AppClientDeployParams
@algorandfoundation/algokit-utils / types/app-client / AppClientDeployParams
types/app-client.AppClientDeployParams
Parameters to pass into ApplicationClient.deploy
Hierarchy
Section titled “Hierarchy”-
AppClientDeployCallInterfaceParams↳
AppClientDeployParams
Table of contents
Section titled “Table of contents”Properties
Section titled “Properties”- allowDelete
- allowUpdate
- createArgs
- createOnCompleteAction
- deleteArgs
- deployTimeParams
- onSchemaBreak
- onUpdate
- schema
- sendParams
- sender
- updateArgs
- version
Properties
Section titled “Properties”allowDelete
Section titled “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
Section titled “Inherited from”AppClientDeployCoreParams.allowDelete
Defined in
Section titled “Defined in”allowUpdate
Section titled “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
Section titled “Inherited from”AppClientDeployCoreParams.allowUpdate
Defined in
Section titled “Defined in”createArgs
Section titled “createArgs”• Optional createArgs: AppClientCallArgs
Any args to pass to any create transaction that is issued as part of deployment
Inherited from
Section titled “Inherited from”AppClientDeployCallInterfaceParams.createArgs
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
Inherited from
Section titled “Inherited from”AppClientDeployCallInterfaceParams.createOnCompleteAction
Defined in
Section titled “Defined in”deleteArgs
Section titled “deleteArgs”• Optional deleteArgs: AppClientCallArgs
Any args to pass to any delete transaction that is issued as part of deployment
Inherited from
Section titled “Inherited from”AppClientDeployCallInterfaceParams.deleteArgs
Defined in
Section titled “Defined in”deployTimeParams
Section titled “deployTimeParams”• Optional deployTimeParams: TealTemplateParams
Any deploy-time parameters to replace in the TEAL code
Inherited from
Section titled “Inherited from”AppClientDeployCallInterfaceParams.deployTimeParams
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
Inherited from
Section titled “Inherited from”AppClientDeployCoreParams.onSchemaBreak
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
Inherited from
Section titled “Inherited from”AppClientDeployCoreParams.onUpdate
Defined in
Section titled “Defined in”schema
Section titled “schema”• Optional schema: Partial<AppStorageSchema>
Any overrides for the storage schema to request for the created app; by default the schema indicated by the app spec is used.
Defined in
Section titled “Defined in”sendParams
Section titled “sendParams”• Optional sendParams: Omit<SendTransactionParams, "skipSending" | "skipWaiting">
Parameters to control transaction sending
Inherited from
Section titled “Inherited from”AppClientDeployCoreParams.sendParams
Defined in
Section titled “Defined in”sender
Section titled “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
Section titled “Inherited from”AppClientDeployCoreParams.sender
Defined in
Section titled “Defined in”updateArgs
Section titled “updateArgs”• Optional updateArgs: AppClientCallArgs
Any args to pass to any update transaction that is issued as part of deployment
Inherited from
Section titled “Inherited from”AppClientDeployCallInterfaceParams.updateArgs
Defined in
Section titled “Defined in”version
Section titled “version”• Optional version: string
The version of the contract, uses “1.0” by default
Inherited from
Section titled “Inherited from”AppClientDeployCoreParams.version