AppDeploymentParams
Defined in: algokit-utils-ts/src/types/app.ts:310
The parameters to deploy an app
Extends
Section titled “Extends”Omit<CreateAppParams,"onCompleteAction"|"args"|"note"|"skipSending"|"skipWaiting"|"atc">
Properties
Section titled “Properties”approvalProgram
Section titled “approvalProgram”approvalProgram:
string|Uint8Array<ArrayBufferLike>
Defined in: algokit-utils-ts/src/types/app.ts:135
The approval program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array)
Inherited from
Section titled “Inherited from”CreateAppParams.approvalProgram
clearStateProgram
Section titled “clearStateProgram”clearStateProgram:
string|Uint8Array<ArrayBufferLike>
Defined in: algokit-utils-ts/src/types/app.ts:137
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”CreateAppParams.clearStateProgram
createArgs?
Section titled “createArgs?”
optionalcreateArgs?:AppCallArgs
Defined in: algokit-utils-ts/src/types/app.ts:323
Any args to pass to any create transaction that is issued as part of deployment
createOnCompleteAction?
Section titled “createOnCompleteAction?”
optionalcreateOnCompleteAction?:NoOpOC|OptInOC|CloseOutOC|UpdateApplicationOC|DeleteApplicationOC|"no_op"|"opt_in"|"close_out"|"update_application"|"delete_application"
Defined in: algokit-utils-ts/src/types/app.ts:325
Override the on-completion action for the create call; defaults to NoOp
deleteArgs?
Section titled “deleteArgs?”
optionaldeleteArgs?:AppCallArgs
Defined in: algokit-utils-ts/src/types/app.ts:329
Any args to pass to any delete transaction that is issued as part of deployment
deployTimeParams?
Section titled “deployTimeParams?”
optionaldeployTimeParams?:TealTemplateParams
Defined in: algokit-utils-ts/src/types/app.ts:315
Any deploy-time parameters to replace in the TEAL code
existingDeployments?
Section titled “existingDeployments?”
optionalexistingDeployments?:AppLookup
Defined in: algokit-utils-ts/src/types/app.ts:321
Optional cached value of the existing apps for the given creator
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”from:
SendTransactionFrom
Defined in: algokit-utils-ts/src/types/app.ts:133
The account (with private key loaded) that will send the transaction
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”SendTransactionParams.maxRoundsToWaitForConfirmation
metadata
Section titled “metadata”metadata:
AppDeployMetadata
Defined in: algokit-utils-ts/src/types/app.ts:313
The deployment metadata
onSchemaBreak?
Section titled “onSchemaBreak?”
optionalonSchemaBreak?:"replace"|"fail"|"append"|OnSchemaBreak
Defined in: algokit-utils-ts/src/types/app.ts:317
What action to perform if a schema break is detected
onUpdate?
Section titled “onUpdate?”
optionalonUpdate?:"replace"|"fail"|"append"|"update"|OnUpdate
Defined in: algokit-utils-ts/src/types/app.ts:319
What action to perform if a TEAL update is detected
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”SendTransactionParams.populateAppCallResources
schema
Section titled “schema”schema:
AppStorageSchema
Defined in: algokit-utils-ts/src/types/app.ts:152
The storage schema to request for the created app
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”SendTransactionParams.suppressLog
transactionParams?
Section titled “transactionParams?”
optionaltransactionParams?:SuggestedParams
Defined in: algokit-utils-ts/src/types/app.ts:139
Optional transaction parameters
Inherited from
Section titled “Inherited from”CreateAppParams.transactionParams
updateArgs?
Section titled “updateArgs?”
optionalupdateArgs?:AppCallArgs
Defined in: algokit-utils-ts/src/types/app.ts:327
Any args to pass to any update transaction that is issued as part of deployment