• Public
  • Public/Protected
  • All

Interface TransferAssetArgs

The argument object for AssetApi.transferAsset




Optional amountPlanck

amountPlanck: string

The amount to be sent as Planck value


assetId: string

The assets id to be transferred

Optional attachment

attachment: Attachment

An optional attachment

Optional deadline

deadline: number

The deadline when after how many minutes the transaction will be discarded, if it was not processed, e.g. due to very low fee


feePlanck: string

The fee expressed in Planck


It's recommended to use util.Amount


quantity: string | number

The amount of assets to be transferred (take the decimals into consideration) If you set decimals to 4 and want to have 100 full assets, you need to set this value to 1000000


recipientId: string

The id of the recipient

Optional recipientPublicKey

recipientPublicKey: string

The optional recipients public key in hex format.

Optional referencedTransactionFullHash

referencedTransactionFullHash: string

Using this field allows to make a transaction dependent on other transactions.

Optional senderPrivateKey

senderPrivateKey: string

The senders private key, i.e. the crypto.Keys.signPrivateKey If the private key is not given, then the transaction method will return the unsigned byte string. The transaction won't be processed until the unsigned bytes are being signed and broadcasted using TransactionApi.signAndBroadcastTransaction


senderPublicKey: string

The senders public key, i.e. the crypto.Keys.publicKey

Optional skipAdditionalSecurityCheck

skipAdditionalSecurityCheck: boolean

Setting this option to true, skips the additional security check, i.e. the verification of the unsigned transaction bytes, which detects tampered node responses. By default, the option is false. Usually, you won't use this option, but can be useful when a method cannot be verified, because the verification is not implemented yet.