AppClientParams
@algorandfoundation/algokit-utils / types/app-client / AppClientParams
types/app-client.AppClientParams
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
An AlgorandClient instance
Defined in
Section titled “Defined in”• appId: bigint
The ID of the app instance this client should make calls against.
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”approvalSourceMap
Section titled “approvalSourceMap”• Optional approvalSourceMap: ProgramSourceMap
Optional source map for the approval program
Defined in
Section titled “Defined in”clearSourceMap
Section titled “clearSourceMap”• Optional clearSourceMap: ProgramSourceMap
Optional source map for the clear state program
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).