@proto-kit/protocol • Docs
Documentation / @proto-kit/protocol / NetworkStateSettlementModule
Class: NetworkStateSettlementModule
Used by various module sub-types that may need to be configured
Extends
ProvableSettlementHook<NetworkStateSettlementModuleConfig>
Constructors
new NetworkStateSettlementModule()
new NetworkStateSettlementModule():
NetworkStateSettlementModule
Returns
Inherited from
ProvableSettlementHook.constructor
Properties
currentConfig
protectedcurrentConfig:undefined|NetworkStateSettlementModuleConfig
Store the config separately, so that we can apply additional checks when retrieving it via the getter
Inherited from
ProvableSettlementHook.currentConfig
Defined in
packages/common/dist/config/ConfigurableModule.d.ts:17
parent?
optionalparent:ProtocolEnvironment
Inherited from
Defined in
packages/protocol/src/protocol/ProtocolModule.ts:14
Accessors
areProofsEnabled
Get Signature
get areProofsEnabled():
undefined|AreProofsEnabled
Returns
undefined | AreProofsEnabled
Inherited from
ProvableSettlementHook.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
Defined in
packages/common/dist/config/ConfigurableModule.d.ts:18
Methods
beforeSettlement()
beforeSettlement(
smartContract,__namedParameters):Promise<void>
Parameters
• smartContract: SettlementContractType
• __namedParameters: SettlementHookInputs
Returns
Promise<void>
Overrides
ProvableSettlementHook.beforeSettlement
Defined in
packages/protocol/src/settlement/modules/NetworkStateSettlementModule.ts:15
create()
create(
childContainerProvider):void
Parameters
• childContainerProvider: ChildContainerProvider
Returns
void
Inherited from
Defined in
packages/protocol/src/protocol/ProtocolModule.ts:20
start()
start():
Promise<void>
Returns
Promise<void>