Skip to content

AssetReference

An Algorand Standard Asset (ASA). asset ABI type when used as an argument or return type in a method, uint64 when in an array or state.

Extends

Constructors

new AssetReference()

new AssetReference(): AssetReference

Returns

AssetReference

Inherited from

AssetID.constructor

Properties

clawback

readonly clawback: Address

The clawback account that can take assets from any account

Inherited from

AssetID.clawback

Source

types/global.d.ts:424


creator

readonly creator: Address

The creator of the asset

Inherited from

AssetID.creator

Source

types/global.d.ts:427


decimals

readonly decimals: uint64

The number of decimal places to use when displaying the asset

Inherited from

AssetID.decimals

Source

types/global.d.ts:397


defaultFrozen

readonly defaultFrozen: boolean

Whether the asset is frozen by default when created

Inherited from

AssetID.defaultFrozen

Source

types/global.d.ts:400


freeze

readonly freeze: Address

The freeze account that can freeze or unfreeze other accounts holdings the asset

Inherited from

AssetID.freeze

Source

types/global.d.ts:421


id

readonly id: uint64

The asset index

Inherited from

AssetID.id

Source

types/global.d.ts:391


manager

readonly manager: Address

The manager that can update the maanger, freeze, and reserve accounts

Inherited from

AssetID.manager

Source

types/global.d.ts:415


metadataHash

readonly metadataHash: StaticBytes<32>

The hash of the assets metadata

Inherited from

AssetID.metadataHash

Source

types/global.d.ts:412


name

readonly name: string

The name of the asset. Must be 32 bytes or less.

Inherited from

AssetID.name

Source

types/global.d.ts:403


reserve

readonly reserve: Address

The reserve account that holds the assets that are not in circulation

Inherited from

AssetID.reserve

Source

types/global.d.ts:418


total

readonly total: uint64

The total number of units of the asset

Inherited from

AssetID.total

Source

types/global.d.ts:394


unitName

readonly unitName: string

The short (ticker) name of the asset (ie. USDC)

Inherited from

AssetID.unitName

Source

types/global.d.ts:406


url

readonly url: string

The URL of the assets metadata

Inherited from

AssetID.url

Source

types/global.d.ts:409


zeroIndex

static readonly zeroIndex: AssetID

Asset index 0. Only useful for input validation.

Inherited from

AssetID.zeroIndex

Source

types/global.d.ts:388

Methods

fromUint64()

static fromUint64(index): AssetID

Get an Asset instance for the ASA with the given asset index

Parameters

index: uint64

Returns

AssetID

Inherited from

AssetID.fromUint64

Source

types/global.d.ts:385