add comments

Author: 0xmountaintop

core/types.go

@@ -33,7 +33,8 @@ type Validator interface {
 	// gas used.
 	ValidateState(block *types.Block, state *state.StateDB, receipts types.Receipts, usedGas uint64) error
 
-	// TODO: add comments
+	// SetupTracerAndCircuitCapacityChecker sets up ScrollTracerWrapper and CircuitCapacityChecker for validator,
+	// to get scroll-related traces and to validate the circuit row consumption
 	SetupTracerAndCircuitCapacityChecker(tracer tracerWrapper)
 }
 

rollup/tracing/mux_tracer.go

@@ -9,50 +9,59 @@ import (
 	_ "github.com/scroll-tech/go-ethereum/eth/tracers/native"
 )
 
+// MuxTracer is a tracer mux, to support running multiple tracers together
 type MuxTracer struct {
 	tracers []vm.EVMLogger
 }
 
+// NewMuxTracer creates a new MuxTracer with multiple tracers
 func NewMuxTracer(tracers ...vm.EVMLogger) *MuxTracer {
 	return &MuxTracer{tracers}
 }
 
+// CaptureStart runs CaptureStart for each tracer in the MuxTracer
 func (t *MuxTracer) CaptureStart(env *vm.EVM, from common.Address, to common.Address, create bool, input []byte, gas uint64, value *big.Int) {
 	for _, tracer := range t.tracers {
 		tracer.CaptureStart(env, from, to, create, input, gas, value)
 	}
 }
 
+// CaptureState runs CaptureState for each tracer in the MuxTracer
 func (t *MuxTracer) CaptureState(pc uint64, op vm.OpCode, gas, cost uint64, scope *vm.ScopeContext, rData []byte, depth int, err error) {
 	for _, tracer := range t.tracers {
 		tracer.CaptureState(pc, op, gas, cost, scope, rData, depth, err)
 	}
 }
 
+// CaptureStateAfter runs CaptureStateAfter for each tracer in the MuxTracer
 func (t *MuxTracer) CaptureStateAfter(pc uint64, op vm.OpCode, gas, cost uint64, scope *vm.ScopeContext, rData []byte, depth int, err error) {
 	for _, tracer := range t.tracers {
 		tracer.CaptureStateAfter(pc, op, gas, cost, scope, rData, depth, err)
 	}
 }
 
+// CaptureEnter runs CaptureEnter for each tracer in the MuxTracer
 func (t *MuxTracer) CaptureEnter(typ vm.OpCode, from common.Address, to common.Address, input []byte, gas uint64, value *big.Int) {
 	for _, tracer := range t.tracers {
 		tracer.CaptureEnter(typ, from, to, input, gas, value)
 	}
 }
 
+// CaptureExit runs CaptureExit for each tracer in the MuxTracer
 func (t *MuxTracer) CaptureExit(output []byte, gasUsed uint64, err error) {
 	for _, tracer := range t.tracers {
 		tracer.CaptureExit(output, gasUsed, err)
 	}
 }
 
+// CaptureFault runs CaptureFault for each tracer in the MuxTracer
 func (t *MuxTracer) CaptureFault(pc uint64, op vm.OpCode, gas, cost uint64, scope *vm.ScopeContext, depth int, err error) {
 	for _, tracer := range t.tracers {
 		tracer.CaptureFault(pc, op, gas, cost, scope, depth, err)
 	}
 }
 
+// CaptureEnd runs CaptureEnd for each tracer in the MuxTracer
 func (t *MuxTracer) CaptureEnd(output []byte, gasUsed uint64, d time.Duration, err error) {
 	for _, tracer := range t.tracers {
 		tracer.CaptureEnd(output, gasUsed, d, err)

rollup/tracing/tracing.go

@@ -26,12 +26,15 @@ import (
 	"github.com/scroll-tech/go-ethereum/trie/zkproof"
 )
 
+// TracerWrapper implements ScrollTracerWrapper interface
 type TracerWrapper struct{}
 
+// TracerWrapper creates a new TracerWrapper
 func NewTracerWrapper() *TracerWrapper {
 	return &TracerWrapper{}
 }
 
+// CreateTraceEnvAndGetBlockTrace wraps the whole block tracing logic for a block
 func (tw *TracerWrapper) CreateTraceEnvAndGetBlockTrace(chainConfig *params.ChainConfig, chainContext core.ChainContext, engine consensus.Engine, chaindb ethdb.Database, statedb *state.StateDB, parent *types.Block, block *types.Block, commitAfterApply bool) (*types.BlockTrace, error) {
 	traceEnv, err := CreateTraceEnv(chainConfig, chainContext, engine, chaindb, statedb, parent, block, commitAfterApply)
 	if err != nil {