Add the possibility for a plugin to validate a tx according to txpool rules

Signed-off-by: Fabio Di Fabio <fabio.difabio@consensys.net>

Author: fab-10

besu/src/main/java/org/hyperledger/besu/services/TransactionPoolServiceImpl.java

@@ -15,7 +15,9 @@
 package org.hyperledger.besu.services;
 
 import org.hyperledger.besu.datatypes.PendingTransaction;
+import org.hyperledger.besu.datatypes.Transaction;
 import org.hyperledger.besu.ethereum.eth.transactions.TransactionPool;
+import org.hyperledger.besu.plugin.data.ValidationResult;
 import org.hyperledger.besu.plugin.services.transactionpool.TransactionPoolService;
 
 import java.util.Collection;
@@ -48,4 +50,17 @@ public void enableTransactionPool() {
   public Collection<? extends PendingTransaction> getPendingTransactions() {
     return transactionPool.getPendingTransactions();
   }
+
+  @Override
+  public ValidationResult validateTransaction(
+      final Transaction transaction, final boolean isLocal, final boolean hasPriority) {
+    final var tx =
+        transaction instanceof org.hyperledger.besu.ethereum.core.Transaction coreTx
+            ? coreTx
+            : new org.hyperledger.besu.ethereum.core.Transaction.Builder()
+                .copiedFrom(transaction)
+                .build();
+
+    return transactionPool.validateTransaction(tx, isLocal, hasPriority);
+  }
 }

ethereum/core/src/main/java/org/hyperledger/besu/ethereum/core/Transaction.java

@@ -52,7 +52,9 @@
 import java.util.List;
 import java.util.Objects;
 import java.util.Optional;
+import java.util.function.Supplier;
 
+import com.google.common.base.Suppliers;
 import com.google.common.cache.Cache;
 import com.google.common.cache.CacheBuilder;
 import com.google.common.primitives.Longs;
