blocktracker

package

v0.0.0-...-e4f0010 Latest Latest Go to latest Published: Dec 2, 2021 License: MPL-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/0xKitsune/go-web3

Documentation ¶

Index ¶

type BlockEvent
type BlockProvider
type BlockTracker
- func NewBlockTracker(provider BlockProvider, opts ...ConfigOption) *BlockTracker
- func (b *BlockTracker) AcquireLock() Lock
- func (t *BlockTracker) AddBlockLocked(block *web3.Block) error
- func (b *BlockTracker) BlocksBlocked() []*web3.Block
- func (b *BlockTracker) Close() error
- func (t *BlockTracker) HandleBlockEvent(block *web3.Block) (*BlockEvent, error)
- func (t *BlockTracker) HandleReconcile(block *web3.Block) error
- func (t *BlockTracker) Init() (err error)
- func (b *BlockTracker) LastBlocked() *web3.Block
- func (b *BlockTracker) Len() int
- func (b *BlockTracker) MaxBlockBacklog() uint64
- func (b *BlockTracker) Start() error
- func (b *BlockTracker) Subscribe() chan *BlockEvent
type BlockTrackerInterface
type Config
- func DefaultConfig() *Config
type ConfigOption
- func WithBlockMaxBacklog(b uint64) ConfigOption
- func WithTracker(b BlockTrackerInterface) ConfigOption
type Event
type EventType
type JSONBlockTracker
- func NewJSONBlockTracker(logger *log.Logger, provider BlockProvider) *JSONBlockTracker
- func (k *JSONBlockTracker) Track(ctx context.Context, handle func(block *web3.Block) error) error
type Lock
- func (l *Lock) Lock()
- func (l *Lock) Unlock()
type SubscriptionBlockTracker
- func NewSubscriptionBlockTracker(logger *log.Logger, client *jsonrpc.Client) (*SubscriptionBlockTracker, error)
- func (s *SubscriptionBlockTracker) Track(ctx context.Context, handle func(block *web3.Block) error) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type BlockEvent ¶

type BlockEvent struct {
	Type    EventType
	Added   []*web3.Block
	Removed []*web3.Block
}

BlockEvent is an event emitted when a new block is included

type BlockProvider ¶

type BlockProvider interface {
	GetBlockByHash(hash web3.Hash, full bool) (*web3.Block, error)
	GetBlockByNumber(i web3.BlockNumber, full bool) (*web3.Block, error)
}

BlockProvider are the eth1x methods required by the block tracker

type BlockTracker ¶

type BlockTracker struct {
	// contains filtered or unexported fields
}

BlockTracker is an interface to track new blocks on the chain

func NewBlockTracker ¶

func NewBlockTracker(provider BlockProvider, opts ...ConfigOption) *BlockTracker

func (*BlockTracker) AcquireLock ¶

func (b *BlockTracker) AcquireLock() Lock

func (*BlockTracker) AddBlockLocked ¶

func (t *BlockTracker) AddBlockLocked(block *web3.Block) error

func (*BlockTracker) BlocksBlocked ¶

func (b *BlockTracker) BlocksBlocked() []*web3.Block

func (*BlockTracker) Close ¶

func (b *BlockTracker) Close() error

func (*BlockTracker) HandleBlockEvent ¶

func (t *BlockTracker) HandleBlockEvent(block *web3.Block) (*BlockEvent, error)

func (*BlockTracker) HandleReconcile ¶

func (t *BlockTracker) HandleReconcile(block *web3.Block) error

func (*BlockTracker) Init ¶

func (t *BlockTracker) Init() (err error)

func (*BlockTracker) LastBlocked ¶

func (b *BlockTracker) LastBlocked() *web3.Block

func (*BlockTracker) Len ¶

func (b *BlockTracker) Len() int

func (*BlockTracker) MaxBlockBacklog ¶

func (b *BlockTracker) MaxBlockBacklog() uint64

func (*BlockTracker) Start ¶

func (b *BlockTracker) Start() error

