refactor WrapWithJournal to use reflection

core/tracing/hooks.go

@@ -18,6 +18,7 @@ package tracing
 
 import (
 	"math/big"
+	"reflect"
 
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
@@ -231,6 +232,21 @@ type Hooks struct {
 	OnBlockHashRead BlockHashReadHook
 }
 
+// Copy creates a new Hooks instance with all implemented hooks copied from the original.
+func (h *Hooks) Copy() *Hooks {
+	copied := &Hooks{}
+	srcValue := reflect.ValueOf(h).Elem()
+	dstValue := reflect.ValueOf(copied).Elem()
+
+	for i := 0; i < srcValue.NumField(); i++ {
+		field := srcValue.Field(i)
+		if !field.IsNil() {
+			dstValue.Field(i).Set(field)
+		}
+	}
+	return copied
+}
+
 // BalanceChangeReason is used to indicate the reason for a balance change, useful
 // for tracing and reporting.
 type BalanceChangeReason byte

core/tracing/journal.go

@@ -50,19 +50,20 @@ func WrapWithJournal(hooks *Hooks) (*Hooks, error) {
 	if hooks == nil {
 		return nil, fmt.Errorf("wrapping nil tracer")
 	}
-	// No state change to journal.
+	// No state change to journal, return the wrapped hooks as is
 	if hooks.OnBalanceChange == nil && hooks.OnNonceChange == nil && hooks.OnCodeChange == nil && hooks.OnStorageChange == nil {
 		return hooks, nil
 	}
-	var (
+
-		j       = &journal{entries: make([]entry, 0), hooks: hooks}
+	// Create a new Hooks instance and copy all hooks
-		wrapped = &Hooks{
+	wrapped := hooks.Copy()
-			OnTxEnd: j.OnTxEnd,
+	// Create journal
-			OnEnter: j.OnEnter,
+	j := &journal{entries: make([]entry, 0), hooks: hooks}
-			OnExit:  j.OnExit,
+	// Scope hooks need to be re-implemented.
-		}
+	wrapped.OnTxEnd = j.OnTxEnd
-	)
+	wrapped.OnEnter = j.OnEnter
-	// State change hooks.
+	wrapped.OnExit = j.OnExit
+	// Wrap state change hooks.
 	if hooks.OnBalanceChange != nil {
 		wrapped.OnBalanceChange = j.OnBalanceChange
 	}
@@ -75,70 +76,7 @@ func WrapWithJournal(hooks *Hooks) (*Hooks, error) {
 	if hooks.OnStorageChange != nil {
 		wrapped.OnStorageChange = j.OnStorageChange
 	}
-	// Pass through the remaining hooks.
+
-	if hooks.OnTxStart != nil {
-		wrapped.OnTxStart = hooks.OnTxStart
-	}
-	if hooks.OnOpcode != nil {
-		wrapped.OnOpcode = hooks.OnOpcode
-	}
-	if hooks.OnFault != nil {
-		wrapped.OnFault = hooks.OnFault
-	}
-	if hooks.OnGasChange != nil {
-		wrapped.OnGasChange = hooks.OnGasChange
-	}
-	if hooks.OnBlockchainInit != nil {
-		wrapped.OnBlockchainInit = hooks.OnBlockchainInit
-	}
-	if hooks.OnClose != nil {
-		wrapped.OnClose = hooks.OnClose
-	}
-	if hooks.OnBlockStart != nil {
-		wrapped.OnBlockStart = hooks.OnBlockStart
-	}
-	if hooks.OnBlockEnd != nil {
-		wrapped.OnBlockEnd = hooks.OnBlockEnd
-	}
-	if hooks.OnSkippedBlock != nil {
-		wrapped.OnSkippedBlock = hooks.OnSkippedBlock
-	}
-	if hooks.OnGenesisBlock != nil {
-		wrapped.OnGenesisBlock = hooks.OnGenesisBlock
-	}
-	if hooks.OnReorg != nil {
-		wrapped.OnReorg = hooks.OnReorg
-	}
-	if hooks.OnSystemCallStart != nil {
-		wrapped.OnSystemCallStart = hooks.OnSystemCallStart
-	}
-	if hooks.OnSystemCallEnd != nil {
-		wrapped.OnSystemCallEnd = hooks.OnSystemCallEnd
-	}
-	if hooks.OnLog != nil {
-		wrapped.OnLog = hooks.OnLog
-	}
-	if hooks.OnBalanceRead != nil {
-		wrapped.OnBalanceRead = hooks.OnBalanceRead
-	}
-	if hooks.OnNonceRead != nil {
-		wrapped.OnNonceRead = hooks.OnNonceRead
-	}
-	if hooks.OnCodeRead != nil {
-		wrapped.OnCodeRead = hooks.OnCodeRead
-	}
-	if hooks.OnCodeSizeRead != nil {
-		wrapped.OnCodeSizeRead = hooks.OnCodeSizeRead
-	}
-	if hooks.OnCodeHashRead != nil {
-		wrapped.OnCodeHashRead = hooks.OnCodeHashRead
-	}
-	if hooks.OnStorageRead != nil {
-		wrapped.OnStorageRead = hooks.OnStorageRead
-	}
-	if hooks.OnBlockHashRead != nil {
-		wrapped.OnBlockHashRead = hooks.OnBlockHashRead
-	}
 	return wrapped, nil
 }