ethmonitor

README

ethmonitor

inspired by the work of the 0x team at github.com/0xProject/0x-mesh

Documentation

Index

• Variables
• func IsBlockEq(a, b *types.Block) bool
• type Block
• type Blocks
  • func (blocks Blocks) Copy() Blocks
  • func (blocks Blocks) EventExists(block *types.Block, event Event) bool
  • func (blocks Blocks) FindBlock(hash common.Hash, optEvent ...Event) (*Block, bool)
  • func (b Blocks) Head() *Block
  • func (b Blocks) IsOK() bool
  • func (b Blocks) LatestBlock() *Block
  • func (b Blocks) Reorg() bool
  • func (b Blocks) Tail() *Block
• type Chain
  • func (c *Chain) Blocks() Blocks
  • func (c *Chain) GetAverageBlockTime() float64
  • func (c *Chain) GetBlock(hash common.Hash) *Block
  • func (c *Chain) GetBlockByNumber(blockNum uint64, event Event) *Block
  • func (c *Chain) GetTransaction(txnHash common.Hash) *types.Transaction
  • func (c *Chain) Head() *Block
  • func (c *Chain) PrintAllBlocks()
  • func (c *Chain) Tail() *Block
• type Event
• type Monitor
  • func NewMonitor(provider *ethrpc.Provider, options ...Options) (*Monitor, error)
  • func (m *Monitor) Chain() *Chain
  • func (m *Monitor) GetAverageBlockTime() float64
  • func (m *Monitor) GetBlock(blockHash common.Hash) *Block
  • func (m *Monitor) GetTransaction(txnHash common.Hash) *types.Transaction
  • func (m *Monitor) IsRunning() bool
  • func (m *Monitor) LatestBlock() *Block
  • func (m *Monitor) LatestBlockNum() *big.Int
  • func (m *Monitor) LatestFinalBlock(numBlocksToFinality int) *Block
  • func (m *Monitor) OldestBlockNum() *big.Int
  • func (m *Monitor) Options() Options
  • func (m *Monitor) Provider() *ethrpc.Provider
  • func (m *Monitor) PurgeHistory()
  • func (m *Monitor) Run(ctx context.Context) error
  • func (m *Monitor) Stop()
  • func (m *Monitor) Subscribe() Subscription
• type Options
• type Subscription

Variables

var (
	ErrFatal                 = errors.New("ethmonitor: fatal error, stopping")
	ErrReorg                 = errors.New("ethmonitor: block reorg")
	ErrUnexpectedParentHash  = errors.New("ethmonitor: unexpected parent hash")
	ErrUnexpectedBlockNumber = errors.New("ethmonitor: unexpected block number")
	ErrQueueFull             = errors.New("ethmonitor: publish queue is full")
	ErrMaxAttempts           = errors.New("ethmonitor: max attempts hit")
)

var DefaultOptions = Options{
	Logger:                   logger.NewLogger(logger.LogLevel_WARN),
	PollingInterval:          1000 * time.Millisecond,
	Timeout:                  20 * time.Second,
	StartBlockNumber:         nil,
	TrailNumBlocksBehindHead: 0,
	BlockRetentionLimit:      200,
	WithLogs:                 false,
	LogTopics:                []common.Hash{},
	DebugLogging:             false,
}

Functions

func IsBlockEq

func IsBlockEq(a, b *types.Block) bool

Types

type Block

type Block struct {
	*types.Block
	Event Event
	Logs  []types.Log
	OK    bool
}

type Blocks

type Blocks []*Block

func (Blocks) Copy

func (blocks Blocks) Copy() Blocks

func (Blocks) EventExists

func (blocks Blocks) EventExists(block *types.Block, event Event) bool

func (Blocks) FindBlock

func (blocks Blocks) FindBlock(hash common.Hash, optEvent ...Event) (*Block, bool)

func (Blocks) Head

func (b Blocks) Head() *Block

func (Blocks) IsOK

func (b Blocks) IsOK() bool

func (Blocks) LatestBlock

func (b Blocks) LatestBlock() *Block

func (Blocks) Reorg

