UpdateAppParams
@algorandfoundation/algokit-utils / types/app / UpdateAppParams
types/app.UpdateAppParams
Deprecated
Use TransactionComposer to construct update app transactions instead.
Parameters that are passed in when updating an app.
Hierarchy
-
CreateOrUpdateAppParams↳
UpdateAppParams
Table of contents
Properties
- appId
- approvalProgram
- args
- atc
- clearStateProgram
- fee
- from
- maxFee
- maxRoundsToWaitForConfirmation
- note
- populateAppCallResources
- skipSending
- skipWaiting
- suppressLog
- transactionParams
Properties
appId
• appId: number | bigint
The id of the app to update
Defined in
approvalProgram
• approvalProgram: string | Uint8Array
The approval program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array)
Inherited from
CreateOrUpdateAppParams.approvalProgram
Defined in
args
• Optional args: AppCallArgs
The arguments passed in to the app call
Inherited from
CreateOrUpdateAppParams.args
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
CreateOrUpdateAppParams.atc
Defined in
clearStateProgram
• clearStateProgram: string | Uint8Array
The clear state program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array)
Inherited from
CreateOrUpdateAppParams.clearStateProgram
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
CreateOrUpdateAppParams.fee
Defined in
from
• from: SendTransactionFrom
The account (with private key loaded) that will send the transaction
Inherited from
CreateOrUpdateAppParams.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
CreateOrUpdateAppParams.maxFee
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
CreateOrUpdateAppParams.maxRoundsToWaitForConfirmation
Defined in
note
• Optional note: TransactionNote
The (optional) transaction note
Inherited from
CreateOrUpdateAppParams.note
Defined in
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
CreateOrUpdateAppParams.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
CreateOrUpdateAppParams.skipSending
Defined in
skipWaiting
• Optional skipWaiting: boolean
Whether to skip waiting for the submitted transaction (only relevant if skipSending is false or unset)
Inherited from
CreateOrUpdateAppParams.skipWaiting
Defined in
suppressLog
• Optional suppressLog: boolean
Whether to suppress log messages from transaction send, default: do not suppress
Inherited from
CreateOrUpdateAppParams.suppressLog
Defined in
transactionParams
• Optional transactionParams: SuggestedParams
Optional transaction parameters
Inherited from
CreateOrUpdateAppParams.transactionParams