@algorandfoundation/algokit-utils 1.0.0-beta.3 → 1.0.0-beta.31

package/testing/fixtures/algorand-fixture.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.algorandFixture = void 0;
+const __1 = require("../");
+const __2 = require("../../");
+/**
+ * Creates a test fixture for automated testing against Algorand.
+ * By default it tests against a default LocalNet instance, but you can pass in an algod and indexer if you want to test against, say, TestNet.
+ *
+ * @example ```typescript
+ * const algorand = algorandFixture()
+ *
+ * beforeEach(algorand.beforeEach, 10_000)
+ *
+ * test('My test', () => {
+ *     const {algod, indexer, testAccount, ...} = algorand.context
+ * })
+ * ```
+ *
+ * @param fixtureConfig The fixture configuration
+ * @returns The fixture
+ */
+const algorandFixture = (fixtureConfig) => {
+    const algod = fixtureConfig?.algod ?? (0, __2.getAlgoClient)((0, __2.getDefaultLocalNetConfig)('algod'));
+    const indexer = fixtureConfig?.indexer ?? (0, __2.getAlgoIndexerClient)((0, __2.getDefaultLocalNetConfig)('indexer'));
+    const kmd = fixtureConfig?.kmd ?? (0, __2.getAlgoKmdClient)((0, __2.getDefaultLocalNetConfig)('kmd'));
+    let context;
+    const beforeEach = async () => {
+        const transactionLogger = new __1.TransactionLogger();
+        context = {
+            algod: transactionLogger.capture(algod),
+            indexer: indexer,
+            kmd: kmd,
+            testAccount: await (0, __1.getTestAccount)({ initialFunds: fixtureConfig?.testAccountFunding ?? (0, __2.algos)(10), suppressLog: true }, algod, kmd),
+            generateAccount: (params) => (0, __1.getTestAccount)(params, algod, kmd),
+            transactionLogger: transactionLogger,
+            waitForIndexer: () => transactionLogger.waitForIndexer(indexer),
+            waitForIndexerTransaction: (transactionId) => (0, __1.runWhenIndexerCaughtUp)(() => (0, __2.lookupTransactionById)(transactionId, indexer)),
+        };
+    };
+    return {
+        get context() {
+            return context;
+        },
+        beforeEach,
+    };
+};
+exports.algorandFixture = algorandFixture;
+//# sourceMappingURL=algorand-fixture.js.map

package/testing/fixtures/algorand-fixture.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"algorand-fixture.js","sourceRoot":"","sources":["../../../src/testing/fixtures/algorand-fixture.ts"],"names":[],"mappings":";;;AAAA,2BAA+E;AAC/E,8BAAsI;AAGtI;;;;;;;;;;;;;;;;GAgBG;AACI,MAAM,eAAe,GAAG,CAAC,aAAqC,EAAmB,EAAE;IACxF,MAAM,KAAK,GAAG,aAAa,EAAE,KAAK,IAAI,IAAA,iBAAa,EAAC,IAAA,4BAAwB,EAAC,OAAO,CAAC,CAAC,CAAA;IACtF,MAAM,OAAO,GAAG,aAAa,EAAE,OAAO,IAAI,IAAA,wBAAoB,EAAC,IAAA,4BAAwB,EAAC,SAAS,CAAC,CAAC,CAAA;IACnG,MAAM,GAAG,GAAG,aAAa,EAAE,GAAG,IAAI,IAAA,oBAAgB,EAAC,IAAA,4BAAwB,EAAC,KAAK,CAAC,CAAC,CAAA;IACnF,IAAI,OAAsC,CAAA;IAE1C,MAAM,UAAU,GAAG,KAAK,IAAI,EAAE;QAC5B,MAAM,iBAAiB,GAAG,IAAI,qBAAiB,EAAE,CAAA;QACjD,OAAO,GAAG;YACR,KAAK,EAAE,iBAAiB,CAAC,OAAO,CAAC,KAAK,CAAC;YACvC,OAAO,EAAE,OAAO;YAChB,GAAG,EAAE,GAAG;YACR,WAAW,EAAE,MAAM,IAAA,kBAAc,EAAC,EAAE,YAAY,EAAE,aAAa,EAAE,kBAAkB,IAAI,IAAA,SAAK,EAAC,EAAE,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC;YAClI,eAAe,EAAE,CAAC,MAA4B,EAAE,EAAE,CAAC,IAAA,kBAAc,EAAC,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC;YACrF,iBAAiB,EAAE,iBAAiB;YACpC,cAAc,EAAE,GAAG,EAAE,CAAC,iBAAiB,CAAC,cAAc,CAAC,OAAO,CAAC;YAC/D,yBAAyB,EAAE,CAAC,aAAqB,EAAE,EAAE,CAAC,IAAA,0BAAsB,EAAC,GAAG,EAAE,CAAC,IAAA,yBAAqB,EAAC,aAAa,EAAE,OAAO,CAAC,CAAC;SAClI,CAAA;IACH,CAAC,CAAA;IAED,OAAO;QACL,IAAI,OAAO;YACT,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,UAAU;KACX,CAAA;AACH,CAAC,CAAA;AA1BY,QAAA,eAAe,mBA0B3B"}

