@proto-kit/sequencer • Docs
Documentation / @proto-kit/sequencer / SequencerModule
Class: abstract SequencerModule<Config>
Lifecycle of a SequencerModule
start(): Executed to execute any logic required to start the module
Extends
ConfigurableModule<Config>
Extended by
PrivateMempoolDefaultMempoolSortingAbstractTaskQueueMinaBaseLayerNoopBaseLayerConstantFeeStrategyBlockTriggerBaseBatchProducerModuleBlockProducerModuleLocalSequencerCoreModuleSequencerCoreModuleSequencerStartupModuleInMemoryDatabaseInMemoryMinaSignerSettlementModuleBridgingModule
Type Parameters
• Config = NoConfig
Implements
Constructors
new SequencerModule()
new SequencerModule<
Config>():SequencerModule<Config>
Returns
SequencerModule<Config>
Inherited from
ConfigurableModule.constructor
Properties
currentConfig
protectedcurrentConfig:undefined|Config
Store the config separately, so that we can apply additional checks when retrieving it via the getter
Inherited from
ConfigurableModule.currentConfig
Defined in
packages/common/dist/config/ConfigurableModule.d.ts:17
presets
staticpresets:Presets<unknown> ={}
Defined in
packages/sequencer/src/sequencer/builder/SequencerModule.ts:20
Accessors
config
Get Signature
get config():
Config
Returns
Config
Set Signature
set config(
config):void
Parameters
• config: Config
Returns
void
Inherited from
Defined in
packages/common/dist/config/ConfigurableModule.d.ts:18
Methods
create()
create(
childContainerProvider):void
Parameters
• childContainerProvider: ChildContainerProvider
Returns
void
Inherited from
Defined in
packages/common/dist/config/ConfigurableModule.d.ts:20
start()
abstractstart():Promise<void>
Start the module and all it’s functionality. The returned Promise has to resolve after initialization, since it will block in the sequencer init. That means that you mustn’t await server.start() for example.
Returns
Promise<void>
Implementation of
Defined in
packages/sequencer/src/sequencer/builder/SequencerModule.ts:28