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

@algorandfoundation/algokit-utils / types/app

Module: types/app

Table of contents

Enumerations

Interfaces

Type Aliases

Variables

Type Aliases

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

src/types/app.ts:96


ABIAppCallArgs

Ƭ ABIAppCallArgs: CoreAppCallArgs & { method: ABIMethodParams | ABIMethod ; methodArgs: ABIAppCallArg[] }

App call args for an ABI call

Defined in

src/types/app.ts:107


ABIReturn

Ƭ ABIReturn: { decodeError: undefined ; rawReturnValue: Uint8Array ; returnValue: ABIValue } | { decodeError: Error ; rawReturnValue: undefined ; returnValue: undefined }

The return value of an ABI method call

Defined in

src/types/app.ts:217


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

src/types/app.ts:118


AppCallType

Ƭ AppCallType: "no_op" | "opt_in" | "close_out" | "clear_state" | "update_application" | "delete_application"

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 action
  • opt_in: Opt-in to smart contract local storage
  • close_out: Close-out local storage storage
  • clear_state: Clear local storage state
  • update_application: Update the smart contract
  • delete_application: Delete the smart contract
Defined in

src/types/app.ts:161


BoxIdentifier

Ƭ BoxIdentifier: string | Uint8Array | SendTransactionFrom

Something that identifies a box name - either a: * Uint8Array * string (that will be encoded to a Uint8Array) * SendTransactionFrom (encoded into the public key address of the corresponding account)

Defined in

src/types/app.ts:64

Variables

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

src/types/app.ts:34


APP_DEPLOY_NOTE_DAPP

Const APP_DEPLOY_NOTE_DAPP: "ALGOKIT_DEPLOYER"

The app create/update ARC-2 transaction note prefix

Defined in

src/types/app.ts:28


APP_PAGE_MAX_SIZE

Const APP_PAGE_MAX_SIZE: 2048

The maximum number of bytes in a single app code page

Defined in

src/types/app.ts:31


DELETABLE_TEMPLATE_NAME

Const DELETABLE_TEMPLATE_NAME: "TMPL_DELETABLE"

The name of the TEAL template variable for deploy-time permanence control

Defined in

src/types/app.ts:25


UPDATABLE_TEMPLATE_NAME

Const UPDATABLE_TEMPLATE_NAME: "TMPL_UPDATABLE"

The name of the TEAL template variable for deploy-time immutability control

Defined in

src/types/app.ts:22