node

Documentation

Index

• Variables
• type EthClient
  • func DialEthClient(ctx context.Context, rpcUrl string, metrics Metricer) (EthClient, error)
• type HeaderTraversal
  • func NewHeaderTraversal(ethClient EthClient, fromHeader *types.Header, confDepth *big.Int) *HeaderTraversal
  • func (f *HeaderTraversal) LastTraversedHeader() *types.Header
  • func (f *HeaderTraversal) LatestHeader() *types.Header
  • func (f *HeaderTraversal) NextHeaders(maxSize uint64) ([]types.Header, error)
• type Logs
• type Metricer
  • func NewMetrics(registry *prometheus.Registry, subsystem string) Metricer
• type MockEthClient
  • func (m *MockEthClient) BlockHeaderByHash(hash common.Hash) (*types.Header, error)
  • func (m *MockEthClient) BlockHeaderByNumber(number *big.Int) (*types.Header, error)
  • func (m *MockEthClient) BlockHeadersByRange(from, to *big.Int) ([]types.Header, error)
  • func (m *MockEthClient) Close()
  • func (m *MockEthClient) FilterLogs(query ethereum.FilterQuery) (Logs, error)
  • func (m *MockEthClient) StorageHash(address common.Address, blockNumber *big.Int) (common.Hash, error)
  • func (m *MockEthClient) TxByHash(hash common.Hash) (*types.Transaction, error)
• type RPC
  • func NewRPC(client *rpc.Client, metrics Metricer) RPC

Variables

var (
	ErrHeaderTraversalAheadOfProvider            = errors.New("the HeaderTraversal's internal state is ahead of the provider")
	ErrHeaderTraversalAndProviderMismatchedState = errors.New("the HeaderTraversal and provider have diverged in state")
)

var (
	MetricsNamespace = "op_indexer_rpc"
)

Types

type EthClient

type EthClient interface {
	BlockHeaderByNumber(*big.Int) (*types.Header, error)
	BlockHeaderByHash(common.Hash) (*types.Header, error)
	BlockHeadersByRange(*big.Int, *big.Int) ([]types.Header, error)

	TxByHash(common.Hash) (*types.Transaction, error)

	StorageHash(common.Address, *big.Int) (common.Hash, error)
	FilterLogs(ethereum.FilterQuery) (Logs, error)

	// Close closes the underlying RPC connection.
	// RPC close does not return any errors, but does shut down e.g. a websocket connection.
	Close()
}

func DialEthClient

func DialEthClient(ctx context.Context, rpcUrl string, metrics Metricer) (EthClient, error)

type HeaderTraversal

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

func NewHeaderTraversal

func NewHeaderTraversal(ethClient EthClient, fromHeader *types.Header, confDepth *big.Int) *HeaderTraversal

NewHeaderTraversal instantiates a new instance of HeaderTraversal against the supplied rpc client. The HeaderTraversal will start fetching blocks starting from the supplied header unless nil, indicating genesis.

func (*HeaderTraversal) LastTraversedHeader

func (f *HeaderTraversal) LastTraversedHeader() *types.Header

LastTraversedHeader returns the last header traversed.

• This is useful for testing the state of the HeaderTraversal
• LastTraversedHeader may be << LatestHeader depending on the number headers traversed via `NextHeaders`.

func (*HeaderTraversal) LatestHeader

func (f *HeaderTraversal) LatestHeader() *types.Header

LatestHeader returns the latest header reported by underlying eth client as headers are traversed via `NextHeaders`.

func (*HeaderTraversal) NextHeaders

func (f *HeaderTraversal) NextHeaders(maxSize uint64) ([]types.Header, error)

NextHeaders retrieves the next set of headers that have been marked as finalized by the connected client, bounded by the supplied size

type Logs

type Logs struct {
	Logs          []types.Log
	ToBlockHeader *types.Header
}

type Metricer

type Metricer interface {
	RecordRPCClientRequest(method string) func(err error)
	RecordRPCClientBatchRequest(b []rpc.BatchElem) func(err error)
}

func NewMetrics

func NewMetrics(registry *prometheus.Registry, subsystem string) Metricer

type MockEthClient

type MockEthClient struct {
	mock.Mock
}

func (*MockEthClient) BlockHeaderByHash

func (m *MockEthClient) BlockHeaderByHash(hash common.Hash) (*types.Header, error)

func (*MockEthClient) BlockHeaderByNumber

func (m *MockEthClient) BlockHeaderByNumber(number *big.Int) (*types.Header, error)

func (*MockEthClient) BlockHeadersByRange

func (m *MockEthClient) BlockHeadersByRange(from, to *big.Int) ([]types.Header, error)

func (*MockEthClient) Close

func (m *MockEthClient) Close()

func (*MockEthClient) FilterLogs

func (m *MockEthClient) FilterLogs(query ethereum.FilterQuery) (Logs, error)

func (*MockEthClient) StorageHash

func (m *MockEthClient) StorageHash(address common.Address, blockNumber *big.Int) (common.Hash, error)

func (*MockEthClient) TxByHash

func (m *MockEthClient) TxByHash(hash common.Hash) (*types.Transaction, error)

type RPC

type RPC interface {
	Close()
	CallContext(ctx context.Context, result any, method string, args ...any) error
	BatchCallContext(ctx context.Context, b []rpc.BatchElem) error
}

func NewRPC

func NewRPC(client *rpc.Client, metrics Metricer) RPC