Class TransferCrossChainCommand

The transfer command of the TokenModule transfers tokens from one account to another account on a different chain.

  • name: transferCrossChain
  • module: token

Hierarchy

Constructors

constructor

Properties

_internalMethod _interoperabilityMethod _method _moduleName events schema stores

Accessors

name

Methods

execute init verify

Constructors

constructor

Properties

Private _internalMethod

_internalMethod: InternalMethod

Private _interoperabilityMethod

_interoperabilityMethod: InteroperabilityMethod

Private _method

_method: TokenMethod

Private _moduleName

_moduleName: string

Protected events

events: NamedRegistry

schema

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

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;
        };
        messageFee: {
            dataType: string;
            fieldNumber: number;
        };
        messageFeeTokenID: {
            dataType: string;
            fieldNumber: number;
            maxLength: number;
            minLength: number;
        };
        receivingChainID: {
            dataType: string;
            fieldNumber: number;
            maxLength: number;
            minLength: number;
        };
        recipientAddress: {
            dataType: string;
            fieldNumber: number;
            format: string;
        };
        tokenID: {
            dataType: string;
            fieldNumber: number;
            maxLength: number;
            minLength: number;
        };
    }

    A list describing the available parameters for the command.

    • 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.

      maxLength is MAX_DATA_LENGTH.

      • dataType: string
      • fieldNumber: number
      • maxLength: number
      • minLength: number
    • messageFee: {
          dataType: string;
          fieldNumber: number;
      }
      • dataType: string
      • fieldNumber: number
    • messageFeeTokenID: {
          dataType: string;
          fieldNumber: number;
          maxLength: number;
          minLength: number;
      }
      • dataType: string
      • fieldNumber: number
      • maxLength: number
      • minLength: number
    • receivingChainID: {
          dataType: string;
          fieldNumber: number;
          maxLength: number;
          minLength: number;
      }

      The chain ID of the receiving chain.

      maxLength and minLength are equal to CHAIN_ID_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
    • 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

Methods

execute

init

  • 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;
          interoperabilityMethod: InteroperabilityMethod;
          method: TokenMethod;
          moduleName: string;
      }

      Contains the module methods and internal module methods.

      • internalMethod: InternalMethod
      • interoperabilityMethod: InteroperabilityMethod
      • method: TokenMethod
      • moduleName: string

    Returns void

verify

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc