@algorandfoundation/algokit-utils 1.0.0-beta.8 → 1.0.0

package/types/algod.d.ts

@@ -0,0 +1,137 @@
+import { EncodedSignedTransaction } from 'algosdk';
+/** The response from the pending transaction API @see https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2transactionspendingtxid */
+export interface PendingTransactionResponse {
+    /**
+     * The application id if the transaction was found and it created an
+     * application.
+     */
+    'application-index'?: number;
+    /**
+     * The number of the asset's unit that were transferred to the close-to address.
+     */
+    'asset-closing-amount'?: number;
+    /**
+     * The asset id if the transaction was found and it created an asset.
+     */
+    'asset-index'?: number;
+    /**
+     * Rewards in microalgos applied to the close remainder to account.
+     */
+    'close-rewards'?: number;
+    /**
+     * Closing amount for the transaction.
+     */
+    'closing-amount'?: number;
+    /**
+     * The round where this transaction was confirmed, if present.
+     */
+    'confirmed-round'?: number;
+    /**
+     * (gd) Global state key/value changes for the application being executed by this
+     * transaction.
+     */
+    'global-state-delta'?: Record<string, EvalDelta>[];
+    /**
+     * Inner transactions produced by application execution.
+     */
+    'inner-txns'?: PendingTransactionResponse[];
+    /**
+     * (ld) Local state key/value changes for the application being executed by this
+     * transaction.
+     */
+    'local-state-delta'?: Record<string, EvalDelta>[];
+    /**
+     * (lg) Logs for the application being executed by this transaction.
+     */
+    logs?: Uint8Array[];
+    /** Indicates that the transaction was kicked out of this node's transaction pool (and specifies why that happened).
+     * An empty string indicates the transaction wasn't kicked out of this node's txpool due to an error. */
+    'pool-error': string;
+    /**
+     * Rewards in µALGOs applied to the receiver account.
+     */
+    'receiver-rewards'?: number;
+    /**
+     * Rewards in µALGOs applied to the sender account.
+     */
+    'sender-rewards'?: number;
+    /**
+     * The raw signed transaction.
+     */
+    txn: EncodedSignedTransaction;
+}
+/** Represents a TEAL value delta @see https://developer.algorand.org/docs/rest-apis/algod/v2/#evaldelta */
+export type EvalDelta = {
+    /**
+     * Value `1` refers to **bytes**, value `2` refers to **uint**
+     */
+    action: 1;
+    /**
+     * Bytes value.
+     */
+    bytes: string;
+} | {
+    /**
+     * Value `1` refers to **bytes**, value `2` refers to **uint**
+     */
+    action: 2;
+    /**
+     * Uint value.
+     */
+    uint: number | bigint;
+};
+/** The response from the application API @see https://developer.algorand.org/docs/rest-apis/algod/v2/#get-v2applicationsapplication-id */
+export interface ApplicationResponse {
+    id: number;
+    params: ApplicationParams;
+}
+/** Stores the global information associated with an application @see https://developer.algorand.org/docs/rest-apis/algod/v2/#applicationparams */
+export interface ApplicationParams {
+    /** Address of the account that created the app */
+    creator: string;
+    /** Base64 encoded TEAL approval program */
+    'approval-program': string;
+    /** Base64 encoded TEAL clear state program */
+    'clear-state-program': string;
+    /** The amount of extra program pages available to this app. */
+    'extra-program-pages'?: number;
+    /** Current global state values */
+    'global-state'?: {
+        key: string;
+        value: TealValue;
+    }[];
+    /** Global state schema */
+    'global-state-schema'?: ApplicationStateSchema;
+    /** Local state schema */
+    'local-state-schema'?: ApplicationStateSchema;
+}
+/**
+ * Represents a TEAL value @see https://developer.algorand.org/docs/rest-apis/algod/v2/#tealvalue
+ */
+export type TealValue = {
+    /**
+     * (tt) value type. Value `1` refers to **bytes**, value `2` refers to **uint**
+     */
+    type: 1;
+    /**
+     * (tb) bytes value.
+     */
+    bytes: string;
+} | {
+    /**
+     * (tt) value type. Value `1` refers to **bytes**, value `2` refers to **uint**
+     */
+    type: 2;
+    /**
+     * (ui) uint value.
+     */
+    uint: number | bigint;
+};
+/** Specifies maximums on the number of each type that may be stored @see https://developer.algorand.org/docs/rest-apis/algod/v2/#applicationstateschema */
+export interface ApplicationStateSchema {
+    /** [nbs] num of byte slices */
+    'num-byte-slice': number;
+    /** [nui] num of uints */
+    'num-uint': number;
+}
+//# sourceMappingURL=algod.d.ts.map

