feat: Add Gas dimension tracers

core/state/statedb.go

@@ -1548,6 +1548,15 @@ func (s *StateDB) SlotInAccessList(addr common.Address, slot common.Hash) (addre
 	return s.accessList.Contains(addr, slot)
 }
 
+// GetAccessList returns the data of the access list directly for tracers to consume
+// this is necessary because the accessList is not exported from the state package
+func (s *StateDB) GetAccessList() (addresses map[common.Address]int, slots []map[common.Hash]struct{}) {
+	accessListCopy := s.accessList.Copy()
+	addresses = accessListCopy.addresses
+	slots = accessListCopy.slots
+	return
+}
+
 // markDelete is invoked when an account is deleted but the deletion is
 // not yet committed. The pending mutation is cached and will be applied
 // all together

core/state/statedb_hooked.go

@@ -369,3 +369,7 @@ func (s *hookedStateDB) GetSelfDestructs() []common.Address {
 func (s *hookedStateDB) GetCurrentTxLogs() []*types.Log {
 	return s.inner.GetCurrentTxLogs()
 }
+
+func (s *hookedStateDB) GetAccessList() (addresses map[common.Address]int, slots []map[common.Hash]struct{}) {
+	return s.inner.GetAccessList()
+}

core/tracing/hooks.go

@@ -55,6 +55,7 @@ type StateDB interface {
 	GetTransientState(common.Address, common.Hash) common.Hash
 	Exist(common.Address) bool
 	GetRefund() uint64
+	GetAccessList() (addresses map[common.Address]int, slots []map[common.Hash]struct{})
 }
 
 // VMContext provides the context for the EVM execution.

core/vm/interface.go

@@ -115,6 +115,8 @@ type StateDB interface {
 	// AddSlotToAccessList adds the given (address,slot) to the access list. This operation is safe to perform
 	// even if the feature/fork is not active yet
 	AddSlotToAccessList(addr common.Address, slot common.Hash)
+	// GetAccessList returns the access list
+	GetAccessList() (addresses map[common.Address]int, slots []map[common.Hash]struct{})
 
 	// PointCache returns the point cache used in computations
 	PointCache() *utils.PointCache

eth/tracers/live/tx_gas_dimension_by_opcode.go

@@ -0,0 +1,146 @@
+package live
+
+import (
+	"encoding/json"
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/ethereum/go-ethereum/core/tracing"
+	"github.com/ethereum/go-ethereum/eth/tracers"
+	"github.com/ethereum/go-ethereum/eth/tracers/native"
+	"github.com/ethereum/go-ethereum/params"
+
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/core/types"
+	_vm "github.com/ethereum/go-ethereum/core/vm"
+)
+
+// initializer for the tracer
+func init() {
+	tracers.LiveDirectory.Register("txGasDimensionByOpcode", NewTxGasDimensionByOpcodeLogger)
+}
+
+type txGasDimensionByOpcodeLiveTraceConfig struct {
+	Path        string              `json:"path"` // Path to directory for output
+	ChainConfig *params.ChainConfig `json:"chainConfig"`
+}
+
+// gasDimensionTracer struct
+type TxGasDimensionByOpcodeLiveTracer struct {
+	Path               string `json:"path"` // Path to directory for output
+	ChainConfig        *params.ChainConfig
+	GasDimensionTracer *native.TxGasDimensionByOpcodeTracer
+}
+
+// gasDimensionTracer returns a new tracer that traces gas
+// usage for each opcode against the dimension of that opcode
+// takes a context, and json input for configuration parameters
+func NewTxGasDimensionByOpcodeLogger(
+	cfg json.RawMessage,
+) (*tracing.Hooks, error) {
+	var config txGasDimensionByOpcodeLiveTraceConfig
+	if err := json.Unmarshal(cfg, &config); err != nil {
+		return nil, err
+	}
+
+	if config.Path == "" {
+		return nil, fmt.Errorf("tx gas dimension live tracer path for output is required: %v", config)
+	}
+
+	// if you get stuck here, look at
+	// cmd/chaininfo/arbitrum_chain_info.json
+	// for a sample chain config
+	if config.ChainConfig == nil {
+		return nil, fmt.Errorf("tx gas dimension live tracer chain config is required: %v", config)
+	}
+
+	t := &TxGasDimensionByOpcodeLiveTracer{
+		Path:               config.Path,
+		ChainConfig:        config.ChainConfig,
+		GasDimensionTracer: nil,
+	}
+
+	return &tracing.Hooks{
+		OnOpcode:     t.OnOpcode,
+		OnTxStart:    t.OnTxStart,
+		OnTxEnd:      t.OnTxEnd,
+		OnBlockStart: t.OnBlockStart,
+		OnBlockEnd:   t.OnBlockEnd,
+	}, nil
+}
+
+func (t *TxGasDimensionByOpcodeLiveTracer) OnTxStart(
+	vm *tracing.VMContext,
+	tx *types.Transaction,
+	from common.Address,
+) {
+	if t.GasDimensionTracer != nil {
+		fmt.Println("Error seen in the gas dimension live tracer lifecycle!")
+	}
+
+	t.GasDimensionTracer = &native.TxGasDimensionByOpcodeTracer{
+		BaseGasDimensionTracer: native.NewBaseGasDimensionTracer(t.ChainConfig),
+		OpcodeToDimensions:     make(map[_vm.OpCode]native.GasesByDimension),
+	}
+	t.GasDimensionTracer.OnTxStart(vm, tx, from)
+}
+
+func (t *TxGasDimensionByOpcodeLiveTracer) OnOpcode(
+	pc uint64,
+	op byte,
+	gas, cost uint64,
+	scope tracing.OpContext,
+	rData []byte,
+	depth int,
+	err error,
+) {
+	t.GasDimensionTracer.OnOpcode(pc, op, gas, cost, scope, rData, depth, err)
+}
+
+func (t *TxGasDimensionByOpcodeLiveTracer) OnTxEnd(
+	receipt *types.Receipt,
+	err error,
+) {
+	// first call the native tracer's OnTxEnd
+	t.GasDimensionTracer.OnTxEnd(receipt, err)
+
+	// system transactions don't use any gas
+	// they can be skipped
+	if receipt.GasUsed != 0 {
+		executionResultBytes, err := t.GasDimensionTracer.GetProtobufResult()
+		if err != nil {
+			fmt.Printf("Failed to get protobuf result: %v\n", err)
+			return
+		}
+
+		blockNumber := receipt.BlockNumber.String()
+		txHashString := receipt.TxHash.Hex()
+
+		// Create the file path
+		filename := fmt.Sprintf("%s.pb", txHashString)
+		dirPath := filepath.Join(t.Path, blockNumber)
+		filepath := filepath.Join(dirPath, filename)
+
+		// Ensure the directory exists (including block number subdirectory)
+		if err := os.MkdirAll(dirPath, 0755); err != nil {
+			fmt.Printf("Failed to create directory %s: %v\n", dirPath, err)
+			return
+		}
+
+		// Write the file
+		if err := os.WriteFile(filepath, executionResultBytes, 0644); err != nil {
+			fmt.Printf("Failed to write file %s: %v\n", filepath, err)
+			return
+		}
+	}
+
+	// reset the tracer
+	t.GasDimensionTracer = nil
+}
+
+func (t *TxGasDimensionByOpcodeLiveTracer) OnBlockStart(ev tracing.BlockEvent) {
+}
+
+func (t *TxGasDimensionByOpcodeLiveTracer) OnBlockEnd(err error) {
+}

eth/tracers/live/tx_gas_dimension_logger.go

@@ -0,0 +1,117 @@
+package live
+
+import (
+	"encoding/json"
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/core/types"
+
+	"github.com/ethereum/go-ethereum/core/tracing"
+	"github.com/ethereum/go-ethereum/eth/tracers"
+	"github.com/ethereum/go-ethereum/eth/tracers/native"
+)
+
+type txGasDimensionLiveTraceLogger struct {
+	Path               string `json:"path"`
+	GasDimensionTracer *tracers.Tracer
+}
+
+func init() {
+	tracers.LiveDirectory.Register("txGasDimensionLogger", newTxGasDimensionLiveTraceLogger)
+}
+
+type txGasDimensionLiveTraceLoggerConfig struct {
+	Path string `json:"path"` // Path to directory for output
+}
+
+func newTxGasDimensionLiveTraceLogger(cfg json.RawMessage) (*tracing.Hooks, error) {
+	var config txGasDimensionLiveTraceLoggerConfig
+	if err := json.Unmarshal(cfg, &config); err != nil {
+		return nil, err
+	}
+
+	if config.Path == "" {
+		return nil, fmt.Errorf("gas dimension live tracer path for output is required: %v", config)
+	}
+
+	gasDimensionTracer, err := native.NewTxGasDimensionLogger(nil, nil, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	t := &txGasDimensionLiveTraceLogger{
+		Path:               config.Path,
+		GasDimensionTracer: gasDimensionTracer,
+	}
+
+	return &tracing.Hooks{
+		OnOpcode:     t.OnOpcode,
+		OnTxStart:    t.OnTxStart,
+		OnTxEnd:      t.OnTxEnd,
+		OnBlockStart: t.OnBlockStart,
+		OnBlockEnd:   t.OnBlockEnd,
+	}, nil
+}
+
+func (t *txGasDimensionLiveTraceLogger) OnTxStart(
+	vm *tracing.VMContext,
+	tx *types.Transaction,
+	from common.Address,
+) {
+	t.GasDimensionTracer.OnTxStart(vm, tx, from)
+}
+
+func (t *txGasDimensionLiveTraceLogger) OnOpcode(
+	pc uint64,
+	op byte,
+	gas, cost uint64,
+	scope tracing.OpContext,
+	rData []byte,
+	depth int,
+	err error,
+) {
+	t.GasDimensionTracer.OnOpcode(pc, op, gas, cost, scope, rData, depth, err)
+}
+func (t *txGasDimensionLiveTraceLogger) OnTxEnd(
+	receipt *types.Receipt,
+	err error,
+) {
+	// first call the native tracer's OnTxEnd
+	t.GasDimensionTracer.OnTxEnd(receipt, err)
+
+	// then get the json from the native tracer
+	executionResultJsonBytes, errGettingResult := t.GasDimensionTracer.GetResult()
+	if errGettingResult != nil {
+		errorJsonString := fmt.Sprintf("{\"errorGettingResult\": \"%s\"}", errGettingResult.Error())
+		fmt.Println(errorJsonString)
+		return
+	}
+
+	blockNumber := receipt.BlockNumber.String()
+	txHashString := receipt.TxHash.Hex()
+
+	// Create the filename
+	filename := fmt.Sprintf("%s_%s.json", blockNumber, txHashString)
+	filepath := filepath.Join(t.Path, filename)
+
+	// Ensure the directory exists
+	if err := os.MkdirAll(t.Path, 0755); err != nil {
+		fmt.Printf("Failed to create directory %s: %v\n", t.Path, err)
+		return
+	}
+
+	// Write the file
+	if err := os.WriteFile(filepath, executionResultJsonBytes, 0644); err != nil {
+		fmt.Printf("Failed to write file %s: %v\n", filepath, err)
+		return
+	}
+}
+
+func (t *txGasDimensionLiveTraceLogger) OnBlockStart(ev tracing.BlockEvent) {
+}
+
+func (t *txGasDimensionLiveTraceLogger) OnBlockEnd(err error) {
+}