@proto-kit/sequencer • Docs
Documentation / @proto-kit/sequencer / SequencerCoreModule
Class: SequencerCoreModule
Lifecycle of a SequencerModule
start(): Executed to execute any logic required to start the module
Extends
Constructors
new SequencerCoreModule()
new SequencerCoreModule(
sequencerStartupModule,blockProducerModule,batchProducerModule):SequencerCoreModule
Parameters
• sequencerStartupModule: SequencerStartupModule
• blockProducerModule: BlockProducerModule
• batchProducerModule: BatchProducerModule
Returns
Overrides
Defined in
packages/sequencer/src/sequencer/SequencerCoreModule.ts:106
Properties
currentConfig
protectedcurrentConfig:undefined|SequencerCoreConfig
Store the config separately, so that we can apply additional checks when retrieving it via the getter
Inherited from
Defined in
packages/common/dist/config/ConfigurableModule.d.ts:17
presets
staticpresets:Presets<unknown> ={}
Inherited from
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():
void
Returns
void
Overrides
Defined in
packages/sequencer/src/sequencer/SequencerCoreModule.ts:131
start()
start():
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>
Overrides
Defined in
packages/sequencer/src/sequencer/SequencerCoreModule.ts:143
dependencies()
staticdependencies():SequencerCoreDependencies