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¶
- allowDelete
- allowUpdate
- createArgs
- createOnCompleteAction
- deleteArgs
- deployTimeParams
- onSchemaBreak
- onUpdate
- sendParams
- sender
- updateArgs
- version
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¶
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¶
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¶
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¶
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¶
deployTimeParams¶
• Optional deployTimeParams: TealTemplateParams
Any deploy-time parameters to replace in the TEAL code
Inherited from¶
AppClientDeployCallInterfaceParams.deployTimeParams
Defined in¶
onSchemaBreak¶
• Optional onSchemaBreak: OnSchemaBreak | "replace" | "fail" | "append"
What action to perform if a schema break is detected
Inherited from¶
AppClientDeployCoreParams.onSchemaBreak
Defined in¶
onUpdate¶
• Optional onUpdate: "replace" | "fail" | "append" | OnUpdate | "update"
What action to perform if a TEAL update is detected
Inherited from¶
AppClientDeployCoreParams.onUpdate
Defined in¶
sendParams¶
• Optional sendParams: Omit\<SendTransactionParams, "skipSending" | "skipWaiting">
Parameters to control transaction sending
Inherited from¶
AppClientDeployCoreParams.sendParams
Defined in¶
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¶
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¶
version¶
• Optional version: string
The version of the contract, uses "1.0" by default
Inherited from¶
AppClientDeployCoreParams.version