@algorandfoundation/algokit-utils 2.3.3-beta.3 → 2.3.3-beta.4

package/esm/types/account.js

@@ -0,0 +1,90 @@
+import algosdk from 'algosdk';
+/**
+ * The account name identifier used for fund dispensing in test environments
+ */
+export const DISPENSER_ACCOUNT = 'DISPENSER';
+/** Account wrapper that supports partial or full multisig signing. */
+export class MultisigAccount {
+    _params;
+    _signingAccounts;
+    _addr;
+    _signer;
+    /** The parameters for the multisig account */
+    get params() {
+        return this._params;
+    }
+    /** The list of accounts that are present to sign */
+    get signingAccounts() {
+        return this._signingAccounts;
+    }
+    /** The address of the multisig account */
+    get addr() {
+        return this._addr;
+    }
+    get signer() {
+        return this._signer;
+    }
+    constructor(multisigParams, signingAccounts) {
+        this._params = multisigParams;
+        this._signingAccounts = signingAccounts;
+        this._addr = algosdk.multisigAddress(multisigParams);
+        this._signer = algosdk.makeMultiSigAccountTransactionSigner(multisigParams, signingAccounts.map((a) => a.sk));
+    }
+    /**
+     * Sign the given transaction
+     * @param transaction Either a transaction object or a raw, partially signed transaction
+     * @returns The transaction signed by the present signers
+     */
+    sign(transaction) {
+        let signedTxn = 'from' in transaction ? undefined : transaction;
+        for (const signer of this._signingAccounts) {
+            if (signedTxn) {
+                signedTxn = algosdk.appendSignMultisigTransaction(signedTxn, this._params, signer.sk).blob;
+            }
+            else {
+                signedTxn = algosdk.signMultisigTransaction(transaction, this._params, signer.sk).blob;
+            }
+        }
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        return signedTxn;
+    }
+}
+/** Account wrapper that supports a rekeyed account */
+export class SigningAccount {
+    _account;
+    _signer;
+    _sender;
+    /**
+     * Algorand address of the sender
+     */
+    get addr() {
+        return this._sender;
+    }
+    /**
+     * Secret key belonging to the signer
+     */
+    get sk() {
+        return this._account.sk;
+    }
+    /**
+     * Transaction signer for the underlying signing account
+     */
+    get signer() {
+        return this._signer;
+    }
+    /**
+     * Algorand account of the sender address and signer private key
+     */
+    get sender() {
+        return {
+            addr: this._sender,
+            sk: this._account.sk,
+        };
+    }
+    constructor(account, sender) {
+        this._account = account;
+        this._sender = sender ?? account.addr;
+        this._signer = algosdk.makeBasicAccountTransactionSigner(account);
+    }
+}
+//# sourceMappingURL=account.js.map

package/esm/types/account.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"account.js","sourceRoot":"","sources":["../../../src/types/account.ts"],"names":[],"mappings":"AAAA,OAAO,OAAsE,MAAM,SAAS,CAAA;AAE5F;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,WAAW,CAAA;AAE5C,sEAAsE;AACtE,MAAM,OAAO,eAAe;IAC1B,OAAO,CAA0B;IACjC,gBAAgB,CAAsC;IACtD,KAAK,CAAQ;IACb,OAAO,CAAmB;IAE1B,8CAA8C;IAC9C,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED,oDAAoD;IACpD,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,gBAAgB,CAAA;IAC9B,CAAC;IAED,0CAA0C;IAC1C,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED,YAAY,cAAgC,EAAE,eAA6C;QACzF,IAAI,CAAC,OAAO,GAAG,cAAc,CAAA;QAC7B,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAA;QACvC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,eAAe,CAAC,cAAc,CAAC,CAAA;QACpD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,oCAAoC,CACzD,cAAc,EACd,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CACjC,CAAA;IACH,CAAC;IAED;;;;OAIG;IACI,IAAI,CAAC,WAAqC;QAC/C,IAAI,SAAS,GAAG,MAAM,IAAI,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAA;QAC/D,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,gBAAgB,EAAE;YAC1C,IAAI,SAAS,EAAE;gBACb,SAAS,GAAG,OAAO,CAAC,6BAA6B,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAA;aAC3F;iBAAM;gBACL,SAAS,GAAG,OAAO,CAAC,uBAAuB,CAAC,WAA0B,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAA;aACtG;SACF;QACD,oEAAoE;QACpE,OAAO,SAAU,CAAA;IACnB,CAAC;CACF;AAED,sDAAsD;AACtD,MAAM,OAAO,cAAc;IACjB,QAAQ,CAAS;IACjB,OAAO,CAAmB;IAC1B,OAAO,CAAQ;IAEvB;;OAEG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED;;OAEG;IACH,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAA;IACzB,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACR,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,OAAO;YAClB,EAAE,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE;SACrB,CAAA;IACH,CAAC;IAED,YAAY,OAAgB,EAAE,MAA0B;QACtD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;QACvB,IAAI,CAAC,OAAO,GAAG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAA;QACrC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,iCAAiC,CAAC,OAAO,CAAC,CAAA;IACnE,CAAC;CACF"}