package/testing/fixtures/index.d.ts

@@ -0,0 +1,3 @@
+export * from './algokit-log-capture-fixture';
+export * from './algorand-fixture';
+//# sourceMappingURL=index.d.ts.map

package/testing/fixtures/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/testing/fixtures/index.ts"],"names":[],"mappings":"AAAA,cAAc,+BAA+B,CAAA;AAC7C,cAAc,oBAAoB,CAAA"}

package/testing/fixtures/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./algokit-log-capture-fixture"), exports);
+__exportStar(require("./algorand-fixture"), exports);
+//# sourceMappingURL=index.js.map

package/testing/fixtures/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/testing/fixtures/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gEAA6C;AAC7C,qDAAkC"}

package/testing/index.d.ts

@@ -0,0 +1,6 @@
+export * from './account';
+export * from './fixtures';
+export * from './indexer';
+export * from './test-logger';
+export * from './transaction-logger';
+//# sourceMappingURL=index.d.ts.map

package/testing/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/testing/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AACzB,cAAc,eAAe,CAAA;AAC7B,cAAc,sBAAsB,CAAA"}

package/testing/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./account"), exports);
+__exportStar(require("./fixtures"), exports);
+__exportStar(require("./indexer"), exports);
+__exportStar(require("./test-logger"), exports);
+__exportStar(require("./transaction-logger"), exports);
+//# sourceMappingURL=index.js.map

package/testing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/testing/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAAyB;AACzB,6CAA0B;AAC1B,4CAAyB;AACzB,gDAA6B;AAC7B,uDAAoC"}

package/testing/indexer.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Runs the given indexer call until a 404 error is no longer returned.
+ * Tried every 200ms up to 20 times.
+ * Very rudimentary implementation designed for automated testing.
+ * @example ```typescript
+ * const transaction = await runWhenIndexerCaughtUp(() => indexer.lookupTransactionByID(txnId).do())
+ * ```
+ * @param run The code to run
+ * @returns The result (as a promise), or throws if the indexer didn't catch up in time
+ */
+export declare function runWhenIndexerCaughtUp<T>(run: () => Promise<T>): Promise<T>;
+//# sourceMappingURL=indexer.d.ts.map

package/testing/indexer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexer.d.ts","sourceRoot":"","sources":["../../src/testing/indexer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,wBAAsB,sBAAsB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAsBjF"}

package/testing/indexer.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runWhenIndexerCaughtUp = void 0;
+/**
+ * Runs the given indexer call until a 404 error is no longer returned.
+ * Tried every 200ms up to 20 times.
+ * Very rudimentary implementation designed for automated testing.
+ * @example ```typescript
+ * const transaction = await runWhenIndexerCaughtUp(() => indexer.lookupTransactionByID(txnId).do())
+ * ```
+ * @param run The code to run
+ * @returns The result (as a promise), or throws if the indexer didn't catch up in time
+ */
+async function runWhenIndexerCaughtUp(run) {
+    let result = null;
+    let ok = false;
+    let tries = 0;
+    while (!ok) {
+        try {
+            result = await run();
+            ok = true;
+        }
+        catch (e) {
+            if (e?.status === 404) {
+                tries++;
+                if (tries > 20) {
+                    throw e;
+                }
+                await new Promise((resolve) => setTimeout(resolve, 200));
+            }
+            else {
+                throw e;
+            }
+        }
+    }
+    return result;
+}
+exports.runWhenIndexerCaughtUp = runWhenIndexerCaughtUp;
+//# sourceMappingURL=indexer.js.map

