AppFactoryParams
@algorandfoundation/algokit-utils / types/app-factory / AppFactoryParams
types/app-factory.AppFactoryParams
Parameters to create an app client
Table of contents
Section titled “Table of contents”Properties
Section titled “Properties”Properties
Section titled “Properties”algorand
Section titled “algorand”• algorand: AlgorandClient
AlgorandClient instance
Defined in
Section titled “Defined in”appName
Section titled “appName”• Optional appName: string
Optional override for the app name; used for on-chain metadata and lookups. Defaults to the ARC-32/ARC-56 app spec name.
Defined in
Section titled “Defined in”appSpec
Section titled “appSpec”• appSpec: string | Arc56Contract | AppSpec
The ARC-56 or ARC-32 application spec as either:
- Parsed JSON ARC-56
Contract - Parsed JSON ARC-32
AppSpec - Raw JSON string (in either ARC-56 or ARC-32 format)
Defined in
Section titled “Defined in”defaultSender
Section titled “defaultSender”• Optional defaultSender: string | Address
Optional address to use for the account to use as the default sender for calls.
Defined in
Section titled “Defined in”defaultSigner
Section titled “defaultSigner”• Optional defaultSigner: TransactionSigner
Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from AlgorandClient).
Defined in
Section titled “Defined in”deletable
Section titled “deletable”• Optional deletable: boolean
Whether or not the contract should have deploy-time permanence control set, undefined = ignore.
If specified here will get used in calls to deploy and create calls unless overridden in those calls.
Useful if you want to vend multiple contracts from the same factory without specifying this value for each call.
Defined in
Section titled “Defined in”deployTimeParams
Section titled “deployTimeParams”• Optional deployTimeParams: TealTemplateParams
Optional deploy-time TEAL template replacement parameters.
If specified here will get used in calls to deploy and create calls unless overridden in those calls.
Useful if you want to vend multiple contracts from the same factory without specifying this value for each call.
Defined in
Section titled “Defined in”updatable
Section titled “updatable”• Optional updatable: boolean
Whether or not the contract should have deploy-time immutability control set, undefined = ignore.
If specified here will get used in calls to deploy and create calls unless overridden in those calls.
Useful if you want to vend multiple contracts from the same factory without specifying this value for each call.
Defined in
Section titled “Defined in”version
Section titled “version”• Optional version: string
The version of app that is / will be deployed; defaults to 1.0