rpc

package
v0.7.0 Latest Latest
Warning

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

 Go to latest Published: Jul 20, 2024 License: MIT Imports: 8 Imported by: 20

Documentation

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 allows to interact with the Ethereum node.

func NewClient 

func NewClient(opts ...ClientOptions) (*Client, error)

NewClient creates a new RPC client. The WithTransport option is required.

func (*Client) Accounts 

func (c *Client) Accounts(ctx context.Context) ([]types.Address, error)

Accounts implements the RPC interface.

func (*Client) BlockByHash 

func (c *Client) BlockByHash(ctx context.Context, hash types.Hash, full bool) (*types.Block, error)

BlockByHash implements the RPC interface.

func (*Client) BlockByNumber 

func (c *Client) BlockByNumber(ctx context.Context, number types.BlockNumber, full bool) (*types.Block, error)

BlockByNumber implements the RPC interface.

func (*Client) BlockNumber 

func (c *Client) BlockNumber(ctx context.Context) (*big.Int, error)

BlockNumber implements the RPC interface.

func (*Client) Call 

func (c *Client) Call(ctx context.Context, call *types.Call, block types.BlockNumber) ([]byte, *types.Call, error)

Call implements the RPC interface.

func (*Client) ChainID 

func (c *Client) ChainID(ctx context.Context) (uint64, error)

ChainID implements the RPC interface.

func (*Client) ClientVersion added in v0.6.1 

func (c *Client) ClientVersion(ctx context.Context) (string, error)

ClientVersion implements the RPC interface.

func (*Client) EstimateGas 

func (c *Client) EstimateGas(ctx context.Context, call *types.Call, block types.BlockNumber) (uint64, *types.Call, error)

EstimateGas implements the RPC interface.

func (*Client) GasPrice 

func (c *Client) GasPrice(ctx context.Context) (*big.Int, error)

GasPrice implements the RPC interface.

func (*Client) GetBalance 

func (c *Client) GetBalance(ctx context.Context, address types.Address, block types.BlockNumber) (*big.Int, error)

GetBalance implements the RPC interface.

func (*Client) GetBlockFilterChanges added in v0.6.1 

func (c *Client) GetBlockFilterChanges(ctx context.Context, id *big.Int) ([]types.Hash, error)

GetBlockFilterChanges implements the RPC interface.

func (*Client) GetBlockReceipts added in v0.6.1 

func (c *Client) GetBlockReceipts(ctx context.Context, block types.BlockNumber) ([]*types.TransactionReceipt, error)

GetBlockReceipts implements the RPC interface.

func (*Client) GetBlockTransactionCountByHash 

func (c *Client) GetBlockTransactionCountByHash(ctx context.Context, hash types.Hash) (uint64, error)

GetBlockTransactionCountByHash implements the RPC interface.

func (*Client) GetBlockTransactionCountByNumber 

func (c *Client) GetBlockTransactionCountByNumber(ctx context.Context, number types.BlockNumber) (uint64, error)

GetBlockTransactionCountByNumber implements the RPC interface.

func (*Client) GetCode 

func (c *Client) GetCode(ctx context.Context, account types.Address, block types.BlockNumber) ([]byte, error)

GetCode implements the RPC interface.

func (*Client) GetFilterChanges added in v0.6.1 

func (c *Client) GetFilterChanges(ctx context.Context, id *big.Int) ([]types.Log, error)

GetFilterChanges implements the RPC interface.

func (*Client) GetFilterLogs added in v0.6.1 

func (c *Client) GetFilterLogs(ctx context.Context, id *big.Int) ([]types.Log, error)

GetFilterLogs implements the RPC interface.

func (*Client) GetLogs 

func (c *Client) GetLogs(ctx context.Context, query *types.FilterLogsQuery) ([]types.Log, error)

GetLogs implements the RPC interface.

func (*Client) GetStorageAt 

func (c *Client) GetStorageAt(ctx context.Context, account types.Address, key types.Hash, block types.BlockNumber) (*types.Hash, error)

GetStorageAt implements the RPC interface.

func (*Client) GetTransactionByBlockHashAndIndex 

func (c *Client) GetTransactionByBlockHashAndIndex(ctx context.Context, hash types.Hash, index uint64) (*types.OnChainTransaction, error)

GetTransactionByBlockHashAndIndex implements the RPC interface.

func (*Client) GetTransactionByBlockNumberAndIndex 

