Class CrossChainTransferCommand

The transferCrossChain cross-chain command of the TokenModule

name: transferCrossChain
module: token

Hierarchy

BaseCCCommand
- CrossChainTransferCommand

Index

Constructors

constructor

new CrossChainTransferCommand(stores: NamedRegistry, events: NamedRegistry): CrossChainTransferCommand
Parameters
- stores: NamedRegistry
- events: NamedRegistry
Returns CrossChainTransferCommand
Inherited from BaseCCCommand.constructor
- Defined in framework/src/modules/interoperability/base_cc_command.ts:34

Properties

`Private` _internalMethod

_internalMethod: InternalMethod

`Private` _tokenMethod

_tokenMethod: TokenMethod

`Protected` events

events: NamedRegistry

schema

schema: {
    $id: string;
    properties: {
        amount: {
            dataType: string;
            fieldNumber: number;
        };
        data: {
            dataType: string;
            fieldNumber: number;
            maxLength: number;
            minLength: number;
        };
        recipientAddress: {
            dataType: string;
            fieldNumber: number;
            format: string;
        };
        senderAddress: {
            dataType: string;
            fieldNumber: number;
            format: string;
        };
        tokenID: {
            dataType: string;
            fieldNumber: number;
            maxLength: number;
            minLength: number;
        };
    };
    required: string[];
    type: string;
} = crossChainTransferMessageParams

Type declaration

$id: string

The unique identifier of the schema.
properties: {
    amount: {
        dataType: string;
        fieldNumber: number;
    };
    data: {
        dataType: string;
        fieldNumber: number;
        maxLength: number;
        minLength: number;
    };
    recipientAddress: {
        dataType: string;
        fieldNumber: number;
        format: string;
    };
    senderAddress: {
        dataType: string;
        fieldNumber: number;
        format: string;
    };
    tokenID: {
        dataType: string;
        fieldNumber: number;
        maxLength: number;
        minLength: number;
    };
}

A list describing the available parameters for the CCM.
- amount: {
  dataType: string;
  fieldNumber: number;
  }
  
  Amount of tokens to be transferred in Beddows.
  - dataType: string
  - fieldNumber: number
- data: {
      dataType: string;
      fieldNumber: number;
      maxLength: number;
      minLength: number;
  }
  
  Optional field for data / messages.
  
  minLength is 0. maxLength` is MAX_DATA_LENGTH.
  - dataType: string
  - fieldNumber: number
  - maxLength: number
  - minLength: number
- recipientAddress: {
      dataType: string;
      fieldNumber: number;
      format: string;
  }
  
  Address of the recipient.
  - dataType: string
  - fieldNumber: number
  - format: string
- senderAddress: {
      dataType: string;
      fieldNumber: number;
      format: string;
  }
  
  Address of the sender.
  - dataType: string
  - fieldNumber: number
  - format: string
- tokenID: {
      dataType: string;
      fieldNumber: number;
      maxLength: number;
      minLength: number;
  }
  
  ID of the tokens being transferred. minLength and maxLength are TOKEN_ID_LENGTH.
  - dataType: string
  - fieldNumber: number
  - maxLength: number
  - minLength: number
required: string[]

The required parameters for the command.
type: string

`Protected` stores

stores: NamedRegistry

Accessors

name

get name(): string
Returns the command name: CROSS_CHAIN_COMMAND_NAME_TRANSFER

Returns string
Overrides BaseCCCommand.name
- Defined in framework/src/modules/token/cc_commands/cc_transfer.ts:43

Methods

execute

execute(ctx: CrossChainMessageContext): Promise<void>
Transfers the specified amount of tokens to the recipient account.

If the token being transferred is native to the receiving chain, it also subtracts the same amount of tokens from the respective escrow account.

For more info about the execute() method, please refer to the BaseCommand.
Parameters
- ctx: CrossChainMessageContext
Returns Promise<void>
Overrides BaseCCCommand.execute
- Defined in framework/src/modules/token/cc_commands/cc_transfer.ts:112

init

init(args: {
internalMethod: InternalMethod;
tokenMethod: TokenMethod;
}): void
The init() hook of a command is called by the Lisk Framework when the node starts.

In this context, you have the opportunity to validate and cache the module config or perform initializations that are intended to occur only once.

See
Command initialization
Parameters
- args: {
  internalMethod: InternalMethod;
  tokenMethod: TokenMethod;
  }
  
  Contains the module methods and internal module methods.
  - internalMethod: InternalMethod
  - tokenMethod: TokenMethod
Returns void
- Defined in framework/src/modules/token/cc_commands/cc_transfer.ts:56

verify

verify(ctx: CrossChainMessageContext): Promise<void>
Checks if the token is native on either the sending or the receiving chain.

If the token is native to the receiving chain, it additionally verifies whether the escrow account holds a sufficient balance to facilitate the transfer of the designated tokens.

For more info about the verify() method, please refer to the BaseCommand
Parameters
- ctx: CrossChainMessageContext
Returns Promise<void>
Overrides BaseCCCommand.verify
- Defined in framework/src/modules/token/cc_commands/cc_transfer.ts:70

Class CrossChainTransferCommand

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

stores: NamedRegistry

events: NamedRegistry

Returns CrossChainTransferCommand

Properties

Private _internalMethod

Private _tokenMethod

Protected events

schema

Type declaration

$id: string

amount: { dataType: string; fieldNumber: number; }

dataType: string

fieldNumber: number

data: { dataType: string; fieldNumber: number; maxLength: number; minLength: number; }

dataType: string

fieldNumber: number

maxLength: number

minLength: number

recipientAddress: { dataType: string; fieldNumber: number; format: string; }

dataType: string

fieldNumber: number

format: string

senderAddress: { dataType: string; fieldNumber: number; format: string; }

dataType: string

fieldNumber: number

format: string

tokenID: { dataType: string; fieldNumber: number; maxLength: number; minLength: number; }

dataType: string

fieldNumber: number

maxLength: number

minLength: number

required: string[]

type: string

Protected stores

Accessors

name

Returns string

Methods

execute

Parameters

ctx: CrossChainMessageContext

Returns Promise<void>

init

See

Parameters

args: { internalMethod: InternalMethod; tokenMethod: TokenMethod; }

internalMethod: InternalMethod

tokenMethod: TokenMethod

Returns void

verify

Parameters

ctx: CrossChainMessageContext

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Private` _internalMethod

`Private` _tokenMethod

`Protected` events

amount: {
dataType: string;
fieldNumber: number;
}

data: {
dataType: string;
fieldNumber: number;
maxLength: number;
minLength: number;
}

recipientAddress: {
dataType: string;
fieldNumber: number;
format: string;
}

senderAddress: {
dataType: string;
fieldNumber: number;
format: string;
}

tokenID: {
dataType: string;
fieldNumber: number;
maxLength: number;
minLength: number;
}

`Protected` stores

args: {
internalMethod: InternalMethod;
tokenMethod: TokenMethod;
}