DocsReference@proto-kit/sequencerClassesLocalSequencerCoreModule

@proto-kit/sequencerDocs


Documentation / @proto-kit/sequencer / LocalSequencerCoreModule

Class: LocalSequencerCoreModule

Lifecycle of a SequencerModule

start(): Executed to execute any logic required to start the module

Extends

Constructors

new LocalSequencerCoreModule()

new LocalSequencerCoreModule(sequencerStartupModule, blockProducerModule): LocalSequencerCoreModule

Parameters

sequencerStartupModule: SequencerStartupModule

blockProducerModule: BlockProducerModule

Returns

LocalSequencerCoreModule

Overrides

SequencerModule.constructor

Defined in

packages/sequencer/src/sequencer/SequencerCoreModule.ts:64

Properties

currentConfig

protected currentConfig: undefined | LocalSequencerCoreConfig

Store the config separately, so that we can apply additional checks when retrieving it via the getter

Inherited from

SequencerModule.currentConfig

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:17


presets

static presets: Presets<unknown> = {}

Inherited from

SequencerModule.presets

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

SequencerModule.config

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:18

Methods

close()

close(): Promise<void>

Returns

Promise<void>

Defined in

packages/sequencer/src/sequencer/SequencerCoreModule.ts:98


create()

create(): void

Returns

void

Overrides

SequencerModule.create

Defined in

packages/sequencer/src/sequencer/SequencerCoreModule.ts:84


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

SequencerModule.start

Defined in

packages/sequencer/src/sequencer/SequencerCoreModule.ts:93


dependencies()

static dependencies(): LocalSequencerCoreDependencies

Returns

LocalSequencerCoreDependencies

Defined in

packages/sequencer/src/sequencer/SequencerCoreModule.ts:73