package/types/algod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"algod.d.ts","sourceRoot":"","sources":["../../src/types/algod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAElD,+IAA+I;AAC/I,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAA;IAClD;;OAEG;IACH,YAAY,CAAC,EAAE,0BAA0B,EAAE,CAAA;IAC3C;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAA;IACjD;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,EAAE,CAAA;IACnB;4GACwG;IACxG,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;OAEG;IACH,GAAG,EAAE,wBAAwB,CAAA;CAC9B;AAED,2GAA2G;AAC3G,MAAM,MAAM,SAAS,GACjB;IACE;;OAEG;IACH,MAAM,EAAE,CAAC,CAAA;IACT;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd,GACD;IACE;;OAEG;IACH,MAAM,EAAE,CAAC,CAAA;IAET;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB,CAAA;AAEL,0IAA0I;AAC1I,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,iBAAiB,CAAA;CAC1B;AAED,kJAAkJ;AAClJ,MAAM,WAAW,iBAAiB;IAChC,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAA;IACf,2CAA2C;IAC3C,kBAAkB,EAAE,MAAM,CAAA;IAC1B,8CAA8C;IAC9C,qBAAqB,EAAE,MAAM,CAAA;IAC7B,+DAA+D;IAC/D,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,kCAAkC;IAClC,cAAc,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,SAAS,CAAA;KAAE,EAAE,CAAA;IACpD,0BAA0B;IAC1B,qBAAqB,CAAC,EAAE,sBAAsB,CAAA;IAC9C,yBAAyB;IACzB,oBAAoB,CAAC,EAAE,sBAAsB,CAAA;CAC9C;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB;IACE;;OAEG;IACH,IAAI,EAAE,CAAC,CAAA;IACP;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd,GACD;IACE;;OAEG;IACH,IAAI,EAAE,CAAC,CAAA;IAEP;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB,CAAA;AAEL,2JAA2J;AAC3J,MAAM,WAAW,sBAAsB;IACrC,+BAA+B;IAC/B,gBAAgB,EAAE,MAAM,CAAA;IACxB,yBAAyB;IACzB,UAAU,EAAE,MAAM,CAAA;CACnB"}

package/types/algod.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=algod.js.map

package/types/algod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"algod.js","sourceRoot":"","sources":["../../src/types/algod.ts"],"names":[],"mappings":""}

package/types/amount.d.ts

@@ -0,0 +1,20 @@
+/** Wrapper class to ensure safe, explicit conversion between µAlgos, Algos and numbers */
+export declare class AlgoAmount {
+    private amountInMicroAlgos;
+    /** Return the amount as a number in µAlgos */
+    get microAlgos(): number;
+    /** Return the amount as a number in Algos */
+    get algos(): number;
+    constructor(amount: {
+        algos: number;
+    } | {
+        microAlgos: number;
+    });
+    toString(): string;
+    valueOf(): number;
+    /** Create a @see {AlgoAmount} object representing the given number of Algos */
+    static Algos(amount: number): AlgoAmount;
+    /** Create a @see {AlgoAmount} object representing the given number of µAlgos */
+    static MicroAlgos(amount: number): AlgoAmount;
+}
+//# sourceMappingURL=amount.d.ts.map

package/types/amount.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"amount.d.ts","sourceRoot":"","sources":["../../src/types/amount.ts"],"names":[],"mappings":"AAEA,0FAA0F;AAC1F,qBAAa,UAAU;IACrB,OAAO,CAAC,kBAAkB,CAAA;IAE1B,8CAA8C;IAC9C,IAAI,UAAU,WAEb;IAED,6CAA6C;IAC7C,IAAI,KAAK,WAER;gBAEW,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE;IAI9D,QAAQ,IAAI,MAAM;IAIlB,OAAO,IAAI,MAAM;IAIjB,+EAA+E;IAC/E,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM;IAI3B,gFAAgF;IAChF,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM;CAGjC"}

package/types/amount.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AlgoAmount = void 0;
+const algosdk_1 = __importDefault(require("algosdk"));
+/** Wrapper class to ensure safe, explicit conversion between µAlgos, Algos and numbers */
+class AlgoAmount {
+    /** Return the amount as a number in µAlgos */
+    get microAlgos() {
+        return this.amountInMicroAlgos;
+    }
+    /** Return the amount as a number in Algos */
+    get algos() {
+        return algosdk_1.default.microalgosToAlgos(this.amountInMicroAlgos);
+    }
+    constructor(amount) {
+        this.amountInMicroAlgos = 'microAlgos' in amount ? amount.microAlgos : algosdk_1.default.algosToMicroalgos(amount.algos);
+    }
+    toString() {
+        return `${this.microAlgos.toLocaleString('en-US')} µALGO${this.microAlgos === 1 ? '' : 's'}`;
+    }
+    valueOf() {
+        return this.microAlgos;
+    }
+    /** Create a @see {AlgoAmount} object representing the given number of Algos */
+    static Algos(amount) {
+        return new AlgoAmount({ algos: amount });
+    }
+    /** Create a @see {AlgoAmount} object representing the given number of µAlgos */
+    static MicroAlgos(amount) {
+        return new AlgoAmount({ microAlgos: amount });
+    }
+}
+exports.AlgoAmount = AlgoAmount;
+//# sourceMappingURL=amount.js.map

package/types/amount.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"amount.js","sourceRoot":"","sources":["../../src/types/amount.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA6B;AAE7B,0FAA0F;AAC1F,MAAa,UAAU;IAGrB,8CAA8C;IAC9C,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,kBAAkB,CAAA;IAChC,CAAC;IAED,6CAA6C;IAC7C,IAAI,KAAK;QACP,OAAO,iBAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAA;IAC3D,CAAC;IAED,YAAY,MAAkD;QAC5D,IAAI,CAAC,kBAAkB,GAAG,YAAY,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,iBAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAChH,CAAC;IAED,QAAQ;QACN,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,OAAO,CAAC,SAAS,IAAI,CAAC,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;IAC9F,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,UAAU,CAAA;IACxB,CAAC;IAED,+EAA+E;IAC/E,MAAM,CAAC,KAAK,CAAC,MAAc;QACzB,OAAO,IAAI,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAA;IAC1C,CAAC;IAED,gFAAgF;IAChF,MAAM,CAAC,UAAU,CAAC,MAAc;QAC9B,OAAO,IAAI,UAAU,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAA;IAC/C,CAAC;CACF;AAlCD,gCAkCC"}

package/types/app.d.ts

