@proto-kit/protocol • Docs

Documentation / @proto-kit/protocol / ProvableBlockHook

Class: abstract ProvableBlockHook<Config>

Extends

• TransitioningProtocolModule<Config>

Extended by

• BlockHeightHook
• LastStateRootBlockHook

Type Parameters

• Config = NoConfig

Constructors

new ProvableBlockHook()

new ProvableBlockHook<Config>(): ProvableBlockHook<Config>

Returns

ProvableBlockHook<Config>

Inherited from

TransitioningProtocolModule<Config>.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

TransitioningProtocolModule.currentConfig

Defined in

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

name?

optional name: string

Inherited from

TransitioningProtocolModule.name

Defined in

packages/protocol/src/protocol/TransitioningProtocolModule.ts:11

parent?

optional parent: ProtocolEnvironment

Inherited from

TransitioningProtocolModule.parent

Defined in

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

Accessors

areProofsEnabled

Get Signature

get areProofsEnabled(): undefined | AreProofsEnabled

Returns

undefined | AreProofsEnabled

Inherited from

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

TransitioningProtocolModule.config

Defined in

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

Methods

afterBlock()

abstract afterBlock(networkState, state): Promise<NetworkState>

Parameters

• networkState: NetworkState

• state: AfterBlockHookArguments

Returns

Promise<NetworkState>

Defined in

packages/protocol/src/protocol/ProvableBlockHook.ts:63

beforeBlock()

abstract beforeBlock(networkState, state): Promise<NetworkState>

Parameters

• networkState: NetworkState

• state: BeforeBlockHookArguments

Returns

Promise<NetworkState>

Defined in

packages/protocol/src/protocol/ProvableBlockHook.ts:58

create()

create(childContainerProvider): void

Parameters

• childContainerProvider: ChildContainerProvider

Returns

void

Inherited from

TransitioningProtocolModule.create

Defined in

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

start()

start(): Promise<void>

Returns

Promise<void>

Inherited from

TransitioningProtocolModule.start

Defined in

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