AppFactoryParams
Defined in: src/app-factory.ts:27
Parameters to create an app client
Properties
Section titled “Properties”algorand
Section titled “algorand”algorand:
AlgorandClient
Defined in: src/app-factory.ts:36
AlgorandClient instance
appName?
Section titled “appName?”
optionalappName:string
Defined in: src/app-factory.ts:42
Optional override for the app name; used for on-chain metadata and lookups. Defaults to the ARC-32/ARC-56 app spec name.
appSpec
Section titled “appSpec”appSpec:
string|Arc56Contract|AppSpec
Defined in: src/app-factory.ts:33
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)
defaultSender?
Section titled “defaultSender?”
optionaldefaultSender:ReadableAddress
Defined in: src/app-factory.ts:45
Optional address to use for the account to use as the default sender for calls.
defaultSigner?
Section titled “defaultSigner?”
optionaldefaultSigner:TransactionSigner
Defined in: src/app-factory.ts:48
Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from AlgorandClient).
deletable?
Section titled “deletable?”
optionaldeletable:boolean
Defined in: src/app-factory.ts:69
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.
deployTimeParams?
Section titled “deployTimeParams?”
optionaldeployTimeParams:TealTemplateParams
Defined in: src/app-factory.ts:78
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.
updatable?
Section titled “updatable?”
optionalupdatable:boolean
Defined in: src/app-factory.ts:60
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.
version?
Section titled “version?”
optionalversion:string
Defined in: src/app-factory.ts:51
The version of app that is / will be deployed; defaults to 1.0