Skip to content

AppClientParams

@algorandfoundation/algokit-utils / types/app-client / AppClientParams

types/app-client.AppClientParams

Parameters to create an app client

Table of contents

Properties

Properties

algorand

algorand: AlgorandClient

An AlgorandClient instance

Defined in

src/types/app-client.ts:331


appId

appId: bigint

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

Defined in

src/types/app-client.ts:321


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

src/types/app-client.ts:337


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

src/types/app-client.ts:328


approvalSourceMap

Optional approvalSourceMap: ProgramSourceMap

Optional source map for the approval program

Defined in

src/types/app-client.ts:343


clearSourceMap

Optional clearSourceMap: ProgramSourceMap

Optional source map for the clear state program

Defined in

src/types/app-client.ts:345


defaultSender

Optional defaultSender: string | Address

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

Defined in

src/types/app-client.ts:339


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

src/types/app-client.ts:341