-
Notifications
You must be signed in to change notification settings - Fork 852
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add transaction selector based on min priority fee parameter (#6083)
Signed-off-by: Gabriel-Trintinalia <[email protected]>
- Loading branch information
1 parent
236779d
commit 41b9575
Showing
8 changed files
with
275 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
88 changes: 88 additions & 0 deletions
88
...ethereum/blockcreation/txselection/selectors/MinPriorityFeePerGasTransactionSelector.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| /* | ||
| * 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.blockcreation.txselection.selectors; | ||
|
|
||
| import org.hyperledger.besu.datatypes.Wei; | ||
| import org.hyperledger.besu.ethereum.blockcreation.txselection.BlockSelectionContext; | ||
| import org.hyperledger.besu.ethereum.blockcreation.txselection.TransactionSelectionResults; | ||
| import org.hyperledger.besu.ethereum.eth.transactions.PendingTransaction; | ||
| import org.hyperledger.besu.ethereum.processing.TransactionProcessingResult; | ||
| import org.hyperledger.besu.plugin.data.TransactionSelectionResult; | ||
|
|
||
| /** This class is responsible for selecting transactions based on the minimum priority fee. */ | ||
| public class MinPriorityFeePerGasTransactionSelector extends AbstractTransactionSelector { | ||
|
|
||
| /** | ||
| * Constructor for MinPriorityFeeSelector. | ||
| * | ||
| * @param context The context of block selection. | ||
| */ | ||
| public MinPriorityFeePerGasTransactionSelector(final BlockSelectionContext context) { | ||
| super(context); | ||
| } | ||
|
|
||
| /** | ||
| * Evaluates a transaction before processing. | ||
| * | ||
| * @param pendingTransaction The transaction to be evaluated. | ||
| * @param transactionSelectionResults The results of other transaction evaluations in the same | ||
| * block. | ||
| * @return TransactionSelectionResult. If the priority fee is below the minimum, it returns an | ||
| * invalid transient result. Otherwise, it returns a selected result. | ||
| */ | ||
| @Override | ||
| public TransactionSelectionResult evaluateTransactionPreProcessing( | ||
| final PendingTransaction pendingTransaction, | ||
| final TransactionSelectionResults transactionSelectionResults) { | ||
| if (isPriorityFeePriceBelowMinimum(pendingTransaction)) { | ||
| return TransactionSelectionResult.PRIORITY_FEE_PER_GAS_BELOW_CURRENT_MIN; | ||
| } | ||
| return TransactionSelectionResult.SELECTED; | ||
| } | ||
|
|
||
| /** | ||
| * Checks if the priority fee price is below the minimum. | ||
| * | ||
| * @param pendingTransaction The transaction to check. | ||
| * @return boolean. Returns true if the minimum priority fee price is below the minimum, false | ||
| * otherwise. | ||
| */ | ||
| private boolean isPriorityFeePriceBelowMinimum(final PendingTransaction pendingTransaction) { | ||
| // Priority txs are exempt from this check | ||
| if (pendingTransaction.hasPriority()) { | ||
| return false; | ||
| } | ||
| Wei priorityFeePerGas = | ||
| pendingTransaction | ||
| .getTransaction() | ||
| .getEffectivePriorityFeePerGas(context.processableBlockHeader().getBaseFee()); | ||
| return priorityFeePerGas.lessThan(context.miningParameters().getMinPriorityFeePerGas()); | ||
| } | ||
|
|
||
| /** | ||
| * No evaluation is performed post-processing. | ||
| * | ||
| * @param pendingTransaction The processed transaction. | ||
| * @param processingResult The result of the transaction processing. | ||
| * @return Always returns SELECTED. | ||
| */ | ||
| @Override | ||
| public TransactionSelectionResult evaluateTransactionPostProcessing( | ||
| final PendingTransaction pendingTransaction, | ||
| final TransactionSelectionResults blockTransactionResults, | ||
| final TransactionProcessingResult processingResult) { | ||
| return TransactionSelectionResult.SELECTED; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
99 changes: 99 additions & 0 deletions
99
.../hyperledger/besu/ethereum/blockcreation/MinPriorityFeePerGasTransactionSelectorTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| /* | ||
| * 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.blockcreation; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.mockito.ArgumentMatchers.any; | ||
| import static org.mockito.Mockito.mock; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| import org.hyperledger.besu.datatypes.Wei; | ||
| import org.hyperledger.besu.ethereum.blockcreation.txselection.BlockSelectionContext; | ||
| import org.hyperledger.besu.ethereum.blockcreation.txselection.selectors.AbstractTransactionSelector; | ||
| import org.hyperledger.besu.ethereum.blockcreation.txselection.selectors.MinPriorityFeePerGasTransactionSelector; | ||
| import org.hyperledger.besu.ethereum.core.MiningParameters; | ||
| import org.hyperledger.besu.ethereum.core.ProcessableBlockHeader; | ||
| import org.hyperledger.besu.ethereum.core.Transaction; | ||
| import org.hyperledger.besu.ethereum.eth.transactions.PendingTransaction; | ||
| import org.hyperledger.besu.plugin.data.TransactionSelectionResult; | ||
|
|
||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| public class MinPriorityFeePerGasTransactionSelectorTest { | ||
| private AbstractTransactionSelector transactionSelector; | ||
|
|
||
| private final int minPriorityFeeParameter = 7; | ||
|
|
||
| @BeforeEach | ||
| public void initialize() { | ||
| MiningParameters miningParameters = | ||
| MiningParameters.newDefault().setMinPriorityFeePerGas(Wei.of(minPriorityFeeParameter)); | ||
| BlockSelectionContext context = | ||
| new BlockSelectionContext( | ||
| miningParameters, | ||
| null, | ||
| null, | ||
| mock(ProcessableBlockHeader.class), | ||
| null, | ||
| null, | ||
| null, | ||
| null); | ||
| transactionSelector = new MinPriorityFeePerGasTransactionSelector(context); | ||
| } | ||
|
|
||
| @Test | ||
| public void shouldNotSelectWhen_PriorityFeePerGas_IsLessThan_MinPriorityFeePerGas() { | ||
| var transaction = mockTransactionWithPriorityFee(minPriorityFeeParameter - 1); | ||
| assertSelectionResult( | ||
| transaction, TransactionSelectionResult.PRIORITY_FEE_PER_GAS_BELOW_CURRENT_MIN); | ||
| } | ||
|
|
||
| @Test | ||
| public void shouldSelectWhen_PriorityFeePerGas_IsEqual_MinPriorityFeePerGas() { | ||
| var transaction = mockTransactionWithPriorityFee(minPriorityFeeParameter); | ||
| assertSelectionResult(transaction, TransactionSelectionResult.SELECTED); | ||
| } | ||
|
|
||
| @Test | ||
| public void shouldSelectWhen_PriorityFeePerGas_IsGreaterThan_MinPriorityFeePerGas() { | ||
| var transaction = mockTransactionWithPriorityFee(minPriorityFeeParameter + 1); | ||
| assertSelectionResult(transaction, TransactionSelectionResult.SELECTED); | ||
| } | ||
|
|
||
| @Test | ||
| public void shouldSelectWhenPrioritySender() { | ||
| var prioritySenderTransaction = mockTransactionWithPriorityFee(minPriorityFeeParameter - 1); | ||
| assertSelectionResult( | ||
| prioritySenderTransaction, | ||
| TransactionSelectionResult.PRIORITY_FEE_PER_GAS_BELOW_CURRENT_MIN); | ||
| when(prioritySenderTransaction.hasPriority()).thenReturn(true); | ||
| assertSelectionResult(prioritySenderTransaction, TransactionSelectionResult.SELECTED); | ||
| } | ||
|
|
||
| private void assertSelectionResult( | ||
| final PendingTransaction transaction, final TransactionSelectionResult expectedResult) { | ||
| var actualResult = transactionSelector.evaluateTransactionPreProcessing(transaction, null); | ||
| assertThat(actualResult).isEqualTo(expectedResult); | ||
| } | ||
|
|
||
| private PendingTransaction mockTransactionWithPriorityFee(final int priorityFeePerGas) { | ||
| PendingTransaction mockTransaction = mock(PendingTransaction.class); | ||
| Transaction transaction = mock(Transaction.class); | ||
| when(mockTransaction.getTransaction()).thenReturn(transaction); | ||
| when(transaction.getEffectivePriorityFeePerGas(any())).thenReturn(Wei.of(priorityFeePerGas)); | ||
| return mockTransaction; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters