chore: simplify accountGetter return type

Author: neilcampbell

docs/capabilities/testing.md

@@ -110,7 +110,7 @@ When calling `algorandFixture()` you can optionally pass in some fixture configu
 - `indexer?: Indexer` - An optional indexer client, if not specified then it will create one against environment variables defined network (if present) or default LocalNet
 - `kmd?: Kmd` - An optional kmd client, if not specified then it will create one against environment variables defined network (if present) or default LocalNet
 - `testAccountFunding?: AlgoAmount` - The [amount](./amount.md) of funds to allocate to the default testing account, if not specified then it will get `10` ALGO
-- `accountGetter?: (algod: Algodv2, kmd?: Kmd) => Promise<Account>` - Optional override for how to get an account; this allows you to retrieve test accounts from a known or cached list of accounts.
+- `accountGetter?: (algod: Algodv2, kmd?: Kmd) => Promise<Address & AddressWithSigners>` - Optional override for how to get an account; this allows you to retrieve test accounts from a known or cached list of accounts.
 
 ### Using the fixture context
 
@@ -121,8 +121,8 @@ The `fixture.context` property is of type [`AlgorandTestAutomationContext`](../c
 - `indexer: Indexer` - Indexer client instance
 - `kmd: Kmd` - KMD client instance
 - `transactionLogger: TransactionLogger` - Transaction logger that will log transaction IDs for all transactions issued by `algod`
-- `testAccount: Account` - Funded test account that is ephemerally created for each test
-- `generateAccount: (params: GetTestAccountParams) => Promise<Account>` - Generate and fund an additional ephemerally created account
+- `testAccount: Address & AddressWithSigners` - Funded test account that is ephemerally created for each test
+- `generateAccount: (params: GetTestAccountParams) => Promise<Address & AddressWithSigners>` - Generate and fund an additional ephemerally created account
 - `waitForIndexer()` - Waits for indexer to catch up with the latest transaction that has been captured by the `transactionLogger` in the Algorand fixture
 - `waitForIndexerTransaction: (transactionId: string) => Promise<TransactionLookupResult>` - Wait for the indexer to catch up with the given transaction ID
 

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:190](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L190)
+[src/types/testing.ts:161](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L161)
 
 ___
 
@@ -53,7 +53,7 @@ Testing framework agnostic handler method to run before each test to prepare the
 
 #### Defined in
 
-[src/types/testing.ts:186](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L186)
+[src/types/testing.ts:157](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L157)
 
 ## Accessors
 
@@ -69,4 +69,4 @@ The test logger instance for the current test
 
 #### Defined in
 
-[src/types/testing.ts:182](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L182)
+[src/types/testing.ts:153](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L153)

docs/code/interfaces/types_testing.AlgorandFixture.md

@@ -39,7 +39,7 @@ Testing framework agnostic handler method to run before each test to prepare the
 
 #### Defined in
 
-[src/types/testing.ts:122](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L122)
+[src/types/testing.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L93)
 
 ___
 
