@algorandfoundation/algokit-utils 1.0.0-beta.2 → 1.0.0-beta.21

package/types/algod.js.map

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

package/{dist/algo-amount.d.ts → types/amount.d.ts}

@@ -10,9 +10,11 @@ export declare class AlgoAmount {
     } | {
         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=algo-amount.d.ts.map
+//# 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/{dist/algo-amount.js → types/amount.js}

@@ -18,6 +18,12 @@ class AlgoAmount {
     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 });
@@ -28,4 +34,4 @@ class AlgoAmount {
     }
 }
 exports.AlgoAmount = AlgoAmount;
-//# sourceMappingURL=algo-amount.js.map
+//# 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,234 @@
+import { ABIArgument, ABIMethod, ABIMethodParams, 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 */
+    boxes?: BoxReference[];
+}
+/** 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 TealTemplateParameters {
+    [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 */
+    deployTimeParameters?: TealTemplateParameters;
+    /** 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;
+}
+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,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAC7H,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,iCAAiC;IACjC,KAAK,CAAC,EAAE,YAAY,EAAE,CAAA;CACvB;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,sBAAsB;IACrC,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,oBAAoB,CAAC,EAAE,sBAAsB,CAAA;IAC7C,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"}

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"}

package/types/application-client.d.ts

@@ -0,0 +1,155 @@
+import { ABIMethodParams, Algodv2, Indexer, SuggestedParams } from 'algosdk';
+import { ABIAppCallArg, ABIAppCallArgs, AppCallArgs, AppLookup, AppMetadata, AppReference, OnSchemaBreak, OnUpdate, RawAppCallArgs, TealTemplateParameters } from './app';
+import { AppSpec } from './appspec';
+import { SendTransactionFrom, SendTransactionParams, TransactionNote } from './transaction';
+/** Configuration to resolve app by creator and name @see getCreatorAppsByName */
+export type ResolveAppByCreatorAndName = {
+    /** The address of the app creator account to resolve the app by */
+    creatorAddress: string;
+    /** The optional name to resolve the app by within the creator account (default: uses the name in the ABI contract) */
+    name?: string;
+} & ({
+    /** indexer An indexer instance to search the creator account apps */
+    indexer: Indexer;
+} | {
+    /** Optional cached value of the existing apps for the given creator, @see getCreatorAppsByName */
+    existingDeployments: AppLookup;
+});
+/** Configuration to resolve app by ID */
+export interface ResolveAppById {
+    /** The id of an existing app to call using this client, or 0 if the app hasn't been created yet */
+    id: number;
+    /** The optional name to use to mark the app when deploying @see ApplicationClient.deploy (default: uses the name in the ABI contract) */
+    name?: string;
+}
+/** The details of an ARC-0032 app spec specified app */
+export type AppSpecAppDetails = {
+    /** The ARC-0032 application spec as either:
+     *  * Parsed JSON @see {AppSpec}
+     *  * Raw JSON string
+     */
+    app: AppSpec | string;
+    /** Default sender to use for transactions issued by this application client */
+    sender?: SendTransactionFrom;
+    /** Default suggested params object to use */
+    params?: SuggestedParams;
+} & (ResolveAppById | ResolveAppByCreatorAndName);
+/** Parameters to pass into ApplicationClient.deploy */
+export interface AppClientDeployParams {
+    /** The version of the contract, uses "1.0" by default */
+    version?: string;
+    /** The optional sender to send the transaction from, will use the application client's default sender by default if specified */
+    sender?: SendTransactionFrom;
+    /** Whether or not to allow updates in the contract using the deploy-time updatability control if present in your contract.
+     * If this is not specified then it will automatically be determined based on the AppSpec definition
+     **/
+    allowUpdate?: boolean;
+    /** Whether or not to allow deletes in the contract using the deploy-time deletability control if present in your contract.
+     * If this is not specified then it will automatically be determined based on the AppSpec definition
+     **/
+    allowDelete?: boolean;
+    /** Parameters to control transaction sending */
+    sendParams?: Omit<SendTransactionParams, 'skipSending' | 'skipWaiting'>;
+    /** Any deploy-time parameters to replace in the TEAL code */
+    deployTimeParameters?: TealTemplateParameters;
+    /** 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;
+    /** Any args to pass to any create transaction that is issued as part of deployment */
+    createArgs?: AppClientCallArgs;
+    /** Any args to pass to any update transaction that is issued as part of deployment */
+    updateArgs?: AppClientCallArgs;
+    /** Any args to pass to any delete transaction that is issued as part of deployment */
+    deleteArgs?: AppClientCallArgs;
+}
+/** The arguments to pass to an Application Client smart contract call */
+export type AppClientCallArgs = {
+    /** Raw argument values to pass to the smart contract call */
+    args?: RawAppCallArgs;
+} | {
+    /** If calling an ABI method then either the name of the method, or the ABI signature */
+    method: string;
+    /** Either the ABI arguments or an object with the ABI arguments and other parameters like boxes */
+    methodArgs: Omit<ABIAppCallArgs, 'method'> | ABIAppCallArg[];
+};
+/** Parameters to construct a ApplicationClient contract call */
+export type AppClientCallParams = AppClientCallArgs & {
+    /** The optional sender to send the transaction from, will use the application client's default sender by default if specified */
+    sender?: SendTransactionFrom;
+    /** The transaction note for the smart contract call */
+    note?: TransactionNote;
+    /** Parameters to control transaction sending */
+    sendParams?: SendTransactionParams;
+};
+/** Parameters for creating a contract using ApplicationClient */
+export type AppClientCreateParams = AppClientCallParams & {
+    /** Any deploy-time parameters to replace in the TEAL code */
+    deployTimeParameters?: TealTemplateParameters;
+    updatable?: boolean;
+    deletable?: boolean;
+};
+/** Parameters for updating a contract using ApplicationClient */
+export type AppClientUpdateParams = AppClientCreateParams;
+/** Application client - a class that wraps an ARC-0032 app spec and provides high productivity methods to deploy and call the app */
+export declare class ApplicationClient {
+    private algod;
+    private indexer?;
+    private appSpec;
+    private sender;
+    private params;
+    private existingDeployments;
+    private _appId;
+    private _appAddress;
+    private _creator;
+    private _appName;
+    private _approvalSourceMap;
+    private _clearSourceMap;
+    /**
+     * Create a new ApplicationClient instance
+     * @param appDetails The details of the app
+     * @param algod An algod instance
+     * @param indexer An indexer instance
+     */
+    constructor(appDetails: AppSpecAppDetails, algod: Algodv2);
+    /**
+     * Idempotently deploy (create, update/delete if changed) an app against the given name via the given creator account, including deploy-time template placeholder substitutions.
+     *
+     * To understand the architecture decisions behind this functionality please @see https://github.com/algorandfoundation/algokit-cli/blob/main/docs/architecture-decisions/2023-01-12_smart-contract-deployment.md
+     *
+     * **Note:** if there is a breaking state schema change to an existing app (and `onSchemaBreak` is set to `'replace'`) the existing app will be deleted and re-created.
+     *
+     * **Note:** if there is an update (different TEAL code) to an existing app (and `onUpdate` is set to `'replace'`) the existing app will be deleted and re-created.
+     * @param deploy Deployment details
+     * @returns The metadata and transaction result(s) of the deployment, or just the metadata if it didn't need to issue transactions
+     */
+    deploy(deploy: AppClientDeployParams): Promise<(Partial<import("./app").AppCompilationResult> & import("./transaction").ConfirmedTransactionResult & AppMetadata & {
+        operationPerformed: "update" | "create";
+    }) | (Partial<import("./app").AppCompilationResult> & import("./transaction").ConfirmedTransactionResult & AppMetadata & {
+        deleteResult: import("./transaction").ConfirmedTransactionResult;
+        operationPerformed: "replace";
+    }) | (Partial<import("./app").AppCompilationResult> & AppMetadata & {
+        operationPerformed: "nothing";
+    })>;
+    create(create?: AppClientCreateParams): Promise<Partial<import("./app").AppCompilationResult> & import("./app").AppCallTransactionResult & AppReference>;
+    update(update?: AppClientUpdateParams): Promise<Partial<import("./app").AppCompilationResult> & import("./app").AppCallTransactionResult>;
+    call(call: AppClientCallParams): Promise<import("./app").AppCallTransactionResult>;
+    optIn(call: AppClientCallParams): Promise<import("./app").AppCallTransactionResult>;
+    closeOut(call: AppClientCallParams): Promise<import("./app").AppCallTransactionResult>;
+    clearState(call: AppClientCallParams): Promise<import("./app").AppCallTransactionResult>;
+    delete(call: AppClientCallParams): Promise<import("./app").AppCallTransactionResult>;
+    private _call;
+    getCallArgs(args?: AppClientCallArgs): AppCallArgs | undefined;
+    getABIMethod(method: string): ABIMethodParams | undefined;
+    getAppReference(): Promise<AppMetadata | AppReference>;
+    /**
+     * Takes an error that may include a logic error from a smart contract call and re-exposes the error to include source code information via the source map.
+     * This is automatically used within @see ApplicationClient but if you pass `skipSending: true` e.g. if doing a group transaction
+     *  then you can use this in a try/catch block to get better debugging information.
+     * @param e The error to parse
+     * @param isClear Whether or not the code was running the clear state program
+     * @returns The new error, or if there was no logic error or source map then the wrapped error with source details
+     */
+    exposeLogicError(e: Error, isClear?: boolean): Error;
+}
+//# sourceMappingURL=application-client.d.ts.map