func (b *BlockTracker) Subscribe() chan *BlockEvent

type BlockTrackerInterface ¶

type BlockTrackerInterface interface {
	Track(context.Context, func(block *web3.Block) error) error
}

type Config ¶

type Config struct {
	Tracker         BlockTrackerInterface
	MaxBlockBacklog uint64
}

func DefaultConfig ¶

func DefaultConfig() *Config

type ConfigOption ¶

type ConfigOption func(*Config)

func WithBlockMaxBacklog ¶

func WithBlockMaxBacklog(b uint64) ConfigOption

func WithTracker ¶

func WithTracker(b BlockTrackerInterface) ConfigOption

type Event ¶

type Event struct {
	Type    EventType
	Added   []*web3.Log
	Removed []*web3.Log
}

Event is an event emitted when a new log is included

type EventType ¶

type EventType int

EventType is the type of the event

const (
	// EventAdd happens when a new event is included in the chain
	EventAdd EventType = iota
	// EventDel may happen when there is a reorg and a past event is deleted
	EventDel
)

type JSONBlockTracker ¶

type JSONBlockTracker struct {
	PollInterval time.Duration
	// contains filtered or unexported fields
}

JSONBlockTracker implements the BlockTracker interface using the http jsonrpc endpoint

func NewJSONBlockTracker ¶

func NewJSONBlockTracker(logger *log.Logger, provider BlockProvider) *JSONBlockTracker

NewJSONBlockTracker creates a new json block tracker

func (*JSONBlockTracker) Track ¶

func (k *JSONBlockTracker) Track(ctx context.Context, handle func(block *web3.Block) error) error

Track implements the BlockTracker interface

type Lock ¶

type Lock struct {
	Locked bool
	// contains filtered or unexported fields
}

func (*Lock) Lock ¶

func (l *Lock) Lock()

func (*Lock) Unlock ¶

func (l *Lock) Unlock()

type SubscriptionBlockTracker ¶

type SubscriptionBlockTracker struct {
	// contains filtered or unexported fields
}

SubscriptionBlockTracker is an interface to track new blocks using the newHeads subscription endpoint

func NewSubscriptionBlockTracker ¶

func NewSubscriptionBlockTracker(logger *log.Logger, client *jsonrpc.Client) (*SubscriptionBlockTracker, error)

NewSubscriptionBlockTracker creates a new block tracker using the subscription endpoint

func (*SubscriptionBlockTracker) Track ¶

func (s *SubscriptionBlockTracker) Track(ctx context.Context, handle func(block *web3.Block) error) error

Track implements the BlockTracker interface

Source Files ¶

View all Source files

blocktracker.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

Types ¶

type BlockEvent ¶

type BlockProvider ¶

type BlockTracker ¶

func NewBlockTracker ¶

func (*BlockTracker) AcquireLock ¶

func (*BlockTracker) AddBlockLocked ¶

func (*BlockTracker) BlocksBlocked ¶

func (*BlockTracker) Close ¶

func (*BlockTracker) HandleBlockEvent ¶

func (*BlockTracker) HandleReconcile ¶

func (*BlockTracker) Init ¶

func (*BlockTracker) LastBlocked ¶

func (*BlockTracker) Len ¶

func (*BlockTracker) MaxBlockBacklog ¶

func (*BlockTracker) Start ¶

func (*BlockTracker) Subscribe ¶

type BlockTrackerInterface ¶

type Config ¶

func DefaultConfig ¶

type ConfigOption ¶

func WithBlockMaxBacklog ¶

func WithTracker ¶

type Event ¶

type EventType ¶

type JSONBlockTracker ¶

func NewJSONBlockTracker ¶

func (*JSONBlockTracker) Track ¶

type Lock ¶

func (*Lock) Lock ¶

func (*Lock) Unlock ¶

type SubscriptionBlockTracker ¶

func NewSubscriptionBlockTracker ¶

func (*SubscriptionBlockTracker) Track ¶

Source Files ¶