@proto-kit/protocol • Docs

Documentation / @proto-kit/protocol / ProtocolModule

Class: abstract ProtocolModule<Config>

Used by various module sub-types that may need to be configured

Extends

• ConfigurableModule<Config>

Extended by

• BlockProver
• StateTransitionProver
• TransactionProver
• TransactionProverType
• BlockProverType
• StateTransitionProverType
• ProvableSettlementHook
• OutgoingMessageProcessor

Type Parameters

• Config = NoConfig

Constructors

new ProtocolModule()

new ProtocolModule<Config>(): ProtocolModule<Config>

Returns

ProtocolModule<Config>

Inherited from

ConfigurableModule.constructor

Properties

currentConfig

protected currentConfig: undefined | Config

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

Inherited from

ConfigurableModule.currentConfig

Defined in

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

parent?

optional parent: ProtocolEnvironment

Defined in

packages/protocol/src/protocol/ProtocolModule.ts:14

Accessors

areProofsEnabled

Get Signature

get areProofsEnabled(): undefined | AreProofsEnabled

Returns

undefined | AreProofsEnabled

Defined in

packages/protocol/src/protocol/ProtocolModule.ts:16

config

Get Signature

get config(): Config

Returns

Config

Set Signature

set config(config): void

Parameters

• config: Config

Returns

void

Inherited from

ConfigurableModule.config

Defined in

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

Methods

create()

create(childContainerProvider): void

Parameters

• childContainerProvider: ChildContainerProvider

Returns

void

Overrides

ConfigurableModule.create

Defined in

packages/protocol/src/protocol/ProtocolModule.ts:20

start()

start(): Promise<void>

Returns

Promise<void>

Defined in

packages/protocol/src/protocol/ProtocolModule.ts:24