CreateAssetParams
@algorandfoundation/algokit-utils / types/asset / CreateAssetParams
types/asset.CreateAssetParams
Deprecated
Parameters for createAsset call.
Hierarchy
Section titled “Hierarchy”-
↳
CreateAssetParams
Table of contents
Section titled “Table of contents”Properties
Section titled “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
Section titled “Properties”• 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
Section titled “Inherited from”Defined in
Section titled “Defined in”clawbackAccount
Section titled “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
Section titled “Defined in”creator
Section titled “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
Section titled “Defined in”decimals
Section titled “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
Section titled “Defined in”• Optional fee: AlgoAmount
The flat fee you want to pay, useful for covering extra fees in a transaction group or app call
Inherited from
Section titled “Inherited from”Defined in
Section titled “Defined in”freezeAccount
Section titled “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
Section titled “Defined in”frozenByDefault
Section titled “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
Section titled “Defined in”• Optional lease: string | Uint8Array
An (optional) transaction lease to apply
Defined in
Section titled “Defined in”manager
Section titled “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
Section titled “Defined in”maxFee
Section titled “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
Section titled “Inherited from”Defined in
Section titled “Defined in”maxRoundsToWaitForConfirmation
Section titled “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
Section titled “Inherited from”SendTransactionParams.maxRoundsToWaitForConfirmation
Defined in
Section titled “Defined in”metadataHash
Section titled “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
Section titled “Defined in”• 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
Section titled “Defined in”• Optional note: TransactionNote
The (optional) transaction note
Defined in
Section titled “Defined in”populateAppCallResources
Section titled “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
Section titled “Inherited from”SendTransactionParams.populateAppCallResources
Defined in
Section titled “Defined in”reserveAccount
Section titled “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
Section titled “Defined in”skipSending
Section titled “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
Section titled “Inherited from”SendTransactionParams.skipSending
Defined in
Section titled “Defined in”skipWaiting
Section titled “skipWaiting”• Optional skipWaiting: boolean
Whether to skip waiting for the submitted transaction (only relevant if skipSending is false or unset)
Inherited from
Section titled “Inherited from”SendTransactionParams.skipWaiting
Defined in
Section titled “Defined in”suppressLog
Section titled “suppressLog”• Optional suppressLog: boolean
Whether to suppress log messages from transaction send, default: do not suppress
Inherited from
Section titled “Inherited from”SendTransactionParams.suppressLog
Defined in
Section titled “Defined in”• 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
Section titled “Defined in”transactionParams
Section titled “transactionParams”• Optional transactionParams: SuggestedParams
Optional transaction parameters
Defined in
Section titled “Defined in”• 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
Section titled “Defined in”• 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.