mirror of https://github.com/hyperledger/besu
Introduce transaction validator interface (phase 2) (#5682)
Signed-off-by: Fabio Di Fabio <fabio.difabio@consensys.net>pull/5715/head
Fabio Di Fabio
1 year ago
committed by
GitHub
parent
1a7635bc3e
commit
6603ebb716
@ -0,0 +1,75 @@ |
||||
/* |
||||
* Copyright Hyperledger Besu Contributors. |
||||
* |
||||
* 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.ethereum.mainnet; |
||||
|
||||
import org.hyperledger.besu.datatypes.Wei; |
||||
import org.hyperledger.besu.ethereum.core.PermissionTransactionFilter; |
||||
import org.hyperledger.besu.ethereum.core.Transaction; |
||||
import org.hyperledger.besu.ethereum.transaction.TransactionInvalidReason; |
||||
import org.hyperledger.besu.evm.account.Account; |
||||
|
||||
import java.util.Optional; |
||||
|
||||
/** |
||||
* Validates a transaction based on Frontier protocol runtime requirements. |
||||
* |
||||
* <p>The {@link PermissionTransactionValidator} performs the intrinsic gas cost check on the given |
||||
* {@link Transaction}. |
||||
*/ |
||||
public class PermissionTransactionValidator implements TransactionValidator { |
||||
private final TransactionValidator delegate; |
||||
private final PermissionTransactionFilter permissionTransactionFilter; |
||||
|
||||
public PermissionTransactionValidator( |
||||
final TransactionValidator delegate, |
||||
final PermissionTransactionFilter permissionTransactionFilter) { |
||||
this.delegate = delegate; |
||||
this.permissionTransactionFilter = permissionTransactionFilter; |
||||
} |
||||
|
||||
@Override |
||||
public ValidationResult<TransactionInvalidReason> validate( |
||||
final Transaction transaction, |
||||
final Optional<Wei> baseFee, |
||||
final TransactionValidationParams transactionValidationParams) { |
||||
return delegate.validate(transaction, baseFee, transactionValidationParams); |
||||
} |
||||
|
||||
@Override |
||||
public ValidationResult<TransactionInvalidReason> validateForSender( |
||||
final Transaction transaction, |
||||
final Account sender, |
||||
final TransactionValidationParams validationParams) { |
||||
|
||||
if (!isSenderAllowed(transaction, validationParams)) { |
||||
return ValidationResult.invalid( |
||||
TransactionInvalidReason.TX_SENDER_NOT_AUTHORIZED, |
||||
String.format("Sender %s is not on the Account Allowlist", transaction.getSender())); |
||||
} |
||||
|
||||
return delegate.validateForSender(transaction, sender, validationParams); |
||||
} |
||||
|
||||
private boolean isSenderAllowed( |
||||
final Transaction transaction, final TransactionValidationParams validationParams) { |
||||
if (validationParams.checkLocalPermissions() || validationParams.checkOnchainPermissions()) { |
||||
return permissionTransactionFilter.permitted( |
||||
transaction, |
||||
validationParams.checkLocalPermissions(), |
||||
validationParams.checkOnchainPermissions()); |
||||
} |
||||
return true; |
||||
} |
||||
} |
||||
@ -0,0 +1,109 @@ |
||||
/* |
||||
* Copyright Hyperledger Besu Contributors. |
||||
* |
||||
* 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.ethereum.mainnet; |
||||
|
||||
import org.hyperledger.besu.datatypes.TransactionType; |
||||
import org.hyperledger.besu.ethereum.GasLimitCalculator; |
||||
import org.hyperledger.besu.ethereum.core.PermissionTransactionFilter; |
||||
import org.hyperledger.besu.ethereum.mainnet.feemarket.FeeMarket; |
||||
import org.hyperledger.besu.evm.gascalculator.GasCalculator; |
||||
|
||||
import java.math.BigInteger; |
||||
import java.util.Optional; |
||||
import java.util.Set; |
||||
|
||||
import com.google.common.base.Suppliers; |
||||
|
||||
public class TransactionValidatorFactory { |
||||
private final GasCalculator gasCalculator; |
||||
private final GasLimitCalculator gasLimitCalculator; |
||||
private final FeeMarket feeMarket; |
||||
private final boolean disallowSignatureMalleability; |
||||
private final Optional<BigInteger> chainId; |
||||
private final Set<TransactionType> acceptedTransactionTypes; |
||||
private final int maxInitcodeSize; |
||||
private Optional<PermissionTransactionFilter> permissionTransactionFilter = Optional.empty(); |
||||
|
||||
public TransactionValidatorFactory( |
||||
final GasCalculator gasCalculator, |
||||
final GasLimitCalculator gasLimitCalculator, |
||||
final boolean checkSignatureMalleability, |
||||
final Optional<BigInteger> chainId) { |
||||
this( |
||||
gasCalculator, |
||||
gasLimitCalculator, |
||||
checkSignatureMalleability, |
||||
chainId, |
||||
Set.of(TransactionType.FRONTIER)); |
||||
} |
||||
|
||||
public TransactionValidatorFactory( |
||||
final GasCalculator gasCalculator, |
||||
final GasLimitCalculator gasLimitCalculator, |
||||
final boolean checkSignatureMalleability, |
||||
final Optional<BigInteger> chainId, |
||||
final Set<TransactionType> acceptedTransactionTypes) { |
||||
this( |
||||
gasCalculator, |
||||
gasLimitCalculator, |
||||
FeeMarket.legacy(), |
||||
checkSignatureMalleability, |
||||
chainId, |
||||
acceptedTransactionTypes, |
||||
Integer.MAX_VALUE); |
||||
} |
||||
|
||||
public TransactionValidatorFactory( |
||||
final GasCalculator gasCalculator, |
||||
final GasLimitCalculator gasLimitCalculator, |
||||
final FeeMarket feeMarket, |
||||
final boolean checkSignatureMalleability, |
||||
final Optional<BigInteger> chainId, |
||||
final Set<TransactionType> acceptedTransactionTypes, |
||||
final int maxInitcodeSize) { |
||||
this.gasCalculator = gasCalculator; |
||||
this.gasLimitCalculator = gasLimitCalculator; |
||||
this.feeMarket = feeMarket; |
||||
this.disallowSignatureMalleability = checkSignatureMalleability; |
||||
this.chainId = chainId; |
||||
this.acceptedTransactionTypes = acceptedTransactionTypes; |
||||
this.maxInitcodeSize = maxInitcodeSize; |
||||
} |
||||
|
||||
public void setPermissionTransactionFilter( |
||||
final PermissionTransactionFilter permissionTransactionFilter) { |
||||
this.permissionTransactionFilter = Optional.of(permissionTransactionFilter); |
||||
} |
||||
|
||||
public TransactionValidator get() { |
||||
return Suppliers.memoize(this::createTransactionValidator).get(); |
||||
} |
||||
|
||||
private TransactionValidator createTransactionValidator() { |
||||
final TransactionValidator baseValidator = |
||||
new MainnetTransactionValidator( |
||||
gasCalculator, |
||||
gasLimitCalculator, |
||||
feeMarket, |
||||
disallowSignatureMalleability, |
||||
chainId, |
||||
acceptedTransactionTypes, |
||||
maxInitcodeSize); |
||||
if (permissionTransactionFilter.isPresent()) { |
||||
return new PermissionTransactionValidator(baseValidator, permissionTransactionFilter.get()); |
||||
} |
||||
return baseValidator; |
||||
} |
||||
} |
||||
@ -0,0 +1,161 @@ |
||||
/* |
||||
* Copyright Hyperledger Besu Contributors. |
||||
* |
||||
* 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.ethereum.mainnet; |
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat; |
||||
import static org.hyperledger.besu.ethereum.mainnet.TransactionValidationParams.transactionPoolParams; |
||||
import static org.mockito.ArgumentMatchers.any; |
||||
import static org.mockito.ArgumentMatchers.anyBoolean; |
||||
import static org.mockito.Mockito.mock; |
||||
import static org.mockito.Mockito.verifyNoInteractions; |
||||
import static org.mockito.Mockito.when; |
||||
|
||||
import org.hyperledger.besu.crypto.KeyPair; |
||||
import org.hyperledger.besu.crypto.SignatureAlgorithm; |
||||
import org.hyperledger.besu.crypto.SignatureAlgorithmFactory; |
||||
import org.hyperledger.besu.datatypes.Wei; |
||||
import org.hyperledger.besu.ethereum.GasLimitCalculator; |
||||
import org.hyperledger.besu.ethereum.core.PermissionTransactionFilter; |
||||
import org.hyperledger.besu.ethereum.core.Transaction; |
||||
import org.hyperledger.besu.ethereum.core.TransactionTestFixture; |
||||
import org.hyperledger.besu.ethereum.transaction.TransactionInvalidReason; |
||||
import org.hyperledger.besu.evm.account.Account; |
||||
import org.hyperledger.besu.evm.gascalculator.GasCalculator; |
||||
|
||||
import java.math.BigInteger; |
||||
import java.util.Optional; |
||||
import java.util.function.Supplier; |
||||
|
||||
import com.google.common.base.Suppliers; |
||||
import org.junit.Test; |
||||
import org.junit.runner.RunWith; |
||||
import org.mockito.ArgumentCaptor; |
||||
import org.mockito.Mock; |
||||
import org.mockito.junit.MockitoJUnitRunner; |
||||
|
||||
@RunWith(MockitoJUnitRunner.class) |
||||
public class PermissionTransactionValidatorTest extends MainnetTransactionValidatorTest { |
||||
|
||||
private static final Supplier<SignatureAlgorithm> SIGNATURE_ALGORITHM = |
||||
Suppliers.memoize(SignatureAlgorithmFactory::getInstance); |
||||
private static final KeyPair senderKeys = SIGNATURE_ALGORITHM.get().generateKeyPair(); |
||||
@Mock private GasCalculator gasCalculator; |
||||
|
||||
private final Transaction basicTransaction = |
||||
new TransactionTestFixture() |
||||
.chainId(Optional.of(BigInteger.ONE)) |
||||
.createTransaction(senderKeys); |
||||
|
||||
@Test |
||||
public void shouldRejectTransactionIfAccountIsNotPermitted() { |
||||
final TransactionValidator baseValidator = |
||||
createTransactionValidator( |
||||
gasCalculator, GasLimitCalculator.constant(), false, Optional.empty()); |
||||
final TransactionValidator validator = |
||||
new PermissionTransactionValidator(baseValidator, transactionFilter(false)); |
||||
|
||||
assertThat( |
||||
validator.validateForSender( |
||||
basicTransaction, accountWithNonce(0), transactionPoolParams)) |
||||
.isEqualTo(ValidationResult.invalid(TransactionInvalidReason.TX_SENDER_NOT_AUTHORIZED)); |
||||
} |
||||
|
||||
@Test |
||||
public void shouldAcceptValidTransactionIfAccountIsPermitted() { |
||||
final TransactionValidator baseValidator = |
||||
createTransactionValidator( |
||||
gasCalculator, GasLimitCalculator.constant(), false, Optional.empty()); |
||||
final TransactionValidator validator = |
||||
new PermissionTransactionValidator(baseValidator, transactionFilter(true)); |
||||
|
||||
assertThat( |
||||
validator.validateForSender( |
||||
basicTransaction, accountWithNonce(0), transactionPoolParams)) |
||||
.isEqualTo(ValidationResult.valid()); |
||||
} |
||||
|
||||
@Test |
||||
public void shouldPropagateCorrectStateChangeParamToTransactionFilter() { |
||||
final ArgumentCaptor<Boolean> stateChangeLocalParamCaptor = |
||||
ArgumentCaptor.forClass(Boolean.class); |
||||
final ArgumentCaptor<Boolean> stateChangeOnchainParamCaptor = |
||||
ArgumentCaptor.forClass(Boolean.class); |
||||
final PermissionTransactionFilter permissionTransactionFilter = |
||||
mock(PermissionTransactionFilter.class); |
||||
when(permissionTransactionFilter.permitted( |
||||
any(Transaction.class), |
||||
stateChangeLocalParamCaptor.capture(), |
||||
stateChangeOnchainParamCaptor.capture())) |
||||
.thenReturn(true); |
||||
|
||||
final TransactionValidator baseValidator = |
||||
createTransactionValidator( |
||||
gasCalculator, GasLimitCalculator.constant(), false, Optional.empty()); |
||||
final TransactionValidator validator = |
||||
new PermissionTransactionValidator(baseValidator, permissionTransactionFilter); |
||||
|
||||
final TransactionValidationParams validationParams = |
||||
ImmutableTransactionValidationParams.builder().checkOnchainPermissions(true).build(); |
||||
|
||||
validator.validateForSender(basicTransaction, accountWithNonce(0), validationParams); |
||||
|
||||
assertThat(stateChangeLocalParamCaptor.getValue()).isTrue(); |
||||
assertThat(stateChangeOnchainParamCaptor.getValue()).isTrue(); |
||||
} |
||||
|
||||
@Test |
||||
public void shouldNotCheckAccountPermissionIfBothValidationParamsCheckPermissionsAreFalse() { |
||||
final PermissionTransactionFilter permissionTransactionFilter = |
||||
mock(PermissionTransactionFilter.class); |
||||
|
||||
final TransactionValidator baseValidator = |
||||
createTransactionValidator( |
||||
gasCalculator, GasLimitCalculator.constant(), false, Optional.empty()); |
||||
final TransactionValidator validator = |
||||
new PermissionTransactionValidator(baseValidator, permissionTransactionFilter); |
||||
|
||||
final TransactionValidationParams validationParams = |
||||
ImmutableTransactionValidationParams.builder() |
||||
.checkOnchainPermissions(false) |
||||
.checkLocalPermissions(false) |
||||
.build(); |
||||
|
||||
validator.validateForSender(basicTransaction, accountWithNonce(0), validationParams); |
||||
|
||||
assertThat(validator.validateForSender(basicTransaction, accountWithNonce(0), validationParams)) |
||||
.isEqualTo(ValidationResult.valid()); |
||||
|
||||
verifyNoInteractions(permissionTransactionFilter); |
||||
} |
||||
|
||||
private Account accountWithNonce(final long nonce) { |
||||
return account(basicTransaction.getUpfrontCost(0L), nonce); |
||||
} |
||||
|
||||
private Account account(final Wei balance, final long nonce) { |
||||
final Account account = mock(Account.class); |
||||
when(account.getBalance()).thenReturn(balance); |
||||
when(account.getNonce()).thenReturn(nonce); |
||||
return account; |
||||
} |
||||
|
||||
private PermissionTransactionFilter transactionFilter(final boolean permitted) { |
||||
final PermissionTransactionFilter permissionTransactionFilter = |
||||
mock(PermissionTransactionFilter.class); |
||||
when(permissionTransactionFilter.permitted(any(Transaction.class), anyBoolean(), anyBoolean())) |
||||
.thenReturn(permitted); |
||||
return permissionTransactionFilter; |
||||
} |
||||
} |
||||
Loading…
Reference in new issue