initial version of eip-5656

Author: GheisMohammadi

core/vm/eips.go

@@ -26,6 +26,7 @@ import (
 )
 
 var activators = map[int]func(*JumpTable){
+	5656: enable5656,
 	3855: enable3855,
 	3529: enable3529,
 	3198: enable3198,
@@ -233,3 +234,15 @@ func opPush0(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]by
 	scope.Stack.push(new(uint256.Int))
 	return nil, nil
 }
+
+// enable5656 applies EIP-5656 (MCOPY opcode)
+func enable5656(jt *JumpTable) {
+	jt[MCOPY] = &operation{
+		execute:     opMcopy,
+		constantGas: 0,
+		dynamicGas:  gasMcopy,
+		minStack:    minStack(3, 0),
+		maxStack:    maxStack(3, 0),
+		memorySize:  memoryMcopy,
+	}
+}

core/vm/gas_table.go

@@ -89,6 +89,7 @@ func memoryCopierGas(stackpos int) gasFunc {
 var (
 	gasCallDataCopy   = memoryCopierGas(2)
 	gasCodeCopy       = memoryCopierGas(2)
+	gasMcopy          = memoryCopierGas(2)
 	gasExtCodeCopy    = memoryCopierGas(3)
 	gasReturnDataCopy = memoryCopierGas(2)
 )

core/vm/instructions.go

@@ -525,6 +525,18 @@ func opMstore8(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]
 	return nil, nil
 }
 
