Merge main into release

docs/code/interfaces/types_testing.AlgoKitLogCaptureFixture.md

@@ -33,7 +33,7 @@ Testing framework agnostic handler method to run after each test to reset the lo
 
 #### Defined in
 
-[src/types/testing.ts:100](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L100)
+[src/types/testing.ts:104](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L104)
 
 ___
 
@@ -53,7 +53,7 @@ Testing framework agnostic handler method to run before each test to prepare the
 
 #### Defined in
 
-[src/types/testing.ts:96](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L96)
+[src/types/testing.ts:100](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L100)
 
 ## Accessors
 
@@ -69,4 +69,4 @@ The test logger instance for the current test
 
 #### Defined in
 
-[src/types/testing.ts:92](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L92)
+[src/types/testing.ts:96](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L96)

docs/code/interfaces/types_testing.AlgorandFixture.md

@@ -34,7 +34,7 @@ Testing framework agnostic handler method to run before each test to prepare the
 
 #### Defined in
 
-[src/types/testing.ts:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L74)
+[src/types/testing.ts:78](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L78)
 
 ## Accessors
 
@@ -59,4 +59,4 @@ test('My test', () => {
 
 #### Defined in
 
-[src/types/testing.ts:69](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L69)
+[src/types/testing.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L73)

docs/code/interfaces/types_testing.AlgorandFixtureConfig.md

@@ -10,13 +10,41 @@ Configuration for creating an Algorand testing fixture.
 
 ### Properties
 
+- [accountGetter](types_testing.AlgorandFixtureConfig.md#accountgetter)
 - [algod](types_testing.AlgorandFixtureConfig.md#algod)
 - [indexer](types_testing.AlgorandFixtureConfig.md#indexer)
 - [kmd](types_testing.AlgorandFixtureConfig.md#kmd)
 - [testAccountFunding](types_testing.AlgorandFixtureConfig.md#testaccountfunding)
 
 ## Properties
 
+### accountGetter
+
+• `Optional` **accountGetter**: (`algod`: `default`, `kmd?`: `default`) => `Promise`\<`default`\>
+
+Optional override for how to get an account; this allows you to retrieve accounts from a known or cached list of accounts.
+
+#### Type declaration
+
+▸ (`algod`, `kmd?`): `Promise`\<`default`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `algod` | `default` |
+| `kmd?` | `default` |
+
+##### Returns
+
+`Promise`\<`default`\>
+
+#### Defined in
+
+[src/types/testing.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L58)
+
+___
+
 ### algod
 
 • `Optional` **algod**: `default`
@@ -25,7 +53,7 @@ An optional algod client, if not specified then it will create one against envir
 
 #### Defined in
 
-[src/types/testing.ts:48](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L48)
+[src/types/testing.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L50)
 
 ___
 
@@ -37,7 +65,7 @@ An optional indexer client, if not specified then it will create one against env
 
 #### Defined in
 
-[src/types/testing.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L50)
+[src/types/testing.ts:52](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L52)
 
 ___
 
@@ -49,7 +77,7 @@ An optional kmd client, if not specified then it will create one against environ
 
 #### Defined in
 
-[src/types/testing.ts:52](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L52)
+[src/types/testing.ts:54](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L54)
 
 ___
 
@@ -61,4 +89,4 @@ The amount of funds to allocate to the default testing account, if not specified
 
 #### Defined in
 
-[src/types/testing.ts:54](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L54)
+[src/types/testing.ts:56](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L56)

docs/code/interfaces/types_testing.GetTestAccountParams.md

@@ -10,11 +10,39 @@ Parameters for the `getTestAccount` function.
 
 ### Properties
 
+- [accountGetter](types_testing.GetTestAccountParams.md#accountgetter)
 - [initialFunds](types_testing.GetTestAccountParams.md#initialfunds)
 - [suppressLog](types_testing.GetTestAccountParams.md#suppresslog)
 
 ## Properties
 
+### accountGetter
+
+• `Optional` **accountGetter**: (`algod`: `default`, `kmd?`: `default`) => `Promise`\<`default`\>
+
+Optional override for how to get an account; this allows you to retrieve accounts from a known or cached list of accounts.
+
+#### Type declaration
+
+▸ (`algod`, `kmd?`): `Promise`\<`default`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `algod` | `default` |
+| `kmd?` | `default` |
+
+##### Returns
+
+`Promise`\<`default`\>
+
+#### Defined in
+
+[src/types/testing.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L44)
+
+___
+
 ### initialFunds
 
 • **initialFunds**: [`AlgoAmount`](../classes/types_amount.AlgoAmount.md)

docs/code/interfaces/types_testing.LogSnapshotConfig.md

@@ -26,7 +26,7 @@ Any accounts/addresses to replace the address for predictably
 
 #### Defined in
 
-[src/types/testing.ts:85](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L85)
+[src/types/testing.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L89)
 
 ___
 
@@ -38,7 +38,7 @@ Any app IDs to replace predictably
 
 #### Defined in
 
-[src/types/testing.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L87)
+[src/types/testing.ts:91](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L91)
 
 ___
 
@@ -50,4 +50,4 @@ Any transaction IDs or transactions to replace the ID for predictably
 
 #### Defined in
 
-[src/types/testing.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L83)
+[src/types/testing.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L87)

jest.config.ts

@@ -4,7 +4,7 @@ const config: Config.InitialOptions = {
  preset: 'ts-jest',
  testEnvironment: 'node',
  testMatch: ['**/*.spec.ts'],
- testTimeout: 10000,
+ testTimeout: 20000,
  bail: 1,
  setupFiles: ['<rootDir>/tests/setup.ts'],
  moduleDirectories: ['node_modules', 'src'],

src/testing/account.ts

@@ -16,8 +16,12 @@ import Kmd = algosdk.Kmd
  * @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 async function getTestAccount({ suppressLog, initialFunds }: GetTestAccountParams, algod: Algodv2, kmd?: Kmd): Promise<Account> {
- const account = algosdk.generateAccount()
+export async function getTestAccount(
+ { suppressLog, initialFunds, accountGetter }: GetTestAccountParams,
+ algod: Algodv2,
+ kmd?: Kmd,
+): Promise<Account> {
+ const account = accountGetter ? await accountGetter(algod, kmd) : algosdk.generateAccount()
 
  Config.getLogger(suppressLog).info(
  `New test account created with address '${account.addr}' and mnemonic '${algosdk.secretKeyToMnemonic(account.sk)}'.`,

src/testing/fixtures/algorand-fixture.ts

@@ -102,11 +102,12 @@ export function algorandFixture(fixtureConfig?: AlgorandFixtureConfig, config?:
  indexer: indexer,
  kmd: kmd,
  testAccount: await getTestAccount(
- { initialFunds: fixtureConfig?.testAccountFunding ?? algos(10), suppressLog: true },
+ { initialFunds: fixtureConfig?.testAccountFunding ?? algos(10), suppressLog: true, accountGetter: fixtureConfig?.accountGetter },
  transactionLoggerAlgod,
  kmd,
  ),
- generateAccount: (params: GetTestAccountParams) => getTestAccount(params, transactionLoggerAlgod, kmd),
+ generateAccount: (params: GetTestAccountParams) =>
+ getTestAccount({ accountGetter: fixtureConfig?.accountGetter, ...params }, transactionLoggerAlgod, kmd),
  transactionLogger: transactionLogger,
  waitForIndexer: () => transactionLogger.waitForIndexer(indexer),
  waitForIndexerTransaction: (transactionId: string) => runWhenIndexerCaughtUp(() => lookupTransactionById(transactionId, indexer)),

src/types/testing.ts

@@ -40,6 +40,8 @@ export interface GetTestAccountParams {
  initialFunds: AlgoAmount
  /** Whether to suppress the log (which includes a mnemonic) or not (default: do not suppress the log) */
  suppressLog?: boolean
+ /** Optional override for how to get an account; this allows you to retrieve accounts from a known or cached list of accounts. */
+ accountGetter?: (algod: Algodv2, kmd?: Kmd) => Promise<Account>
 }
 
 /** Configuration for creating an Algorand testing fixture. */
@@ -52,6 +54,8 @@ export interface AlgorandFixtureConfig {
  kmd?: Kmd
  /** The amount of funds to allocate to the default testing account, if not specified then it will get 10 ALGOs. */
  testAccountFunding?: AlgoAmount
+ /** Optional override for how to get an account; this allows you to retrieve accounts from a known or cached list of accounts. */
+ accountGetter?: (algod: Algodv2, kmd?: Kmd) => Promise<Account>
 }
 
 /** An Algorand automated testing fixture */