ethclient

Documentation

Overview

Package ethclient is a listener that listens to an Ethereum client.

Index

• type Parameter
  • func WithAddress(address string) Parameter
  • func WithBlockDelay(delay uint32) Parameter
  • func WithBlockSpecifier(specifier string) Parameter
  • func WithBlockTriggers(triggers []*handlers.BlockTrigger) Parameter
  • func WithClientLogLevel(logLevel zerolog.Level) Parameter
  • func WithEarliestBlock(block int32) Parameter
  • func WithEventTriggers(triggers []*handlers.EventTrigger) Parameter
  • func WithInterval(interval time.Duration) Parameter
  • func WithLogLevel(logLevel zerolog.Level) Parameter
  • func WithMetadataDBPath(path string) Parameter
  • func WithMonitor(monitor metrics.Service) Parameter
  • func WithTimeout(timeout time.Duration) Parameter
  • func WithTxTriggers(triggers []*handlers.TxTrigger) Parameter
• type Service
  • func New(ctx context.Context, params ...Parameter) (*Service, error)

Types

type Parameter

type Parameter interface {
	// contains filtered or unexported methods
}

Parameter is the interface for service parameters.

func WithAddress

func WithAddress(address string) Parameter

WithAddress sets the address of the Ethereum client.

func WithBlockDelay

func WithBlockDelay(delay uint32) Parameter

WithBlockDelay sets the number of blocks to delay before passing on to the handlers, allowing avoidance of reorgs. Ignored if block specifier is provided.

func WithBlockSpecifier

func WithBlockSpecifier(specifier string) Parameter

WithBlockSpecifier sets the specifier for the block to handle. This override block delay if supplied.

func WithBlockTriggers

func WithBlockTriggers(triggers []*handlers.BlockTrigger) Parameter

WithBlockTriggers sets the block triggers for the listener.

func WithClientLogLevel

func WithClientLogLevel(logLevel zerolog.Level) Parameter

WithClientLogLevel sets the log level for the clients used by the listener.

func WithEarliestBlock

func WithEarliestBlock(block int32) Parameter

WithEarliestBlock sets the block number from which to start listening.

func WithEventTriggers

func WithEventTriggers(triggers []*handlers.EventTrigger) Parameter

WithEventTriggers sets the event triggers for the listener.

func WithInterval

func WithInterval(interval time.Duration) Parameter

WithInterval sets the interval between polls.

func WithLogLevel

func WithLogLevel(logLevel zerolog.Level) Parameter

WithLogLevel sets the log level for the listener.

func WithMetadataDBPath

func WithMetadataDBPath(path string) Parameter

WithMetadataDBPath sets the path of the metadata database.

func WithMonitor

func WithMonitor(monitor metrics.Service) Parameter

WithMonitor sets the metrics monitor.

func WithTimeout

func WithTimeout(timeout time.Duration) Parameter

WithTimeout sets the timeout for requests made to the Ethereum client.

func WithTxTriggers

func WithTxTriggers(triggers []*handlers.TxTrigger) Parameter

WithTxTriggers sets the transaction triggers for the listener.

type Service

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

Service is a listener that listens to an Ethereum client.

func New

func New(ctx context.Context, params ...Parameter) (*Service, error)

New creates a new service.