package/types/application-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"application-client.d.ts","sourceRoot":"","sources":["../../src/types/application-client.ts"],"names":[],"mappings":"AAAA,OAAgB,EAAE,eAAe,EAAE,OAAO,EAAyB,OAAO,EAAa,eAAe,EAAE,MAAM,SAAS,CAAA;AAKvH,OAAO,EACL,aAAa,EACb,cAAc,EACd,WAAW,EACX,SAAS,EACT,WAAW,EACX,YAAY,EAEZ,aAAa,EACb,QAAQ,EACR,cAAc,EACd,sBAAsB,EAEvB,MAAM,OAAO,CAAA;AACd,OAAO,EAAE,OAAO,EAAmB,MAAM,WAAW,CAAA;AAEpD,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE3F,iFAAiF;AACjF,MAAM,MAAM,0BAA0B,GAAG;IACvC,mEAAmE;IACnE,cAAc,EAAE,MAAM,CAAA;IACtB,sHAAsH;IACtH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,GAAG,CACA;IACE,qEAAqE;IACrE,OAAO,EAAE,OAAO,CAAA;CACjB,GACD;IACE,kGAAkG;IAClG,mBAAmB,EAAE,SAAS,CAAA;CAC/B,CACJ,CAAA;AAED,yCAAyC;AACzC,MAAM,WAAW,cAAc;IAC7B,mGAAmG;IACnG,EAAE,EAAE,MAAM,CAAA;IACV,yIAAyI;IACzI,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,wDAAwD;AACxD,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;OAGG;IACH,GAAG,EAAE,OAAO,GAAG,MAAM,CAAA;IACrB,+EAA+E;IAC/E,MAAM,CAAC,EAAE,mBAAmB,CAAA;IAC5B,6CAA6C;IAC7C,MAAM,CAAC,EAAE,eAAe,CAAA;CACzB,GAAG,CAAC,cAAc,GAAG,0BAA0B,CAAC,CAAA;AAEjD,uDAAuD;AACvD,MAAM,WAAW,qBAAqB;IACpC,yDAAyD;IACzD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iIAAiI;IACjI,MAAM,CAAC,EAAE,mBAAmB,CAAA;IAC5B;;QAEI;IACJ,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;QAEI;IACJ,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,gDAAgD;IAChD,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,EAAE,aAAa,GAAG,aAAa,CAAC,CAAA;IACvE,6DAA6D;IAC7D,oBAAoB,CAAC,EAAE,sBAAsB,CAAA;IAC7C,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,sFAAsF;IACtF,UAAU,CAAC,EAAE,iBAAiB,CAAA;IAC9B,sFAAsF;IACtF,UAAU,CAAC,EAAE,iBAAiB,CAAA;IAC9B,sFAAsF;IACtF,UAAU,CAAC,EAAE,iBAAiB,CAAA;CAC/B;AAED,yEAAyE;AACzE,MAAM,MAAM,iBAAiB,GACzB;IACE,6DAA6D;IAC7D,IAAI,CAAC,EAAE,cAAc,CAAA;CACtB,GACD;IACE,wFAAwF;IACxF,MAAM,EAAE,MAAM,CAAA;IACd,mGAAmG;IACnG,UAAU,EAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,GAAG,aAAa,EAAE,CAAA;CAC7D,CAAA;AAEL,gEAAgE;AAChE,MAAM,MAAM,mBAAmB,GAAG,iBAAiB,GAAG;IACpD,iIAAiI;IACjI,MAAM,CAAC,EAAE,mBAAmB,CAAA;IAC5B,uDAAuD;IACvD,IAAI,CAAC,EAAE,eAAe,CAAA;IACtB,gDAAgD;IAChD,UAAU,CAAC,EAAE,qBAAqB,CAAA;CACnC,CAAA;AAED,iEAAiE;AACjE,MAAM,MAAM,qBAAqB,GAAG,mBAAmB,GAAG;IACxD,6DAA6D;IAC7D,oBAAoB,CAAC,EAAE,sBAAsB,CAAA;IAE7C,SAAS,CAAC,EAAE,OAAO,CAAA;IAEnB,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB,CAAA;AAED,iEAAiE;AACjE,MAAM,MAAM,qBAAqB,GAAG,qBAAqB,CAAA;AAEzD,qIAAqI;AACrI,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,OAAO,CAAC,CAAiB;IACjC,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,MAAM,CAAiC;IAC/C,OAAO,CAAC,MAAM,CAA6B;IAC3C,OAAO,CAAC,mBAAmB,CAAuB;IAElD,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,WAAW,CAAQ;IAC3B,OAAO,CAAC,QAAQ,CAAoB;IACpC,OAAO,CAAC,QAAQ,CAAQ;IAExB,OAAO,CAAC,kBAAkB,CAAuB;IACjD,OAAO,CAAC,eAAe,CAAuB;IAE9C;;;;;OAKG;gBACS,UAAU,EAAE,iBAAiB,EAAE,KAAK,EAAE,OAAO;IAiCzD;;;;;;;;;;OAUG;IACG,MAAM,CAAC,MAAM,EAAE,qBAAqB;;;;;;;;IAkGpC,MAAM,CAAC,MAAM,CAAC,EAAE,qBAAqB;IAqDrC,MAAM,CAAC,MAAM,CAAC,EAAE,qBAAqB;IA0CrC,IAAI,CAAC,IAAI,EAAE,mBAAmB;IAI9B,KAAK,CAAC,IAAI,EAAE,mBAAmB;IAI/B,QAAQ,CAAC,IAAI,EAAE,mBAAmB;IAIlC,UAAU,CAAC,IAAI,EAAE,mBAAmB;IAIpC,MAAM,CAAC,IAAI,EAAE,mBAAmB;YAIxB,KAAK;IAmCnB,WAAW,CAAC,IAAI,CAAC,EAAE,iBAAiB,GAAG,WAAW,GAAG,SAAS;IAoB9D,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAenD,eAAe,IAAI,OAAO,CAAC,WAAW,GAAG,YAAY,CAAC;IAwB5D;;;;;;;OAOG;IACH,gBAAgB,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,KAAK;CAgBrD"}