ethclient

package
v0.15.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 1, 2025 License: GPL-3.0, LGPL-3.0 Imports: 13 Imported by: 38

Documentation

Overview

Package ethclient provides a client for the Ethereum RPC API.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ToBlockNumArg added in v0.6.0 

func ToBlockNumArg(number *big.Int) string

Types

type BlockHook added in v0.15.1 

type BlockHook interface {
	// OnBlockDecoded is called when a block is decoded. It can be used to
	// modify the block before it is returned to the caller.
	OnBlockDecoded(raw json.RawMessage, block *types.Block) error
}

BlockHook is an interface that can be implemented to modify the block after it has been decoded. This is useful for plugins that want to modify the block before it is returned to the caller.

type Client 

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

Client defines typed wrappers for the Ethereum RPC API.

func Dial 

func Dial(rawurl string) (*Client, error)

Dial connects a client to the given URL.

func DialContext 

func DialContext(ctx context.Context, rawurl string) (*Client, error)

DialContext connects a client to the given URL with context.

func NewClient 

func NewClient(c *rpc.Client) *Client

NewClient creates a client that uses the given RPC client.

func NewClientWithHook added in v0.15.1 

func NewClientWithHook(c *rpc.Client, hook BlockHook) *Client

NewClientWithHook creates a client that uses the given RPC client and block hook.

func (*Client) AcceptedCallContract added in v0.7.1 

func (ec *Client) AcceptedCallContract(ctx context.Context, msg ethereum.CallMsg) ([]byte, error)

AcceptedCallContract executes a message call transaction in the accepted state.

func (*Client) AcceptedCodeAt added in v0.7.1 

func (ec *Client) AcceptedCodeAt(ctx context.Context, account common.Address) ([]byte, error)

AcceptedCodeAt returns the contract code of the given account in the accepted state.

func (*Client) AcceptedNonceAt added in v0.7.1 

func (ec *Client) AcceptedNonceAt(ctx context.Context, account common.Address) (uint64, error)

AcceptedNonceAt returns the account nonce of the given account in the accepted state. This is the nonce that should be used for the next transaction.

func (*Client) BalanceAt 

func (ec *Client) BalanceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (*big.Int, error)

BalanceAt returns the wei balance of the given account. The block number can be nil, in which case the balance is taken from the latest known block.

func (*Client) BalanceAtHash added in v0.13.4 

func (ec *Client) BalanceAtHash(ctx context.Context, account common.Address, blockHash common.Hash) (*big.Int, error)

BalanceAtHash returns the wei balance of the given account.

func (*Client) BlockByHash 

func (ec *Client) BlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error)

BlockByHash returns the given full block.

Note that loading full blocks requires two requests. Use HeaderByHash if you don't need all transactions or uncle headers.

func (*Client) BlockByNumber 

func (ec *Client) BlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error)

BlockByNumber returns a block from the current canonical chain. If number is nil, the latest known block is returned.

Note that loading full blocks requires two requests. Use HeaderByNumber if you don't need all transactions or uncle headers.

func (*Client) BlockNumber 

func (ec *Client) BlockNumber(ctx context.Context) (uint64, error)

BlockNumber returns the most recent block number

func (*Client) BlockReceipts added in v0.12.10 

func (ec *Client) BlockReceipts(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) ([]*types.Receipt, error)

BlockReceipts returns the receipts of a given block number or hash.

func (*Client) CallContract 

func (ec *Client) CallContract(ctx context.Context, msg ethereum.CallMsg, blockNumber *big.Int) ([]byte, error)

CallContract executes a message call transaction, which is directly executed in the VM of the node, but never mined into the blockchain.

blockNumber selects the block height at which the call runs. It can be nil, in which case the code is taken from the latest known block. Note that state from very old blocks might not be available.

func (*Client) CallContractAtHash added in v0.8.6 

func (ec *Client) CallContractAtHash(ctx context.Context, msg ethereum.CallMsg, blockHash common.Hash) ([]byte, error)

CallContractAtHash is almost the same as CallContract except that it selects the block by block hash instead of block height.

func (*Client) ChainID 

func (ec *Client) ChainID(ctx context.Context) (*big.Int, error)

ChainID retrieves the current chain ID for transaction replay protection.

func (*Client) Client added in v0.12.5 

func (ec *Client) Client() *rpc.Client

Client gets the underlying RPC client.

func (*Client) Close 

func (ec *Client) Close()

Close closes the underlying RPC connection.

func (*Client) CodeAt 

func (ec *Client) CodeAt(ctx context.Context, account common.Address, blockNumber *big.Int) ([]byte, error)

CodeAt returns the contract code of the given account. The block number can be nil, in which case the code is taken from the latest known block.

func (*Client) CodeAtHash added in v0.13.4 

func (ec *Client) CodeAtHash(ctx context.Context, account common.Address, blockHash common.Hash) ([]byte, error)

CodeAtHash returns the contract code of the given account.

func (*Client) EstimateBaseFee added in v0.6.0 

func (ec *Client) EstimateBaseFee(ctx context.Context) (*big.Int, error)

EstimateBaseFee tries to estimate the base fee for the next block if it were created immediately. There is no guarantee that this will be the base fee used in the next block or that the next base fee will be higher or lower than the returned value.

func (*Client) EstimateGas 

func (ec *Client) EstimateGas(ctx context.Context, msg ethereum.CallMsg) (uint64, error)

EstimateGas tries to estimate the gas needed to execute a specific transaction based on the current pending state of the backend blockchain. There is no guarantee that this is the true gas limit requirement as other transactions may be added or removed by miners, but it should provide a basis for setting a reasonable default.

func (*Client) FeeHistory added in v0.9.0 

