@walletmesh/aztec-rpc-wallet 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/.tsbuildinfo +1 -1
  3. package/dist/aztecRemoteWallet.d.ts +4 -8
  4. package/dist/aztecRemoteWallet.d.ts.map +1 -1
  5. package/dist/aztecRemoteWallet.js +5 -29
  6. package/dist/contractArtifactCache.d.ts.map +1 -1
  7. package/dist/contractArtifactCache.js +20 -9
  8. package/dist/handlers/aztecAccountWallet.d.ts.map +1 -1
  9. package/dist/handlers/aztecAccountWallet.js +11 -44
  10. package/dist/serializers/account.d.ts +16 -16
  11. package/dist/serializers/account.d.ts.map +1 -1
  12. package/dist/serializers/account.js +43 -43
  13. package/dist/serializers/contract.d.ts +22 -76
  14. package/dist/serializers/contract.d.ts.map +1 -1
  15. package/dist/serializers/contract.js +68 -120
  16. package/dist/serializers/index.d.ts +0 -4
  17. package/dist/serializers/index.d.ts.map +1 -1
  18. package/dist/serializers/index.js +15 -20
  19. package/dist/serializers/log.d.ts +16 -16
  20. package/dist/serializers/log.d.ts.map +1 -1
  21. package/dist/serializers/log.js +43 -43
  22. package/dist/serializers/note.d.ts +12 -12
  23. package/dist/serializers/note.d.ts.map +1 -1
  24. package/dist/serializers/note.js +32 -32
  25. package/dist/serializers/transaction.d.ts +25 -26
  26. package/dist/serializers/transaction.d.ts.map +1 -1
  27. package/dist/serializers/transaction.js +92 -44
  28. package/dist/types.d.ts +7 -30
  29. package/dist/types.d.ts.map +1 -1
  30. package/dist/types.js +1 -1
  31. package/docs/README.md +264 -0
  32. package/docs/classes/AztecChainProvider.md +553 -0
  33. package/docs/classes/AztecChainWallet.md +409 -0
  34. package/docs/classes/AztecProvider.md +1112 -0
  35. package/docs/classes/AztecWalletError.md +213 -0
  36. package/docs/classes/ContractArtifactCache.md +81 -0
  37. package/docs/globals.md +34 -0
  38. package/docs/interfaces/AztecWalletBaseMethodMap.md +135 -0
  39. package/docs/interfaces/AztecWalletEventMap.md +17 -0
  40. package/docs/interfaces/AztecWalletMethodMap.md +1012 -0
  41. package/docs/type-aliases/AztecChainId.md +11 -0
  42. package/docs/type-aliases/AztecChainWalletMiddleware.md +13 -0
  43. package/docs/type-aliases/AztecWalletContext.md +29 -0
  44. package/docs/type-aliases/AztecWalletMethodHandler.md +37 -0
  45. package/docs/type-aliases/AztecWalletMiddleware.md +13 -0
  46. package/docs/type-aliases/AztecWalletRouterClient.md +13 -0
  47. package/docs/type-aliases/TransactionFunctionCall.md +33 -0
  48. package/docs/type-aliases/TransactionParams.md +27 -0
  49. package/docs/variables/AztecWalletErrorMap.md +13 -0
  50. package/package.json +9 -9
  51. package/src/aztecRemoteWallet.test.ts +22 -61
  52. package/src/aztecRemoteWallet.ts +8 -35
  53. package/src/chainProvider.test.ts +117 -38
  54. package/src/contractArtifactCache.test.ts +28 -45
  55. package/src/contractArtifactCache.ts +20 -10
  56. package/src/handlers/aztecAccountWallet.test.ts +12 -86
  57. package/src/handlers/aztecAccountWallet.ts +19 -77
  58. package/src/provider.test.ts +0 -2
  59. package/src/serializers/account.test.ts +19 -20
  60. package/src/serializers/account.ts +52 -52
  61. package/src/serializers/contract.test.ts +4 -140
  62. package/src/serializers/contract.ts +93 -166
  63. package/src/serializers/index.test.ts +30 -28
  64. package/src/serializers/index.ts +15 -21
  65. package/src/serializers/log.test.ts +42 -48
  66. package/src/serializers/log.ts +54 -54
  67. package/src/serializers/note.test.ts +43 -16
  68. package/src/serializers/note.ts +39 -39
  69. package/src/serializers/transaction.test.ts +48 -41
  70. package/src/serializers/transaction.ts +146 -58
  71. package/src/types.ts +7 -7
  72. package/src/wallet.test.ts +3 -3
  73. package/dist/serializers/transaction-utils.d.ts +0 -51
  74. package/dist/serializers/transaction-utils.d.ts.map +0 -1
  75. package/dist/serializers/transaction-utils.js +0 -103
  76. package/src/serializers/transaction-utils.ts +0 -174
