evmwatcher

Documentation

Index

• type EVMWatcher
  • func NewEVMWatcher(chainName, wssURL string, watcherData []WatcherData, storage StorageInterface, ...) *EVMWatcher
  • func (e *EVMWatcher) AddWatcher(watcherData WatcherData) error
  • func (e *EVMWatcher) GetWatcherData() []WatcherData
  • func (e *EVMWatcher) RemoveWatcher(watcherData WatcherData) error
  • func (e *EVMWatcher) Start() error
  • func (e *EVMWatcher) Stop()
• type Event
• type EventInterface
• type Option
  • func WithConfirmations(n uint64) Option
  • func WithMaxBlockRange(blocks uint64) Option
  • func WithPollInterval(d time.Duration) Option
  • func WithRequestInterval(interval time.Duration) Option
• type StorageInterface
• type WatcherData

Types

type EVMWatcher

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

EVMWatcher watches multiple contracts of one chain over a single connection, so that the whole chain shares one consistent block progress.

func NewEVMWatcher

func NewEVMWatcher(chainName, wssURL string, watcherData []WatcherData, storage StorageInterface, event EventInterface, options ...Option) *EVMWatcher

func (*EVMWatcher) AddWatcher

func (e *EVMWatcher) AddWatcher(watcherData WatcherData) error

func (*EVMWatcher) GetWatcherData

func (e *EVMWatcher) GetWatcherData() []WatcherData

func (*EVMWatcher) RemoveWatcher

func (e *EVMWatcher) RemoveWatcher(watcherData WatcherData) error

func (*EVMWatcher) Start

func (e *EVMWatcher) Start() error

func (*EVMWatcher) Stop

func (e *EVMWatcher) Stop()

type Event

type Event struct {
	ContractAddress common.Address
	EventName       string
	BlockNumber     uint64
	BlockHash       common.Hash
	TxHash          common.Hash
	TxIndex         uint
	LogIndex        uint
	Args            map[string]any
	// Removed is true when the log has been reverted by a chain reorg.
	Removed bool
	Raw     types.Log
}

Event is the decoded contract event delivered through EventInterface.

type EventInterface

type EventInterface interface {
	// OnEvent is called with the chain the event belongs to, so that one
	// implementation can serve several chains.
	OnEvent(chainName string, event *Event) error
}

监听到事件之后向外通知的接口

type Option

type Option func(*EVMWatcher)

func WithConfirmations

func WithConfirmations(n uint64) Option

WithConfirmations delays delivery and watermark until a block is N blocks behind the chain head. 0 (default) keeps the current immediate-delivery behavior.

func WithMaxBlockRange

func WithMaxBlockRange(blocks uint64) Option

WithMaxBlockRange sets the block span of one eth_getLogs call, it is shrunk automatically when the provider rejects the range.

func WithPollInterval

func WithPollInterval(d time.Duration) Option

WithPollInterval sets the poll interval used when confirmations > 0.

func WithRequestInterval

func WithRequestInterval(interval time.Duration) Option

WithRequestInterval sets the minimum gap between two RPC calls.

type StorageInterface

type StorageInterface interface {
	// GetWatchedBlockNumber returns the last watched block number of the given
	// chain, -1 means there is no progress recorded yet.
	GetWatchedBlockNumber(chainName string) (int64, error)
	SetWatchedBlockNumber(chainName string, blockNumber uint64) error
}

type WatcherData

type WatcherData struct {
	ContractAddress string
	ContractABI     string
	// EventNames is the watched event name list, empty means every event in the ABI.
	EventNames []string
}

WatcherData describes one contract and the events watched on it.