@@ -0,0 +1,279 @@
+import { ABIArgument, ABIMethod, ABIMethodParams, ABIType, ABIValue, Address, SourceMap, SuggestedParams, Transaction } from 'algosdk';
+import { SendTransactionFrom, SendTransactionParams, SendTransactionResult, TransactionNote, TransactionToSign } from './transaction';
+/** The name of the TEAL template variable for deploy-time immutability control */
+export declare const UPDATABLE_TEMPLATE_NAME = "TMPL_UPDATABLE";
+/** The name of the TEAL template variable for deploy-time permanence control */
+export declare const DELETABLE_TEMPLATE_NAME = "TMPL_DELETABLE";
+/** The app create/update ARC-2 transaction note prefix */
+export declare const APP_DEPLOY_NOTE_DAPP = "ALGOKIT_DEPLOYER";
+/** The maximum number of bytes in a single app code page */
+export declare const APP_PAGE_MAX_SIZE = 2048;
+/** First 4 bytes of SHA-512/256 hash of "return" for retrieving ABI return values */
+export declare const ABI_RETURN_PREFIX: Uint8Array;
+/** Information about an Algorand app */
+export interface AppReference {
+    /** The id of the app */
+    appId: number;
+    /** The Algorand address of the account associated with the app */
+    appAddress: string;
+}
+/**
+ * A grouping of the app ID and name of the box in an Uint8Array
+ */
+export interface BoxReference {
+    /**
+     * A unique application id
+     */
+    appId: number;
+    /**
+     * Name of box to reference
+     */
+    name: Uint8Array | string;
+}
+/**
+ * App call args with raw values (minus some processing like encoding strings as binary)
+ */
+export interface RawAppCallArgs {
+    /** The address of any accounts to load in */
+    accounts?: (string | Address)[];
+    /** Any application arguments to pass through */
+    appArgs?: (Uint8Array | string)[];
+    /** Any box references to load */
+    boxes?: BoxReference[];
+    /** IDs of any apps to load into the foreignApps array */
+    apps?: number[];
+    /** IDs of any assets to load into the foreignAssets array */
+    assets?: number[];
+    /** The optional lease for the transaction */
+    lease?: string | Uint8Array;
+}
+export type ABIAppCallArg = ABIArgument | TransactionToSign | Transaction;
+/**
+ * App call args for an ABI call
+ */
+export interface ABIAppCallArgs {
+    /** The ABI method to call, either:
+     *  * `method_name` e.g. `hello`; or
+     *  * `method_signature` e.g. `hello(string)string`
+     **/
+    method: ABIMethodParams | ABIMethod;
+    /** The ABI args to pass in */
+    args: ABIAppCallArg[];
+    /** The optional lease for the transaction */
+    lease?: string | Uint8Array;
+    /** Any box references to load either as the box name (if for the current app) or the reference with app id */
+    boxes?: (BoxReference | Uint8Array | string)[];
+}
+/** 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)
+ **/
+export type AppCallArgs = RawAppCallArgs | ABIAppCallArgs;
+/** Base interface for common data passed to an app create or update. */
+interface CreateOrUpdateAppParams extends SendTransactionParams {
+    /** The account (with private key loaded) that will send the µALGOs */
+    from: SendTransactionFrom;
+    /** The approval program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) */
+    approvalProgram: Uint8Array | string;
+    /** The clear state program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) */
+    clearStateProgram: Uint8Array | string;
+    /** Optional transaction parameters */
+    transactionParams?: SuggestedParams;
+    /** The (optional) transaction note */
+    note?: TransactionNote;
+    /** The arguments passed in to the app call */
+    args?: AppCallArgs;
+}
+/** Parameters that are passed in when creating an app. */
+export interface CreateAppParams extends CreateOrUpdateAppParams {
+    /** The storage schema to request for the created app */
+    schema: AppStorageSchema;
+}
+/** Parameters that are passed in when updating an app. */
+export interface UpdateAppParams extends CreateOrUpdateAppParams {
+    /** The id of the app to update */
+    appId: number;
+}
+export interface AppCallParams extends SendTransactionParams {
+    /** The id of the app to call */
+    appId: number;
+    /** The type of call, everything except create (@see createApp ) and update (@see updateApp ) */
+    callType: 'optin' | 'closeout' | 'clearstate' | 'delete' | 'normal';
+    /** The account to make the call from */
+    from: SendTransactionFrom;
+    /** Optional transaction parameters */
+    transactionParams?: SuggestedParams;
+    /** The (optional) transaction note */
+    note?: TransactionNote;
+    /** The arguments passed in to the app call */
+    args?: AppCallArgs;
+}
+/** Parameters representing the storage schema of an app. */
+export interface AppStorageSchema {
+    /** Restricts number of ints in per-user local state */
+    localInts: number;
+    /** Restricts number of byte slices in per-user local state */
+    localByteSlices: number;
+    /** Restricts number of ints in global state */
+    globalInts: number;
+    /** Restricts number of byte slices in global state */
+    globalByteSlices: number;
+    /** Any extra pages that are needed for the smart contract; if left blank then the right number of pages will be calculated based on the teal code size */
+    extraPages?: number;
+}
+/** Information about a compiled teal program */
+export interface CompiledTeal {
+    /** Original TEAL code */
+    teal: string;
+    /** The compiled code */
+    compiled: string;
+    /** The has returned by the compiler */
+    compiledHash: string;
+    /** The base64 encoded code as a byte array */
+    compiledBase64ToBytes: Uint8Array;
+    /** Source map from the compilation */
+    sourceMap: SourceMap;
+}
+/** Result from calling an app */
+export interface AppCallTransactionResult extends SendTransactionResult {
+    /** If an ABI method was called the processed return value */
+    return?: ABIReturn;
+}
+/** The return value of an ABI method call */
+export type ABIReturn = {
+    rawReturnValue: Uint8Array;
+    returnValue: ABIValue;
+    decodeError: undefined;
+} | {
+    rawReturnValue: undefined;
+    returnValue: undefined;
+    decodeError: Error;
+};
+/**
+ * The payload of the metadata to add to the transaction note when deploying an app, noting it will be prefixed with @see {APP_DEPLOY_NOTE_PREFIX}.
+ */
+export interface AppDeployMetadata {
+    /** The unique name identifier of the app within the creator account */
+    name: string;
+    /** The version of app that is / will be deployed */
+    version: string;
+    /** Whether or not the app is deletable / permanent / unspecified */
+    deletable?: boolean;
+    /** Whether or not the app is updatable / immutable / unspecified */
+    updatable?: boolean;
+}
+/** The metadata that can be collected about a deployed app */
+export interface AppMetadata extends AppReference, AppDeployMetadata {
+    /** The round the app was created */
+    createdRound: number;
+    /** The last round that the app was updated */
+    updatedRound: number;
+    /** The metadata when the app was created */
+    createdMetadata: AppDeployMetadata;
+    /** Whether or not the app is deleted */
+    deleted: boolean;
+}
+/** A lookup of name -> Algorand app for a creator */
+export interface AppLookup {
+    creator: Readonly<string>;
+    apps: Readonly<{
+        [name: string]: AppMetadata;
+    }>;
+}
+/** Dictionary of deploy-time parameters to replace in a teal template.
+ *
+ * Note: Looks for `TMPL_{parameter}` for template replacements i.e. you can leave out the `TMPL_`.
+ *
+ */
+export interface TealTemplateParams {
+    [key: string]: string | bigint | number | Uint8Array;
+}
+/** What action to perform when deploying an app and an update is detected in the TEAL code */
+export declare enum OnUpdate {
+    /** Fail the deployment */
+    Fail = 0,
+    /** Update the app */
+    UpdateApp = 1,
+    /** Delete the app and create a new one in its place */
+    ReplaceApp = 2
+}
+/** What action to perform when deploying an app and a breaking schema change is detected */
+export declare enum OnSchemaBreak {
+    /** Fail the deployment */
+    Fail = 0,
+    /** Delete the app and create a new one in its place */
+    ReplaceApp = 1
+}
+/** The parameters to deploy an app */
+export interface AppDeploymentParams extends Omit<CreateAppParams, 'args' | 'note' | 'skipSending' | 'skipWaiting'> {
+    /** The deployment metadata */
+    metadata: AppDeployMetadata;
+    /** Any deploy-time parameters to replace in the TEAL code */
+    deployTimeParams?: TealTemplateParams;
+    /** What action to perform if a schema break is detected */
+    onSchemaBreak?: 'replace' | 'fail' | OnSchemaBreak;
+    /** What action to perform if a TEAL update is detected */
+    onUpdate?: 'update' | 'replace' | 'fail' | OnUpdate;
+    /** Optional cached value of the existing apps for the given creator */
+    existingDeployments?: AppLookup;
+    /** Any args to pass to any create transaction that is issued as part of deployment */
+    createArgs?: AppCallArgs;
+    /** Any args to pass to any update transaction that is issued as part of deployment */
+    updateArgs?: AppCallArgs;
+    /** Any args to pass to any delete transaction that is issued as part of deployment */
+    deleteArgs?: AppCallArgs;
+}
+/** The result of compiling the approval and clear TEAL for an app */
+export interface AppCompilationResult {
+    /** The compilation result of approval */
+    compiledApproval: CompiledTeal;
+    /** The compilation result of clear */
+    compiledClear: CompiledTeal;
+}
+/** Object holding app state values */
+export interface AppState {
+    [key: string]: {
+        value: number | bigint;
+        keyRaw: Uint8Array;
+        keyBase64: string;
+    } | {
+        value: string;
+        valueRaw: Uint8Array;
+        valueBase64: string;
+        keyRaw: Uint8Array;
+        keyBase64: string;
+    };
+}
+/** The name of a box storage box */
+export interface BoxName {
+    /** Name in UTF-8 */
+    name: string;
+    /** Name in binary bytes */
+    nameRaw: Uint8Array;
+    /** Name in Base64 */
+    nameBase64: string;
+}
+/**
+ * Parameters to get and decode a box value as an ABI type.
+ */
+export interface BoxValueRequestParams {
+    /** The ID of the app return box names for */
+    appId: number;
+    /** The name of the box to return either as a string, binary array or @see BoxName */
+    boxName: string | Uint8Array | BoxName;
+    /** The ABI type to decode the value using */
+    type: ABIType;
+}
+/**
+ * Parameters to get and decode a box value as an ABI type.
+ */
+export interface BoxValuesRequestParams {
+    /** The ID of the app return box names for */
+    appId: number;
+    /** The names of the boxes to return either as a string, binary array or @see BoxName */
+    boxNames: (string | Uint8Array | BoxName)[];
+    /** The ABI type to decode the value using */
+    type: ABIType;
+}
+export {};
+//# sourceMappingURL=app.d.ts.map

