@proto-kit/indexer • Docs
Documentation / @proto-kit/indexer / IndexerNotifier
Class: IndexerNotifier
Lifecycle of a SequencerModule
start(): Executed to execute any logic required to start the module
Extends
SequencerModule<Record<never,never>>
Constructors
new IndexerNotifier()
new IndexerNotifier(
sequencer,taskQueue,blockStorage,indexBlockTask,indexPendingTxTask,indexBatchTask,indexSettlementTask,sequencerIdProvider):IndexerNotifier
Parameters
• sequencer: Sequencer<NotifierMandatorySequencerModules>
• taskQueue: TaskQueue
• blockStorage: BlockStorage
• indexBlockTask: IndexBlockTask
• indexPendingTxTask: IndexPendingTxTask
• indexBatchTask: IndexBatchTask
• indexSettlementTask: IndexSettlementTask
• sequencerIdProvider: SequencerIdProvider
Returns
Overrides
Defined in
indexer/src/IndexerNotifier.ts:29
Properties
currentConfig
protectedcurrentConfig:undefined|Record<never,never>
Store the config separately, so that we can apply additional checks when retrieving it via the getter
Inherited from
Defined in
common/dist/config/ConfigurableModule.d.ts:17
indexBatchTask
indexBatchTask:
IndexBatchTask
Defined in
indexer/src/IndexerNotifier.ts:38
indexBlockTask
indexBlockTask:
IndexBlockTask
Defined in
indexer/src/IndexerNotifier.ts:36
indexPendingTxTask
indexPendingTxTask:
IndexPendingTxTask
Defined in
indexer/src/IndexerNotifier.ts:37
indexSettlementTask
indexSettlementTask:
IndexSettlementTask
Defined in
indexer/src/IndexerNotifier.ts:39
sequencer
sequencer:
Sequencer<NotifierMandatorySequencerModules>
Defined in
indexer/src/IndexerNotifier.ts:31
taskQueue
taskQueue:
TaskQueue
Defined in
indexer/src/IndexerNotifier.ts:33
presets
staticpresets:Presets<unknown>
Inherited from
Defined in
sequencer/dist/sequencer/builder/SequencerModule.d.ts:8
Accessors
config
Get Signature
get config():
Config
Returns
Config
Set Signature
set config(
config):void
Parameters
• config: Config
Returns
void
Inherited from
Defined in
common/dist/config/ConfigurableModule.d.ts:18
Methods
create()
create(
childContainerProvider):void
Parameters
• childContainerProvider: ChildContainerProvider
Returns
void
Inherited from
Defined in
common/dist/config/ConfigurableModule.d.ts:20
propagateEventsAsTasks()
propagateEventsAsTasks():
Promise<void>
Returns
Promise<void>
Defined in
indexer/src/IndexerNotifier.ts:104
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>