@proto-kit/sequencer • Docs

Documentation / @proto-kit/sequencer / BlockTriggerBase

Class: BlockTriggerBase<Config, Events>

A BlockTrigger is the primary method to start the production of a block and all associated processes.

Extends

• SequencerModule<Config>

Extended by

• ManualBlockTrigger
• TimedBlockTrigger

Type Parameters

• Config = NoConfig

• Events extends BlockEvents = BlockEvents

Implements

• BlockTrigger
• EventEmittingComponent<Events>

Constructors

new BlockTriggerBase()

new BlockTriggerBase<Config, Events>(blockProducerModule, batchProducerModule, settlementModule, bridgingModule, blockQueue): BlockTriggerBase<Config, Events>

Parameters

• blockProducerModule: BlockProducerModule

• batchProducerModule: undefined | BatchProducerModule

• settlementModule: undefined | SettlementModule

• bridgingModule: undefined | BridgingModule

• blockQueue: BlockQueue

Returns

BlockTriggerBase<Config, Events>

Overrides

SequencerModule.constructor

Defined in

packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:46

Properties

batchProducerModule

protected readonly batchProducerModule: undefined | BatchProducerModule

Defined in

packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:48

blockProducerModule

protected readonly blockProducerModule: BlockProducerModule

Defined in

packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:47

blockQueue

protected readonly blockQueue: BlockQueue

Defined in

packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:51

bridgingModule

protected readonly bridgingModule: undefined | BridgingModule

Defined in

packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:50

currentConfig

protected currentConfig: undefined | Config

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

events

readonly events: EventEmitter<Events>

Implementation of

EventEmittingComponent.events

Defined in

packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:44

settlementModule

protected readonly settlementModule: undefined | SettlementModule

Defined in

packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:49

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

create()

create(childContainerProvider): void

Parameters

• childContainerProvider: ChildContainerProvider

Returns

void

Inherited from

SequencerModule.create

Defined in

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

produceBatch()

protected produceBatch(): Promise<undefined | SettleableBatch>

Returns

Promise<undefined | SettleableBatch>

Defined in

packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:56

produceBlock()

protected produceBlock(): Promise<undefined | Block>

Returns

Promise<undefined | Block>

Defined in

packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:89

produceBlockWithResult()

protected produceBlockWithResult(): Promise<undefined | BlockWithResult>

Returns

Promise<undefined | BlockWithResult>

Defined in

packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:68

settle()

protected settle(batch, config): Promise<undefined | object>

Parameters

• batch: SettleableBatch

• config: SettlementTokenConfig

Returns

Promise<undefined | object>

Defined in

packages/sequencer/src/protocol/production/trigger/BlockTrigger.ts:95

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/protocol/production/trigger/BlockTrigger.ts:121