$AssetParams

const $AssetParams: object

Type declaration

description

readonly description: “AssetParams specifies the parameters for an asset.\n\n[apar] when part of an AssetConfig transaction.\n\nDefinition:\ndata/transactions/asset.go : AssetParams”

properties

readonly properties: object

properties.clawback

readonly properties.clawback: object

properties.clawback.description

readonly properties.clawback.description: ”\[c\] Address of account used to clawback holdings of this asset. If empty, clawback is not permitted.” = '\\[c\\] Address of account used to clawback holdings of this asset. If empty, clawback is not permitted.'

properties.clawback.type

readonly properties.clawback.type: "string" = 'string'

properties.creator

readonly properties.creator: object

properties.creator.description

readonly properties.creator.description: "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." = '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.'

properties.creator.type

readonly properties.creator.type: "string" = 'string'

properties.decimals

readonly properties.decimals: object

properties.decimals.description

readonly properties.decimals.description: ”\[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).” = '\\[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).'

properties.decimals.maximum

readonly properties.decimals.maximum: 19 = 19

properties.decimals.minimum

readonly properties.decimals.minimum: 0 = 0

properties.decimals.type

readonly properties.decimals.type: "integer" = 'integer'

properties.default-frozen

readonly properties.default-frozen: object

properties.default-frozen.description

readonly properties.default-frozen.description: ”\[df\] Whether holdings of this asset are frozen by default.” = '\\[df\\] Whether holdings of this asset are frozen by default.'

properties.default-frozen.type

readonly properties.default-frozen.type: "boolean" = 'boolean'

properties.freeze

readonly properties.freeze: object

properties.freeze.description

readonly properties.freeze.description: ”\[f\] Address of account used to freeze holdings of this asset. If empty, freezing is not permitted.” = '\\[f\\] Address of account used to freeze holdings of this asset. If empty, freezing is not permitted.'

properties.freeze.type

readonly properties.freeze.type: "string" = 'string'

properties.manager

readonly properties.manager: object

properties.manager.description

readonly properties.manager.description: ”\[m\] Address of account used to manage the keys of this asset and to destroy it.” = '\\[m\\] Address of account used to manage the keys of this asset and to destroy it.'

properties.manager.type

readonly properties.manager.type: "string" = 'string'

properties.metadata-hash

readonly properties.metadata-hash: object

properties.metadata-hash.description

readonly properties.metadata-hash.description: ”\[am\] A commitment to some unspecified asset metadata. The format of this metadata is up to the application.” = '\\[am\\] A commitment to some unspecified asset metadata. The format of this metadata is up to the application.'

properties.metadata-hash.format

readonly properties.metadata-hash.format: "byte" = 'byte'

properties.metadata-hash.pattern

readonly properties.metadata-hash.pattern: ”^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$” = '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$'

properties.metadata-hash.type

readonly properties.metadata-hash.type: "string" = 'string'

properties.name

readonly properties.name: object

properties.name.description

readonly properties.name.description: ”\[an\] Name of this asset, as supplied by the creator. Included only when the asset name is composed of printable utf-8 characters.” = '\\[an\\] Name of this asset, as supplied by the creator. Included only when the asset name is composed of printable utf-8 characters.'

properties.name.type

readonly properties.name.type: "string" = 'string'

properties.name-b64

readonly properties.name-b64: object

properties.name-b64.description

readonly properties.name-b64.description: "Base64 encoded name of this asset, as supplied by the creator." = 'Base64 encoded name of this asset, as supplied by the creator.'

properties.name-b64.format

readonly properties.name-b64.format: "byte" = 'byte'

properties.name-b64.pattern

readonly properties.name-b64.pattern: ”^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$” = '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$'

properties.name-b64.type

readonly properties.name-b64.type: "string" = 'string'

properties.reserve

readonly properties.reserve: object

properties.reserve.description

readonly properties.reserve.description: ”\[r\] Address of account holding reserve (non-minted) units of this asset.” = '\\[r\\] Address of account holding reserve (non-minted) units of this asset.'

properties.reserve.type

readonly properties.reserve.type: "string" = 'string'

properties.total

readonly properties.total: object

properties.total.description

readonly properties.total.description: ”\[t\] The total number of units of this asset.” = '\\[t\\] The total number of units of this asset.'

properties.total.type

readonly properties.total.type: "integer" = 'integer'

properties.total.x-algorand-format

readonly properties.total.x-algorand-format: "uint64" = 'uint64'

properties.unit-name

readonly properties.unit-name: object

properties.unit-name.description

readonly properties.unit-name.description: ”\[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.” = '\\[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.'

properties.unit-name.type

readonly properties.unit-name.type: "string" = 'string'

properties.unit-name-b64

readonly properties.unit-name-b64: object

properties.unit-name-b64.description

readonly properties.unit-name-b64.description: "Base64 encoded name of a unit of this asset, as supplied by the creator." = 'Base64 encoded name of a unit of this asset, as supplied by the creator.'

properties.unit-name-b64.format

readonly properties.unit-name-b64.format: "byte" = 'byte'

properties.unit-name-b64.pattern

readonly properties.unit-name-b64.pattern: ”^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$” = '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$'

properties.unit-name-b64.type

readonly properties.unit-name-b64.type: "string" = 'string'

properties.url

readonly properties.url: object

properties.url.description

readonly properties.url.description: ”\[au\] URL where more information about the asset can be retrieved. Included only when the URL is composed of printable utf-8 characters.” = '\\[au\\] URL where more information about the asset can be retrieved. Included only when the URL is composed of printable utf-8 characters.'

properties.url.type

readonly properties.url.type: "string" = 'string'

properties.url-b64

readonly properties.url-b64: object

properties.url-b64.description

readonly properties.url-b64.description: "Base64 encoded URL where more information about the asset can be retrieved." = 'Base64 encoded URL where more information about the asset can be retrieved.'

properties.url-b64.format

readonly properties.url-b64.format: "byte" = 'byte'

properties.url-b64.pattern

readonly properties.url-b64.pattern: ”^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$” = '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$'

properties.url-b64.type

readonly properties.url-b64.type: "string" = 'string'

required

readonly required: readonly ["creator", "decimals", "total"]

type

readonly type: "object" = 'object'

Defined in

schemas.gen.ts:483