@algorandfoundation/algokit-utils 7.0.1 → 7.1.0

package/package.json

@@ -6,7 +6,7 @@
     "**"
   ],
   "name": "@algorandfoundation/algokit-utils",
-  "version": "7.0.1",
+  "version": "7.1.0",
   "private": false,
   "description": "A set of core Algorand utilities written in TypeScript and released via npm that make it easier to build solutions on Algorand.",
   "author": "Algorand Foundation",

package/testing/fixtures/algorand-fixture.d.ts

@@ -8,29 +8,41 @@ import { AlgorandFixture, AlgorandFixtureConfig } from '../../types/testing';
  *  and/or kmd (or their respective config) if you want to test against
  * an explicitly defined network.
  *
- * @example No config
+ * @example No config (per-test isolation)
  * ```typescript
- * const algorand = algorandFixture()
+ * const fixture = algorandFixture()
  *
- * beforeEach(algorand.beforeEach, 10_000)
+ * beforeEach(fixture.newScope, 10_000)
  *
  * test('My test', async () => {
- *     const {algod, indexer, testAccount, ...} = algorand.context
+ *     const {algod, indexer, testAccount, ...} = fixture.context
+ *     // test things...
+ * })
+ * ```
+ *
+ * @example No config (test suite isolation)
+ * ```typescript
+ * const fixture = algorandFixture()
+ *
+ * beforeAll(fixture.newScope, 10_000)
+ *
+ * test('My test', async () => {
+ *     const {algod, indexer, testAccount, ...} = fixture.context
  *     // test things...
  * })
  * ```
  *
  * @example With config
  * ```typescript
- * const algorand = algorandFixture({
+ * const fixture = algorandFixture({
  *  algod: new Algodv2('localhost', 12345, 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'),
  *  // ...
  * })
  *
- * beforeEach(algorand.beforeEach, 10_000)
+ * beforeEach(fixture.newScope, 10_000)
  *
  * test('My test', async () => {
- *     const {algod, indexer, testAccount, ...} = algorand.context
+ *     const {algod, indexer, testAccount, ...} = fixture.context
  *     // test things...
  * })
  * ```
@@ -48,18 +60,6 @@ export declare function algorandFixture(fixtureConfig?: AlgorandFixtureConfig):
  *  a default LocalNet instance, but you can pass in an algod, indexer
  *  and/or kmd if you want to test against an explicitly defined network.
  *
- * @example
- * ```typescript
- * const algorand = algorandFixture(undefined, getConfigFromEnvOrDefaults())
- *
- * beforeEach(algorand.beforeEach, 10_000)
- *
- * test('My test', async () => {
- *     const {algod, indexer, testAccount, ...} = algorand.context
- *     // test things...
- * })
- * ```
- *
  * @param fixtureConfig The fixture configuration
  * @param config The fixture configuration
  * @returns The fixture

package/testing/fixtures/algorand-fixture.js