package/testing/indexer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexer.js","sourceRoot":"","sources":["../../src/testing/indexer.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;GASG;AACI,KAAK,UAAU,sBAAsB,CAAI,GAAqB;IACnE,IAAI,MAAM,GAAa,IAAI,CAAA;IAC3B,IAAI,EAAE,GAAG,KAAK,CAAA;IACd,IAAI,KAAK,GAAG,CAAC,CAAA;IACb,OAAO,CAAC,EAAE,EAAE;QACV,IAAI;YACF,MAAM,GAAG,MAAM,GAAG,EAAE,CAAA;YACpB,EAAE,GAAG,IAAI,CAAA;SACV;QAAC,OAAO,CAAM,EAAE;YACf,IAAI,CAAC,EAAE,MAAM,KAAK,GAAG,EAAE;gBACrB,KAAK,EAAE,CAAA;gBACP,IAAI,KAAK,GAAG,EAAE,EAAE;oBACd,MAAM,CAAC,CAAA;iBACR;gBACD,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAA;aAC/D;iBAAM;gBACL,MAAM,CAAC,CAAA;aACR;SACF;KACF;IAED,OAAO,MAAW,CAAA;AACpB,CAAC;AAtBD,wDAsBC"}

package/testing/test-logger.d.ts

@@ -0,0 +1,39 @@
+import { Logger } from '../types/logging';
+import { LogSnapshotConfig } from '../types/testing';
+/** Exposes an AlgoKit logger which captures log messages, while wrapping an original logger.
+ * This is useful for automated testing.
+ */
+export declare class TestLogger implements Logger {
+    private originalLogger;
+    private logs;
+    /**
+     * Create a new test logger that wraps the given logger if provided.
+     * @param originalLogger The optional original logger to wrap.
+     */
+    constructor(originalLogger?: Logger);
+    /** Returns all logs captured thus far. */
+    get capturedLogs(): string[];
+    /** Clears all logs captured so far. */
+    clear(): void;
+    /**
+     * Returns a captured log snapshot.
+     * This helps ensure that the provided configuration items won't appear
+     *  with random values in the log snapshot, but rather will get substituted with predictable ids.
+     * @see https://jestjs.io/docs/snapshot-testing#2-tests-should-be-deterministic
+     * @example Jest Example
+     * ```typescript
+     * const logger = new TestLogger()
+     * ...
+     * expect(logger.getLogSnapshot()).toMatchSnapshot()
+     * ```
+     * @param config The snapshot configuration
+     * @returns The snapshotted logs.
+     */
+    getLogSnapshot(config?: LogSnapshotConfig): string;
+    error(message: string, ...optionalParams: unknown[]): void;
+    warn(message: string, ...optionalParams: unknown[]): void;
+    info(message: string, ...optionalParams: unknown[]): void;
+    verbose(message: string, ...optionalParams: unknown[]): void;
+    debug(message: string, ...optionalParams: unknown[]): void;
+}
+//# sourceMappingURL=test-logger.d.ts.map

package/testing/test-logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-logger.d.ts","sourceRoot":"","sources":["../../src/testing/test-logger.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AAEpD;;GAEG;AACH,qBAAa,UAAW,YAAW,MAAM;IACvC,OAAO,CAAC,cAAc,CAAoB;IAC1C,OAAO,CAAC,IAAI,CAAU;IAEtB;;;OAGG;gBACS,cAAc,CAAC,EAAE,MAAM;IAKnC,0CAA0C;IAC1C,IAAI,YAAY,IAAI,MAAM,EAAE,CAE3B;IAED,uCAAuC;IACvC,KAAK;IAIL;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE,iBAAiB;IAczC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI;IAI1D,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI;IAIzD,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI;IAIzD,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI;IAI5D,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI;CAI3D"}

package/testing/test-logger.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestLogger = void 0;
+const __1 = require("../");
+/** Exposes an AlgoKit logger which captures log messages, while wrapping an original logger.
+ * This is useful for automated testing.
+ */
+class TestLogger {
+    /**
+     * Create a new test logger that wraps the given logger if provided.
+     * @param originalLogger The optional original logger to wrap.
+     */
+    constructor(originalLogger) {
+        this.originalLogger = originalLogger;
+        this.logs = [];
+    }
+    /** Returns all logs captured thus far. */
+    get capturedLogs() {
+        return this.logs;
+    }
+    /** Clears all logs captured so far. */
+    clear() {
+        this.logs = [];
+    }
+    /**
+     * Returns a captured log snapshot.
+     * This helps ensure that the provided configuration items won't appear
+     *  with random values in the log snapshot, but rather will get substituted with predictable ids.
+     * @see https://jestjs.io/docs/snapshot-testing#2-tests-should-be-deterministic
+     * @example Jest Example
+     * ```typescript
+     * const logger = new TestLogger()
+     * ...
+     * expect(logger.getLogSnapshot()).toMatchSnapshot()
+     * ```
+     * @param config The snapshot configuration
+     * @returns The snapshotted logs.
+     */
+    getLogSnapshot(config) {
+        const { transactions: transactionIds, accounts, apps } = config ?? {};
+        let snapshot = this.capturedLogs.join('\n');
+        transactionIds?.forEach((txn, id) => (snapshot = snapshot.replace(new RegExp(typeof txn === 'string' ? txn : txn.txID(), 'g'), `TXID_${id + 1}`)));
+        accounts?.forEach((sender, id) => (snapshot = snapshot.replace(new RegExp(typeof sender === 'string' ? sender : (0, __1.getSenderAddress)(sender), 'g'), `ACCOUNT_${id + 1}`)));
+        apps?.forEach((app, id) => (snapshot = snapshot.replace(new RegExp(`\\b${app.toString()}\\b`, 'g'), `APP_${id + 1}`)));
+        return snapshot;
+    }
+    error(message, ...optionalParams) {
+        this.originalLogger?.error(message, ...optionalParams);
+        this.logs.push(`ERROR: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`);
+    }
+    warn(message, ...optionalParams) {
+        this.originalLogger?.warn(message, ...optionalParams);
+        this.logs.push(`WARN: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`);
+    }
+    info(message, ...optionalParams) {
+        this.originalLogger?.info(message, ...optionalParams);
+        this.logs.push(`INFO: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`);
+    }
+    verbose(message, ...optionalParams) {
+        this.originalLogger?.verbose(message, ...optionalParams);
+        this.logs.push(`VERBOSE: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`);
+    }
+    debug(message, ...optionalParams) {
+        this.originalLogger?.debug(message, ...optionalParams);
+        this.logs.push(`DEBUG: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`);
+    }
+}
+exports.TestLogger = TestLogger;
+//# sourceMappingURL=test-logger.js.map

package/testing/test-logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-logger.js","sourceRoot":"","sources":["../../src/testing/test-logger.ts"],"names":[],"mappings":";;;AAAA,2BAAsC;AAItC;;GAEG;AACH,MAAa,UAAU;IAIrB;;;OAGG;IACH,YAAY,cAAuB;QACjC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAA;QACpC,IAAI,CAAC,IAAI,GAAG,EAAE,CAAA;IAChB,CAAC;IAED,0CAA0C;IAC1C,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAED,uCAAuC;IACvC,KAAK;QACH,IAAI,CAAC,IAAI,GAAG,EAAE,CAAA;IAChB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,MAA0B;QACvC,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE,CAAA;QACrE,IAAI,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC3C,cAAc,EAAE,OAAO,CACrB,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAC1H,CAAA;QACD,QAAQ,EAAE,OAAO,CACf,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE,CACb,CAAC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAA,oBAAgB,EAAC,MAAM,CAAC,EAAE,GAAG,CAAC,EAAE,WAAW,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CACtI,CAAA;QACD,IAAI,EAAE,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QACtH,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,GAAG,cAAyB;QACjD,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,CAAA;QACtD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,OAAO,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IAC3G,CAAC;IACD,IAAI,CAAC,OAAe,EAAE,GAAG,cAAyB;QAChD,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,CAAA;QACrD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,OAAO,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IAC1G,CAAC;IACD,IAAI,CAAC,OAAe,EAAE,GAAG,cAAyB;QAChD,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,CAAA;QACrD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,OAAO,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IAC1G,CAAC;IACD,OAAO,CAAC,OAAe,EAAE,GAAG,cAAyB;QACnD,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,CAAA;QACxD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,OAAO,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IAC7G,CAAC;IACD,KAAK,CAAC,OAAe,EAAE,GAAG,cAAyB;QACjD,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,CAAA;QACtD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,OAAO,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IAC3G,CAAC;CACF;AAvED,gCAuEC"}

