@proto-kit/sdk • Docs

Documentation / @proto-kit/sdk / BlockStorageNetworkStateModule

Class: BlockStorageNetworkStateModule

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

Extends

• AppChainModule<Record<string, never>>

Implements

• NetworkStateTransportModule

Constructors

new BlockStorageNetworkStateModule()

new BlockStorageNetworkStateModule(sequencer): BlockStorageNetworkStateModule

Parameters

• sequencer: ModuleContainerLike

Returns

BlockStorageNetworkStateModule

Overrides

AppChainModule.constructor

Defined in

sdk/src/query/BlockStorageNetworkStateModule.ts:17

Properties

appChain?

optional appChain: AppChain<any>

Inherited from

AppChainModule.appChain

Defined in

sequencer/dist/appChain/AppChainModule.d.ts:5

currentConfig

protected currentConfig: undefined | Record<string, never>

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

Inherited from

AppChainModule.currentConfig

Defined in

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

presets

static presets: Presets<unknown>

Inherited from

AppChainModule.presets

Defined in

sequencer/dist/appChain/AppChainModule.d.ts:4

Accessors

config

Get Signature

get config(): Config

Returns

Config

Set Signature

set config(config): void

Parameters

• config: Config

Returns

void

Inherited from

AppChainModule.config

Defined in

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

Methods

create()

create(childContainerProvider): void

Parameters

• childContainerProvider: ChildContainerProvider

Returns

void

Inherited from

AppChainModule.create

Defined in

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

getProvenNetworkState()

getProvenNetworkState(): Promise<undefined | NetworkState>

Returns

Promise<undefined | NetworkState>

Implementation of

NetworkStateTransportModule.getProvenNetworkState

Defined in

sdk/src/query/BlockStorageNetworkStateModule.ts:56

getStagedNetworkState()

getStagedNetworkState(): Promise<undefined | NetworkState>

Staged network state is the networkstate after the latest unproven block with afterBundle() hooks executed

Returns

Promise<undefined | NetworkState>

Implementation of

NetworkStateTransportModule.getStagedNetworkState

Defined in

sdk/src/query/BlockStorageNetworkStateModule.ts:49

getUnprovenNetworkState()

getUnprovenNetworkState(): Promise<undefined | NetworkState>

Returns

Promise<undefined | NetworkState>

Implementation of

NetworkStateTransportModule.getUnprovenNetworkState

Defined in

sdk/src/query/BlockStorageNetworkStateModule.ts:40