Documentation / @proto-kit/protocol / BridgeContractProtocolModule

Class: BridgeContractProtocolModule

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<BridgeContractType, BridgeContractConfig>

Constructors

new BridgeContractProtocolModule()

new BridgeContractProtocolModule(messageProcessors, contractArgsRegistry): BridgeContractProtocolModule

Parameters

• messageProcessors: OutgoingMessageProcessor<unknown, NoConfig>[]

• contractArgsRegistry: ContractArgsRegistry

Properties

currentConfig

protected currentConfig: undefined | BridgeContractConfig

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>

BridgeContract

BridgeContract: CompileArtifact

Overrides

ContractModule.compile

Defined in

packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:42

contractFactory()

contractFactory(): typeof BridgeContract

Returns

typeof BridgeContract

Overrides

ContractModule.contractFactory

Defined in

packages/protocol/src/settlement/contracts/BridgeContractProtocolModule.ts:31

create()

create(childContainerProvider): void

Parameters

• childContainerProvider: ChildContainerProvider

Returns

void

Inherited from

ContractModule.create

Defined in

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

BridgeContractBase BridgingSettlementContract