package/testing/transaction-logger.d.ts

@@ -0,0 +1,29 @@
+import { Algodv2, Indexer } from 'algosdk';
+/**
+ * Allows you to keep track of Algorand transaction IDs by wrapping an @see Algodv2 in a proxy.
+ * Useful for automated tests.
+ */
+export declare class TransactionLogger {
+    private _sentTransactionIds;
+    /**
+     * The list of transaction IDs that has been logged thus far.
+     */
+    get sentTransactionIds(): Readonly<string[]>;
+    /**
+     * Clear all logged IDs.
+     */
+    clear(): void;
+    /**
+     * The method that captures raw transactions and stores the transaction IDs.
+     */
+    logRawTransaction(signedTransactions: Uint8Array | Uint8Array[]): void;
+    /** Return a proxy that wraps the given Algodv2 with this transaction logger.
+     *
+     * @param algod The @see Algodv2 to wrap
+     * @returns The wrapped @see Algodv2, any transactions sent using this algod instance will be logged by this transaction logger
+     */
+    capture(algod: Algodv2): Algodv2;
+    /** Wait until all logged transactions IDs appear in the given @see Indexer. */
+    waitForIndexer(indexer: Indexer): Promise<void>;
+}
+//# sourceMappingURL=transaction-logger.d.ts.map

package/testing/transaction-logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction-logger.d.ts","sourceRoot":"","sources":["../../src/testing/transaction-logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAA2B,OAAO,EAAE,MAAM,SAAS,CAAA;AAGnE;;;GAGG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,mBAAmB,CAAe;IAE1C;;OAEG;IACH,IAAI,kBAAkB,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC,CAE3C;IAED;;OAEG;IACH,KAAK;IAIL;;OAEG;IACH,iBAAiB,CAAC,kBAAkB,EAAE,UAAU,GAAG,UAAU,EAAE;IAY/D;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAIhC,+EAA+E;IACzE,cAAc,CAAC,OAAO,EAAE,OAAO;CAGtC"}

