Class FungibleToken

constructor

• new FungibleToken(accountId: string, metadata: FTMetadata): FungibleToken

  Parameters

  • accountId: string
  • metadata: FTMetadata

  Returns FungibleToken

ReadonlyaccountId

getBalance

• getBalance(account: Account): Promise<bigint>

  Get the available balance of an account in indivisible units

  Parameters

  • account: Account

    The account to get the balance of

  Returns Promise<bigint>

registerAccount

• registerAccount(
      param: { accountIdToRegister: string; fundingAccount: Account },
  ): Promise<any>

  Register an account to the fungible token contract by paying a storage deposit

  Parameters

  • param: { accountIdToRegister: string; fundingAccount: Account }

    • accountIdToRegister: string

      The AccountID to register

    • fundingAccount: Account

      The Account that will fund the registration

  Returns Promise<any>

transfer

• transfer(
      param: {
          amount: string | number | bigint;
          from: Account;
          receiverId: string;
      },
  ): Promise<any>

  Transfer tokens from one account to another

  Parameters

  • param: { amount: string | number | bigint; from: Account; receiverId: string }

    • amount: string | number | bigint

      The amount of tokens to transfer in the smallest unit

    • from: Account

      The Account that will transfer the tokens

    • receiverId: string

      The AccountID that will receive the tokens

  Returns Promise<any>

transferCall

• transferCall(
      param: {
          amount: bigint;
          from: Account;
          msg: string;
          receiverId: string;
      },
  ): Promise<any>

  Transfer tokens and call a function on the receiver contract, only works if the receiver implements the ft_on_transfer method

  Parameters

  • param: { amount: bigint; from: Account; msg: string; receiverId: string }

    Transfer call parameters

    • amount: bigint

      The amount of tokens to transfer in the smallest unit

    • from: Account

      The Account that will transfer the tokens

    • msg: string

      The message to send to the ft_on_transfer method

    • receiverId: string

      The AccountID that will receive the tokens

  Returns Promise<any>

unregisterAccount

• unregisterAccount(param: { account: Account; force: boolean }): Promise<any>

  Unregister an account from the fungible token contract by paying a storage deposit

  Parameters

  • param: { account: Account; force: boolean }

    • account: Account

      The Account to unregister

    • force: boolean

      Whether to remove the account without claiming the storage deposit

  Returns Promise<any>