Skip to content

Commit 7c4c6f4

Browse files
authored
feat!: remove Account class (#476)
* feat: optional sendingAddress for generateAddressWithSigners * feat!: remove Account class * chore: lint and docs
1 parent dfd8229 commit 7c4c6f4

28 files changed

+234
-461
lines changed

docs/code/classes/types_account.SigningAccount.md

Lines changed: 0 additions & 153 deletions
This file was deleted.

docs/code/classes/types_account_manager.AccountManager.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -185,13 +185,13 @@ ___
185185

186186
#### Defined in
187187

188-
[src/types/account-manager.ts:532](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L532)
188+
[src/types/account-manager.ts:546](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L546)
189189

190190
___
191191

192192
### dispenserFromEnvironment
193193

194-
**dispenserFromEnvironment**(): `Promise`\<[`Address`](index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\>
194+
**dispenserFromEnvironment**(): `Promise`\<`AddressWithTransactionSigner`\>
195195

196196
Returns an account (with private key loaded) that can act as a dispenser from
197197
environment variables, or against default LocalNet if no environment variables present.
@@ -203,7 +203,7 @@ process.env.DISPENSER_SENDER if it's a rekeyed account.
203203

204204
#### Returns
205205

206-
`Promise`\<[`Address`](index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\>
206+
`Promise`\<`AddressWithTransactionSigner`\>
207207

208208
The account
209209

@@ -215,7 +215,7 @@ const account = await accountManager.dispenserFromEnvironment()
215215

216216
#### Defined in
217217

218-
[src/types/account-manager.ts:445](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L445)
218+
[src/types/account-manager.ts:459](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L459)
219219

220220
___
221221

@@ -258,7 +258,7 @@ await accountManager.ensureFunded("ACCOUNTADDRESS", "DISPENSERADDRESS", algokit.
258258

259259
#### Defined in
260260

261-
[src/types/account-manager.ts:565](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L565)
261+
[src/types/account-manager.ts:579](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L579)
262262

263263
___
264264

@@ -307,7 +307,7 @@ await accountManager.ensureFundedFromEnvironment("ACCOUNTADDRESS", algokit.algo(
307307

308308
#### Defined in
309309

310-
[src/types/account-manager.ts:627](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L627)
310+
[src/types/account-manager.ts:641](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L641)
311311

312312
___
313313

@@ -351,13 +351,13 @@ await accountManager.ensureFundedFromTestNetDispenserApi("ACCOUNTADDRESS", algor
351351

352352
#### Defined in
353353

354-
[src/types/account-manager.ts:683](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L683)
354+
[src/types/account-manager.ts:697](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L697)
355355

356356
___
357357

358358
### fromEnvironment
359359

360-
**fromEnvironment**(`name`, `fundWith?`): `Promise`\<[`Address`](index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\>
360+
**fromEnvironment**(`name`, `fundWith?`): `Promise`\<`AddressWithTransactionSigner`\>
361361

362362
Tracks and returns an Algorand account with private key loaded by convention from environment variables based on the given name identifier.
363363

@@ -380,7 +380,7 @@ This allows you to write code that will work seamlessly in production and local
380380

381381
#### Returns
382382

383-
`Promise`\<[`Address`](index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\>
383+
`Promise`\<`AddressWithTransactionSigner`\>
384384

385385
The account
386386

@@ -396,13 +396,13 @@ If not running against LocalNet then it will use proces.env.MY_ACCOUNT_MNEMONIC
396396

397397
#### Defined in
398398

399-
[src/types/account-manager.ts:338](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L338)
399+
[src/types/account-manager.ts:348](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L348)
400400

401401
___
402402

403403
### fromKmd
404404

405-
**fromKmd**(`name`, `predicate?`, `sender?`): `Promise`\<[`Address`](index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\>
405+
**fromKmd**(`name`, `predicate?`, `sender?`): `Promise`\<[`Address`](index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: `AddressWithTransactionSigner` }\>
406406

407407
Tracks and returns an Algorand account with private key loaded from the given KMD wallet (identified by name).
408408

@@ -416,7 +416,7 @@ Tracks and returns an Algorand account with private key loaded from the given KM
416416

417417
#### Returns
418418

419-
`Promise`\<[`Address`](index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\>
419+
`Promise`\<[`Address`](index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: `AddressWithTransactionSigner` }\>
420420

421421
The account
422422

@@ -430,13 +430,13 @@ const defaultDispenserAccount = await accountManager.fromKmd('unencrypted-defaul
430430

431431
#### Defined in
432432

433-
[src/types/account-manager.ts:374](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L374)
433+
[src/types/account-manager.ts:383](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L383)
434434

435435
___
436436

437437
### fromMnemonic
438438

439-
**fromMnemonic**(`mnemonicSecret`, `sender?`): [`Address`](index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }
439+
**fromMnemonic**(`mnemonicSecret`, `sender?`): `AddressWithTransactionSigner`
440440

441441
Tracks and returns an Algorand account with secret key loaded (i.e. that can sign transactions) by taking the mnemonic secret.
442442

@@ -449,7 +449,7 @@ Tracks and returns an Algorand account with secret key loaded (i.e. that can sig
449449

450450
#### Returns
451451

452-
[`Address`](index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }
452+
`AddressWithTransactionSigner`
453453

454454
The account
455455

@@ -569,13 +569,13 @@ ___
569569

570570
### localNetDispenser
571571

572-
**localNetDispenser**(): `Promise`\<[`Address`](index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\>
572+
**localNetDispenser**(): `Promise`\<[`Address`](index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: `AddressWithTransactionSigner` }\>
573573

574574
Returns an Algorand account with private key loaded for the default LocalNet dispenser account (that can be used to fund other accounts).
575575

576576
#### Returns
577577

578-
`Promise`\<[`Address`](index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: [`SigningAccount`](types_account.SigningAccount.md) }\>
578+
`Promise`\<[`Address`](index.Address.md) & `AddressWithTransactionSigner` & \{ `account`: `AddressWithTransactionSigner` }\>
579579

580580
The account
581581

@@ -587,7 +587,7 @@ const account = await accountManager.localNetDispenser()
587587

588588
#### Defined in
589589

590-
[src/types/account-manager.ts:464](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L464)
590+
[src/types/account-manager.ts:478](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L478)
591591

592592
___
593593

@@ -618,7 +618,7 @@ const account = accountManager.logicsig(program, [new Uint8Array(3, ...)])
618618

619619
#### Defined in
620620

621-
[src/types/account-manager.ts:412](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L412)
621+
[src/types/account-manager.ts:421](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L421)
622622

623623
___
624624

@@ -650,19 +650,19 @@ const account = accountManager.multisig({version: 1, threshold: 1, addrs: ["ADDR
650650

651651
#### Defined in
652652

653-
[src/types/account-manager.ts:397](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L397)
653+
[src/types/account-manager.ts:406](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L406)
654654

655655
___
656656

657657
### random
658658

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

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

663663
#### Returns
664664

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

667667
The account
668668

@@ -674,7 +674,7 @@ const account = accountManager.random()
674674

675675
#### Defined in
676676

677-
[src/types/account-manager.ts:425](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L425)
677+
[src/types/account-manager.ts:434](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L434)
678678

679679
___
680680

@@ -734,7 +734,7 @@ await accountManager.rekeyAccount({
734734

735735
#### Defined in
736736

737-
[src/types/account-manager.ts:507](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L507)
737+
[src/types/account-manager.ts:521](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L521)
738738

739739
___
740740

@@ -766,7 +766,7 @@ const rekeyedAccount = accountManager.rekeyed(account, "SENDERADDRESS...")
766766

767767
#### Defined in
768768

769-
[src/types/account-manager.ts:307](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L307)
769+
[src/types/account-manager.ts:317](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account-manager.ts#L317)
770770

771771
___
772772

@@ -852,7 +852,7 @@ Note: If you are generating accounts via the various methods on `AccountManager`
852852

853853
| Name | Type | Description |
854854
| :------ | :------ | :------ |
855-
| `account` | `MultisigAccount` \| `AddressWithTransactionSigner` \| `LogicSigAccount` \| `default` \| [`SigningAccount`](types_account.SigningAccount.md) | The account to register, which can be a `AddressWithSigner` or a `algosdk.Account`, `algosdk.LogicSigAccount`, `SigningAccount` or `MultisigAccount` |
855+
| `account` | `MultisigAccount` \| `AddressWithTransactionSigner` \| `LogicSigAccount` | The account to register, which can be a `AddressWithSigner` or a `algosdk.Account`, `algosdk.LogicSigAccount`, `SigningAccount` or `MultisigAccount` |
856856

857857
#### Returns
858858

@@ -921,7 +921,7 @@ retrieval and returns a `AddressWithSigner` along with the original account in a
921921

922922
| Name | Type |
923923
| :------ | :------ |
924-
| `T` | extends `MultisigAccount` \| `AddressWithTransactionSigner` \| `LogicSigAccount` \| `default` \| [`SigningAccount`](types_account.SigningAccount.md) |
924+
| `T` | extends `MultisigAccount` \| `AddressWithTransactionSigner` \| `LogicSigAccount` |
925925

926926
#### Parameters
927927

0 commit comments

Comments
 (0)