Function transfer

  • Transfers tokens from the sender to the specified recipients.

    Returns

    A promise that resolves to the transaction hash.

    Throws

    If opts.validate and any token amount is not compatible with the token.

    Throws

    If opts.validate and the sender does not have enough tokens.

    Throws

    If opts.validate and a sender or receiver is not allowed to send/receive tokens.

    Throws

    If opts.validate and the token is paused.

    Parameters

    • token: Token

      The token to transfer.

    • sender: AccountAddress

      The account address of the sender.

    • payload: TransferInput | TransferInput[]

      The transfer payload.

    • signer: AccountSigner

      The signer responsible for signing the transaction.

    • Optional metadata: TokenUpdateMetadata
    • Optional [opts={: TransferOtions = {}

      autoScale: true, validate: false }] - Options for the transfer.

    Returns Promise<Type>

Settings

Member Visibility

Theme

Generated using TypeDoc