Skip to content

Create Publication

We are looking for publications that demonstrate building dApps or smart contracts!
See the full list of Gitcoin bounties that are eligible for rewards.

types app client.AppClientDeployParams

@algorandfoundation/algokit-utils / types/app-client / AppClientDeployParams

Interface: AppClientDeployParams

types/app-client.AppClientDeployParams

Parameters to pass into ApplicationClient.deploy

Hierarchy

AppClientDeployParams

Table of contents

Properties

Properties

allowDelete

Optional allowDelete: boolean

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

Defined in

src/types/app-client.ts:137


allowUpdate

Optional allowUpdate: boolean

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

Defined in

src/types/app-client.ts:133


createArgs

Optional createArgs: AppClientCallArgs

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

Inherited from

AppClientDeployCallInterfaceParams.createArgs

Defined in

src/types/app-client.ts:149


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

Inherited from

AppClientDeployCallInterfaceParams.createOnCompleteAction

Defined in

src/types/app-client.ts:151


deleteArgs

Optional deleteArgs: AppClientCallArgs

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

Inherited from

AppClientDeployCallInterfaceParams.deleteArgs

Defined in

src/types/app-client.ts:155


deployTimeParams

Optional deployTimeParams: TealTemplateParams

Any deploy-time parameters to replace in the TEAL code

Inherited from

AppClientDeployCallInterfaceParams.deployTimeParams

Defined in

src/types/app-client.ts:147


onSchemaBreak

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

What action to perform if a schema break is detected

Inherited from

AppClientDeployCoreParams.onSchemaBreak

Defined in

src/types/app-client.ts:139


onUpdate

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

What action to perform if a TEAL update is detected

Inherited from

AppClientDeployCoreParams.onUpdate

Defined in

src/types/app-client.ts:141


sendParams

Optional sendParams: Omit\<SendTransactionParams, "skipSending" | "skipWaiting">

Parameters to control transaction sending

Inherited from

AppClientDeployCoreParams.sendParams

Defined in

src/types/app-client.ts:129


sender

Optional sender: SendTransactionFrom

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

Inherited from

AppClientDeployCoreParams.sender

Defined in

src/types/app-client.ts:127


updateArgs

Optional updateArgs: AppClientCallArgs

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

Inherited from

AppClientDeployCallInterfaceParams.updateArgs

Defined in

src/types/app-client.ts:153


version

Optional version: string

The version of the contract, uses "1.0" by default

Inherited from

AppClientDeployCoreParams.version

Defined in

src/types/app-client.ts:125