package/testing/transaction-logger.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionLogger = void 0;
+const algosdk_1 = require("algosdk");
+const _1 = require("./");
+/**
+ * Allows you to keep track of Algorand transaction IDs by wrapping an @see Algodv2 in a proxy.
+ * Useful for automated tests.
+ */
+class TransactionLogger {
+    constructor() {
+        this._sentTransactionIds = [];
+    }
+    /**
+     * The list of transaction IDs that has been logged thus far.
+     */
+    get sentTransactionIds() {
+        return this._sentTransactionIds;
+    }
+    /**
+     * Clear all logged IDs.
+     */
+    clear() {
+        this._sentTransactionIds = [];
+    }
+    /**
+     * The method that captures raw transactions and stores the transaction IDs.
+     */
+    logRawTransaction(signedTransactions) {
+        if (Array.isArray(signedTransactions)) {
+            for (const stxn of signedTransactions) {
+                const decoded = (0, algosdk_1.decodeSignedTransaction)(stxn);
+                this._sentTransactionIds.push(decoded.txn.txID());
+            }
+        }
+        else {
+            const decoded = (0, algosdk_1.decodeSignedTransaction)(signedTransactions);
+            this._sentTransactionIds.push(decoded.txn.txID());
+        }
+    }
+    /** Return a proxy that wraps the given Algodv2 with this transaction logger.
+     *
+     * @param algod The @see Algodv2 to wrap
+     * @returns The wrapped @see Algodv2, any transactions sent using this algod instance will be logged by this transaction logger
+     */
+    capture(algod) {
+        return new Proxy(algod, new TransactionLoggingAlgodv2ProxyHandler(this));
+    }
+    /** Wait until all logged transactions IDs appear in the given @see Indexer. */
+    async waitForIndexer(indexer) {
+        await Promise.all(this._sentTransactionIds.map((txnId) => (0, _1.runWhenIndexerCaughtUp)(() => indexer.lookupTransactionByID(txnId).do())));
+    }
+}
+exports.TransactionLogger = TransactionLogger;
+class TransactionLoggingAlgodv2ProxyHandler {
+    constructor(transactionLogger) {
+        this.transactionLogger = transactionLogger;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    get(target, property, receiver) {
+        if (property === 'sendRawTransaction') {
+            return (stxOrStxs) => {
+                this.transactionLogger.logRawTransaction(stxOrStxs);
+                return target[property].call(receiver, stxOrStxs);
+            };
+        }
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        return target[property];
+    }
+}
+//# sourceMappingURL=transaction-logger.js.map

package/testing/transaction-logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction-logger.js","sourceRoot":"","sources":["../../src/testing/transaction-logger.ts"],"names":[],"mappings":";;;AAAA,qCAAmE;AACnE,yBAA2C;AAE3C;;;GAGG;AACH,MAAa,iBAAiB;IAA9B;QACU,wBAAmB,GAAa,EAAE,CAAA;IA4C5C,CAAC;IA1CC;;OAEG;IACH,IAAI,kBAAkB;QACpB,OAAO,IAAI,CAAC,mBAAmB,CAAA;IACjC,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,mBAAmB,GAAG,EAAE,CAAA;IAC/B,CAAC;IAED;;OAEG;IACH,iBAAiB,CAAC,kBAA6C;QAC7D,IAAI,KAAK,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE;YACrC,KAAK,MAAM,IAAI,IAAI,kBAAkB,EAAE;gBACrC,MAAM,OAAO,GAAG,IAAA,iCAAuB,EAAC,IAAI,CAAC,CAAA;gBAC7C,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAA;aAClD;SACF;aAAM;YACL,MAAM,OAAO,GAAG,IAAA,iCAAuB,EAAC,kBAAkB,CAAC,CAAA;YAC3D,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAA;SAClD;IACH,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,KAAc;QACpB,OAAO,IAAI,KAAK,CAAU,KAAK,EAAE,IAAI,qCAAqC,CAAC,IAAI,CAAC,CAAC,CAAA;IACnF,CAAC;IAED,+EAA+E;IAC/E,KAAK,CAAC,cAAc,CAAC,OAAgB;QACnC,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,yBAAsB,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAA;IACrI,CAAC;CACF;AA7CD,8CA6CC;AAED,MAAM,qCAAqC;IAGzC,YAAY,iBAAoC;QAC9C,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAA;IAC5C,CAAC;IAED,8DAA8D;IAC9D,GAAG,CAAC,MAAe,EAAE,QAAyB,EAAE,QAAa;QAC3D,IAAI,QAAQ,KAAK,oBAAoB,EAAE;YACrC,OAAO,CAAC,SAAoC,EAAE,EAAE;gBAC9C,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAA;gBACnD,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAA;YACnD,CAAC,CAAA;SACF;QACD,8DAA8D;QAC9D,OAAQ,MAAc,CAAC,QAAQ,CAAC,CAAA;IAClC,CAAC;CACF"}

package/transaction.d.ts

@@ -0,0 +1,120 @@
+import algosdk, { Algodv2, AtomicTransactionComposer, SuggestedParams, Transaction } from 'algosdk';
+import { PendingTransactionResponse } from './types/algod';
+import { AlgoAmount } from './types/amount';
+import { ABIReturn } from './types/app';
+import { AtomicTransactionComposerToSend, SendTransactionFrom, SendTransactionParams, SendTransactionResult, TransactionGroupToSend, TransactionNote } from './types/transaction';
+/** Encodes a transaction note into a byte array ready to be included in an Algorand transaction.
+ *
+ * @param note The transaction note
+ * @returns the transaction note ready for inclusion in a transaction
+ *
+ *  Case on the value of `data` this either either be:
+ *   * `null` | `undefined`: `undefined`
+ *   * `string`: The string value
+ *   * Uint8Array: passthrough
+ *   * Arc2TransactionNote object: ARC-0002 compatible transaction note
+ *   * Else: The object/value converted into a JSON string representation
+ */
+export declare function encodeTransactionNote(note?: TransactionNote): Uint8Array | undefined;
+/**
+ * Returns the public address of the given transaction sender.
+ * @param sender A transaction sender
+ * @returns The public address
+ */
+export declare const getSenderAddress: (sender: SendTransactionFrom) => string;
+/**
+ * Returns a @see TransactionSigner for the given transaction sender.
+ * This function has memoization, so will return the same transaction signer for a given sender.
+ * @param sender A transaction sender
+ * @returns A transaction signer
+ */
+export declare const getSenderTransactionSigner: (val: SendTransactionFrom) => algosdk.TransactionSigner;
+/** Prepares a transaction for sending and then (if instructed) signs and sends the given transaction to the chain.
+ *
+ * @param send The details for the transaction to prepare/send, including:
+ *   * `transaction`: The unsigned transaction
+ *   * `from`: The account to sign the transaction with: either an account with private key loaded or a logic signature account
+ *   * `config`: The sending configuration for this transaction
+ * @param algod An algod client
+ *
+ * @returns An object with transaction (`transaction`) and (if `skipWaiting` is `false` or `undefined`) confirmation (`confirmation`)
+ */
+export declare const sendTransaction: (send: {
+    transaction: Transaction;
+    from: SendTransactionFrom;
+    sendParams?: SendTransactionParams;
+}, algod: Algodv2) => Promise<SendTransactionResult>;
+/**
+ * Signs and sends transactions that have been collected by an @see AtomicTransactionComposer.
+ * @param atcSend The parameters controlling the send, including:
+ *  * `atc` The @see AtomicTransactionComposer
+ *  * `sendParams` The parameters to control the send behaviour
+ * @param algod An algod client
+ * @returns An object with transaction IDs, transactions, group transaction ID (`groupTransactionId`) if more than 1 transaction sent, and (if `skipWaiting` is `false` or unset) confirmation (`confirmation`)
+ */
+export declare const sendAtomicTransactionComposer: (atcSend: AtomicTransactionComposerToSend, algod: Algodv2) => Promise<{
+    groupId: string | undefined;
+    confirmations: PendingTransactionResponse[] | undefined;
+    txIds: string[];
+    transactions: algosdk.Transaction[];
+    returns: ABIReturn[];
+}>;
+/**
+ * Signs and sends a group of [up to 16](https://developer.algorand.org/docs/get-details/atomic_transfers/#create-transactions) transactions to the chain
+ *
+ * @param groupSend The group details to send, with:
+ *   * `transactions`: The array of transactions to send along with their signing account
+ *   * `sendParams`: The parameters to dictate how the group is sent
+ * @param algod An algod client
+ * @returns An object with transaction IDs, transactions, group transaction ID (`groupTransactionId`) if more than 1 transaction sent, and (if `skipWaiting` is `false` or unset) confirmation (`confirmation`)
+ */
+export declare const sendGroupOfTransactions: (groupSend: TransactionGroupToSend, algod: Algodv2) => Promise<{
+    groupId: string | undefined;
+    confirmations: PendingTransactionResponse[] | undefined;
+    txIds: string[];
+    transactions: algosdk.Transaction[];
+    returns: ABIReturn[];
+}>;
+/**
+ * Wait until the transaction is confirmed or rejected, or until `timeout`
+ * number of rounds have passed.
+ *
+ * @param algod An algod client
+ * @param transactionId The transaction ID to wait for
+ * @param maxRoundsToWait Maximum number of rounds to wait
+ *
+ * @return Pending transaction information
+ * @throws Throws an error if the transaction is not confirmed or rejected in the next `timeout` rounds
+ */
+export declare const waitForConfirmation: (transactionId: string, maxRoundsToWait: number, algod: Algodv2) => Promise<PendingTransactionResponse>;
+/**
+ * Limit the acceptable fee to a defined amount of µALGOs.
+ * This also sets the transaction to be flatFee to ensure the transaction only succeeds at
+ * the estimated rate.
+ * @param transaction The transaction to cap or suggested params object about to be used to create a transaction
+ * @param maxAcceptableFee The maximum acceptable fee to pay
+ */
+export declare function capTransactionFee(transaction: algosdk.Transaction | SuggestedParams, maxAcceptableFee: AlgoAmount): void;
+/**
+ * Allows for control of fees on a @see Transaction or @see SuggestedParams object
+ * @param transaction The transaction or suggested params
+ * @param feeControl The fee control parameters
+ */
+export declare function controlFees<T extends SuggestedParams | Transaction>(transaction: T, feeControl: {
+    fee?: AlgoAmount;
+    maxFee?: AlgoAmount;
+}): T;
+/**
+ * Returns suggested transaction parameters from algod unless some are already provided.
+ * @param params Optionally provide parameters to use
+ * @param algod Algod algod
+ * @returns The suggested transaction parameters
+ */
+export declare function getTransactionParams(params: SuggestedParams | undefined, algod: Algodv2): Promise<algosdk.SuggestedParams>;
+/**
+ * Returns the array of transactions currently present in the given @see AtomicTransactionComposer
+ * @param atc The atomic transaction composer
+ * @returns The array of transactions with signers
+ */
+export declare function getAtomicTransactionComposerTransactions(atc: AtomicTransactionComposer): algosdk.TransactionWithSigner[];
+//# sourceMappingURL=transaction.d.ts.map

package/transaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../src/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,EAAE,EAAE,OAAO,EAAE,yBAAyB,EAAE,eAAe,EAAE,WAAW,EAAqB,MAAM,SAAS,CAAA;AAGtH,OAAO,EAAE,0BAA0B,EAAE,MAAM,eAAe,CAAA;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EACL,+BAA+B,EAC/B,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,EACtB,eAAe,EAChB,MAAM,qBAAqB,CAAA;AAE5B;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,CAAC,EAAE,eAAe,GAAG,UAAU,GAAG,SAAS,CAcpF;AAED;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,WAAqB,mBAAmB,WAEpE,CAAA;AAWD;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,yDAMrC,CAAA;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,SACpB;IACJ,WAAW,EAAE,WAAW,CAAA;IACxB,IAAI,EAAE,mBAAmB,CAAA;IACzB,UAAU,CAAC,EAAE,qBAAqB,CAAA;CACnC,SACM,OAAO,KACb,QAAQ,qBAAqB,CAkC/B,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B,YAA4B,+BAA+B,SAAS,OAAO;;;;;;EAiDpH,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,uBAAuB,cAA8B,sBAAsB,SAAS,OAAO;;;;;;EAgCvG,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,mBAAmB,kBACf,MAAM,mBACJ,MAAM,SAChB,OAAO,KACb,QAAQ,0BAA0B,CAkCpC,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,OAAO,CAAC,WAAW,GAAG,eAAe,EAAE,gBAAgB,EAAE,UAAU,QAgBjH;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,eAAe,GAAG,WAAW,EACjE,WAAW,EAAE,CAAC,EACd,UAAU,EAAE;IAAE,GAAG,CAAC,EAAE,UAAU,CAAC;IAAC,MAAM,CAAC,EAAE,UAAU,CAAA;CAAE,KAatD;AAED;;;;;GAKG;AACH,wBAAsB,oBAAoB,CAAC,MAAM,EAAE,eAAe,GAAG,SAAS,EAAE,KAAK,EAAE,OAAO,oCAE7F;AAED;;;;GAIG;AACH,wBAAgB,wCAAwC,CAAC,GAAG,EAAE,yBAAyB,mCAMtF"}