DocsReference@proto-kit/sequencerClassesFungibleTokenContractModule

@proto-kit/sequencerDocs


Documentation / @proto-kit/sequencer / FungibleTokenContractModule

Class: FungibleTokenContractModule

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

Constructors

new FungibleTokenContractModule()

new FungibleTokenContractModule(): FungibleTokenContractModule

Returns

FungibleTokenContractModule

Inherited from

ContractModule.constructor

Properties

currentConfig

protected currentConfig: undefined | NoConfig

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<Record<string, CompileArtifact>>

Parameters

registry: CompileRegistry

Returns

Promise<Record<string, CompileArtifact>>

Overrides

ContractModule.compile

Defined in

packages/sequencer/src/settlement/utils/FungibleTokenContractModule.ts:15


contractFactory()

contractFactory(): SmartContractClassFromInterface<FungibleToken>

Returns

SmartContractClassFromInterface<FungibleToken>

Overrides

ContractModule.contractFactory

Defined in

packages/sequencer/src/settlement/utils/FungibleTokenContractModule.ts:11


create()

create(childContainerProvider): void

Parameters

childContainerProvider: ChildContainerProvider

Returns

void

Inherited from

ContractModule.create

Defined in

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