Skip to content

AppClientParams

Defined in: src/app-client.ts:272

Parameters to create an app client

algorand: AlgorandClient

Defined in: src/app-client.ts:284

An AlgorandClient instance


appId: bigint

Defined in: src/app-client.ts:274

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


optional appName: string

Defined in: src/app-client.ts:290

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: src/app-client.ts:296

Optional source map for the approval program


appSpec: string | Arc56Contract | AppSpec

Defined in: src/app-client.ts:281

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: src/app-client.ts:298

Optional source map for the clear state program


optional defaultSender: ReadableAddress

Defined in: src/app-client.ts:292

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


optional defaultSigner: TransactionSigner

Defined in: src/app-client.ts:294

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