package/types/app.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../src/types/app.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AACtI,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AAErI,kFAAkF;AAClF,eAAO,MAAM,uBAAuB,mBAAmB,CAAA;AAEvD,gFAAgF;AAChF,eAAO,MAAM,uBAAuB,mBAAmB,CAAA;AAEvD,0DAA0D;AAC1D,eAAO,MAAM,oBAAoB,qBAAqB,CAAA;AAEtD,4DAA4D;AAC5D,eAAO,MAAM,iBAAiB,OAAO,CAAA;AAErC,qFAAqF;AACrF,eAAO,MAAM,iBAAiB,YAAqC,CAAA;AAEnE,wCAAwC;AACxC,MAAM,WAAW,YAAY;IAC3B,wBAAwB;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,kEAAkE;IAClE,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,IAAI,EAAE,UAAU,GAAG,MAAM,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,CAAC,MAAM,GAAG,OAAO,CAAC,EAAE,CAAA;IAC/B,gDAAgD;IAChD,OAAO,CAAC,EAAE,CAAC,UAAU,GAAG,MAAM,CAAC,EAAE,CAAA;IACjC,iCAAiC;IACjC,KAAK,CAAC,EAAE,YAAY,EAAE,CAAA;IACtB,yDAAyD;IACzD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,6DAA6D;IAC7D,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;CAC5B;AAED,MAAM,MAAM,aAAa,GAAG,WAAW,GAAG,iBAAiB,GAAG,WAAW,CAAA;AAEzE;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;QAGI;IACJ,MAAM,EAAE,eAAe,GAAG,SAAS,CAAA;IACnC,8BAA8B;IAC9B,IAAI,EAAE,aAAa,EAAE,CAAA;IACrB,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;IAC3B,8GAA8G;IAC9G,KAAK,CAAC,EAAE,CAAC,YAAY,GAAG,UAAU,GAAG,MAAM,CAAC,EAAE,CAAA;CAC/C;AAED;;;IAGI;AACJ,MAAM,MAAM,WAAW,GAAG,cAAc,GAAG,cAAc,CAAA;AAEzD,wEAAwE;AACxE,UAAU,uBAAwB,SAAQ,qBAAqB;IAC7D,sEAAsE;IACtE,IAAI,EAAE,mBAAmB,CAAA;IACzB,+GAA+G;IAC/G,eAAe,EAAE,UAAU,GAAG,MAAM,CAAA;IACpC,kHAAkH;IAClH,iBAAiB,EAAE,UAAU,GAAG,MAAM,CAAA;IACtC,sCAAsC;IACtC,iBAAiB,CAAC,EAAE,eAAe,CAAA;IACnC,sCAAsC;IACtC,IAAI,CAAC,EAAE,eAAe,CAAA;IACtB,8CAA8C;IAC9C,IAAI,CAAC,EAAE,WAAW,CAAA;CACnB;AAED,0DAA0D;AAC1D,MAAM,WAAW,eAAgB,SAAQ,uBAAuB;IAC9D,wDAAwD;IACxD,MAAM,EAAE,gBAAgB,CAAA;CACzB;AAED,0DAA0D;AAC1D,MAAM,WAAW,eAAgB,SAAQ,uBAAuB;IAC9D,kCAAkC;IAClC,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,aAAc,SAAQ,qBAAqB;IAC1D,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAA;IACb,gGAAgG;IAChG,QAAQ,EAAE,OAAO,GAAG,UAAU,GAAG,YAAY,GAAG,QAAQ,GAAG,QAAQ,CAAA;IACnE,wCAAwC;IACxC,IAAI,EAAE,mBAAmB,CAAA;IACzB,sCAAsC;IACtC,iBAAiB,CAAC,EAAE,eAAe,CAAA;IACnC,sCAAsC;IACtC,IAAI,CAAC,EAAE,eAAe,CAAA;IACtB,8CAA8C;IAC9C,IAAI,CAAC,EAAE,WAAW,CAAA;CACnB;AAED,4DAA4D;AAC5D,MAAM,WAAW,gBAAgB;IAC/B,uDAAuD;IACvD,SAAS,EAAE,MAAM,CAAA;IACjB,8DAA8D;IAC9D,eAAe,EAAE,MAAM,CAAA;IACvB,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAA;IAClB,sDAAsD;IACtD,gBAAgB,EAAE,MAAM,CAAA;IACxB,0JAA0J;IAC1J,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,gDAAgD;AAChD,MAAM,WAAW,YAAY;IAC3B,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,wBAAwB;IACxB,QAAQ,EAAE,MAAM,CAAA;IAChB,uCAAuC;IACvC,YAAY,EAAE,MAAM,CAAA;IACpB,8CAA8C;IAC9C,qBAAqB,EAAE,UAAU,CAAA;IACjC,sCAAsC;IACtC,SAAS,EAAE,SAAS,CAAA;CACrB;AAED,iCAAiC;AACjC,MAAM,WAAW,wBAAyB,SAAQ,qBAAqB;IACrE,6DAA6D;IAC7D,MAAM,CAAC,EAAE,SAAS,CAAA;CACnB;AAED,6CAA6C;AAC7C,MAAM,MAAM,SAAS,GACjB;IACE,cAAc,EAAE,UAAU,CAAA;IAC1B,WAAW,EAAE,QAAQ,CAAA;IACrB,WAAW,EAAE,SAAS,CAAA;CACvB,GACD;IAAE,cAAc,EAAE,SAAS,CAAC;IAAC,WAAW,EAAE,SAAS,CAAC;IAAC,WAAW,EAAE,KAAK,CAAA;CAAE,CAAA;AAE7E;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,uEAAuE;IACvE,IAAI,EAAE,MAAM,CAAA;IACZ,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAA;IACf,oEAAoE;IACpE,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,oEAAoE;IACpE,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,8DAA8D;AAC9D,MAAM,WAAW,WAAY,SAAQ,YAAY,EAAE,iBAAiB;IAClE,oCAAoC;IACpC,YAAY,EAAE,MAAM,CAAA;IACpB,8CAA8C;IAC9C,YAAY,EAAE,MAAM,CAAA;IACpB,4CAA4C;IAC5C,eAAe,EAAE,iBAAiB,CAAA;IAClC,wCAAwC;IACxC,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,qDAAqD;AACrD,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;IACzB,IAAI,EAAE,QAAQ,CAAC;QACb,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAAA;KAC5B,CAAC,CAAA;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAA;CACrD;AAED,8FAA8F;AAC9F,oBAAY,QAAQ;IAClB,0BAA0B;IAC1B,IAAI,IAAA;IACJ,qBAAqB;IACrB,SAAS,IAAA;IACT,uDAAuD;IACvD,UAAU,IAAA;CACX;AAED,4FAA4F;AAC5F,oBAAY,aAAa;IACvB,0BAA0B;IAC1B,IAAI,IAAA;IACJ,uDAAuD;IACvD,UAAU,IAAA;CACX;AAED,sCAAsC;AACtC,MAAM,WAAW,mBAAoB,SAAQ,IAAI,CAAC,eAAe,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,aAAa,CAAC;IACjH,8BAA8B;IAC9B,QAAQ,EAAE,iBAAiB,CAAA;IAC3B,6DAA6D;IAC7D,gBAAgB,CAAC,EAAE,kBAAkB,CAAA;IACrC,2DAA2D;IAC3D,aAAa,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,aAAa,CAAA;IAClD,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,QAAQ,CAAA;IACnD,uEAAuE;IACvE,mBAAmB,CAAC,EAAE,SAAS,CAAA;IAC/B,sFAAsF;IACtF,UAAU,CAAC,EAAE,WAAW,CAAA;IACxB,sFAAsF;IACtF,UAAU,CAAC,EAAE,WAAW,CAAA;IACxB,sFAAsF;IACtF,UAAU,CAAC,EAAE,WAAW,CAAA;CACzB;AAED,qEAAqE;AACrE,MAAM,WAAW,oBAAoB;IACnC,yCAAyC;IACzC,gBAAgB,EAAE,YAAY,CAAA;IAC9B,sCAAsC;IACtC,aAAa,EAAE,YAAY,CAAA;CAC5B;AAED,sCAAsC;AACtC,MAAM,WAAW,QAAQ;IACvB,CAAC,GAAG,EAAE,MAAM,GACR;QACE,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;QACtB,MAAM,EAAE,UAAU,CAAA;QAClB,SAAS,EAAE,MAAM,CAAA;KAClB,GACD;QACE,KAAK,EAAE,MAAM,CAAA;QACb,QAAQ,EAAE,UAAU,CAAA;QACpB,WAAW,EAAE,MAAM,CAAA;QACnB,MAAM,EAAE,UAAU,CAAA;QAClB,SAAS,EAAE,MAAM,CAAA;KAClB,CAAA;CACN;AAED,oCAAoC;AACpC,MAAM,WAAW,OAAO;IACtB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,2BAA2B;IAC3B,OAAO,EAAE,UAAU,CAAA;IACnB,qBAAqB;IACrB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAA;IACb,qFAAqF;IACrF,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAAA;IACtC,6CAA6C;IAC7C,IAAI,EAAE,OAAO,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAA;IACb,wFAAwF;IACxF,QAAQ,EAAE,CAAC,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC,EAAE,CAAA;IAC3C,6CAA6C;IAC7C,IAAI,EAAE,OAAO,CAAA;CACd"}

