Skip to content

Create Publication

We are looking for publications that demonstrate building dApps or smart contracts!
See the full list of Gitcoin bounties that are eligible for rewards.

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

Properties

clawback

Optional clawback: string

© Address of account used to clawback holdings of this asset. If empty, clawback is not permitted.

Defined in

src/types/indexer.ts:525


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

src/types/indexer.ts:509


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

src/types/indexer.ts:516


default-frozen

Optional default-frozen: boolean

(df) Whether holdings of this asset are frozen by default.

Defined in

src/types/indexer.ts:529


freeze

Optional freeze: string

(f) Address of account used to freeze holdings of this asset. If empty, freezing is not permitted.

Defined in

src/types/indexer.ts:534


manager

Optional manager: string

(m) Address of account used to manage the keys of this asset and to destroy it.

Defined in

src/types/indexer.ts:538


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

src/types/indexer.ts:543


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

src/types/indexer.ts:548


name-b64

Optional name-b64: Uint8Array

Base64 encoded name of this asset, as supplied by the creator.

Defined in

src/types/indexer.ts:552


reserve

Optional reserve: string

® Address of account holding reserve (non-minted) units of this asset.

Defined in

src/types/indexer.ts:556


total

total: number | bigint

(t) The total number of units of this asset.

Defined in

src/types/indexer.ts:520


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

src/types/indexer.ts:561


unit-name-b64

Optional unit-name-b64: Uint8Array

Base64 encoded name of a unit of this asset, as supplied by the creator.

Defined in

src/types/indexer.ts:565


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

src/types/indexer.ts:570


url-b64

Optional url-b64: Uint8Array

Base64 encoded URL where more information about the asset can be retrieved.

Defined in

src/types/indexer.ts:574