Skip to content

创建文章

We are looking for publications that demonstrate building dApps or smart contracts!
See the full list of Gitcoin bounties that are eligible for rewards.

Types app client

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

Module: types/app-client

Table of contents

Classes

Interfaces

Type Aliases

Type Aliases

AppClientCallArgs

Ƭ AppClientCallArgs: AppClientCallRawArgs | AppClientCallABIArgs

The arguments to pass to an Application Client smart contract call

Defined in

src/types/app-client.ts:170


AppClientCallParams

Ƭ AppClientCallParams: AppClientCallArgs & AppClientCallCoreParams

Parameters to construct a ApplicationClient contract call

Defined in

src/types/app-client.ts:183


AppClientClearStateParams

Ƭ AppClientClearStateParams: AppClientCallRawArgs & AppClientCallCoreParams

Parameters to construct a ApplicationClient clear state contract call

Defined in

src/types/app-client.ts:186


AppClientCreateOnComplete

Ƭ AppClientCreateOnComplete: Object

On-complete action parameter for creating a contract using ApplicationClient

Type declaration
Name Type Description
onCompleteAction? Exclude\<AppCallType, "clear_state"> | Exclude\<OnApplicationComplete, OnApplicationComplete.ClearStateOC> Override the on-completion action for the create call; defaults to NoOp
Defined in

src/types/app-client.ts:198


AppClientCreateParams

Ƭ AppClientCreateParams: AppClientCallParams & AppClientCompilationParams & AppClientCreateOnComplete

Parameters for creating a contract using ApplicationClient

Defined in

src/types/app-client.ts:204


AppClientUpdateParams

Ƭ AppClientUpdateParams: AppClientCallParams & AppClientCompilationParams

Parameters for updating a contract using ApplicationClient

Defined in

src/types/app-client.ts:207


AppDetails

Ƭ AppDetails: AppDetailsBase & ResolveAppById | ResolveAppByCreatorAndName

The details of an AlgoKit Utils deployed app

Defined in

src/types/app-client.ts:102


AppDetailsBase

Ƭ AppDetailsBase: Object

The details of an AlgoKit Utils deployed app

Type declaration
Name Type Description
deployTimeParams? TealTemplateParams Optionally provide any deploy-time parameters to replace in the TEAL code; if specified here will get used in calls to deploy, create and update unless overridden in those calls
params? SuggestedParams Default suggested params object to use
sender? SendTransactionFrom Default sender to use for transactions issued by this application client
Defined in

src/types/app-client.ts:90


AppSpecAppDetails

Ƭ AppSpecAppDetails: AppSpecAppDetailsBase & AppDetails

The details of an ARC-0032 app spec specified, AlgoKit Utils deployed app

Defined in

src/types/app-client.ts:120


AppSpecAppDetailsBase

Ƭ AppSpecAppDetailsBase: Object

The details of an ARC-0032 app spec specified, AlgoKit Utils deployed app

Type declaration
Name Type Description
app AppSpec | string The ARC-0032 application spec as either: * Parsed JSON AppSpec * Raw JSON string
Defined in

src/types/app-client.ts:105


AppSpecAppDetailsByCreatorAndName

Ƭ AppSpecAppDetailsByCreatorAndName: AppSpecAppDetailsBase & AppDetailsBase & ResolveAppByCreatorAndNameBase

The details of an ARC-0032 app spec specified, AlgoKit Utils deployed app by creator and name

Defined in

src/types/app-client.ts:117


AppSpecAppDetailsById

Ƭ AppSpecAppDetailsById: AppSpecAppDetailsBase & AppDetailsBase & ResolveAppByIdBase

The details of an ARC-0032 app spec specified, AlgoKit Utils deployed app by id

Defined in

src/types/app-client.ts:114


ResolveAppByCreatorAndName

Ƭ ResolveAppByCreatorAndName: ResolveAppByCreatorAndNameBase & { resolveBy: "creatorAndName" }

Configuration to resolve app by creator and name getCreatorAppsByName

Defined in

src/types/app-client.ts:71


ResolveAppByCreatorAndNameBase

Ƭ ResolveAppByCreatorAndNameBase: Object

Configuration to resolve app by creator and name getCreatorAppsByName

Type declaration
Name Type Description
creatorAddress string The address of the app creator account to resolve the app by
findExistingUsing Indexer | AppLookup The mechanism to find an existing app instance metadata for the given creator and name; either: * An indexer instance to search the creator account apps; or * The cached value of the existing apps for the given creator from getCreatorAppsByName
name? string The optional name override to resolve the app by within the creator account (default: uses the name in the ABI contract)
Defined in

src/types/app-client.ts:58