@@ -19,13 +19,13 @@ function algorandFixture(fixtureConfig, config$1) {
     const kmd = fixtureConfig.kmd ?? types_clientManager.ClientManager.getKmdClient(fixtureConfig.kmdConfig);
     let context;
     let algorand;
-    const beforeEach = async () => {
+    const newScope = async () => {
         config.Config.configure({ debug: true });
         const transactionLogger$1 = new transactionLogger.TransactionLogger();
         const transactionLoggerAlgod = transactionLogger$1.capture(algod);
-        algorand = types_algorandClient.AlgorandClient.fromClients({ algod: transactionLoggerAlgod, indexer: indexer$1, kmd });
+        algorand = types_algorandClient.AlgorandClient.fromClients({ algod: transactionLoggerAlgod, indexer: indexer$1, kmd }).setSuggestedParamsCacheTimeout(0);
         const acc = await account.getTestAccount({ initialFunds: fixtureConfig?.testAccountFunding ?? amount.algos(10), suppressLog: true }, algorand);
-        algorand.setSignerFromAccount(acc).setSuggestedParamsCacheTimeout(0);
+        algorand.setSignerFromAccount(acc);
         // If running against LocalNet we are likely in dev mode and we need to set a much higher validity window
         //  otherwise we are more likely to get invalid transactions.
         if (await algorand.client.isLocalNet()) {
@@ -50,12 +50,15 @@ function algorandFixture(fixtureConfig, config$1) {
     };
     return {
         get context() {
+            if (!context)
+                throw new Error('Context not initialised; make sure to call fixture.newScope() before accessing context.');
             return context;
         },
         get algorand() {
             return algorand;
         },
-        beforeEach,
+        beforeEach: newScope,
+        newScope,
     };
 }
 

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

@@ -1 +1 @@
-{"version":3,"file":"algorand-fixture.js","sources":["../../../src/testing/fixtures/algorand-fixture.ts"],"sourcesContent":["import { algos, Config, lookupTransactionById } from '../../'\nimport { AlgorandClient } from '../../types/algorand-client'\nimport { ClientManager } from '../../types/client-manager'\nimport { AlgoConfig } from '../../types/network-client'\nimport { AlgorandFixture, AlgorandFixtureConfig, AlgorandTestAutomationContext, GetTestAccountParams } from '../../types/testing'\nimport { getTestAccount } from '../account'\nimport { runWhenIndexerCaughtUp } from '../indexer'\nimport { TransactionLogger } from '../transaction-logger'\n\n/**\n * Creates a test fixture for automated testing against Algorand.\n * By default it tests against an environment variable specified client\n *  if the standard environment variables are specified, otherwise against\n *  a default LocalNet instance, but you can pass in an algod, indexer\n *  and/or kmd (or their respective config) if you want to test against\n * an explicitly defined network.\n *\n * @example No config\n * ```typescript\n * const algorand = algorandFixture()\n *\n * beforeEach(algorand.beforeEach, 10_000)\n *\n * test('My test', async () => {\n *     const {algod, indexer, testAccount, ...} = algorand.context\n *     // test things...\n * })\n * ```\n *\n * @example With config\n * ```typescript\n * const algorand = algorandFixture({\n *  algod: new Algodv2('localhost', 12345, 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'),\n *  // ...\n * })\n *\n * beforeEach(algorand.beforeEach, 10_000)\n *\n * test('My test', async () => {\n *     const {algod, indexer, testAccount, ...} = algorand.context\n *     // test things...\n * })\n * ```\n *\n * @param fixtureConfig The fixture configuration\n * @returns The fixture\n */\nexport function algorandFixture(fixtureConfig?: AlgorandFixtureConfig): AlgorandFixture\n\n/**\n * @deprecated Config can be passed in directly to fixture config now.\n *\n * Creates a test fixture for automated testing against Algorand.\n * By default it tests against an environment variable specified client\n *  if the standard environment variables are specified, otherwise against\n *  a default LocalNet instance, but you can pass in an algod, indexer\n *  and/or kmd if you want to test against an explicitly defined network.\n *\n * @example\n * ```typescript\n * const algorand = algorandFixture(undefined, getConfigFromEnvOrDefaults())\n *\n * beforeEach(algorand.beforeEach, 10_000)\n *\n * test('My test', async () => {\n *     const {algod, indexer, testAccount, ...} = algorand.context\n *     // test things...\n * })\n * ```\n *\n * @param fixtureConfig The fixture configuration\n * @param config The fixture configuration\n * @returns The fixture\n */\nexport function algorandFixture(fixtureConfig: AlgorandFixtureConfig | undefined, config: AlgoConfig): AlgorandFixture\n\nexport function algorandFixture(fixtureConfig?: AlgorandFixtureConfig, config?: AlgoConfig): AlgorandFixture {\n  fixtureConfig = { ...fixtureConfig, ...config }\n  if (!fixtureConfig.algod || !fixtureConfig.indexer || !fixtureConfig.kmd) {\n    fixtureConfig = { ...ClientManager.getConfigFromEnvironmentOrLocalNet(), ...fixtureConfig }\n  }\n\n  const algod = fixtureConfig.algod ?? ClientManager.getAlgodClient(fixtureConfig.algodConfig!)\n  const indexer = fixtureConfig.indexer ?? ClientManager.getIndexerClient(fixtureConfig.indexerConfig!)\n  const kmd = fixtureConfig.kmd ?? ClientManager.getKmdClient(fixtureConfig.kmdConfig!)\n  let context: AlgorandTestAutomationContext\n  let algorand: AlgorandClient\n\n  const beforeEach = async () => {\n    Config.configure({ debug: true })\n    const transactionLogger = new TransactionLogger()\n    const transactionLoggerAlgod = transactionLogger.capture(algod)\n    algorand = AlgorandClient.fromClients({ algod: transactionLoggerAlgod, indexer, kmd })\n    const acc = await getTestAccount({ initialFunds: fixtureConfig?.testAccountFunding ?? algos(10), suppressLog: true }, algorand)\n    algorand.setSignerFromAccount(acc).setSuggestedParamsCacheTimeout(0)\n    // If running against LocalNet we are likely in dev mode and we need to set a much higher validity window\n    //  otherwise we are more likely to get invalid transactions.\n    if (await algorand.client.isLocalNet()) {\n      algorand.setDefaultValidityWindow(1000)\n    }\n    const testAccount = { ...acc, signer: algorand.account.getSigner(acc.addr) }\n    context = {\n      algorand,\n      algod: transactionLoggerAlgod,\n      indexer: indexer,\n      kmd: kmd,\n      testAccount,\n      generateAccount: async (params: GetTestAccountParams) => {\n        const account = await getTestAccount(params, algorand)\n        algorand.setSignerFromAccount(account)\n        return { ...account, signer: algorand.account.getSigner(account.addr) }\n      },\n      transactionLogger: transactionLogger,\n      waitForIndexer: () => transactionLogger.waitForIndexer(indexer),\n      waitForIndexerTransaction: (transactionId: string) => runWhenIndexerCaughtUp(() => lookupTransactionById(transactionId, indexer)),\n    }\n  }\n\n  return {\n    get context() {\n      return context\n    },\n    get algorand() {\n      return algorand\n    },\n    beforeEach,\n  }\n}\n"],"names":["config","ClientManager","indexer","Config","transactionLogger","TransactionLogger","AlgorandClient","getTestAccount","algos","account","runWhenIndexerCaughtUp","lookupTransactionById"],"mappings":";;;;;;;;;;;AA4EgB,SAAA,eAAe,CAAC,aAAqC,EAAEA,QAAmB,EAAA;IACxF,aAAa,GAAG,EAAE,GAAG,aAAa,EAAE,GAAGA,QAAM,EAAE;AAC/C,IAAA,IAAI,CAAC,aAAa,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE;QACxE,aAAa,GAAG,EAAE,GAAGC,iCAAa,CAAC,kCAAkC,EAAE,EAAE,GAAG,aAAa,EAAE;;AAG7F,IAAA,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,IAAIA,iCAAa,CAAC,cAAc,CAAC,aAAa,CAAC,WAAY,CAAC;AAC7F,IAAA,MAAMC,SAAO,GAAG,aAAa,CAAC,OAAO,IAAID,iCAAa,CAAC,gBAAgB,CAAC,aAAa,CAAC,aAAc,CAAC;AACrG,IAAA,MAAM,GAAG,GAAG,aAAa,CAAC,GAAG,IAAIA,iCAAa,CAAC,YAAY,CAAC,aAAa,CAAC,SAAU,CAAC;AACrF,IAAA,IAAI,OAAsC;AAC1C,IAAA,IAAI,QAAwB;AAE5B,IAAA,MAAM,UAAU,GAAG,YAAW;QAC5BE,aAAM,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AACjC,QAAA,MAAMC,mBAAiB,GAAG,IAAIC,mCAAiB,EAAE;QACjD,MAAM,sBAAsB,GAAGD,mBAAiB,CAAC,OAAO,CAAC,KAAK,CAAC;AAC/D,QAAA,QAAQ,GAAGE,mCAAc,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,sBAAsB,WAAEJ,SAAO,EAAE,GAAG,EAAE,CAAC;QACtF,MAAM,GAAG,GAAG,MAAMK,sBAAc,CAAC,EAAE,YAAY,EAAE,aAAa,EAAE,kBAAkB,IAAIC,YAAK,CAAC,EAAE,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,QAAQ,CAAC;QAC/H,QAAQ,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,8BAA8B,CAAC,CAAC,CAAC;;;QAGpE,IAAI,MAAM,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE;AACtC,YAAA,QAAQ,CAAC,wBAAwB,CAAC,IAAI,CAAC;;AAEzC,QAAA,MAAM,WAAW,GAAG,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;AAC5E,QAAA,OAAO,GAAG;YACR,QAAQ;AACR,YAAA,KAAK,EAAE,sBAAsB;AAC7B,YAAA,OAAO,EAAEN,SAAO;AAChB,YAAA,GAAG,EAAE,GAAG;YACR,WAAW;AACX,YAAA,eAAe,EAAE,OAAO,MAA4B,KAAI;gBACtD,MAAMO,SAAO,GAAG,MAAMF,sBAAc,CAAC,MAAM,EAAE,QAAQ,CAAC;AACtD,gBAAA,QAAQ,CAAC,oBAAoB,CAACE,SAAO,CAAC;AACtC,gBAAA,OAAO,EAAE,GAAGA,SAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,SAAS,CAACA,SAAO,CAAC,IAAI,CAAC,EAAE;aACxE;AACD,YAAA,iBAAiB,EAAEL,mBAAiB;YACpC,cAAc,EAAE,MAAMA,mBAAiB,CAAC,cAAc,CAACF,SAAO,CAAC;AAC/D,YAAA,yBAAyB,EAAE,CAAC,aAAqB,KAAKQ,8BAAsB,CAAC,MAAMC,mCAAqB,CAAC,aAAa,EAAET,SAAO,CAAC,CAAC;SAClI;AACH,KAAC;IAED,OAAO;AACL,QAAA,IAAI,OAAO,GAAA;AACT,YAAA,OAAO,OAAO;SACf;AACD,QAAA,IAAI,QAAQ,GAAA;AACV,YAAA,OAAO,QAAQ;SAChB;QACD,UAAU;KACX;AACH;;;;"}
+{"version":3,"file":"algorand-fixture.js","sources":["../../../src/testing/fixtures/algorand-fixture.ts"],"sourcesContent":["import { algos, Config, lookupTransactionById } from '../../'\nimport { AlgorandClient } from '../../types/algorand-client'\nimport { ClientManager } from '../../types/client-manager'\nimport { AlgoConfig } from '../../types/network-client'\nimport { AlgorandFixture, AlgorandFixtureConfig, AlgorandTestAutomationContext, GetTestAccountParams } from '../../types/testing'\nimport { getTestAccount } from '../account'\nimport { runWhenIndexerCaughtUp } from '../indexer'\nimport { TransactionLogger } from '../transaction-logger'\n\n/**\n * Creates a test fixture for automated testing against Algorand.\n * By default it tests against an environment variable specified client\n *  if the standard environment variables are specified, otherwise against\n *  a default LocalNet instance, but you can pass in an algod, indexer\n *  and/or kmd (or their respective config) if you want to test against\n * an explicitly defined network.\n *\n * @example No config (per-test isolation)\n * ```typescript\n * const fixture = algorandFixture()\n *\n * beforeEach(fixture.newScope, 10_000)\n *\n * test('My test', async () => {\n *     const {algod, indexer, testAccount, ...} = fixture.context\n *     // test things...\n * })\n * ```\n *\n * @example No config (test suite isolation)\n * ```typescript\n * const fixture = algorandFixture()\n *\n * beforeAll(fixture.newScope, 10_000)\n *\n * test('My test', async () => {\n *     const {algod, indexer, testAccount, ...} = fixture.context\n *     // test things...\n * })\n * ```\n *\n * @example With config\n * ```typescript\n * const fixture = algorandFixture({\n *  algod: new Algodv2('localhost', 12345, 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'),\n *  // ...\n * })\n *\n * beforeEach(fixture.newScope, 10_000)\n *\n * test('My test', async () => {\n *     const {algod, indexer, testAccount, ...} = fixture.context\n *     // test things...\n * })\n * ```\n *\n * @param fixtureConfig The fixture configuration\n * @returns The fixture\n */\nexport function algorandFixture(fixtureConfig?: AlgorandFixtureConfig): AlgorandFixture\n\n/**\n * @deprecated Config can be passed in directly to fixture config now.\n *\n * Creates a test fixture for automated testing against Algorand.\n * By default it tests against an environment variable specified client\n *  if the standard environment variables are specified, otherwise against\n *  a default LocalNet instance, but you can pass in an algod, indexer\n *  and/or kmd if you want to test against an explicitly defined network.\n *\n * @param fixtureConfig The fixture configuration\n * @param config The fixture configuration\n * @returns The fixture\n */\nexport function algorandFixture(fixtureConfig: AlgorandFixtureConfig | undefined, config: AlgoConfig): AlgorandFixture\n\nexport function algorandFixture(fixtureConfig?: AlgorandFixtureConfig, config?: AlgoConfig): AlgorandFixture {\n  fixtureConfig = { ...fixtureConfig, ...config }\n  if (!fixtureConfig.algod || !fixtureConfig.indexer || !fixtureConfig.kmd) {\n    fixtureConfig = { ...ClientManager.getConfigFromEnvironmentOrLocalNet(), ...fixtureConfig }\n  }\n\n  const algod = fixtureConfig.algod ?? ClientManager.getAlgodClient(fixtureConfig.algodConfig!)\n  const indexer = fixtureConfig.indexer ?? ClientManager.getIndexerClient(fixtureConfig.indexerConfig!)\n  const kmd = fixtureConfig.kmd ?? ClientManager.getKmdClient(fixtureConfig.kmdConfig!)\n  let context: AlgorandTestAutomationContext\n  let algorand: AlgorandClient\n\n  const newScope = async () => {\n    Config.configure({ debug: true })\n    const transactionLogger = new TransactionLogger()\n    const transactionLoggerAlgod = transactionLogger.capture(algod)\n    algorand = AlgorandClient.fromClients({ algod: transactionLoggerAlgod, indexer, kmd }).setSuggestedParamsCacheTimeout(0)\n\n    const acc = await getTestAccount({ initialFunds: fixtureConfig?.testAccountFunding ?? algos(10), suppressLog: true }, algorand)\n    algorand.setSignerFromAccount(acc)\n    // If running against LocalNet we are likely in dev mode and we need to set a much higher validity window\n    //  otherwise we are more likely to get invalid transactions.\n    if (await algorand.client.isLocalNet()) {\n      algorand.setDefaultValidityWindow(1000)\n    }\n    const testAccount = { ...acc, signer: algorand.account.getSigner(acc.addr) }\n    context = {\n      algorand,\n      algod: transactionLoggerAlgod,\n      indexer: indexer,\n      kmd: kmd,\n      testAccount,\n      generateAccount: async (params: GetTestAccountParams) => {\n        const account = await getTestAccount(params, algorand)\n        algorand.setSignerFromAccount(account)\n        return { ...account, signer: algorand.account.getSigner(account.addr) }\n      },\n      transactionLogger: transactionLogger,\n      waitForIndexer: () => transactionLogger.waitForIndexer(indexer),\n      waitForIndexerTransaction: (transactionId: string) => runWhenIndexerCaughtUp(() => lookupTransactionById(transactionId, indexer)),\n    }\n  }\n\n  return {\n    get context() {\n      if (!context) throw new Error('Context not initialised; make sure to call fixture.newScope() before accessing context.')\n      return context\n    },\n    get algorand() {\n      return algorand\n    },\n    beforeEach: newScope,\n    newScope,\n  }\n}\n"],"names":["config","ClientManager","indexer","Config","transactionLogger","TransactionLogger","AlgorandClient","getTestAccount","algos","account","runWhenIndexerCaughtUp","lookupTransactionById"],"mappings":";;;;;;;;;;;AA4EgB,SAAA,eAAe,CAAC,aAAqC,EAAEA,QAAmB,EAAA;IACxF,aAAa,GAAG,EAAE,GAAG,aAAa,EAAE,GAAGA,QAAM,EAAE;AAC/C,IAAA,IAAI,CAAC,aAAa,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE;QACxE,aAAa,GAAG,EAAE,GAAGC,iCAAa,CAAC,kCAAkC,EAAE,EAAE,GAAG,aAAa,EAAE;;AAG7F,IAAA,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,IAAIA,iCAAa,CAAC,cAAc,CAAC,aAAa,CAAC,WAAY,CAAC;AAC7F,IAAA,MAAMC,SAAO,GAAG,aAAa,CAAC,OAAO,IAAID,iCAAa,CAAC,gBAAgB,CAAC,aAAa,CAAC,aAAc,CAAC;AACrG,IAAA,MAAM,GAAG,GAAG,aAAa,CAAC,GAAG,IAAIA,iCAAa,CAAC,YAAY,CAAC,aAAa,CAAC,SAAU,CAAC;AACrF,IAAA,IAAI,OAAsC;AAC1C,IAAA,IAAI,QAAwB;AAE5B,IAAA,MAAM,QAAQ,GAAG,YAAW;QAC1BE,aAAM,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AACjC,QAAA,MAAMC,mBAAiB,GAAG,IAAIC,mCAAiB,EAAE;QACjD,MAAM,sBAAsB,GAAGD,mBAAiB,CAAC,OAAO,CAAC,KAAK,CAAC;QAC/D,QAAQ,GAAGE,mCAAc,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,sBAAsB,WAAEJ,SAAO,EAAE,GAAG,EAAE,CAAC,CAAC,8BAA8B,CAAC,CAAC,CAAC;QAExH,MAAM,GAAG,GAAG,MAAMK,sBAAc,CAAC,EAAE,YAAY,EAAE,aAAa,EAAE,kBAAkB,IAAIC,YAAK,CAAC,EAAE,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,QAAQ,CAAC;AAC/H,QAAA,QAAQ,CAAC,oBAAoB,CAAC,GAAG,CAAC;;;QAGlC,IAAI,MAAM,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE;AACtC,YAAA,QAAQ,CAAC,wBAAwB,CAAC,IAAI,CAAC;;AAEzC,QAAA,MAAM,WAAW,GAAG,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;AAC5E,QAAA,OAAO,GAAG;YACR,QAAQ;AACR,YAAA,KAAK,EAAE,sBAAsB;AAC7B,YAAA,OAAO,EAAEN,SAAO;AAChB,YAAA,GAAG,EAAE,GAAG;YACR,WAAW;AACX,YAAA,eAAe,EAAE,OAAO,MAA4B,KAAI;gBACtD,MAAMO,SAAO,GAAG,MAAMF,sBAAc,CAAC,MAAM,EAAE,QAAQ,CAAC;AACtD,gBAAA,QAAQ,CAAC,oBAAoB,CAACE,SAAO,CAAC;AACtC,gBAAA,OAAO,EAAE,GAAGA,SAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,SAAS,CAACA,SAAO,CAAC,IAAI,CAAC,EAAE;aACxE;AACD,YAAA,iBAAiB,EAAEL,mBAAiB;YACpC,cAAc,EAAE,MAAMA,mBAAiB,CAAC,cAAc,CAACF,SAAO,CAAC;AAC/D,YAAA,yBAAyB,EAAE,CAAC,aAAqB,KAAKQ,8BAAsB,CAAC,MAAMC,mCAAqB,CAAC,aAAa,EAAET,SAAO,CAAC,CAAC;SAClI;AACH,KAAC;IAED,OAAO;AACL,QAAA,IAAI,OAAO,GAAA;AACT,YAAA,IAAI,CAAC,OAAO;AAAE,gBAAA,MAAM,IAAI,KAAK,CAAC,yFAAyF,CAAC;AACxH,YAAA,OAAO,OAAO;SACf;AACD,QAAA,IAAI,QAAQ,GAAA;AACV,YAAA,OAAO,QAAQ;SAChB;AACD,QAAA,UAAU,EAAE,QAAQ;QACpB,QAAQ;KACT;AACH;;;;"}

package/testing/fixtures/algorand-fixture.mjs

@@ -17,13 +17,13 @@ function algorandFixture(fixtureConfig, config) {
     const kmd = fixtureConfig.kmd ?? ClientManager.getKmdClient(fixtureConfig.kmdConfig);
     let context;
     let algorand;
-    const beforeEach = async () => {
+    const newScope = async () => {
         Config.configure({ debug: true });
         const transactionLogger = new TransactionLogger();
         const transactionLoggerAlgod = transactionLogger.capture(algod);
-        algorand = AlgorandClient.fromClients({ algod: transactionLoggerAlgod, indexer, kmd });
+        algorand = AlgorandClient.fromClients({ algod: transactionLoggerAlgod, indexer, kmd }).setSuggestedParamsCacheTimeout(0);
         const acc = await getTestAccount({ initialFunds: fixtureConfig?.testAccountFunding ?? algos(10), suppressLog: true }, algorand);
-        algorand.setSignerFromAccount(acc).setSuggestedParamsCacheTimeout(0);
+        algorand.setSignerFromAccount(acc);
         // If running against LocalNet we are likely in dev mode and we need to set a much higher validity window
         //  otherwise we are more likely to get invalid transactions.
         if (await algorand.client.isLocalNet()) {
@@ -48,12 +48,15 @@ function algorandFixture(fixtureConfig, config) {
     };
     return {
         get context() {
+            if (!context)
+                throw new Error('Context not initialised; make sure to call fixture.newScope() before accessing context.');
             return context;
         },
         get algorand() {
             return algorand;
         },
-        beforeEach,
+        beforeEach: newScope,
+        newScope,
     };
 }
 

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

@@ -1 +1 @@
-{"version":3,"file":"algorand-fixture.mjs","sources":["../../../src/testing/fixtures/algorand-fixture.ts"],"sourcesContent":["import { algos, Config, lookupTransactionById } from '../../'\nimport { AlgorandClient } from '../../types/algorand-client'\nimport { ClientManager } from '../../types/client-manager'\nimport { AlgoConfig } from '../../types/network-client'\nimport { AlgorandFixture, AlgorandFixtureConfig, AlgorandTestAutomationContext, GetTestAccountParams } from '../../types/testing'\nimport { getTestAccount } from '../account'\nimport { runWhenIndexerCaughtUp } from '../indexer'\nimport { TransactionLogger } from '../transaction-logger'\n\n/**\n * Creates a test fixture for automated testing against Algorand.\n * By default it tests against an environment variable specified client\n *  if the standard environment variables are specified, otherwise against\n *  a default LocalNet instance, but you can pass in an algod, indexer\n *  and/or kmd (or their respective config) if you want to test against\n * an explicitly defined network.\n *\n * @example No config\n * ```typescript\n * const algorand = algorandFixture()\n *\n * beforeEach(algorand.beforeEach, 10_000)\n *\n * test('My test', async () => {\n *     const {algod, indexer, testAccount, ...} = algorand.context\n *     // test things...\n * })\n * ```\n *\n * @example With config\n * ```typescript\n * const algorand = algorandFixture({\n *  algod: new Algodv2('localhost', 12345, 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'),\n *  // ...\n * })\n *\n * beforeEach(algorand.beforeEach, 10_000)\n *\n * test('My test', async () => {\n *     const {algod, indexer, testAccount, ...} = algorand.context\n *     // test things...\n * })\n * ```\n *\n * @param fixtureConfig The fixture configuration\n * @returns The fixture\n */\nexport function algorandFixture(fixtureConfig?: AlgorandFixtureConfig): AlgorandFixture\n\n/**\n * @deprecated Config can be passed in directly to fixture config now.\n *\n * Creates a test fixture for automated testing against Algorand.\n * By default it tests against an environment variable specified client\n *  if the standard environment variables are specified, otherwise against\n *  a default LocalNet instance, but you can pass in an algod, indexer\n *  and/or kmd if you want to test against an explicitly defined network.\n *\n * @example\n * ```typescript\n * const algorand = algorandFixture(undefined, getConfigFromEnvOrDefaults())\n *\n * beforeEach(algorand.beforeEach, 10_000)\n *\n * test('My test', async () => {\n *     const {algod, indexer, testAccount, ...} = algorand.context\n *     // test things...\n * })\n * ```\n *\n * @param fixtureConfig The fixture configuration\n * @param config The fixture configuration\n * @returns The fixture\n */\nexport function algorandFixture(fixtureConfig: AlgorandFixtureConfig | undefined, config: AlgoConfig): AlgorandFixture\n\nexport function algorandFixture(fixtureConfig?: AlgorandFixtureConfig, config?: AlgoConfig): AlgorandFixture {\n  fixtureConfig = { ...fixtureConfig, ...config }\n  if (!fixtureConfig.algod || !fixtureConfig.indexer || !fixtureConfig.kmd) {\n    fixtureConfig = { ...ClientManager.getConfigFromEnvironmentOrLocalNet(), ...fixtureConfig }\n  }\n\n  const algod = fixtureConfig.algod ?? ClientManager.getAlgodClient(fixtureConfig.algodConfig!)\n  const indexer = fixtureConfig.indexer ?? ClientManager.getIndexerClient(fixtureConfig.indexerConfig!)\n  const kmd = fixtureConfig.kmd ?? ClientManager.getKmdClient(fixtureConfig.kmdConfig!)\n  let context: AlgorandTestAutomationContext\n  let algorand: AlgorandClient\n\n  const beforeEach = async () => {\n    Config.configure({ debug: true })\n    const transactionLogger = new TransactionLogger()\n    const transactionLoggerAlgod = transactionLogger.capture(algod)\n    algorand = AlgorandClient.fromClients({ algod: transactionLoggerAlgod, indexer, kmd })\n    const acc = await getTestAccount({ initialFunds: fixtureConfig?.testAccountFunding ?? algos(10), suppressLog: true }, algorand)\n    algorand.setSignerFromAccount(acc).setSuggestedParamsCacheTimeout(0)\n    // If running against LocalNet we are likely in dev mode and we need to set a much higher validity window\n    //  otherwise we are more likely to get invalid transactions.\n    if (await algorand.client.isLocalNet()) {\n      algorand.setDefaultValidityWindow(1000)\n    }\n    const testAccount = { ...acc, signer: algorand.account.getSigner(acc.addr) }\n    context = {\n      algorand,\n      algod: transactionLoggerAlgod,\n      indexer: indexer,\n      kmd: kmd,\n      testAccount,\n      generateAccount: async (params: GetTestAccountParams) => {\n        const account = await getTestAccount(params, algorand)\n        algorand.setSignerFromAccount(account)\n        return { ...account, signer: algorand.account.getSigner(account.addr) }\n      },\n      transactionLogger: transactionLogger,\n      waitForIndexer: () => transactionLogger.waitForIndexer(indexer),\n      waitForIndexerTransaction: (transactionId: string) => runWhenIndexerCaughtUp(() => lookupTransactionById(transactionId, indexer)),\n    }\n  }\n\n  return {\n    get context() {\n      return context\n    },\n    get algorand() {\n      return algorand\n    },\n    beforeEach,\n  }\n}\n"],"names":[],"mappings":";;;;;;;;;AA4EgB,SAAA,eAAe,CAAC,aAAqC,EAAE,MAAmB,EAAA;IACxF,aAAa,GAAG,EAAE,GAAG,aAAa,EAAE,GAAG,MAAM,EAAE;AAC/C,IAAA,IAAI,CAAC,aAAa,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE;QACxE,aAAa,GAAG,EAAE,GAAG,aAAa,CAAC,kCAAkC,EAAE,EAAE,GAAG,aAAa,EAAE;;AAG7F,IAAA,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,IAAI,aAAa,CAAC,cAAc,CAAC,aAAa,CAAC,WAAY,CAAC;AAC7F,IAAA,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,IAAI,aAAa,CAAC,gBAAgB,CAAC,aAAa,CAAC,aAAc,CAAC;AACrG,IAAA,MAAM,GAAG,GAAG,aAAa,CAAC,GAAG,IAAI,aAAa,CAAC,YAAY,CAAC,aAAa,CAAC,SAAU,CAAC;AACrF,IAAA,IAAI,OAAsC;AAC1C,IAAA,IAAI,QAAwB;AAE5B,IAAA,MAAM,UAAU,GAAG,YAAW;QAC5B,MAAM,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AACjC,QAAA,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,EAAE;QACjD,MAAM,sBAAsB,GAAG,iBAAiB,CAAC,OAAO,CAAC,KAAK,CAAC;AAC/D,QAAA,QAAQ,GAAG,cAAc,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,sBAAsB,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;QACtF,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,EAAE,YAAY,EAAE,aAAa,EAAE,kBAAkB,IAAI,KAAK,CAAC,EAAE,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,QAAQ,CAAC;QAC/H,QAAQ,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,8BAA8B,CAAC,CAAC,CAAC;;;QAGpE,IAAI,MAAM,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE;AACtC,YAAA,QAAQ,CAAC,wBAAwB,CAAC,IAAI,CAAC;;AAEzC,QAAA,MAAM,WAAW,GAAG,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;AAC5E,QAAA,OAAO,GAAG;YACR,QAAQ;AACR,YAAA,KAAK,EAAE,sBAAsB;AAC7B,YAAA,OAAO,EAAE,OAAO;AAChB,YAAA,GAAG,EAAE,GAAG;YACR,WAAW;AACX,YAAA,eAAe,EAAE,OAAO,MAA4B,KAAI;gBACtD,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC;AACtD,gBAAA,QAAQ,CAAC,oBAAoB,CAAC,OAAO,CAAC;AACtC,gBAAA,OAAO,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;aACxE;AACD,YAAA,iBAAiB,EAAE,iBAAiB;YACpC,cAAc,EAAE,MAAM,iBAAiB,CAAC,cAAc,CAAC,OAAO,CAAC;AAC/D,YAAA,yBAAyB,EAAE,CAAC,aAAqB,KAAK,sBAAsB,CAAC,MAAM,qBAAqB,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;SAClI;AACH,KAAC;IAED,OAAO;AACL,QAAA,IAAI,OAAO,GAAA;AACT,YAAA,OAAO,OAAO;SACf;AACD,QAAA,IAAI,QAAQ,GAAA;AACV,YAAA,OAAO,QAAQ;SAChB;QACD,UAAU;KACX;AACH;;;;"}
+{"version":3,"file":"algorand-fixture.mjs","sources":["../../../src/testing/fixtures/algorand-fixture.ts"],"sourcesContent":["import { algos, Config, lookupTransactionById } from '../../'\nimport { AlgorandClient } from '../../types/algorand-client'\nimport { ClientManager } from '../../types/client-manager'\nimport { AlgoConfig } from '../../types/network-client'\nimport { AlgorandFixture, AlgorandFixtureConfig, AlgorandTestAutomationContext, GetTestAccountParams } from '../../types/testing'\nimport { getTestAccount } from '../account'\nimport { runWhenIndexerCaughtUp } from '../indexer'\nimport { TransactionLogger } from '../transaction-logger'\n\n/**\n * Creates a test fixture for automated testing against Algorand.\n * By default it tests against an environment variable specified client\n *  if the standard environment variables are specified, otherwise against\n *  a default LocalNet instance, but you can pass in an algod, indexer\n *  and/or kmd (or their respective config) if you want to test against\n * an explicitly defined network.\n *\n * @example No config (per-test isolation)\n * ```typescript\n * const fixture = algorandFixture()\n *\n * beforeEach(fixture.newScope, 10_000)\n *\n * test('My test', async () => {\n *     const {algod, indexer, testAccount, ...} = fixture.context\n *     // test things...\n * })\n * ```\n *\n * @example No config (test suite isolation)\n * ```typescript\n * const fixture = algorandFixture()\n *\n * beforeAll(fixture.newScope, 10_000)\n *\n * test('My test', async () => {\n *     const {algod, indexer, testAccount, ...} = fixture.context\n *     // test things...\n * })\n * ```\n *\n * @example With config\n * ```typescript\n * const fixture = algorandFixture({\n *  algod: new Algodv2('localhost', 12345, 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'),\n *  // ...\n * })\n *\n * beforeEach(fixture.newScope, 10_000)\n *\n * test('My test', async () => {\n *     const {algod, indexer, testAccount, ...} = fixture.context\n *     // test things...\n * })\n * ```\n *\n * @param fixtureConfig The fixture configuration\n * @returns The fixture\n */\nexport function algorandFixture(fixtureConfig?: AlgorandFixtureConfig): AlgorandFixture\n\n/**\n * @deprecated Config can be passed in directly to fixture config now.\n *\n * Creates a test fixture for automated testing against Algorand.\n * By default it tests against an environment variable specified client\n *  if the standard environment variables are specified, otherwise against\n *  a default LocalNet instance, but you can pass in an algod, indexer\n *  and/or kmd if you want to test against an explicitly defined network.\n *\n * @param fixtureConfig The fixture configuration\n * @param config The fixture configuration\n * @returns The fixture\n */\nexport function algorandFixture(fixtureConfig: AlgorandFixtureConfig | undefined, config: AlgoConfig): AlgorandFixture\n\nexport function algorandFixture(fixtureConfig?: AlgorandFixtureConfig, config?: AlgoConfig): AlgorandFixture {\n  fixtureConfig = { ...fixtureConfig, ...config }\n  if (!fixtureConfig.algod || !fixtureConfig.indexer || !fixtureConfig.kmd) {\n    fixtureConfig = { ...ClientManager.getConfigFromEnvironmentOrLocalNet(), ...fixtureConfig }\n  }\n\n  const algod = fixtureConfig.algod ?? ClientManager.getAlgodClient(fixtureConfig.algodConfig!)\n  const indexer = fixtureConfig.indexer ?? ClientManager.getIndexerClient(fixtureConfig.indexerConfig!)\n  const kmd = fixtureConfig.kmd ?? ClientManager.getKmdClient(fixtureConfig.kmdConfig!)\n  let context: AlgorandTestAutomationContext\n  let algorand: AlgorandClient\n\n  const newScope = async () => {\n    Config.configure({ debug: true })\n    const transactionLogger = new TransactionLogger()\n    const transactionLoggerAlgod = transactionLogger.capture(algod)\n    algorand = AlgorandClient.fromClients({ algod: transactionLoggerAlgod, indexer, kmd }).setSuggestedParamsCacheTimeout(0)\n\n    const acc = await getTestAccount({ initialFunds: fixtureConfig?.testAccountFunding ?? algos(10), suppressLog: true }, algorand)\n    algorand.setSignerFromAccount(acc)\n    // If running against LocalNet we are likely in dev mode and we need to set a much higher validity window\n    //  otherwise we are more likely to get invalid transactions.\n    if (await algorand.client.isLocalNet()) {\n      algorand.setDefaultValidityWindow(1000)\n    }\n    const testAccount = { ...acc, signer: algorand.account.getSigner(acc.addr) }\n    context = {\n      algorand,\n      algod: transactionLoggerAlgod,\n      indexer: indexer,\n      kmd: kmd,\n      testAccount,\n      generateAccount: async (params: GetTestAccountParams) => {\n        const account = await getTestAccount(params, algorand)\n        algorand.setSignerFromAccount(account)\n        return { ...account, signer: algorand.account.getSigner(account.addr) }\n      },\n      transactionLogger: transactionLogger,\n      waitForIndexer: () => transactionLogger.waitForIndexer(indexer),\n      waitForIndexerTransaction: (transactionId: string) => runWhenIndexerCaughtUp(() => lookupTransactionById(transactionId, indexer)),\n    }\n  }\n\n  return {\n    get context() {\n      if (!context) throw new Error('Context not initialised; make sure to call fixture.newScope() before accessing context.')\n      return context\n    },\n    get algorand() {\n      return algorand\n    },\n    beforeEach: newScope,\n    newScope,\n  }\n}\n"],"names":[],"mappings":";;;;;;;;;AA4EgB,SAAA,eAAe,CAAC,aAAqC,EAAE,MAAmB,EAAA;IACxF,aAAa,GAAG,EAAE,GAAG,aAAa,EAAE,GAAG,MAAM,EAAE;AAC/C,IAAA,IAAI,CAAC,aAAa,CAAC,KAAK,IAAI,CAAC,aAAa,CAAC,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE;QACxE,aAAa,GAAG,EAAE,GAAG,aAAa,CAAC,kCAAkC,EAAE,EAAE,GAAG,aAAa,EAAE;;AAG7F,IAAA,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,IAAI,aAAa,CAAC,cAAc,CAAC,aAAa,CAAC,WAAY,CAAC;AAC7F,IAAA,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,IAAI,aAAa,CAAC,gBAAgB,CAAC,aAAa,CAAC,aAAc,CAAC;AACrG,IAAA,MAAM,GAAG,GAAG,aAAa,CAAC,GAAG,IAAI,aAAa,CAAC,YAAY,CAAC,aAAa,CAAC,SAAU,CAAC;AACrF,IAAA,IAAI,OAAsC;AAC1C,IAAA,IAAI,QAAwB;AAE5B,IAAA,MAAM,QAAQ,GAAG,YAAW;QAC1B,MAAM,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AACjC,QAAA,MAAM,iBAAiB,GAAG,IAAI,iBAAiB,EAAE;QACjD,MAAM,sBAAsB,GAAG,iBAAiB,CAAC,OAAO,CAAC,KAAK,CAAC;QAC/D,QAAQ,GAAG,cAAc,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,sBAAsB,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,8BAA8B,CAAC,CAAC,CAAC;QAExH,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,EAAE,YAAY,EAAE,aAAa,EAAE,kBAAkB,IAAI,KAAK,CAAC,EAAE,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,QAAQ,CAAC;AAC/H,QAAA,QAAQ,CAAC,oBAAoB,CAAC,GAAG,CAAC;;;QAGlC,IAAI,MAAM,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE;AACtC,YAAA,QAAQ,CAAC,wBAAwB,CAAC,IAAI,CAAC;;AAEzC,QAAA,MAAM,WAAW,GAAG,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;AAC5E,QAAA,OAAO,GAAG;YACR,QAAQ;AACR,YAAA,KAAK,EAAE,sBAAsB;AAC7B,YAAA,OAAO,EAAE,OAAO;AAChB,YAAA,GAAG,EAAE,GAAG;YACR,WAAW;AACX,YAAA,eAAe,EAAE,OAAO,MAA4B,KAAI;gBACtD,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC;AACtD,gBAAA,QAAQ,CAAC,oBAAoB,CAAC,OAAO,CAAC;AACtC,gBAAA,OAAO,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;aACxE;AACD,YAAA,iBAAiB,EAAE,iBAAiB;YACpC,cAAc,EAAE,MAAM,iBAAiB,CAAC,cAAc,CAAC,OAAO,CAAC;AAC/D,YAAA,yBAAyB,EAAE,CAAC,aAAqB,KAAK,sBAAsB,CAAC,MAAM,qBAAqB,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;SAClI;AACH,KAAC;IAED,OAAO;AACL,QAAA,IAAI,OAAO,GAAA;AACT,YAAA,IAAI,CAAC,OAAO;AAAE,gBAAA,MAAM,IAAI,KAAK,CAAC,yFAAyF,CAAC;AACxH,YAAA,OAAO,OAAO;SACf;AACD,QAAA,IAAI,QAAQ,GAAA;AACV,YAAA,OAAO,QAAQ;SAChB;AACD,QAAA,UAAU,EAAE,QAAQ;QACpB,QAAQ;KACT;AACH;;;;"}

package/testing/test-logger.js

@@ -1,5 +1,7 @@
 'use strict';
 
+var util = require('../util.js');
+
 /** Exposes an AlgoKit logger which captures log messages, while wrapping an original logger.
  * This is useful for automated testing.
  */
@@ -46,23 +48,23 @@ class TestLogger {
     }
     error(message, ...optionalParams) {
         this.originalLogger?.error(message, ...optionalParams);
-        this.logs.push(`ERROR: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`);
+        this.logs.push(`ERROR: ${message}${optionalParams.length ? ` | ${util.asJson(optionalParams)}` : ''}`);
     }
     warn(message, ...optionalParams) {
         this.originalLogger?.warn(message, ...optionalParams);
-        this.logs.push(`WARN: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`);
+        this.logs.push(`WARN: ${message}${optionalParams.length ? ` | ${util.asJson(optionalParams)}` : ''}`);
     }
     info(message, ...optionalParams) {
         this.originalLogger?.info(message, ...optionalParams);
-        this.logs.push(`INFO: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`);
+        this.logs.push(`INFO: ${message}${optionalParams.length ? ` | ${util.asJson(optionalParams)}` : ''}`);
     }
     verbose(message, ...optionalParams) {
         this.originalLogger?.verbose(message, ...optionalParams);
-        this.logs.push(`VERBOSE: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`);
+        this.logs.push(`VERBOSE: ${message}${optionalParams.length ? ` | ${util.asJson(optionalParams)}` : ''}`);
     }
     debug(message, ...optionalParams) {
         this.originalLogger?.debug(message, ...optionalParams);
-        this.logs.push(`DEBUG: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`);
+        this.logs.push(`DEBUG: ${message}${optionalParams.length ? ` | ${util.asJson(optionalParams)}` : ''}`);
     }
 }
 

package/testing/test-logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"test-logger.js","sources":["../../src/testing/test-logger.ts"],"sourcesContent":["import { Logger } from '../types/logging'\nimport { LogSnapshotConfig } from '../types/testing'\n\n/** Exposes an AlgoKit logger which captures log messages, while wrapping an original logger.\n * This is useful for automated testing.\n */\nexport class TestLogger implements Logger {\n  private originalLogger: Logger | undefined\n  private logs: string[]\n\n  /**\n   * Create a new test logger that wraps the given logger if provided.\n   * @param originalLogger The optional original logger to wrap.\n   */\n  constructor(originalLogger?: Logger) {\n    this.originalLogger = originalLogger\n    this.logs = []\n  }\n\n  /** Returns all logs captured thus far. */\n  get capturedLogs(): string[] {\n    return this.logs\n  }\n\n  /** Clears all logs captured so far. */\n  clear() {\n    this.logs = []\n  }\n\n  /**\n   * Returns a captured log snapshot.\n   * This helps ensure that the provided configuration items won't appear\n   *  with random values in the log snapshot, but rather will get substituted with predictable ids.\n   *\n   * https://jestjs.io/docs/snapshot-testing#2-tests-should-be-deterministic\n   *\n   * @example Jest Example\n   * ```typescript\n   * const logger = new TestLogger()\n   * ...\n   * expect(logger.getLogSnapshot()).toMatchSnapshot()\n   * ```\n   * @param config The snapshot configuration\n   * @returns The snapshotted logs.\n   */\n  getLogSnapshot(config?: LogSnapshotConfig) {\n    const { transactions: transactionIds, accounts, apps } = config ?? {}\n    let snapshot = this.capturedLogs.join('\\n')\n    transactionIds?.forEach(\n      (txn, id) => (snapshot = snapshot.replace(new RegExp(typeof txn === 'string' ? txn : txn.txID(), 'g'), `TXID_${id + 1}`)),\n    )\n    accounts?.forEach(\n      (sender, id) =>\n        (snapshot = snapshot.replace(\n          new RegExp(typeof sender === 'string' ? sender : 'addr' in sender ? sender.addr : sender.address(), 'g'),\n          `ACCOUNT_${id + 1}`,\n        )),\n    )\n    apps?.forEach((app, id) => (snapshot = snapshot.replace(new RegExp(`\\\\b${app.toString()}\\\\b(?! bytes)`, 'g'), `APP_${id + 1}`)))\n    return snapshot\n  }\n\n  error(message: string, ...optionalParams: unknown[]): void {\n    this.originalLogger?.error(message, ...optionalParams)\n    this.logs.push(`ERROR: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`)\n  }\n  warn(message: string, ...optionalParams: unknown[]): void {\n    this.originalLogger?.warn(message, ...optionalParams)\n    this.logs.push(`WARN: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`)\n  }\n  info(message: string, ...optionalParams: unknown[]): void {\n    this.originalLogger?.info(message, ...optionalParams)\n    this.logs.push(`INFO: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`)\n  }\n  verbose(message: string, ...optionalParams: unknown[]): void {\n    this.originalLogger?.verbose(message, ...optionalParams)\n    this.logs.push(`VERBOSE: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`)\n  }\n  debug(message: string, ...optionalParams: unknown[]): void {\n    this.originalLogger?.debug(message, ...optionalParams)\n    this.logs.push(`DEBUG: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`)\n  }\n}\n"],"names":[],"mappings":";;AAGA;;AAEG;MACU,UAAU,CAAA;AAIrB;;;AAGG;AACH,IAAA,WAAA,CAAY,cAAuB,EAAA;AACjC,QAAA,IAAI,CAAC,cAAc,GAAG,cAAc;AACpC,QAAA,IAAI,CAAC,IAAI,GAAG,EAAE;;;AAIhB,IAAA,IAAI,YAAY,GAAA;QACd,OAAO,IAAI,CAAC,IAAI;;;IAIlB,KAAK,GAAA;AACH,QAAA,IAAI,CAAC,IAAI,GAAG,EAAE;;AAGhB;;;;;;;;;;;;;;;AAeG;AACH,IAAA,cAAc,CAAC,MAA0B,EAAA;AACvC,QAAA,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE;QACrE,IAAI,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;QAC3C,cAAc,EAAE,OAAO,CACrB,CAAC,GAAG,EAAE,EAAE,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,GAAG,KAAK,QAAQ,GAAG,GAAG,GAAG,GAAG,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAE,CAAA,CAAC,CAAC,CAC1H;QACD,QAAQ,EAAE,OAAO,CACf,CAAC,MAAM,EAAE,EAAE,MACR,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAC1B,IAAI,MAAM,CAAC,OAAO,MAAM,KAAK,QAAQ,GAAG,MAAM,GAAG,MAAM,IAAI,MAAM,GAAG,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,EACxG,CAAW,QAAA,EAAA,EAAE,GAAG,CAAC,CAAE,CAAA,CACpB,CAAC,CACL;AACD,QAAA,IAAI,EAAE,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,CAAA,GAAA,EAAM,GAAG,CAAC,QAAQ,EAAE,CAAA,aAAA,CAAe,EAAE,GAAG,CAAC,EAAE,CAAA,IAAA,EAAO,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;AAChI,QAAA,OAAO,QAAQ;;AAGjB,IAAA,KAAK,CAAC,OAAe,EAAE,GAAG,cAAyB,EAAA;QACjD,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC;AACtD,QAAA,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,OAAA,EAAU,OAAO,CAAA,EAAG,cAAc,CAAC,MAAM,GAAG,CAAM,GAAA,EAAA,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAA,CAAE,GAAG,EAAE,CAAE,CAAA,CAAC;;AAE3G,IAAA,IAAI,CAAC,OAAe,EAAE,GAAG,cAAyB,EAAA;QAChD,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC;AACrD,QAAA,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,MAAA,EAAS,OAAO,CAAA,EAAG,cAAc,CAAC,MAAM,GAAG,CAAM,GAAA,EAAA,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAA,CAAE,GAAG,EAAE,CAAE,CAAA,CAAC;;AAE1G,IAAA,IAAI,CAAC,OAAe,EAAE,GAAG,cAAyB,EAAA;QAChD,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC;AACrD,QAAA,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,MAAA,EAAS,OAAO,CAAA,EAAG,cAAc,CAAC,MAAM,GAAG,CAAM,GAAA,EAAA,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAA,CAAE,GAAG,EAAE,CAAE,CAAA,CAAC;;AAE1G,IAAA,OAAO,CAAC,OAAe,EAAE,GAAG,cAAyB,EAAA;QACnD,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC;AACxD,QAAA,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,SAAA,EAAY,OAAO,CAAA,EAAG,cAAc,CAAC,MAAM,GAAG,CAAM,GAAA,EAAA,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAA,CAAE,GAAG,EAAE,CAAE,CAAA,CAAC;;AAE7G,IAAA,KAAK,CAAC,OAAe,EAAE,GAAG,cAAyB,EAAA;QACjD,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC;AACtD,QAAA,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,OAAA,EAAU,OAAO,CAAA,EAAG,cAAc,CAAC,MAAM,GAAG,CAAM,GAAA,EAAA,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAA,CAAE,GAAG,EAAE,CAAE,CAAA,CAAC;;AAE5G;;;;"}
+{"version":3,"file":"test-logger.js","sources":["../../src/testing/test-logger.ts"],"sourcesContent":["import { Logger } from '../types/logging'\nimport { LogSnapshotConfig } from '../types/testing'\nimport { asJson } from '../util'\n\n/** Exposes an AlgoKit logger which captures log messages, while wrapping an original logger.\n * This is useful for automated testing.\n */\nexport class TestLogger implements Logger {\n  private originalLogger: Logger | undefined\n  private logs: string[]\n\n  /**\n   * Create a new test logger that wraps the given logger if provided.\n   * @param originalLogger The optional original logger to wrap.\n   */\n  constructor(originalLogger?: Logger) {\n    this.originalLogger = originalLogger\n    this.logs = []\n  }\n\n  /** Returns all logs captured thus far. */\n  get capturedLogs(): string[] {\n    return this.logs\n  }\n\n  /** Clears all logs captured so far. */\n  clear() {\n    this.logs = []\n  }\n\n  /**\n   * Returns a captured log snapshot.\n   * This helps ensure that the provided configuration items won't appear\n   *  with random values in the log snapshot, but rather will get substituted with predictable ids.\n   *\n   * https://jestjs.io/docs/snapshot-testing#2-tests-should-be-deterministic\n   *\n   * @example Jest Example\n   * ```typescript\n   * const logger = new TestLogger()\n   * ...\n   * expect(logger.getLogSnapshot()).toMatchSnapshot()\n   * ```\n   * @param config The snapshot configuration\n   * @returns The snapshotted logs.\n   */\n  getLogSnapshot(config?: LogSnapshotConfig) {\n    const { transactions: transactionIds, accounts, apps } = config ?? {}\n    let snapshot = this.capturedLogs.join('\\n')\n    transactionIds?.forEach(\n      (txn, id) => (snapshot = snapshot.replace(new RegExp(typeof txn === 'string' ? txn : txn.txID(), 'g'), `TXID_${id + 1}`)),\n    )\n    accounts?.forEach(\n      (sender, id) =>\n        (snapshot = snapshot.replace(\n          new RegExp(typeof sender === 'string' ? sender : 'addr' in sender ? sender.addr : sender.address(), 'g'),\n          `ACCOUNT_${id + 1}`,\n        )),\n    )\n    apps?.forEach((app, id) => (snapshot = snapshot.replace(new RegExp(`\\\\b${app.toString()}\\\\b(?! bytes)`, 'g'), `APP_${id + 1}`)))\n    return snapshot\n  }\n\n  error(message: string, ...optionalParams: unknown[]): void {\n    this.originalLogger?.error(message, ...optionalParams)\n    this.logs.push(`ERROR: ${message}${optionalParams.length ? ` | ${asJson(optionalParams)}` : ''}`)\n  }\n  warn(message: string, ...optionalParams: unknown[]): void {\n    this.originalLogger?.warn(message, ...optionalParams)\n    this.logs.push(`WARN: ${message}${optionalParams.length ? ` | ${asJson(optionalParams)}` : ''}`)\n  }\n  info(message: string, ...optionalParams: unknown[]): void {\n    this.originalLogger?.info(message, ...optionalParams)\n    this.logs.push(`INFO: ${message}${optionalParams.length ? ` | ${asJson(optionalParams)}` : ''}`)\n  }\n  verbose(message: string, ...optionalParams: unknown[]): void {\n    this.originalLogger?.verbose(message, ...optionalParams)\n    this.logs.push(`VERBOSE: ${message}${optionalParams.length ? ` | ${asJson(optionalParams)}` : ''}`)\n  }\n  debug(message: string, ...optionalParams: unknown[]): void {\n    this.originalLogger?.debug(message, ...optionalParams)\n    this.logs.push(`DEBUG: ${message}${optionalParams.length ? ` | ${asJson(optionalParams)}` : ''}`)\n  }\n}\n"],"names":["asJson"],"mappings":";;;;AAIA;;AAEG;MACU,UAAU,CAAA;AAIrB;;;AAGG;AACH,IAAA,WAAA,CAAY,cAAuB,EAAA;AACjC,QAAA,IAAI,CAAC,cAAc,GAAG,cAAc;AACpC,QAAA,IAAI,CAAC,IAAI,GAAG,EAAE;;;AAIhB,IAAA,IAAI,YAAY,GAAA;QACd,OAAO,IAAI,CAAC,IAAI;;;IAIlB,KAAK,GAAA;AACH,QAAA,IAAI,CAAC,IAAI,GAAG,EAAE;;AAGhB;;;;;;;;;;;;;;;AAeG;AACH,IAAA,cAAc,CAAC,MAA0B,EAAA;AACvC,QAAA,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE;QACrE,IAAI,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;QAC3C,cAAc,EAAE,OAAO,CACrB,CAAC,GAAG,EAAE,EAAE,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,GAAG,KAAK,QAAQ,GAAG,GAAG,GAAG,GAAG,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAE,CAAA,CAAC,CAAC,CAC1H;QACD,QAAQ,EAAE,OAAO,CACf,CAAC,MAAM,EAAE,EAAE,MACR,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAC1B,IAAI,MAAM,CAAC,OAAO,MAAM,KAAK,QAAQ,GAAG,MAAM,GAAG,MAAM,IAAI,MAAM,GAAG,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,EACxG,CAAW,QAAA,EAAA,EAAE,GAAG,CAAC,CAAE,CAAA,CACpB,CAAC,CACL;AACD,QAAA,IAAI,EAAE,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,CAAA,GAAA,EAAM,GAAG,CAAC,QAAQ,EAAE,CAAA,aAAA,CAAe,EAAE,GAAG,CAAC,EAAE,CAAA,IAAA,EAAO,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;AAChI,QAAA,OAAO,QAAQ;;AAGjB,IAAA,KAAK,CAAC,OAAe,EAAE,GAAG,cAAyB,EAAA;QACjD,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC;QACtD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAU,OAAA,EAAA,OAAO,CAAG,EAAA,cAAc,CAAC,MAAM,GAAG,CAAM,GAAA,EAAAA,WAAM,CAAC,cAAc,CAAC,CAAA,CAAE,GAAG,EAAE,CAAE,CAAA,CAAC;;AAEnG,IAAA,IAAI,CAAC,OAAe,EAAE,GAAG,cAAyB,EAAA;QAChD,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC;QACrD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAS,MAAA,EAAA,OAAO,CAAG,EAAA,cAAc,CAAC,MAAM,GAAG,CAAM,GAAA,EAAAA,WAAM,CAAC,cAAc,CAAC,CAAA,CAAE,GAAG,EAAE,CAAE,CAAA,CAAC;;AAElG,IAAA,IAAI,CAAC,OAAe,EAAE,GAAG,cAAyB,EAAA;QAChD,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC;QACrD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAS,MAAA,EAAA,OAAO,CAAG,EAAA,cAAc,CAAC,MAAM,GAAG,CAAM,GAAA,EAAAA,WAAM,CAAC,cAAc,CAAC,CAAA,CAAE,GAAG,EAAE,CAAE,CAAA,CAAC;;AAElG,IAAA,OAAO,CAAC,OAAe,EAAE,GAAG,cAAyB,EAAA;QACnD,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC;QACxD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAY,SAAA,EAAA,OAAO,CAAG,EAAA,cAAc,CAAC,MAAM,GAAG,CAAM,GAAA,EAAAA,WAAM,CAAC,cAAc,CAAC,CAAA,CAAE,GAAG,EAAE,CAAE,CAAA,CAAC;;AAErG,IAAA,KAAK,CAAC,OAAe,EAAE,GAAG,cAAyB,EAAA;QACjD,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC;QACtD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAU,OAAA,EAAA,OAAO,CAAG,EAAA,cAAc,CAAC,MAAM,GAAG,CAAM,GAAA,EAAAA,WAAM,CAAC,cAAc,CAAC,CAAA,CAAE,GAAG,EAAE,CAAE,CAAA,CAAC;;AAEpG;;;;"}

package/testing/test-logger.mjs

@@ -1,3 +1,5 @@
+import { asJson } from '../util.mjs';
+
 /** Exposes an AlgoKit logger which captures log messages, while wrapping an original logger.
  * This is useful for automated testing.
  */
@@ -44,23 +46,23 @@ class TestLogger {
     }
     error(message, ...optionalParams) {
         this.originalLogger?.error(message, ...optionalParams);
-        this.logs.push(`ERROR: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`);
+        this.logs.push(`ERROR: ${message}${optionalParams.length ? ` | ${asJson(optionalParams)}` : ''}`);
     }
     warn(message, ...optionalParams) {
         this.originalLogger?.warn(message, ...optionalParams);
-        this.logs.push(`WARN: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`);
+        this.logs.push(`WARN: ${message}${optionalParams.length ? ` | ${asJson(optionalParams)}` : ''}`);
     }
     info(message, ...optionalParams) {
         this.originalLogger?.info(message, ...optionalParams);
-        this.logs.push(`INFO: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`);
+        this.logs.push(`INFO: ${message}${optionalParams.length ? ` | ${asJson(optionalParams)}` : ''}`);
     }
     verbose(message, ...optionalParams) {
         this.originalLogger?.verbose(message, ...optionalParams);
-        this.logs.push(`VERBOSE: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`);
+        this.logs.push(`VERBOSE: ${message}${optionalParams.length ? ` | ${asJson(optionalParams)}` : ''}`);
     }
     debug(message, ...optionalParams) {
         this.originalLogger?.debug(message, ...optionalParams);
-        this.logs.push(`DEBUG: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`);
+        this.logs.push(`DEBUG: ${message}${optionalParams.length ? ` | ${asJson(optionalParams)}` : ''}`);
     }
 }
 

package/testing/test-logger.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"test-logger.mjs","sources":["../../src/testing/test-logger.ts"],"sourcesContent":["import { Logger } from '../types/logging'\nimport { LogSnapshotConfig } from '../types/testing'\n\n/** Exposes an AlgoKit logger which captures log messages, while wrapping an original logger.\n * This is useful for automated testing.\n */\nexport class TestLogger implements Logger {\n  private originalLogger: Logger | undefined\n  private logs: string[]\n\n  /**\n   * Create a new test logger that wraps the given logger if provided.\n   * @param originalLogger The optional original logger to wrap.\n   */\n  constructor(originalLogger?: Logger) {\n    this.originalLogger = originalLogger\n    this.logs = []\n  }\n\n  /** Returns all logs captured thus far. */\n  get capturedLogs(): string[] {\n    return this.logs\n  }\n\n  /** Clears all logs captured so far. */\n  clear() {\n    this.logs = []\n  }\n\n  /**\n   * Returns a captured log snapshot.\n   * This helps ensure that the provided configuration items won't appear\n   *  with random values in the log snapshot, but rather will get substituted with predictable ids.\n   *\n   * https://jestjs.io/docs/snapshot-testing#2-tests-should-be-deterministic\n   *\n   * @example Jest Example\n   * ```typescript\n   * const logger = new TestLogger()\n   * ...\n   * expect(logger.getLogSnapshot()).toMatchSnapshot()\n   * ```\n   * @param config The snapshot configuration\n   * @returns The snapshotted logs.\n   */\n  getLogSnapshot(config?: LogSnapshotConfig) {\n    const { transactions: transactionIds, accounts, apps } = config ?? {}\n    let snapshot = this.capturedLogs.join('\\n')\n    transactionIds?.forEach(\n      (txn, id) => (snapshot = snapshot.replace(new RegExp(typeof txn === 'string' ? txn : txn.txID(), 'g'), `TXID_${id + 1}`)),\n    )\n    accounts?.forEach(\n      (sender, id) =>\n        (snapshot = snapshot.replace(\n          new RegExp(typeof sender === 'string' ? sender : 'addr' in sender ? sender.addr : sender.address(), 'g'),\n          `ACCOUNT_${id + 1}`,\n        )),\n    )\n    apps?.forEach((app, id) => (snapshot = snapshot.replace(new RegExp(`\\\\b${app.toString()}\\\\b(?! bytes)`, 'g'), `APP_${id + 1}`)))\n    return snapshot\n  }\n\n  error(message: string, ...optionalParams: unknown[]): void {\n    this.originalLogger?.error(message, ...optionalParams)\n    this.logs.push(`ERROR: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`)\n  }\n  warn(message: string, ...optionalParams: unknown[]): void {\n    this.originalLogger?.warn(message, ...optionalParams)\n    this.logs.push(`WARN: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`)\n  }\n  info(message: string, ...optionalParams: unknown[]): void {\n    this.originalLogger?.info(message, ...optionalParams)\n    this.logs.push(`INFO: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`)\n  }\n  verbose(message: string, ...optionalParams: unknown[]): void {\n    this.originalLogger?.verbose(message, ...optionalParams)\n    this.logs.push(`VERBOSE: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`)\n  }\n  debug(message: string, ...optionalParams: unknown[]): void {\n    this.originalLogger?.debug(message, ...optionalParams)\n    this.logs.push(`DEBUG: ${message}${optionalParams.length ? ` | ${JSON.stringify(optionalParams)}` : ''}`)\n  }\n}\n"],"names":[],"mappings":"AAGA;;AAEG;MACU,UAAU,CAAA;AAIrB;;;AAGG;AACH,IAAA,WAAA,CAAY,cAAuB,EAAA;AACjC,QAAA,IAAI,CAAC,cAAc,GAAG,cAAc;AACpC,QAAA,IAAI,CAAC,IAAI,GAAG,EAAE;;;AAIhB,IAAA,IAAI,YAAY,GAAA;QACd,OAAO,IAAI,CAAC,IAAI;;;IAIlB,KAAK,GAAA;AACH,QAAA,IAAI,CAAC,IAAI,GAAG,EAAE;;AAGhB;;;;;;;;;;;;;;;AAeG;AACH,IAAA,cAAc,CAAC,MAA0B,EAAA;AACvC,QAAA,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE;QACrE,IAAI,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;QAC3C,cAAc,EAAE,OAAO,CACrB,CAAC,GAAG,EAAE,EAAE,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,GAAG,KAAK,QAAQ,GAAG,GAAG,GAAG,GAAG,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAE,CAAA,CAAC,CAAC,CAC1H;QACD,QAAQ,EAAE,OAAO,CACf,CAAC,MAAM,EAAE,EAAE,MACR,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAC1B,IAAI,MAAM,CAAC,OAAO,MAAM,KAAK,QAAQ,GAAG,MAAM,GAAG,MAAM,IAAI,MAAM,GAAG,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,EACxG,CAAW,QAAA,EAAA,EAAE,GAAG,CAAC,CAAE,CAAA,CACpB,CAAC,CACL;AACD,QAAA,IAAI,EAAE,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,CAAA,GAAA,EAAM,GAAG,CAAC,QAAQ,EAAE,CAAA,aAAA,CAAe,EAAE,GAAG,CAAC,EAAE,CAAA,IAAA,EAAO,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;AAChI,QAAA,OAAO,QAAQ;;AAGjB,IAAA,KAAK,CAAC,OAAe,EAAE,GAAG,cAAyB,EAAA;QACjD,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC;AACtD,QAAA,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,OAAA,EAAU,OAAO,CAAA,EAAG,cAAc,CAAC,MAAM,GAAG,CAAM,GAAA,EAAA,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAA,CAAE,GAAG,EAAE,CAAE,CAAA,CAAC;;AAE3G,IAAA,IAAI,CAAC,OAAe,EAAE,GAAG,cAAyB,EAAA;QAChD,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC;AACrD,QAAA,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,MAAA,EAAS,OAAO,CAAA,EAAG,cAAc,CAAC,MAAM,GAAG,CAAM,GAAA,EAAA,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAA,CAAE,GAAG,EAAE,CAAE,CAAA,CAAC;;AAE1G,IAAA,IAAI,CAAC,OAAe,EAAE,GAAG,cAAyB,EAAA;QAChD,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC;AACrD,QAAA,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,MAAA,EAAS,OAAO,CAAA,EAAG,cAAc,CAAC,MAAM,GAAG,CAAM,GAAA,EAAA,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAA,CAAE,GAAG,EAAE,CAAE,CAAA,CAAC;;AAE1G,IAAA,OAAO,CAAC,OAAe,EAAE,GAAG,cAAyB,EAAA;QACnD,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC;AACxD,QAAA,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,SAAA,EAAY,OAAO,CAAA,EAAG,cAAc,CAAC,MAAM,GAAG,CAAM,GAAA,EAAA,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAA,CAAE,GAAG,EAAE,CAAE,CAAA,CAAC;;AAE7G,IAAA,KAAK,CAAC,OAAe,EAAE,GAAG,cAAyB,EAAA;QACjD,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC;AACtD,QAAA,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,OAAA,EAAU,OAAO,CAAA,EAAG,cAAc,CAAC,MAAM,GAAG,CAAM,GAAA,EAAA,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAA,CAAE,GAAG,EAAE,CAAE,CAAA,CAAC;;AAE5G;;;;"}
+{"version":3,"file":"test-logger.mjs","sources":["../../src/testing/test-logger.ts"],"sourcesContent":["import { Logger } from '../types/logging'\nimport { LogSnapshotConfig } from '../types/testing'\nimport { asJson } from '../util'\n\n/** Exposes an AlgoKit logger which captures log messages, while wrapping an original logger.\n * This is useful for automated testing.\n */\nexport class TestLogger implements Logger {\n  private originalLogger: Logger | undefined\n  private logs: string[]\n\n  /**\n   * Create a new test logger that wraps the given logger if provided.\n   * @param originalLogger The optional original logger to wrap.\n   */\n  constructor(originalLogger?: Logger) {\n    this.originalLogger = originalLogger\n    this.logs = []\n  }\n\n  /** Returns all logs captured thus far. */\n  get capturedLogs(): string[] {\n    return this.logs\n  }\n\n  /** Clears all logs captured so far. */\n  clear() {\n    this.logs = []\n  }\n\n  /**\n   * Returns a captured log snapshot.\n   * This helps ensure that the provided configuration items won't appear\n   *  with random values in the log snapshot, but rather will get substituted with predictable ids.\n   *\n   * https://jestjs.io/docs/snapshot-testing#2-tests-should-be-deterministic\n   *\n   * @example Jest Example\n   * ```typescript\n   * const logger = new TestLogger()\n   * ...\n   * expect(logger.getLogSnapshot()).toMatchSnapshot()\n   * ```\n   * @param config The snapshot configuration\n   * @returns The snapshotted logs.\n   */\n  getLogSnapshot(config?: LogSnapshotConfig) {\n    const { transactions: transactionIds, accounts, apps } = config ?? {}\n    let snapshot = this.capturedLogs.join('\\n')\n    transactionIds?.forEach(\n      (txn, id) => (snapshot = snapshot.replace(new RegExp(typeof txn === 'string' ? txn : txn.txID(), 'g'), `TXID_${id + 1}`)),\n    )\n    accounts?.forEach(\n      (sender, id) =>\n        (snapshot = snapshot.replace(\n          new RegExp(typeof sender === 'string' ? sender : 'addr' in sender ? sender.addr : sender.address(), 'g'),\n          `ACCOUNT_${id + 1}`,\n        )),\n    )\n    apps?.forEach((app, id) => (snapshot = snapshot.replace(new RegExp(`\\\\b${app.toString()}\\\\b(?! bytes)`, 'g'), `APP_${id + 1}`)))\n    return snapshot\n  }\n\n  error(message: string, ...optionalParams: unknown[]): void {\n    this.originalLogger?.error(message, ...optionalParams)\n    this.logs.push(`ERROR: ${message}${optionalParams.length ? ` | ${asJson(optionalParams)}` : ''}`)\n  }\n  warn(message: string, ...optionalParams: unknown[]): void {\n    this.originalLogger?.warn(message, ...optionalParams)\n    this.logs.push(`WARN: ${message}${optionalParams.length ? ` | ${asJson(optionalParams)}` : ''}`)\n  }\n  info(message: string, ...optionalParams: unknown[]): void {\n    this.originalLogger?.info(message, ...optionalParams)\n    this.logs.push(`INFO: ${message}${optionalParams.length ? ` | ${asJson(optionalParams)}` : ''}`)\n  }\n  verbose(message: string, ...optionalParams: unknown[]): void {\n    this.originalLogger?.verbose(message, ...optionalParams)\n    this.logs.push(`VERBOSE: ${message}${optionalParams.length ? ` | ${asJson(optionalParams)}` : ''}`)\n  }\n  debug(message: string, ...optionalParams: unknown[]): void {\n    this.originalLogger?.debug(message, ...optionalParams)\n    this.logs.push(`DEBUG: ${message}${optionalParams.length ? ` | ${asJson(optionalParams)}` : ''}`)\n  }\n}\n"],"names":[],"mappings":";;AAIA;;AAEG;MACU,UAAU,CAAA;AAIrB;;;AAGG;AACH,IAAA,WAAA,CAAY,cAAuB,EAAA;AACjC,QAAA,IAAI,CAAC,cAAc,GAAG,cAAc;AACpC,QAAA,IAAI,CAAC,IAAI,GAAG,EAAE;;;AAIhB,IAAA,IAAI,YAAY,GAAA;QACd,OAAO,IAAI,CAAC,IAAI;;;IAIlB,KAAK,GAAA;AACH,QAAA,IAAI,CAAC,IAAI,GAAG,EAAE;;AAGhB;;;;;;;;;;;;;;;AAeG;AACH,IAAA,cAAc,CAAC,MAA0B,EAAA;AACvC,QAAA,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,EAAE;QACrE,IAAI,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;QAC3C,cAAc,EAAE,OAAO,CACrB,CAAC,GAAG,EAAE,EAAE,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,GAAG,KAAK,QAAQ,GAAG,GAAG,GAAG,GAAG,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAE,CAAA,CAAC,CAAC,CAC1H;QACD,QAAQ,EAAE,OAAO,CACf,CAAC,MAAM,EAAE,EAAE,MACR,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAC1B,IAAI,MAAM,CAAC,OAAO,MAAM,KAAK,QAAQ,GAAG,MAAM,GAAG,MAAM,IAAI,MAAM,GAAG,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,EACxG,CAAW,QAAA,EAAA,EAAE,GAAG,CAAC,CAAE,CAAA,CACpB,CAAC,CACL;AACD,QAAA,IAAI,EAAE,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,CAAA,GAAA,EAAM,GAAG,CAAC,QAAQ,EAAE,CAAA,aAAA,CAAe,EAAE,GAAG,CAAC,EAAE,CAAA,IAAA,EAAO,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;AAChI,QAAA,OAAO,QAAQ;;AAGjB,IAAA,KAAK,CAAC,OAAe,EAAE,GAAG,cAAyB,EAAA;QACjD,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC;QACtD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAU,OAAA,EAAA,OAAO,CAAG,EAAA,cAAc,CAAC,MAAM,GAAG,CAAM,GAAA,EAAA,MAAM,CAAC,cAAc,CAAC,CAAA,CAAE,GAAG,EAAE,CAAE,CAAA,CAAC;;AAEnG,IAAA,IAAI,CAAC,OAAe,EAAE,GAAG,cAAyB,EAAA;QAChD,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC;QACrD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAS,MAAA,EAAA,OAAO,CAAG,EAAA,cAAc,CAAC,MAAM,GAAG,CAAM,GAAA,EAAA,MAAM,CAAC,cAAc,CAAC,CAAA,CAAE,GAAG,EAAE,CAAE,CAAA,CAAC;;AAElG,IAAA,IAAI,CAAC,OAAe,EAAE,GAAG,cAAyB,EAAA;QAChD,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC;QACrD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAS,MAAA,EAAA,OAAO,CAAG,EAAA,cAAc,CAAC,MAAM,GAAG,CAAM,GAAA,EAAA,MAAM,CAAC,cAAc,CAAC,CAAA,CAAE,GAAG,EAAE,CAAE,CAAA,CAAC;;AAElG,IAAA,OAAO,CAAC,OAAe,EAAE,GAAG,cAAyB,EAAA;QACnD,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC;QACxD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAY,SAAA,EAAA,OAAO,CAAG,EAAA,cAAc,CAAC,MAAM,GAAG,CAAM,GAAA,EAAA,MAAM,CAAC,cAAc,CAAC,CAAA,CAAE,GAAG,EAAE,CAAE,CAAA,CAAC;;AAErG,IAAA,KAAK,CAAC,OAAe,EAAE,GAAG,cAAyB,EAAA;QACjD,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC;QACtD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAU,OAAA,EAAA,OAAO,CAAG,EAAA,cAAc,CAAC,MAAM,GAAG,CAAM,GAAA,EAAA,MAAM,CAAC,cAAc,CAAC,CAAA,CAAE,GAAG,EAAE,CAAE,CAAA,CAAC;;AAEpG;;;;"}

package/testing/transaction-logger.js

@@ -49,7 +49,10 @@ class TransactionLogger {
     }
     /** Wait until all logged transactions IDs appear in the given `Indexer`. */
     async waitForIndexer(indexer$1) {
-        await Promise.all(this._sentTransactionIds.map((txnId) => indexer.runWhenIndexerCaughtUp(() => indexer$1.lookupTransactionByID(txnId).do())));
+        if (this._sentTransactionIds.length === 0)
+            return;
+        const lastTxId = this._sentTransactionIds[this._sentTransactionIds.length - 1];
+        await indexer.runWhenIndexerCaughtUp(() => indexer$1.lookupTransactionByID(lastTxId).do());
     }
 }
 class TransactionLoggingAlgodv2ProxyHandler {

package/testing/transaction-logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"transaction-logger.js","sources":["../../src/testing/transaction-logger.ts"],"sourcesContent":["import algosdk from 'algosdk'\nimport { runWhenIndexerCaughtUp } from './indexer'\nimport Algodv2 = algosdk.Algodv2\nimport decodeSignedTransaction = algosdk.decodeSignedTransaction\nimport Indexer = algosdk.Indexer\n\n/**\n * Allows you to keep track of Algorand transaction IDs by wrapping an `Algodv2` in a proxy.\n * Useful for automated tests.\n */\nexport class TransactionLogger {\n  private _sentTransactionIds: string[] = []\n\n  /**\n   * The list of transaction IDs that has been logged thus far.\n   */\n  get sentTransactionIds(): Readonly<string[]> {\n    return this._sentTransactionIds\n  }\n\n  /**\n   * Clear all logged IDs.\n   */\n  clear() {\n    this._sentTransactionIds = []\n  }\n\n  /**\n   * The method that captures raw transactions and stores the transaction IDs.\n   */\n  logRawTransaction(signedTransactions: Uint8Array | Uint8Array[]) {\n    if (Array.isArray(signedTransactions)) {\n      for (const stxn of signedTransactions) {\n        const decoded = decodeSignedTransaction(stxn)\n        this._sentTransactionIds.push(decoded.txn.txID())\n      }\n    } else {\n      const decoded = decodeSignedTransaction(signedTransactions)\n      this._sentTransactionIds.push(decoded.txn.txID())\n    }\n  }\n\n  /** Return a proxy that wraps the given Algodv2 with this transaction logger.\n   *\n   * @param algod The `Algodv2` to wrap\n   * @returns The wrapped `Algodv2`, any transactions sent using this algod instance will be logged by this transaction logger\n   */\n  capture(algod: Algodv2): Algodv2 {\n    return new Proxy<Algodv2>(algod, new TransactionLoggingAlgodv2ProxyHandler(this))\n  }\n\n  /** Wait until all logged transactions IDs appear in the given `Indexer`. */\n  async waitForIndexer(indexer: Indexer) {\n    await Promise.all(this._sentTransactionIds.map((txnId) => runWhenIndexerCaughtUp(() => indexer.lookupTransactionByID(txnId).do())))\n  }\n}\n\nclass TransactionLoggingAlgodv2ProxyHandler implements ProxyHandler<Algodv2> {\n  private transactionLogger: TransactionLogger\n\n  constructor(transactionLogger: TransactionLogger) {\n    this.transactionLogger = transactionLogger\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  get(target: Algodv2, property: string | symbol, receiver: any) {\n    if (property === 'sendRawTransaction') {\n      return (stxOrStxs: Uint8Array | Uint8Array[]) => {\n        this.transactionLogger.logRawTransaction(stxOrStxs)\n        return target[property].call(receiver, stxOrStxs)\n      }\n    }\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    return (target as any)[property]\n  }\n}\n"],"names":["indexer","runWhenIndexerCaughtUp"],"mappings":";;;;;AAGA,IAAO,uBAAuB,GAAG,OAAO,CAAC,uBAAuB;AAGhE;;;AAGG;MACU,iBAAiB,CAAA;AAA9B,IAAA,WAAA,GAAA;QACU,IAAmB,CAAA,mBAAA,GAAa,EAAE;;AAE1C;;AAEG;AACH,IAAA,IAAI,kBAAkB,GAAA;QACpB,OAAO,IAAI,CAAC,mBAAmB;;AAGjC;;AAEG;IACH,KAAK,GAAA;AACH,QAAA,IAAI,CAAC,mBAAmB,GAAG,EAAE;;AAG/B;;AAEG;AACH,IAAA,iBAAiB,CAAC,kBAA6C,EAAA;AAC7D,QAAA,IAAI,KAAK,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE;AACrC,YAAA,KAAK,MAAM,IAAI,IAAI,kBAAkB,EAAE;AACrC,gBAAA,MAAM,OAAO,GAAG,uBAAuB,CAAC,IAAI,CAAC;AAC7C,gBAAA,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;;;aAE9C;AACL,YAAA,MAAM,OAAO,GAAG,uBAAuB,CAAC,kBAAkB,CAAC;AAC3D,YAAA,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;;;AAIrD;;;;AAIG;AACH,IAAA,OAAO,CAAC,KAAc,EAAA;QACpB,OAAO,IAAI,KAAK,CAAU,KAAK,EAAE,IAAI,qCAAqC,CAAC,IAAI,CAAC,CAAC;;;IAInF,MAAM,cAAc,CAACA,SAAgB,EAAA;AACnC,QAAA,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,KAAK,KAAKC,8BAAsB,CAAC,MAAMD,SAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;;AAEtI;AAED,MAAM,qCAAqC,CAAA;AAGzC,IAAA,WAAA,CAAY,iBAAoC,EAAA;AAC9C,QAAA,IAAI,CAAC,iBAAiB,GAAG,iBAAiB;;;AAI5C,IAAA,GAAG,CAAC,MAAe,EAAE,QAAyB,EAAE,QAAa,EAAA;AAC3D,QAAA,IAAI,QAAQ,KAAK,oBAAoB,EAAE;YACrC,OAAO,CAAC,SAAoC,KAAI;AAC9C,gBAAA,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,SAAS,CAAC;gBACnD,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC;AACnD,aAAC;;;AAGH,QAAA,OAAQ,MAAc,CAAC,QAAQ,CAAC;;AAEnC;;;;"}
+{"version":3,"file":"transaction-logger.js","sources":["../../src/testing/transaction-logger.ts"],"sourcesContent":["import algosdk from 'algosdk'\nimport { runWhenIndexerCaughtUp } from './indexer'\nimport Algodv2 = algosdk.Algodv2\nimport decodeSignedTransaction = algosdk.decodeSignedTransaction\nimport Indexer = algosdk.Indexer\n\n/**\n * Allows you to keep track of Algorand transaction IDs by wrapping an `Algodv2` in a proxy.\n * Useful for automated tests.\n */\nexport class TransactionLogger {\n  private _sentTransactionIds: string[] = []\n\n  /**\n   * The list of transaction IDs that has been logged thus far.\n   */\n  get sentTransactionIds(): Readonly<string[]> {\n    return this._sentTransactionIds\n  }\n\n  /**\n   * Clear all logged IDs.\n   */\n  clear() {\n    this._sentTransactionIds = []\n  }\n\n  /**\n   * The method that captures raw transactions and stores the transaction IDs.\n   */\n  logRawTransaction(signedTransactions: Uint8Array | Uint8Array[]) {\n    if (Array.isArray(signedTransactions)) {\n      for (const stxn of signedTransactions) {\n        const decoded = decodeSignedTransaction(stxn)\n        this._sentTransactionIds.push(decoded.txn.txID())\n      }\n    } else {\n      const decoded = decodeSignedTransaction(signedTransactions)\n      this._sentTransactionIds.push(decoded.txn.txID())\n    }\n  }\n\n  /** Return a proxy that wraps the given Algodv2 with this transaction logger.\n   *\n   * @param algod The `Algodv2` to wrap\n   * @returns The wrapped `Algodv2`, any transactions sent using this algod instance will be logged by this transaction logger\n   */\n  capture(algod: Algodv2): Algodv2 {\n    return new Proxy<Algodv2>(algod, new TransactionLoggingAlgodv2ProxyHandler(this))\n  }\n\n  /** Wait until all logged transactions IDs appear in the given `Indexer`. */\n  async waitForIndexer(indexer: Indexer) {\n    if (this._sentTransactionIds.length === 0) return\n    const lastTxId = this._sentTransactionIds[this._sentTransactionIds.length - 1]\n    await runWhenIndexerCaughtUp(() => indexer.lookupTransactionByID(lastTxId).do())\n  }\n}\n\nclass TransactionLoggingAlgodv2ProxyHandler implements ProxyHandler<Algodv2> {\n  private transactionLogger: TransactionLogger\n\n  constructor(transactionLogger: TransactionLogger) {\n    this.transactionLogger = transactionLogger\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  get(target: Algodv2, property: string | symbol, receiver: any) {\n    if (property === 'sendRawTransaction') {\n      return (stxOrStxs: Uint8Array | Uint8Array[]) => {\n        this.transactionLogger.logRawTransaction(stxOrStxs)\n        return target[property].call(receiver, stxOrStxs)\n      }\n    }\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    return (target as any)[property]\n  }\n}\n"],"names":["indexer","runWhenIndexerCaughtUp"],"mappings":";;;;;AAGA,IAAO,uBAAuB,GAAG,OAAO,CAAC,uBAAuB;AAGhE;;;AAGG;MACU,iBAAiB,CAAA;AAA9B,IAAA,WAAA,GAAA;QACU,IAAmB,CAAA,mBAAA,GAAa,EAAE;;AAE1C;;AAEG;AACH,IAAA,IAAI,kBAAkB,GAAA;QACpB,OAAO,IAAI,CAAC,mBAAmB;;AAGjC;;AAEG;IACH,KAAK,GAAA;AACH,QAAA,IAAI,CAAC,mBAAmB,GAAG,EAAE;;AAG/B;;AAEG;AACH,IAAA,iBAAiB,CAAC,kBAA6C,EAAA;AAC7D,QAAA,IAAI,KAAK,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE;AACrC,YAAA,KAAK,MAAM,IAAI,IAAI,kBAAkB,EAAE;AACrC,gBAAA,MAAM,OAAO,GAAG,uBAAuB,CAAC,IAAI,CAAC;AAC7C,gBAAA,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;;;aAE9C;AACL,YAAA,MAAM,OAAO,GAAG,uBAAuB,CAAC,kBAAkB,CAAC;AAC3D,YAAA,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;;;AAIrD;;;;AAIG;AACH,IAAA,OAAO,CAAC,KAAc,EAAA;QACpB,OAAO,IAAI,KAAK,CAAU,KAAK,EAAE,IAAI,qCAAqC,CAAC,IAAI,CAAC,CAAC;;;IAInF,MAAM,cAAc,CAACA,SAAgB,EAAA;AACnC,QAAA,IAAI,IAAI,CAAC,mBAAmB,CAAC,MAAM,KAAK,CAAC;YAAE;AAC3C,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,CAAC;AAC9E,QAAA,MAAMC,8BAAsB,CAAC,MAAMD,SAAO,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC;;AAEnF;AAED,MAAM,qCAAqC,CAAA;AAGzC,IAAA,WAAA,CAAY,iBAAoC,EAAA;AAC9C,QAAA,IAAI,CAAC,iBAAiB,GAAG,iBAAiB;;;AAI5C,IAAA,GAAG,CAAC,MAAe,EAAE,QAAyB,EAAE,QAAa,EAAA;AAC3D,QAAA,IAAI,QAAQ,KAAK,oBAAoB,EAAE;YACrC,OAAO,CAAC,SAAoC,KAAI;AAC9C,gBAAA,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,SAAS,CAAC;gBACnD,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC;AACnD,aAAC;;;AAGH,QAAA,OAAQ,MAAc,CAAC,QAAQ,CAAC;;AAEnC;;;;"}

package/testing/transaction-logger.mjs

@@ -47,7 +47,10 @@ class TransactionLogger {
     }
     /** Wait until all logged transactions IDs appear in the given `Indexer`. */
     async waitForIndexer(indexer) {
-        await Promise.all(this._sentTransactionIds.map((txnId) => runWhenIndexerCaughtUp(() => indexer.lookupTransactionByID(txnId).do())));
+        if (this._sentTransactionIds.length === 0)
+            return;
+        const lastTxId = this._sentTransactionIds[this._sentTransactionIds.length - 1];
+        await runWhenIndexerCaughtUp(() => indexer.lookupTransactionByID(lastTxId).do());
     }
 }
 class TransactionLoggingAlgodv2ProxyHandler {

package/testing/transaction-logger.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"transaction-logger.mjs","sources":["../../src/testing/transaction-logger.ts"],"sourcesContent":["import algosdk from 'algosdk'\nimport { runWhenIndexerCaughtUp } from './indexer'\nimport Algodv2 = algosdk.Algodv2\nimport decodeSignedTransaction = algosdk.decodeSignedTransaction\nimport Indexer = algosdk.Indexer\n\n/**\n * Allows you to keep track of Algorand transaction IDs by wrapping an `Algodv2` in a proxy.\n * Useful for automated tests.\n */\nexport class TransactionLogger {\n  private _sentTransactionIds: string[] = []\n\n  /**\n   * The list of transaction IDs that has been logged thus far.\n   */\n  get sentTransactionIds(): Readonly<string[]> {\n    return this._sentTransactionIds\n  }\n\n  /**\n   * Clear all logged IDs.\n   */\n  clear() {\n    this._sentTransactionIds = []\n  }\n\n  /**\n   * The method that captures raw transactions and stores the transaction IDs.\n   */\n  logRawTransaction(signedTransactions: Uint8Array | Uint8Array[]) {\n    if (Array.isArray(signedTransactions)) {\n      for (const stxn of signedTransactions) {\n        const decoded = decodeSignedTransaction(stxn)\n        this._sentTransactionIds.push(decoded.txn.txID())\n      }\n    } else {\n      const decoded = decodeSignedTransaction(signedTransactions)\n      this._sentTransactionIds.push(decoded.txn.txID())\n    }\n  }\n\n  /** Return a proxy that wraps the given Algodv2 with this transaction logger.\n   *\n   * @param algod The `Algodv2` to wrap\n   * @returns The wrapped `Algodv2`, any transactions sent using this algod instance will be logged by this transaction logger\n   */\n  capture(algod: Algodv2): Algodv2 {\n    return new Proxy<Algodv2>(algod, new TransactionLoggingAlgodv2ProxyHandler(this))\n  }\n\n  /** Wait until all logged transactions IDs appear in the given `Indexer`. */\n  async waitForIndexer(indexer: Indexer) {\n    await Promise.all(this._sentTransactionIds.map((txnId) => runWhenIndexerCaughtUp(() => indexer.lookupTransactionByID(txnId).do())))\n  }\n}\n\nclass TransactionLoggingAlgodv2ProxyHandler implements ProxyHandler<Algodv2> {\n  private transactionLogger: TransactionLogger\n\n  constructor(transactionLogger: TransactionLogger) {\n    this.transactionLogger = transactionLogger\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  get(target: Algodv2, property: string | symbol, receiver: any) {\n    if (property === 'sendRawTransaction') {\n      return (stxOrStxs: Uint8Array | Uint8Array[]) => {\n        this.transactionLogger.logRawTransaction(stxOrStxs)\n        return target[property].call(receiver, stxOrStxs)\n      }\n    }\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    return (target as any)[property]\n  }\n}\n"],"names":[],"mappings":";;;AAGA,IAAO,uBAAuB,GAAG,OAAO,CAAC,uBAAuB;AAGhE;;;AAGG;MACU,iBAAiB,CAAA;AAA9B,IAAA,WAAA,GAAA;QACU,IAAmB,CAAA,mBAAA,GAAa,EAAE;;AAE1C;;AAEG;AACH,IAAA,IAAI,kBAAkB,GAAA;QACpB,OAAO,IAAI,CAAC,mBAAmB;;AAGjC;;AAEG;IACH,KAAK,GAAA;AACH,QAAA,IAAI,CAAC,mBAAmB,GAAG,EAAE;;AAG/B;;AAEG;AACH,IAAA,iBAAiB,CAAC,kBAA6C,EAAA;AAC7D,QAAA,IAAI,KAAK,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE;AACrC,YAAA,KAAK,MAAM,IAAI,IAAI,kBAAkB,EAAE;AACrC,gBAAA,MAAM,OAAO,GAAG,uBAAuB,CAAC,IAAI,CAAC;AAC7C,gBAAA,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;;;aAE9C;AACL,YAAA,MAAM,OAAO,GAAG,uBAAuB,CAAC,kBAAkB,CAAC;AAC3D,YAAA,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;;;AAIrD;;;;AAIG;AACH,IAAA,OAAO,CAAC,KAAc,EAAA;QACpB,OAAO,IAAI,KAAK,CAAU,KAAK,EAAE,IAAI,qCAAqC,CAAC,IAAI,CAAC,CAAC;;;IAInF,MAAM,cAAc,CAAC,OAAgB,EAAA;AACnC,QAAA,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,KAAK,KAAK,sBAAsB,CAAC,MAAM,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;;AAEtI;AAED,MAAM,qCAAqC,CAAA;AAGzC,IAAA,WAAA,CAAY,iBAAoC,EAAA;AAC9C,QAAA,IAAI,CAAC,iBAAiB,GAAG,iBAAiB;;;AAI5C,IAAA,GAAG,CAAC,MAAe,EAAE,QAAyB,EAAE,QAAa,EAAA;AAC3D,QAAA,IAAI,QAAQ,KAAK,oBAAoB,EAAE;YACrC,OAAO,CAAC,SAAoC,KAAI;AAC9C,gBAAA,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,SAAS,CAAC;gBACnD,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC;AACnD,aAAC;;;AAGH,QAAA,OAAQ,MAAc,CAAC,QAAQ,CAAC;;AAEnC;;;;"}
+{"version":3,"file":"transaction-logger.mjs","sources":["../../src/testing/transaction-logger.ts"],"sourcesContent":["import algosdk from 'algosdk'\nimport { runWhenIndexerCaughtUp } from './indexer'\nimport Algodv2 = algosdk.Algodv2\nimport decodeSignedTransaction = algosdk.decodeSignedTransaction\nimport Indexer = algosdk.Indexer\n\n/**\n * Allows you to keep track of Algorand transaction IDs by wrapping an `Algodv2` in a proxy.\n * Useful for automated tests.\n */\nexport class TransactionLogger {\n  private _sentTransactionIds: string[] = []\n\n  /**\n   * The list of transaction IDs that has been logged thus far.\n   */\n  get sentTransactionIds(): Readonly<string[]> {\n    return this._sentTransactionIds\n  }\n\n  /**\n   * Clear all logged IDs.\n   */\n  clear() {\n    this._sentTransactionIds = []\n  }\n\n  /**\n   * The method that captures raw transactions and stores the transaction IDs.\n   */\n  logRawTransaction(signedTransactions: Uint8Array | Uint8Array[]) {\n    if (Array.isArray(signedTransactions)) {\n      for (const stxn of signedTransactions) {\n        const decoded = decodeSignedTransaction(stxn)\n        this._sentTransactionIds.push(decoded.txn.txID())\n      }\n    } else {\n      const decoded = decodeSignedTransaction(signedTransactions)\n      this._sentTransactionIds.push(decoded.txn.txID())\n    }\n  }\n\n  /** Return a proxy that wraps the given Algodv2 with this transaction logger.\n   *\n   * @param algod The `Algodv2` to wrap\n   * @returns The wrapped `Algodv2`, any transactions sent using this algod instance will be logged by this transaction logger\n   */\n  capture(algod: Algodv2): Algodv2 {\n    return new Proxy<Algodv2>(algod, new TransactionLoggingAlgodv2ProxyHandler(this))\n  }\n\n  /** Wait until all logged transactions IDs appear in the given `Indexer`. */\n  async waitForIndexer(indexer: Indexer) {\n    if (this._sentTransactionIds.length === 0) return\n    const lastTxId = this._sentTransactionIds[this._sentTransactionIds.length - 1]\n    await runWhenIndexerCaughtUp(() => indexer.lookupTransactionByID(lastTxId).do())\n  }\n}\n\nclass TransactionLoggingAlgodv2ProxyHandler implements ProxyHandler<Algodv2> {\n  private transactionLogger: TransactionLogger\n\n  constructor(transactionLogger: TransactionLogger) {\n    this.transactionLogger = transactionLogger\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  get(target: Algodv2, property: string | symbol, receiver: any) {\n    if (property === 'sendRawTransaction') {\n      return (stxOrStxs: Uint8Array | Uint8Array[]) => {\n        this.transactionLogger.logRawTransaction(stxOrStxs)\n        return target[property].call(receiver, stxOrStxs)\n      }\n    }\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    return (target as any)[property]\n  }\n}\n"],"names":[],"mappings":";;;AAGA,IAAO,uBAAuB,GAAG,OAAO,CAAC,uBAAuB;AAGhE;;;AAGG;MACU,iBAAiB,CAAA;AAA9B,IAAA,WAAA,GAAA;QACU,IAAmB,CAAA,mBAAA,GAAa,EAAE;;AAE1C;;AAEG;AACH,IAAA,IAAI,kBAAkB,GAAA;QACpB,OAAO,IAAI,CAAC,mBAAmB;;AAGjC;;AAEG;IACH,KAAK,GAAA;AACH,QAAA,IAAI,CAAC,mBAAmB,GAAG,EAAE;;AAG/B;;AAEG;AACH,IAAA,iBAAiB,CAAC,kBAA6C,EAAA;AAC7D,QAAA,IAAI,KAAK,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE;AACrC,YAAA,KAAK,MAAM,IAAI,IAAI,kBAAkB,EAAE;AACrC,gBAAA,MAAM,OAAO,GAAG,uBAAuB,CAAC,IAAI,CAAC;AAC7C,gBAAA,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;;;aAE9C;AACL,YAAA,MAAM,OAAO,GAAG,uBAAuB,CAAC,kBAAkB,CAAC;AAC3D,YAAA,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;;;AAIrD;;;;AAIG;AACH,IAAA,OAAO,CAAC,KAAc,EAAA;QACpB,OAAO,IAAI,KAAK,CAAU,KAAK,EAAE,IAAI,qCAAqC,CAAC,IAAI,CAAC,CAAC;;;IAInF,MAAM,cAAc,CAAC,OAAgB,EAAA;AACnC,QAAA,IAAI,IAAI,CAAC,mBAAmB,CAAC,MAAM,KAAK,CAAC;YAAE;AAC3C,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,CAAC;AAC9E,QAAA,MAAM,sBAAsB,CAAC,MAAM,OAAO,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC;;AAEnF;AAED,MAAM,qCAAqC,CAAA;AAGzC,IAAA,WAAA,CAAY,iBAAoC,EAAA;AAC9C,QAAA,IAAI,CAAC,iBAAiB,GAAG,iBAAiB;;;AAI5C,IAAA,GAAG,CAAC,MAAe,EAAE,QAAyB,EAAE,QAAa,EAAA;AAC3D,QAAA,IAAI,QAAQ,KAAK,oBAAoB,EAAE;YACrC,OAAO,CAAC,SAAoC,KAAI;AAC9C,gBAAA,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,SAAS,CAAC;gBACnD,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC;AACnD,aAAC;;;AAGH,QAAA,OAAQ,MAAc,CAAC,QAAQ,CAAC;;AAEnC;;;;"}

