Class TokenMethod

Hierarchy

BaseMethod
- TokenMethod

Constructors

constructor

new TokenMethod(stores: NamedRegistry, events: NamedRegistry, moduleName: string): TokenMethod
Parameters
- stores: NamedRegistry
- events: NamedRegistry
- moduleName: string
Returns TokenMethod
Overrides BaseMethod.constructor
- Defined in framework/src/modules/token/method.ts:59

Properties

`Private` _config

_config: MethodConfig

`Private` _internalMethod

_internalMethod: InternalMethod

`Private` _interoperabilityMethod

_interoperabilityMethod: InteroperabilityMethod

`Private` `Readonly` _moduleName

_moduleName: string

`Protected` events

events: NamedRegistry

`Protected` stores

stores: NamedRegistry

Methods

addDependencies

addDependencies(interoperabilityMethod: InteroperabilityMethod, internalMethod: InternalMethod): void
Parameters
- interoperabilityMethod: InteroperabilityMethod
- internalMethod: InternalMethod
Returns void
- Defined in framework/src/modules/token/method.ts:68

burn

burn(methodContext: MethodContext, address: Buffer, tokenID: Buffer, amount: bigint): Promise<void>
Parameters
- methodContext: MethodContext
- address: Buffer
- tokenID: Buffer
- amount: bigint
Returns Promise<void>
- Defined in framework/src/modules/token/method.ts:259

escrowSubstoreExists

escrowSubstoreExists(methodContext: MethodContext, chainID: Buffer, tokenID: Buffer): Promise<boolean>
Parameters
- methodContext: MethodContext
- chainID: Buffer
- tokenID: Buffer
Returns Promise<boolean>
- Defined in framework/src/modules/token/method.ts:809

getAvailableBalance

getAvailableBalance(methodContext: ImmutableMethodContext, address: Buffer, tokenID: Buffer): Promise<bigint>
Parameters
- methodContext: ImmutableMethodContext
- address: Buffer
- tokenID: Buffer
Returns Promise<bigint>
- Defined in framework/src/modules/token/method.ts:96

getEscrowedAmount

getEscrowedAmount(methodContext: ImmutableMethodContext, escrowChainID: Buffer, tokenID: Buffer): Promise<bigint>
Parameters
- methodContext: ImmutableMethodContext
- escrowChainID: Buffer
- tokenID: Buffer
Returns Promise<bigint>
- Defined in framework/src/modules/token/method.ts:131

getLockedAmount

getLockedAmount(methodContext: ImmutableMethodContext, address: Buffer, tokenID: Buffer, module: string): Promise<bigint>
Parameters
- methodContext: ImmutableMethodContext
- address: Buffer
- tokenID: Buffer
- module: string
Returns Promise<bigint>
- Defined in framework/src/modules/token/method.ts:113

getTokenIDKLY

getTokenIDKLY(): Buffer
Returns Buffer
- Defined in framework/src/modules/token/method.ts:81

getTotalSupply

getTotalSupply(context: MethodContext): Promise<{
    totalSupply: (SupplyStoreData & {
        tokenID: Buffer;
    })[];
}>
Parameters
- context: MethodContext
Returns Promise<{
    totalSupply: (SupplyStoreData & {
        tokenID: Buffer;
    })[];
}>
- Defined in framework/src/modules/token/method.ts:795

init

init(config: MethodConfig): void
Parameters
- config: MethodConfig
Returns void
- Defined in framework/src/modules/token/method.ts:64

initializeEscrowAccount

initializeEscrowAccount(methodContext: MethodContext, chainID: Buffer, tokenID: Buffer): Promise<void>
Parameters
- methodContext: MethodContext
- chainID: Buffer
- tokenID: Buffer
Returns Promise<void>
- Defined in framework/src/modules/token/method.ts:322

initializeToken

initializeToken(methodContext: MethodContext, tokenID: Buffer): Promise<void>
Parameters
- methodContext: MethodContext
- tokenID: Buffer
Returns Promise<void>
- Defined in framework/src/modules/token/method.ts:165

initializeUserAccount

initializeUserAccount(methodContext: MethodContext, address: Buffer, tokenID: Buffer): Promise<void>
Parameters
- methodContext: MethodContext
- address: Buffer
- tokenID: Buffer
Returns Promise<void>
- Defined in framework/src/modules/token/method.ts:310

isNativeToken

isNativeToken(tokenID: Buffer): boolean
Parameters
- tokenID: Buffer
Returns boolean
- Defined in framework/src/modules/token/method.ts:76

isTokenIDAvailable

isTokenIDAvailable(methodContext: ImmutableMethodContext, tokenID: Buffer): Promise<boolean>
Parameters
- methodContext: ImmutableMethodContext
- tokenID: Buffer
Returns Promise<boolean>
- Defined in framework/src/modules/token/method.ts:157

isTokenSupported

isTokenSupported(methodContext: ImmutableMethodContext, tokenID: Buffer): Promise<boolean>
Parameters
- methodContext: ImmutableMethodContext
- tokenID: Buffer
Returns Promise<boolean>
- Defined in framework/src/modules/token/method.ts:676

lock

lock(methodContext: MethodContext, address: Buffer, module: string, tokenID: Buffer, amount: bigint): Promise<void>
Parameters
- methodContext: MethodContext
- address: Buffer
- module: string
- tokenID: Buffer
- amount: bigint
Returns Promise<void>
- Defined in framework/src/modules/token/method.ts:525

mint

