AppClientDeployParams

Defined in: algokit-utils-ts/src/types/app-client.ts:195

Parameters to pass into ApplicationClient.deploy

Extends

AppClientDeployCoreParams.AppClientDeployCallInterfaceParams

Properties

allowDelete?

optional allowDelete?: boolean

Defined in: algokit-utils-ts/src/types/app-client.ts:173

Whether or not to allow deletes in the contract using the deploy-time deletability control if present in your contract. If this is not specified then it will automatically be determined based on the AppSpec definition

Inherited from

AppClientDeployCoreParams.allowDelete

allowUpdate?

optional allowUpdate?: boolean

Defined in: algokit-utils-ts/src/types/app-client.ts:169

Whether or not to allow updates in the contract using the deploy-time updatability control if present in your contract. If this is not specified then it will automatically be determined based on the AppSpec definition

Inherited from

AppClientDeployCoreParams.allowUpdate

createArgs?

optional createArgs?: AppClientCallArgs

Defined in: algokit-utils-ts/src/types/app-client.ts:185

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

Inherited from

AppClientDeployCallInterfaceParams.createArgs

createOnCompleteAction?

optional createOnCompleteAction?: NoOpOC | OptInOC | CloseOutOC | UpdateApplicationOC | DeleteApplicationOC | "no_op" | "opt_in" | "close_out" | "update_application" | "delete_application"

Defined in: algokit-utils-ts/src/types/app-client.ts:187

Override the on-completion action for the create call; defaults to NoOp

Inherited from

AppClientDeployCallInterfaceParams.createOnCompleteAction

deleteArgs?

optional deleteArgs?: AppClientCallArgs

Defined in: algokit-utils-ts/src/types/app-client.ts:191

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

Inherited from

AppClientDeployCallInterfaceParams.deleteArgs

deployTimeParams?

optional deployTimeParams?: TealTemplateParams

Defined in: algokit-utils-ts/src/types/app-client.ts:183

Any deploy-time parameters to replace in the TEAL code

Inherited from

AppClientDeployCallInterfaceParams.deployTimeParams

onSchemaBreak?

optional onSchemaBreak?: "replace" | "fail" | "append" | OnSchemaBreak

Defined in: algokit-utils-ts/src/types/app-client.ts:175

What action to perform if a schema break is detected

Inherited from

AppClientDeployCoreParams.onSchemaBreak

onUpdate?

optional onUpdate?: "replace" | "fail" | "append" | "update" | OnUpdate

Defined in: algokit-utils-ts/src/types/app-client.ts:177

What action to perform if a TEAL update is detected

Inherited from

AppClientDeployCoreParams.onUpdate

schema?

optional schema?: Partial<AppStorageSchema>

Defined in: algokit-utils-ts/src/types/app-client.ts:197

Any overrides for the storage schema to request for the created app; by default the schema indicated by the app spec is used.

sender?

optional sender?: SendTransactionFrom

Defined in: algokit-utils-ts/src/types/app-client.ts:163

The optional sender to send the transaction from, will use the application client’s default sender by default if specified

Inherited from

AppClientDeployCoreParams.sender

sendParams?

optional sendParams?: Omit<SendTransactionParams, "skipSending" | "skipWaiting">

Defined in: algokit-utils-ts/src/types/app-client.ts:165

Parameters to control transaction sending

Inherited from

AppClientDeployCoreParams.sendParams

updateArgs?

optional updateArgs?: AppClientCallArgs

Defined in: algokit-utils-ts/src/types/app-client.ts:189

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

Inherited from

AppClientDeployCallInterfaceParams.updateArgs

version?

optional version?: string

Defined in: algokit-utils-ts/src/types/app-client.ts:161

The version of the contract, uses “1.0” by default

Inherited from

AppClientDeployCoreParams.version