package/esm/types/algo-http-client-with-retry.js

@@ -0,0 +1,58 @@
+import { Config } from '../';
+import { URLTokenBaseHTTPClient } from './urlTokenBaseHTTPClient';
+/** A HTTP Client that wraps the Algorand SDK HTTP Client with retries */
+export class AlgoHttpClientWithRetry extends URLTokenBaseHTTPClient {
+    static MAX_TRIES = 5;
+    static MAX_BACKOFF_MS = 10000;
+    // These lists come from https://visionmedia.github.io/superagent/#retrying-requests
+    // which is the underlying library used by algosdk - but the CloudFlare specific 52X status codes have been removed
+    static RETRY_STATUS_CODES = [408, 413, 429, 500, 502, 503, 504];
+    static RETRY_ERROR_CODES = [
+        'ETIMEDOUT',
+        'ECONNRESET',
+        'EADDRINUSE',
+        'ECONNREFUSED',
+        'EPIPE',
+        'ENOTFOUND',
+        'ENETUNREACH',
+        'EAI_AGAIN',
+        'EPROTO', // We get this intermittently with AlgoNode API
+    ];
+    async callWithRetry(func) {
+        let response;
+        let numTries = 1;
+        do {
+            try {
+                response = await func();
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            }
+            catch (err) {
+                if (numTries >= AlgoHttpClientWithRetry.MAX_TRIES) {
+                    throw err;
+                }
+                // Only retry for one of the hardcoded conditions
+                if (!(AlgoHttpClientWithRetry.RETRY_ERROR_CODES.includes(err.code) || AlgoHttpClientWithRetry.RETRY_STATUS_CODES.includes(err.status))) {
+                    throw err;
+                }
+                // Retry immediately the first time, then exponentially backoff.
+                const delayTimeMs = numTries == 1 ? 0 : Math.min(1000 * Math.pow(2, numTries - 1), AlgoHttpClientWithRetry.MAX_BACKOFF_MS);
+                if (delayTimeMs > 0) {
+                    await new Promise((r) => setTimeout(r, delayTimeMs));
+                }
+                Config.logger.warn(`algosdk request failed ${numTries} times. Retrying in ${delayTimeMs}ms: ${err}`);
+            }
+        } while (!response && ++numTries <= AlgoHttpClientWithRetry.MAX_TRIES);
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        return response;
+    }
+    async get(relativePath, query, requestHeaders = {}) {
+        return await this.callWithRetry(() => super.get(relativePath, query, requestHeaders));
+    }
+    async post(relativePath, data, query, requestHeaders = {}) {
+        return await this.callWithRetry(() => super.post(relativePath, data, query, requestHeaders));
+    }
+    async delete(relativePath, data, query, requestHeaders = {}) {
+        return await this.callWithRetry(() => super.delete(relativePath, data, query, requestHeaders));
+    }
+}
+//# sourceMappingURL=algo-http-client-with-retry.js.map

