node

package

v0.0.0-...-e865ecf Latest Latest Go to latest Published: Apr 27, 2024 License: MIT Imports: 18 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/cornerstone-labs/acorus

Documentation ¶

Index ¶

Variables
func IsURLAvailable(address string) bool
type EthClient
- func DialEthClient(ctx context.Context, rpcUrl string) (EthClient, error)
type HeaderTraversal
- func NewHeaderTraversal(ethClient EthClient, fromHeader *types.Header, confDepth *big.Int, ...) *HeaderTraversal
type Logs
type MockEthClient
type RPC
- func NewRPC(client *rpc.Client) RPC

Constants ¶

This section is empty.

Variables ¶

View Source

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")
)

Functions ¶

func IsURLAvailable ¶

func IsURLAvailable(address string) bool

Types ¶

type EthClient ¶

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

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

	StorageHash(common.Address, *big.Int) (common.Hash, error)
	FilterLogs(filterQuery ethereum.FilterQuery, chainId uint) (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) (EthClient, error)

type HeaderTraversal ¶

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

func NewHeaderTraversal ¶

func NewHeaderTraversal(ethClient EthClient, fromHeader *types.Header, confDepth *big.Int, chainId uint) *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 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, chainId uint) ([]types.Header, error)

func (*MockEthClient) Close ¶

func (m *MockEthClient) Close()

func (*MockEthClient) FilterLogs ¶

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

func (*MockEthClient) LatestFinalizedBlockHeader ¶

func (m *MockEthClient) LatestFinalizedBlockHeader() (*types.Header, error)

func (*MockEthClient) LatestSafeBlockHeader ¶

func (m *MockEthClient) LatestSafeBlockHeader() (*types.Header, 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) RPC

Source Files ¶

View all Source files

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