public BlockProducerEnvFactory(
IDbProvider dbProvider,
IBlockTree blockTree,
IReadOnlyTrieStore readOnlyTrieStore,
ISpecProvider specProvider,
IBlockValidator blockValidator,
IRewardCalculatorSource rewardCalculatorSource,
IReceiptStorage receiptStorage,
IBlockPreprocessorStep blockPreprocessorStep,
ITxPool txPool,
ITransactionComparerProvider transactionComparerProvider,
IMiningConfig miningConfig,
ILogManager logManager)
{
_dbProvider = dbProvider;
_blockTree = blockTree;
_readOnlyTrieStore = readOnlyTrieStore;
_specProvider = specProvider;
_blockValidator = blockValidator;
_rewardCalculatorSource = rewardCalculatorSource;
_receiptStorage = receiptStorage;
_blockPreprocessorStep = blockPreprocessorStep;
_txPool = txPool;
_transactionComparerProvider = transactionComparerProvider;
_miningConfig = miningConfig;
_logManager = logManager;
TransactionsExecutorFactory = new BlockProducerTransactionsExecutorFactory(specProvider, logManager);
}
public TxPoolTxSource(ITxPool?transactionPool, IStateReader?stateReader, ISpecProvider?specProvider, ITransactionComparerProvider transactionComparerProvider, ILogManager?logManager, ITxFilterPipeline?txFilterPipeline)
{
_transactionPool = transactionPool ?? throw new ArgumentNullException(nameof(transactionPool));
_stateReader = stateReader ?? throw new ArgumentNullException(nameof(stateReader));
_transactionComparerProvider = transactionComparerProvider ?? throw new ArgumentNullException(nameof(transactionComparerProvider));
_txFilterPipeline = txFilterPipeline ?? throw new ArgumentNullException(nameof(txFilterPipeline));
_specProvider = specProvider ?? throw new ArgumentNullException(nameof(specProvider));
_logger = logManager?.GetClassLogger <TxPoolTxSource>() ?? throw new ArgumentNullException(nameof(logManager));
}
public TestingContext(bool isEip1559Enabled = false, long eip1559TransitionBlock = 0)
{
ReleaseSpec releaseSpec = new();
ReleaseSpec eip1559ReleaseSpec = new() { IsEip1559Enabled = isEip1559Enabled, Eip1559TransitionBlock = eip1559TransitionBlock };
ISpecProvider specProvider = Substitute.For <ISpecProvider>();
specProvider.GetSpec(Arg.Is <long>(x => x >= eip1559TransitionBlock)).Returns(eip1559ReleaseSpec);
specProvider.GetSpec(Arg.Is <long>(x => x < eip1559TransitionBlock)).Returns(releaseSpec);
_blockTree = Substitute.For <IBlockTree>();
UpdateBlockTreeHead();
_transactionComparerProvider =
new TransactionComparerProvider(specProvider, _blockTree);
}
public TxPriorityTxSource(
ITxPool transactionPool,
IStateReader stateReader,
ILogManager logManager,
ITxFilterPipeline txFilterPipeline,
IContractDataStore <Address> sendersWhitelist, // expected HashSet based
IDictionaryContractDataStore <TxPriorityContract.Destination> priorities,
ISpecProvider specProvider,
ITransactionComparerProvider transactionComparerProvider) // expected SortedList based
: base(transactionPool, specProvider, transactionComparerProvider, logManager, txFilterPipeline)
{
_sendersWhitelist = sendersWhitelist ?? throw new ArgumentNullException(nameof(sendersWhitelist));
_priorities = priorities ?? throw new ArgumentNullException(nameof(priorities));
}
protected override IBlockProducer CreateTestBlockProducer(TxPoolTxSource txPoolTxSource, ISealer sealer,
ITransactionComparerProvider transactionComparerProvider)
{
MiningConfig miningConfig = new() { MinGasPrice = UInt256.One };
SpecProvider.UpdateMergeTransitionInfo(1, 0);
BlockProducerEnvFactory blockProducerEnvFactory = new BlockProducerEnvFactory(
DbProvider,
BlockTree,
ReadOnlyTrieStore,
SpecProvider,
BlockValidator,
NoBlockRewards.Instance,
ReceiptStorage,
BlockPreprocessorStep,
TxPool,
transactionComparerProvider,
miningConfig,
LogManager)
{
TransactionsExecutorFactory =
new AABlockProducerTransactionsExecutorFactory(
SpecProvider,
LogManager,
Signer,
EntryPointAddresses)
};
UserOperationTxSource = new(UserOperationTxBuilder, UserOperationPool, UserOperationSimulator, SpecProvider, State, Signer, LogManager.GetClassLogger());
PostMergeBlockProducer CreatePostMergeBlockProducer(IBlockProductionTrigger blockProductionTrigger,
ITxSource?txSource = null)
{
var blockProducerEnv = blockProducerEnvFactory.Create(txSource);
return(new PostMergeBlockProducerFactory(SpecProvider, SealEngine, Timestamper, miningConfig,
LogManager, GasLimitCalculator).Create(
blockProducerEnv, blockProductionTrigger));
}
IBlockProducer blockProducer =
CreatePostMergeBlockProducer(BlockProductionTrigger, UserOperationTxSource);
blockProducer.BlockProduced += OnBlockProduced;
return(blockProducer);
}
public void Setup()
{
CollectAndFinalize();
_finalizedCount = 0;
_allCount = 0;
ISpecProvider specProvider = Substitute.For <ISpecProvider>();
IBlockTree blockTree = Substitute.For <IBlockTree>();
Block block = Build.A.Block.WithNumber(0).TestObject;
blockTree.Head.Returns(block);
specProvider.GetSpec(Arg.Any <long>()).Returns(new ReleaseSpec()
{
IsEip1559Enabled = false
});
_transactionComparerProvider = new TransactionComparerProvider(specProvider, blockTree);
}
protected override IBlockProducer CreateTestBlockProducer(TxPoolTxSource txPoolTxSource, ISealer sealer, ITransactionComparerProvider transactionComparerProvider)
{
MiningConfig miningConfig = new() { MinGasPrice = UInt256.One };
BlockProducerEnvFactory blockProducerEnvFactory = new BlockProducerEnvFactory(
DbProvider,
BlockTree,
ReadOnlyTrieStore,
SpecProvider,
BlockValidator,
NoBlockRewards.Instance,
ReceiptStorage,
BlockPreprocessorStep,
TxPool,
transactionComparerProvider,
miningConfig,
LogManager)
{
TransactionsExecutorFactory =
new AABlockProducerTransactionsExecutorFactory(
SpecProvider,
LogManager,
Signer,
EntryPointAddresses)
};
UserOperationTxSource = new(UserOperationTxBuilder, UserOperationPool, UserOperationSimulator, SpecProvider, State, Signer, LogManager.GetClassLogger());
Eth2TestBlockProducerFactory producerFactory = new Eth2TestBlockProducerFactory(GasLimitCalculator, UserOperationTxSource);
Eth2BlockProducer blockProducer = producerFactory.Create(
blockProducerEnvFactory,
BlockTree,
BlockProductionTrigger,
SpecProvider,
new Eth2Signer(MinerAddress),
Timestamper,
miningConfig,
LogManager);
return(blockProducer);
}
protected override IBlockProducer CreateTestBlockProducer(TxPoolTxSource txPoolTxSource, ISealer sealer,
ITransactionComparerProvider transactionComparerProvider)
{
MiningConfig miningConfig = new() { MinGasPrice = UInt256.One };
SpecProvider.UpdateMergeTransitionInfo(1, 0);
BlockProducerEnvFactory blockProducerEnvFactory = new(
DbProvider,
BlockTree,
ReadOnlyTrieStore,
SpecProvider,
BlockValidator,
NoBlockRewards.Instance,
ReceiptStorage,
BlockPreprocessorStep,
TxPool,
transactionComparerProvider,
miningConfig,
LogManager)
{
TransactionsExecutorFactory =
new MevBlockProducerTransactionsExecutorFactory(SpecProvider, LogManager)
};
PostMergeBlockProducer CreatePostMergeBlockProducer(IBlockProductionTrigger blockProductionTrigger,
ITxSource?txSource = null)
{
BlockProducerEnv blockProducerEnv = blockProducerEnvFactory.Create(txSource);
return(new PostMergeBlockProducerFactory(SpecProvider, SealEngine, Timestamper, miningConfig,
LogManager).Create(
blockProducerEnv, blockProductionTrigger, txSource));
}
MevBlockProducer.MevBlockProducerInfo CreateProducer(int bundleLimit = 0,
ITxSource?additionalTxSource = null)
{
// TODO: this could be simplified a lot of the parent was not retrieved, not sure why do we need the parent here
bool BundleLimitTriggerCondition(BlockProductionEventArgs e)
{
// TODO: why do we need this parent? later we use only the current block number
BlockHeader?parent = BlockTree.GetProducedBlockParent(e.ParentHeader);
if (parent is not null)
{
// ToDo resolved conflict parent.Timestamp?
IEnumerable <MevBundle> bundles = BundlePool.GetBundles(parent.Number + 1, parent.Timestamp);
return(bundles.Count() >= bundleLimit);
}
return(false);
}
IManualBlockProductionTrigger manualTrigger = new BuildBlocksWhenRequested();
IBlockProductionTrigger trigger = manualTrigger;
if (bundleLimit != 0)
{
trigger = new TriggerWithCondition(manualTrigger, BundleLimitTriggerCondition);
}
IBlockProducer producer = CreatePostMergeBlockProducer(trigger, additionalTxSource);
return(new MevBlockProducer.MevBlockProducerInfo(producer, manualTrigger, new BeneficiaryTracer()));
}
int megabundleProducerCount = _relayAddresses.Any() ? 1 : 0;
List <MevBlockProducer.MevBlockProducerInfo> blockProducers =
new(_maxMergedBundles + megabundleProducerCount + 1);
// Add non-mev block
MevBlockProducer.MevBlockProducerInfo standardProducer = CreateProducer();
blockProducers.Add(standardProducer);
// Try blocks with all bundle numbers <= maxMergedBundles
for (int bundleLimit = 1; bundleLimit <= _maxMergedBundles; bundleLimit++)
{
BundleSelector bundleSelector = new(BundlePool, bundleLimit);
BundleTxSource bundleTxSource = new(bundleSelector, Timestamper);
MevBlockProducer.MevBlockProducerInfo bundleProducer = CreateProducer(bundleLimit, bundleTxSource);
blockProducers.Add(bundleProducer);
}
if (megabundleProducerCount > 0)
{
MegabundleSelector megabundleSelector = new(BundlePool);
BundleTxSource megabundleTxSource = new(megabundleSelector, Timestamper);
MevBlockProducer.MevBlockProducerInfo bundleProducer = CreateProducer(0, megabundleTxSource);
blockProducers.Add(bundleProducer);
}
MevBlockProducer blockProducer = new MevBlockProducer(BlockProductionTrigger, LogManager, blockProducers.ToArray());
blockProducer.BlockProduced += OnBlockProduced;
return(blockProducer);
}
protected override IBlockProducer CreateTestBlockProducer(TxPoolTxSource txPoolTxSource, ISealer sealer, ITransactionComparerProvider transactionComparerProvider)
{
SealEngine = new MergeSealEngine(SealEngine, PoSSwitcher, SealValidator, LogManager);
MiningConfig miningConfig = new() { Enabled = true, MinGasPrice = 0 };
TargetAdjustedGasLimitCalculator targetAdjustedGasLimitCalculator = new(SpecProvider, miningConfig);
EthSyncingInfo = new EthSyncingInfo(BlockTree);
PostMergeBlockProducerFactory blockProducerFactory = new(
SpecProvider,
SealEngine,
Timestamper,
miningConfig,
LogManager,
targetAdjustedGasLimitCalculator);
BlockProducerEnvFactory blockProducerEnvFactory = new(
DbProvider,
BlockTree,
ReadOnlyTrieStore,
SpecProvider,
BlockValidator,
NoBlockRewards.Instance,
ReceiptStorage,
BlockPreprocessorStep,
TxPool,
transactionComparerProvider,
miningConfig,
LogManager);
BlockProducerEnv blockProducerEnv = blockProducerEnvFactory.Create();
PostMergeBlockProducer postMergeBlockProducer = blockProducerFactory.Create(blockProducerEnv, BlockProductionTrigger);
PostMergeBlockProducer = postMergeBlockProducer;
PayloadPreparationService ??= new PayloadPreparationService(
postMergeBlockProducer,
new BlockImprovementContextFactory(BlockProductionTrigger, TimeSpan.FromSeconds(MergeConfig.SecondsPerSlot)
),
TimerFactory.Default,
LogManager,
TimeSpan.FromSeconds(MergeConfig.SecondsPerSlot)
);
IAuRaStepCalculator auraStepCalculator = Substitute.For <IAuRaStepCalculator>();
auraStepCalculator.TimeToNextStep.Returns(TimeSpan.FromMilliseconds(0));
FollowOtherMiners gasLimitCalculator = new(MainnetSpecProvider.Instance);
AuRaBlockProducer preMergeBlockProducer = new(
txPoolTxSource,
blockProducerEnvFactory.Create().ChainProcessor,
((TestBlockchain)this).BlockProductionTrigger,
State,
sealer,
BlockTree,
Timestamper,
auraStepCalculator,
NullReportingValidator.Instance,
new AuRaConfig(),
gasLimitCalculator,
SpecProvider,
LogManager
);
return(new MergeBlockProducer(preMergeBlockProducer, postMergeBlockProducer, PoSSwitcher));
}
}
public Task <IBlockProducer> InitBlockProducer(IBlockProductionTrigger?blockProductionTrigger = null, ITxSource?additionalTxSource = null)
{
if (_nethermindApi !.SealEngineType != Nethermind.Core.SealEngineType.Clique)
{
return(Task.FromResult((IBlockProducer)null));
}
(IApiWithBlockchain getFromApi, IApiWithBlockchain setInApi) = _nethermindApi !.ForProducer;
_miningConfig = getFromApi.Config <IMiningConfig>();
if (!_miningConfig.Enabled)
{
throw new InvalidOperationException("Request to start block producer while mining disabled.");
}
setInApi.Sealer = new CliqueSealer(
getFromApi.EngineSigner !,
_cliqueConfig !,
_snapshotManager !,
getFromApi.LogManager);
ReadOnlyDbProvider readOnlyDbProvider = getFromApi.DbProvider !.AsReadOnly(false);
ReadOnlyBlockTree readOnlyBlockTree = getFromApi.BlockTree !.AsReadOnly();
ITransactionComparerProvider transactionComparerProvider = getFromApi.TransactionComparerProvider;
ReadOnlyTxProcessingEnv producerEnv = new (
readOnlyDbProvider,
getFromApi.ReadOnlyTrieStore,
readOnlyBlockTree,
getFromApi.SpecProvider,
getFromApi.LogManager);
BlockProcessor producerProcessor = new (
getFromApi !.SpecProvider,
getFromApi !.BlockValidator,
NoBlockRewards.Instance,
getFromApi.BlockProducerEnvFactory.TransactionsExecutorFactory.Create(producerEnv),
producerEnv.StateProvider,
producerEnv.StorageProvider, // do not remove transactions from the pool when preprocessing
NullReceiptStorage.Instance,
NullWitnessCollector.Instance,
getFromApi.LogManager);
IBlockchainProcessor producerChainProcessor = new BlockchainProcessor(
readOnlyBlockTree,
producerProcessor,
getFromApi.BlockPreprocessor,
getFromApi.StateReader,
getFromApi.LogManager,
BlockchainProcessor.Options.NoReceipts);
OneTimeChainProcessor chainProcessor = new (
readOnlyDbProvider,
producerChainProcessor);
ITxFilterPipeline txFilterPipeline =
TxFilterPipelineBuilder.CreateStandardFilteringPipeline(
_nethermindApi.LogManager,
getFromApi.SpecProvider,
_miningConfig);
TxPoolTxSource txPoolTxSource = new(
getFromApi.TxPool,
getFromApi.SpecProvider,
transactionComparerProvider,
getFromApi.LogManager,
txFilterPipeline);
IGasLimitCalculator gasLimitCalculator = setInApi.GasLimitCalculator = new TargetAdjustedGasLimitCalculator(getFromApi.SpecProvider, _miningConfig);
IBlockProducer blockProducer = new CliqueBlockProducer(
additionalTxSource.Then(txPoolTxSource),
chainProcessor,
producerEnv.StateProvider,
getFromApi.BlockTree !,
getFromApi.Timestamper,
getFromApi.CryptoRandom,
_snapshotManager !,
getFromApi.Sealer !,
gasLimitCalculator,
getFromApi.SpecProvider,
_cliqueConfig !,
getFromApi.LogManager);
return(Task.FromResult(blockProducer));
}
protected override IBlockProducer CreateTestBlockProducer(TxPoolTxSource txPoolTxSource, ISealer sealer, ITransactionComparerProvider transactionComparerProvider)
{
MiningConfig miningConfig = new();
TargetAdjustedGasLimitCalculator targetAdjustedGasLimitCalculator = new(SpecProvider, miningConfig);
BlockProducerEnvFactory blockProducerEnvFactory = new(
DbProvider,
BlockTree,
ReadOnlyTrieStore,
SpecProvider,
BlockValidator,
NoBlockRewards.Instance,
ReceiptStorage,
BlockPreprocessorStep,
TxPool,
transactionComparerProvider,
miningConfig,
LogManager);
return(new Eth2TestBlockProducerFactory(targetAdjustedGasLimitCalculator).Create(
blockProducerEnvFactory,
BlockTree,
BlockProductionTrigger,
SpecProvider,
Signer,
Timestamper,
miningConfig,
LogManager));
}
protected override IBlockProducer CreateTestBlockProducer(TxPoolTxSource txPoolTxSource, ISealer sealer, ITransactionComparerProvider transactionComparerProvider)
{
MiningConfig miningConfig = new() { MinGasPrice = UInt256.One };
BlockProducerEnvFactory blockProducerEnvFactory = new(
DbProvider,
BlockTree,
ReadOnlyTrieStore,
SpecProvider,
BlockValidator,
NoBlockRewards.Instance,
ReceiptStorage,
BlockPreprocessorStep,
TxPool,
transactionComparerProvider,
miningConfig,
LogManager)
{
TransactionsExecutorFactory = new MevBlockProducerTransactionsExecutorFactory(SpecProvider, LogManager)
};
Eth2BlockProducer CreateEth2BlockProducer(IBlockProductionTrigger blockProductionTrigger, ITxSource?txSource = null) =>
new Eth2TestBlockProducerFactory(GasLimitCalculator, txSource).Create(
blockProducerEnvFactory,
BlockTree,
blockProductionTrigger,
SpecProvider,
Signer,
Timestamper,
miningConfig,
LogManager);
MevBlockProducer.MevBlockProducerInfo CreateProducer(int bundleLimit = 0, ITxSource?additionalTxSource = null)
{
bool BundleLimitTriggerCondition(BlockProductionEventArgs e)
{
BlockHeader?parent = BlockTree.GetProducedBlockParent(e.ParentHeader);
if (parent is not null)
{
IEnumerable <MevBundle> bundles = BundlePool.GetBundles(parent, Timestamper);
return(bundles.Count() >= bundleLimit);
}
return(false);
}
IManualBlockProductionTrigger manualTrigger = new BuildBlocksWhenRequested();
IBlockProductionTrigger trigger = manualTrigger;
if (bundleLimit != 0)
{
trigger = new TriggerWithCondition(manualTrigger, BundleLimitTriggerCondition);
}
IBlockProducer producer = CreateEth2BlockProducer(trigger, additionalTxSource);
return(new MevBlockProducer.MevBlockProducerInfo(producer, manualTrigger, new BeneficiaryTracer()));
}
int megabundleProducerCount = _relayAddresses.Any() ? 1 : 0;
List <MevBlockProducer.MevBlockProducerInfo> blockProducers =
new(_maxMergedBundles + megabundleProducerCount + 1);
// Add non-mev block
MevBlockProducer.MevBlockProducerInfo standardProducer = CreateProducer();
blockProducers.Add(standardProducer);
// Try blocks with all bundle numbers <= maxMergedBundles
for (int bundleLimit = 1; bundleLimit <= _maxMergedBundles; bundleLimit++)
{
BundleSelector bundleSelector = new(BundlePool, bundleLimit);
BundleTxSource bundleTxSource = new(bundleSelector, Timestamper);
MevBlockProducer.MevBlockProducerInfo bundleProducer = CreateProducer(bundleLimit, bundleTxSource);
blockProducers.Add(bundleProducer);
}
if (megabundleProducerCount > 0)
{
MegabundleSelector megabundleSelector = new(BundlePool);
BundleTxSource megabundleTxSource = new(megabundleSelector, Timestamper);
MevBlockProducer.MevBlockProducerInfo bundleProducer = CreateProducer(0, megabundleTxSource);
blockProducers.Add(bundleProducer);
}
return(new MevBlockProducer(BlockProductionTrigger, LogManager, blockProducers.ToArray()));
}
protected override IBlockProducer CreateTestBlockProducer(TxPoolTxSource txPoolTxSource, ISealer sealer, ITransactionComparerProvider transactionComparerProvider)
{
SealEngine = new MergeSealEngine(SealEngine, PoSSwitcher, SealValidator, LogManager);
IBlockProducer preMergeBlockProducer =
base.CreateTestBlockProducer(txPoolTxSource, sealer, transactionComparerProvider);
MiningConfig miningConfig = new() { Enabled = true, MinGasPrice = 0 };
TargetAdjustedGasLimitCalculator targetAdjustedGasLimitCalculator = new(SpecProvider, miningConfig);
EthSyncingInfo = new EthSyncingInfo(BlockTree);
PostMergeBlockProducerFactory?blockProducerFactory = new(
SpecProvider,
SealEngine,
Timestamper,
miningConfig,
LogManager,
targetAdjustedGasLimitCalculator);
BlockProducerEnvFactory blockProducerEnvFactory = new(
DbProvider,
BlockTree,
ReadOnlyTrieStore,
SpecProvider,
BlockValidator,
NoBlockRewards.Instance,
ReceiptStorage,
BlockPreprocessorStep,
TxPool,
transactionComparerProvider,
miningConfig,
LogManager);
BlockProducerEnv blockProducerEnv = blockProducerEnvFactory.Create();
PostMergeBlockProducer?postMergeBlockProducer = blockProducerFactory.Create(
blockProducerEnv, BlockProductionTrigger);
PostMergeBlockProducer = postMergeBlockProducer;
PayloadPreparationService ??= new PayloadPreparationService(
postMergeBlockProducer,
new BlockImprovementContextFactory(BlockProductionTrigger, TimeSpan.FromSeconds(MergeConfig.SecondsPerSlot)),
TimerFactory.Default,
LogManager,
TimeSpan.FromSeconds(MergeConfig.SecondsPerSlot));
return(new MergeBlockProducer(preMergeBlockProducer, postMergeBlockProducer, PoSSwitcher));
}
private TxPoolTxSource CreateTxPoolTxSource(ReadOnlyTxProcessingEnv processingEnv, ITxPool txPool, IMiningConfig miningConfig, ISpecProvider specProvider, ITransactionComparerProvider transactionComparerProvider, ILogManager logManager)
{
ITxFilterPipeline txSourceFilterPipeline = CreateTxSourceFilter(logManager, specProvider);
return(new TxPoolTxSource(txPool, processingEnv.StateReader, specProvider, transactionComparerProvider, logManager, txSourceFilterPipeline));
}
private ITxSource CreateTxSourceForProducer(ReadOnlyTxProcessingEnv processingEnv, ITxPool txPool, ISpecProvider specProvider, ILogManager logManager, IMiningConfig miningConfig, ITransactionComparerProvider transactionComparerProvider) => CreateTxPoolTxSource(processingEnv, txPool, miningConfig, specProvider, transactionComparerProvider, logManager);
