adding tests and javadoc comments

Signed-off-by: Daniel Lehrner <[email protected]>

Author: daniellehrner

ethereum/core/src/test/java/org/hyperledger/besu/ethereum/mainnet/IntrinsicGasTest.java

@@ -16,15 +16,21 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+import org.hyperledger.besu.datatypes.AccessListEntry;
 import org.hyperledger.besu.ethereum.core.Transaction;
+import org.hyperledger.besu.ethereum.rlp.BytesValueRLPOutput;
 import org.hyperledger.besu.ethereum.rlp.RLP;
 import org.hyperledger.besu.evm.gascalculator.FrontierGasCalculator;
 import org.hyperledger.besu.evm.gascalculator.GasCalculator;
 import org.hyperledger.besu.evm.gascalculator.IstanbulGasCalculator;
+import org.hyperledger.besu.evm.gascalculator.PragueGasCalculator;
+import org.hyperledger.besu.evm.gascalculator.ShanghaiGasCalculator;
 
+import java.util.List;
 import java.util.stream.Stream;
 
 import org.apache.tuweni.bytes.Bytes;
+import org.apache.tuweni.bytes.Bytes32;
 import org.assertj.core.api.Assertions;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
@@ -36,6 +42,8 @@ public class IntrinsicGasTest {
   public static Stream<Arguments> data() {
     final GasCalculator frontier = new FrontierGasCalculator();
     final GasCalculator istanbul = new IstanbulGasCalculator();
+    final GasCalculator shanghai = new ShanghaiGasCalculator();
+    final GasCalculator prague = new PragueGasCalculator();
     return Stream.of(
         // EnoughGAS
         Arguments.of(
@@ -81,16 +89,36 @@ public static Stream<Arguments> data() {
         Arguments.of(
             istanbul,
             21116L,
-            "0xf87c80018261a894095e7baea6a6c7c4c2dfeb977efac326af552d870a9d00000000000000000000000000000000000000000000000000000000001ba048b55bfa915ac795c431978d8a6a992b628d557da5ff759b307d495a36649353a01fffd310ac743f371de3b9f7f9cb56c0b28ad43601b4ab949f53faa07bd2c804"));
+            "0xf87c80018261a894095e7baea6a6c7c4c2dfeb977efac326af552d870a9d00000000000000000000000000000000000000000000000000000000001ba048b55bfa915ac795c431978d8a6a992b628d557da5ff759b307d495a36649353a01fffd310ac743f371de3b9f7f9cb56c0b28ad43601b4ab949f53faa07bd2c804"),
+        // CallData Gas Increase
+        Arguments.of(
+            prague,
+            21290L,
+            "0xf87c80018261a894095e7baea6a6c7c4c2dfeb977efac326af552d870a9d00000000000000000000000000000000000000000000000000000000001ba048b55bfa915ac795c431978d8a6a992b628d557da5ff759b307d495a36649353a01fffd310ac743f371de3b9f7f9cb56c0b28ad43601b4ab949f53faa07bd2c804"),
+        // AccessList
+        Arguments.of(
+            shanghai,
+            25300L,
+            "0x01f89a018001826a4094095e7baea6a6c7c4c2dfeb977efac326af552d878080f838f794a95e7baea6a6c7c4c2dfeb977efac326af552d87e1a0ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80a05cbd172231fc0735e0fb994dd5b1a4939170a260b36f0427a8a80866b063b948a07c230f7f578dd61785c93361b9871c0706ebfa6d06e3f4491dc9558c5202ed36"));
   }
 
   @ParameterizedTest
   @MethodSource("data")
   public void validateGasCost(
       final GasCalculator gasCalculator, final long expectedGas, final String txRlp) {
-    Transaction t = Transaction.readFrom(RLP.input(Bytes.fromHexString(txRlp)));
+    Bytes rlp = Bytes.fromHexString(txRlp);
+
+    // non-frontier transactions need to be opaque for parsing to work
+    if (rlp.get(0) > 0) {
+      final BytesValueRLPOutput output = new BytesValueRLPOutput();
+      output.writeBytes(rlp);
+      rlp = output.encoded();
+    }
+
+    Transaction t = Transaction.readFrom(RLP.input(rlp));
     Assertions.assertThat(
-            gasCalculator.transactionIntrinsicGasCost(t.getPayload(), t.isContractCreation()))
+            gasCalculator.transactionIntrinsicGasCost(
+                t.getPayload(), t.isContractCreation(), evmGasUsed(gasCalculator, t)))
         .isEqualTo(expectedGas);
   }
 
@@ -100,4 +128,21 @@ void dryRunDetector() {
         .withFailMessage("This test is here so gradle --dry-run executes this class")
         .isTrue();
   }
+
+  long evmGasUsed(final GasCalculator gasCalculator, final Transaction transaction) {
+    final List<AccessListEntry> accessListEntries = transaction.getAccessList().orElse(List.of());
+
+    int accessListStorageCount = 0;
+    for (final var entry : accessListEntries) {
+      final List<Bytes32> storageKeys = entry.storageKeys();
+      accessListStorageCount += storageKeys.size();
+    }
+    final long accessListGas =
+        gasCalculator.accessListGasCost(accessListEntries.size(), accessListStorageCount);
+
+    final long codeDelegationGas =
+        gasCalculator.delegateCodeGasCost(transaction.codeDelegationListSize());
+
+    return accessListGas + codeDelegationGas;
+  }
 }

