@algorandfoundation/algokit-utils 6.1.1-beta.1 → 6.1.1-beta.2

package/package.json

@@ -6,7 +6,7 @@
     "**"
   ],
   "name": "@algorandfoundation/algokit-utils",
-  "version": "6.1.1-beta.1",
+  "version": "6.1.1-beta.2",
   "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/account.d.ts

@@ -2,14 +2,29 @@ import algosdk from 'algosdk';
 import { AlgorandClient } from '../';
 import { GetTestAccountParams } from '../types/testing';
 import Account = algosdk.Account;
+import Algodv2 = algosdk.Algodv2;
+import Kmd = algosdk.Kmd;
 /**
+ * @deprecated Use `getTestAccount(params, algorandClient)` instead. The `algorandClient` object can be created using `AlgorandClient.fromClients({ algod, kmd })`.
+ *
  * Creates an ephemeral Algorand account for the purposes of testing.
  * Returns a newly created random test account that is funded from the dispenser
  * DO NOT USE THIS TO CREATE A MAINNET ACCOUNT!
  * Note: By default this will log the mnemonic of the account.
- * @param param0 The config for the test account to generate
+ * @param params The config for the test account to generate
+ * @param algod An algod client
+ * @param kmd A KMD client, if not specified then a default KMD client will be loaded from environment variables
+ * @returns The account, with private key loaded
+ */
+export declare function getTestAccount(params: GetTestAccountParams, algod: Algodv2, kmd?: Kmd): Promise<Account>;
+/**
+ * Creates an ephemeral Algorand account for the purposes of testing.
+ * Returns a newly created random test account that is funded from the dispenser
+ * DO NOT USE THIS TO CREATE A MAINNET ACCOUNT!
+ * Note: By default this will log the mnemonic of the account.
+ * @param params The config for the test account to generate
  * @param algorand An AlgorandClient client
  * @returns The account, with private key loaded
  */
-export declare function getTestAccount({ suppressLog, initialFunds, accountGetter }: GetTestAccountParams, algorand: AlgorandClient): Promise<Account>;
+export declare function getTestAccount(params: GetTestAccountParams, algorand: AlgorandClient): Promise<Account>;
 //# sourceMappingURL=account.d.ts.map

