Class TokenTransfer

constructor

• new TokenTransfer(options): TokenTransfer

• Parameters

  • options: ILegacyTokenTransferOptions | {
        amount: bigint;
        token: Token;
    }

  Returns TokenTransfer

Readonly amount

Readonly amountAsBigInteger

Readonly nonce

Readonly numDecimals

Readonly token

Readonly tokenIdentifier

isEgld

• isEgld(): boolean

• Legacy function. Within your code, don't mix native values (EGLD) and custom (ESDT) tokens. See "TransferTransactionsFactory.createTransactionForNativeTokenTransfer()" vs. "TransferTransactionsFactory.createTransactionForESDTTokenTransfer()".

  Returns boolean

isFungible

• isFungible(): boolean

• Legacy function. Use "TokenComputer.isFungible(token)" instead.

  Returns boolean

toPrettyString

• toPrettyString(): string

• Legacy function. For formatting and parsing amounts, use "sdk-dapp" or "bignumber.js" directly.

  Returns string

toString

• toString(): string

• Returns string

valueOf

• valueOf(): BigNumber

• Legacy function. Use the "amount" field instead.

  Returns BigNumber

Static egldFromAmount

• egldFromAmount(amount): TokenTransfer

• Legacy function. Use the constructor instead: new TokenTransfer({ token, amount });

  Parameters

  • amount: Value

  Returns TokenTransfer

Static egldFromBigInteger

• egldFromBigInteger(amountAsBigInteger): TokenTransfer

• Legacy function. Use the constructor instead: new TokenTransfer({ token, amount });

  Parameters

  • amountAsBigInteger: Value

  Returns TokenTransfer

Static fungibleFromAmount

• fungibleFromAmount(tokenIdentifier, amount, numDecimals): TokenTransfer

• Legacy function. Use the constructor instead: new TokenTransfer({ token, amount });

  Parameters

  • tokenIdentifier: string
  • amount: Value
  • numDecimals: number

  Returns TokenTransfer

Static fungibleFromBigInteger

• fungibleFromBigInteger(tokenIdentifier, amountAsBigInteger, numDecimals?): TokenTransfer

• Legacy function. Use the constructor instead: new TokenTransfer({ token, amount });

  Parameters

  • tokenIdentifier: string
  • amountAsBigInteger: Value
  • numDecimals: number = 0

  Returns TokenTransfer

Static metaEsdtFromAmount

• metaEsdtFromAmount(tokenIdentifier, nonce, amount, numDecimals): TokenTransfer

• Legacy function. Use the constructor instead: new TokenTransfer({ token, amount });

  Parameters

  • tokenIdentifier: string
  • nonce: number
  • amount: Value
  • numDecimals: number

  Returns TokenTransfer

Static metaEsdtFromBigInteger

• metaEsdtFromBigInteger(tokenIdentifier, nonce, amountAsBigInteger, numDecimals?): TokenTransfer

• Legacy function. Use the constructor instead: new TokenTransfer({ token, amount });

  Parameters

  • tokenIdentifier: string
  • nonce: number
  • amountAsBigInteger: Value
  • numDecimals: number = 0

  Returns TokenTransfer

Static nonFungible

• nonFungible(tokenIdentifier, nonce): TokenTransfer

• Legacy function. Use the constructor instead: new TokenTransfer({ token, amount });

  Parameters

  • tokenIdentifier: string
  • nonce: number

  Returns TokenTransfer

Static semiFungible

• semiFungible(tokenIdentifier, nonce, quantity): TokenTransfer

• Legacy function. Use the constructor instead: new TokenTransfer({ token, amount });

  Parameters

  • tokenIdentifier: string
  • nonce: number
  • quantity: number

  Returns TokenTransfer