core/vm: enable EIP-3855 (PUSH0)

Author: GheisMohammadi

core/vm/analysis.go

@@ -43,7 +43,10 @@ func codeBitmap(code []byte) bitvec {
 	for pc := uint64(0); pc < uint64(len(code)); {
 		op := OpCode(code[pc])
 
-		if op >= PUSH1 && op <= PUSH32 {
+		if op == PUSH0 {
+			// PUSH0 doesn't read any bytes, just increment pc
+			pc++
+		} else if op >= PUSH1 && op <= PUSH32 {
 			numbits := op - PUSH1 + 1
 			pc++
 			for ; numbits >= 8; numbits -= 8 {

core/vm/eips.go

@@ -37,6 +37,8 @@ func EnableEIP(eipNum int, jt *JumpTable) error {
 		enable1344(jt)
 	case 1153:
 		enable1153(jt)
+	case 3855:
+		enable3855(jt)
 	default:
 		return fmt.Errorf("undefined eip %d", eipNum)
 	}
@@ -151,3 +153,15 @@ func opTstore(pc *uint64, interpreter *EVMInterpreter, contract *Contract, memor
 	interpreter.evm.StateDB.SetTransientState(contract.Address(), key, val)
 	return nil, nil
 }
+
+// enable3855 applies EIP-3855 (PUSH0 opcode)
+// - Adds PUSH0 opcode that pushes the value 0 onto the stack
+func enable3855(jt *JumpTable) {
+	jt[PUSH0] = operation{
+		execute:     opPush0,
+		constantGas: GasQuickStep,
+		minStack:    minStack(0, 1),
+		maxStack:    maxStack(0, 1),
+		valid:       true,
+	}
+}

core/vm/instructions.go

@@ -955,6 +955,13 @@ func makeLog(size int) executionFunc {
 	}
 }
 
+// opPush0 pushes the value 0 onto the stack
+func opPush0(pc *uint64, interpreter *EVMInterpreter, contract *Contract, memory *Memory, stack *Stack) ([]byte, error) {
+	stack.push(interpreter.intPool.getZero())
+	*pc++
+	return nil, nil
+}
+
 // opPush1 is a specialized version of pushN
 func opPush1(pc *uint64, interpreter *EVMInterpreter, contract *Contract, memory *Memory, stack *Stack) ([]byte, error) {
 	var (

core/vm/interpreter.go

@@ -111,6 +111,18 @@ func NewEVMInterpreter(evm *EVM, cfg Config) *EVMInterpreter {
 		default:
 			jt = frontierInstructionSet
 		}
+		// Enable epoch-based EIPs
+		epochBasedEIPs := []int{}
+		if evm.ChainConfig().IsEIP3855(evm.EpochNumber) {
+			epochBasedEIPs = append(epochBasedEIPs, 3855)
+		}
+		// Enable all epoch-based EIPs
+		for _, eip := range epochBasedEIPs {
+			if err := EnableEIP(eip, &jt); err != nil {
+				utils.Logger().Error().Int("eip", eip).Err(err).Msg("Epoch-based EIP activation failed")
+			}
+		}
+		// Enable manually specified extra EIPs
 		for i, eip := range cfg.ExtraEips {
 			if err := EnableEIP(eip, &jt); err != nil {
 				// Disable it, so caller can check if it's activated or not

core/vm/opcodes.go

@@ -26,7 +26,7 @@ type OpCode byte
 // IsPush specifies if an opcode is a PUSH opcode.
 func (op OpCode) IsPush() bool {
 	switch op {
-	case PUSH1, PUSH2, PUSH3, PUSH4, PUSH5, PUSH6, PUSH7, PUSH8, PUSH9, PUSH10, PUSH11, PUSH12, PUSH13, PUSH14, PUSH15, PUSH16, PUSH17, PUSH18, PUSH19, PUSH20, PUSH21, PUSH22, PUSH23, PUSH24, PUSH25, PUSH26, PUSH27, PUSH28, PUSH29, PUSH30, PUSH31, PUSH32:
+	case PUSH0, PUSH1, PUSH2, PUSH3, PUSH4, PUSH5, PUSH6, PUSH7, PUSH8, PUSH9, PUSH10, PUSH11, PUSH12, PUSH13, PUSH14, PUSH15, PUSH16, PUSH17, PUSH18, PUSH19, PUSH20, PUSH21, PUSH22, PUSH23, PUSH24, PUSH25, PUSH26, PUSH27, PUSH28, PUSH29, PUSH30, PUSH31, PUSH32:
 		return true
 	}
 	return false
@@ -121,6 +121,7 @@ const (
 	JUMPDEST
 	TLOAD  // 0x5c
 	TSTORE // 0x5d
+	PUSH0  = 0x5f
 )
 
 // 0x60 range.
@@ -301,6 +302,7 @@ var opCodeToString = map[OpCode]string{
 	JUMPDEST: "JUMPDEST",
 	TLOAD:    "TLOAD",
 	TSTORE:   "TSTORE",
+	PUSH0:    "PUSH0",
 
 	// 0x60 range - push.
 	PUSH1:  "PUSH1",
@@ -468,6 +470,7 @@ var stringToOp = map[string]OpCode{
 	"JUMPDEST":       JUMPDEST,
 	"TLOAD":          TLOAD,
 	"TSTORE":         TSTORE,
+	"PUSH0":          PUSH0,
 	"PUSH1":          PUSH1,
 	"PUSH2":          PUSH2,
 	"PUSH3":          PUSH3,

internal/params/config.go

@@ -83,6 +83,7 @@ var (
 		HIP32Epoch:                            big.NewInt(2152), // 2024-10-31 13:02 UTC
 		IsOneSecondEpoch:                      EpochTBD,
 		EIP2537PrecompileEpoch:                EpochTBD,
+		EIP3855Epoch:                          EpochTBD,
 	}
 
 	// TestnetChainConfig contains the chain parameters to run a node on the harmony test network.
@@ -133,6 +134,7 @@ var (
 		TestnetExternalEpoch:                  big.NewInt(3044),
 		IsOneSecondEpoch:                      EpochTBD,
 		EIP2537PrecompileEpoch:                EpochTBD,
+		EIP3855Epoch:                          EpochTBD,
 	}
 	// PangaeaChainConfig contains the chain parameters for the Pangaea network.
 	// All features except for CrossLink are enabled at launch.
@@ -183,6 +185,7 @@ var (
 		TestnetExternalEpoch:                  EpochTBD,
 		IsOneSecondEpoch:                      EpochTBD,
 		EIP2537PrecompileEpoch:                EpochTBD,
+		EIP3855Epoch:                          EpochTBD,
 	}
 
 	// PartnerChainConfig contains the chain parameters for the Partner network.
@@ -285,6 +288,7 @@ var (
 		TestnetExternalEpoch:                  EpochTBD,
 		IsOneSecondEpoch:                      EpochTBD,
 		EIP2537PrecompileEpoch:                EpochTBD,
+		EIP3855Epoch:                          EpochTBD,
 	}
 
 	// LocalnetChainConfig contains the chain parameters to run for local development.
@@ -335,6 +339,7 @@ var (
 		TestnetExternalEpoch:                  EpochTBD,
 		IsOneSecondEpoch:                      big.NewInt(4),
 		EIP2537PrecompileEpoch:                EpochTBD,
+		EIP3855Epoch:                          EpochTBD,
 	}
 
 	// AllProtocolChanges ...
@@ -388,6 +393,7 @@ var (
 		big.NewInt(0),
 		big.NewInt(0),
 		big.NewInt(0), // EIP2537PrecompileEpoch
+		big.NewInt(0), // EIP3855Epoch
 	}
 
 	// TestChainConfig ...
@@ -441,6 +447,7 @@ var (
 		big.NewInt(0),
 		big.NewInt(0),
 		big.NewInt(0), // EIP2537PrecompileEpoch
+		big.NewInt(0), // EIP3855Epoch
 	}
 
 	// TestRules ...
@@ -571,6 +578,9 @@ type ChainConfig struct {
 	// EIP2537PrecompileEpoch is the first epoch to support the EIP-2537 precompiles
 	EIP2537PrecompileEpoch *big.Int `json:"eip2537-precompile-epoch,omitempty"`
 
+	// EIP3855Epoch is the first epoch to support EIP-3855 (PUSH0 opcode)
+	EIP3855Epoch *big.Int `json:"eip3855-epoch,omitempty"`
+
 	// ChainIdFixEpoch is the first epoch to return ethereum compatible chain id by ChainID() op code
 	ChainIdFixEpoch *big.Int `json:"chain-id-fix-epoch,omitempty"`
 
@@ -865,6 +875,12 @@ func (c *ChainConfig) IsEIP2537Precompile(epoch *big.Int) bool {
 	return isForked(c.EIP2537PrecompileEpoch, epoch)
 }
 
+// IsEIP3855 determines whether EIP-3855 (PUSH0 opcode)
+// is available in the EVM
+func (c *ChainConfig) IsEIP3855(epoch *big.Int) bool {
+	return isForked(c.EIP3855Epoch, epoch)
+}
+
 // IsChainIdFix returns whether epoch is either equal to the ChainId Fix fork epoch or greater.
 func (c *ChainConfig) IsChainIdFix(epoch *big.Int) bool {
 	return isForked(c.ChainIdFixEpoch, epoch)