types/app
@algorandfoundation/algokit-utils / types/app
Table of contents
Section titled “Table of contents”Enumerations
Section titled “Enumerations”Interfaces
Section titled “Interfaces”- AppCallParams
- AppCallTransactionResultOfType
- AppCompilationResult
- AppDeployMetadata
- AppDeploymentParams
- AppLookup
- AppMetadata
- AppReference
- AppState
- AppStorageSchema
- BoxName
- BoxReference
- BoxValueRequestParams
- BoxValuesRequestParams
- CompiledTeal
- CoreAppCallArgs
- CreateAppParams
- RawAppCallArgs
- TealTemplateParams
- UpdateAppParams
Type Aliases
Section titled “Type Aliases”- ABIAppCallArg
- ABIAppCallArgs
- ABIReturn
- AppCallArgs
- AppCallTransactionResult
- AppCallType
- AppReturn
- BoxIdentifier
- SendAppCreateTransactionResult
- SendAppTransactionResult
- SendAppUpdateTransactionResult
Variables
Section titled “Variables”- ABI_RETURN_PREFIX
- APP_DEPLOY_NOTE_DAPP
- APP_PAGE_MAX_SIZE
- DELETABLE_TEMPLATE_NAME
- UPDATABLE_TEMPLATE_NAME
Type Aliases
Section titled “Type Aliases”ABIAppCallArg
Section titled “ABIAppCallArg”Ƭ ABIAppCallArg: ABIArgument | TransactionToSign | Transaction | Promise<SendTransactionResult> | SendTransactionResult | undefined
An argument for an ABI method, either a primitive value, or a transaction with or without signer, or the unawaited async return value of an algokit method that returns a SendTransactionResult
Defined in
Section titled “Defined in”ABIAppCallArgs
Section titled “ABIAppCallArgs”Ƭ ABIAppCallArgs: CoreAppCallArgs & { method: ABIMethodParams | ABIMethod ; methodArgs: ABIAppCallArg[] }
App call args for an ABI call
Defined in
Section titled “Defined in”ABIReturn
Section titled “ABIReturn”Ƭ ABIReturn: { decodeError: undefined ; method: ABIMethod ; rawReturnValue: Uint8Array ; returnValue: ABIValue } | { decodeError: Error ; method?: undefined ; rawReturnValue?: undefined ; returnValue?: undefined }
The return value of an ABI method call
Defined in
Section titled “Defined in”AppCallArgs
Section titled “AppCallArgs”Ƭ AppCallArgs: RawAppCallArgs | ABIAppCallArgs
Arguments to pass to an app call either:
- The raw app call values to pass through into the transaction (after processing); or
- An ABI method definition (method and args)
Defined in
Section titled “Defined in”AppCallTransactionResult
Section titled “AppCallTransactionResult”Ƭ AppCallTransactionResult: AppCallTransactionResultOfType<ABIReturn>
Result from calling an app
Defined in
Section titled “Defined in”AppCallType
Section titled “AppCallType”Ƭ AppCallType: "no_op" | "opt_in" | "close_out" | "clear_state" | "update_application" | "delete_application"
Deprecated
Use algosdk.OnApplicationComplete directly instead.
The type of call / on-completion action for a smart contract call.
Equivalent of algosdk.OnApplicationComplete, but as a more convenient string enum.
no_op: Normal smart contract call, no special on-complete actionopt_in: Opt-in to smart contract local storageclose_out: Close-out local storage storageclear_state: Clear local storage stateupdate_application: Update the smart contractdelete_application: Delete the smart contract
Defined in
Section titled “Defined in”AppReturn
Section titled “AppReturn”Ƭ AppReturn<TReturn>: Object
Type parameters
Section titled “Type parameters”| Name |
|---|
TReturn |
Type declaration
Section titled “Type declaration”| Name | Type | Description |
|---|---|---|
return? | TReturn | The ABI method call return value |
Defined in
Section titled “Defined in”BoxIdentifier
Section titled “BoxIdentifier”Ƭ BoxIdentifier: string | Uint8Array | SendTransactionFrom
Deprecated
Use types/app-manager/BoxIdentifier instead.
Something that identifies a box name - either a:
Uint8Arraystring(that will be encoded to a Uint8Array)SendTransactionFrom(encoded into the public key address of the corresponding account)
Defined in
Section titled “Defined in”SendAppCreateTransactionResult
Section titled “SendAppCreateTransactionResult”Ƭ SendAppCreateTransactionResult: Expand<SendAppUpdateTransactionResult & { appAddress: Address ; appId: bigint }>
Result from sending a single app transaction.
Defined in
Section titled “Defined in”SendAppTransactionResult
Section titled “SendAppTransactionResult”Ƭ SendAppTransactionResult: Expand<SendSingleTransactionResult & { return?: ABIReturn }>
Result from sending a single app transaction.
Defined in
Section titled “Defined in”SendAppUpdateTransactionResult
Section titled “SendAppUpdateTransactionResult”Ƭ SendAppUpdateTransactionResult: Expand<SendAppTransactionResult & Partial<AppCompilationResult>>
Result from sending a single app transaction.
Defined in
Section titled “Defined in”Variables
Section titled “Variables”ABI_RETURN_PREFIX
Section titled “ABI_RETURN_PREFIX”• Const ABI_RETURN_PREFIX: Uint8Array
First 4 bytes of SHA-512/256 hash of “return” for retrieving ABI return values
Defined in
Section titled “Defined in”APP_DEPLOY_NOTE_DAPP
Section titled “APP_DEPLOY_NOTE_DAPP”• Const APP_DEPLOY_NOTE_DAPP: "ALGOKIT_DEPLOYER"
The app create/update ARC-2 transaction note prefix
Defined in
Section titled “Defined in”APP_PAGE_MAX_SIZE
Section titled “APP_PAGE_MAX_SIZE”• Const APP_PAGE_MAX_SIZE: 2048
The maximum number of bytes in a single app code page
Defined in
Section titled “Defined in”DELETABLE_TEMPLATE_NAME
Section titled “DELETABLE_TEMPLATE_NAME”• Const DELETABLE_TEMPLATE_NAME: "TMPL_DELETABLE"
The name of the TEAL template variable for deploy-time permanence control
Defined in
Section titled “Defined in”UPDATABLE_TEMPLATE_NAME
Section titled “UPDATABLE_TEMPLATE_NAME”• Const UPDATABLE_TEMPLATE_NAME: "TMPL_UPDATABLE"
The name of the TEAL template variable for deploy-time immutability control