@@ -0,0 +1,553 @@
1
+ [**@walletmesh/aztec-rpc-wallet v0.3.0**](../README.md)
2
+
3
+ ***
4
+
5
+ [@walletmesh/aztec-rpc-wallet](../globals.md) / AztecChainProvider
6
+
7
+ # Class: AztecChainProvider
8
+
9
+ Defined in: [aztec/rpc-wallet/src/chainProvider.ts:11](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/chainProvider.ts#L11)
10
+
11
+ Provider for directly interacting with an Aztec chain wallet.
12
+ This is a minimal implementation that supports core Aztec operations
13
+ without the complexity of multi-chain routing.
14
+
15
+ ## Extends
16
+
17
+ - `JSONRPCNode`\<[`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md)\>
18
+
19
+ ## Constructors
20
+
21
+ ### new AztecChainProvider()
22
+
23
+ > **new AztecChainProvider**(`transport`, `context`?): [`AztecChainProvider`](AztecChainProvider.md)
24
+
25
+ Defined in: core/jsonrpc/dist/node.d.ts:12
26
+
27
+ #### Parameters
28
+
29
+ ##### transport
30
+
31
+ `JSONRPCTransport`
32
+
33
+ ##### context?
34
+
35
+ `JSONRPCContext`
36
+
37
+ #### Returns
38
+
39
+ [`AztecChainProvider`](AztecChainProvider.md)
40
+
41
+ #### Inherited from
42
+
43
+ `JSONRPCNode<AztecWalletMethodMap>.constructor`
44
+
45
+ ## Properties
46
+
47
+ ### context
48
+
49
+ > `readonly` **context**: `JSONRPCContext`
50
+
51
+ Defined in: core/jsonrpc/dist/node.d.ts:4
52
+
53
+ #### Inherited from
54
+
55
+ `JSONRPCNode.context`
56
+
57
+ ## Methods
58
+
59
+ ### addMiddleware()
60
+
61
+ > **addMiddleware**(`middleware`): () => `void`
62
+
63
+ Defined in: core/jsonrpc/dist/node.d.ts:19
64
+
65
+ #### Parameters
66
+
67
+ ##### middleware
68
+
69
+ `JSONRPCMiddleware`\<[`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md), `JSONRPCContext`\>
70
+
71
+ #### Returns
72
+
73
+ `Function`
74
+
75
+ ##### Returns
76
+
77
+ `void`
78
+
79
+ #### Inherited from
80
+
81
+ `JSONRPCNode.addMiddleware`
82
+
83
+ ***
84
+
85
+ ### callMethod()
86
+
87
+ > **callMethod**\<`M`\>(`method`, `params`?, `timeoutInSeconds`?): `Promise`\<[`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md)\[`M`\]\[`"result"`\]\>
88
+
89
+ Defined in: core/jsonrpc/dist/node.d.ts:15
90
+
91
+ #### Type Parameters
92
+
93
+ • **M** *extends* keyof [`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md)
94
+
95
+ #### Parameters
96
+
97
+ ##### method
98
+
99
+ `M`
100
+
101
+ ##### params?
102
+
103
+ [`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md)\[`M`\]\[`"params"`\]
104
+
105
+ ##### timeoutInSeconds?
106
+
107
+ `number`
108
+
109
+ #### Returns
110
+
111
+ `Promise`\<[`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md)\[`M`\]\[`"result"`\]\>
112
+
113
+ #### Inherited from
114
+
115
+ `JSONRPCNode.callMethod`
116
+
117
+ ***
118
+
119
+ ### close()
120
+
121
+ > **close**(): `Promise`\<`void`\>
122
+
123
+ Defined in: core/jsonrpc/dist/node.d.ts:25
124
+
125
+ #### Returns
126
+
127
+ `Promise`\<`void`\>
128
+
129
+ #### Inherited from
130
+
131
+ `JSONRPCNode.close`
132
+
133
+ ***
134
+
135
+ ### connect()
136
+
137
+ > **connect**(): `Promise`\<`boolean`\>
138
+
139
+ Defined in: [aztec/rpc-wallet/src/chainProvider.ts:26](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/chainProvider.ts#L26)
140
+
141
+ #### Returns
142
+
143
+ `Promise`\<`boolean`\>
144
+
145
+ ***
146
+
147
+ ### emit()
148
+
149
+ > **emit**\<`K`\>(`event`, `params`): `Promise`\<`void`\>
150
+
151
+ Defined in: core/jsonrpc/dist/node.d.ts:18
152
+
153
+ #### Type Parameters
154
+
155
+ • **K** *extends* `string` \| `number`
156
+
157
+ #### Parameters
158
+
159
+ ##### event
160
+
161
+ `K`
162
+
163
+ ##### params
164
+
165
+ `JSONRPCEventMap`\[`K`\]
166
+
167
+ #### Returns
168
+
169
+ `Promise`\<`void`\>
170
+
171
+ #### Inherited from
172
+
173
+ `JSONRPCNode.emit`
174
+
175
+ ***
176
+
177
+ ### getAccount()
178
+
179
+ > **getAccount**(): `Promise`\<`string`\>
180
+
181
+ Defined in: [aztec/rpc-wallet/src/chainProvider.ts:40](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/chainProvider.ts#L40)
182
+
183
+ Gets the account address from the wallet.
184
+
185
+ #### Returns
186
+
187
+ `Promise`\<`string`\>
188
+
189
+ The account address as a string
190
+
191
+ #### Throws
192
+
193
+ If response is invalid
194
+
195
+ ***
196
+
197
+ ### makeRequest()
198
+
199
+ > `protected` **makeRequest**\<`M`\>(`method`, `params`?): `Promise`\<[`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md)\[`M`\]\[`"result"`\]\>
200
+
201
+ Defined in: [aztec/rpc-wallet/src/chainProvider.ts:12](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/chainProvider.ts#L12)
202
+
203
+ #### Type Parameters
204
+
205
+ • **M** *extends* keyof [`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md)
206
+
207
+ #### Parameters
208
+
209
+ ##### method
210
+
211
+ `M`
212
+
213
+ ##### params?
214
+
215
+ [`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md)\[`M`\]\[`"params"`\]
216
+
217
+ #### Returns
218
+
219
+ `Promise`\<[`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md)\[`M`\]\[`"result"`\]\>
220
+
221
+ ***
222
+
223
+ ### notify()
224
+
225
+ > **notify**\<`M`\>(`method`, `params`): `Promise`\<`void`\>
226
+
227
+ Defined in: core/jsonrpc/dist/node.d.ts:16
228
+
229
+ #### Type Parameters
230
+
231
+ • **M** *extends* keyof [`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md)
232
+
233
+ #### Parameters
234
+
235
+ ##### method
236
+
237
+ `M`
238
+
239
+ ##### params
240
+
241
+ [`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md)\[`M`\]\[`"params"`\]
242
+
243
+ #### Returns
244
+
245
+ `Promise`\<`void`\>
246
+
247
+ #### Inherited from
248
+
249
+ `JSONRPCNode.notify`
250
+
251
+ ***
252
+
253
+ ### on()
254
+
255
+ > **on**\<`K`\>(`event`, `handler`): () => `void`
256
+
257
+ Defined in: core/jsonrpc/dist/node.d.ts:17
258
+
259
+ #### Type Parameters
260
+
261
+ • **K** *extends* `string` \| `number`
262
+
263
+ #### Parameters
264
+
265
+ ##### event
266
+
267
+ `K`
268
+
269
+ ##### handler
270
+
271
+ (`params`) => `void`
272
+
273
+ #### Returns
274
+
275
+ `Function`
276
+
277
+ ##### Returns
278
+
279
+ `void`
280
+
281
+ #### Inherited from
282
+
283
+ `JSONRPCNode.on`
284
+
285
+ ***
286
+
287
+ ### receiveMessage()
288
+
289
+ > **receiveMessage**(`message`): `Promise`\<`void`\>
290
+
291
+ Defined in: core/jsonrpc/dist/node.d.ts:20
292
+
293
+ #### Parameters
294
+
295
+ ##### message
296
+
297
+ `unknown`
298
+
299
+ #### Returns
300
+
301
+ `Promise`\<`void`\>
302
+
303
+ #### Inherited from
304
+
305
+ `JSONRPCNode.receiveMessage`
306
+
307
+ ***
308
+
309
+ ### registerContract()
310
+
311
+ > **registerContract**(`params`): `Promise`\<`void`\>
312
+
313
+ Defined in: [aztec/rpc-wallet/src/chainProvider.ts:81](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/chainProvider.ts#L81)
314
+
315
+ Registers a contract instance with the wallet.
316
+
317
+ #### Parameters
318
+
319
+ ##### params
320
+
321
+ Contract registration parameters
322
+
323
+ ###### artifact
324
+
325
+ `ContractArtifact`
326
+
327
+ ###### instance
328
+
329
+ `ContractInstanceWithAddress`
330
+
331
+ #### Returns
332
+
333
+ `Promise`\<`void`\>
334
+
335
+ #### Throws
336
+
337
+ If registration fails
338
+
339
+ ***
340
+
341
+ ### registerContractClass()
342
+
343
+ > **registerContractClass**(`params`): `Promise`\<`void`\>
344
+
345
+ Defined in: [aztec/rpc-wallet/src/chainProvider.ts:96](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/chainProvider.ts#L96)
346
+
347
+ Registers a contract class with the wallet.
348
+
349
+ #### Parameters
350
+
351
+ ##### params
352
+
353
+ Contract class registration parameters
354
+
355
+ ###### artifact
356
+
357
+ `ContractArtifact`
358
+
359
+ #### Returns
360
+
361
+ `Promise`\<`void`\>
362
+
363
+ #### Throws
364
+
365
+ If registration fails
366
+
367
+ ***
368
+
369
+ ### registerMethod()
370
+
371
+ > **registerMethod**\<`M`\>(`name`, `handler`): `void`
372
+
373
+ Defined in: core/jsonrpc/dist/node.d.ts:13
374
+
375
+ #### Type Parameters
376
+
377
+ • **M** *extends* keyof [`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md)
378
+
379
+ #### Parameters
380
+
381
+ ##### name
382
+
383
+ `Extract`\<`M`, `string`\>
384
+
385
+ ##### handler
386
+
387
+ (`context`, `params`) => `Promise`\<[`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md)\[`M`\]\[`"result"`\]\>
388
+
389
+ #### Returns
390
+
391
+ `void`
392
+
393
+ #### Inherited from
394
+
395
+ `JSONRPCNode.registerMethod`
396
+
397
+ ***
398
+
399
+ ### registerSender()
400
+
401
+ > **registerSender**(`params`): `Promise`\<`void`\>
402
+
403
+ Defined in: [aztec/rpc-wallet/src/chainProvider.ts:110](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/chainProvider.ts#L110)
404
+
405
+ Registers a sender with the wallet.
406
+
407
+ #### Parameters
408
+
409
+ ##### params
410
+
411
+ Sender registration parameters
412
+
413
+ ###### sender
414
+
415
+ `AztecAddress`
416
+
417
+ #### Returns
418
+
419
+ `Promise`\<`void`\>
420
+
421
+ #### Throws
422
+
423
+ If registration fails
424
+
425
+ ***
426
+
427
+ ### registerSerializer()
428
+
429
+ > **registerSerializer**\<`M`\>(`method`, `serializer`): `void`
430
+
431
+ Defined in: core/jsonrpc/dist/node.d.ts:14
432
+
433
+ #### Type Parameters
434
+
435
+ • **M** *extends* keyof [`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md)
436
+
437
+ #### Parameters
438
+
439
+ ##### method
440
+
441
+ `M`
442
+
443
+ ##### serializer
444
+
445
+ `JSONRPCSerializer`\<[`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md)\[`M`\]\[`"params"`\], [`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md)\[`M`\]\[`"result"`\]\>
446
+
447
+ #### Returns
448
+
449
+ `void`
450
+
451
+ #### Inherited from
452
+
453
+ `JSONRPCNode.registerSerializer`
454
+
455
+ ***
456
+
457
+ ### sendTransaction()
458
+
459
+ > **sendTransaction**(`params`): `Promise`\<`string`\>
460
+
461
+ Defined in: [aztec/rpc-wallet/src/chainProvider.ts:54](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/chainProvider.ts#L54)
462
+
463
+ Sends a transaction to the chain.
464
+
465
+ #### Parameters
466
+
467
+ ##### params
468
+
469
+ [`TransactionParams`](../type-aliases/TransactionParams.md)
470
+
471
+ Transaction parameters including function calls
472
+
473
+ #### Returns
474
+
475
+ `Promise`\<`string`\>
476
+
477
+ Transaction hash
478
+
479
+ #### Throws
480
+
481
+ If transaction fails or response invalid
482
+
483
+ ***
484
+
485
+ ### setFallbackHandler()
486
+
487
+ > **setFallbackHandler**(`handler`): `void`
488
+
489
+ Defined in: core/jsonrpc/dist/node.d.ts:24
490
+
491
+ #### Parameters
492
+
493
+ ##### handler
494
+
495
+ (`context`, `method`, `params`) => `Promise`\<`unknown`\>
496
+
497
+ #### Returns
498
+
499
+ `void`
500
+
501
+ #### Inherited from
502
+
503
+ `JSONRPCNode.setFallbackHandler`
504
+
505
+ ***
506
+
507
+ ### setFallbackSerializer()
508
+
509
+ > **setFallbackSerializer**(`serializer`): `void`
510
+
511
+ Defined in: core/jsonrpc/dist/node.d.ts:11
512
+
513
+ #### Parameters
514
+
515
+ ##### serializer
516
+
517
+ `JSONRPCSerializer`\<`unknown`, `unknown`\>
518
+
519
+ #### Returns
520
+
521
+ `void`
522
+
523
+ #### Inherited from
524
+
525
+ `JSONRPCNode.setFallbackSerializer`
526
+
527
+ ***
528
+
529
+ ### simulateTransaction()
530
+
531
+ > **simulateTransaction**(`params`): `Promise`\<`unknown`\>
532
+
533
+ Defined in: [aztec/rpc-wallet/src/chainProvider.ts:68](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/chainProvider.ts#L68)
534
+
535
+ Simulates a transaction without submitting it.
536
+
537
+ #### Parameters
538
+
539
+ ##### params
540
+
541
+ [`TransactionFunctionCall`](../type-aliases/TransactionFunctionCall.md)
542
+
543
+ Transaction parameters to simulate
544
+
545
+ #### Returns
546
+
547
+ `Promise`\<`unknown`\>
548
+
549
+ Simulation result
550
+
551
+ #### Throws
552
+
553
+ If simulation fails