Class NativeToken

Hierarchy

BaseFT
- NativeToken

Index

Constructors

Properties

Methods

getBalance toDecimal toUnits transfer

Constructors

constructor

new NativeToken(metadata: FTMetadata): NativeToken
Parameters
- metadata: FTMetadata
Returns NativeToken
Overrides BaseFT.constructor
- Defined in ft/index.ts:60

Properties

`Readonly`metadata

metadata: FTMetadata

Methods

getBalance

getBalance(account: AccountLike): Promise<bigint>
Get the available balance of an account in indivisible units
Parameters
- account: AccountLike
  The account to get the balance of
Returns Promise<bigint>
Overrides BaseFT.getBalance
- Defined in ft/index.ts:71

toDecimal

toDecimal(amount: string | number | bigint): string
Converts indivisible units to a decimal number (represented as a string)
Parameters
- amount: string | number | bigint
Returns string
The amount as a decimal string (e.g. "1.234")
Inherited from BaseFT.toDecimal
- Defined in ft/index.ts:36

toUnits

toUnits(amount: string | number): bigint
Converts a decimal number to indivisible units
Parameters
- amount: string | number
  The amount in decimal format (e.g. "1.234")
Returns bigint
The amount in indivisible units (e.g. "1234")
Inherited from BaseFT.toUnits
- Defined in ft/index.ts:25

transfer

transfer(
    param: {
        amount: string | number | bigint;
        from: AccountLike;
        receiverId: string;
    },
): Promise<any>
Transfer tokens from one account to another
Parameters
- param: { amount: string | number | bigint; from: AccountLike; receiverId: string }
  - amount: string | number | bigint
    The amount of tokens to transfer in the smallest unit
  - from: AccountLike
    The Account that will transfer the tokens
  - receiverId: string
    The AccountID that will receive the tokens
Returns Promise<any>
Overrides BaseFT.transfer
- Defined in ft/index.ts:64