Skip to content

Create Publication

We are looking for publications that demonstrate building dApps or smart contracts!
See the full list of Gitcoin bounties that are eligible for rewards.

types asset.AssetOptOutParams

@algorandfoundation/algokit-utils / types/asset / AssetOptOutParams

Interface: AssetOptOutParams

types/asset.AssetOptOutParams

Parameters for assetOptOut call.

Hierarchy

AssetOptOutParams

Table of contents

Properties

Properties

account

account: SendTransactionFrom

The account to opt in/out for

Inherited from

AssetOptInParams.account

Defined in

src/types/asset.ts:9


assetCreatorAddress

Optional assetCreatorAddress: string

The address of the creator account for the asset; if unspecified then it looks it up using algod

Defined in

src/types/asset.ts:23


assetId

assetId: number

The ID of the assets to opt in for / out of

Inherited from

AssetOptInParams.assetId

Defined in

src/types/asset.ts:11


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

AssetOptInParams.atc

Defined in

src/types/transaction.ts:35


ensureZeroBalance

Optional ensureZeroBalance: boolean

Whether or not to validate the account has a zero-balance before issuing the opt-out; default = true

Defined in

src/types/asset.ts:25


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

AssetOptInParams.fee

Defined in

src/types/transaction.ts:39


lease

Optional lease: string | Uint8Array

An (optional) transaction lease to apply

Inherited from

AssetOptInParams.lease

Defined in

src/types/asset.ts:17


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

AssetOptInParams.maxFee

Defined in

src/types/transaction.ts:41


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

src/types/transaction.ts:43


note

Optional note: TransactionNote

The (optional) transaction note

Inherited from

AssetOptInParams.note

Defined in

src/types/asset.ts:15


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

AssetOptInParams.skipSending

Defined in

src/types/transaction.ts:31


skipWaiting

Optional skipWaiting: boolean

Whether to skip waiting for the submitted transaction (only relevant if skipSending is false or unset)

Inherited from

AssetOptInParams.skipWaiting

Defined in

src/types/transaction.ts:33


suppressLog

Optional suppressLog: boolean

Whether to suppress log messages from transaction send, default: do not suppress

Inherited from

AssetOptInParams.suppressLog

Defined in

src/types/transaction.ts:37


transactionParams

Optional transactionParams: SuggestedParams

Optional transaction parameters

Inherited from

AssetOptInParams.transactionParams

Defined in

src/types/asset.ts:13