Class TokenModule

The Token module handles all logic related to balance. Specifically the following criteria:

Storing token balances of accounts.
Transferring tokens between accounts.
Transferring tokens between accounts on different chains.

See

LIP 0051 - Define state and state transitions of Token module

Hierarchy

BaseInteroperableModule
- TokenModule

Constructors

constructor

new TokenModule(): TokenModule
Returns TokenModule
Overrides BaseInteroperableModule.constructor
- Defined in framework/src/modules/token/module.ts:104

Properties

`Private` `Readonly` _ccTransferCommand

_ccTransferCommand: TransferCrossChainCommand = ...

`Private` `Readonly` _internalMethod

_internalMethod: InternalMethod = ...

`Private` _interoperabilityMethod

_interoperabilityMethod: InteroperabilityMethod

`Private` `Readonly` _transferCommand

_transferCommand: TransferCommand = ...

commands

commands: (TransferCommand | TransferCrossChainCommand)[] = ...

crossChainCommand

crossChainCommand: CrossChainTransferCommand[] = ...

crossChainMethod

crossChainMethod: TokenInteroperableMethod = ...

crossChainTransferCommand

crossChainTransferCommand: CrossChainTransferCommand = ...

endpoint

endpoint: TokenEndpoint = ...

events

events: NamedRegistry = ...

method

method: TokenMethod = ...

offchainStores

offchainStores: NamedRegistry = ...

stores

stores: NamedRegistry = ...

Accessors

name

get name(): string
Returns string
Inherited from BaseInteroperableModule.name
- Defined in framework/src/modules/base_module.ts:73

Methods

addDependencies

addDependencies(interoperabilityMethod: InteroperabilityMethod, feeMethod: FeeMethod): void
Parameters
- interoperabilityMethod: InteroperabilityMethod
- feeMethod: FeeMethod
Returns void
- Defined in framework/src/modules/token/module.ts:137

`Optional` afterCommandExecute

afterCommandExecute(context: TransactionExecuteContext): Promise<void>
Parameters
- context: TransactionExecuteContext
Returns Promise<void>
Inherited from BaseInteroperableModule.afterCommandExecute
- Defined in framework/src/modules/base_module.ts:86

`Optional` afterTransactionsExecute

afterTransactionsExecute(context: BlockAfterExecuteContext): Promise<void>
Parameters
- context: BlockAfterExecuteContext
Returns Promise<void>
Inherited from BaseInteroperableModule.afterTransactionsExecute
- Defined in framework/src/modules/base_module.ts:90

`Protected` baseMetadata

baseMetadata(): {
    assets: never[];
    commands: {
        name: string;
        params: Schema;
    }[];
    endpoints: never[];
    events: {
        data: Schema;
        name: string;
    }[];
    stores: {
        data: Schema;
        key: string;
    }[];
}
Returns {
    assets: never[];
    commands: {
        name: string;
        params: Schema;
    }[];
    endpoints: never[];
    events: {
        data: Schema;
        name: string;
    }[];
    stores: {
        data: Schema;
        key: string;
    }[];
}
- assets: never[]
- commands: {
  name: string;
  params: Schema;
  }[]
- endpoints: never[]
- events: {
  data: Schema;
  name: string;
  }[]
- stores: {
  data: Schema;
  key: string;
  }[]
Inherited from BaseInteroperableModule.baseMetadata
- Defined in framework/src/modules/base_module.ts:94

`Optional` beforeCommandExecute

beforeCommandExecute(context: TransactionExecuteContext): Promise<void>
Parameters
- context: TransactionExecuteContext
Returns Promise<void>
Inherited from BaseInteroperableModule.beforeCommandExecute
- Defined in framework/src/modules/base_module.ts:85

`Optional` beforeTransactionsExecute

