AssetOptOutParams
@algorandfoundation/algokit-utils / types/asset / AssetOptOutParams
types/asset.AssetOptOutParams
Deprecated
Parameters for assetOptOut call.
Hierarchy
Section titled “Hierarchy”-
↳
AssetOptOutParams
Table of contents
Section titled “Table of contents”Properties
Section titled “Properties”- account
- assetCreatorAddress
- assetId
- atc
- ensureZeroBalance
- fee
- lease
- maxFee
- maxRoundsToWaitForConfirmation
- note
- populateAppCallResources
- skipSending
- skipWaiting
- suppressLog
- transactionParams
Properties
Section titled “Properties”account
Section titled “account”• account: SendTransactionFrom
The account to opt in/out for
Inherited from
Section titled “Inherited from”Defined in
Section titled “Defined in”assetCreatorAddress
Section titled “assetCreatorAddress”• Optional assetCreatorAddress: string
The address of the creator account for the asset; if unspecified then it looks it up using algod
Defined in
Section titled “Defined in”assetId
Section titled “assetId”• assetId: number
The ID of the assets to opt in for / out of
Inherited from
Section titled “Inherited from”Defined in
Section titled “Defined in”• 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”ensureZeroBalance
Section titled “ensureZeroBalance”• Optional ensureZeroBalance: boolean
Whether or not to validate the account has a zero-balance before issuing the opt-out; default = true
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”• Optional lease: string | Uint8Array
An (optional) transaction lease to apply
Inherited from
Section titled “Inherited from”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”AssetOptInParams.maxRoundsToWaitForConfirmation
Defined in
Section titled “Defined in”• Optional note: TransactionNote
The (optional) transaction note
Inherited from
Section titled “Inherited from”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”AssetOptInParams.populateAppCallResources
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”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”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”Defined in
Section titled “Defined in”transactionParams
Section titled “transactionParams”• Optional transactionParams: SuggestedParams
Optional transaction parameters
Inherited from
Section titled “Inherited from”AssetOptInParams.transactionParams