Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/code/classes/types_account_manager.AccountManager.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ ___

#### Defined in

[src/types/account-manager.ts:547](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L547)
[src/types/account-manager.ts:563](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L563)

___

Expand Down Expand Up @@ -215,7 +215,7 @@ const account = await accountManager.dispenserFromEnvironment()

#### Defined in

[src/types/account-manager.ts:460](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L460)
[src/types/account-manager.ts:476](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L476)

___

Expand Down Expand Up @@ -258,7 +258,7 @@ await accountManager.ensureFunded("ACCOUNTADDRESS", "DISPENSERADDRESS", algokit.

#### Defined in

[src/types/account-manager.ts:580](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L580)
[src/types/account-manager.ts:596](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L596)

___

Expand Down Expand Up @@ -307,7 +307,7 @@ await accountManager.ensureFundedFromEnvironment("ACCOUNTADDRESS", algokit.algo(

#### Defined in

[src/types/account-manager.ts:642](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L642)
[src/types/account-manager.ts:658](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L658)

___

Expand Down Expand Up @@ -351,7 +351,7 @@ await accountManager.ensureFundedFromTestNetDispenserApi("ACCOUNTADDRESS", algor

#### Defined in

[src/types/account-manager.ts:698](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L698)
[src/types/account-manager.ts:714](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L714)

___

Expand Down Expand Up @@ -587,7 +587,7 @@ const account = await accountManager.localNetDispenser()

#### Defined in

[src/types/account-manager.ts:479](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L479)
[src/types/account-manager.ts:495](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L495)

___

Expand Down Expand Up @@ -656,13 +656,13 @@ ___

### random

▸ **random**(): [`Address`](index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: \{ `addr`: `Readonly`\<[`Address`](index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner` } }
▸ **random**(): [`Address`](index.Address.md) & \{ `addr`: `Readonly`\<[`Address`](index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner` }

Tracks and returns a new, random Algorand account with secret key loaded.

#### Returns

[`Address`](index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: \{ `addr`: `Readonly`\<[`Address`](index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner` } }
[`Address`](index.Address.md) & \{ `addr`: `Readonly`\<[`Address`](index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner` }

The account

Expand Down Expand Up @@ -734,7 +734,7 @@ await accountManager.rekeyAccount({

#### Defined in

[src/types/account-manager.ts:522](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L522)
[src/types/account-manager.ts:538](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L538)

___

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Testing framework agnostic handler method to run after each test to reset the lo

#### Defined in

[src/types/testing.ts:156](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L156)
[src/types/testing.ts:190](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L190)

___

Expand All @@ -53,7 +53,7 @@ Testing framework agnostic handler method to run before each test to prepare the

#### Defined in

[src/types/testing.ts:152](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L152)
[src/types/testing.ts:186](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L186)

## Accessors

Expand All @@ -69,4 +69,4 @@ The test logger instance for the current test

#### Defined in

[src/types/testing.ts:148](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L148)
[src/types/testing.ts:182](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L182)
8 changes: 4 additions & 4 deletions docs/code/interfaces/types_testing.AlgorandFixture.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Testing framework agnostic handler method to run before each test to prepare the

#### Defined in

[src/types/testing.ts:88](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L88)
[src/types/testing.ts:122](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L122)

___

Expand Down Expand Up @@ -95,7 +95,7 @@ describe('MY MODULE', () => {

#### Defined in

[src/types/testing.ts:128](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L128)
[src/types/testing.ts:162](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L162)

## Accessors

Expand All @@ -111,7 +111,7 @@ Retrieve an `AlgorandClient` loaded with the current context, including testAcco

#### Defined in

[src/types/testing.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L82)
[src/types/testing.ts:116](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L116)

___

Expand All @@ -138,4 +138,4 @@ test('My test', () => {

#### Defined in

[src/types/testing.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L77)
[src/types/testing.ts:111](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L111)
16 changes: 8 additions & 8 deletions docs/code/interfaces/types_testing.AlgorandFixtureConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ Configuration for creating an Algorand testing fixture.

### accountGetter

• `Optional` **accountGetter**: (`algod`: `AlgodClient`, `kmd?`: `KmdClient`) => `Promise`\<\{ `addr`: `Readonly`\<[`Address`](../classes/index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner` }\>
• `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 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`\<\{ `addr`: `Readonly`\<[`Address`](../classes/index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner` }\>
▸ (`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` } }\>

##### Parameters

Expand All @@ -46,11 +46,11 @@ Optional override for how to get an account; this allows you to retrieve account

##### Returns

`Promise`\<\{ `addr`: `Readonly`\<[`Address`](../classes/index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner` }\>
`Promise`\<[`Address`](../classes/index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: \{ `addr`: `Readonly`\<[`Address`](../classes/index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner` } }\>

#### Defined in

[src/types/testing.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L60)
[src/types/testing.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L80)

___

Expand All @@ -62,7 +62,7 @@ An optional algod client, if not specified then it will create one against `algo

#### 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:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L72)

___

Expand Down Expand Up @@ -90,7 +90,7 @@ An optional indexer client, if not specified then it will create one against `in

#### 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:74](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L74)

___

Expand Down Expand Up @@ -118,7 +118,7 @@ An optional kmd client, if not specified then it will create one against `kmdCon

#### Defined in

[src/types/testing.ts:56](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L56)
[src/types/testing.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L76)

___

Expand Down Expand Up @@ -146,4 +146,4 @@ The amount of funds to allocate to the default testing account, if not specified

#### Defined in

[src/types/testing.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L58)
[src/types/testing.ts:78](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L78)
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Algod client instance that will log transactions in `transactionLogger`

#### Defined in

[src/types/testing.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L20)
[src/types/testing.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L29)

___

Expand All @@ -42,7 +42,7 @@ An AlgorandClient instance loaded with the current context, including testAccoun

#### Defined in

[src/types/testing.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L18)
[src/types/testing.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L27)

___

Expand All @@ -68,7 +68,7 @@ Generate and fund an additional ephemerally created account

#### Defined in

[src/types/testing.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L30)
[src/types/testing.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L39)

___

Expand All @@ -80,7 +80,7 @@ Indexer client instance

#### Defined in

[src/types/testing.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L22)
[src/types/testing.ts:31](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L31)

___

Expand All @@ -92,7 +92,7 @@ KMD client instance

#### Defined in

[src/types/testing.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L24)
[src/types/testing.ts:33](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L33)

___

Expand All @@ -104,7 +104,7 @@ Default, funded test account that is ephemerally created

#### Defined in

[src/types/testing.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L28)
[src/types/testing.ts:37](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L37)

___

Expand All @@ -116,7 +116,7 @@ Transaction logger that will log transaction IDs for all transactions issued by

#### Defined in

[src/types/testing.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L26)
[src/types/testing.ts:35](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L35)

___

Expand All @@ -136,7 +136,7 @@ Wait for the indexer to catch up with all transactions logged by `transactionLog

#### Defined in

[src/types/testing.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L32)
[src/types/testing.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L41)

___

Expand All @@ -162,4 +162,4 @@ Wait for the indexer to catch up with the given transaction ID

#### Defined in

[src/types/testing.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L34)
[src/types/testing.ts:43](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L43)
12 changes: 6 additions & 6 deletions docs/code/interfaces/types_testing.GetTestAccountParams.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ Parameters for the `getTestAccount` function.

### accountGetter

• `Optional` **accountGetter**: (`algorand`: [`AlgorandClient`](../classes/types_algorand_client.AlgorandClient.md)) => `Promise`\<\{ `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) & `AddressWithTransactionSigner` & \{ `account`: \{ `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`\<\{ `addr`: `Readonly`\<[`Address`](../classes/index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner` }\>
▸ (`algorand`): `Promise`\<[`Address`](../classes/index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: \{ `addr`: `Readonly`\<[`Address`](../classes/index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner` } }\>

##### Parameters

Expand All @@ -34,11 +34,11 @@ Optional override for how to get a test account; this allows you to retrieve acc

##### Returns

`Promise`\<\{ `addr`: `Readonly`\<[`Address`](../classes/index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner` }\>
`Promise`\<[`Address`](../classes/index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: \{ `addr`: `Readonly`\<[`Address`](../classes/index.Address.md)\> ; `lsigSigner`: `DelegatedLsigSigner` ; `mxBytesSigner`: `MxBytesSigner` ; `programDataSigner`: `ProgramDataSigner` ; `signer`: `TransactionSigner` } }\>

#### Defined in

[src/types/testing.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L46)
[src/types/testing.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L55)

___

Expand All @@ -50,7 +50,7 @@ Initial funds to ensure the account has

#### Defined in

[src/types/testing.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L42)
[src/types/testing.ts:51](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L51)

___

Expand All @@ -62,4 +62,4 @@ Whether to suppress the log (which includes a mnemonic) or not (default: do not

#### Defined in

[src/types/testing.ts:44](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L44)
[src/types/testing.ts:53](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L53)
8 changes: 4 additions & 4 deletions docs/code/interfaces/types_testing.LogSnapshotConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Any accounts/addresses to replace the address for predictably

#### Defined in

[src/types/testing.ts:139](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L139)
[src/types/testing.ts:173](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L173)

___

Expand All @@ -39,7 +39,7 @@ Any app IDs to replace predictably

#### Defined in

[src/types/testing.ts:141](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L141)
[src/types/testing.ts:175](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L175)

___

Expand All @@ -65,7 +65,7 @@ Optional filter predicate to filter out logs

#### Defined in

[src/types/testing.ts:143](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L143)
[src/types/testing.ts:177](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L177)

___

Expand All @@ -77,4 +77,4 @@ Any transaction IDs or transactions to replace the ID for predictably

#### Defined in

[src/types/testing.ts:137](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L137)
[src/types/testing.ts:171](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/testing.ts#L171)
4 changes: 2 additions & 2 deletions docs/code/modules/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ Note: By default this will log the mnemonic of the account.

#### Defined in

[src/testing/account.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/account.ts#L20)
[src/testing/account.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/account.ts#L23)

▸ **getTestAccount**(`params`, `algorand`): `Promise`\<[`Address`](../classes/index.Address.md) & `AddressWithSigners`\>

Expand All @@ -202,7 +202,7 @@ The account, with private key loaded

#### Defined in

[src/testing/account.ts:34](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/account.ts#L34)
[src/testing/account.ts:37](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/account.ts#L37)

___

Expand Down
4 changes: 2 additions & 2 deletions packages/transact/src/logicsig.spec.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { encodeMsgpack } from '@algorandfoundation/algokit-common'
import { Address, encodeMsgpack } from '@algorandfoundation/algokit-common'
import { describe, expect, test } from 'vitest'
import { LogicSigAccount } from './logicsig'
import { LogicSignature } from './transactions/signed-transaction'
Expand All @@ -15,7 +15,7 @@ describe('logicsig', () => {
} satisfies LogicSignature
const encoded = encodeMsgpack(logicSignatureCodec.encode(logicSignature, 'msgpack'))

const decoded = LogicSigAccount.fromBytes(encoded)
const decoded = LogicSigAccount.fromBytes(encoded, Address.zeroAddress())

expect(decoded.logic).toEqual(logicSignature.logic)
expect(decoded.sig).toEqual(signature)
Expand Down
Loading