func (b Blocks) Reorg() bool

func (Blocks) Tail

func (b Blocks) Tail() *Block

type Chain

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

func (*Chain) Blocks

func (c *Chain) Blocks() Blocks

func (*Chain) GetAverageBlockTime

func (c *Chain) GetAverageBlockTime() float64

func (*Chain) GetBlock

func (c *Chain) GetBlock(hash common.Hash) *Block

func (*Chain) GetBlockByNumber

func (c *Chain) GetBlockByNumber(blockNum uint64, event Event) *Block

func (*Chain) GetTransaction

func (c *Chain) GetTransaction(txnHash common.Hash) *types.Transaction

GetTransaction searches our canonical chain of blocks (where each block points at previous), and returns the transaction. Aka, searches our chain for mined transactions. Keep in mind transactions can still be reorged, but you can check the blockNumber and compare it against the head to determine if its final.

func (*Chain) Head

func (c *Chain) Head() *Block

func (*Chain) PrintAllBlocks

func (c *Chain) PrintAllBlocks()

func (*Chain) Tail

func (c *Chain) Tail() *Block

type Event

type Event uint32

const (
	Added Event = iota
	Removed
)

type Monitor

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

func NewMonitor

func NewMonitor(provider *ethrpc.Provider, options ...Options) (*Monitor, error)

func (*Monitor) Chain

func (m *Monitor) Chain() *Chain

func (*Monitor) GetAverageBlockTime

func (m *Monitor) GetAverageBlockTime() float64

GetAverageBlockTime returns the average block time in seconds (including fractions)

func (*Monitor) GetBlock

func (m *Monitor) GetBlock(blockHash common.Hash) *Block

GetBlock will search the retained blocks for the hash

func (*Monitor) GetTransaction

func (m *Monitor) GetTransaction(txnHash common.Hash) *types.Transaction

GetBlock will search within the retained canonical chain for the txn hash. Passing `optMined true` will only return transaction which have not been removed from the chain via a reorg.

func (*Monitor) IsRunning

func (m *Monitor) IsRunning() bool

func (*Monitor) LatestBlock

func (m *Monitor) LatestBlock() *Block

LatestBlock will return the head block of the canonical chain

func (*Monitor) LatestBlockNum

func (m *Monitor) LatestBlockNum() *big.Int

LatestBlockNum returns the latest block number in the canonical chain

func (*Monitor) LatestFinalBlock

func (m *Monitor) LatestFinalBlock(numBlocksToFinality int) *Block

LatestFinalBlock returns the latest block which has reached finality. The argument `numBlocksToFinality` should be a constant value of the number of blocks a particular chain needs to reach finality. Ie. on Polygon this value would be 120 and on Ethereum it would be 20. As the pubsub system publishes new blocks, this value will change, as the chain will progress forward. It's recommend / safe to call this method each time in a <-sub.Blocks() code block.

func (*Monitor) OldestBlockNum

func (m *Monitor) OldestBlockNum() *big.Int

func (*Monitor) Options

func (m *Monitor) Options() Options

func (*Monitor) Provider

func (m *Monitor) Provider() *ethrpc.Provider

func (*Monitor) PurgeHistory

func (m *Monitor) PurgeHistory()

PurgeHistory clears all but the head of the chain. Useful for tests, but should almost never be used in a normal application.

func (*Monitor) Run

func (m *Monitor) Run(ctx context.Context) error

func (*Monitor) Stop

func (m *Monitor) Stop()

func (*Monitor) Subscribe

func (m *Monitor) Subscribe() Subscription

type Options

type Options struct {
	// ..
	Logger logger.Logger

	// ..
	PollingInterval time.Duration

	// ..
	Timeout time.Duration

	// ..
	StartBlockNumber *big.Int

	// ..
	TrailNumBlocksBehindHead int

	// ..
	BlockRetentionLimit int

	// ..
	WithLogs bool

	// ..
	LogTopics []common.Hash

	// ..
	DebugLogging bool
}

type Subscription

type Subscription interface {
	Blocks() <-chan Blocks
	Done() <-chan struct{}
	Unsubscribe()
}