func (ec *Client) FeeHistory(ctx context.Context, blockCount uint64, lastBlock *big.Int, rewardPercentiles []float64) (*ethereum.FeeHistory, error)

FeeHistory retrieves the fee market history.

func (*Client) FilterLogs 

func (ec *Client) FilterLogs(ctx context.Context, q ethereum.FilterQuery) ([]types.Log, error)

FilterLogs executes a filter query.

func (*Client) HeaderByHash 

func (ec *Client) HeaderByHash(ctx context.Context, hash common.Hash) (*types.Header, error)

HeaderByHash returns the block header with the given hash.

func (*Client) HeaderByNumber 

func (ec *Client) HeaderByNumber(ctx context.Context, number *big.Int) (*types.Header, error)

HeaderByNumber returns a block header from the current canonical chain. If number is nil, the latest known header is returned.

func (*Client) NetworkID 

func (ec *Client) NetworkID(ctx context.Context) (*big.Int, error)

NetworkID returns the network ID for this client.

func (*Client) NonceAt 

func (ec *Client) NonceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (uint64, error)

NonceAt returns the account nonce of the given account. The block number can be nil, in which case the nonce is taken from the latest known block.

func (*Client) NonceAtHash added in v0.13.4 

func (ec *Client) NonceAtHash(ctx context.Context, account common.Address, blockHash common.Hash) (uint64, error)

NonceAtHash returns the account nonce of the given account.

func (*Client) SendTransaction 

func (ec *Client) SendTransaction(ctx context.Context, tx *types.Transaction) error

SendTransaction injects a signed transaction into the pending pool for execution.

If the transaction was a contract creation use the TransactionReceipt method to get the contract address after the transaction has been mined.

func (*Client) StorageAt 

func (ec *Client) StorageAt(ctx context.Context, account common.Address, key common.Hash, blockNumber *big.Int) ([]byte, error)

StorageAt returns the value of key in the contract storage of the given account. The block number can be nil, in which case the value is taken from the latest known block.

func (*Client) StorageAtHash added in v0.13.4 

func (ec *Client) StorageAtHash(ctx context.Context, account common.Address, key common.Hash, blockHash common.Hash) ([]byte, error)

StorageAtHash returns the value of key in the contract storage of the given account.

func (*Client) SubscribeFilterLogs 

func (ec *Client) SubscribeFilterLogs(ctx context.Context, q ethereum.FilterQuery, ch chan<- types.Log) (ethereum.Subscription, error)

SubscribeFilterLogs subscribes to the results of a streaming filter query.

func (*Client) SubscribeNewAcceptedTransactions added in v0.5.0 

func (ec *Client) SubscribeNewAcceptedTransactions(ctx context.Context, ch chan<- *common.Hash) (ethereum.Subscription, error)

SubscribeNewAcceptedTransactions subscribes to notifications about the accepted transaction hashes on the given channel.

func (*Client) SubscribeNewHead 

func (ec *Client) SubscribeNewHead(ctx context.Context, ch chan<- *types.Header) (ethereum.Subscription, error)

SubscribeNewHead subscribes to notifications about the current blockchain head on the given channel.

func (*Client) SubscribeNewPendingTransactions added in v0.5.0 

func (ec *Client) SubscribeNewPendingTransactions(ctx context.Context, ch chan<- *common.Hash) (ethereum.Subscription, error)

SubscribeNewPendingTransactions subscribes to notifications about the pending transaction hashes on the given channel.

func (*Client) SuggestGasPrice 

func (ec *Client) SuggestGasPrice(ctx context.Context) (*big.Int, error)

SuggestGasPrice retrieves the currently suggested gas price to allow a timely execution of a transaction.

func (*Client) SuggestGasTipCap added in v0.6.0 

func (ec *Client) SuggestGasTipCap(ctx context.Context) (*big.Int, error)

SuggestGasTipCap retrieves the currently suggested gas tip cap after 1559 to allow a timely execution of a transaction.

func (*Client) SyncProgress added in v0.8.14 

func (ec *Client) SyncProgress(ctx context.Context) error

SyncProgress retrieves the current progress of the sync algorithm. If there's no sync currently running, it returns nil.

func (*Client) TransactionByHash 

func (ec *Client) TransactionByHash(ctx context.Context, hash common.Hash) (tx *types.Transaction, isPending bool, err error)

TransactionByHash returns the transaction with the given hash.

func (*Client) TransactionCount 

func (ec *Client) TransactionCount(ctx context.Context, blockHash common.Hash) (uint, error)

TransactionCount returns the total number of transactions in the given block.

func (*Client) TransactionInBlock 

func (ec *Client) TransactionInBlock(ctx context.Context, blockHash common.Hash, index uint) (*types.Transaction, error)

TransactionInBlock returns a single transaction at index in the given block.

func (*Client) TransactionReceipt 

func (ec *Client) TransactionReceipt(ctx context.Context, txHash common.Hash) (*types.Receipt, error)

TransactionReceipt returns the receipt of a transaction by transaction hash. Note that the receipt is not available for pending transactions.

func (*Client) TransactionSender 

func (ec *Client) TransactionSender(ctx context.Context, tx *types.Transaction, block common.Hash, index uint) (common.Address, error)

TransactionSender returns the sender address of the given transaction. The transaction must be known to the remote node and included in the blockchain at the given block and index. The sender is the one derived by the protocol at the time of inclusion.

There is a fast-path for transactions retrieved by TransactionByHash and TransactionInBlock. Getting their sender address can be done without an RPC interaction.

Source Files

View all Source files

Directories

Path Synopsis
Package corethclient provides an RPC client for coreth-specific APIs.
 Package corethclient provides an RPC client for coreth-specific APIs.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.