ethereum/core/src/test/java/org/hyperledger/besu/ethereum/mainnet/MainnetTransactionValidatorTest.java

@@ -128,7 +128,7 @@ public void shouldRejectTransactionIfIntrinsicGasExceedsGasLimit() {
             .gasLimit(10)
             .chainId(Optional.empty())
             .createTransaction(senderKeys);
-    when(gasCalculator.transactionIntrinsicGasCost(any(), anyBoolean())).thenReturn(50L);
+    when(gasCalculator.transactionIntrinsicGasCost(any(), anyBoolean(), anyLong())).thenReturn(50L);
 
     assertThat(
             validator.validate(
@@ -398,7 +398,7 @@ public void shouldAcceptOnlyTransactionsInAcceptedTransactionTypes() {
                 transaction, Optional.empty(), Optional.empty(), transactionValidationParams))
         .isEqualTo(ValidationResult.invalid(INVALID_TRANSACTION_FORMAT));
 
-    when(gasCalculator.transactionIntrinsicGasCost(any(), anyBoolean())).thenReturn(0L);
+    when(gasCalculator.transactionIntrinsicGasCost(any(), anyBoolean(), anyLong())).thenReturn(0L);
 
     assertThat(
             eip1559Validator.validate(
@@ -475,7 +475,7 @@ public void shouldAcceptValidEIP1559() {
             .chainId(Optional.of(BigInteger.ONE))
             .createTransaction(senderKeys);
     final Optional<Wei> basefee = Optional.of(Wei.of(150000L));
-    when(gasCalculator.transactionIntrinsicGasCost(any(), anyBoolean())).thenReturn(50L);
+    when(gasCalculator.transactionIntrinsicGasCost(any(), anyBoolean(), anyLong())).thenReturn(50L);
 
     assertThat(
             validator.validate(transaction, basefee, Optional.empty(), transactionValidationParams))
@@ -500,7 +500,7 @@ public void shouldValidate1559TransactionWithPriceLowerThanBaseFeeForTransaction
             .type(TransactionType.EIP1559)
             .chainId(Optional.of(BigInteger.ONE))
             .createTransaction(senderKeys);
-    when(gasCalculator.transactionIntrinsicGasCost(any(), anyBoolean())).thenReturn(50L);
+    when(gasCalculator.transactionIntrinsicGasCost(any(), anyBoolean(), anyLong())).thenReturn(50L);
 
     assertThat(
             validator.validate(

evm/src/main/java/org/hyperledger/besu/evm/gascalculator/FrontierGasCalculator.java

@@ -38,6 +38,7 @@ public class FrontierGasCalculator implements GasCalculator {
 
   private static final long TX_DATA_NON_ZERO_COST = 68L;
 
+  /** Minimum base cost that every transaction needs to pay */
   protected static final long TX_BASE_COST = 21_000L;
 
   private static final long TX_CREATE_EXTRA_COST = 0L;
@@ -139,6 +140,14 @@ public long transactionIntrinsicGasCost(
     return clampedAdd(TX_BASE_COST, dynamicIntrinsicGasCost);
   }
 
+  /**
+   * Calculates the dynamic part of the intrinsic gas cost
+   *
+   * @param payload the call data payload
+   * @param isContractCreation whether the transaction is a contract creation
+   * @param evmGasUsed how much gas is used by access lists and code delegations
+   * @return the dynamic part of the intrinsic gas cost
+   */
   protected long dynamicIntrinsicGasCost(
       final Bytes payload, final boolean isContractCreation, final long evmGasUsed) {
     final int payloadSize = payload.size();
@@ -160,21 +169,40 @@ protected long dynamicIntrinsicGasCost(
     return cost;
   }
 
+  /**
+   * Calculates the cost of the call data
+   *
+   * @param payloadSize the total size of the payload
+   * @param zeroBytes the number of zero bytes in the payload
+   * @return the cost of the call data
+   */
   protected long callDataCost(final long payloadSize, final long zeroBytes) {
     return clampedAdd(
         TX_DATA_NON_ZERO_COST * (payloadSize - zeroBytes), TX_DATA_ZERO_COST * zeroBytes);
   }
 
+  /**
+   * Counts the zero bytes in the payload
+   *
+   * @param payload the payload
+   * @return the number of zero bytes in the payload
+   */
   protected static long zeroBytes(final Bytes payload) {
     int zeros = 0;
     for (int i = 0; i < payload.size(); i++) {
       if (payload.get(i) == 0) {
-        ++zeros;
+        zeros += 1;
       }
     }
     return zeros;
   }
 
+  /**
+   * Returns the gas cost for contract creation transactions
+   *
+   * @param ignored the size of the contract creation code (ignored in Frontier)
+   * @return the gas cost for contract creation transactions
+   */
   protected long contractCreationCost(final int ignored) {
     return txCreateExtraGasCost();
   }