types app.AppDeploymentParams

@algorandfoundation/algokit-utils / types/app / AppDeploymentParams

Interface: AppDeploymentParams

types/app.AppDeploymentParams

The parameters to deploy an app

Hierarchy

• Omit\<CreateAppParams, "onCompleteAction" | "args" | "note" | "skipSending" | "skipWaiting" | "atc">

↳ AppDeploymentParams

Table of contents

Properties

• approvalProgram
• clearStateProgram
• createArgs
• createOnCompleteAction
• deleteArgs
• deployTimeParams
• existingDeployments
• fee
• from
• maxFee
• maxRoundsToWaitForConfirmation
• metadata
• onSchemaBreak
• onUpdate
• populateAppCallResources
• schema
• suppressLog
• transactionParams
• updateArgs

Properties

approvalProgram

• approvalProgram: string | Uint8Array

The approval program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array)

Inherited from

Omit.approvalProgram

Defined in

src/types/app.ts:125

---

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

Omit.clearStateProgram

Defined in

src/types/app.ts:127

---

createArgs

• Optional createArgs: AppCallArgs

Any args to pass to any create transaction that is issued as part of deployment

Defined in

src/types/app.ts:304

---

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

src/types/app.ts:306

---

deleteArgs

• Optional deleteArgs: AppCallArgs

Any args to pass to any delete transaction that is issued as part of deployment

Defined in

src/types/app.ts:310

---

deployTimeParams

• Optional deployTimeParams: TealTemplateParams

Any deploy-time parameters to replace in the TEAL code

Defined in

src/types/app.ts:296

---

existingDeployments

• Optional existingDeployments: AppLookup

Optional cached value of the existing apps for the given creator

Defined in

src/types/app.ts:302

---

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

Omit.fee

Defined in

src/types/transaction.ts:39

---

from

• from: SendTransactionFrom

The account (with private key loaded) that will send the transaction

Inherited from

Omit.from

Defined in

src/types/app.ts:123

---

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

Omit.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

Omit.maxRoundsToWaitForConfirmation

Defined in

src/types/transaction.ts:43

---

metadata

• metadata: AppDeployMetadata

The deployment metadata

Defined in

src/types/app.ts:294

---

onSchemaBreak

• Optional onSchemaBreak: OnSchemaBreak | "replace" | "fail" | "append"

What action to perform if a schema break is detected

Defined in

src/types/app.ts:298

---

onUpdate

• Optional onUpdate: "replace" | "fail" | "append" | OnUpdate | "update"

What action to perform if a TEAL update is detected

Defined in

src/types/app.ts:300

---

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

Omit.populateAppCallResources

Defined in

src/types/transaction.ts:45

---

schema

• schema: AppStorageSchema

The storage schema to request for the created app

Inherited from

Omit.schema

Defined in

src/types/app.ts:139

---

suppressLog

• Optional suppressLog: boolean

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

Inherited from

Omit.suppressLog

Defined in

src/types/transaction.ts:37

---

transactionParams

• Optional transactionParams: SuggestedParams

Optional transaction parameters

Inherited from

Omit.transactionParams

Defined in

src/types/app.ts:129

---

updateArgs

• Optional updateArgs: AppCallArgs

Any args to pass to any update transaction that is issued as part of deployment

Defined in

src/types/app.ts:308