types/app-client
@algorandfoundation/algokit-utils / types/app-client
Table of contents
Classes
Interfaces
- AppClientCallABIArgs
- AppClientCallCoreParams
- AppClientCompilationParams
- AppClientCompilationResult
- AppClientDeployCallInterfaceParams
- AppClientDeployCoreParams
- AppClientDeployParams
- AppClientParams
- AppSourceMaps
- FundAppAccountParams
- ResolveAppById
- ResolveAppByIdBase
- SourceMapExport
Type Aliases
- AppClientBareCallParams
- AppClientCallArgs
- AppClientCallParams
- AppClientCallRawArgs
- AppClientClearStateParams
- AppClientCreateOnComplete
- AppClientCreateParams
- AppClientMethodCallParams
- AppClientUpdateParams
- AppDetails
- AppDetailsBase
- AppSpecAppDetails
- AppSpecAppDetailsBase
- AppSpecAppDetailsByCreatorAndName
- AppSpecAppDetailsById
- CallOnComplete
- CloneAppClientParams
- FundAppParams
- ResolveAppByCreatorAndName
- ResolveAppByCreatorAndNameBase
- ResolveAppClientByCreatorAndName
- ResolveAppClientByNetwork
Type Aliases
AppClientBareCallParams
Ƭ AppClientBareCallParams: Expand<Omit<CommonAppCallParams, "appId" | "sender" | "onComplete"> & { sender?: Address | string }>
AppClient common parameters for a bare app call
Defined in
AppClientCallArgs
Ƭ AppClientCallArgs: AppClientCallRawArgs | AppClientCallABIArgs
The arguments to pass to an Application Client smart contract call
Defined in
AppClientCallParams
Ƭ AppClientCallParams: AppClientCallArgs & AppClientCallCoreParams
Parameters to construct a ApplicationClient contract call
Defined in
AppClientCallRawArgs
Ƭ AppClientCallRawArgs: RawAppCallArgs
Defined in
AppClientClearStateParams
Ƭ AppClientClearStateParams: AppClientCallRawArgs & AppClientCallCoreParams
Parameters to construct a ApplicationClient clear state contract call
Defined in
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
AppClientCreateParams
Ƭ AppClientCreateParams: AppClientCallParams & AppClientCompilationParams & AppClientCreateOnComplete & { schema?: Partial<AppStorageSchema> }
Parameters for creating a contract using ApplicationClient
Defined in
AppClientMethodCallParams
Ƭ AppClientMethodCallParams: Expand<Omit<CommonAppCallParams, "appId" | "sender" | "method" | "args"> & { args?: (ABIValue | ABIStruct | AppMethodCallTransactionArgument | undefined)[] ; method: string ; sender?: Address | string }>
AppClient common parameters for an ABI method call
Defined in
AppClientUpdateParams
Ƭ AppClientUpdateParams: AppClientCallParams & AppClientCompilationParams
Parameters for updating a contract using ApplicationClient
Defined in
AppDetails
Ƭ AppDetails: AppDetailsBase & ResolveAppById | ResolveAppByCreatorAndName
The details of an AlgoKit Utils deployed app
Defined in
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
AppSpecAppDetails
Ƭ AppSpecAppDetails: AppSpecAppDetailsBase & AppDetails
The details of an ARC-0032 app spec specified, AlgoKit Utils deployed app
Defined in
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
AppSpecAppDetailsByCreatorAndName
Ƭ AppSpecAppDetailsByCreatorAndName: AppSpecAppDetailsBase & AppDetailsBase & ResolveAppByCreatorAndNameBase
The details of an ARC-0032 app spec specified, AlgoKit Utils deployed app by creator and name
Defined in
AppSpecAppDetailsById
Ƭ AppSpecAppDetailsById: AppSpecAppDetailsBase & AppDetailsBase & ResolveAppByIdBase
The details of an ARC-0032 app spec specified, AlgoKit Utils deployed app by id
Defined in
CallOnComplete
Ƭ CallOnComplete: Object
onComplete parameter for a non-update app call
Type declaration
| Name | Type | Description |
|---|---|---|
onComplete? | Exclude<OnApplicationComplete, OnApplicationComplete.UpdateApplicationOC> | On-complete of the call; defaults to no-op |
Defined in
CloneAppClientParams
Ƭ CloneAppClientParams: Expand<Partial<Omit<AppClientParams, "algorand" | "appSpec">>>
Parameters to clone an app client
Defined in
FundAppParams
Ƭ FundAppParams: Expand<Omit<PaymentParams, "receiver" | "sender"> & SendParams & { sender?: Address | string }>
Parameters for funding an app account
Defined in
ResolveAppByCreatorAndName
Ƭ ResolveAppByCreatorAndName: ResolveAppByCreatorAndNameBase & { resolveBy: "creatorAndName" }
Configuration to resolve app by creator and name getCreatorAppsByName
Defined in
ResolveAppByCreatorAndNameBase
Ƭ ResolveAppByCreatorAndNameBase: Object
Configuration to resolve app by creator and name getCreatorAppsByName
Type declaration
| Name | Type | Description |
|---|---|---|
creatorAddress | Address | 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
ResolveAppClientByCreatorAndName
Ƭ ResolveAppClientByCreatorAndName: Expand<Omit<AppClientParams, "appId"> & { appLookupCache?: AppLookup ; creatorAddress: Address | string ; ignoreCache?: boolean }>
Resolve an app client instance by looking up an app created by the given creator with the given name
Defined in
ResolveAppClientByNetwork
Ƭ ResolveAppClientByNetwork: Expand<Omit<AppClientParams, "appId">>
Resolve an app client instance by looking up the current network.