func (c *Client) GetTransactionByBlockNumberAndIndex(ctx context.Context, number types.BlockNumber, index uint64) (*types.OnChainTransaction, error)

GetTransactionByBlockNumberAndIndex implements the RPC interface.

func (*Client) GetTransactionByHash 

func (c *Client) GetTransactionByHash(ctx context.Context, hash types.Hash) (*types.OnChainTransaction, error)

GetTransactionByHash implements the RPC interface.

func (*Client) GetTransactionCount 

func (c *Client) GetTransactionCount(ctx context.Context, account types.Address, block types.BlockNumber) (uint64, error)

GetTransactionCount implements the RPC interface.

func (*Client) GetTransactionReceipt 

func (c *Client) GetTransactionReceipt(ctx context.Context, hash types.Hash) (*types.TransactionReceipt, error)

GetTransactionReceipt implements the RPC interface.

func (*Client) GetUncleByBlockHashAndIndex added in v0.6.1 

func (c *Client) GetUncleByBlockHashAndIndex(ctx context.Context, hash types.Hash, index uint64) (*types.Block, error)

GetUncleByBlockHashAndIndex implements the RPC interface.

func (*Client) GetUncleByBlockNumberAndIndex added in v0.6.1 

func (c *Client) GetUncleByBlockNumberAndIndex(ctx context.Context, number types.BlockNumber, index uint64) (*types.Block, error)

GetUncleByBlockNumberAndIndex implements the RPC interface.

func (*Client) GetUncleCountByBlockHash 

func (c *Client) GetUncleCountByBlockHash(ctx context.Context, hash types.Hash) (uint64, error)

GetUncleCountByBlockHash implements the RPC interface.

func (*Client) GetUncleCountByBlockNumber 

func (c *Client) GetUncleCountByBlockNumber(ctx context.Context, number types.BlockNumber) (uint64, error)

GetUncleCountByBlockNumber implements the RPC interface.

func (*Client) Listening added in v0.6.1 

func (c *Client) Listening(ctx context.Context) (bool, error)

Listening implements the RPC interface.

func (*Client) MaxPriorityFeePerGas 

func (c *Client) MaxPriorityFeePerGas(ctx context.Context) (*big.Int, error)

MaxPriorityFeePerGas implements the RPC interface.

func (*Client) NetworkID added in v0.6.1 

func (c *Client) NetworkID(ctx context.Context) (uint64, error)

NetworkID implements the RPC interface.

func (*Client) NewBlockFilter added in v0.6.1 

func (c *Client) NewBlockFilter(ctx context.Context) (*big.Int, error)

NewBlockFilter implements the RPC interface.

func (*Client) NewFilter added in v0.6.1 

func (c *Client) NewFilter(ctx context.Context, query *types.FilterLogsQuery) (*big.Int, error)

NewFilter implements the RPC interface.

func (*Client) NewPendingTransactionFilter added in v0.6.1 

func (c *Client) NewPendingTransactionFilter(ctx context.Context) (*big.Int, error)

NewPendingTransactionFilter implements the RPC interface.

func (*Client) PeerCount added in v0.6.1 

func (c *Client) PeerCount(ctx context.Context) (uint64, error)

PeerCount implements the RPC interface.

func (*Client) PrepareTransaction added in v0.6.1 

func (c *Client) PrepareTransaction(ctx context.Context, tx *types.Transaction) (*types.Transaction, error)

PrepareTransaction prepares the transaction by applying transaction modifiers and setting the default address if it is not set.

A copy of the modified transaction is returned.

func (*Client) ProtocolVersion added in v0.6.1 

func (c *Client) ProtocolVersion(ctx context.Context) (uint64, error)

ProtocolVersion implements the RPC interface.

func (*Client) SendRawTransaction 

func (c *Client) SendRawTransaction(ctx context.Context, data []byte) (*types.Hash, error)

SendRawTransaction implements the RPC interface.

func (*Client) SendTransaction 

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

SendTransaction implements the RPC interface.

func (*Client) Sign 

func (c *Client) Sign(ctx context.Context, account types.Address, data []byte) (*types.Signature, error)

Sign implements the RPC interface.

func (*Client) SignTransaction 

func (c *Client) SignTransaction(ctx context.Context, tx *types.Transaction) ([]byte, *types.Transaction, error)

SignTransaction implements the RPC interface.

func (*Client) SubscribeLogs 

func (c *Client) SubscribeLogs(ctx context.Context, query *types.FilterLogsQuery) (<-chan types.Log, error)

SubscribeLogs implements the RPC interface.

func (*Client) SubscribeNewHeads 

func (c *Client) SubscribeNewHeads(ctx context.Context) (<-chan types.Block, error)

SubscribeNewHeads implements the RPC interface.

func (*Client) SubscribeNewPendingTransactions 

func (c *Client) SubscribeNewPendingTransactions(ctx context.Context) (<-chan types.Hash, error)

SubscribeNewPendingTransactions implements the RPC interface.

func (*Client) Syncing added in v0.6.1 

func (c *Client) Syncing(ctx context.Context) (*types.SyncStatus, error)

Syncing implements the RPC interface.

func (*Client) UninstallFilter added in v0.6.1 

func (c *Client) UninstallFilter(ctx context.Context, id *big.Int) (bool, error)

UninstallFilter implements the RPC interface.

type ClientOptions 

type ClientOptions func(c *Client) error

func WithDefaultAddress 

func WithDefaultAddress(addr types.Address) ClientOptions

WithDefaultAddress sets the call "from" address if it is not set in the following methods:

  • SignTransaction
  • SendTransaction
  • Call
  • EstimateGas

func WithKeys 

func WithKeys(keys ...wallet.Key) ClientOptions

WithKeys allows to set keys that will be used to sign data. It allows to emulate the behavior of the RPC methods that require a key.

The following methods are affected:

  • Accounts - returns the addresses of the provided keys
  • Sign - signs the data with the provided key
  • SignTransaction - signs transaction with the provided key
  • SendTransaction - signs transaction with the provided key and sends it using SendRawTransaction

func WithTXModifiers added in v0.3.1 

func WithTXModifiers(modifiers ...TXModifier) ClientOptions

WithTXModifiers allows to modify the transaction before it is signed and sent to the node.

Modifiers will be applied in the order they are provided.

func WithTransport 

func WithTransport(transport transport.Transport) ClientOptions

WithTransport sets the transport for the client.

type RPC 

