@proto-kit/protocol • Docs

Documentation / @proto-kit/protocol / AccountStateHook

Class: AccountStateHook

Extends

• ProvableTransactionHook<AccountStateHookConfig>

Constructors

new AccountStateHook()

new AccountStateHook(): AccountStateHook

Returns

AccountStateHook

Inherited from

ProvableTransactionHook.constructor

Properties

accountState

accountState: StateMap<PublicKey, AccountState>

Defined in

packages/protocol/src/hooks/AccountStateHook.ts:23

currentConfig

protected currentConfig: undefined | AccountStateHookConfig

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

Inherited from

ProvableTransactionHook.currentConfig

Defined in

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

name?

optional name: string

Inherited from

ProvableTransactionHook.name

Defined in

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

parent?

optional parent: ProtocolEnvironment

Inherited from

ProvableTransactionHook.parent

Defined in

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

Accessors

areProofsEnabled

Get Signature

get areProofsEnabled(): undefined | AreProofsEnabled

Returns

undefined | AreProofsEnabled

Inherited from

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

ProvableTransactionHook.config

Defined in

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

Methods

afterTransaction()

afterTransaction(): Promise<void>

Returns

Promise<void>

Overrides

ProvableTransactionHook.afterTransaction

Defined in

packages/protocol/src/hooks/AccountStateHook.ts:58

beforeTransaction()

beforeTransaction(__namedParameters): Promise<void>

Parameters

• __namedParameters: BeforeTransactionHookArguments

Returns

Promise<void>

Overrides

ProvableTransactionHook.beforeTransaction

Defined in

packages/protocol/src/hooks/AccountStateHook.ts:28

create()

create(childContainerProvider): void

Parameters

• childContainerProvider: ChildContainerProvider

Returns

void

Inherited from

ProvableTransactionHook.create

Defined in

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

removeTransactionWhen()

removeTransactionWhen(__namedParameters): Promise<boolean>

Parameters

• __namedParameters: BeforeTransactionHookArguments

Returns

Promise<boolean>

Overrides

ProvableTransactionHook.removeTransactionWhen

Defined in

packages/protocol/src/hooks/AccountStateHook.ts:63

start()

start(): Promise<void>

Returns

Promise<void>

Inherited from

ProvableTransactionHook.start

Defined in

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