package/testing/account.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../src/testing/account.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAC7B,OAAO,EAAE,cAAc,EAAU,MAAM,KAAK,CAAA;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA;AACvD,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAEhC;;;;;;;;GAQG;AACH,wBAAsB,cAAc,CAClC,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAE,EAAE,oBAAoB,EAClE,QAAQ,EAAE,cAAc,GACvB,OAAO,CAAC,OAAO,CAAC,CAmBlB"}
+{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../src/testing/account.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAC7B,OAAO,EAAE,cAAc,EAAU,MAAM,KAAK,CAAA;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA;AACvD,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAChC,OAAO,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAChC,OAAO,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;AAExB;;;;;;;;;;;GAWG;AACH,wBAAsB,cAAc,CAAC,MAAM,EAAE,oBAAoB,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;AAC/G;;;;;;;;GAQG;AACH,wBAAsB,cAAc,CAAC,MAAM,EAAE,oBAAoB,EAAE,QAAQ,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA"}

package/testing/account.js

@@ -1,18 +1,13 @@
 'use strict';
 
 var algosdk = require('algosdk');
+var types_algorandClient = require('../types/algorand-client.js');
 var config = require('../config.js');
 
-/**
- * Creates an ephemeral Algorand account for the purposes of testing.
- * Returns a newly created random test account that is funded from the dispenser
- * DO NOT USE THIS TO CREATE A MAINNET ACCOUNT!
- * Note: By default this will log the mnemonic of the account.
- * @param param0 The config for the test account to generate
- * @param algorand An AlgorandClient client
- * @returns The account, with private key loaded
- */
-async function getTestAccount({ suppressLog, initialFunds, accountGetter }, algorand) {
+async function getTestAccount({ suppressLog, initialFunds, accountGetter }, algodOrAlgorandClient, kmd) {
+    const algorand = algodOrAlgorandClient instanceof types_algorandClient.AlgorandClient
+        ? algodOrAlgorandClient
+        : types_algorandClient.AlgorandClient.fromClients({ algod: algodOrAlgorandClient, kmd });
     const account = accountGetter ? await accountGetter(algorand) : algosdk.generateAccount();
     config.Config.getLogger(suppressLog).info(`New test account created with address '${account.addr}' and mnemonic '${algosdk.secretKeyToMnemonic(account.sk)}'.`);
     const dispenser = await algorand.account.dispenserFromEnvironment();

package/testing/account.js.map

@@ -1 +1 @@
-{"version":3,"file":"account.js","sources":["../../src/testing/account.ts"],"sourcesContent":[null],"names":["Config"],"mappings":";;;;;AAKA;;;;;;;;AAQG;AACI,eAAe,cAAc,CAClC,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAwB,EAClE,QAAwB,EAAA;AAExB,IAAA,MAAM,OAAO,GAAG,aAAa,GAAG,MAAM,aAAa,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,eAAe,EAAE,CAAA;IAEzFA,aAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,IAAI,CAChC,CAAA,uCAAA,EAA0C,OAAO,CAAC,IAAI,CAAmB,gBAAA,EAAA,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAI,EAAA,CAAA,CACrH,CAAA;IAED,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,wBAAwB,EAAE,CAAA;AAEnE,IAAA,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,CACzB,EAAE,MAAM,EAAE,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,sBAAsB,EAAE,EACtG,EAAE,WAAW,EAAE,CAChB,CAAA;AAED,IAAA,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;AAEvE,IAAAA,aAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,iDAAiD,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;AAEzG,IAAA,OAAO,OAAO,CAAA;AAChB;;;;"}
+{"version":3,"file":"account.js","sources":["../../src/testing/account.ts"],"sourcesContent":[null],"names":["AlgorandClient","Config"],"mappings":";;;;;;AA8BO,eAAe,cAAc,CAClC,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAwB,EAClE,qBAA+C,EAC/C,GAAS,EAAA;AAET,IAAA,MAAM,QAAQ,GACZ,qBAAqB,YAAYA,mCAAc;AAC7C,UAAE,qBAAqB;AACvB,UAAEA,mCAAc,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,qBAAqB,EAAE,GAAG,EAAE,CAAC,CAAA;AAEvE,IAAA,MAAM,OAAO,GAAG,aAAa,GAAG,MAAM,aAAa,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,eAAe,EAAE,CAAA;IAEzFC,aAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,IAAI,CAChC,CAAA,uCAAA,EAA0C,OAAO,CAAC,IAAI,CAAmB,gBAAA,EAAA,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAI,EAAA,CAAA,CACrH,CAAA;IAED,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,wBAAwB,EAAE,CAAA;AAEnE,IAAA,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,CACzB,EAAE,MAAM,EAAE,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,sBAAsB,EAAE,EACtG,EAAE,WAAW,EAAE,CAChB,CAAA;AAED,IAAA,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;AAEvE,IAAAA,aAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,iDAAiD,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;AAEzG,IAAA,OAAO,OAAO,CAAA;AAChB;;;;"}

package/testing/account.mjs

@@ -1,16 +1,11 @@
 import algosdk from 'algosdk';
+import { AlgorandClient } from '../types/algorand-client.mjs';
 import { Config } from '../config.mjs';
 
-/**
- * Creates an ephemeral Algorand account for the purposes of testing.
- * Returns a newly created random test account that is funded from the dispenser
- * DO NOT USE THIS TO CREATE A MAINNET ACCOUNT!
- * Note: By default this will log the mnemonic of the account.
- * @param param0 The config for the test account to generate
- * @param algorand An AlgorandClient client
- * @returns The account, with private key loaded
- */
-async function getTestAccount({ suppressLog, initialFunds, accountGetter }, algorand) {
+async function getTestAccount({ suppressLog, initialFunds, accountGetter }, algodOrAlgorandClient, kmd) {
+    const algorand = algodOrAlgorandClient instanceof AlgorandClient
+        ? algodOrAlgorandClient
+        : AlgorandClient.fromClients({ algod: algodOrAlgorandClient, kmd });
     const account = accountGetter ? await accountGetter(algorand) : algosdk.generateAccount();
     Config.getLogger(suppressLog).info(`New test account created with address '${account.addr}' and mnemonic '${algosdk.secretKeyToMnemonic(account.sk)}'.`);
     const dispenser = await algorand.account.dispenserFromEnvironment();

package/testing/account.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"account.mjs","sources":["../../src/testing/account.ts"],"sourcesContent":[null],"names":[],"mappings":";;;AAKA;;;;;;;;AAQG;AACI,eAAe,cAAc,CAClC,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAwB,EAClE,QAAwB,EAAA;AAExB,IAAA,MAAM,OAAO,GAAG,aAAa,GAAG,MAAM,aAAa,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,eAAe,EAAE,CAAA;IAEzF,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,IAAI,CAChC,CAAA,uCAAA,EAA0C,OAAO,CAAC,IAAI,CAAmB,gBAAA,EAAA,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAI,EAAA,CAAA,CACrH,CAAA;IAED,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,wBAAwB,EAAE,CAAA;AAEnE,IAAA,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,CACzB,EAAE,MAAM,EAAE,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,sBAAsB,EAAE,EACtG,EAAE,WAAW,EAAE,CAChB,CAAA;AAED,IAAA,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;AAEvE,IAAA,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,iDAAiD,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;AAEzG,IAAA,OAAO,OAAO,CAAA;AAChB;;;;"}
+{"version":3,"file":"account.mjs","sources":["../../src/testing/account.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AA8BO,eAAe,cAAc,CAClC,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAwB,EAClE,qBAA+C,EAC/C,GAAS,EAAA;AAET,IAAA,MAAM,QAAQ,GACZ,qBAAqB,YAAY,cAAc;AAC7C,UAAE,qBAAqB;AACvB,UAAE,cAAc,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,qBAAqB,EAAE,GAAG,EAAE,CAAC,CAAA;AAEvE,IAAA,MAAM,OAAO,GAAG,aAAa,GAAG,MAAM,aAAa,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,eAAe,EAAE,CAAA;IAEzF,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,IAAI,CAChC,CAAA,uCAAA,EAA0C,OAAO,CAAC,IAAI,CAAmB,gBAAA,EAAA,OAAO,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAI,EAAA,CAAA,CACrH,CAAA;IAED,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,wBAAwB,EAAE,CAAA;AAEnE,IAAA,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,CACzB,EAAE,MAAM,EAAE,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,sBAAsB,EAAE,EACtG,EAAE,WAAW,EAAE,CAChB,CAAA;AAED,IAAA,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;AAEvE,IAAA,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,iDAAiD,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;AAEzG,IAAA,OAAO,OAAO,CAAA;AAChB;;;;"}