Documentation / @proto-kit/protocol / DispatchContractProtocolModule

Class: DispatchContractProtocolModule

This module type is used to define a contract module that can be used to construct and inject smart contract instances. It defines a method contractFactory, whose arguments can be configured via the Argument generic. It returns a smart contract class that is a subclass of SmartContract and implements a certain interface as specified by the ContractType generic.

Extends

ContractModule<DispatchContractType, DispatchContractConfig>

Constructors

new DispatchContractProtocolModule()

new DispatchContractProtocolModule(runtime, contractArgsRegistry): DispatchContractProtocolModule

Parameters

• runtime: RuntimeLike

• contractArgsRegistry: ContractArgsRegistry

Properties

currentConfig

protected currentConfig: undefined | DispatchContractConfig

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

Inherited from

ContractModule.currentConfig

Defined in

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

Accessors

config

Get Signature

get config(): Config

Returns

Config

Set Signature

set config(config): void

Parameters

• config: Config

Returns

void

Inherited from

ContractModule.config

Defined in

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

Methods

compile()

compile(registry): Promise<object>

Parameters

• registry: CompileRegistry

Returns

Promise<object>

DispatchSmartContract

DispatchSmartContract: CompileArtifact

Overrides

ContractModule.compile

Defined in

packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:70

contractFactory()

contractFactory(): SmartContractClassFromInterface<DispatchContractType>

Returns

SmartContractClassFromInterface<DispatchContractType>

Overrides

ContractModule.contractFactory

Defined in

packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:53

create()

create(childContainerProvider): void

Parameters

• childContainerProvider: ChildContainerProvider

Returns

void

Inherited from

ContractModule.create

Defined in

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

eventsDefinition()

eventsDefinition(): object

Returns

object

incoming-message-placeholder

incoming-message-placeholder: typeof Field & (x) => Field = Field

token-bridge-added

token-bridge-added: typeof TokenBridgeTreeAddition = TokenBridgeTreeAddition

Defined in

packages/protocol/src/settlement/contracts/DispatchContractProtocolModule.ts:34

Deposit DispatchSmartContract