mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-02-26 07:37:20 +00:00
15a9e92bbd
Added methods `TraceCallWithCallTracer` and `TraceTransactionWithCallTracer`. Fixes #28182 --------- Co-authored-by: Sina Mahmoodi <itz.s1na@gmail.com>
409 lines
15 KiB
Go
409 lines
15 KiB
Go
// Copyright 2021 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 gethclient provides an RPC client for geth-specific APIs.
|
|
package gethclient
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"math/big"
|
|
"runtime"
|
|
"runtime/debug"
|
|
"time"
|
|
|
|
"github.com/ethereum/go-ethereum"
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/common/hexutil"
|
|
"github.com/ethereum/go-ethereum/core/types"
|
|
"github.com/ethereum/go-ethereum/eth/tracers"
|
|
"github.com/ethereum/go-ethereum/p2p"
|
|
"github.com/ethereum/go-ethereum/rpc"
|
|
)
|
|
|
|
// Client is a wrapper around rpc.Client that implements geth-specific functionality.
|
|
//
|
|
// If you want to use the standardized Ethereum RPC functionality, use ethclient.Client instead.
|
|
type Client struct {
|
|
c *rpc.Client
|
|
}
|
|
|
|
// New creates a client that uses the given RPC client.
|
|
func New(c *rpc.Client) *Client {
|
|
return &Client{c}
|
|
}
|
|
|
|
// CreateAccessList tries to create an access list for a specific transaction based on the
|
|
// current pending state of the blockchain.
|
|
func (ec *Client) CreateAccessList(ctx context.Context, msg ethereum.CallMsg) (*types.AccessList, uint64, string, error) {
|
|
type accessListResult struct {
|
|
Accesslist *types.AccessList `json:"accessList"`
|
|
Error string `json:"error,omitempty"`
|
|
GasUsed hexutil.Uint64 `json:"gasUsed"`
|
|
}
|
|
var result accessListResult
|
|
if err := ec.c.CallContext(ctx, &result, "eth_createAccessList", toCallArg(msg)); err != nil {
|
|
return nil, 0, "", err
|
|
}
|
|
return result.Accesslist, uint64(result.GasUsed), result.Error, nil
|
|
}
|
|
|
|
// AccountResult is the result of a GetProof operation.
|
|
type AccountResult struct {
|
|
Address common.Address `json:"address"`
|
|
AccountProof []string `json:"accountProof"`
|
|
Balance *big.Int `json:"balance"`
|
|
CodeHash common.Hash `json:"codeHash"`
|
|
Nonce uint64 `json:"nonce"`
|
|
StorageHash common.Hash `json:"storageHash"`
|
|
StorageProof []StorageResult `json:"storageProof"`
|
|
}
|
|
|
|
// StorageResult provides a proof for a key-value pair.
|
|
type StorageResult struct {
|
|
Key string `json:"key"`
|
|
Value *big.Int `json:"value"`
|
|
Proof []string `json:"proof"`
|
|
}
|
|
|
|
// GetProof returns the account and storage values of the specified account including the Merkle-proof.
|
|
// The block number can be nil, in which case the value is taken from the latest known block.
|
|
func (ec *Client) GetProof(ctx context.Context, account common.Address, keys []string, blockNumber *big.Int) (*AccountResult, error) {
|
|
type storageResult struct {
|
|
Key string `json:"key"`
|
|
Value *hexutil.Big `json:"value"`
|
|
Proof []string `json:"proof"`
|
|
}
|
|
|
|
type accountResult struct {
|
|
Address common.Address `json:"address"`
|
|
AccountProof []string `json:"accountProof"`
|
|
Balance *hexutil.Big `json:"balance"`
|
|
CodeHash common.Hash `json:"codeHash"`
|
|
Nonce hexutil.Uint64 `json:"nonce"`
|
|
StorageHash common.Hash `json:"storageHash"`
|
|
StorageProof []storageResult `json:"storageProof"`
|
|
}
|
|
|
|
// Avoid keys being 'null'.
|
|
if keys == nil {
|
|
keys = []string{}
|
|
}
|
|
|
|
var res accountResult
|
|
err := ec.c.CallContext(ctx, &res, "eth_getProof", account, keys, toBlockNumArg(blockNumber))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
// Turn hexutils back to normal data types
|
|
storageResults := make([]StorageResult, 0, len(res.StorageProof))
|
|
for _, st := range res.StorageProof {
|
|
storageResults = append(storageResults, StorageResult{
|
|
Key: st.Key,
|
|
Value: st.Value.ToInt(),
|
|
Proof: st.Proof,
|
|
})
|
|
}
|
|
result := AccountResult{
|
|
Address: res.Address,
|
|
AccountProof: res.AccountProof,
|
|
Balance: res.Balance.ToInt(),
|
|
Nonce: uint64(res.Nonce),
|
|
CodeHash: res.CodeHash,
|
|
StorageHash: res.StorageHash,
|
|
StorageProof: storageResults,
|
|
}
|
|
return &result, nil
|
|
}
|
|
|
|
// 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.
|
|
//
|
|
// overrides specifies a map of contract states that should be overwritten before executing
|
|
// the message call.
|
|
// Please use ethclient.CallContract instead if you don't need the override functionality.
|
|
func (ec *Client) CallContract(ctx context.Context, msg ethereum.CallMsg, blockNumber *big.Int, overrides *map[common.Address]OverrideAccount) ([]byte, error) {
|
|
var hex hexutil.Bytes
|
|
err := ec.c.CallContext(
|
|
ctx, &hex, "eth_call", toCallArg(msg),
|
|
toBlockNumArg(blockNumber), overrides,
|
|
)
|
|
return hex, err
|
|
}
|
|
|
|
// CallContractWithBlockOverrides 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.
|
|
//
|
|
// overrides specifies a map of contract states that should be overwritten before executing
|
|
// the message call.
|
|
//
|
|
// blockOverrides specifies block fields exposed to the EVM that can be overridden for the call.
|
|
//
|
|
// Please use ethclient.CallContract instead if you don't need the override functionality.
|
|
func (ec *Client) CallContractWithBlockOverrides(ctx context.Context, msg ethereum.CallMsg, blockNumber *big.Int, overrides *map[common.Address]OverrideAccount, blockOverrides BlockOverrides) ([]byte, error) {
|
|
var hex hexutil.Bytes
|
|
err := ec.c.CallContext(
|
|
ctx, &hex, "eth_call", toCallArg(msg),
|
|
toBlockNumArg(blockNumber), overrides, blockOverrides,
|
|
)
|
|
return hex, err
|
|
}
|
|
|
|
// GCStats retrieves the current garbage collection stats from a geth node.
|
|
func (ec *Client) GCStats(ctx context.Context) (*debug.GCStats, error) {
|
|
var result debug.GCStats
|
|
err := ec.c.CallContext(ctx, &result, "debug_gcStats")
|
|
return &result, err
|
|
}
|
|
|
|
// MemStats retrieves the current memory stats from a geth node.
|
|
func (ec *Client) MemStats(ctx context.Context) (*runtime.MemStats, error) {
|
|
var result runtime.MemStats
|
|
err := ec.c.CallContext(ctx, &result, "debug_memStats")
|
|
return &result, err
|
|
}
|
|
|
|
// SetHead sets the current head of the local chain by block number.
|
|
// Note, this is a destructive action and may severely damage your chain.
|
|
// Use with extreme caution.
|
|
func (ec *Client) SetHead(ctx context.Context, number *big.Int) error {
|
|
return ec.c.CallContext(ctx, nil, "debug_setHead", toBlockNumArg(number))
|
|
}
|
|
|
|
// GetNodeInfo retrieves the node info of a geth node.
|
|
func (ec *Client) GetNodeInfo(ctx context.Context) (*p2p.NodeInfo, error) {
|
|
var result p2p.NodeInfo
|
|
err := ec.c.CallContext(ctx, &result, "admin_nodeInfo")
|
|
return &result, err
|
|
}
|
|
|
|
// SubscribeFullPendingTransactions subscribes to new pending transactions.
|
|
func (ec *Client) SubscribeFullPendingTransactions(ctx context.Context, ch chan<- *types.Transaction) (*rpc.ClientSubscription, error) {
|
|
return ec.c.EthSubscribe(ctx, ch, "newPendingTransactions", true)
|
|
}
|
|
|
|
// SubscribePendingTransactions subscribes to new pending transaction hashes.
|
|
func (ec *Client) SubscribePendingTransactions(ctx context.Context, ch chan<- common.Hash) (*rpc.ClientSubscription, error) {
|
|
return ec.c.EthSubscribe(ctx, ch, "newPendingTransactions")
|
|
}
|
|
|
|
// TraceTransaction returns the structured logs created during the execution of EVM
|
|
// and returns them as a JSON object.
|
|
func (ec *Client) TraceTransaction(ctx context.Context, hash common.Hash, config *tracers.TraceConfig) (any, error) {
|
|
var result any
|
|
err := ec.c.CallContext(ctx, &result, "debug_traceTransaction", hash, config)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return result, nil
|
|
}
|
|
|
|
// TraceBlock returns the structured logs created during the execution of EVM
|
|
// and returns them as a JSON object.
|
|
func (ec *Client) TraceBlock(ctx context.Context, hash common.Hash, config *tracers.TraceConfig) (any, error) {
|
|
var result any
|
|
err := ec.c.CallContext(ctx, &result, "debug_traceBlockByHash", hash, config)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return result, nil
|
|
}
|
|
|
|
// CallTracerConfig configures the call tracer for
|
|
// TraceTransactionWithCallTracer and TraceCallWithCallTracer.
|
|
type CallTracerConfig struct {
|
|
// OnlyTopCall, when true, limits tracing to the main (top-level) call only.
|
|
OnlyTopCall bool
|
|
// WithLog, when true, includes log emissions in the trace output.
|
|
WithLog bool
|
|
// Timeout is the maximum duration the tracer may run.
|
|
// Zero means the server default (5s).
|
|
Timeout time.Duration
|
|
}
|
|
|
|
//go:generate go run github.com/fjl/gencodec -type CallLog -field-override callLogMarshaling -out gen_calllog_json.go
|
|
|
|
// CallLog represents a log emitted during a traced call.
|
|
type CallLog struct {
|
|
Address common.Address `json:"address"`
|
|
Topics []common.Hash `json:"topics"`
|
|
Data []byte `json:"data"`
|
|
Index uint `json:"index"`
|
|
Position uint `json:"position"`
|
|
}
|
|
|
|
type callLogMarshaling struct {
|
|
Data hexutil.Bytes
|
|
Index hexutil.Uint
|
|
Position hexutil.Uint
|
|
}
|
|
|
|
//go:generate go run github.com/fjl/gencodec -type CallFrame -field-override callFrameMarshaling -out gen_callframe_json.go
|
|
|
|
// CallFrame contains the result of a call tracer run.
|
|
type CallFrame struct {
|
|
Type string `json:"type"`
|
|
From common.Address `json:"from"`
|
|
Gas uint64 `json:"gas"`
|
|
GasUsed uint64 `json:"gasUsed"`
|
|
To *common.Address `json:"to,omitempty"`
|
|
Input []byte `json:"input"`
|
|
Output []byte `json:"output,omitempty"`
|
|
Error string `json:"error,omitempty"`
|
|
RevertReason string `json:"revertReason,omitempty"`
|
|
Calls []CallFrame `json:"calls,omitempty"`
|
|
Logs []CallLog `json:"logs,omitempty"`
|
|
Value *big.Int `json:"value,omitempty"`
|
|
}
|
|
|
|
type callFrameMarshaling struct {
|
|
Gas hexutil.Uint64
|
|
GasUsed hexutil.Uint64
|
|
Input hexutil.Bytes
|
|
Output hexutil.Bytes
|
|
Value *hexutil.Big
|
|
}
|
|
|
|
// TraceTransactionWithCallTracer traces a transaction with the call tracer
|
|
// and returns a typed CallFrame. If config is nil, defaults are used.
|
|
func (ec *Client) TraceTransactionWithCallTracer(ctx context.Context, txHash common.Hash, config *CallTracerConfig) (*CallFrame, error) {
|
|
var result CallFrame
|
|
err := ec.c.CallContext(ctx, &result, "debug_traceTransaction", txHash, callTracerConfig(config))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return &result, nil
|
|
}
|
|
|
|
// TraceCallWithCallTracer executes a call with the call tracer and returns
|
|
// a typed CallFrame. blockNrOrHash selects the block context for the call.
|
|
// overrides specifies state overrides (nil for none), blockOverrides specifies
|
|
// block header overrides (nil for none), and config configures the tracer
|
|
// (nil for defaults).
|
|
func (ec *Client) TraceCallWithCallTracer(ctx context.Context, msg ethereum.CallMsg, blockNrOrHash rpc.BlockNumberOrHash, overrides map[common.Address]OverrideAccount, blockOverrides *BlockOverrides, config *CallTracerConfig) (*CallFrame, error) {
|
|
var result CallFrame
|
|
err := ec.c.CallContext(ctx, &result, "debug_traceCall", toCallArg(msg), blockNrOrHash, callTraceCallConfig(config, overrides, blockOverrides))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return &result, nil
|
|
}
|
|
|
|
// callTracerConfig converts a CallTracerConfig to the wire-format TraceConfig.
|
|
func callTracerConfig(config *CallTracerConfig) *tracers.TraceConfig {
|
|
tracer := "callTracer"
|
|
tc := &tracers.TraceConfig{Tracer: &tracer}
|
|
if config != nil {
|
|
if config.OnlyTopCall || config.WithLog {
|
|
cfg, _ := json.Marshal(struct {
|
|
OnlyTopCall bool `json:"onlyTopCall"`
|
|
WithLog bool `json:"withLog"`
|
|
}{config.OnlyTopCall, config.WithLog})
|
|
tc.TracerConfig = cfg
|
|
}
|
|
if config.Timeout != 0 {
|
|
s := config.Timeout.String()
|
|
tc.Timeout = &s
|
|
}
|
|
}
|
|
return tc
|
|
}
|
|
|
|
// callTraceCallConfig builds the wire-format TraceCallConfig for debug_traceCall,
|
|
// bundling tracer settings with optional state and block overrides.
|
|
func callTraceCallConfig(config *CallTracerConfig, overrides map[common.Address]OverrideAccount, blockOverrides *BlockOverrides) interface{} {
|
|
tc := callTracerConfig(config)
|
|
// debug_traceCall expects a single config object that includes both
|
|
// tracer settings and any state/block overrides.
|
|
type traceCallConfig struct {
|
|
*tracers.TraceConfig
|
|
StateOverrides map[common.Address]OverrideAccount `json:"stateOverrides,omitempty"`
|
|
BlockOverrides *BlockOverrides `json:"blockOverrides,omitempty"`
|
|
}
|
|
return &traceCallConfig{
|
|
TraceConfig: tc,
|
|
StateOverrides: overrides,
|
|
BlockOverrides: blockOverrides,
|
|
}
|
|
}
|
|
|
|
func toBlockNumArg(number *big.Int) string {
|
|
if number == nil {
|
|
return "latest"
|
|
}
|
|
if number.Sign() >= 0 {
|
|
return hexutil.EncodeBig(number)
|
|
}
|
|
// It's negative.
|
|
if number.IsInt64() {
|
|
return rpc.BlockNumber(number.Int64()).String()
|
|
}
|
|
// It's negative and large, which is invalid.
|
|
return fmt.Sprintf("<invalid %d>", number)
|
|
}
|
|
|
|
func toCallArg(msg ethereum.CallMsg) interface{} {
|
|
arg := map[string]interface{}{
|
|
"from": msg.From,
|
|
"to": msg.To,
|
|
}
|
|
if len(msg.Data) > 0 {
|
|
arg["input"] = hexutil.Bytes(msg.Data)
|
|
}
|
|
if msg.Value != nil {
|
|
arg["value"] = (*hexutil.Big)(msg.Value)
|
|
}
|
|
if msg.Gas != 0 {
|
|
arg["gas"] = hexutil.Uint64(msg.Gas)
|
|
}
|
|
if msg.GasPrice != nil {
|
|
arg["gasPrice"] = (*hexutil.Big)(msg.GasPrice)
|
|
}
|
|
if msg.GasFeeCap != nil {
|
|
arg["maxFeePerGas"] = (*hexutil.Big)(msg.GasFeeCap)
|
|
}
|
|
if msg.GasTipCap != nil {
|
|
arg["maxPriorityFeePerGas"] = (*hexutil.Big)(msg.GasTipCap)
|
|
}
|
|
if msg.AccessList != nil {
|
|
arg["accessList"] = msg.AccessList
|
|
}
|
|
if msg.BlobGasFeeCap != nil {
|
|
arg["maxFeePerBlobGas"] = (*hexutil.Big)(msg.BlobGasFeeCap)
|
|
}
|
|
if msg.BlobHashes != nil {
|
|
arg["blobVersionedHashes"] = msg.BlobHashes
|
|
}
|
|
if msg.AuthorizationList != nil {
|
|
arg["authorizationList"] = msg.AuthorizationList
|
|
}
|
|
return arg
|
|
}
|
|
|
|
// OverrideAccount is an alias for ethereum.OverrideAccount.
|
|
type OverrideAccount = ethereum.OverrideAccount
|
|
|
|
// BlockOverrides is an alias for ethereum.BlockOverrides.
|
|
type BlockOverrides = ethereum.BlockOverrides
|