Skip to content

AppClientParams

Defined in: algokit-utils-ts/src/types/app-client.ts:319

Parameters to create an app client

algorand: AlgorandClient

Defined in: algokit-utils-ts/src/types/app-client.ts:331

An AlgorandClient instance


appId: bigint

Defined in: algokit-utils-ts/src/types/app-client.ts:321

The ID of the app instance this client should make calls against.


optional appName?: string

Defined in: algokit-utils-ts/src/types/app-client.ts:337

Optional override for the app name; used for on-chain metadata and lookups. Defaults to the ARC-32/ARC-56 app spec name


optional approvalSourceMap?: ProgramSourceMap

Defined in: algokit-utils-ts/src/types/app-client.ts:343

Optional source map for the approval program


appSpec: string | Arc56Contract | AppSpec

Defined in: algokit-utils-ts/src/types/app-client.ts:328

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)

optional clearSourceMap?: ProgramSourceMap

Defined in: algokit-utils-ts/src/types/app-client.ts:345

Optional source map for the clear state program


optional defaultSender?: string | Address

Defined in: algokit-utils-ts/src/types/app-client.ts:339

Optional address to use for the account to use as the default sender for calls.


optional defaultSigner?: TransactionSigner

Defined in: algokit-utils-ts/src/types/app-client.ts:341

Optional signer to use as the default signer for default sender calls (if not specified then the signer will be resolved from AlgorandClient).