Documentation

Overview

    Package ethclient provides a client for the Ethereum RPC API.

    Index

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    This section is empty.

    Types

    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 NewClient

        func NewClient(c *rpc.Client) *Client

          NewClient creates a client that uses the given RPC client.

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

                    func (ec *Client) EstimateGas(ctx context.Context, msg ethereum.CallMsg) (*big.Int, 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) 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) 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) PendingBalanceAt

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

                                PendingBalanceAt returns the wei balance of the given account in the pending state.

                                func (*Client) PendingCallContract

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

                                  PendingCallContract executes a message call transaction using the EVM. The state seen by the contract call is the pending state.

                                  func (*Client) PendingCodeAt

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

                                    PendingCodeAt returns the contract code of the given account in the pending state.

                                    func (*Client) PendingNonceAt

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

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

                                      func (*Client) PendingStorageAt

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

                                        PendingStorageAt returns the value of key in the contract storage of the given account in the pending state.

                                        func (*Client) PendingTransactionCount

                                        func (ec *Client) PendingTransactionCount(ctx context.Context) (uint, error)

                                          PendingTransactionCount returns the total number of transactions in the pending state.

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

                                                    func (ec *Client) SyncProgress(ctx context.Context) (*ethereum.SyncProgress, 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.

                                                              Source Files