-
Notifications
You must be signed in to change notification settings - Fork 840
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve blob size transaction selector #7312
Merged
fab-10
merged 1 commit into
hyperledger:main
from
fab-10:blob-size-selector-improvement
Jul 16, 2024
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
95 changes: 95 additions & 0 deletions
95
...ledger/besu/ethereum/blockcreation/txselection/selectors/BlobSizeTransactionSelector.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,95 @@ | ||
| /* | ||
| * Copyright contributors to Hyperledger 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.ethereum.blockcreation.txselection.selectors; | ||
|
|
||
| import org.hyperledger.besu.ethereum.blockcreation.txselection.BlockSelectionContext; | ||
| import org.hyperledger.besu.ethereum.blockcreation.txselection.TransactionEvaluationContext; | ||
| import org.hyperledger.besu.ethereum.blockcreation.txselection.TransactionSelectionResults; | ||
| import org.hyperledger.besu.ethereum.processing.TransactionProcessingResult; | ||
| import org.hyperledger.besu.plugin.data.TransactionSelectionResult; | ||
|
|
||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * This class extends AbstractTransactionSelector and provides a specific implementation for | ||
| * evaluating transactions based on blobs size. It checks if a transaction supports blobs, and if | ||
| * so, checks that there is enough remaining data gas in the block to fit the blobs of the tx. | ||
| */ | ||
| public class BlobSizeTransactionSelector extends AbstractTransactionSelector { | ||
| private static final Logger LOG = LoggerFactory.getLogger(BlobSizeTransactionSelector.class); | ||
|
|
||
| public BlobSizeTransactionSelector(final BlockSelectionContext context) { | ||
| super(context); | ||
| } | ||
|
|
||
| /** | ||
| * Evaluates a transaction considering other transactions in the same block. If the tx does not | ||
| * support blobs, no check is performed, and SELECTED is returned, otherwise SELECTED is returned | ||
| * only if there is enough remaining blob gas to fit the blobs of the tx, otherwise a specific not | ||
| * selected result is returned, depending on the fact that the block already contains the max | ||
| * number of blobs or not. | ||
| * | ||
| * @param evaluationContext The current selection session data. | ||
| * @param transactionSelectionResults The results of other transaction evaluations in the same | ||
| * block. | ||
| * @return The result of the transaction selection. | ||
| */ | ||
| @Override | ||
| public TransactionSelectionResult evaluateTransactionPreProcessing( | ||
| final TransactionEvaluationContext evaluationContext, | ||
| final TransactionSelectionResults transactionSelectionResults) { | ||
|
|
||
| final var tx = evaluationContext.getTransaction(); | ||
| if (tx.getType().supportsBlob()) { | ||
|
|
||
| final var remainingBlobGas = | ||
| context.gasLimitCalculator().currentBlobGasLimit() | ||
| - transactionSelectionResults.getCumulativeBlobGasUsed(); | ||
|
|
||
| if (remainingBlobGas == 0) { | ||
| LOG.atTrace() | ||
| .setMessage("The block already contains the max number of allowed blobs") | ||
| .addArgument(evaluationContext.getPendingTransaction()::toTraceLog) | ||
| .log(); | ||
| return TransactionSelectionResult.BLOBS_FULL; | ||
| } | ||
|
|
||
| final long requestedBlobGas = context.gasCalculator().blobGasCost(tx.getBlobCount()); | ||
|
|
||
| if (requestedBlobGas > remainingBlobGas) { | ||
| LOG.atTrace() | ||
| .setMessage( | ||
| "There is not enough blob gas available to fit the blobs of the transaction {} in the block." | ||
| + " Available {} / Requested {}") | ||
| .addArgument(evaluationContext.getPendingTransaction()::toTraceLog) | ||
| .addArgument(remainingBlobGas) | ||
| .addArgument(requestedBlobGas) | ||
| .log(); | ||
| return TransactionSelectionResult.TX_TOO_LARGE_FOR_REMAINING_BLOB_GAS; | ||
| } | ||
| } | ||
| return TransactionSelectionResult.SELECTED; | ||
| } | ||
|
|
||
| @Override | ||
| public TransactionSelectionResult evaluateTransactionPostProcessing( | ||
| final TransactionEvaluationContext evaluationContext, | ||
| final TransactionSelectionResults blockTransactionResults, | ||
| final TransactionProcessingResult processingResult) { | ||
| // All necessary checks were done in the pre-processing method, so nothing to do here. | ||
| 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
188 changes: 188 additions & 0 deletions
188
...er/besu/ethereum/blockcreation/txselection/selectors/BlobSizeTransactionSelectorTest.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,188 @@ | ||
| /* | ||
| * Copyright contributors to Hyperledger 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.ethereum.blockcreation.txselection.selectors; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.assertj.core.api.Assertions.fail; | ||
| import static org.mockito.Answers.RETURNS_DEEP_STUBS; | ||
| import static org.mockito.ArgumentMatchers.anyInt; | ||
| import static org.mockito.Mockito.verify; | ||
| 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.Address; | ||
| import org.hyperledger.besu.datatypes.Blob; | ||
| import org.hyperledger.besu.datatypes.BlobsWithCommitments; | ||
| import org.hyperledger.besu.datatypes.Hash; | ||
| import org.hyperledger.besu.datatypes.KZGCommitment; | ||
| import org.hyperledger.besu.datatypes.KZGProof; | ||
| import org.hyperledger.besu.datatypes.TransactionType; | ||
| import org.hyperledger.besu.datatypes.VersionedHash; | ||
| import org.hyperledger.besu.datatypes.Wei; | ||
| import org.hyperledger.besu.ethereum.blockcreation.txselection.BlockSelectionContext; | ||
| import org.hyperledger.besu.ethereum.blockcreation.txselection.TransactionEvaluationContext; | ||
| import org.hyperledger.besu.ethereum.blockcreation.txselection.TransactionSelectionResults; | ||
| import org.hyperledger.besu.ethereum.core.Transaction; | ||
| import org.hyperledger.besu.ethereum.core.TransactionTestFixture; | ||
| import org.hyperledger.besu.ethereum.eth.transactions.PendingTransaction; | ||
| import org.hyperledger.besu.evm.gascalculator.CancunGasCalculator; | ||
| import org.hyperledger.besu.plugin.data.TransactionSelectionResult; | ||
|
|
||
| import java.util.Optional; | ||
| import java.util.stream.IntStream; | ||
|
|
||
| import com.google.common.base.Supplier; | ||
| import com.google.common.base.Suppliers; | ||
| import org.apache.tuweni.bytes.Bytes; | ||
| import org.apache.tuweni.bytes.Bytes48; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.extension.ExtendWith; | ||
| import org.mockito.Mock; | ||
| import org.mockito.junit.jupiter.MockitoExtension; | ||
|
|
||
| @ExtendWith(MockitoExtension.class) | ||
| class BlobSizeTransactionSelectorTest { | ||
| private static final Supplier<SignatureAlgorithm> SIGNATURE_ALGORITHM = | ||
| Suppliers.memoize(SignatureAlgorithmFactory::getInstance); | ||
| private static final KeyPair KEYS = SIGNATURE_ALGORITHM.get().generateKeyPair(); | ||
|
|
||
| private static final long BLOB_GAS_PER_BLOB = CancunGasCalculator.BLOB_GAS_PER_BLOB; | ||
| private static final int MAX_BLOBS = 6; | ||
| private static final long MAX_BLOB_GAS = BLOB_GAS_PER_BLOB * MAX_BLOBS; | ||
|
|
||
| @Mock(answer = RETURNS_DEEP_STUBS) | ||
| BlockSelectionContext blockSelectionContext; | ||
|
|
||
| @Mock TransactionSelectionResults selectionResults; | ||
|
|
||
| @Test | ||
| void notBlobTransactionsAreSelectedWithoutAnyCheck() { | ||
| final var selector = new BlobSizeTransactionSelector(blockSelectionContext); | ||
|
|
||
| final var nonBlobTx = createEIP1559PendingTransaction(); | ||
|
|
||
| final var txEvaluationContext = new TransactionEvaluationContext(nonBlobTx, null, null, null); | ||
|
|
||
| final var result = | ||
| selector.evaluateTransactionPreProcessing(txEvaluationContext, selectionResults); | ||
| assertThat(result).isEqualTo(TransactionSelectionResult.SELECTED); | ||
| verifyNoInteractions(selectionResults); | ||
| } | ||
|
|
||
| @Test | ||
| void firstBlobTransactionIsSelected() { | ||
| when(blockSelectionContext.gasLimitCalculator().currentBlobGasLimit()).thenReturn(MAX_BLOB_GAS); | ||
| when(blockSelectionContext.gasCalculator().blobGasCost(anyInt())) | ||
| .thenAnswer(iom -> BLOB_GAS_PER_BLOB * iom.getArgument(0, Integer.class)); | ||
|
|
||
| final var selector = new BlobSizeTransactionSelector(blockSelectionContext); | ||
|
|
||
| final var firstBlobTx = createBlobPendingTransaction(MAX_BLOBS); | ||
|
|
||
| final var txEvaluationContext = new TransactionEvaluationContext(firstBlobTx, null, null, null); | ||
|
|
||
| when(selectionResults.getCumulativeBlobGasUsed()).thenReturn(0L); | ||
|
|
||
| final var result = | ||
| selector.evaluateTransactionPreProcessing(txEvaluationContext, selectionResults); | ||
| assertThat(result).isEqualTo(TransactionSelectionResult.SELECTED); | ||
| verify(selectionResults).getCumulativeBlobGasUsed(); | ||
| } | ||
|
|
||
| @Test | ||
| void returnsBlobsFullWhenMaxNumberOfBlobsAlreadyPresent() { | ||
| when(blockSelectionContext.gasLimitCalculator().currentBlobGasLimit()).thenReturn(MAX_BLOB_GAS); | ||
|
|
||
| final var selector = new BlobSizeTransactionSelector(blockSelectionContext); | ||
|
|
||
| final var firstBlobTx = createBlobPendingTransaction(1); | ||
|
|
||
| final var txEvaluationContext = new TransactionEvaluationContext(firstBlobTx, null, null, null); | ||
|
|
||
| when(selectionResults.getCumulativeBlobGasUsed()).thenReturn(MAX_BLOB_GAS); | ||
|
|
||
| final var result = | ||
| selector.evaluateTransactionPreProcessing(txEvaluationContext, selectionResults); | ||
| assertThat(result).isEqualTo(TransactionSelectionResult.BLOBS_FULL); | ||
| verify(selectionResults).getCumulativeBlobGasUsed(); | ||
| } | ||
|
|
||
| @Test | ||
| void returnsTooLargeForRemainingBlobGas() { | ||
| when(blockSelectionContext.gasLimitCalculator().currentBlobGasLimit()).thenReturn(MAX_BLOB_GAS); | ||
| when(blockSelectionContext.gasCalculator().blobGasCost(anyInt())) | ||
| .thenAnswer(iom -> BLOB_GAS_PER_BLOB * iom.getArgument(0, Integer.class)); | ||
|
|
||
| final var selector = new BlobSizeTransactionSelector(blockSelectionContext); | ||
|
|
||
| final var firstBlobTx = createBlobPendingTransaction(MAX_BLOBS); | ||
|
|
||
| final var txEvaluationContext = new TransactionEvaluationContext(firstBlobTx, null, null, null); | ||
|
|
||
| when(selectionResults.getCumulativeBlobGasUsed()).thenReturn(MAX_BLOB_GAS - 1); | ||
|
|
||
| final var result = | ||
| selector.evaluateTransactionPreProcessing(txEvaluationContext, selectionResults); | ||
| assertThat(result).isEqualTo(TransactionSelectionResult.TX_TOO_LARGE_FOR_REMAINING_BLOB_GAS); | ||
| verify(selectionResults).getCumulativeBlobGasUsed(); | ||
| } | ||
|
|
||
| private PendingTransaction createEIP1559PendingTransaction() { | ||
| return PendingTransaction.newPendingTransaction( | ||
| createTransaction(TransactionType.EIP1559, 0), false, false); | ||
| } | ||
|
|
||
| private PendingTransaction createBlobPendingTransaction(final int blobCount) { | ||
| return PendingTransaction.newPendingTransaction( | ||
| createTransaction(TransactionType.BLOB, blobCount), false, false); | ||
| } | ||
|
|
||
| private Transaction createTransaction(final TransactionType type, final int blobCount) { | ||
|
|
||
| var tx = | ||
| new TransactionTestFixture() | ||
| .to(Optional.of(Address.fromHexString("0x634316eA0EE79c701c6F67C53A4C54cBAfd2316d"))) | ||
| .nonce(0) | ||
| .type(type); | ||
| tx.maxFeePerGas(Optional.of(Wei.of(1000))).maxPriorityFeePerGas(Optional.of(Wei.of(100))); | ||
| if (type.supportsBlob()) { | ||
| if (blobCount > 0) { | ||
| tx.maxFeePerBlobGas(Optional.of(Wei.of(10))); | ||
| final var versionHashes = | ||
| IntStream.range(0, blobCount) | ||
| .mapToObj(i -> new VersionedHash((byte) 1, Hash.ZERO)) | ||
| .toList(); | ||
| final var kgzCommitments = | ||
| IntStream.range(0, blobCount) | ||
| .mapToObj(i -> new KZGCommitment(Bytes48.random())) | ||
| .toList(); | ||
| final var kzgProofs = | ||
| IntStream.range(0, blobCount).mapToObj(i -> new KZGProof(Bytes48.random())).toList(); | ||
| final var blobs = | ||
| IntStream.range(0, blobCount).mapToObj(i -> new Blob(Bytes.random(32 * 4096))).toList(); | ||
| tx.versionedHashes(Optional.of(versionHashes)); | ||
| final var blobsWithCommitments = | ||
| new BlobsWithCommitments(kgzCommitments, blobs, kzgProofs, versionHashes); | ||
| tx.blobsWithCommitments(Optional.of(blobsWithCommitments)); | ||
| } else { | ||
| fail("At least 1 blob is required for blob tx type"); | ||
| } | ||
| } | ||
| return tx.createTransaction(KEYS); | ||
| } | ||
| } |
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
adding
blobGasUsedis incorrect here, since here we only want to check the gas used and not the data gas used