type RPC interface {
	// ClientVersion performs web3_clientVersion RPC call.
	//
	// It returns the current client version.
	ClientVersion(ctx context.Context) (string, error)

	// Listening performs net_listening RPC call.
	//
	// It returns true if the client is actively listening for network.
	Listening(ctx context.Context) (bool, error)

	// PeerCount performs net_peerCount RPC call.
	//
	// It returns the number of connected peers.
	PeerCount(ctx context.Context) (uint64, error)

	// ProtocolVersion performs eth_protocolVersion RPC call.
	//
	// It returns the current Ethereum protocol version.
	ProtocolVersion(ctx context.Context) (uint64, error)

	// Syncing performs eth_syncing RPC call.
	//
	// It returns an object with data about the sync status or false.
	Syncing(ctx context.Context) (*types.SyncStatus, error)

	// NetworkID performs net_version RPC call.
	//
	// It returns the current network ID.
	NetworkID(ctx context.Context) (uint64, error)

	// ChainID performs eth_chainId RPC call.
	//
	// It returns the current chain ID.
	ChainID(ctx context.Context) (uint64, error)

	// GasPrice performs eth_gasPrice RPC call.
	//
	// It returns the current price per gas in wei.
	GasPrice(ctx context.Context) (*big.Int, error)

	// Accounts performs eth_accounts RPC call.
	//
	// It returns the list of addresses owned by the client.
	Accounts(ctx context.Context) ([]types.Address, error)

	// BlockNumber performs eth_blockNumber RPC call.
	//
	// It returns the current block number.
	BlockNumber(ctx context.Context) (*big.Int, error)

	// GetBalance performs eth_getBalance RPC call.
	//
	// It returns the balance of the account of given address in wei.
	GetBalance(ctx context.Context, address types.Address, block types.BlockNumber) (*big.Int, error)

	// GetStorageAt performs eth_getStorageAt RPC call.
	//
	// It returns the value of key in the contract storage at the given
	// address.
	GetStorageAt(ctx context.Context, account types.Address, key types.Hash, block types.BlockNumber) (*types.Hash, error)

	// GetTransactionCount performs eth_getTransactionCount RPC call.
	//
	// It returns the number of transactions sent from the given address.
	GetTransactionCount(ctx context.Context, account types.Address, block types.BlockNumber) (uint64, error)

	// GetBlockTransactionCountByHash performs eth_getBlockTransactionCountByHash RPC call.
	//
	// It returns the number of transactions in the block with the given hash.
	GetBlockTransactionCountByHash(ctx context.Context, hash types.Hash) (uint64, error)

	// GetBlockTransactionCountByNumber performs eth_getBlockTransactionCountByNumber RPC call.
	//
	// It returns the number of transactions in the block with the given block
	GetBlockTransactionCountByNumber(ctx context.Context, number types.BlockNumber) (uint64, error)

	// GetUncleCountByBlockHash performs eth_getUncleCountByBlockHash RPC call.
	//
	// It returns the number of uncles in the block with the given hash.
	GetUncleCountByBlockHash(ctx context.Context, hash types.Hash) (uint64, error)

	// GetUncleCountByBlockNumber performs eth_getUncleCountByBlockNumber RPC call.
	//
	// It returns the number of uncles in the block with the given block number.
	GetUncleCountByBlockNumber(ctx context.Context, number types.BlockNumber) (uint64, error)

	// GetCode performs eth_getCode RPC call.
	//
	// It returns the contract code at the given address.
	GetCode(ctx context.Context, account types.Address, block types.BlockNumber) ([]byte, error)

	// Sign performs eth_sign RPC call.
	//
	// It signs the given data with the given address.
	Sign(ctx context.Context, account types.Address, data []byte) (*types.Signature, error)

	// SignTransaction performs eth_signTransaction RPC call.
	//
	// It signs the given transaction.
	//
	// If transaction was internally mutated, the mutated call is returned.
	SignTransaction(ctx context.Context, tx *types.Transaction) ([]byte, *types.Transaction, error)

	// SendTransaction performs eth_sendTransaction RPC call.
	//
	// It sends a transaction to the network.
	//
	// If transaction was internally mutated, the mutated call is returned.
	SendTransaction(ctx context.Context, tx *types.Transaction) (*types.Hash, *types.Transaction, error)

	// SendRawTransaction performs eth_sendRawTransaction RPC call.
	//
	// It sends an encoded transaction to the network.
	SendRawTransaction(ctx context.Context, data []byte) (*types.Hash, error)

	// Call performs eth_call RPC call.
	//
	// It executes a new message call immediately without creating a
	// transaction on the blockchain.
	//
	// If call was internally mutated, the mutated call is returned.
	Call(ctx context.Context, call *types.Call, block types.BlockNumber) ([]byte, *types.Call, error)

	// EstimateGas performs eth_estimateGas RPC call.
	//
	// It estimates the gas necessary to execute a specific transaction.
	//
	// If call was internally mutated, the mutated call is returned.
	EstimateGas(ctx context.Context, call *types.Call, block types.BlockNumber) (uint64, *types.Call, error)

	// BlockByHash performs eth_getBlockByHash RPC call.
	//
	// It returns information about a block by hash.
	BlockByHash(ctx context.Context, hash types.Hash, full bool) (*types.Block, error)

	// BlockByNumber performs eth_getBlockByNumber RPC call.
	//
	// It returns the block with the given number.
	BlockByNumber(ctx context.Context, number types.BlockNumber, full bool) (*types.Block, error)

	// GetTransactionByHash performs eth_getTransactionByHash RPC call.
	//
	// It returns the information about a transaction requested by transaction.
	GetTransactionByHash(ctx context.Context, hash types.Hash) (*types.OnChainTransaction, error)

	// GetTransactionByBlockHashAndIndex performs eth_getTransactionByBlockHashAndIndex RPC call.
	//
	// It returns the information about a transaction requested by transaction.
	GetTransactionByBlockHashAndIndex(ctx context.Context, hash types.Hash, index uint64) (*types.OnChainTransaction, error)

	// GetTransactionByBlockNumberAndIndex performs eth_getTransactionByBlockNumberAndIndex RPC call.
	//
	// It returns the information about a transaction requested by transaction.
	GetTransactionByBlockNumberAndIndex(ctx context.Context, number types.BlockNumber, index uint64) (*types.OnChainTransaction, error)

	// GetTransactionReceipt performs eth_getTransactionReceipt RPC call.
	//
	// It returns the receipt of a transaction by transaction hash.
	GetTransactionReceipt(ctx context.Context, hash types.Hash) (*types.TransactionReceipt, error)

	// GetBlockReceipts performs eth_getBlockReceipts RPC call.
	//
	// It returns all transaction receipts for a given block hash or number.
	GetBlockReceipts(ctx context.Context, block types.BlockNumber) ([]*types.TransactionReceipt, error)

	// GetUncleByBlockHashAndIndex performs eth_getUncleByBlockNumberAndIndex RPC call.
	//
	// It returns information about an uncle of a block by number and uncle index position.
	GetUncleByBlockHashAndIndex(ctx context.Context, hash types.Hash, index uint64) (*types.Block, error)

	// GetUncleByBlockNumberAndIndex performs eth_getUncleByBlockNumberAndIndex RPC call.
	//
	// It returns information about an uncle of a block by hash and uncle index position.
	GetUncleByBlockNumberAndIndex(ctx context.Context, number types.BlockNumber, index uint64) (*types.Block, error)

	// NewFilter performs eth_newFilter RPC call.
	//
	// It creates a filter object based on the given filter options. To check
	// if the state has changed, use GetFilterChanges.
	NewFilter(ctx context.Context, query *types.FilterLogsQuery) (*big.Int, error)

	// NewBlockFilter performs eth_newBlockFilter RPC call.
	//
	// It creates a filter in the node, to notify when a new block arrives. To
	// check if the state has changed, use GetBlockFilterChanges.
	NewBlockFilter(ctx context.Context) (*big.Int, error)

	// NewPendingTransactionFilter performs eth_newPendingTransactionFilter RPC call.
	//
	// It creates a filter in the node, to notify when new pending transactions
	// arrive. To check if the state has changed, use GetFilterChanges.
	NewPendingTransactionFilter(ctx context.Context) (*big.Int, error)

	// UninstallFilter performs eth_uninstallFilter RPC call.
	//
	// It uninstalls a filter with given ID. Should always be called when watch
	// is no longer needed.
	UninstallFilter(ctx context.Context, id *big.Int) (bool, error)

	// GetFilterChanges performs eth_getFilterChanges RPC call.
	//
	// It returns an array of logs that occurred since the given filter ID.
	GetFilterChanges(ctx context.Context, id *big.Int) ([]types.Log, error)

	// GetBlockFilterChanges performs eth_getFilterChanges RPC call.
	//
	// It returns an array of block hashes that occurred since the given filter ID.
	GetBlockFilterChanges(ctx context.Context, id *big.Int) ([]types.Hash, error)

	// GetFilterLogs performs eth_getFilterLogs RPC call.
	//
	// It returns an array of all logs matching filter with given ID.
	GetFilterLogs(ctx context.Context, id *big.Int) ([]types.Log, error)

	// GetLogs performs eth_getLogs RPC call.
	//
	// It returns logs that match the given query.
	GetLogs(ctx context.Context, query *types.FilterLogsQuery) ([]types.Log, error)

	// MaxPriorityFeePerGas performs eth_maxPriorityFeePerGas RPC call.
	//
	// It returns the estimated maximum priority fee per gas.
	MaxPriorityFeePerGas(ctx context.Context) (*big.Int, error)

	// SubscribeLogs performs eth_subscribe RPC call with "logs" subscription
	// type.
	//
	// It creates a subscription that will send logs that match the given query.
	//
	// Subscription channel will be closed when the context is canceled.
	SubscribeLogs(ctx context.Context, query *types.FilterLogsQuery) (<-chan types.Log, error)

	// SubscribeNewHeads performs eth_subscribe RPC call with "newHeads"
	// subscription type.
	//
	// It creates a subscription that will send new block headers.
	//
	// Subscription channel will be closed when the context is canceled.
	SubscribeNewHeads(ctx context.Context) (<-chan types.Block, error)

	// SubscribeNewPendingTransactions performs eth_subscribe RPC call with
	// "newPendingTransactions" subscription type.
	//
	// It creates a subscription that will send new pending transactions.
	//
	// Subscription channel will be closed when the context is canceled.
	SubscribeNewPendingTransactions(ctx context.Context) (<-chan types.Hash, error)
}

RPC is an RPC client for the Ethereum-compatible nodes.

type TXModifier added in v0.3.1 

type TXModifier interface {
	Modify(ctx context.Context, client RPC, tx *types.Transaction) error
}

TXModifier allows to modify the transaction before it is signed or sent to the node.

type TXModifierFunc added in v0.3.1 

type TXModifierFunc func(ctx context.Context, client RPC, tx *types.Transaction) error

func (TXModifierFunc) Modify added in v0.3.1 

func (f TXModifierFunc) Modify(ctx context.Context, client RPC, tx *types.Transaction) error

Source Files

View all Source files

Directories

Path Synopsis

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.