package/transaction/transaction.js

@@ -35,12 +35,12 @@ function encodeTransactionNote(note) {
         return note;
     }
     else if (typeof note === 'object' && 'dAppName' in note) {
-        const arc2Payload = `${note.dAppName}:${note.format}${typeof note.data === 'string' ? note.data : JSON.stringify(note.data)}`;
+        const arc2Payload = `${note.dAppName}:${note.format}${typeof note.data === 'string' ? note.data : util.asJson(note.data)}`;
         const encoder = new TextEncoder();
         return encoder.encode(arc2Payload);
     }
     else {
-        const n = typeof note === 'string' ? note : JSON.stringify(note);
+        const n = typeof note === 'string' ? note : util.asJson(note);
         const encoder = new TextEncoder();
         return encoder.encode(n);
     }
@@ -313,8 +313,8 @@ async function populateAppCallResources(atc, algod) {
                     t.txn.appForeignApps?.map((a) => algosdk.getApplicationAddress(a)).includes(account) ||
                     // account is available since it's in one of the fields
                     Object.values(t.txn)
-                        .map((f) => JSON.stringify(f))
-                        .includes(JSON.stringify(algosdk.decodeAddress(account))));
+                        .map((f) => util.asJson(f))
+                        .includes(util.asJson(algosdk.decodeAddress(account))));
             });
             if (txnIndex > -1) {
                 if (type === 'assetHolding') {