AssetOptOutParams
Defined in: algokit-utils-ts/src/types/asset.ts:84
Extends
Section titled “Extends”Properties
Section titled “Properties”account
Section titled “account”account:
SendTransactionFrom
Defined in: algokit-utils-ts/src/types/asset.ts:72
The account to opt in/out for
Inherited from
Section titled “Inherited from”assetCreatorAddress?
Section titled “assetCreatorAddress?”
optionalassetCreatorAddress?:string
Defined in: algokit-utils-ts/src/types/asset.ts:86
The address of the creator account for the asset; if unspecified then it looks it up using algod
assetId
Section titled “assetId”assetId:
number
Defined in: algokit-utils-ts/src/types/asset.ts:74
The ID of the assets to opt in for / out of
Inherited from
Section titled “Inherited from”
optionalatc?:AtomicTransactionComposer
Defined in: algokit-utils-ts/src/types/transaction.ts:36
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”ensureZeroBalance?
Section titled “ensureZeroBalance?”
optionalensureZeroBalance?:boolean
Defined in: algokit-utils-ts/src/types/asset.ts:88
Whether or not to validate the account has a zero-balance before issuing the opt-out; default = true
optionalfee?:AlgoAmount
Defined in: algokit-utils-ts/src/types/transaction.ts:40
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”lease?
Section titled “lease?”
optionallease?:string|Uint8Array<ArrayBufferLike>
Defined in: algokit-utils-ts/src/types/asset.ts:80
An (optional) transaction lease to apply
Inherited from
Section titled “Inherited from”maxFee?
Section titled “maxFee?”
optionalmaxFee?:AlgoAmount
Defined in: algokit-utils-ts/src/types/transaction.ts:42
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”maxRoundsToWaitForConfirmation?
Section titled “maxRoundsToWaitForConfirmation?”
optionalmaxRoundsToWaitForConfirmation?:number
Defined in: algokit-utils-ts/src/types/transaction.ts:44
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
optionalnote?:TransactionNote
Defined in: algokit-utils-ts/src/types/asset.ts:78
The (optional) transaction note
Inherited from
Section titled “Inherited from”populateAppCallResources?
Section titled “populateAppCallResources?”
optionalpopulateAppCallResources?:boolean
Defined in: algokit-utils-ts/src/types/transaction.ts:46
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
skipSending?
Section titled “skipSending?”
optionalskipSending?:boolean
Defined in: algokit-utils-ts/src/types/transaction.ts:32
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”skipWaiting?
Section titled “skipWaiting?”
optionalskipWaiting?:boolean
Defined in: algokit-utils-ts/src/types/transaction.ts:34
Whether to skip waiting for the submitted transaction (only relevant if skipSending is false or unset)
Inherited from
Section titled “Inherited from”suppressLog?
Section titled “suppressLog?”
optionalsuppressLog?:boolean
Defined in: algokit-utils-ts/src/types/transaction.ts:38
Whether to suppress log messages from transaction send, default: do not suppress
Inherited from
Section titled “Inherited from”transactionParams?
Section titled “transactionParams?”
optionaltransactionParams?:SuggestedParams
Defined in: algokit-utils-ts/src/types/asset.ts:76
Optional transaction parameters