EIP-1153: Transient storage opcodes

config/src/main/java/org/hyperledger/besu/config/GenesisConfigOptions.java

@@ -90,6 +90,8 @@ default boolean isConsensusMigration() {
 
   OptionalLong getMergeNetSplitBlockNumber();
 
+  OptionalLong getEIP1153BlockNumber();
+
   Optional<Wei> getBaseFeePerGas();
 
   Optional<UInt256> getTerminalTotalDifficulty();

config/src/main/java/org/hyperledger/besu/config/JsonGenesisConfigOptions.java

@@ -284,6 +284,11 @@ public OptionalLong getMergeNetSplitBlockNumber() {
     return getOptionalLong("mergenetsplitblock");
   }
 
+  @Override
+  public OptionalLong getEIP1153BlockNumber() {
+    return getOptionalLong("eip1153Block");
+  }
+
   @Override
   public Optional<Wei> getBaseFeePerGas() {
     return Optional.ofNullable(configOverrides.get("baseFeePerGas"))
@@ -441,6 +446,7 @@ public Map<String, Object> asMap() {
     getArrowGlacierBlockNumber().ifPresent(l -> builder.put("arrowGlacierBlock", l));
     getGrayGlacierBlockNumber().ifPresent(l -> builder.put("grayGlacierBlock", l));
     getMergeNetSplitBlockNumber().ifPresent(l -> builder.put("mergeNetSplitBlock", l));
+    getEIP1153BlockNumber().ifPresent(l -> builder.put("eip1153Block", l));
     getTerminalBlockNumber().ifPresent(l -> builder.put("terminalBlockNumber", l));
     getTerminalBlockHash().ifPresent(h -> builder.put("terminalBlockHash", h.toHexString()));
 
@@ -560,6 +566,7 @@ public List<Long> getForks() {
             getArrowGlacierBlockNumber(),
             getGrayGlacierBlockNumber(),
             getMergeNetSplitBlockNumber(),
+            getEIP1153BlockNumber(),
             getEcip1015BlockNumber(),
             getDieHardBlockNumber(),
             getGothamBlockNumber(),

config/src/main/java/org/hyperledger/besu/config/StubGenesisConfigOptions.java

@@ -44,6 +44,7 @@ public class StubGenesisConfigOptions implements GenesisConfigOptions {
   private OptionalLong arrowGlacierBlockNumber = OptionalLong.empty();
   private OptionalLong grayGlacierBlockNumber = OptionalLong.empty();
   private OptionalLong mergeNetSplitBlockNumber = OptionalLong.empty();
+  private OptionalLong eip1153BlockNumber = OptionalLong.empty();
   private OptionalLong terminalBlockNumber = OptionalLong.empty();
   private Optional<Hash> terminalBlockHash = Optional.empty();
   private Optional<UInt256> terminalTotalDifficulty = Optional.empty();
@@ -216,6 +217,11 @@ public OptionalLong getMergeNetSplitBlockNumber() {
     return mergeNetSplitBlockNumber;
   }
 
+  @Override
+  public OptionalLong getEIP1153BlockNumber() {
+    return eip1153BlockNumber;
+  }
+
   @Override
   public Optional<Wei> getBaseFeePerGas() {
     return baseFeePerGas;
@@ -344,6 +350,7 @@ public Map<String, Object> asMap() {
     getArrowGlacierBlockNumber().ifPresent(l -> builder.put("arrowGlacierBlock", l));
     getGrayGlacierBlockNumber().ifPresent(l -> builder.put("grayGlacierBlock", l));
     getMergeNetSplitBlockNumber().ifPresent(l -> builder.put("mergeNetSplitBlock", l));
+    getEIP1153BlockNumber().ifPresent(l -> builder.put("eip1153Block", l));
     getTerminalBlockNumber().ifPresent(l -> builder.put("terminalBlockNumber", l));
     getTerminalBlockHash().ifPresent(h -> builder.put("terminalBlockHash", h));
     // classic fork blocks
@@ -482,6 +489,11 @@ public StubGenesisConfigOptions mergeNetSplitBlock(final long blockNumber) {
     return this;
   }
 
+  public StubGenesisConfigOptions eip1153Block(final long blockNumber) {
+    eip1153BlockNumber = OptionalLong.of(blockNumber);
+    return this;
+  }
+
   public StubGenesisConfigOptions terminalTotalDifficulty(
       final UInt256 updatedTerminalTotalDifficulty) {
     terminalTotalDifficulty = Optional.of(updatedTerminalTotalDifficulty);

ethereum/api/src/test/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/DebugTraceBlockByHashTest.java

@@ -83,6 +83,7 @@ public void shouldReturnCorrectResponse() {
             Optional.empty(),
             false,
             Optional.empty(),
+            Optional.empty(),
             Optional.empty());
 
     final TransactionProcessingResult transaction1Result = mock(TransactionProcessingResult.class);

ethereum/api/src/test/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/DebugTraceBlockByNumberTest.java

@@ -88,6 +88,7 @@ public void shouldReturnCorrectResponse() {
             Optional.empty(),
             false,
             Optional.empty(),
+            Optional.empty(),
             Optional.empty());
 
     final TransactionProcessingResult transaction1Result = mock(TransactionProcessingResult.class);

ethereum/api/src/test/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/DebugTraceBlockTest.java

@@ -101,6 +101,7 @@ public void shouldReturnCorrectResponse() {
             Optional.empty(),
             false,
             Optional.empty(),
+            Optional.empty(),
             Optional.empty());
 
     final TransactionProcessingResult transaction1Result = mock(TransactionProcessingResult.class);

ethereum/api/src/test/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/DebugTraceTransactionTest.java

@@ -111,6 +111,7 @@ public void shouldTraceTheTransactionUsingTheTransactionTracer() {
             Optional.empty(),
             false,
             Optional.empty(),
+            Optional.empty(),
             Optional.empty());
     final List<TraceFrame> traceFrames = Collections.singletonList(traceFrame);
     final TransactionTrace transactionTrace =
@@ -176,6 +177,7 @@ public void shouldNotTraceTheTransactionIfNotFound() {
             Optional.empty(),
             false,
             Optional.empty(),
+            Optional.empty(),
             Optional.empty());
     final List<TraceFrame> traceFrames = Collections.singletonList(traceFrame);
     final TransactionTrace transactionTrace =

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/bonsai/BonsaiAccount.java

@@ -52,6 +52,7 @@ public class BonsaiAccount implements MutableAccount, EvmAccount {
   private Bytes code;
 
   private final Map<UInt256, UInt256> updatedStorage = new HashMap<>();
+  private final Map<UInt256, UInt256> updatedTransientStorage = new HashMap<>();
 
   BonsaiAccount(
       final BonsaiWorldView context,
@@ -103,6 +104,7 @@ public class BonsaiAccount implements MutableAccount, EvmAccount {
     this.codeHash = toCopy.codeHash;
     this.code = toCopy.code;
     updatedStorage.putAll(toCopy.updatedStorage);
+    updatedTransientStorage.putAll(toCopy.updatedTransientStorage);
 
     this.mutable = mutable;
   }
@@ -117,7 +119,7 @@ public class BonsaiAccount implements MutableAccount, EvmAccount {
     this.codeHash = tracked.getCodeHash();
     this.code = tracked.getCode();
     updatedStorage.putAll(tracked.getUpdatedStorage());
-
+    updatedTransientStorage.putAll(tracked.getUpdatedTransientStorage());
     this.mutable = true;
   }
 
@@ -243,13 +245,24 @@ public void setStorageValue(final UInt256 key, final UInt256 value) {
   @Override
   public void clearStorage() {
     updatedStorage.clear();
+    clearTransientStorage();
+  }
+
+  @Override
+  public void clearTransientStorage() {
+    updatedTransientStorage.clear();
   }
 
   @Override
   public Map<UInt256, UInt256> getUpdatedStorage() {
     return updatedStorage;
   }
 
+  @Override
+  public Map<UInt256, UInt256> getUpdatedTransientStorage() {
+    return updatedTransientStorage;
+  }
+
   @Override
   public MutableAccount getMutable() throws ModificationNotAllowedException {
     if (mutable) {
@@ -310,4 +323,21 @@ static void assertCloseEnoughForDiffing(
       }
     }
   }
+
+  @Override
+  public UInt256 getTransientStorageValue(final UInt256 key) {
+    if (updatedTransientStorage.containsKey(key)) {
+      return updatedTransientStorage.get(key);
+    } else {
+      return UInt256.ZERO;
+    }
+  }
+
+  @Override
+  public void setTransientStorageValue(final UInt256 key, final UInt256 value) {
+    if (!mutable) {
+      throw new UnsupportedOperationException("Account is immutable");
+    }
+    updatedTransientStorage.put(key, value);
+  }
 }

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/bonsai/BonsaiWorldStateUpdater.java

@@ -280,6 +280,8 @@ public void commit() {
         tracked.setStorageWasCleared(false); // storage already cleared for this transaction
       }
 
+      tracked.clearTransientStorage();
+
       // TODO maybe add address preimage?
     }
   }

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/debug/TraceFrame.java

@@ -58,6 +58,7 @@ public class TraceFrame {
   private final boolean virtualOperation;
   private final Optional<MemoryEntry> maybeUpdatedMemory;
   private final Optional<StorageEntry> maybeUpdatedStorage;
+  private final Optional<StorageEntry> maybeUpdatedTransientStorage;
   private OptionalLong precompiledGasCost;
 
   public TraceFrame(
@@ -83,7 +84,8 @@ public TraceFrame(
       final Optional<Bytes32[]> stackPostExecution,
       final boolean virtualOperation,
       final Optional<MemoryEntry> maybeUpdatedMemory,
-      final Optional<StorageEntry> maybeUpdatedStorage) {
+      final Optional<StorageEntry> maybeUpdatedStorage,
+      final Optional<StorageEntry> maybeUpdatedTransientStorage) {
     this.pc = pc;
     this.opcode = opcode;
     this.gasRemaining = gasRemaining;
@@ -107,6 +109,7 @@ public TraceFrame(
     this.virtualOperation = virtualOperation;
     this.maybeUpdatedMemory = maybeUpdatedMemory;
     this.maybeUpdatedStorage = maybeUpdatedStorage;
+    this.maybeUpdatedTransientStorage = maybeUpdatedTransientStorage;
     precompiledGasCost = OptionalLong.empty();
   }
 
@@ -229,6 +232,10 @@ public Optional<StorageEntry> getMaybeUpdatedStorage() {
     return maybeUpdatedStorage;
   }
 
+  public Optional<StorageEntry> getMaybeUpdatedTransientStorage() {
+    return maybeUpdatedTransientStorage;
+  }
+
   public OptionalLong getPrecompiledGasCost() {
     return precompiledGasCost;
   }

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/mainnet/MainnetProtocolSpecFactory.java

@@ -185,6 +185,17 @@ public ProtocolSpecBuilder parisDefinition(final GenesisConfigOptions genesisCon
         evmConfiguration);
   }
 
+  public ProtocolSpecBuilder eip1153Definition(final GenesisConfigOptions genesisConfigOptions) {
+    return MainnetProtocolSpecs.eip1153Definition(
+        chainId,
+        contractSizeLimit,
+        evmStackSize,
+        isRevertReasonEnabled,
+        genesisConfigOptions,
+        quorumCompatibilityMode,
+        evmConfiguration);
+  }
+
   ////////////////////////////////////////////////////////////////////////////////////////////////
   ////////////////////////////////////////////////////////////////////////////////////////////////
   // Classic Protocol Specs

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/mainnet/MainnetProtocolSpecs.java

@@ -43,6 +43,7 @@
 import org.hyperledger.besu.evm.gascalculator.BerlinGasCalculator;
 import org.hyperledger.besu.evm.gascalculator.ByzantiumGasCalculator;
 import org.hyperledger.besu.evm.gascalculator.ConstantinopleGasCalculator;
+import org.hyperledger.besu.evm.gascalculator.EIP1153GasCalculator;
 import org.hyperledger.besu.evm.gascalculator.FrontierGasCalculator;
 import org.hyperledger.besu.evm.gascalculator.HomesteadGasCalculator;
 import org.hyperledger.besu.evm.gascalculator.IstanbulGasCalculator;
@@ -632,6 +633,32 @@ static ProtocolSpecBuilder parisDefinition(
         .name("ParisFork");
   }
 
+  // TODO EIP-1153 change for the actual fork name when known
+  static ProtocolSpecBuilder eip1153Definition(
+      final Optional<BigInteger> chainId,
+      final OptionalInt configContractSizeLimit,
+      final OptionalInt configStackSizeLimit,
+      final boolean enableRevertReason,
+      final GenesisConfigOptions genesisConfigOptions,
+      final boolean quorumCompatibilityMode,
+      final EvmConfiguration evmConfiguration) {
+
+    return parisDefinition(
+            chainId,
+            configContractSizeLimit,
+            configStackSizeLimit,
+            enableRevertReason,
+            genesisConfigOptions,
+            quorumCompatibilityMode,
+            evmConfiguration)
+        .evmBuilder(
+            (gasCalculator, jdCacheConfig) ->
+                MainnetEVMs.eip1153(
+                    gasCalculator, chainId.orElse(BigInteger.ZERO), evmConfiguration))
+        .gasCalculator(EIP1153GasCalculator::new)
+        .name("EIP-1153");
+  }
+
   private static TransactionReceipt frontierTransactionReceiptFactory(
       // ignored because it's always FRONTIER
       final TransactionType __,

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/mainnet/ProtocolScheduleBuilder.java

@@ -234,6 +234,7 @@ private TreeMap<Long, BuilderMapEntry> buildMilestoneMap(
                 create(
                     config.getGrayGlacierBlockNumber(), specFactory.grayGlacierDefinition(config)),
                 create(config.getMergeNetSplitBlockNumber(), specFactory.parisDefinition(config)),
+                create(config.getEIP1153BlockNumber(), specFactory.eip1153Definition(config)),
                 // Classic Milestones
                 create(config.getEcip1015BlockNumber(), specFactory.tangerineWhistleDefinition()),
                 create(config.getDieHardBlockNumber(), specFactory.dieHardDefinition()),

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/vm/DebugOperationTracer.java

@@ -93,7 +93,8 @@ public void traceExecution(final MessageFrame frame, final ExecuteOperation exec
             stackPostExecution,
             currentOperation.isVirtualOperation(),
             frame.getMaybeUpdatedMemory(),
-            frame.getMaybeUpdatedStorage());
+            frame.getMaybeUpdatedStorage(),
+            frame.getMaybeUpdatedTransientStorage());
     traceFrames.add(lastFrame);
     frame.reset();
   }
@@ -126,6 +127,7 @@ public void tracePrecompileCall(
               Optional.empty(),
               true,
               Optional.empty(),
+              Optional.empty(),
               Optional.empty());
       traceFrames.add(traceFrame);
     }
@@ -172,6 +174,7 @@ public void traceAccountCreationResult(
                     Optional.empty(),
                     true,
                     Optional.empty(),
+                    Optional.empty(),
                     Optional.empty());
             traceFrames.add(traceFrame);
           }

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/worldstate/DefaultMutableWorldState.java

@@ -311,6 +311,12 @@ public UInt256 getOriginalStorageValue(final UInt256 key) {
       return getStorageValue(key);
     }
 
+    @Override
+    public UInt256 getTransientStorageValue(final UInt256 key) {
+      // Transient state isn't persistent
+      return UInt256.ZERO;
+    }
+
     @Override
     public NavigableMap<Bytes32, AccountStorageEntry> storageEntriesFrom(
         final Bytes32 startKeyHash, final int limit) {
@@ -435,6 +441,7 @@ public void commit() {
             serializeAccount(updated.getNonce(), updated.getBalance(), storageRoot, codeHash);
 
         wrapped.accountStateTrie.put(updated.getAddressHash(), account);
+        updated.clearTransientStorage();
       }
     }
   }