beforeTransactionsExecute(context: BlockExecuteContext): Promise<void>
Parameters
- context: BlockExecuteContext
Returns Promise<void>
Inherited from BaseInteroperableModule.beforeTransactionsExecute
- Defined in framework/src/modules/base_module.ts:89

`Optional` insertAssets

insertAssets(context: InsertAssetContext): Promise<void>
Parameters
- context: InsertAssetContext
Returns Promise<void>
Inherited from BaseInteroperableModule.insertAssets
- Defined in framework/src/modules/base_module.ts:82

metadata

metadata(): ModuleMetadata
Returns ModuleMetadata
Overrides BaseInteroperableModule.metadata
- Defined in framework/src/modules/token/module.ts:144

`Optional` verifyAssets

verifyAssets(context: BlockVerifyContext): Promise<void>
Parameters
- context: BlockVerifyContext
Returns Promise<void>
Inherited from BaseInteroperableModule.verifyAssets
- Defined in framework/src/modules/base_module.ts:83

`Optional` verifyTransaction

verifyTransaction(context: TransactionVerifyContext): Promise<VerificationResult>
Parameters
- context: TransactionVerifyContext
Returns Promise<VerificationResult>
Inherited from BaseInteroperableModule.verifyTransaction
- Defined in framework/src/modules/base_module.ts:84

Class TokenModule

See

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns TokenModule

Properties

Private Readonly _ccTransferCommand

Private Readonly _internalMethod

Private _interoperabilityMethod

Private Readonly _transferCommand

commands

crossChainCommand

crossChainMethod

crossChainTransferCommand

endpoint

events

method

offchainStores

stores

Accessors

name

Returns string

Methods

addDependencies

Parameters

interoperabilityMethod: InteroperabilityMethod

feeMethod: FeeMethod

Returns void

Optional afterCommandExecute

Parameters

context: TransactionExecuteContext

Returns Promise<void>

Optional afterTransactionsExecute

Parameters

context: BlockAfterExecuteContext

Returns Promise<void>

Protected baseMetadata

Returns { assets: never[]; commands: { name: string; params: Schema; }[]; endpoints: never[]; events: { data: Schema; name: string; }[]; stores: { data: Schema; key: string; }[]; }

assets: never[]

commands: { name: string; params: Schema; }[]

endpoints: never[]

events: { data: Schema; name: string; }[]

stores: { data: Schema; key: string; }[]

Optional beforeCommandExecute

Parameters

context: TransactionExecuteContext

Returns Promise<void>

Optional beforeTransactionsExecute

Parameters

context: BlockExecuteContext

Returns Promise<void>

Optional finalizeGenesisState

Parameters

context: GenesisBlockExecuteContext

Returns Promise<void>

init

Parameters

args: ModuleInitArgs

Returns Promise<void>

initGenesisState

Parameters

context: GenesisBlockExecuteContext

Returns Promise<void>

Optional insertAssets

Parameters

context: InsertAssetContext

Returns Promise<void>

metadata

Returns ModuleMetadata

Optional verifyAssets

Parameters

context: BlockVerifyContext

Returns Promise<void>

Optional verifyTransaction

`Private` `Readonly` _ccTransferCommand

`Private` `Readonly` _internalMethod

`Private` _interoperabilityMethod

`Private` `Readonly` _transferCommand

`Optional` afterCommandExecute

`Optional` afterTransactionsExecute

`Protected` baseMetadata

Returns {
assets: never[];
commands: {
name: string;
params: Schema;
}[];
endpoints: never[];
events: {
data: Schema;
name: string;
}[];
stores: {
data: Schema;
key: string;
}[];
}

commands: {
name: string;
params: Schema;
}[]

events: {
data: Schema;
name: string;
}[]

stores: {
data: Schema;
key: string;
}[]

`Optional` beforeCommandExecute

`Optional` beforeTransactionsExecute

`Optional` finalizeGenesisState

`Optional` insertAssets

`Optional` verifyAssets

`Optional` verifyTransaction