@proto-kit/sdk • Docs

Documentation / @proto-kit/sdk / StateServiceQueryModule

Class: StateServiceQueryModule

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

Extends

• AppChainModule

Implements

• QueryTransportModule

Constructors

new StateServiceQueryModule()

new StateServiceQueryModule(sequencer): StateServiceQueryModule

Parameters

• sequencer: ModuleContainerLike

Returns

StateServiceQueryModule

Overrides

AppChainModule.constructor

Defined in

sdk/src/query/StateServiceQueryModule.ts:22

Properties

appChain?

optional appChain: AppChain<any>

Inherited from

AppChainModule.appChain

Defined in

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

currentConfig

protected currentConfig: undefined | NoConfig

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

sequencer

sequencer: ModuleContainerLike

Defined in

sdk/src/query/StateServiceQueryModule.ts:23

presets

static presets: Presets<unknown>

Inherited from

AppChainModule.presets

Defined in

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

Accessors

asyncStateService

Get Signature

get asyncStateService(): AsyncStateService

Returns

AsyncStateService

Defined in

sdk/src/query/StateServiceQueryModule.ts:28

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

leafStore

Get Signature

get leafStore(): AsyncLinkedLeafStore

Returns

AsyncLinkedLeafStore

Defined in

sdk/src/query/StateServiceQueryModule.ts:34

treeStore

Get Signature

get treeStore(): AsyncMerkleTreeStore

Returns

AsyncMerkleTreeStore

Defined in

sdk/src/query/StateServiceQueryModule.ts:38

Methods

create()

create(childContainerProvider): void

Parameters

• childContainerProvider: ChildContainerProvider

Returns

void

Inherited from

AppChainModule.create

Defined in

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

get()

get(key): Promise<undefined | Field[]>

Parameters

• key: Field

Returns

Promise<undefined | Field[]>

Implementation of

QueryTransportModule.get

Defined in

sdk/src/query/StateServiceQueryModule.ts:42

merkleWitness()

merkleWitness(path): Promise<undefined | LinkedMerkleTreeReadWitness>

Parameters

• path: Field

Returns

Promise<undefined | LinkedMerkleTreeReadWitness>

Implementation of

QueryTransportModule.merkleWitness

Defined in

sdk/src/query/StateServiceQueryModule.ts:46