@proto-kit/sequencer • Docs

Documentation / @proto-kit/sequencer / TimedBlockTrigger

Class: TimedBlockTrigger

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

Extends

BlockTriggerBase<TimedBlockTriggerConfig>

Implements

Closeable

Constructors

new TimedBlockTrigger()

new TimedBlockTrigger(batchProducerModule, blockProducerModule, settlementModule, bridgingModule, blockQueue, mempool, startupModule, sequencerCoreModule): TimedBlockTrigger

Parameters

• batchProducerModule: undefined | BatchProducerModule

• blockProducerModule: BlockProducerModule

• settlementModule: undefined | SettlementModule

• bridgingModule: undefined | BridgingModule

• blockQueue: BlockQueue

• mempool: Mempool<MempoolEvents>

• startupModule: SequencerStartupModule

• sequencerCoreModule: undefined | SequencerCoreModule

Properties

batchProducerModule

protected readonly batchProducerModule: undefined | BatchProducerModule

Inherited from

BlockTriggerBase.batchProducerModule

Defined in

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

blockProducerModule

protected readonly blockProducerModule: BlockProducerModule

Inherited from

BlockTriggerBase.blockProducerModule

Defined in

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

blockQueue

protected readonly blockQueue: BlockQueue

Inherited from

BlockTriggerBase.blockQueue

Defined in

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

bridgingModule

protected readonly bridgingModule: undefined | BridgingModule

Inherited from

BlockTriggerBase.bridgingModule

Defined in

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

currentConfig

protected currentConfig: undefined | TimedBlockTriggerConfig

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

Inherited from

BlockTriggerBase.currentConfig

Defined in

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

events

readonly events: EventEmitter<BlockEvents>

Inherited from

BlockTriggerBase.events

Defined in

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

settlementModule

protected readonly settlementModule: undefined | SettlementModule

Inherited from

BlockTriggerBase.settlementModule

Defined in

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

presets

static presets: Presets<unknown> = {}

Inherited from

BlockTriggerBase.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

BlockTriggerBase.config

Defined in

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

Methods

close()

close(): Promise<void>

Returns

Promise<void>

Implementation of

Closeable.close

Defined in

packages/sequencer/src/protocol/production/trigger/TimedBlockTrigger.ts:134

create()

create(childContainerProvider): void

Parameters

• childContainerProvider: ChildContainerProvider

Returns

void

Inherited from

BlockTriggerBase.create

Defined in

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

produceBatch()

protected produceBatch(): Promise<undefined | SettleableBatch>

Returns

Promise<undefined | SettleableBatch>

Inherited from

BlockTriggerBase.produceBatch

Defined in

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

produceBlock()

protected produceBlock(): Promise<undefined | Block>

Returns

Promise<undefined | Block>

Inherited from

BlockTriggerBase.produceBlock

Defined in

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

produceBlockWithResult()

protected produceBlockWithResult(): Promise<undefined | BlockWithResult>

Returns

Promise<undefined | BlockWithResult>

Inherited from

BlockTriggerBase.produceBlockWithResult

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>

Inherited from

BlockTriggerBase.settle

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.