AppDeploymentParams
@algorandfoundation/algokit-utils / types/app / AppDeploymentParams
types/app.AppDeploymentParams
The parameters to deploy an app
Hierarchy
Section titled “Hierarchy”-
Omit<CreateAppParams,"onCompleteAction"|"args"|"note"|"skipSending"|"skipWaiting"|"atc">↳
AppDeploymentParams
Table of contents
Section titled “Table of contents”Properties
Section titled “Properties”- approvalProgram
- clearStateProgram
- createArgs
- createOnCompleteAction
- deleteArgs
- deployTimeParams
- existingDeployments
- fee
- from
- maxFee
- maxRoundsToWaitForConfirmation
- metadata
- onSchemaBreak
- onUpdate
- populateAppCallResources
- schema
- suppressLog
- transactionParams
- updateArgs
Properties
Section titled “Properties”approvalProgram
Section titled “approvalProgram”• approvalProgram: string | Uint8Array
The approval program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array)
Inherited from
Section titled “Inherited from”Omit.approvalProgram
Defined in
Section titled “Defined in”clearStateProgram
Section titled “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
Section titled “Inherited from”Omit.clearStateProgram
Defined in
Section titled “Defined in”createArgs
Section titled “createArgs”• Optional createArgs: AppCallArgs
Any args to pass to any create transaction that is issued as part of deployment
Defined in
Section titled “Defined in”createOnCompleteAction
Section titled “createOnCompleteAction”• Optional createOnCompleteAction: "no_op" | "opt_in" | "close_out" | "update_application" | "delete_application" | NoOpOC | OptInOC | CloseOutOC | UpdateApplicationOC | DeleteApplicationOC
Override the on-completion action for the create call; defaults to NoOp
Defined in
Section titled “Defined in”deleteArgs
Section titled “deleteArgs”• Optional deleteArgs: AppCallArgs
Any args to pass to any delete transaction that is issued as part of deployment
Defined in
Section titled “Defined in”deployTimeParams
Section titled “deployTimeParams”• Optional deployTimeParams: TealTemplateParams
Any deploy-time parameters to replace in the TEAL code
Defined in
Section titled “Defined in”existingDeployments
Section titled “existingDeployments”• Optional existingDeployments: AppLookup
Optional cached value of the existing apps for the given creator
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”Omit.fee
Defined in
Section titled “Defined in”• from: SendTransactionFrom
The account (with private key loaded) that will send the transaction
Inherited from
Section titled “Inherited from”Omit.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”Omit.maxFee
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”Omit.maxRoundsToWaitForConfirmation
Defined in
Section titled “Defined in”metadata
Section titled “metadata”• metadata: AppDeployMetadata
The deployment metadata
Defined in
Section titled “Defined in”onSchemaBreak
Section titled “onSchemaBreak”• Optional onSchemaBreak: OnSchemaBreak | "replace" | "fail" | "append"
What action to perform if a schema break is detected
Defined in
Section titled “Defined in”onUpdate
Section titled “onUpdate”• Optional onUpdate: "replace" | "fail" | "append" | OnUpdate | "update"
What action to perform if a TEAL update is detected
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”Omit.populateAppCallResources
Defined in
Section titled “Defined in”schema
Section titled “schema”• schema: AppStorageSchema
The storage schema to request for the created app
Inherited from
Section titled “Inherited from”Omit.schema
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”Omit.suppressLog
Defined in
Section titled “Defined in”transactionParams
Section titled “transactionParams”• Optional transactionParams: SuggestedParams
Optional transaction parameters
Inherited from
Section titled “Inherited from”Omit.transactionParams
Defined in
Section titled “Defined in”updateArgs
Section titled “updateArgs”• Optional updateArgs: AppCallArgs
Any args to pass to any update transaction that is issued as part of deployment