@@ -95,7 +95,7 @@ describe('MY MODULE', () => {
 
 #### Defined in
 
-[src/types/testing.ts:162](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L162)
+[src/types/testing.ts:133](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L133)
 
 ## Accessors
 
@@ -111,7 +111,7 @@ Retrieve an `AlgorandClient` loaded with the current context, including testAcco
 
 #### Defined in
 
-[src/types/testing.ts:116](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L116)
+[src/types/testing.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L87)
 
 ___
 
@@ -138,4 +138,4 @@ test('My test', () => {
 
 #### Defined in
 
-[src/types/testing.ts:111](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L111)
+[src/types/testing.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L82)

docs/code/interfaces/types_testing.AlgorandFixtureConfig.md

@@ -29,28 +29,27 @@ Configuration for creating an Algorand testing fixture.
 
 ### accountGetter
 
-• `Optional` **accountGetter**: (`algod`: `AlgodClient`, `kmd?`: `KmdClient`) => `Promise`\<[`Address`](../classes/index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: \{ `addr`: `Readonly`\<[`Address`](../classes/index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner`  }  }\>
+• `Optional` **accountGetter**: (`algorand`: [`AlgorandClient`](../classes/types_algorand_client.AlgorandClient.md)) => `Promise`\<[`Address`](../classes/index.Address.md) & \{ `addr`: `Readonly`\<[`Address`](../classes/index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner`  }\>
 
 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`\<[`Address`](../classes/index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: \{ `addr`: `Readonly`\<[`Address`](../classes/index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner`  }  }\>
+▸ (`algorand`): `Promise`\<[`Address`](../classes/index.Address.md) & \{ `addr`: `Readonly`\<[`Address`](../classes/index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner`  }\>
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `algod` | `AlgodClient` |
-| `kmd?` | `KmdClient` |
+| `algorand` | [`AlgorandClient`](../classes/types_algorand_client.AlgorandClient.md) |
 
 ##### Returns
 
-`Promise`\<[`Address`](../classes/index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: \{ `addr`: `Readonly`\<[`Address`](../classes/index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner`  }  }\>
+`Promise`\<[`Address`](../classes/index.Address.md) & \{ `addr`: `Readonly`\<[`Address`](../classes/index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner`  }\>
 
 #### Defined in
 
-[src/types/testing.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L80)
+[src/types/testing.ts:65](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L65)
 
 ___
 
@@ -62,7 +61,7 @@ An optional algod client, if not specified then it will create one against `algo
 
 #### Defined in
 
-[src/types/testing.ts:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L72)
+[src/types/testing.ts:57](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L57)
 
 ___
 
@@ -90,7 +89,7 @@ An optional indexer client, if not specified then it will create one against `in
 
 #### 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:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L59)
 
 ___
 
@@ -118,7 +117,7 @@ An optional kmd client, if not specified then it will create one against `kmdCon
 
 #### Defined in
 
-[src/types/testing.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L76)
+[src/types/testing.ts:61](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L61)
 
 ___
 
@@ -146,4 +145,4 @@ The amount of funds to allocate to the default testing account, if not specified
 
 #### Defined in
 
-[src/types/testing.ts:78](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L78)
+[src/types/testing.ts:63](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L63)

docs/code/interfaces/types_testing.AlgorandTestAutomationContext.md

@@ -30,7 +30,7 @@ Algod client instance that will log transactions in `transactionLogger`
 
 #### Defined in
 
-[src/types/testing.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L29)
+[src/types/testing.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L25)
 
 ___
 
@@ -42,7 +42,7 @@ An AlgorandClient instance loaded with the current context, including testAccoun
 
 #### Defined in
 
-[src/types/testing.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L27)
+[src/types/testing.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L23)
 
 ___
 
@@ -68,7 +68,7 @@ Generate and fund an additional ephemerally created account
 
 #### Defined in
 
-[src/types/testing.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L39)
+[src/types/testing.ts:35](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L35)
 
 ___
 
@@ -80,7 +80,7 @@ Indexer client instance
 
 #### Defined in
 
-[src/types/testing.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L31)
+[src/types/testing.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L27)
 
 ___
 
@@ -92,7 +92,7 @@ KMD client instance
 
 #### Defined in
 
-[src/types/testing.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L33)
+[src/types/testing.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L29)
 
 ___
 
@@ -104,7 +104,7 @@ Default, funded test account that is ephemerally created
 
 #### Defined in
 
-[src/types/testing.ts:37](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L37)
+[src/types/testing.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L33)
 
 ___
 
@@ -116,7 +116,7 @@ Transaction logger that will log transaction IDs for all transactions issued by
 
 #### Defined in
 
-[src/types/testing.ts:35](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L35)
+[src/types/testing.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L31)
 
 ___
 
@@ -136,7 +136,7 @@ Wait for the indexer to catch up with all transactions logged by `transactionLog
 
 #### Defined in
 
-[src/types/testing.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L41)
+[src/types/testing.ts:37](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L37)
 
 ___
 
@@ -162,4 +162,4 @@ Wait for the indexer to catch up with the given transaction ID
 
 #### Defined in
 
-[src/types/testing.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L43)
+[src/types/testing.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L39)

docs/code/interfaces/types_testing.GetTestAccountParams.md

@@ -18,13 +18,13 @@ Parameters for the `getTestAccount` function.
 
 ### accountGetter
 
-• `Optional` **accountGetter**: (`algorand`: [`AlgorandClient`](../classes/types_algorand_client.AlgorandClient.md)) => `Promise`\<[`Address`](../classes/index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: \{ `addr`: `Readonly`\<[`Address`](../classes/index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner`  }  }\>
+• `Optional` **accountGetter**: (`algorand`: [`AlgorandClient`](../classes/types_algorand_client.AlgorandClient.md)) => `Promise`\<[`Address`](../classes/index.Address.md) & \{ `addr`: `Readonly`\<[`Address`](../classes/index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner`  }\>
 
 Optional override for how to get a test account; this allows you to retrieve accounts from a known or cached list of accounts.
 
 #### Type declaration
 
-▸ (`algorand`): `Promise`\<[`Address`](../classes/index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: \{ `addr`: `Readonly`\<[`Address`](../classes/index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner`  }  }\>
+▸ (`algorand`): `Promise`\<[`Address`](../classes/index.Address.md) & \{ `addr`: `Readonly`\<[`Address`](../classes/index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner`  }\>
 
 ##### Parameters
 
@@ -34,11 +34,11 @@ Optional override for how to get a test account; this allows you to retrieve acc
 
 ##### Returns
 
-`Promise`\<[`Address`](../classes/index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: \{ `addr`: `Readonly`\<[`Address`](../classes/index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner`  }  }\>
+`Promise`\<[`Address`](../classes/index.Address.md) & \{ `addr`: `Readonly`\<[`Address`](../classes/index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner`  }\>
 
 #### Defined in
 
-[src/types/testing.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L55)
+[src/types/testing.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L51)
 
 ___
 
@@ -50,7 +50,7 @@ Initial funds to ensure the account has
 
 #### Defined in
 
-[src/types/testing.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L51)
+[src/types/testing.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L47)
 
 ___
 
@@ -62,4 +62,4 @@ Whether to suppress the log (which includes a mnemonic) or not (default: do not
 
 #### Defined in
 
-[src/types/testing.ts:53](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L53)
+[src/types/testing.ts:49](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L49)

docs/code/interfaces/types_testing.LogSnapshotConfig.md

@@ -27,7 +27,7 @@ Any accounts/addresses to replace the address for predictably
 
 #### Defined in
 
-[src/types/testing.ts:173](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L173)
+[src/types/testing.ts:144](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L144)
 
 ___
 
@@ -39,7 +39,7 @@ Any app IDs to replace predictably
 
 #### Defined in
 
-[src/types/testing.ts:175](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L175)
+[src/types/testing.ts:146](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L146)
 
 ___
 
@@ -65,7 +65,7 @@ Optional filter predicate to filter out logs
 
 #### Defined in
 
-[src/types/testing.ts:177](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L177)
+[src/types/testing.ts:148](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L148)
 
 ___
 
@@ -77,4 +77,4 @@ Any transaction IDs or transactions to replace the ID for predictably
 
 #### Defined in
 
-[src/types/testing.ts:171](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L171)
+[src/types/testing.ts:142](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L142)

src/types/testing.ts

@@ -1,18 +1,14 @@
 import { AlgodClient } from '@algorandfoundation/algokit-algod-client'
 import { Address } from '@algorandfoundation/algokit-common'
+import { IndexerClient, TransactionResponse } from '@algorandfoundation/algokit-indexer-client'
+import { KmdClient } from '@algorandfoundation/algokit-kmd-client'
 import {
   AddressWithSigners,
   AddressWithTransactionSigner,
-  DelegatedLsigSigner,
   LogicSigAccount,
-  MxBytesSigner,
-  ProgramDataSigner,
+  MultisigAccount,
   Transaction,
-  TransactionSigner,
 } from '@algorandfoundation/algokit-transact'
-import { MultisigAccount } from '@algorandfoundation/algokit-transact'
-import { IndexerClient, TransactionResponse } from '@algorandfoundation/algokit-indexer-client'
-import { KmdClient } from '@algorandfoundation/algokit-kmd-client'
 import { TransactionLogger } from '../testing'
 import { TestLogger } from '../testing/test-logger'
 import { AlgoAmount } from '../types/amount'
@@ -52,18 +48,7 @@ export interface GetTestAccountParams {
   /** 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 a test account; this allows you to retrieve accounts from a known or cached list of accounts. */
-  accountGetter?: (algorand: AlgorandClient) => Promise<
-    Address &
-      AddressWithTransactionSigner & {
-        account: {
-          addr: Readonly<Address>
-          signer: TransactionSigner
-          lsigSigner: DelegatedLsigSigner
-          programDataSigner: ProgramDataSigner
-          mxBytesSigner: MxBytesSigner
-        }
-      }
-  >
+  accountGetter?: (algorand: AlgorandClient) => Promise<Address & AddressWithSigners>
 }
 
 /** Configuration for creating an Algorand testing fixture. */
@@ -77,21 +62,7 @@ export interface AlgorandFixtureConfig extends Partial<AlgoConfig> {
   /** The amount of funds to allocate to the default testing account, if not specified then it will get 10 ALGO. */
   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: AlgodClient,
-    kmd?: KmdClient,
-  ) => Promise<
-    Address &
-      AddressWithTransactionSigner & {
-        account: {
-          addr: Readonly<Address>
-          signer: TransactionSigner
-          lsigSigner: DelegatedLsigSigner
-          programDataSigner: ProgramDataSigner
-          mxBytesSigner: MxBytesSigner
-        }
-      }
-  >
+  accountGetter?: (algorand: AlgorandClient) => Promise<Address & AddressWithSigners>
 }
 
 /** An Algorand automated testing fixture */