Type Alias Asset

An Asset on the Algorand network.

type Asset = {
    clawback: Account;
    creator: Account;
    decimals: uint64;
    defaultFrozen: boolean;
    freeze: Account;
    id: uint64;
    manager: Account;
    metadataHash: bytes;
    name: bytes;
    reserve: Account;
    total: uint64;
    unitName: bytes;
    url: bytes;
    balance(account: Account): uint64;
    frozen(account: Account): boolean;
}

Index

Properties

clawback creator decimals defaultFrozen freeze id manager metadataHash name reserve total unitName url

Methods

Properties

`Readonly`clawback

clawback: Account

Clawback address

`Readonly`creator

creator: Account

Creator address

`Readonly`decimals

decimals: uint64

See

AssetParams.decimals

`Readonly`defaultFrozen

defaultFrozen: boolean

Frozen by default or not

`Readonly`freeze

freeze: Account

Freeze address

`Readonly`id

Returns the id of the Asset

`Readonly`manager

manager: Account

Manager address

`Readonly`metadataHash

metadataHash: bytes

Arbitrary commitment

`Readonly`name

name: bytes

Asset name

`Readonly`reserve

reserve: Account

Reserve address

`Readonly`total

total: uint64

Total number of units of this asset

`Readonly`unitName

unitName: bytes

Asset unit name

`Readonly`url

url: bytes

URL with additional info about the asset

Methods

balance

balance(account: Account): uint64
Amount of the asset unit held by this account. Fails if the account has not opted in to the asset. Asset and supplied Account must be an available resource
Parameters
- account: Account
  Account
Returns uint64
balance: uint64
- Defined in packages/algo-ts/src/reference.ts:213

frozen

frozen(account: Account): boolean
Is the asset frozen or not. Fails if the account has not opted in to the asset. Asset and supplied Account must be an available resource
Parameters
- account: Account
  Account
Returns boolean
isFrozen: boolean
- Defined in packages/algo-ts/src/reference.ts:222