@@ -65,6 +67,9 @@
 public class Transaction
     implements org.hyperledger.besu.datatypes.Transaction,
         org.hyperledger.besu.plugin.data.UnsignedPrivateMarkerTransaction {
+  // Supplier for the signature algorithm
+  private static final Supplier<SignatureAlgorithm> SIGNATURE_ALGORITHM =
+      Suppliers.memoize(SignatureAlgorithmFactory::getInstance);
 
   // Used for transactions that are not tied to a specific chain
   // (e.g. does not have a chain id associated with it).
@@ -1226,6 +1231,51 @@ public Builder copiedFrom(final Transaction toCopy) {
       return this;
     }
 
+    public Builder copiedFrom(final org.hyperledger.besu.datatypes.Transaction toCopy) {
+      this.transactionType = toCopy.getType();
+      this.nonce = toCopy.getNonce();
+      this.gasPrice = toCopy.getGasPrice().map(Wei::fromQuantity).orElse(null);
+      this.maxPriorityFeePerGas =
+          toCopy.getMaxPriorityFeePerGas().map(Wei::fromQuantity).orElse(null);
+      this.maxFeePerGas = toCopy.getMaxFeePerGas().map(Wei::fromQuantity).orElse(null);
+      this.maxFeePerBlobGas = toCopy.getMaxFeePerBlobGas().map(Wei::fromQuantity).orElse(null);
+      this.gasLimit = toCopy.getGasLimit();
+      this.to = Optional.ofNullable(toCopy.getTo().orElse(null));
+      this.value = Wei.fromQuantity(toCopy.getValue());
+      this.payload = toCopy.getPayload();
+      this.accessList = toCopy.getAccessList();
+      this.sender = toCopy.getSender();
+      this.chainId = toCopy.getChainId();
+      this.versionedHashes = toCopy.getVersionedHashes().orElse(null);
+      this.blobsWithCommitments = toCopy.getBlobsWithCommitments().orElse(null);
+      this.codeDelegationAuthorizations = toCopy.getCodeDelegationList();
+
+      final byte recId = getRecId(toCopy);
+      this.signature =
+          SIGNATURE_ALGORITHM.get().createSignature(toCopy.getR(), toCopy.getS(), recId);
+
+      return this;
+    }
+
+    private byte getRecId(final org.hyperledger.besu.datatypes.Transaction toCopy) {
+      final byte recId;
+      if (this.transactionType.equals(TransactionType.FRONTIER)) {
+        final BigInteger v = toCopy.getV();
+        if (v.equals(REPLAY_UNPROTECTED_V_BASE) || v.equals(REPLAY_UNPROTECTED_V_BASE_PLUS_1)) {
+          recId = v.subtract(REPLAY_UNPROTECTED_V_BASE).byteValueExact();
+        } else if (v.compareTo(REPLAY_PROTECTED_V_MIN) > 0) {
+          recId =
+              v.subtract(TWO.multiply(chainId.get()).add(REPLAY_PROTECTED_V_BASE)).byteValueExact();
+        } else {
+          throw new RuntimeException(
+              String.format("An unsupported encoded `v` value of %s was found", v));
+        }
+      } else {
+        recId = toCopy.getYParity().byteValueExact();
+      }
+      return recId;
+    }
+
     public Builder type(final TransactionType transactionType) {
       this.transactionType = transactionType;
       return this;

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

@@ -22,7 +22,8 @@
 
 import com.google.common.base.MoreObjects;
 
-public final class ValidationResult<T> {
+public final class ValidationResult<T>
+    implements org.hyperledger.besu.plugin.data.ValidationResult {
 
   private final Optional<T> invalidReason;
   private final Optional<String> errorMessage;
@@ -32,6 +33,7 @@ private ValidationResult(final Optional<T> invalidReason, final Optional<String>
     this.errorMessage = errorMessage;
   }
 
+  @Override
   public boolean isValid() {
     return invalidReason.isEmpty();
   }
@@ -40,6 +42,7 @@ public T getInvalidReason() throws NoSuchElementException {
     return invalidReason.get();
   }
 
+  @Override
   public String getErrorMessage() {
     return errorMessage.orElse(getInvalidReason().toString());
   }

ethereum/eth/src/main/java/org/hyperledger/besu/ethereum/eth/transactions/TransactionPool.java

@@ -259,7 +259,7 @@ private ValidationResult<TransactionInvalidReason> addTransaction(
     }
 
     final ValidationResultAndAccount validationResult =
-        validateTransaction(transaction, isLocal, hasPriority);
+        internalValidateTransaction(transaction, isLocal, hasPriority);
 
     if (validationResult.result.isValid()) {
       final TransactionAddedResult status =
@@ -409,7 +409,12 @@ private TransactionValidator getTransactionValidator() {
         .get();
   }
 
-  private ValidationResultAndAccount validateTransaction(
+  public ValidationResult<TransactionInvalidReason> validateTransaction(
+      final Transaction transaction, final boolean isLocal, final boolean hasPriority) {
+    return internalValidateTransaction(transaction, isLocal, hasPriority).result;
+  }
+
+  private ValidationResultAndAccount internalValidateTransaction(
       final Transaction transaction, final boolean isLocal, final boolean hasPriority) {
 
     final BlockHeader chainHeadBlockHeader = getChainHeadBlockHeader().orElse(null);

plugin-api/src/main/java/org/hyperledger/besu/plugin/data/ValidationResult.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright contributors to Besu.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package org.hyperledger.besu.plugin.data;
+
+/** Represent a result of a transaction validation */
+public interface ValidationResult {
+  /**
+   * Return if transaction is valid or not
+   *
+   * @return true if transaction is valid
+   */
+  boolean isValid();
+
+  /**
+   * If the transaction is not valid returns the related error message, null otherwise
+   *
+   * @return the reason why the transaction is not valid or null if the transaction is valid
+   */
+  String getErrorMessage();
+}

plugin-api/src/main/java/org/hyperledger/besu/plugin/services/transactionpool/TransactionPoolService.java

@@ -15,6 +15,8 @@
 package org.hyperledger.besu.plugin.services.transactionpool;
 
 import org.hyperledger.besu.datatypes.PendingTransaction;
+import org.hyperledger.besu.datatypes.Transaction;
+import org.hyperledger.besu.plugin.data.ValidationResult;
 import org.hyperledger.besu.plugin.services.BesuService;
 
 import java.util.Collection;
@@ -33,4 +35,15 @@ public interface TransactionPoolService extends BesuService {
    * @return a collection of pending transactions
    */
   Collection<? extends PendingTransaction> getPendingTransactions();
+
+  /**
+   * Validate a transaction for txpool addition
+   *
+   * @param transaction the transaction
+   * @param isLocal if the transaction is from a local source
+   * @param hasPriority if the transaction has priority
+   * @return the result of the validation
+   */
+  ValidationResult validateTransaction(
+      Transaction transaction, boolean isLocal, boolean hasPriority);
 }