types indexer.AssetParams
@algorandfoundation/algokit-utils / types/indexer / AssetParams
Interface: AssetParams¶
types/indexer.AssetParams
AssetParams specifies the parameters for an asset. https://developer.algorand.org/docs/rest-apis/indexer/#assetparams
Table of contents¶
Properties¶
- clawback
- creator
- decimals
- default-frozen
- freeze
- manager
- metadata-hash
- name
- name-b64
- reserve
- total
- unit-name
- unit-name-b64
- url
- url-b64
Properties¶
clawback¶
• Optional clawback: string
© Address of account used to clawback holdings of this asset. If empty, clawback is not permitted.
Defined in¶
creator¶
• creator: string
The address that created this asset. This is the address where the parameters for this asset can be found, and also the address where unwanted asset units can be sent in the worst case.
Defined in¶
decimals¶
• decimals: number | bigint
(dc) The number of digits to use after the decimal point when displaying this asset. If 0, the asset is not divisible. If 1, the base unit of the asset is in tenths. If 2, the base unit of the asset is in hundredths, and so on. This value must be between 0 and 19 (inclusive).
Defined in¶
default-frozen¶
• Optional default-frozen: boolean
(df) Whether holdings of this asset are frozen by default.
Defined in¶
freeze¶
• Optional freeze: string
(f) Address of account used to freeze holdings of this asset. If empty, freezing is not permitted.
Defined in¶
manager¶
• Optional manager: string
(m) Address of account used to manage the keys of this asset and to destroy it.
Defined in¶
metadata-hash¶
• Optional metadata-hash: Uint8Array
(am) A commitment to some unspecified asset metadata. The format of this metadata is up to the application.
Defined in¶
name¶
• Optional name: string
(an) Name of this asset, as supplied by the creator. Included only when the asset name is composed of printable utf-8 characters.
Defined in¶
name-b64¶
• Optional name-b64: Uint8Array
Base64 encoded name of this asset, as supplied by the creator.
Defined in¶
reserve¶
• Optional reserve: string
® Address of account holding reserve (non-minted) units of this asset.
Defined in¶
total¶
• total: number | bigint
(t) The total number of units of this asset.
Defined in¶
unit-name¶
• Optional unit-name: string
(un) Name of a unit of this asset, as supplied by the creator. Included only when the name of a unit of this asset is composed of printable utf-8 characters.
Defined in¶
unit-name-b64¶
• Optional unit-name-b64: Uint8Array
Base64 encoded name of a unit of this asset, as supplied by the creator.
Defined in¶
url¶
• Optional url: string
(au) URL where more information about the asset can be retrieved. Included only when the URL is composed of printable utf-8 characters.
Defined in¶
url-b64¶
• Optional url-b64: Uint8Array
Base64 encoded URL where more information about the asset can be retrieved.