2016-08-09 17:01:13 -05:00
|
|
|
// Copyright 2016 The go-ethereum Authors
|
|
|
|
// This file is part of the go-ethereum library.
|
|
|
|
//
|
|
|
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
|
|
|
// it under the terms of the GNU Lesser General Public License as published by
|
|
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
|
|
// (at your option) any later version.
|
|
|
|
//
|
|
|
|
// The go-ethereum library is distributed in the hope that it will be useful,
|
|
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
// GNU Lesser General Public License for more details.
|
|
|
|
//
|
|
|
|
// You should have received a copy of the GNU Lesser General Public License
|
|
|
|
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
|
|
// Package ethclient provides a client for the Ethereum RPC API.
|
|
|
|
package ethclient
|
|
|
|
|
|
|
|
import (
|
2017-03-22 12:20:33 -05:00
|
|
|
"context"
|
2016-08-09 17:01:13 -05:00
|
|
|
"encoding/json"
|
2017-10-01 04:03:28 -05:00
|
|
|
"errors"
|
2016-08-09 17:01:13 -05:00
|
|
|
"fmt"
|
|
|
|
"math/big"
|
|
|
|
|
|
|
|
"github.com/ethereum/go-ethereum"
|
|
|
|
"github.com/ethereum/go-ethereum/common"
|
2016-11-27 17:41:25 -06:00
|
|
|
"github.com/ethereum/go-ethereum/common/hexutil"
|
2016-08-09 17:01:13 -05:00
|
|
|
"github.com/ethereum/go-ethereum/core/types"
|
|
|
|
"github.com/ethereum/go-ethereum/rpc"
|
|
|
|
)
|
|
|
|
|
|
|
|
// Client defines typed wrappers for the Ethereum RPC API.
|
|
|
|
type Client struct {
|
|
|
|
c *rpc.Client
|
|
|
|
}
|
|
|
|
|
|
|
|
// Dial connects a client to the given URL.
|
|
|
|
func Dial(rawurl string) (*Client, error) {
|
2018-04-19 08:36:33 -05:00
|
|
|
return DialContext(context.Background(), rawurl)
|
|
|
|
}
|
|
|
|
|
2023-05-11 02:09:16 -05:00
|
|
|
// DialContext connects a client to the given URL with context.
|
2018-04-19 08:36:33 -05:00
|
|
|
func DialContext(ctx context.Context, rawurl string) (*Client, error) {
|
|
|
|
c, err := rpc.DialContext(ctx, rawurl)
|
2016-08-09 17:01:13 -05:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
return NewClient(c), nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// NewClient creates a client that uses the given RPC client.
|
|
|
|
func NewClient(c *rpc.Client) *Client {
|
|
|
|
return &Client{c}
|
|
|
|
}
|
|
|
|
|
2023-05-11 02:09:16 -05:00
|
|
|
// Close closes the underlying RPC connection.
|
2018-04-19 08:36:33 -05:00
|
|
|
func (ec *Client) Close() {
|
|
|
|
ec.c.Close()
|
|
|
|
}
|
|
|
|
|
2023-05-11 02:09:16 -05:00
|
|
|
// Client gets the underlying RPC client.
|
|
|
|
func (ec *Client) Client() *rpc.Client {
|
|
|
|
return ec.c
|
|
|
|
}
|
|
|
|
|
2016-08-09 17:01:13 -05:00
|
|
|
// Blockchain Access
|
|
|
|
|
2021-10-20 09:22:02 -05:00
|
|
|
// ChainID retrieves the current chain ID for transaction replay protection.
|
2019-06-11 06:12:33 -05:00
|
|
|
func (ec *Client) ChainID(ctx context.Context) (*big.Int, error) {
|
|
|
|
var result hexutil.Big
|
|
|
|
err := ec.c.CallContext(ctx, &result, "eth_chainId")
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
return (*big.Int)(&result), err
|
|
|
|
}
|
|
|
|
|
2016-08-09 17:01:13 -05:00
|
|
|
// 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 (ec *Client) BlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error) {
|
|
|
|
return ec.getBlock(ctx, "eth_getBlockByHash", hash, true)
|
|
|
|
}
|
|
|
|
|
|
|
|
// 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 (ec *Client) BlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error) {
|
|
|
|
return ec.getBlock(ctx, "eth_getBlockByNumber", toBlockNumArg(number), true)
|
|
|
|
}
|
|
|
|
|
2020-09-10 07:24:21 -05:00
|
|
|
// BlockNumber returns the most recent block number
|
|
|
|
func (ec *Client) BlockNumber(ctx context.Context) (uint64, error) {
|
|
|
|
var result hexutil.Uint64
|
2020-09-15 04:29:51 -05:00
|
|
|
err := ec.c.CallContext(ctx, &result, "eth_blockNumber")
|
2020-09-10 07:24:21 -05:00
|
|
|
return uint64(result), err
|
|
|
|
}
|
|
|
|
|
2022-05-11 00:05:55 -05:00
|
|
|
// PeerCount returns the number of p2p peers as reported by the net_peerCount method.
|
|
|
|
func (ec *Client) PeerCount(ctx context.Context) (uint64, error) {
|
|
|
|
var result hexutil.Uint64
|
|
|
|
err := ec.c.CallContext(ctx, &result, "net_peerCount")
|
|
|
|
return uint64(result), err
|
|
|
|
}
|
|
|
|
|
2023-08-15 07:35:48 -05:00
|
|
|
// BlockReceipts returns the receipts of a given block number or hash
|
|
|
|
func (ec *Client) BlockReceipts(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) ([]*types.Receipt, error) {
|
|
|
|
var r []*types.Receipt
|
|
|
|
err := ec.c.CallContext(ctx, &r, "eth_getBlockReceipts", blockNrOrHash)
|
|
|
|
if err == nil && r == nil {
|
|
|
|
return nil, ethereum.NotFound
|
|
|
|
}
|
|
|
|
return r, err
|
|
|
|
}
|
|
|
|
|
2016-08-09 17:01:13 -05:00
|
|
|
type rpcBlock struct {
|
2023-02-28 07:40:24 -06:00
|
|
|
Hash common.Hash `json:"hash"`
|
|
|
|
Transactions []rpcTransaction `json:"transactions"`
|
|
|
|
UncleHashes []common.Hash `json:"uncles"`
|
|
|
|
Withdrawals []*types.Withdrawal `json:"withdrawals,omitempty"`
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
func (ec *Client) getBlock(ctx context.Context, method string, args ...interface{}) (*types.Block, error) {
|
|
|
|
var raw json.RawMessage
|
|
|
|
err := ec.c.CallContext(ctx, &raw, method, args...)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2023-03-07 04:21:23 -06:00
|
|
|
|
2016-08-09 17:01:13 -05:00
|
|
|
// Decode header and transactions.
|
|
|
|
var head *types.Header
|
|
|
|
if err := json.Unmarshal(raw, &head); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2023-03-07 04:21:23 -06:00
|
|
|
// When the block is not found, the API returns JSON null.
|
|
|
|
if head == nil {
|
|
|
|
return nil, ethereum.NotFound
|
|
|
|
}
|
|
|
|
|
|
|
|
var body rpcBlock
|
2016-08-09 17:01:13 -05:00
|
|
|
if err := json.Unmarshal(raw, &body); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
// Quick-verify transaction and uncle lists. This mostly helps with debugging the server.
|
|
|
|
if head.UncleHash == types.EmptyUncleHash && len(body.UncleHashes) > 0 {
|
2023-05-24 05:39:49 -05:00
|
|
|
return nil, errors.New("server returned non-empty uncle list but block header indicates no uncles")
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
if head.UncleHash != types.EmptyUncleHash && len(body.UncleHashes) == 0 {
|
2023-05-24 05:39:49 -05:00
|
|
|
return nil, errors.New("server returned empty uncle list but block header indicates uncles")
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
2023-02-21 05:12:27 -06:00
|
|
|
if head.TxHash == types.EmptyTxsHash && len(body.Transactions) > 0 {
|
2023-05-24 05:39:49 -05:00
|
|
|
return nil, errors.New("server returned non-empty transaction list but block header indicates no transactions")
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
2023-02-21 05:12:27 -06:00
|
|
|
if head.TxHash != types.EmptyTxsHash && len(body.Transactions) == 0 {
|
2023-05-24 05:39:49 -05:00
|
|
|
return nil, errors.New("server returned empty transaction list but block header indicates transactions")
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
// Load uncles because they are not included in the block response.
|
|
|
|
var uncles []*types.Header
|
|
|
|
if len(body.UncleHashes) > 0 {
|
|
|
|
uncles = make([]*types.Header, len(body.UncleHashes))
|
|
|
|
reqs := make([]rpc.BatchElem, len(body.UncleHashes))
|
|
|
|
for i := range reqs {
|
|
|
|
reqs[i] = rpc.BatchElem{
|
|
|
|
Method: "eth_getUncleByBlockHashAndIndex",
|
2016-11-29 06:59:00 -06:00
|
|
|
Args: []interface{}{body.Hash, hexutil.EncodeUint64(uint64(i))},
|
2016-08-09 17:01:13 -05:00
|
|
|
Result: &uncles[i],
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if err := ec.c.BatchCallContext(ctx, reqs); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
for i := range reqs {
|
|
|
|
if reqs[i].Error != nil {
|
|
|
|
return nil, reqs[i].Error
|
|
|
|
}
|
2016-11-29 06:57:46 -06:00
|
|
|
if uncles[i] == nil {
|
|
|
|
return nil, fmt.Errorf("got null header for uncle %d of block %x", i, body.Hash[:])
|
|
|
|
}
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
}
|
2017-10-01 04:03:28 -05:00
|
|
|
// Fill the sender cache of transactions in the block.
|
|
|
|
txs := make([]*types.Transaction, len(body.Transactions))
|
|
|
|
for i, tx := range body.Transactions {
|
2018-06-11 02:41:09 -05:00
|
|
|
if tx.From != nil {
|
|
|
|
setSenderFromServer(tx.tx, *tx.From, body.Hash)
|
|
|
|
}
|
2017-10-01 04:03:28 -05:00
|
|
|
txs[i] = tx.tx
|
|
|
|
}
|
2023-02-28 07:40:24 -06:00
|
|
|
return types.NewBlockWithHeader(head).WithBody(txs, uncles).WithWithdrawals(body.Withdrawals), nil
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// HeaderByHash returns the block header with the given hash.
|
|
|
|
func (ec *Client) HeaderByHash(ctx context.Context, hash common.Hash) (*types.Header, error) {
|
|
|
|
var head *types.Header
|
|
|
|
err := ec.c.CallContext(ctx, &head, "eth_getBlockByHash", hash, false)
|
2016-11-29 08:54:06 -06:00
|
|
|
if err == nil && head == nil {
|
|
|
|
err = ethereum.NotFound
|
|
|
|
}
|
2016-08-09 17:01:13 -05:00
|
|
|
return head, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// HeaderByNumber returns a block header from the current canonical chain. If number is
|
|
|
|
// nil, the latest known header is returned.
|
|
|
|
func (ec *Client) HeaderByNumber(ctx context.Context, number *big.Int) (*types.Header, error) {
|
|
|
|
var head *types.Header
|
|
|
|
err := ec.c.CallContext(ctx, &head, "eth_getBlockByNumber", toBlockNumArg(number), false)
|
2016-11-29 08:54:06 -06:00
|
|
|
if err == nil && head == nil {
|
|
|
|
err = ethereum.NotFound
|
|
|
|
}
|
2016-08-09 17:01:13 -05:00
|
|
|
return head, err
|
|
|
|
}
|
|
|
|
|
2017-10-01 04:03:28 -05:00
|
|
|
type rpcTransaction struct {
|
|
|
|
tx *types.Transaction
|
|
|
|
txExtraInfo
|
|
|
|
}
|
|
|
|
|
|
|
|
type txExtraInfo struct {
|
2018-06-11 02:41:09 -05:00
|
|
|
BlockNumber *string `json:"blockNumber,omitempty"`
|
|
|
|
BlockHash *common.Hash `json:"blockHash,omitempty"`
|
|
|
|
From *common.Address `json:"from,omitempty"`
|
2017-10-01 04:03:28 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
func (tx *rpcTransaction) UnmarshalJSON(msg []byte) error {
|
|
|
|
if err := json.Unmarshal(msg, &tx.tx); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
return json.Unmarshal(msg, &tx.txExtraInfo)
|
|
|
|
}
|
|
|
|
|
2016-08-09 17:01:13 -05:00
|
|
|
// TransactionByHash returns the transaction with the given hash.
|
2016-11-29 08:54:06 -06:00
|
|
|
func (ec *Client) TransactionByHash(ctx context.Context, hash common.Hash) (tx *types.Transaction, isPending bool, err error) {
|
2017-10-01 04:03:28 -05:00
|
|
|
var json *rpcTransaction
|
|
|
|
err = ec.c.CallContext(ctx, &json, "eth_getTransactionByHash", hash)
|
2016-11-29 08:54:06 -06:00
|
|
|
if err != nil {
|
|
|
|
return nil, false, err
|
2017-10-01 04:03:28 -05:00
|
|
|
} else if json == nil {
|
2016-11-29 08:54:06 -06:00
|
|
|
return nil, false, ethereum.NotFound
|
2017-10-01 04:03:28 -05:00
|
|
|
} else if _, r, _ := json.tx.RawSignatureValues(); r == nil {
|
2023-05-24 05:39:49 -05:00
|
|
|
return nil, false, errors.New("server returned transaction without signature")
|
2016-11-29 08:54:06 -06:00
|
|
|
}
|
2018-06-11 02:41:09 -05:00
|
|
|
if json.From != nil && json.BlockHash != nil {
|
|
|
|
setSenderFromServer(json.tx, *json.From, *json.BlockHash)
|
|
|
|
}
|
2017-10-01 04:03:28 -05:00
|
|
|
return json.tx, json.BlockNumber == nil, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// 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.
|
|
|
|
func (ec *Client) TransactionSender(ctx context.Context, tx *types.Transaction, block common.Hash, index uint) (common.Address, error) {
|
|
|
|
// Try to load the address from the cache.
|
|
|
|
sender, err := types.Sender(&senderFromServer{blockhash: block}, tx)
|
|
|
|
if err == nil {
|
|
|
|
return sender, nil
|
|
|
|
}
|
2021-11-17 07:44:41 -06:00
|
|
|
|
|
|
|
// It was not found in cache, ask the server.
|
2017-10-01 04:03:28 -05:00
|
|
|
var meta struct {
|
|
|
|
Hash common.Hash
|
|
|
|
From common.Address
|
|
|
|
}
|
|
|
|
if err = ec.c.CallContext(ctx, &meta, "eth_getTransactionByBlockHashAndIndex", block, hexutil.Uint64(index)); err != nil {
|
|
|
|
return common.Address{}, err
|
|
|
|
}
|
|
|
|
if meta.Hash == (common.Hash{}) || meta.Hash != tx.Hash() {
|
|
|
|
return common.Address{}, errors.New("wrong inclusion block/index")
|
2016-11-29 08:54:06 -06:00
|
|
|
}
|
2017-10-01 04:03:28 -05:00
|
|
|
return meta.From, nil
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// TransactionCount returns the total number of transactions in the given block.
|
|
|
|
func (ec *Client) TransactionCount(ctx context.Context, blockHash common.Hash) (uint, error) {
|
2016-11-27 17:41:25 -06:00
|
|
|
var num hexutil.Uint
|
2016-08-09 17:01:13 -05:00
|
|
|
err := ec.c.CallContext(ctx, &num, "eth_getBlockTransactionCountByHash", blockHash)
|
2016-11-27 17:41:25 -06:00
|
|
|
return uint(num), err
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// TransactionInBlock returns a single transaction at index in the given block.
|
|
|
|
func (ec *Client) TransactionInBlock(ctx context.Context, blockHash common.Hash, index uint) (*types.Transaction, error) {
|
2017-10-01 04:03:28 -05:00
|
|
|
var json *rpcTransaction
|
|
|
|
err := ec.c.CallContext(ctx, &json, "eth_getTransactionByBlockHashAndIndex", blockHash, hexutil.Uint64(index))
|
2019-06-03 10:52:02 -05:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
if json == nil {
|
|
|
|
return nil, ethereum.NotFound
|
|
|
|
} else if _, r, _ := json.tx.RawSignatureValues(); r == nil {
|
2023-05-24 05:39:49 -05:00
|
|
|
return nil, errors.New("server returned transaction without signature")
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
2018-06-11 02:41:09 -05:00
|
|
|
if json.From != nil && json.BlockHash != nil {
|
|
|
|
setSenderFromServer(json.tx, *json.From, *json.BlockHash)
|
|
|
|
}
|
2017-10-01 04:03:28 -05:00
|
|
|
return json.tx, err
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// TransactionReceipt returns the receipt of a transaction by transaction hash.
|
|
|
|
// Note that the receipt is not available for pending transactions.
|
|
|
|
func (ec *Client) TransactionReceipt(ctx context.Context, txHash common.Hash) (*types.Receipt, error) {
|
|
|
|
var r *types.Receipt
|
|
|
|
err := ec.c.CallContext(ctx, &r, "eth_getTransactionReceipt", txHash)
|
2016-11-29 08:54:06 -06:00
|
|
|
if err == nil {
|
|
|
|
if r == nil {
|
|
|
|
return nil, ethereum.NotFound
|
|
|
|
}
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
return r, err
|
|
|
|
}
|
|
|
|
|
2016-09-06 04:39:14 -05:00
|
|
|
// SyncProgress retrieves the current progress of the sync algorithm. If there's
|
|
|
|
// no sync currently running, it returns nil.
|
|
|
|
func (ec *Client) SyncProgress(ctx context.Context) (*ethereum.SyncProgress, error) {
|
|
|
|
var raw json.RawMessage
|
|
|
|
if err := ec.c.CallContext(ctx, &raw, "eth_syncing"); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
// Handle the possible response types
|
|
|
|
var syncing bool
|
|
|
|
if err := json.Unmarshal(raw, &syncing); err == nil {
|
|
|
|
return nil, nil // Not syncing (always false)
|
|
|
|
}
|
2022-01-05 09:12:47 -06:00
|
|
|
var p *rpcProgress
|
|
|
|
if err := json.Unmarshal(raw, &p); err != nil {
|
2016-09-06 04:39:14 -05:00
|
|
|
return nil, err
|
|
|
|
}
|
2022-01-05 09:12:47 -06:00
|
|
|
return p.toSyncProgress(), nil
|
2016-09-06 04:39:14 -05:00
|
|
|
}
|
|
|
|
|
2016-08-09 17:01:13 -05:00
|
|
|
// SubscribeNewHead subscribes to notifications about the current blockchain head
|
|
|
|
// on the given channel.
|
|
|
|
func (ec *Client) SubscribeNewHead(ctx context.Context, ch chan<- *types.Header) (ethereum.Subscription, error) {
|
2023-03-25 16:38:43 -05:00
|
|
|
sub, err := ec.c.EthSubscribe(ctx, ch, "newHeads")
|
|
|
|
if err != nil {
|
|
|
|
// Defensively prefer returning nil interface explicitly on error-path, instead
|
|
|
|
// of letting default golang behavior wrap it with non-nil interface that stores
|
|
|
|
// nil concrete type value.
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
return sub, nil
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// State Access
|
|
|
|
|
2022-11-16 01:44:54 -06:00
|
|
|
// NetworkID returns the network ID for this client.
|
2017-08-01 03:59:46 -05:00
|
|
|
func (ec *Client) NetworkID(ctx context.Context) (*big.Int, error) {
|
|
|
|
version := new(big.Int)
|
|
|
|
var ver string
|
|
|
|
if err := ec.c.CallContext(ctx, &ver, "net_version"); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
if _, ok := version.SetString(ver, 10); !ok {
|
|
|
|
return nil, fmt.Errorf("invalid net_version result %q", ver)
|
|
|
|
}
|
|
|
|
return version, nil
|
|
|
|
}
|
|
|
|
|
2016-08-09 17:01:13 -05:00
|
|
|
// 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 (ec *Client) BalanceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (*big.Int, error) {
|
2016-11-27 17:41:25 -06:00
|
|
|
var result hexutil.Big
|
2016-08-09 17:01:13 -05:00
|
|
|
err := ec.c.CallContext(ctx, &result, "eth_getBalance", account, toBlockNumArg(blockNumber))
|
|
|
|
return (*big.Int)(&result), err
|
|
|
|
}
|
|
|
|
|
|
|
|
// 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 (ec *Client) StorageAt(ctx context.Context, account common.Address, key common.Hash, blockNumber *big.Int) ([]byte, error) {
|
2016-11-27 17:41:25 -06:00
|
|
|
var result hexutil.Bytes
|
2016-08-09 17:01:13 -05:00
|
|
|
err := ec.c.CallContext(ctx, &result, "eth_getStorageAt", account, key, toBlockNumArg(blockNumber))
|
|
|
|
return result, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// 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 (ec *Client) CodeAt(ctx context.Context, account common.Address, blockNumber *big.Int) ([]byte, error) {
|
2016-11-27 17:41:25 -06:00
|
|
|
var result hexutil.Bytes
|
2016-08-09 17:01:13 -05:00
|
|
|
err := ec.c.CallContext(ctx, &result, "eth_getCode", account, toBlockNumArg(blockNumber))
|
|
|
|
return result, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// 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 (ec *Client) NonceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (uint64, error) {
|
2016-11-27 17:41:25 -06:00
|
|
|
var result hexutil.Uint64
|
2016-08-09 17:01:13 -05:00
|
|
|
err := ec.c.CallContext(ctx, &result, "eth_getTransactionCount", account, toBlockNumArg(blockNumber))
|
2016-11-27 17:41:25 -06:00
|
|
|
return uint64(result), err
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// Filters
|
|
|
|
|
|
|
|
// FilterLogs executes a filter query.
|
2017-01-05 07:03:50 -06:00
|
|
|
func (ec *Client) FilterLogs(ctx context.Context, q ethereum.FilterQuery) ([]types.Log, error) {
|
|
|
|
var result []types.Log
|
2018-11-08 06:26:47 -06:00
|
|
|
arg, err := toFilterArg(q)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
err = ec.c.CallContext(ctx, &result, "eth_getLogs", arg)
|
2016-08-09 17:01:13 -05:00
|
|
|
return result, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// SubscribeFilterLogs subscribes to the results of a streaming filter query.
|
2017-01-05 07:03:50 -06:00
|
|
|
func (ec *Client) SubscribeFilterLogs(ctx context.Context, q ethereum.FilterQuery, ch chan<- types.Log) (ethereum.Subscription, error) {
|
2018-11-08 06:26:47 -06:00
|
|
|
arg, err := toFilterArg(q)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2023-03-25 16:38:43 -05:00
|
|
|
sub, err := ec.c.EthSubscribe(ctx, ch, "logs", arg)
|
|
|
|
if err != nil {
|
|
|
|
// Defensively prefer returning nil interface explicitly on error-path, instead
|
|
|
|
// of letting default golang behavior wrap it with non-nil interface that stores
|
|
|
|
// nil concrete type value.
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
return sub, nil
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
|
2018-11-08 06:26:47 -06:00
|
|
|
func toFilterArg(q ethereum.FilterQuery) (interface{}, error) {
|
2016-08-09 17:01:13 -05:00
|
|
|
arg := map[string]interface{}{
|
2018-11-08 06:26:47 -06:00
|
|
|
"address": q.Addresses,
|
|
|
|
"topics": q.Topics,
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
2018-11-08 06:26:47 -06:00
|
|
|
if q.BlockHash != nil {
|
|
|
|
arg["blockHash"] = *q.BlockHash
|
|
|
|
if q.FromBlock != nil || q.ToBlock != nil {
|
2023-05-24 05:39:49 -05:00
|
|
|
return nil, errors.New("cannot specify both BlockHash and FromBlock/ToBlock")
|
2018-11-08 06:26:47 -06:00
|
|
|
}
|
|
|
|
} else {
|
|
|
|
if q.FromBlock == nil {
|
|
|
|
arg["fromBlock"] = "0x0"
|
|
|
|
} else {
|
|
|
|
arg["fromBlock"] = toBlockNumArg(q.FromBlock)
|
|
|
|
}
|
|
|
|
arg["toBlock"] = toBlockNumArg(q.ToBlock)
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
2018-11-08 06:26:47 -06:00
|
|
|
return arg, nil
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// Pending State
|
|
|
|
|
|
|
|
// PendingBalanceAt returns the wei balance of the given account in the pending state.
|
|
|
|
func (ec *Client) PendingBalanceAt(ctx context.Context, account common.Address) (*big.Int, error) {
|
2016-11-27 17:41:25 -06:00
|
|
|
var result hexutil.Big
|
2016-08-09 17:01:13 -05:00
|
|
|
err := ec.c.CallContext(ctx, &result, "eth_getBalance", account, "pending")
|
|
|
|
return (*big.Int)(&result), err
|
|
|
|
}
|
|
|
|
|
|
|
|
// PendingStorageAt returns the value of key in the contract storage of the given account in the pending state.
|
|
|
|
func (ec *Client) PendingStorageAt(ctx context.Context, account common.Address, key common.Hash) ([]byte, error) {
|
2016-11-27 17:41:25 -06:00
|
|
|
var result hexutil.Bytes
|
2016-08-09 17:01:13 -05:00
|
|
|
err := ec.c.CallContext(ctx, &result, "eth_getStorageAt", account, key, "pending")
|
|
|
|
return result, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// PendingCodeAt returns the contract code of the given account in the pending state.
|
|
|
|
func (ec *Client) PendingCodeAt(ctx context.Context, account common.Address) ([]byte, error) {
|
2016-11-27 17:41:25 -06:00
|
|
|
var result hexutil.Bytes
|
2016-08-09 17:01:13 -05:00
|
|
|
err := ec.c.CallContext(ctx, &result, "eth_getCode", account, "pending")
|
|
|
|
return result, err
|
|
|
|
}
|
|
|
|
|
|
|
|
// 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 (ec *Client) PendingNonceAt(ctx context.Context, account common.Address) (uint64, error) {
|
2016-11-27 17:41:25 -06:00
|
|
|
var result hexutil.Uint64
|
2016-08-09 17:01:13 -05:00
|
|
|
err := ec.c.CallContext(ctx, &result, "eth_getTransactionCount", account, "pending")
|
2016-11-27 17:41:25 -06:00
|
|
|
return uint64(result), err
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// PendingTransactionCount returns the total number of transactions in the pending state.
|
|
|
|
func (ec *Client) PendingTransactionCount(ctx context.Context) (uint, error) {
|
2016-11-27 17:41:25 -06:00
|
|
|
var num hexutil.Uint
|
2016-08-09 17:01:13 -05:00
|
|
|
err := ec.c.CallContext(ctx, &num, "eth_getBlockTransactionCountByNumber", "pending")
|
2016-11-27 17:41:25 -06:00
|
|
|
return uint(num), err
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// Contract Calling
|
|
|
|
|
|
|
|
// 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 (ec *Client) CallContract(ctx context.Context, msg ethereum.CallMsg, blockNumber *big.Int) ([]byte, error) {
|
2016-11-27 17:41:25 -06:00
|
|
|
var hex hexutil.Bytes
|
2016-08-09 17:01:13 -05:00
|
|
|
err := ec.c.CallContext(ctx, &hex, "eth_call", toCallArg(msg), toBlockNumArg(blockNumber))
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2016-11-27 17:41:25 -06:00
|
|
|
return hex, nil
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
|
2022-02-15 03:55:55 -06:00
|
|
|
// CallContractAtHash is almost the same as CallContract except that it selects
|
|
|
|
// the block by block hash instead of block height.
|
|
|
|
func (ec *Client) CallContractAtHash(ctx context.Context, msg ethereum.CallMsg, blockHash common.Hash) ([]byte, error) {
|
|
|
|
var hex hexutil.Bytes
|
|
|
|
err := ec.c.CallContext(ctx, &hex, "eth_call", toCallArg(msg), rpc.BlockNumberOrHashWithHash(blockHash, false))
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
return hex, nil
|
|
|
|
}
|
|
|
|
|
2016-08-09 17:01:13 -05:00
|
|
|
// PendingCallContract executes a message call transaction using the EVM.
|
|
|
|
// The state seen by the contract call is the pending state.
|
|
|
|
func (ec *Client) PendingCallContract(ctx context.Context, msg ethereum.CallMsg) ([]byte, error) {
|
2016-11-27 17:41:25 -06:00
|
|
|
var hex hexutil.Bytes
|
2016-08-09 17:01:13 -05:00
|
|
|
err := ec.c.CallContext(ctx, &hex, "eth_call", toCallArg(msg), "pending")
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2016-11-27 17:41:25 -06:00
|
|
|
return hex, nil
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// SuggestGasPrice retrieves the currently suggested gas price to allow a timely
|
|
|
|
// execution of a transaction.
|
|
|
|
func (ec *Client) SuggestGasPrice(ctx context.Context) (*big.Int, error) {
|
2016-11-27 17:41:25 -06:00
|
|
|
var hex hexutil.Big
|
2016-08-09 17:01:13 -05:00
|
|
|
if err := ec.c.CallContext(ctx, &hex, "eth_gasPrice"); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
return (*big.Int)(&hex), nil
|
|
|
|
}
|
|
|
|
|
2021-06-15 05:56:14 -05:00
|
|
|
// SuggestGasTipCap retrieves the currently suggested gas tip cap after 1559 to
|
|
|
|
// allow a timely execution of a transaction.
|
|
|
|
func (ec *Client) SuggestGasTipCap(ctx context.Context) (*big.Int, error) {
|
|
|
|
var hex hexutil.Big
|
|
|
|
if err := ec.c.CallContext(ctx, &hex, "eth_maxPriorityFeePerGas"); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
return (*big.Int)(&hex), nil
|
|
|
|
}
|
|
|
|
|
2022-07-29 11:22:04 -05:00
|
|
|
type feeHistoryResultMarshaling struct {
|
|
|
|
OldestBlock *hexutil.Big `json:"oldestBlock"`
|
|
|
|
Reward [][]*hexutil.Big `json:"reward,omitempty"`
|
|
|
|
BaseFee []*hexutil.Big `json:"baseFeePerGas,omitempty"`
|
|
|
|
GasUsedRatio []float64 `json:"gasUsedRatio"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// FeeHistory retrieves the fee market history.
|
|
|
|
func (ec *Client) FeeHistory(ctx context.Context, blockCount uint64, lastBlock *big.Int, rewardPercentiles []float64) (*ethereum.FeeHistory, error) {
|
|
|
|
var res feeHistoryResultMarshaling
|
|
|
|
if err := ec.c.CallContext(ctx, &res, "eth_feeHistory", hexutil.Uint(blockCount), toBlockNumArg(lastBlock), rewardPercentiles); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
reward := make([][]*big.Int, len(res.Reward))
|
|
|
|
for i, r := range res.Reward {
|
|
|
|
reward[i] = make([]*big.Int, len(r))
|
|
|
|
for j, r := range r {
|
|
|
|
reward[i][j] = (*big.Int)(r)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
baseFee := make([]*big.Int, len(res.BaseFee))
|
|
|
|
for i, b := range res.BaseFee {
|
|
|
|
baseFee[i] = (*big.Int)(b)
|
|
|
|
}
|
|
|
|
return ðereum.FeeHistory{
|
|
|
|
OldestBlock: (*big.Int)(res.OldestBlock),
|
|
|
|
Reward: reward,
|
|
|
|
BaseFee: baseFee,
|
|
|
|
GasUsedRatio: res.GasUsedRatio,
|
|
|
|
}, nil
|
|
|
|
}
|
|
|
|
|
2016-08-09 17:01:13 -05:00
|
|
|
// 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.
|
2017-11-13 05:47:27 -06:00
|
|
|
func (ec *Client) EstimateGas(ctx context.Context, msg ethereum.CallMsg) (uint64, error) {
|
|
|
|
var hex hexutil.Uint64
|
2016-08-09 17:01:13 -05:00
|
|
|
err := ec.c.CallContext(ctx, &hex, "eth_estimateGas", toCallArg(msg))
|
|
|
|
if err != nil {
|
2017-11-13 05:47:27 -06:00
|
|
|
return 0, err
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
2017-11-13 05:47:27 -06:00
|
|
|
return uint64(hex), nil
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// 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 (ec *Client) SendTransaction(ctx context.Context, tx *types.Transaction) error {
|
2021-02-25 08:26:57 -06:00
|
|
|
data, err := tx.MarshalBinary()
|
2016-08-09 17:01:13 -05:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2019-11-19 07:53:26 -06:00
|
|
|
return ec.c.CallContext(ctx, nil, "eth_sendRawTransaction", hexutil.Encode(data))
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
|
2021-06-30 04:03:01 -05:00
|
|
|
func toBlockNumArg(number *big.Int) string {
|
|
|
|
if number == nil {
|
|
|
|
return "latest"
|
|
|
|
}
|
2023-05-23 06:18:38 -05:00
|
|
|
if number.Sign() >= 0 {
|
|
|
|
return hexutil.EncodeBig(number)
|
2021-06-30 04:03:01 -05:00
|
|
|
}
|
2023-05-23 06:18:38 -05:00
|
|
|
// It's negative.
|
|
|
|
if number.IsInt64() {
|
|
|
|
return rpc.BlockNumber(number.Int64()).String()
|
2022-08-30 07:56:39 -05:00
|
|
|
}
|
2023-05-23 06:18:38 -05:00
|
|
|
// It's negative and large, which is invalid.
|
|
|
|
return fmt.Sprintf("<invalid %d>", number)
|
2021-06-30 04:03:01 -05:00
|
|
|
}
|
|
|
|
|
2016-08-09 17:01:13 -05:00
|
|
|
func toCallArg(msg ethereum.CallMsg) interface{} {
|
|
|
|
arg := map[string]interface{}{
|
|
|
|
"from": msg.From,
|
|
|
|
"to": msg.To,
|
|
|
|
}
|
|
|
|
if len(msg.Data) > 0 {
|
2023-09-08 11:33:36 -05:00
|
|
|
arg["input"] = hexutil.Bytes(msg.Data)
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
if msg.Value != nil {
|
2016-11-27 17:41:25 -06:00
|
|
|
arg["value"] = (*hexutil.Big)(msg.Value)
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
2017-11-13 05:47:27 -06:00
|
|
|
if msg.Gas != 0 {
|
|
|
|
arg["gas"] = hexutil.Uint64(msg.Gas)
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
if msg.GasPrice != nil {
|
2016-11-27 17:41:25 -06:00
|
|
|
arg["gasPrice"] = (*hexutil.Big)(msg.GasPrice)
|
2016-08-09 17:01:13 -05:00
|
|
|
}
|
|
|
|
return arg
|
|
|
|
}
|
2022-01-05 09:12:47 -06:00
|
|
|
|
|
|
|
// rpcProgress is a copy of SyncProgress with hex-encoded fields.
|
|
|
|
type rpcProgress struct {
|
|
|
|
StartingBlock hexutil.Uint64
|
|
|
|
CurrentBlock hexutil.Uint64
|
|
|
|
HighestBlock hexutil.Uint64
|
|
|
|
|
|
|
|
PulledStates hexutil.Uint64
|
|
|
|
KnownStates hexutil.Uint64
|
|
|
|
|
|
|
|
SyncedAccounts hexutil.Uint64
|
|
|
|
SyncedAccountBytes hexutil.Uint64
|
|
|
|
SyncedBytecodes hexutil.Uint64
|
|
|
|
SyncedBytecodeBytes hexutil.Uint64
|
|
|
|
SyncedStorage hexutil.Uint64
|
|
|
|
SyncedStorageBytes hexutil.Uint64
|
|
|
|
HealedTrienodes hexutil.Uint64
|
|
|
|
HealedTrienodeBytes hexutil.Uint64
|
|
|
|
HealedBytecodes hexutil.Uint64
|
|
|
|
HealedBytecodeBytes hexutil.Uint64
|
|
|
|
HealingTrienodes hexutil.Uint64
|
|
|
|
HealingBytecode hexutil.Uint64
|
|
|
|
}
|
|
|
|
|
|
|
|
func (p *rpcProgress) toSyncProgress() *ethereum.SyncProgress {
|
|
|
|
if p == nil {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
return ðereum.SyncProgress{
|
|
|
|
StartingBlock: uint64(p.StartingBlock),
|
|
|
|
CurrentBlock: uint64(p.CurrentBlock),
|
|
|
|
HighestBlock: uint64(p.HighestBlock),
|
|
|
|
PulledStates: uint64(p.PulledStates),
|
|
|
|
KnownStates: uint64(p.KnownStates),
|
|
|
|
SyncedAccounts: uint64(p.SyncedAccounts),
|
|
|
|
SyncedAccountBytes: uint64(p.SyncedAccountBytes),
|
|
|
|
SyncedBytecodes: uint64(p.SyncedBytecodes),
|
|
|
|
SyncedBytecodeBytes: uint64(p.SyncedBytecodeBytes),
|
|
|
|
SyncedStorage: uint64(p.SyncedStorage),
|
|
|
|
SyncedStorageBytes: uint64(p.SyncedStorageBytes),
|
|
|
|
HealedTrienodes: uint64(p.HealedTrienodes),
|
|
|
|
HealedTrienodeBytes: uint64(p.HealedTrienodeBytes),
|
|
|
|
HealedBytecodes: uint64(p.HealedBytecodes),
|
|
|
|
HealedBytecodeBytes: uint64(p.HealedBytecodeBytes),
|
|
|
|
HealingTrienodes: uint64(p.HealingTrienodes),
|
|
|
|
HealingBytecode: uint64(p.HealingBytecode),
|
|
|
|
}
|
|
|
|
}
|