Asset

@algorandfoundation/algorand-typescript

---

@algorandfoundation/algorand-typescript / index / Asset

Type Alias: Asset

Asset: object

Defined in: packages/algo-ts/src/reference.ts:122

An Asset on the Algorand network.

Type declaration

clawback

readonly clawback: Account

Clawback address

creator

readonly creator: Account

Creator address

decimals

readonly decimals: uint64

See

AssetParams.decimals

defaultFrozen

readonly defaultFrozen: boolean

Frozen by default or not

freeze

readonly freeze: Account

Freeze address

id

readonly id: uint64

Returns the id of the Asset

manager

readonly manager: Account

Manager address

metadataHash

readonly metadataHash: bytes

Arbitrary commitment

name

readonly name: bytes

Asset name

reserve

readonly reserve: Account

Reserve address

total

readonly total: uint64

Total number of units of this asset

unitName

readonly unitName: bytes

Asset unit name

url

readonly url: bytes

URL with additional info about the asset

balance()

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

frozen()

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