mint(methodContext: MethodContext, address: Buffer, tokenID: Buffer, amount: bigint): Promise<void>
Parameters
- methodContext: MethodContext
- address: Buffer
- tokenID: Buffer
- amount: bigint
Returns Promise<void>
- Defined in framework/src/modules/token/method.ts:184

payMessageFee

payMessageFee(methodContext: MethodContext, payFromAddress: Buffer, receivingChainID: Buffer, fee: bigint): Promise<void>
Parameters
- methodContext: MethodContext
- payFromAddress: Buffer
- receivingChainID: Buffer
- fee: bigint
Returns Promise<void>
- Defined in framework/src/modules/token/method.ts:640

removeAllTokensSupport

removeAllTokensSupport(methodContext: MethodContext): Promise<void>
Parameters
- methodContext: MethodContext
Returns Promise<void>
- Defined in framework/src/modules/token/method.ts:688

removeAllTokensSupportFromChainID

removeAllTokensSupportFromChainID(methodContext: MethodContext, chainID: Buffer): Promise<void>
Parameters
- methodContext: MethodContext
- chainID: Buffer
Returns Promise<void>
- Defined in framework/src/modules/token/method.ts:716

removeSupport

removeSupport(methodContext: MethodContext, tokenID: Buffer): Promise<void>
Parameters
- methodContext: MethodContext
- tokenID: Buffer
Returns Promise<void>
- Defined in framework/src/modules/token/method.ts:752

supportAllTokens

supportAllTokens(methodContext: MethodContext): Promise<void>
Parameters
- methodContext: MethodContext
Returns Promise<void>
- Defined in framework/src/modules/token/method.ts:683

supportAllTokensFromChainID

supportAllTokensFromChainID(methodContext: MethodContext, chainID: Buffer): Promise<void>
Parameters
- methodContext: MethodContext
- chainID: Buffer
Returns Promise<void>
- Defined in framework/src/modules/token/method.ts:693

supportTokenID

supportTokenID(methodContext: MethodContext, tokenID: Buffer): Promise<void>
Parameters
- methodContext: MethodContext
- tokenID: Buffer
Returns Promise<void>
- Defined in framework/src/modules/token/method.ts:747

transfer

transfer(methodContext: MethodContext, senderAddress: Buffer, recipientAddress: Buffer, tokenID: Buffer, amount: bigint): Promise<void>
Parameters
- methodContext: MethodContext
- senderAddress: Buffer
- recipientAddress: Buffer
- tokenID: Buffer
- amount: bigint
Returns Promise<void>
- Defined in framework/src/modules/token/method.ts:348

transferCrossChain

transferCrossChain(methodContext: MethodContext, senderAddress: Buffer, receivingChainID: Buffer, recipientAddress: Buffer, tokenID: Buffer, amount: bigint, messageFee: bigint, data: string): Promise<void>
Parameters
- methodContext: MethodContext
- senderAddress: Buffer
- receivingChainID: Buffer
- recipientAddress: Buffer
- tokenID: Buffer
- amount: bigint
- messageFee: bigint
- data: string
Returns Promise<void>
- Defined in framework/src/modules/token/method.ts:403

unlock

unlock(methodContext: MethodContext, address: Buffer, module: string, tokenID: Buffer, amount: bigint): Promise<void>
Parameters
- methodContext: MethodContext
- address: Buffer
- module: string
- tokenID: Buffer
- amount: bigint
Returns Promise<void>
- Defined in framework/src/modules/token/method.ts:582

userSubstoreExists

userSubstoreExists(methodContext: ImmutableMethodContext, address: Buffer, tokenID: Buffer): Promise<boolean>
Parameters
- methodContext: ImmutableMethodContext
- address: Buffer
- tokenID: Buffer
Returns Promise<boolean>
- Defined in framework/src/modules/token/method.ts:87

Class TokenMethod

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

stores: NamedRegistry

events: NamedRegistry

moduleName: string

Returns TokenMethod

Properties

Private _config

Private _internalMethod

Private _interoperabilityMethod

Private Readonly _moduleName

Protected events

Protected stores

Methods

addDependencies

Parameters

interoperabilityMethod: InteroperabilityMethod

internalMethod: InternalMethod

Returns void

burn

Parameters

methodContext: MethodContext

address: Buffer

tokenID: Buffer

amount: bigint

Returns Promise<void>

escrowSubstoreExists

Parameters

methodContext: MethodContext

chainID: Buffer

tokenID: Buffer

Returns Promise<boolean>

getAvailableBalance

Parameters

methodContext: ImmutableMethodContext

address: Buffer

tokenID: Buffer

Returns Promise<bigint>

getEscrowedAmount

Parameters

methodContext: ImmutableMethodContext

escrowChainID: Buffer

tokenID: Buffer

Returns Promise<bigint>

getLockedAmount

Parameters

methodContext: ImmutableMethodContext

address: Buffer

tokenID: Buffer

module: string

Returns Promise<bigint>

getTokenIDKLY

Returns Buffer

getTotalSupply

Parameters

context: MethodContext

Returns Promise<{ totalSupply: (SupplyStoreData & { tokenID: Buffer; })[]; }>

init

Parameters

config: MethodConfig

Returns void

initializeEscrowAccount

Parameters

methodContext: MethodContext

chainID: Buffer

tokenID: Buffer

Returns Promise<void>

initializeToken

Parameters

methodContext: MethodContext

tokenID: Buffer

Returns Promise<void>

initializeUserAccount

`Private` _config

`Private` _internalMethod

`Private` _interoperabilityMethod

`Private` `Readonly` _moduleName

`Protected` events

`Protected` stores

Returns Promise<{
totalSupply: (SupplyStoreData & {
tokenID: Buffer;
})[];
}>