package/esm/types/algo-http-client-with-retry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"algo-http-client-with-retry.js","sourceRoot":"","sources":["../../../src/types/algo-http-client-with-retry.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,KAAK,CAAA;AAC5B,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AAEjE,yEAAyE;AACzE,MAAM,OAAO,uBAAwB,SAAQ,sBAAsB;IACzD,MAAM,CAAU,SAAS,GAAG,CAAC,CAAA;IAC7B,MAAM,CAAU,cAAc,GAAG,KAAK,CAAA;IAE9C,oFAAoF;IACpF,mHAAmH;IAC3G,MAAM,CAAU,kBAAkB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;IACxE,MAAM,CAAU,iBAAiB,GAAG;QAC1C,WAAW;QACX,YAAY;QACZ,YAAY;QACZ,cAAc;QACd,OAAO;QACP,WAAW;QACX,aAAa;QACb,WAAW;QACX,QAAQ,EAAE,+CAA+C;KAC1D,CAAA;IAEO,KAAK,CAAC,aAAa,CAAC,IAA2C;QACrE,IAAI,QAA4C,CAAA;QAChD,IAAI,QAAQ,GAAG,CAAC,CAAA;QAChB,GAAG;YACD,IAAI;gBACF,QAAQ,GAAG,MAAM,IAAI,EAAE,CAAA;gBACvB,8DAA8D;aAC/D;YAAC,OAAO,GAAQ,EAAE;gBACjB,IAAI,QAAQ,IAAI,uBAAuB,CAAC,SAAS,EAAE;oBACjD,MAAM,GAAG,CAAA;iBACV;gBACD,iDAAiD;gBACjD,IACE,CAAC,CAAC,uBAAuB,CAAC,iBAAiB,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,uBAAuB,CAAC,kBAAkB,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,EAClI;oBACA,MAAM,GAAG,CAAA;iBACV;gBACD,gEAAgE;gBAChE,MAAM,WAAW,GAAG,QAAQ,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,GAAG,CAAC,CAAC,EAAE,uBAAuB,CAAC,cAAc,CAAC,CAAA;gBAC1H,IAAI,WAAW,GAAG,CAAC,EAAE;oBACnB,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAA;iBACrD;gBACD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,0BAA0B,QAAQ,uBAAuB,WAAW,OAAO,GAAG,EAAE,CAAC,CAAA;aACrG;SACF,QAAQ,CAAC,QAAQ,IAAI,EAAE,QAAQ,IAAI,uBAAuB,CAAC,SAAS,EAAC;QACtE,oEAAoE;QACpE,OAAO,QAAS,CAAA;IAClB,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,YAAoB,EAAE,KAAqB,EAAE,iBAAyC,EAAE;QAChG,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC,CAAA;IACvF,CAAC;IAED,KAAK,CAAC,IAAI,CACR,YAAoB,EACpB,IAAgB,EAChB,KAAqB,EACrB,iBAAyC,EAAE;QAE3C,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC,CAAA;IAC9F,CAAC;IAED,KAAK,CAAC,MAAM,CACV,YAAoB,EACpB,IAAgB,EAChB,KAAqB,EACrB,iBAAyC,EAAE;QAE3C,OAAO,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC,CAAA;IAChG,CAAC"}

package/esm/types/amount.js

@@ -0,0 +1,35 @@
+import algosdk from 'algosdk';
+/** Wrapper class to ensure safe, explicit conversion between µAlgos, Algos and numbers */
+export class AlgoAmount {
+    amountInMicroAlgos;
+    /** 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.microalgosToAlgos(this.amountInMicroAlgos);
+    }
+    constructor(amount) {
+        this.amountInMicroAlgos = 'microAlgos' in amount ? amount.microAlgos : algosdk.algosToMicroalgos(amount.algos);
+    }
+    toString() {
+        return `${this.microAlgos.toLocaleString('en-US')} µALGO${this.microAlgos === 1 ? '' : 's'}`;
+    }
+    /** valueOf allows you to use `AlgoAmount` in comparison operations such as `<` and `>=` etc.,
+     * but it's not recommended to use this to convert to a number, it's much safer to explicitly call
+     * the algos or microAlgos properties
+     */
+    valueOf() {
+        return this.microAlgos;
+    }
+    /** Create a `AlgoAmount` object representing the given number of Algos */
+    static Algos(amount) {
+        return new AlgoAmount({ algos: amount });
+    }
+    /** Create a `AlgoAmount` object representing the given number of µAlgos */
+    static MicroAlgos(amount) {
+        return new AlgoAmount({ microAlgos: amount });
+    }
+}
+//# sourceMappingURL=amount.js.map

package/esm/types/amount.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"amount.js","sourceRoot":"","sources":["../../../src/types/amount.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAE7B,0FAA0F;AAC1F,MAAM,OAAO,UAAU;IACb,kBAAkB,CAAA;IAE1B,8CAA8C;IAC9C,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,kBAAkB,CAAA;IAChC,CAAC;IAED,6CAA6C;IAC7C,IAAI,KAAK;QACP,OAAO,OAAO,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,OAAO,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;;;OAGG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,UAAU,CAAA;IACxB,CAAC;IAED,0EAA0E;IAC1E,MAAM,CAAC,KAAK,CAAC,MAAc;QACzB,OAAO,IAAI,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAA;IAC1C,CAAC;IAED,2EAA2E;IAC3E,MAAM,CAAC,UAAU,CAAC,MAAc;QAC9B,OAAO,IAAI,UAAU,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAA;IAC/C,CAAC;CACF"}