+func opMcopy(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
+	var (
+		dst    = scope.Stack.pop()
+		src    = scope.Stack.pop()
+		length = scope.Stack.pop()
+	)
+	// These values are checked for overflow during memory expansion calculation
+	// (the memorySize function on the opcode).
+	scope.Memory.Copy(dst.Uint64(), src.Uint64(), length.Uint64())
+	return nil, nil
+}
+
 func opSload(pc *uint64, interpreter *EVMInterpreter, scope *ScopeContext) ([]byte, error) {
 	loc := scope.Stack.peek()
 	hash := common.Hash(loc.Bytes32())

core/vm/interpreter.go

@@ -78,6 +78,8 @@ func NewEVMInterpreter(evm *EVM, cfg Config) *EVMInterpreter {
 	// If jump table was not initialised we set the default one.
 	if cfg.JumpTable == nil {
 		switch {
+		case evm.chainRules.IsEIP5656Mcopy:
+			cfg.JumpTable = &eip5656InstructionSet
 		case evm.chainRules.Is1153TransientStorage:
 			cfg.JumpTable = &eip1153InstructionSet
 		case evm.chainRules.IsIstanbul:

core/vm/jump_table.go

@@ -53,6 +53,7 @@ var (
 	constantinopleInstructionSet   = newConstantinopleInstructionSet()
 	istanbulInstructionSet         = newIstanbulInstructionSet()
 	eip1153InstructionSet          = eip1153TransientStorage()
+	eip5656InstructionSet          = eip5656Mcopy()
 	//berlinInstructionSet           = newBerlinInstructionSet()
 	//londonInstructionSet           = newLondonInstructionSet()
 	//mergeInstructionSet            = newMergeInstructionSet()
@@ -110,6 +111,13 @@ func newBerlinInstructionSet() JumpTable {
 	return validate(instructionSet)
 }*/
 
+// EIP 5656 MCOPY
+func eip5656Mcopy() JumpTable {
+	instructionSet := eip1153TransientStorage()
+	enable5656(&instructionSet) // MCOPY - https://eips.ethereum.org/EIPS/eip-5656
+	return validate(instructionSet)
+}
+
 // EIP 1153 Transient Storage
 func eip1153TransientStorage() JumpTable {
 	instructionSet := newIstanbulInstructionSet()

core/vm/memory.go

@@ -107,6 +107,17 @@ func (m *Memory) Data() []byte {
 	return m.store
 }
 
+// Copy copies data from the src position slice into the dst position.
+// The source and destination may overlap.
+// OBS: This operation assumes that any necessary memory expansion has already been performed,
+// and this method may panic otherwise.
+func (m *Memory) Copy(dst, src, len uint64) {
+	if len == 0 {
+		return
+	}
+	copy(m.store[dst:], m.store[src:src+len])
+}
+
 // Print dumps the content of the memory.
 func (m *Memory) Print() {
 	fmt.Printf("### mem %d bytes ###\n", len(m.store))

core/vm/memory_table.go

@@ -48,6 +48,14 @@ func memoryMStore(stack *Stack) (uint64, bool) {
 	return calcMemSize64WithUint(stack.Back(0), 32)
 }
 
+func memoryMcopy(stack *Stack) (uint64, bool) {
+	mStart := stack.Back(0) // stack[0]: dest
+	if stack.Back(1).Gt(mStart) {
+		mStart = stack.Back(1) // stack[1]: source
+	}
+	return calcMemSize64(mStart, stack.Back(2))
+}
+
 func memoryCreate(stack *Stack) (uint64, bool) {
 	return calcMemSize64(stack.Back(1), stack.Back(2))
 }

core/vm/opcodes.go

@@ -121,6 +121,7 @@ const (
 	JUMPDEST OpCode = 0x5b
 	TLOAD    OpCode = 0x5c
 	TSTORE   OpCode = 0x5d
+	MCOPY    OpCode = 0x5e
 	PUSH0    OpCode = 0x5f
 )
 
@@ -305,6 +306,7 @@ var opCodeToString = map[OpCode]string{
 	JUMPDEST: "JUMPDEST",
 	TLOAD:    "TLOAD",
 	TSTORE:   "TSTORE",
+	MCOPY:    "MCOPY",
 	PUSH0:    "PUSH0",
 
 	// 0x60 range - push.
@@ -472,6 +474,7 @@ var stringToOp = map[string]OpCode{
 	"PUSH0":          PUSH0,
 	"TLOAD":          TLOAD,
 	"TSTORE":         TSTORE,
+	"MCOPY":          MCOPY,
 	"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,
+		EIP5656McopyEpoch:                     EpochTBD,
 	}
 
 	// TestnetChainConfig contains the chain parameters to run a node on the harmony test network.
@@ -134,6 +135,7 @@ var (
 		IsOneSecondEpoch:                      EpochTBD,
 		EIP2537PrecompileEpoch:                EpochTBD,
 		EIP1153TransientStorageEpoch:          big.NewInt(6280),
+		EIP5656McopyEpoch:                     EpochTBD,
 	}
 	// PangaeaChainConfig contains the chain parameters for the Pangaea network.
 	// All features except for CrossLink are enabled at launch.
@@ -184,6 +186,7 @@ var (
 		TestnetExternalEpoch:                  EpochTBD,
 		IsOneSecondEpoch:                      EpochTBD,
 		EIP2537PrecompileEpoch:                EpochTBD,
+		EIP5656McopyEpoch:                     EpochTBD,
 	}
 
 	// PartnerChainConfig contains the chain parameters for the Partner network.
@@ -236,6 +239,7 @@ var (
 		IsOneSecondEpoch:                      big.NewInt(17436),
 		EIP2537PrecompileEpoch:                EpochTBD,
 		EIP1153TransientStorageEpoch:          big.NewInt(35626),
+		EIP5656McopyEpoch:                     EpochTBD,
 	}
 
 	// StressnetChainConfig contains the chain parameters for the Stress test network.
@@ -287,6 +291,7 @@ var (
 		TestnetExternalEpoch:                  EpochTBD,
 		IsOneSecondEpoch:                      EpochTBD,
 		EIP2537PrecompileEpoch:                EpochTBD,
+		EIP5656McopyEpoch:                     EpochTBD,
 	}
 
 	// LocalnetChainConfig contains the chain parameters to run for local development.
@@ -337,6 +342,7 @@ var (
 		TestnetExternalEpoch:                  EpochTBD,
 		IsOneSecondEpoch:                      big.NewInt(4),
 		EIP2537PrecompileEpoch:                EpochTBD,
+		EIP5656McopyEpoch:                     EpochTBD,
 	}
 
 	// AllProtocolChanges ...
@@ -391,6 +397,7 @@ var (
 		big.NewInt(0),
 		big.NewInt(0), // EIP2537PrecompileEpoch
 		big.NewInt(0), // 1153 transient storage
+		big.NewInt(0), // EIP5656McopyEpoch
 	}
 
 	// TestChainConfig ...
@@ -445,6 +452,7 @@ var (
 		big.NewInt(0),
 		big.NewInt(0), // EIP2537PrecompileEpoch
 		big.NewInt(0), // 1153 transient storage
+		big.NewInt(0), // EIP5656McopyEpoch
 	}
 
 	// TestRules ...
@@ -634,11 +642,14 @@ type ChainConfig struct {
 
 	// EIP2537PrecompileEpoch is the first epoch to support the EIP-2537 precompiles
 	EIP1153TransientStorageEpoch *big.Int `json:"eip1153-transient-storage-epoch,omitempty"`
+
+	// EIP5656McopyEpoch is the first epoch to support the EIP-5656 MCOPY opcode
+	EIP5656McopyEpoch *big.Int `json:"eip5656-mcopy-epoch,omitempty"`
 }
 
 // String implements the fmt.Stringer interface.
 func (c *ChainConfig) String() string {
-	return fmt.Sprintf("{ChainID: %v EthCompatibleChainID: %v EIP155: %v CrossTx: %v Staking: %v CrossLink: %v ReceiptLog: %v SHA3Epoch: %v StakingPrecompileEpoch: %v ChainIdFixEpoch: %v CrossShardXferPrecompileEpoch: %v EIP2537PrecompileEpoch: %v EIP1153TransientStorageEpoch: %v}",
+	return fmt.Sprintf("{ChainID: %v EthCompatibleChainID: %v EIP155: %v CrossTx: %v Staking: %v CrossLink: %v ReceiptLog: %v SHA3Epoch: %v StakingPrecompileEpoch: %v ChainIdFixEpoch: %v CrossShardXferPrecompileEpoch: %v EIP2537PrecompileEpoch: %v EIP1153TransientStorageEpoch: %v EIP5656McopyEpoch: %v}",
 		c.ChainID,
 		c.EthCompatibleChainID,
 		c.EIP155Epoch,
@@ -652,6 +663,7 @@ func (c *ChainConfig) String() string {
 		c.CrossShardXferPrecompileEpoch,
 		c.EIP2537PrecompileEpoch,
 		c.EIP1153TransientStorageEpoch,
+		c.EIP5656McopyEpoch,
 	)
 }
 
@@ -878,6 +890,11 @@ func (c *ChainConfig) IsEIP1153TransientStorage(epoch *big.Int) bool {
 	return isForked(c.EIP1153TransientStorageEpoch, epoch)
 }
 
+// IsEIP5656Mcopy determines whether EIP-5656 MCOPY opcode is available in the EVM
+func (c *ChainConfig) IsEIP5656Mcopy(epoch *big.Int) bool {
+	return isForked(c.EIP5656McopyEpoch, 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)
@@ -1009,6 +1026,7 @@ type Rules struct {
 	IsValidatorCodeFix     bool
 	IsYoloV2               bool
 	Is1153TransientStorage bool
+	IsEIP5656Mcopy         bool
 }
 
 // Rules ensures c's ChainID is not nil.
@@ -1041,5 +1059,6 @@ func (c *ChainConfig) Rules(epoch *big.Int) Rules {
 		IsValidatorCodeFix:         c.IsValidatorCodeFix(epoch),
 		IsEIP2537Precompile:        c.IsEIP2537Precompile(epoch),
 		Is1153TransientStorage:     c.IsEIP1153TransientStorage(epoch),
+		IsEIP5656Mcopy:             c.IsEIP5656Mcopy(epoch),
 	}
 }