rpc

Documentation

Index

• type Client
  • func NewClient(url string, override FinalityOverride) (Client, error)
• type Ethereum2Client
  • func NewEthereum2Client(ethereumClient *EthereumClient) (*Ethereum2Client, error)
  • func (c *Ethereum2Client) LatestFinalizedBlockNumber(ctx context.Context, _ uint64) (*big.Int, error)
• type EthereumClient
  • func NewEthereumClient(ethClient EthereumJSONRPCClient, rpc JSONRPCClient) (*EthereumClient, error)
  • func (c *EthereumClient) HeaderByNumber(ctx context.Context, number *big.Int) (*Header, error)
  • func (c *EthereumClient) LatestFinalizedBlockNumber(ctx context.Context, confirmations uint64) (*big.Int, error)
  • func (c *EthereumClient) TransactionReceipts(ctx context.Context, txHashes []common.Hash) ([]TxReceiptResult, error)
• type EthereumJSONRPCClient
• type FinalityOverride
  • func ParseFinalityOverride(s string) (FinalityOverride, error)
  • func (i FinalityOverride) String() string
• type Header
• type JSONRPCClient
• type TxReceiptResult

Types

type Client

type Client interface {
	// TransactionReceipts returns transaction receipts for the given transaction hashes
	TransactionReceipts(ctx context.Context, txHashes []common.Hash) ([]TxReceiptResult, error)
	// HeaderByNumber returns the block header for the given block number
	HeaderByNumber(ctx context.Context, number *big.Int) (*Header, error)
	// LatestFinalizedBlockNumber returns the latest finalized block number
	LatestFinalizedBlockNumber(ctx context.Context, confirmations uint64) (*big.Int, error)
	// Close closes the client connection
	Close()
}

Client provides calls to EVM JSON-RPC endpoints

func NewClient

func NewClient(url string, override FinalityOverride) (Client, error)

NewClient returns an EVM JSON-RPC client

type Ethereum2Client

type Ethereum2Client struct {
	*EthereumClient
}

Ethereum2Client is a JSON-RPC client of Ethereum 2.0

func NewEthereum2Client

func NewEthereum2Client(ethereumClient *EthereumClient) (*Ethereum2Client, error)

NewEthereum2Client is the constructor

func (*Ethereum2Client) LatestFinalizedBlockNumber

func (c *Ethereum2Client) LatestFinalizedBlockNumber(ctx context.Context, _ uint64) (*big.Int, error)

LatestFinalizedBlockNumber returns the latest finalized block number

type EthereumClient

type EthereumClient struct {
	EthereumJSONRPCClient
	// contains filtered or unexported fields
}

EthereumClient is a JSON-RPC client of any Ethereum-compact chains

func NewEthereumClient

func NewEthereumClient(ethClient EthereumJSONRPCClient, rpc JSONRPCClient) (*EthereumClient, error)

NewEthereumClient is the constructor

func (*EthereumClient) HeaderByNumber

func (c *EthereumClient) HeaderByNumber(ctx context.Context, number *big.Int) (*Header, error)

HeaderByNumber returns the block header for the given block number

func (*EthereumClient) LatestFinalizedBlockNumber

func (c *EthereumClient) LatestFinalizedBlockNumber(ctx context.Context, confirmations uint64) (*big.Int, error)

LatestFinalizedBlockNumber returns the latest finalized block number

func (*EthereumClient) TransactionReceipts

func (c *EthereumClient) TransactionReceipts(ctx context.Context, txHashes []common.Hash) ([]TxReceiptResult, error)

type EthereumJSONRPCClient

type EthereumJSONRPCClient interface {
	BlockNumber(ctx context.Context) (uint64, error)
	CallContract(ctx context.Context, msg ethereum.CallMsg, blockNumber *big.Int) ([]byte, error)
	TransactionReceipt(ctx context.Context, txHash common.Hash) (*types.Receipt, error)
	FilterLogs(ctx context.Context, q ethereum.FilterQuery) ([]types.Log, error)
	Close()
}

EthereumJSONRPCClient represents the functionality of github.com/ethereum/go-ethereum/ethclient.Client

type FinalityOverride

type FinalityOverride int

const (
	NoOverride FinalityOverride = iota
	Confirmation
)

func ParseFinalityOverride

func ParseFinalityOverride(s string) (FinalityOverride, error)

func (FinalityOverride) String

func (i FinalityOverride) String() string

type Header

type Header struct {
	ParentHash    common.Hash    `json:"parentHash"       gencodec:"required"`
	Number        *hexutil.Big   `json:"number"           gencodec:"required"`
	Time          hexutil.Uint64 `json:"timestamp"        gencodec:"required"`
	Hash          common.Hash    `json:"hash"`
	Transactions  []common.Hash  `json:"transactions"     gencodec:"required"`
	L1BlockNumber *hexutil.Big   `json:"l1BlockNumber"`
}

Header represents a block header in any EVM blockchain

type JSONRPCClient

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

JSONRPCClient represents the functionality of github.com/ethereum/go-ethereum/rpc.Client

type TxReceiptResult

type TxReceiptResult results.Result[types.Receipt]

TxReceiptResult is a custom type that allows moq to correctly generate the mock for results.TxReceiptResult with *types.Receipt.