CreateAssetParams
@algorandfoundation/algokit-utils / types/asset / CreateAssetParams
types/asset.CreateAssetParams
Deprecated
Parameters for createAsset call.
Hierarchy
-
↳
CreateAssetParams
Table of contents
Properties
- atc
- clawbackAccount
- creator
- decimals
- fee
- freezeAccount
- frozenByDefault
- lease
- manager
- maxFee
- maxRoundsToWaitForConfirmation
- metadataHash
- name
- note
- populateAppCallResources
- reserveAccount
- skipSending
- skipWaiting
- suppressLog
- total
- transactionParams
- unit
- url
Properties
atc
• Optional atc: AtomicTransactionComposer
An optional AtomicTransactionComposer to add the transaction to, if specified then skipSending: undefined has the same effect as skipSending: true
Inherited from
Defined in
clawbackAccount
• Optional clawbackAccount: string | SendTransactionFrom
The optional account that can clawback holdings of this asset. If empty, clawback is not permitted. If not set at asset creation or subsequently set to empty by the manager the field is permanently empty.
Defined in
creator
• creator: SendTransactionFrom
The account to create the asset.
This account automatically is opted in to the asset and holds all units after creation.
Defined in
decimals
• decimals: number
The number of digits to use after the decimal point when displaying the 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. If 3, the base unit of the asset is in thousandths, and so on up to 19 decimal places. This field can only be specified upon asset creation.
Defined in
fee
• Optional fee: AlgoAmount
The flat fee you want to pay, useful for covering extra fees in a transaction group or app call
Inherited from
Defined in
freezeAccount
• Optional freezeAccount: string | SendTransactionFrom
The optional account that can be used to freeze holdings of this asset. If empty, freezing is not permitted. If not set at asset creation or subsequently set to empty by the manager the field is permanently empty.
Defined in
frozenByDefault
• Optional frozenByDefault: boolean
Whether to freeze holdings for this asset by default. If true then for anyone apart from the creator to hold the asset it needs to be unfrozen per account using freeze. Defaults to false.
Defined in
lease
• Optional lease: string | Uint8Array
An (optional) transaction lease to apply
Defined in
manager
• Optional manager: string | SendTransactionFrom
The optional account that can manage the configuration of the asset and destroy it. If not set at asset creation or subsequently set to empty by the manager the asset becomes immutable.
Defined in
maxFee
• Optional maxFee: AlgoAmount
The maximum fee that you are happy to pay (default: unbounded) - if this is set it’s possible the transaction could get rejected during network congestion
Inherited from
Defined in
maxRoundsToWaitForConfirmation
• Optional maxRoundsToWaitForConfirmation: number
The maximum number of rounds to wait for confirmation, only applies if skipWaiting is undefined or false, default: wait up to 5 rounds
Inherited from
SendTransactionParams.maxRoundsToWaitForConfirmation
Defined in
metadataHash
• Optional metadataHash: string | Uint8Array
This field is intended to be a 32-byte hash of some metadata that is relevant to your asset and/or asset holders. The format of this metadata is up to the application. This field can only be specified upon asset creation.
Defined in
name
• Optional name: string
The optional name of the asset. Max size if 32 bytes. This field can only be specified upon asset creation.
Defined in
note
• Optional note: TransactionNote
The (optional) transaction note
Defined in
populateAppCallResources
• Optional populateAppCallResources: boolean
Whether to use simulate to automatically populate app call resources in the txn objects. Defaults to true when there are app calls in the group.
Inherited from
SendTransactionParams.populateAppCallResources
Defined in
reserveAccount
• Optional reserveAccount: string | SendTransactionFrom
The optional account that holds the reserve (non-minted) units of the asset. This address has no specific authority in the protocol itself and is informational. Some standards like ARC-19 rely on this field to hold meaningful data. It is used in the case where you want to signal to holders of your asset that the non-minted units of the asset reside in an account that is different from the default creator account. If not set at asset creation or subsequently set to empty by the manager the field is permanently empty.
Defined in
skipSending
• Optional skipSending: boolean
Whether to skip signing and sending the transaction to the chain (default: transaction signed and sent to chain, unless atc specified)
and instead just return the raw transaction, e.g. so you can add it to a group of transactions
Inherited from
SendTransactionParams.skipSending
Defined in
skipWaiting
• Optional skipWaiting: boolean
Whether to skip waiting for the submitted transaction (only relevant if skipSending is false or unset)
Inherited from
SendTransactionParams.skipWaiting
Defined in
suppressLog
• Optional suppressLog: boolean
Whether to suppress log messages from transaction send, default: do not suppress
Inherited from
SendTransactionParams.suppressLog
Defined in
total
• total: number | bigint
The total number of base (decimal) units of the asset to create.
If decimal is, say, 2, then for every 100 total there would be 1 whole unit.
This field can only be specified upon asset creation.
Defined in
transactionParams
• Optional transactionParams: SuggestedParams
Optional transaction parameters
Defined in
unit
• Optional unit: string
The optional name of the unit of this asset. Max size is 8 bytes. This field can only be specified upon asset creation.
Defined in
url
• Optional url: string
Specifies an optional URL where more information about the asset can be retrieved. Max size is 96 bytes. This field can only be specified upon asset creation.