Skip to content

Commit 45676a3

Browse files
authored
feat: algokit-crypto (#521)
* feat!: algokit-crypto THis introduces a breaking change to AccountManager ctor * feat: xHD support in algokit-crypto * feat: hd verify * feat: rm pubkey from verifier * feat: raw verifier and bytesForSigning * test: full example xHD mx bytes flow * chore: reorg code * chore: split out crypto files * chore: switch from js-sha512 to @noble/hashes * chore: rm unused Promise * docs: generate docs * chore: lint:fix * chore: use npm package for xHD * chore: don't spread to avoid passing sk * chore: remove newSeedBytes variable * chore: add crypto to rolldown
1 parent fe9cfe8 commit 45676a3

24 files changed

+922
-141
lines changed

docs/code/classes/index.Address.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Create a new Address object from its binary form.
4545

4646
#### Defined in
4747

48-
[packages/common/src/address.ts:59](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/packages/common/src/address.ts#L59)
48+
[packages/common/src/address.ts:55](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/packages/common/src/address.ts#L55)
4949

5050
## Properties
5151

@@ -55,7 +55,7 @@ Create a new Address object from its binary form.
5555

5656
#### Defined in
5757

58-
[packages/common/src/address.ts:53](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/packages/common/src/address.ts#L53)
58+
[packages/common/src/address.ts:49](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/packages/common/src/address.ts#L49)
5959

6060
___
6161

@@ -67,7 +67,7 @@ The binary form of the address. For standard accounts, this is the public key.
6767

6868
#### Defined in
6969

70-
[packages/common/src/address.ts:50](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/packages/common/src/address.ts#L50)
70+
[packages/common/src/address.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/packages/common/src/address.ts#L46)
7171

7272
## Methods
7373

@@ -83,7 +83,7 @@ Compute the 4 byte checksum of the address.
8383

8484
#### Defined in
8585

86-
[packages/common/src/address.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/packages/common/src/address.ts#L76)
86+
[packages/common/src/address.ts:72](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/packages/common/src/address.ts#L72)
8787

8888
___
8989

@@ -105,7 +105,7 @@ Check if the address is equal to another address.
105105

106106
#### Defined in
107107

108-
[packages/common/src/address.ts:69](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/packages/common/src/address.ts#L69)
108+
[packages/common/src/address.ts:65](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/packages/common/src/address.ts#L65)
109109

110110
___
111111

@@ -121,7 +121,7 @@ Encode the address into a string form.
121121

122122
#### Defined in
123123

124-
[packages/common/src/address.ts:83](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/packages/common/src/address.ts#L83)
124+
[packages/common/src/address.ts:79](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/packages/common/src/address.ts#L79)
125125

126126
___
127127

@@ -145,7 +145,7 @@ An Address object corresponding to the input string.
145145

146146
#### Defined in
147147

148-
[packages/common/src/address.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/packages/common/src/address.ts#L93)
148+
[packages/common/src/address.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/packages/common/src/address.ts#L89)
149149

150150
___
151151

@@ -161,4 +161,4 @@ Get the zero address.
161161

162162
#### Defined in
163163

164-
[packages/common/src/address.ts:117](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/packages/common/src/address.ts#L117)
164+
[packages/common/src/address.ts:113](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/packages/common/src/address.ts#L113)

docs/code/classes/index.AlgorandClient.md

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -66,15 +66,15 @@ A client that brokers easy access to Algorand functionality.
6666

6767
| Name | Type |
6868
| :------ | :------ |
69-
| `config` | `AlgoConfig` \| `AlgoSdkClients` |
69+
| `config` | `AlgoConfig` \| `AlgoSdkClients` & `Partial`\<`AccountManagerConfig`\> |
7070

7171
#### Returns
7272

7373
[`AlgorandClient`](index.AlgorandClient.md)
7474

7575
#### Defined in
7676

77-
[src/algorand-client.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L39)
77+
[src/algorand-client.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L41)
7878

7979
## Properties
8080

@@ -84,7 +84,7 @@ A client that brokers easy access to Algorand functionality.
8484

8585
#### Defined in
8686

87-
[src/algorand-client.ts:19](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L19)
87+
[src/algorand-client.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L21)
8888

8989
___
9090

@@ -94,7 +94,7 @@ ___
9494

9595
#### Defined in
9696

97-
[src/algorand-client.ts:21](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L21)
97+
[src/algorand-client.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L23)
9898

9999
___
100100

@@ -104,7 +104,7 @@ ___
104104

105105
#### Defined in
106106

107-
[src/algorand-client.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L20)
107+
[src/algorand-client.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L22)
108108

109109
___
110110

@@ -114,7 +114,7 @@ ___
114114

115115
#### Defined in
116116

117-
[src/algorand-client.ts:22](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L22)
117+
[src/algorand-client.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L24)
118118

119119
___
120120

@@ -137,7 +137,7 @@ ___
137137

138138
#### Defined in
139139

140-
[src/algorand-client.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L26)
140+
[src/algorand-client.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L28)
141141

142142
___
143143

@@ -147,7 +147,7 @@ ___
147147

148148
#### Defined in
149149

150-
[src/algorand-client.ts:27](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L27)
150+
[src/algorand-client.ts:29](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L29)
151151

152152
___
153153

@@ -157,7 +157,7 @@ ___
157157

158158
#### Defined in
159159

160-
[src/algorand-client.ts:28](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L28)
160+
[src/algorand-client.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L30)
161161

162162
___
163163

@@ -167,7 +167,7 @@ ___
167167

168168
#### Defined in
169169

170-
[src/algorand-client.ts:18](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L18)
170+
[src/algorand-client.ts:20](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L20)
171171

172172
___
173173

@@ -177,7 +177,7 @@ ___
177177

178178
#### Defined in
179179

180-
[src/algorand-client.ts:30](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L30)
180+
[src/algorand-client.ts:32](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L32)
181181

182182
___
183183

@@ -191,7 +191,7 @@ error transformers from the set.
191191

192192
#### Defined in
193193

194-
[src/algorand-client.ts:37](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L37)
194+
[src/algorand-client.ts:39](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L39)
195195

196196
___
197197

@@ -201,7 +201,7 @@ ___
201201

202202
#### Defined in
203203

204-
[src/algorand-client.ts:24](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L24)
204+
[src/algorand-client.ts:26](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L26)
205205

206206
___
207207

@@ -211,7 +211,7 @@ ___
211211

212212
#### Defined in
213213

214-
[src/algorand-client.ts:23](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L23)
214+
[src/algorand-client.ts:25](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L25)
215215

216216
## Accessors
217217

@@ -235,7 +235,7 @@ const accountManager = AlgorandClient.mainNet().account;
235235

236236
#### Defined in
237237

238-
[src/algorand-client.ts:181](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L181)
238+
[src/algorand-client.ts:183](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L183)
239239

240240
___
241241

@@ -259,7 +259,7 @@ const appManager = AlgorandClient.mainNet().app;
259259

260260
#### Defined in
261261

262-
[src/algorand-client.ts:201](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L201)
262+
[src/algorand-client.ts:203](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L203)
263263

264264
___
265265

@@ -283,7 +283,7 @@ const deployer = AlgorandClient.mainNet().appDeployer;
283283

284284
#### Defined in
285285

286-
[src/algorand-client.ts:211](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L211)
286+
[src/algorand-client.ts:213](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L213)
287287

288288
___
289289

@@ -307,7 +307,7 @@ const assetManager = AlgorandClient.mainNet().asset;
307307

308308
#### Defined in
309309

310-
[src/algorand-client.ts:191](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L191)
310+
[src/algorand-client.ts:193](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L193)
311311

312312
___
313313

@@ -331,7 +331,7 @@ const clientManager = AlgorandClient.mainNet().client;
331331

332332
#### Defined in
333333

334-
[src/algorand-client.ts:171](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L171)
334+
[src/algorand-client.ts:173](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L173)
335335

336336
___
337337

@@ -359,7 +359,7 @@ const payment = await AlgorandClient.mainNet().createTransaction.payment({
359359

360360
#### Defined in
361361

362-
[src/algorand-client.ts:269](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L269)
362+
[src/algorand-client.ts:271](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L271)
363363

364364
___
365365

@@ -387,7 +387,7 @@ const result = await AlgorandClient.mainNet().send.payment({
387387

388388
#### Defined in
389389

390-
[src/algorand-client.ts:255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L255)
390+
[src/algorand-client.ts:257](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L257)
391391

392392
## Methods
393393

@@ -411,7 +411,7 @@ const params = await AlgorandClient.mainNet().getSuggestedParams();
411411

412412
#### Defined in
413413

414-
[src/algorand-client.ts:150](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L150)
414+
[src/algorand-client.ts:152](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L152)
415415

416416
___
417417

@@ -442,7 +442,7 @@ const result = await composer.addTransaction(payment).send()
442442

443443
#### Defined in
444444

445-
[src/algorand-client.ts:233](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L233)
445+
[src/algorand-client.ts:235](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L235)
446446

447447
___
448448

@@ -465,7 +465,7 @@ composed transaction groups made from `newGroup`
465465

466466
#### Defined in
467467

468-
[src/algorand-client.ts:219](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L219)
468+
[src/algorand-client.ts:221](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L221)
469469

470470
___
471471

@@ -496,7 +496,7 @@ const algorand = AlgorandClient.mainNet().setDefaultSigner(signer)
496496

497497
#### Defined in
498498

499-
[src/algorand-client.ts:73](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L73)
499+
[src/algorand-client.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L75)
500500

501501
___
502502

@@ -526,7 +526,7 @@ const algorand = AlgorandClient.mainNet().setDefaultValidityWindow(1000);
526526

527527
#### Defined in
528528

529-
[src/algorand-client.ts:58](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L58)
529+
[src/algorand-client.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L60)
530530

531531
___
532532

@@ -558,7 +558,7 @@ const algorand = AlgorandClient.mainNet().setSigner(signer.addr, signer.signer)
558558

559559
#### Defined in
560560

561-
[src/algorand-client.ts:109](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L109)
561+
[src/algorand-client.ts:111](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L111)
562562

563563
___
564564

@@ -593,7 +593,7 @@ const accountManager = AlgorandClient.mainNet()
593593

594594
#### Defined in
595595

596-
[src/algorand-client.ts:93](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L93)
596+
[src/algorand-client.ts:95](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L95)
597597

598598
___
599599

@@ -632,7 +632,7 @@ const algorand = AlgorandClient.mainNet().setSuggestedParamsCache(suggestedParam
632632

633633
#### Defined in
634634

635-
[src/algorand-client.ts:124](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L124)
635+
[src/algorand-client.ts:126](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L126)
636636

637637
___
638638

@@ -662,7 +662,7 @@ const algorand = AlgorandClient.mainNet().setSuggestedParamsCacheTimeout(10_000)
662662

663663
#### Defined in
664664

665-
[src/algorand-client.ts:139](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L139)
665+
[src/algorand-client.ts:141](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L141)
666666

667667
___
668668

@@ -682,7 +682,7 @@ ___
682682

683683
#### Defined in
684684

685-
[src/algorand-client.ts:223](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L223)
685+
[src/algorand-client.ts:225](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L225)
686686

687687
___
688688

@@ -706,7 +706,7 @@ const algorand = AlgorandClient.defaultLocalNet();
706706

707707
#### Defined in
708708

709-
[src/algorand-client.ts:281](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L281)
709+
[src/algorand-client.ts:283](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L283)
710710

711711
___
712712

@@ -736,7 +736,7 @@ const algorand = AlgorandClient.fromClients({ algod, indexer, kmd });
736736

737737
#### Defined in
738738

739-
[src/algorand-client.ts:324](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L324)
739+
[src/algorand-client.ts:326](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L326)
740740

741741
___
742742

@@ -766,7 +766,7 @@ const client = AlgorandClient.fromConfig({ algodConfig, indexerConfig, kmdConfig
766766

767767
#### Defined in
768768

769-
[src/algorand-client.ts:358](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L358)
769+
[src/algorand-client.ts:360](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L360)
770770

771771
___
772772

@@ -803,7 +803,7 @@ const client = AlgorandClient.fromEnvironment();
803803

804804
#### Defined in
805805

806-
[src/algorand-client.ts:347](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L347)
806+
[src/algorand-client.ts:349](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L349)
807807

808808
___
809809

@@ -827,7 +827,7 @@ const algorand = AlgorandClient.mainNet();
827827

828828
#### Defined in
829829

830-
[src/algorand-client.ts:309](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L309)
830+
[src/algorand-client.ts:311](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L311)
831831

832832
___
833833

@@ -851,4 +851,4 @@ const algorand = AlgorandClient.testNet();
851851

852852
#### Defined in
853853

854-
[src/algorand-client.ts:295](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L295)
854+
[src/algorand-client.ts:297](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/algorand-client.ts#L297)

0 commit comments

Comments
 (0)