core/tracing: register live tracer APIs

cmd/utils/flags.go

@@ -2190,7 +2190,7 @@ func MakeChain(ctx *cli.Context, stack *node.Node, readonly bool) (*core.BlockCh
 			if ctx.IsSet(VMTraceJsonConfigFlag.Name) {
 				config = json.RawMessage(ctx.String(VMTraceJsonConfigFlag.Name))
 			}
-			t, err := tracers.LiveDirectory.New(name, config)
+			t, err := tracers.LiveDirectory.New(name, config, stack, nil)
 			if err != nil {
 				Fatalf("Failed to create tracer %q: %v", name, err)
 			}

console/console.go

@@ -221,7 +221,7 @@ func (c *Console) initExtensions() error {
 			continue
 		}
 		aliases[api] = struct{}{}
-		if file, ok := web3ext.Modules[api]; ok {
+		if file := web3ext.DefaultModules.Get(api); file != "" {
 			if err = c.jsre.Compile(api+".js", file); err != nil {
 				return fmt.Errorf("%s.js: %v", api, err)
 			}

core/blockchain.go

@@ -258,7 +258,6 @@ type BlockChain struct {
 	prefetcher Prefetcher
 	processor  Processor // Block transaction processor interface
 	vmConfig   vm.Config
-	logger     *tracing.Hooks
 }
 
 // NewBlockChain returns a fully initialised block chain using information
@@ -301,7 +300,6 @@ func NewBlockChain(db ethdb.Database, cacheConfig *CacheConfig, genesis *Genesis
 		txLookupCache: lru.NewCache[common.Hash, txLookup](txLookupCacheLimit),
 		engine:        engine,
 		vmConfig:      vmConfig,
-		logger:        vmConfig.Tracer,
 	}
 	var err error
 	bc.hc, err = NewHeaderChain(db, chainConfig, engine, bc.insertStopped)
@@ -411,10 +409,11 @@ func NewBlockChain(db ethdb.Database, cacheConfig *CacheConfig, genesis *Genesis
 	// it in advance.
 	bc.engine.VerifyHeader(bc, bc.CurrentHeader())
 
-	if bc.logger != nil && bc.logger.OnBlockchainInit != nil {
-		bc.logger.OnBlockchainInit(chainConfig)
+	logger := bc.logger()
+	if logger != nil && logger.OnBlockchainInit != nil {
+		logger.OnBlockchainInit(chainConfig)
 	}
-	if bc.logger != nil && bc.logger.OnGenesisBlock != nil {
+	if logger != nil && logger.OnGenesisBlock != nil {
 		if block := bc.CurrentBlock(); block.Number.Uint64() == 0 {
 			alloc, err := getGenesisState(bc.db, block.Hash())
 			if err != nil {
@@ -423,7 +422,7 @@ func NewBlockChain(db ethdb.Database, cacheConfig *CacheConfig, genesis *Genesis
 			if alloc == nil {
 				return nil, errors.New("live blockchain tracer requires genesis alloc to be set")
 			}
-			bc.logger.OnGenesisBlock(bc.genesisBlock, alloc)
+			logger.OnGenesisBlock(bc.genesisBlock, alloc)
 		}
 	}
 
@@ -1156,8 +1155,8 @@ func (bc *BlockChain) Stop() {
 		}
 	}
 	// Allow tracers to clean-up and release resources.
-	if bc.logger != nil && bc.logger.OnClose != nil {
-		bc.logger.OnClose()
+	if logger := bc.logger(); logger != nil && logger.OnClose != nil {
+		logger.OnClose()
 	}
 	// Close the trie database, release all the held resources as the last step.
 	if err := bc.triedb.Close(); err != nil {
@@ -1714,6 +1713,7 @@ func (bc *BlockChain) insertChain(chain types.Blocks, setHead bool, makeWitness
 	// Track the singleton witness from this chain insertion (if any)
 	var witness *stateless.Witness
 
+	bclogger := bc.logger()
 	for ; block != nil && err == nil || errors.Is(err, ErrKnownBlock); block, err = it.next() {
 		// If the chain is terminating, stop processing blocks
 		if bc.insertStopped() {
@@ -1753,8 +1753,8 @@ func (bc *BlockChain) insertChain(chain types.Blocks, setHead bool, makeWitness
 				return nil, it.index, err
 			}
 			stats.processed++
-			if bc.logger != nil && bc.logger.OnSkippedBlock != nil {
-				bc.logger.OnSkippedBlock(tracing.BlockEvent{
+			if bclogger != nil && bclogger.OnSkippedBlock != nil {
+				bclogger.OnSkippedBlock(tracing.BlockEvent{
 					Block:     block,
 					TD:        bc.GetTd(block.ParentHash(), block.NumberU64()-1),
 					Finalized: bc.CurrentFinalBlock(),
@@ -1776,7 +1776,7 @@ func (bc *BlockChain) insertChain(chain types.Blocks, setHead bool, makeWitness
 		if err != nil {
 			return nil, it.index, err
 		}
-		statedb.SetLogger(bc.logger)
+		statedb.SetLogger(bclogger)
 
 		// If we are past Byzantium, enable prefetching to pull in trie node paths
 		// while processing transactions. Before Byzantium the prefetcher is mostly
@@ -1881,19 +1881,21 @@ type blockProcessingResult struct {
 // processBlock executes and validates the given block. If there was no error
 // it writes the block and associated state to database.
 func (bc *BlockChain) processBlock(block *types.Block, statedb *state.StateDB, start time.Time, setHead bool) (_ *blockProcessingResult, blockEndErr error) {
-	if bc.logger != nil && bc.logger.OnBlockStart != nil {
-		td := bc.GetTd(block.ParentHash(), block.NumberU64()-1)
-		bc.logger.OnBlockStart(tracing.BlockEvent{
-			Block:     block,
-			TD:        td,
-			Finalized: bc.CurrentFinalBlock(),
-			Safe:      bc.CurrentSafeBlock(),
-		})
-	}
-	if bc.logger != nil && bc.logger.OnBlockEnd != nil {
-		defer func() {
-			bc.logger.OnBlockEnd(blockEndErr)
-		}()
+	if logger := bc.logger(); logger != nil {
+		if logger.OnBlockStart != nil {
+			td := bc.GetTd(block.ParentHash(), block.NumberU64()-1)
+			logger.OnBlockStart(tracing.BlockEvent{
+				Block:     block,
+				TD:        td,
+				Finalized: bc.CurrentFinalBlock(),
+				Safe:      bc.CurrentSafeBlock(),
+			})
+		}
+		if logger.OnBlockEnd != nil {
+			defer func() {
+				logger.OnBlockEnd(blockEndErr)
+			}()
+		}
 	}
 
 	// Process block using the parent state as reference point
@@ -2537,3 +2539,8 @@ func (bc *BlockChain) SetTrieFlushInterval(interval time.Duration) {
 func (bc *BlockChain) GetTrieFlushInterval() time.Duration {
 	return time.Duration(bc.flushInterval.Load())
 }
+
+// logger returns the tracing logger
+func (bc *BlockChain) logger() *tracing.Hooks {
+	return bc.vmConfig.Tracer
+}

core/tracing/CHANGELOG.md

@@ -4,6 +4,25 @@ All notable changes to the tracing interface will be documented in this file.
 
 ## [Unreleased]
 
+This release gives live tracers the ability to register JSON-RPC APIs in existing or new namespaces.
+
+### Modified methods
+
+- The signature for constructing a live tracer has changed from `func(config json.RawMessage) (*Hooks, error)` to `func(config json.RawMessage, node tracing.Node, backend tracing.Backend) (*Hooks, error)`. The signature of the constructor for live tracers has been updated was previously not documented as part of the tracing interface. We have decided to include it now as changes to the constructor can break tracers.
+
+### New types
+
+- `tracing.Node`: A new interface which allows live tracers to register APIs.
+- `tracing.Backend`: A new interface allowing the tracers to query the database for chain info, i.e. blocks, headers, and transactions.
+
+## [v1.14.10]
+
+### Modified types
+
+- `OpContext`: Added `ContractCode()` method to retrieve the code of the current contract being executed. This change affects the `OpContext` interface which is an argument to the `OpcodeHook` and `FaultHook` hooks.
+
+## [v1.14.9]
+
 ### Modified types
 
 - `GasChangeReason` has been extended with the following reasons which will be enabled only post-Verkle. There shouldn't be any gas changes with those reasons prior to the fork.
@@ -93,7 +112,9 @@ The hooks `CaptureStart` and `CaptureEnd` have been removed. These hooks signale
 - `CaptureState` -> `OnOpcode(pc uint64, op byte, gas, cost uint64, scope tracing.OpContext, rData []byte, depth int, err error)`. `op` is of type `byte` which can be cast to `vm.OpCode` when necessary. A `*vm.ScopeContext` is not passed anymore. It is replaced by `tracing.OpContext` which offers access to the memory, stack and current contract.
 - `CaptureFault` -> `OnFault(pc uint64, op byte, gas, cost uint64, scope tracing.OpContext, depth int, err error)`. Similar to above.
 
-[unreleased]: https://github.com/ethereum/go-ethereum/compare/v1.14.8...master
-[v1.14.0]: https://github.com/ethereum/go-ethereum/releases/tag/v1.14.0
-[v1.14.3]: https://github.com/ethereum/go-ethereum/releases/tag/v1.14.3
+[unreleased]: https://github.com/ethereum/go-ethereum/compare/v1.14.10...master
+[v1.14.10]: https://github.com/ethereum/go-ethereum/releases/tag/v1.14.10
+[v1.14.9]: https://github.com/ethereum/go-ethereum/releases/tag/v1.14.9
 [v1.14.4]: https://github.com/ethereum/go-ethereum/releases/tag/v1.14.4
+[v1.14.3]: https://github.com/ethereum/go-ethereum/releases/tag/v1.14.3
+[v1.14.0]: https://github.com/ethereum/go-ethereum/releases/tag/v1.14.0

core/tracing/hooks.go

@@ -17,11 +17,14 @@
 package tracing
 
 import (
+	"context"
+	"encoding/json"
 	"math/big"
 
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/params"
+	"github.com/ethereum/go-ethereum/rpc"
 	"github.com/holiman/uint256"
 )
 
@@ -68,7 +71,26 @@ type BlockEvent struct {
 	Safe      *types.Header
 }
 
+// Backend interface provides the common API services (that are provided by
+// both full and light clients) with access to necessary functions.
+type Backend interface {
+	HeaderByHash(ctx context.Context, hash common.Hash) (*types.Header, error)
+	HeaderByNumber(ctx context.Context, number rpc.BlockNumber) (*types.Header, error)
+	BlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error)
+	BlockByNumber(ctx context.Context, number rpc.BlockNumber) (*types.Block, error)
+	GetTransaction(ctx context.Context, txHash common.Hash) (bool, *types.Transaction, common.Hash, uint64, uint64, error)
+}
+
+// Node is the interface providing access to node-level
+// infra such as APIs and DBs.
+type Node interface {
+	RegisterAPIs(apis []rpc.API)
+}
+
 type (
+	// LiveConstructor is the constructor for a live tracer.
+	LiveConstructor = func(config json.RawMessage, stack Node, backend Backend) (*Hooks, error)
+
 	/*
 		- VM events -
 	*/

eth/backend.go

@@ -180,6 +180,12 @@ func New(stack *node.Node, config *ethconfig.Config) (*Ethereum, error) {
 			rawdb.WriteDatabaseVersion(chainDb, core.BlockChainVersion)
 		}
 	}
+
+	eth.APIBackend = &EthAPIBackend{stack.Config().ExtRPCEnabled(), stack.Config().AllowUnprotectedTxs, eth, nil}
+	if eth.APIBackend.allowUnprotectedTxs {
+		log.Info("Unprotected transactions allowed")
+	}
+
 	var (
 		vmConfig = vm.Config{
 			EnablePreimageRecording: config.EnablePreimageRecording,
@@ -201,7 +207,7 @@ func New(stack *node.Node, config *ethconfig.Config) (*Ethereum, error) {
 		if config.VMTraceJsonConfig != "" {
 			traceConfig = json.RawMessage(config.VMTraceJsonConfig)
 		}
-		t, err := tracers.LiveDirectory.New(config.VMTrace, traceConfig)
+		t, err := tracers.LiveDirectory.New(config.VMTrace, traceConfig, stack, eth.APIBackend)
 		if err != nil {
 			return nil, fmt.Errorf("failed to create tracer %s: %v", config.VMTrace, err)
 		}
@@ -254,10 +260,7 @@ func New(stack *node.Node, config *ethconfig.Config) (*Ethereum, error) {
 	eth.miner = miner.New(eth, config.Miner, eth.engine)
 	eth.miner.SetExtra(makeExtraData(config.Miner.ExtraData))
 
-	eth.APIBackend = &EthAPIBackend{stack.Config().ExtRPCEnabled(), stack.Config().AllowUnprotectedTxs, eth, nil}
-	if eth.APIBackend.allowUnprotectedTxs {
-		log.Info("Unprotected transactions allowed")
-	}
+	// Start the gas price oracle after blockchain is fully loaded
 	eth.APIBackend.gpo = gasprice.NewOracle(eth.APIBackend, config.GPO, config.Miner.GasPrice)
 
 	// Start the RPC service

eth/tracers/internal/tracetest/supply_test.go

@@ -552,7 +552,7 @@ func testSupplyTracer(t *testing.T, genesis *core.Genesis, gen func(*core.BlockG
 	traceOutputFilename := path.Join(traceOutputPath, "supply.jsonl")
 
 	// Load supply tracer
-	tracer, err := tracers.LiveDirectory.New("supply", json.RawMessage(fmt.Sprintf(`{"path":"%s"}`, traceOutputPath)))
+	tracer, err := tracers.LiveDirectory.New("supply", json.RawMessage(fmt.Sprintf(`{"path":"%s"}`, traceOutputPath)), nil, nil)
 	if err != nil {
 		return nil, nil, fmt.Errorf("failed to create call tracer: %v", err)
 	}

eth/tracers/live.go

@@ -7,25 +7,23 @@ import (
 	"github.com/ethereum/go-ethereum/core/tracing"
 )
 
-type ctorFunc func(config json.RawMessage) (*tracing.Hooks, error)
-
 // LiveDirectory is the collection of tracers which can be used
 // during normal block import operations.
-var LiveDirectory = liveDirectory{elems: make(map[string]ctorFunc)}
+var LiveDirectory = liveDirectory{elems: make(map[string]tracing.LiveConstructor)}
 
 type liveDirectory struct {
-	elems map[string]ctorFunc
+	elems map[string]tracing.LiveConstructor
 }
 
 // Register registers a tracer constructor by name.
-func (d *liveDirectory) Register(name string, f ctorFunc) {
+func (d *liveDirectory) Register(name string, f tracing.LiveConstructor) {
 	d.elems[name] = f
 }
 
 // New instantiates a tracer by name.
-func (d *liveDirectory) New(name string, config json.RawMessage) (*tracing.Hooks, error) {
+func (d *liveDirectory) New(name string, config json.RawMessage, stack tracing.Node, backend tracing.Backend) (*tracing.Hooks, error) {
 	if f, ok := d.elems[name]; ok {
-		return f(config)
+		return f(config, stack, backend)
 	}
 	return nil, errors.New("not found")
 }

eth/tracers/live/noop.go

@@ -21,7 +21,7 @@ func init() {
 // as soon as we have a real live tracer.
 type noop struct{}
 
-func newNoopTracer(_ json.RawMessage) (*tracing.Hooks, error) {
+func newNoopTracer(_ json.RawMessage, _ tracing.Node, _ tracing.Backend) (*tracing.Hooks, error) {
 	t := &noop{}
 	return &tracing.Hooks{
 		OnTxStart:        t.OnTxStart,

eth/tracers/live/supply.go

@@ -74,7 +74,7 @@ type supplyTracerConfig struct {
 	MaxSize int    `json:"maxSize"` // MaxSize is the maximum size in megabytes of the tracer log file before it gets rotated. It defaults to 100 megabytes.
 }
 
-func newSupply(cfg json.RawMessage) (*tracing.Hooks, error) {
+func newSupply(cfg json.RawMessage, _ tracing.Node, _ tracing.Backend) (*tracing.Hooks, error) {
 	var config supplyTracerConfig
 	if cfg != nil {
 		if err := json.Unmarshal(cfg, &config); err != nil {

internal/web3ext/web3ext.go

@@ -17,17 +17,40 @@
 // Package web3ext contains geth specific web3.js extensions.
 package web3ext
 
-var Modules = map[string]string{
-	"admin":    AdminJs,
-	"clique":   CliqueJs,
-	"debug":    DebugJs,
-	"eth":      EthJs,
-	"miner":    MinerJs,
-	"net":      NetJs,
-	"personal": PersonalJs,
-	"rpc":      RpcJs,
-	"txpool":   TxpoolJs,
-	"dev":      DevJs,
+import "fmt"
+
+type ModuleDirectory struct {
+	modules map[string]string
+}
+
+var DefaultModules = &ModuleDirectory{
+	modules: map[string]string{
+		"admin":    AdminJs,
+		"clique":   CliqueJs,
+		"debug":    DebugJs,
+		"eth":      EthJs,
+		"miner":    MinerJs,
+		"net":      NetJs,
+		"personal": PersonalJs,
+		"rpc":      RpcJs,
+		"txpool":   TxpoolJs,
+		"dev":      DevJs,
+	},
+}
+
+func (d *ModuleDirectory) Add(name, code string) {
+	if code == "" {
+		return
+	}
+	prev := ""
+	if c, ok := d.modules[name]; ok {
+		prev = fmt.Sprintf("%s\n", c)
+	}
+	d.modules[name] = fmt.Sprintf("%s%s", prev, code)
+}
+
+func (d *ModuleDirectory) Get(name string) string {
+	return d.modules[name]
 }
 
 const CliqueJs = `

node/node.go

@@ -36,6 +36,7 @@ import (
 	"github.com/ethereum/go-ethereum/ethdb"
 	"github.com/ethereum/go-ethereum/ethdb/memorydb"
 	"github.com/ethereum/go-ethereum/event"
+	"github.com/ethereum/go-ethereum/internal/web3ext"
 	"github.com/ethereum/go-ethereum/log"
 	"github.com/ethereum/go-ethereum/p2p"
 	"github.com/ethereum/go-ethereum/rpc"
@@ -386,6 +387,8 @@ func (n *Node) startRPC() error {
 			}
 		}
 		apis = append(apis, api)
+		// Register console extension.
+		web3ext.DefaultModules.Add(api.Namespace, api.ConsoleExtension)
 	}
 	if err := n.startInProc(apis); err != nil {
 		return err