-
Notifications
You must be signed in to change notification settings - Fork 476
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
New filter restricting delegations in txpool #8022
Changes from 16 commits
1a48fd6
64c0936
e7df773
7be934f
aa2a818
edb1c21
775dda6
1f8fa39
d35ba1d
ce4cf84
2e6e13a
963bba1
a7aa58e
ee6fd89
93ecfea
5bdab60
067d504
cc6b5d7
e8fbbbc
b0ad70f
5d4ac71
3f402c3
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,161 @@ | ||
// SPDX-FileCopyrightText: 2024 Demerzel Solutions Limited | ||
// SPDX-License-Identifier: LGPL-3.0-only | ||
|
||
using Nethermind.Core; | ||
using Nethermind.Core.Specs; | ||
using Nethermind.Core.Test.Builders; | ||
using Nethermind.Crypto; | ||
using Nethermind.Db; | ||
using Nethermind.Evm; | ||
using Nethermind.Logging; | ||
using Nethermind.Specs.Forks; | ||
using Nethermind.State; | ||
using Nethermind.Trie.Pruning; | ||
using Nethermind.TxPool.Collections; | ||
using Nethermind.TxPool.Filters; | ||
using NSubstitute; | ||
using NUnit.Framework; | ||
using Org.BouncyCastle.Pqc.Crypto.Lms; | ||
using System; | ||
using System.Collections; | ||
using System.Collections.Generic; | ||
using System.Linq; | ||
using System.Text; | ||
using System.Threading.Tasks; | ||
|
||
namespace Nethermind.TxPool.Test; | ||
internal class OnlyOneTxPerDelegatedAccountFilterTest | ||
{ | ||
[Test] | ||
public void Accept_SenderIsNotDelegated_ReturnsAccepted() | ||
{ | ||
IChainHeadSpecProvider headInfoProvider = Substitute.For<IChainHeadSpecProvider>(); | ||
headInfoProvider.GetCurrentHeadSpec().Returns(Prague.Instance); | ||
TxDistinctSortedPool standardPool = new TxDistinctSortedPool(MemoryAllowance.MemPoolSize, Substitute.For<IComparer<Transaction>>(), NullLogManager.Instance); | ||
TxDistinctSortedPool blobPool = new BlobTxDistinctSortedPool(10, Substitute.For<IComparer<Transaction>>(), NullLogManager.Instance); | ||
OnlyOneTxPerDelegatedAccountFilter filter = new(headInfoProvider, standardPool, blobPool, Substitute.For<IReadOnlyStateProvider>(), new CodeInfoRepository(), new DelegationCache()); | ||
Transaction transaction = Build.A.Transaction.SignedAndResolved(new EthereumEcdsa(0), TestItem.PrivateKeyA).TestObject; | ||
TxFilteringState state = new(); | ||
|
||
AcceptTxResult result = filter.Accept(transaction, ref state, TxHandlingOptions.None); | ||
|
||
Assert.That(result, Is.EqualTo(AcceptTxResult.Accepted)); | ||
} | ||
|
||
[Test] | ||
public void Accept_SenderIsDelegatedWithNoTransactionsInPool_ReturnsAccepted() | ||
{ | ||
IChainHeadSpecProvider headInfoProvider = Substitute.For<IChainHeadSpecProvider>(); | ||
headInfoProvider.GetCurrentHeadSpec().Returns(Prague.Instance); | ||
TxDistinctSortedPool standardPool = new TxDistinctSortedPool(MemoryAllowance.MemPoolSize, Substitute.For<IComparer<Transaction>>(), NullLogManager.Instance); | ||
TxDistinctSortedPool blobPool = new BlobTxDistinctSortedPool(10, Substitute.For<IComparer<Transaction>>(), NullLogManager.Instance); | ||
OnlyOneTxPerDelegatedAccountFilter filter = new(headInfoProvider, standardPool, blobPool, Substitute.For<IReadOnlyStateProvider>(), new CodeInfoRepository(), new DelegationCache()); | ||
Transaction transaction = Build.A.Transaction.SignedAndResolved(new EthereumEcdsa(0), TestItem.PrivateKeyA).TestObject; | ||
TxFilteringState state = new(); | ||
|
||
AcceptTxResult result = filter.Accept(transaction, ref state, TxHandlingOptions.None); | ||
|
||
Assert.That(result, Is.EqualTo(AcceptTxResult.Accepted)); | ||
ak88 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
|
||
[Test] | ||
public void Accept_SenderIsDelegatedWithOneTransactionInPoolWithSameNonce_ReturnsAccepted() | ||
{ | ||
IChainHeadSpecProvider headInfoProvider = Substitute.For<IChainHeadSpecProvider>(); | ||
headInfoProvider.GetCurrentHeadSpec().Returns(Prague.Instance); | ||
TxDistinctSortedPool standardPool = new TxDistinctSortedPool(MemoryAllowance.MemPoolSize, Substitute.For<IComparer<Transaction>>(), NullLogManager.Instance); | ||
TxDistinctSortedPool blobPool = new BlobTxDistinctSortedPool(10, Substitute.For<IComparer<Transaction>>(), NullLogManager.Instance); | ||
Transaction inPool = Build.A.Transaction.SignedAndResolved(new EthereumEcdsa(0), TestItem.PrivateKeyA).TestObject; | ||
standardPool.TryInsert(inPool.Hash, inPool); | ||
IDb stateDb = new MemDb(); | ||
IDb codeDb = new MemDb(); | ||
TrieStore trieStore = new(stateDb, LimboLogs.Instance); | ||
IWorldState stateProvider = new WorldState(trieStore, codeDb, LimboLogs.Instance); | ||
stateProvider.CreateAccount(TestItem.AddressA, 0); | ||
CodeInfoRepository codeInfoRepository = new(); | ||
byte[] code = [.. Eip7702Constants.DelegationHeader, .. TestItem.PrivateKeyA.Address.Bytes]; | ||
codeInfoRepository.InsertCode(stateProvider, code, TestItem.AddressA, Prague.Instance); | ||
OnlyOneTxPerDelegatedAccountFilter filter = new(headInfoProvider, standardPool, blobPool, stateProvider, codeInfoRepository, new DelegationCache()); | ||
Transaction transaction = Build.A.Transaction.SignedAndResolved(new EthereumEcdsa(0), TestItem.PrivateKeyA).TestObject; | ||
TxFilteringState state = new(); | ||
|
||
AcceptTxResult result = filter.Accept(transaction, ref state, TxHandlingOptions.None); | ||
|
||
Assert.That(result, Is.EqualTo(AcceptTxResult.Accepted)); | ||
} | ||
|
||
[Test] | ||
public void Accept_SenderIsDelegatedWithOneTransactionInPoolWithDifferentNonce_ReturnsOnlyOneTxPerDelegatedAccount() | ||
{ | ||
IChainHeadSpecProvider headInfoProvider = Substitute.For<IChainHeadSpecProvider>(); | ||
headInfoProvider.GetCurrentHeadSpec().Returns(Prague.Instance); | ||
TxDistinctSortedPool standardPool = new TxDistinctSortedPool(MemoryAllowance.MemPoolSize, Substitute.For<IComparer<Transaction>>(), NullLogManager.Instance); | ||
TxDistinctSortedPool blobPool = new BlobTxDistinctSortedPool(10, Substitute.For<IComparer<Transaction>>(), NullLogManager.Instance); | ||
Transaction inPool = Build.A.Transaction.SignedAndResolved(new EthereumEcdsa(0), TestItem.PrivateKeyA).TestObject; | ||
standardPool.TryInsert(inPool.Hash, inPool); | ||
IDb stateDb = new MemDb(); | ||
IDb codeDb = new MemDb(); | ||
TrieStore trieStore = new(stateDb, LimboLogs.Instance); | ||
IWorldState stateProvider = new WorldState(trieStore, codeDb, LimboLogs.Instance); | ||
stateProvider.CreateAccount(TestItem.AddressA, 0); | ||
CodeInfoRepository codeInfoRepository = new(); | ||
byte[] code = [.. Eip7702Constants.DelegationHeader, .. TestItem.PrivateKeyA.Address.Bytes]; | ||
codeInfoRepository.InsertCode(stateProvider, code, TestItem.AddressA, Prague.Instance); | ||
OnlyOneTxPerDelegatedAccountFilter filter = new(headInfoProvider, standardPool, blobPool, stateProvider, codeInfoRepository, new DelegationCache()); | ||
Transaction transaction = Build.A.Transaction.WithNonce(1).SignedAndResolved(new EthereumEcdsa(0), TestItem.PrivateKeyA).TestObject; | ||
TxFilteringState state = new(); | ||
|
||
AcceptTxResult result = filter.Accept(transaction, ref state, TxHandlingOptions.None); | ||
|
||
Assert.That(result, Is.EqualTo(AcceptTxResult.OnlyOneTxPerDelegatedAccount)); | ||
} | ||
|
||
private static object[] EipActiveCases = | ||
{ | ||
new object[]{ true, AcceptTxResult.OnlyOneTxPerDelegatedAccount }, | ||
new object[]{ false, AcceptTxResult.Accepted}, | ||
}; | ||
[TestCaseSource(nameof(EipActiveCases))] | ||
public void Accept_Eip7702IsNotActivated_ReturnsExpected(bool isActive, AcceptTxResult expected) | ||
{ | ||
IChainHeadSpecProvider headInfoProvider = Substitute.For<IChainHeadSpecProvider>(); | ||
headInfoProvider.GetCurrentHeadSpec().Returns(isActive ? Prague.Instance : Cancun.Instance); | ||
TxDistinctSortedPool standardPool = new TxDistinctSortedPool(MemoryAllowance.MemPoolSize, Substitute.For<IComparer<Transaction>>(), NullLogManager.Instance); | ||
TxDistinctSortedPool blobPool = new BlobTxDistinctSortedPool(10, Substitute.For<IComparer<Transaction>>(), NullLogManager.Instance); | ||
Transaction inPool = Build.A.Transaction.SignedAndResolved(new EthereumEcdsa(0), TestItem.PrivateKeyA).TestObject; | ||
standardPool.TryInsert(inPool.Hash, inPool); | ||
IDb stateDb = new MemDb(); | ||
IDb codeDb = new MemDb(); | ||
TrieStore trieStore = new(stateDb, LimboLogs.Instance); | ||
IWorldState stateProvider = new WorldState(trieStore, codeDb, LimboLogs.Instance); | ||
stateProvider.CreateAccount(TestItem.AddressA, 0); | ||
CodeInfoRepository codeInfoRepository = new(); | ||
byte[] code = [.. Eip7702Constants.DelegationHeader, .. TestItem.PrivateKeyA.Address.Bytes]; | ||
codeInfoRepository.InsertCode(stateProvider, code, TestItem.AddressA, Prague.Instance); | ||
OnlyOneTxPerDelegatedAccountFilter filter = new(headInfoProvider, standardPool, blobPool, stateProvider, codeInfoRepository, new DelegationCache()); | ||
Transaction transaction = Build.A.Transaction.WithNonce(1).SignedAndResolved(new EthereumEcdsa(0), TestItem.PrivateKeyA).TestObject; | ||
TxFilteringState state = new(); | ||
|
||
AcceptTxResult result = filter.Accept(transaction, ref state, TxHandlingOptions.None); | ||
|
||
Assert.That(result, Is.EqualTo(expected)); | ||
} | ||
|
||
[Test] | ||
public void Accept_SenderHasPendingDelegation_ReturnsPendingDelegation() | ||
{ | ||
IChainHeadSpecProvider headInfoProvider = Substitute.For<IChainHeadSpecProvider>(); | ||
headInfoProvider.GetCurrentHeadSpec().Returns(Prague.Instance); | ||
TxDistinctSortedPool standardPool = new TxDistinctSortedPool(MemoryAllowance.MemPoolSize, Substitute.For<IComparer<Transaction>>(), NullLogManager.Instance); | ||
TxDistinctSortedPool blobPool = new BlobTxDistinctSortedPool(10, Substitute.For<IComparer<Transaction>>(), NullLogManager.Instance); | ||
DelegationCache pendingDelegations = new(); | ||
pendingDelegations.IncrementDelegationCount(TestItem.AddressA, 0); | ||
OnlyOneTxPerDelegatedAccountFilter filter = new(headInfoProvider, standardPool, blobPool, Substitute.For<IReadOnlyStateProvider>(), new CodeInfoRepository(), pendingDelegations); | ||
Transaction transaction = Build.A.Transaction.WithNonce(0).SignedAndResolved(new EthereumEcdsa(0), TestItem.PrivateKeyA).TestObject; | ||
TxFilteringState state = new(); | ||
|
||
AcceptTxResult result = filter.Accept(transaction, ref state, TxHandlingOptions.None); | ||
|
||
Assert.That(result, Is.EqualTo(AcceptTxResult.PendingDelegation)); | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
// SPDX-FileCopyrightText: 2024 Demerzel Solutions Limited | ||
// SPDX-License-Identifier: LGPL-3.0-only | ||
|
||
using Nethermind.Core; | ||
using Nethermind.Int256; | ||
using System; | ||
using System.Collections.Concurrent; | ||
using System.Collections.Generic; | ||
using System.Linq; | ||
using System.Text; | ||
using System.Threading.Tasks; | ||
|
||
namespace Nethermind.TxPool; | ||
internal sealed class DelegationCache | ||
{ | ||
private readonly ConcurrentDictionary<UInt256, int> _pendingDelegations = new(); | ||
|
||
public bool HasPending(AddressAsKey key, UInt256 nonce) | ||
{ | ||
return _pendingDelegations.ContainsKey(KeyMask(key, nonce)); | ||
} | ||
|
||
public void DecrementDelegationCount(AddressAsKey key, UInt256 nonce) | ||
{ | ||
InternalIncrement(key, nonce, false); | ||
} | ||
public void IncrementDelegationCount(AddressAsKey key, UInt256 nonce) | ||
{ | ||
InternalIncrement(key, nonce, true); | ||
} | ||
|
||
private void InternalIncrement(AddressAsKey key, UInt256 nonce, bool increment) | ||
{ | ||
UInt256 addressPlusNonce = KeyMask(key, nonce); | ||
|
||
int value = increment ? 1 : -1; | ||
var lastCount = _pendingDelegations.AddOrUpdate(addressPlusNonce, | ||
(k) => | ||
{ | ||
if (increment) | ||
return 1; | ||
return 0; | ||
}, | ||
(k, c) => c + value); | ||
|
||
if (lastCount == 0) | ||
{ | ||
//Remove() is threadsafe and only removes if the count is the same as the updated one | ||
((ICollection<KeyValuePair<UInt256, int>>)_pendingDelegations).Remove( | ||
new KeyValuePair<UInt256, int>(addressPlusNonce, lastCount)); | ||
} | ||
} | ||
|
||
private static UInt256 KeyMask(AddressAsKey key, UInt256 nonce) | ||
{ | ||
//A nonce cannot exceed 2^64-1 and an address is 20 bytes, so we can pack them together in one u256 | ||
UInt256 addressPlusNonce = new(key.Value.Bytes); | ||
nonce <<= 64 * 3; | ||
addressPlusNonce += nonce; | ||
return addressPlusNonce; | ||
ak88 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
using Nethermind.Core; | ||
using Nethermind.Core.Specs; | ||
using Nethermind.Evm; | ||
using Nethermind.Int256; | ||
using Nethermind.State; | ||
using Nethermind.TxPool.Collections; | ||
using System.Collections.Concurrent; | ||
|
||
namespace Nethermind.TxPool.Filters | ||
{ | ||
internal sealed class OnlyOneTxPerDelegatedAccountFilter( | ||
IChainHeadSpecProvider specProvider, | ||
TxDistinctSortedPool standardPool, | ||
TxDistinctSortedPool blobPool, | ||
IReadOnlyStateProvider worldState, | ||
ICodeInfoRepository codeInfoRepository, | ||
DelegationCache pendingDelegations) : IIncomingTxFilter | ||
{ | ||
public AcceptTxResult Accept(Transaction tx, ref TxFilteringState state, TxHandlingOptions txHandlingOptions) | ||
{ | ||
IReleaseSpec spec = specProvider.GetCurrentHeadSpec(); | ||
if (!spec.IsEip7702Enabled) | ||
return AcceptTxResult.Accepted; | ||
|
||
if (pendingDelegations.HasPending(tx.SenderAddress!, tx.Nonce)) | ||
return AcceptTxResult.PendingDelegation; | ||
|
||
if (!codeInfoRepository.TryGetDelegation(worldState, tx.SenderAddress!, out _)) | ||
return AcceptTxResult.Accepted; | ||
Transaction[] currentTxs; | ||
|
||
//Transactios from the same source can only be either blob transactions or some other type | ||
if (standardPool.TryGetBucket(tx.SenderAddress!, out currentTxs) || blobPool.TryGetBucket(tx.SenderAddress!, out currentTxs)) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Alternatively returning a pooled array instead? Keeping the lock while searching inside the bucket, could have other side effects. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should keep the lock if changing the txs in the bucket? What if another tx came in from same sender doing same thing? Why is it or? If there are regular txs does it not matter if are blob txs? And do the blob txs only matter if not regular ones? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Though probably lock at bucket level rather than whole pool There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fair; add comment for 2. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do you have any suggestions for Lukasz comment? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The search below is very fast. I would rather have this search under the lock as I think it won't be much slower than allocating an array? |
||
{ | ||
foreach (Transaction existingTx in currentTxs) | ||
{ | ||
if (existingTx.Nonce == tx.Nonce) | ||
{ | ||
//This is a replacement tx so accept it, and let the comparers check for correct replacement rules | ||
return AcceptTxResult.Accepted; | ||
} | ||
} | ||
return AcceptTxResult.OnlyOneTxPerDelegatedAccount; | ||
} | ||
return AcceptTxResult.Accepted; | ||
} | ||
} | ||
} |
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.
We are setting up a filter in every test, repeating the same lines of code. Maybe worth to move it to method e.g.
CreateFilter(stateProvider)
, which is returningOnlyOneTxPerDelegatedAccountFilter filter
?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.
Or even move state provider setup into it and return (filter, stateProvider?)?
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.
But it's just details about code repeating in test class, feel free to ignore and focus on more important things