types asset.AssetOptOutParams
@algorandfoundation/algokit-utils / types/asset / AssetOptOutParams
Interface: AssetOptOutParams¶
types/asset.AssetOptOutParams
Parameters for assetOptOut call.
Hierarchy¶
↳ AssetOptOutParams
Table of contents¶
Properties¶
- account
- assetCreatorAddress
- assetId
- atc
- ensureZeroBalance
- fee
- lease
- maxFee
- maxRoundsToWaitForConfirmation
- note
- populateAppCallResources
- skipSending
- skipWaiting
- suppressLog
- transactionParams
Properties¶
account¶
• account: SendTransactionFrom
The account to opt in/out for
Inherited from¶
Defined in¶
assetCreatorAddress¶
• Optional assetCreatorAddress: string
The address of the creator account for the asset; if unspecified then it looks it up using algod
Defined in¶
assetId¶
• assetId: number
The ID of the assets to opt in for / out of
Inherited from¶
Defined in¶
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¶
ensureZeroBalance¶
• Optional ensureZeroBalance: boolean
Whether or not to validate the account has a zero-balance before issuing the opt-out; default = true
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¶
lease¶
• Optional lease: string | Uint8Array
An (optional) transaction lease to apply
Inherited from¶
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¶
AssetOptInParams.maxRoundsToWaitForConfirmation
Defined in¶
note¶
• Optional note: TransactionNote
The (optional) transaction note
Inherited from¶
Defined in¶
populateAppCallResources¶
• Optional populateAppCallResources: boolean
WARNING: Not recommended for production use due to https://github.com/algorand/go-algorand/issues/5914. 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¶
AssetOptInParams.populateAppCallResources
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¶
Defined in¶
skipWaiting¶
• Optional skipWaiting: boolean
Whether to skip waiting for the submitted transaction (only relevant if skipSending is false or unset)
Inherited from¶
Defined in¶
suppressLog¶
• Optional suppressLog: boolean
Whether to suppress log messages from transaction send, default: do not suppress
Inherited from¶
Defined in¶
transactionParams¶
• Optional transactionParams: SuggestedParams
Optional transaction parameters
Inherited from¶
AssetOptInParams.transactionParams