package/types/app.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OnSchemaBreak = exports.OnUpdate = exports.ABI_RETURN_PREFIX = exports.APP_PAGE_MAX_SIZE = exports.APP_DEPLOY_NOTE_DAPP = exports.DELETABLE_TEMPLATE_NAME = exports.UPDATABLE_TEMPLATE_NAME = void 0;
+/** The name of the TEAL template variable for deploy-time immutability control */
+exports.UPDATABLE_TEMPLATE_NAME = 'TMPL_UPDATABLE';
+/** The name of the TEAL template variable for deploy-time permanence control */
+exports.DELETABLE_TEMPLATE_NAME = 'TMPL_DELETABLE';
+/** The app create/update ARC-2 transaction note prefix */
+exports.APP_DEPLOY_NOTE_DAPP = 'ALGOKIT_DEPLOYER';
+/** The maximum number of bytes in a single app code page */
+exports.APP_PAGE_MAX_SIZE = 2048;
+/** First 4 bytes of SHA-512/256 hash of "return" for retrieving ABI return values */
+exports.ABI_RETURN_PREFIX = new Uint8Array([21, 31, 124, 117]);
+/** What action to perform when deploying an app and an update is detected in the TEAL code */
+var OnUpdate;
+(function (OnUpdate) {
+    /** Fail the deployment */
+    OnUpdate[OnUpdate["Fail"] = 0] = "Fail";
+    /** Update the app */
+    OnUpdate[OnUpdate["UpdateApp"] = 1] = "UpdateApp";
+    /** Delete the app and create a new one in its place */
+    OnUpdate[OnUpdate["ReplaceApp"] = 2] = "ReplaceApp";
+})(OnUpdate = exports.OnUpdate || (exports.OnUpdate = {}));
+/** What action to perform when deploying an app and a breaking schema change is detected */
+var OnSchemaBreak;
+(function (OnSchemaBreak) {
+    /** Fail the deployment */
+    OnSchemaBreak[OnSchemaBreak["Fail"] = 0] = "Fail";
+    /** Delete the app and create a new one in its place */
+    OnSchemaBreak[OnSchemaBreak["ReplaceApp"] = 1] = "ReplaceApp";
+})(OnSchemaBreak = exports.OnSchemaBreak || (exports.OnSchemaBreak = {}));
+//# sourceMappingURL=app.js.map

package/types/app.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.js","sourceRoot":"","sources":["../../src/types/app.ts"],"names":[],"mappings":";;;AAGA,kFAAkF;AACrE,QAAA,uBAAuB,GAAG,gBAAgB,CAAA;AAEvD,gFAAgF;AACnE,QAAA,uBAAuB,GAAG,gBAAgB,CAAA;AAEvD,0DAA0D;AAC7C,QAAA,oBAAoB,GAAG,kBAAkB,CAAA;AAEtD,4DAA4D;AAC/C,QAAA,iBAAiB,GAAG,IAAI,CAAA;AAErC,qFAAqF;AACxE,QAAA,iBAAiB,GAAG,IAAI,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAA;AAoMnE,8FAA8F;AAC9F,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,0BAA0B;IAC1B,uCAAI,CAAA;IACJ,qBAAqB;IACrB,iDAAS,CAAA;IACT,uDAAuD;IACvD,mDAAU,CAAA;AACZ,CAAC,EAPW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAOnB;AAED,4FAA4F;AAC5F,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,0BAA0B;IAC1B,iDAAI,CAAA;IACJ,uDAAuD;IACvD,6DAAU,CAAA;AACZ,CAAC,EALW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAKxB"}