@walletmesh/aztec-rpc-wallet 0.3.1 → 0.4.1

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 (185) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/README.md +290 -228
  3. package/dist/.tsbuildinfo +1 -1
  4. package/dist/client/aztec-dapp-wallet.d.ts +401 -0
  5. package/dist/client/aztec-dapp-wallet.d.ts.map +1 -0
  6. package/dist/client/aztec-dapp-wallet.js +705 -0
  7. package/dist/client/aztec-router-provider.d.ts +58 -0
  8. package/dist/client/aztec-router-provider.d.ts.map +1 -0
  9. package/dist/client/aztec-router-provider.js +62 -0
  10. package/dist/client/helpers.d.ts +44 -0
  11. package/dist/client/helpers.d.ts.map +1 -0
  12. package/dist/client/helpers.js +79 -0
  13. package/dist/client/register-serializers.d.ts +41 -0
  14. package/dist/client/register-serializers.d.ts.map +1 -0
  15. package/dist/client/register-serializers.js +97 -0
  16. package/dist/contractArtifactCache.d.ts +49 -32
  17. package/dist/contractArtifactCache.d.ts.map +1 -1
  18. package/dist/contractArtifactCache.js +47 -34
  19. package/dist/errors.d.ts +50 -8
  20. package/dist/errors.d.ts.map +1 -1
  21. package/dist/errors.js +50 -10
  22. package/dist/index.d.ts +53 -40
  23. package/dist/index.d.ts.map +1 -1
  24. package/dist/index.js +52 -17
  25. package/dist/types.d.ts +345 -270
  26. package/dist/types.d.ts.map +1 -1
  27. package/dist/types.js +10 -8
  28. package/dist/wallet/create-node.d.ts +73 -0
  29. package/dist/wallet/create-node.d.ts.map +1 -0
  30. package/dist/wallet/create-node.js +99 -0
  31. package/dist/wallet/handlers/account.d.ts +67 -0
  32. package/dist/wallet/handlers/account.d.ts.map +1 -0
  33. package/dist/wallet/handlers/account.js +85 -0
  34. package/dist/wallet/handlers/contract-interaction.d.ts +77 -0
  35. package/dist/wallet/handlers/contract-interaction.d.ts.map +1 -0
  36. package/dist/wallet/handlers/contract-interaction.js +219 -0
  37. package/dist/wallet/handlers/contract.d.ts +96 -0
  38. package/dist/wallet/handlers/contract.d.ts.map +1 -0
  39. package/dist/wallet/handlers/contract.js +146 -0
  40. package/dist/wallet/handlers/event.d.ts +62 -0
  41. package/dist/wallet/handlers/event.d.ts.map +1 -0
  42. package/dist/wallet/handlers/event.js +85 -0
  43. package/dist/wallet/handlers/index.d.ts +88 -0
  44. package/dist/wallet/handlers/index.d.ts.map +1 -0
  45. package/dist/wallet/handlers/index.js +47 -0
  46. package/dist/wallet/handlers/node.d.ts +117 -0
  47. package/dist/wallet/handlers/node.d.ts.map +1 -0
  48. package/dist/wallet/handlers/node.js +196 -0
  49. package/dist/wallet/handlers/senders.d.ts +70 -0
  50. package/dist/wallet/handlers/senders.d.ts.map +1 -0
  51. package/dist/wallet/handlers/senders.js +92 -0
  52. package/dist/wallet/handlers/transaction.d.ts +123 -0
  53. package/dist/wallet/handlers/transaction.d.ts.map +1 -0
  54. package/dist/wallet/handlers/transaction.js +191 -0
  55. package/dist/wallet/serializers.d.ts +75 -0
  56. package/dist/wallet/serializers.d.ts.map +1 -0
  57. package/dist/wallet/serializers.js +498 -0
  58. package/docs/README.md +290 -229
  59. package/docs/classes/AztecDappWallet.md +1304 -0
  60. package/docs/classes/AztecRouterProvider.md +1058 -0
  61. package/docs/classes/AztecWalletError.md +124 -47
  62. package/docs/classes/ContractArtifactCache.md +48 -31
  63. package/docs/functions/connectAztec.md +62 -0
  64. package/docs/functions/createAztecWallet.md +46 -0
  65. package/docs/functions/createAztecWalletNode.md +96 -0
  66. package/docs/functions/registerAztecSerializers.md +61 -0
  67. package/docs/functions/registerWalletAztecSerializers.md +39 -0
  68. package/docs/globals.md +16 -14
  69. package/docs/interfaces/AztecHandlerContext.md +54 -0
  70. package/docs/interfaces/AztecWalletContext.md +50 -0
  71. package/docs/interfaces/AztecWalletMethodMap.md +470 -477
  72. package/docs/type-aliases/AztecChainId.md +16 -3
  73. package/docs/variables/ALL_AZTEC_METHODS.md +20 -0
  74. package/docs/variables/AztecWalletErrorMap.md +9 -4
  75. package/docs/variables/AztecWalletSerializer.md +45 -0
  76. package/package.json +11 -9
  77. package/src/client/aztec-dapp-wallet.test.ts +628 -0
  78. package/src/client/aztec-dapp-wallet.ts +879 -0
  79. package/src/client/aztec-router-provider.test.ts +235 -0
  80. package/src/client/aztec-router-provider.ts +64 -0
  81. package/src/client/helpers.test.ts +187 -0
  82. package/src/client/helpers.ts +91 -0
  83. package/src/client/register-serializers.ts +108 -0
  84. package/src/contractArtifactCache.test.ts +21 -10
  85. package/src/contractArtifactCache.ts +54 -35
  86. package/src/errors.ts +58 -10
  87. package/src/index.test.ts +2 -6
  88. package/src/index.ts +73 -37
  89. package/src/types.ts +379 -217
  90. package/src/wallet/create-node.test.ts +332 -0
  91. package/src/wallet/create-node.ts +120 -0
  92. package/src/wallet/handlers/account.test.ts +172 -0
  93. package/src/wallet/handlers/account.ts +99 -0
  94. package/src/wallet/handlers/contract-interaction.test.ts +248 -0
  95. package/src/wallet/handlers/contract-interaction.ts +269 -0
  96. package/src/wallet/handlers/contract.test.ts +245 -0
  97. package/src/wallet/handlers/contract.ts +174 -0
  98. package/src/wallet/handlers/event.test.ts +216 -0
  99. package/src/wallet/handlers/event.ts +99 -0
  100. package/src/wallet/handlers/index.ts +84 -0
  101. package/src/wallet/handlers/node.test.ts +304 -0
  102. package/src/wallet/handlers/node.ts +230 -0
  103. package/src/wallet/handlers/senders.test.ts +172 -0
  104. package/src/wallet/handlers/senders.ts +106 -0
  105. package/src/wallet/handlers/transaction.test.ts +371 -0
  106. package/src/wallet/handlers/transaction.ts +239 -0
  107. package/src/wallet/serializers.test.ts +253 -0
  108. package/src/wallet/serializers.ts +584 -0
  109. package/typedoc.json +23 -1
  110. package/dist/aztecRemoteWallet.d.ts +0 -70
  111. package/dist/aztecRemoteWallet.d.ts.map +0 -1
  112. package/dist/aztecRemoteWallet.js +0 -335
  113. package/dist/chainProvider.d.ts +0 -56
  114. package/dist/chainProvider.d.ts.map +0 -1
  115. package/dist/chainProvider.js +0 -98
  116. package/dist/handlers/aztecAccountWallet.d.ts +0 -4
  117. package/dist/handlers/aztecAccountWallet.d.ts.map +0 -1
  118. package/dist/handlers/aztecAccountWallet.js +0 -295
  119. package/dist/handlers/transactions.d.ts +0 -21
  120. package/dist/handlers/transactions.d.ts.map +0 -1
  121. package/dist/handlers/transactions.js +0 -98
  122. package/dist/handlers.d.ts +0 -27
  123. package/dist/handlers.d.ts.map +0 -1
  124. package/dist/handlers.js +0 -55
  125. package/dist/provider.d.ts +0 -105
  126. package/dist/provider.d.ts.map +0 -1
  127. package/dist/provider.js +0 -160
  128. package/dist/serializers/account.d.ts +0 -164
  129. package/dist/serializers/account.d.ts.map +0 -1
  130. package/dist/serializers/account.js +0 -244
  131. package/dist/serializers/contract.d.ts +0 -62
  132. package/dist/serializers/contract.d.ts.map +0 -1
  133. package/dist/serializers/contract.js +0 -130
  134. package/dist/serializers/index.d.ts +0 -21
  135. package/dist/serializers/index.d.ts.map +0 -1
  136. package/dist/serializers/index.js +0 -154
  137. package/dist/serializers/log.d.ts +0 -66
  138. package/dist/serializers/log.d.ts.map +0 -1
  139. package/dist/serializers/log.js +0 -222
  140. package/dist/serializers/note.d.ts +0 -124
  141. package/dist/serializers/note.d.ts.map +0 -1
  142. package/dist/serializers/note.js +0 -208
  143. package/dist/serializers/transaction.d.ts +0 -99
  144. package/dist/serializers/transaction.d.ts.map +0 -1
  145. package/dist/serializers/transaction.js +0 -275
  146. package/dist/wallet.d.ts +0 -62
  147. package/dist/wallet.d.ts.map +0 -1
  148. package/dist/wallet.js +0 -77
  149. package/docs/classes/AztecChainProvider.md +0 -553
  150. package/docs/classes/AztecChainWallet.md +0 -409
  151. package/docs/classes/AztecProvider.md +0 -1112
  152. package/docs/interfaces/AztecWalletBaseMethodMap.md +0 -135
  153. package/docs/interfaces/AztecWalletEventMap.md +0 -17
  154. package/docs/type-aliases/AztecChainWalletMiddleware.md +0 -13
  155. package/docs/type-aliases/AztecWalletContext.md +0 -29
  156. package/docs/type-aliases/AztecWalletMethodHandler.md +0 -37
  157. package/docs/type-aliases/AztecWalletMiddleware.md +0 -13
  158. package/docs/type-aliases/AztecWalletRouterClient.md +0 -13
  159. package/docs/type-aliases/TransactionFunctionCall.md +0 -33
  160. package/docs/type-aliases/TransactionParams.md +0 -27
  161. package/src/aztecRemoteWallet.test.ts +0 -505
  162. package/src/aztecRemoteWallet.ts +0 -467
  163. package/src/chainProvider.test.ts +0 -401
  164. package/src/chainProvider.ts +0 -116
  165. package/src/handlers/aztecAccountWallet.test.ts +0 -650
  166. package/src/handlers/aztecAccountWallet.ts +0 -531
  167. package/src/handlers/transactions.ts +0 -124
  168. package/src/handlers.test.ts +0 -270
  169. package/src/handlers.ts +0 -70
  170. package/src/provider.test.ts +0 -277
  171. package/src/provider.ts +0 -189
  172. package/src/serializers/account.test.ts +0 -125
  173. package/src/serializers/account.ts +0 -301
  174. package/src/serializers/contract.test.ts +0 -24
  175. package/src/serializers/contract.ts +0 -183
  176. package/src/serializers/index.test.ts +0 -136
  177. package/src/serializers/index.ts +0 -191
  178. package/src/serializers/log.test.ts +0 -286
  179. package/src/serializers/log.ts +0 -292
  180. package/src/serializers/note.test.ts +0 -125
  181. package/src/serializers/note.ts +0 -250
  182. package/src/serializers/transaction.test.ts +0 -320
  183. package/src/serializers/transaction.ts +0 -409
  184. package/src/wallet.test.ts +0 -275
  185. package/src/wallet.ts +0 -94
@@ -1,135 +0,0 @@
1
- [**@walletmesh/aztec-rpc-wallet v0.3.1**](../README.md)
2
-
3
- ***
4
-
5
- [@walletmesh/aztec-rpc-wallet](../globals.md) / AztecWalletBaseMethodMap
6
-
7
- # Interface: AztecWalletBaseMethodMap
8
-
9
- Defined in: [aztec/rpc-wallet/src/types.ts:83](https://github.com/WalletMesh/walletmesh-packages/blob/65bc501d5bed45d0e6d444f53e29595da551d59e/aztec/rpc-wallet/src/types.ts#L83)
10
-
11
- A mapping of JSON-RPC methods to their parameters and return types for Aztec Wallets.
12
-
13
- This extends the base WalletMethodMap with Aztec-specific methods.
14
-
15
- ## Extends
16
-
17
- - `WalletMethodMap`
18
-
19
- ## Extended by
20
-
21
- - [`AztecWalletMethodMap`](AztecWalletMethodMap.md)
22
-
23
- ## Indexable
24
-
25
- \[`method`: `string`\]: `object`
26
-
27
- ## Properties
28
-
29
- ### aztec\_connect
30
-
31
- > **aztec\_connect**: `object`
32
-
33
- Defined in: [aztec/rpc-wallet/src/types.ts:88](https://github.com/WalletMesh/walletmesh-packages/blob/65bc501d5bed45d0e6d444f53e29595da551d59e/aztec/rpc-wallet/src/types.ts#L88)
34
-
35
- Connects to the Aztec network.
36
-
37
- #### result
38
-
39
- > **result**: `boolean`
40
-
41
- #### Returns
42
-
43
- A boolean indicating if the connection was successful
44
-
45
- ***
46
-
47
- ### aztec\_getAccount
48
-
49
- > **aztec\_getAccount**: `object`
50
-
51
- Defined in: [aztec/rpc-wallet/src/types.ts:94](https://github.com/WalletMesh/walletmesh-packages/blob/65bc501d5bed45d0e6d444f53e29595da551d59e/aztec/rpc-wallet/src/types.ts#L94)
52
-
53
- Gets the account address from the wallet.
54
-
55
- #### result
56
-
57
- > **result**: `string`
58
-
59
- #### Returns
60
-
61
- The account address as a string
62
-
63
- ***
64
-
65
- ### aztec\_sendTransaction
66
-
67
- > **aztec\_sendTransaction**: `object`
68
-
69
- Defined in: [aztec/rpc-wallet/src/types.ts:101](https://github.com/WalletMesh/walletmesh-packages/blob/65bc501d5bed45d0e6d444f53e29595da551d59e/aztec/rpc-wallet/src/types.ts#L101)
70
-
71
- Sends transactions to the Aztec network.
72
-
73
- #### params
74
-
75
- > **params**: [`TransactionParams`](../type-aliases/TransactionParams.md)
76
-
77
- #### result
78
-
79
- > **result**: `string`
80
-
81
- #### Param
82
-
83
- The transactions to execute and optional authorization witnesses
84
-
85
- #### Returns
86
-
87
- The transaction hash as a string
88
-
89
- ***
90
-
91
- ### aztec\_simulateTransaction
92
-
93
- > **aztec\_simulateTransaction**: `object`
94
-
95
- Defined in: [aztec/rpc-wallet/src/types.ts:111](https://github.com/WalletMesh/walletmesh-packages/blob/65bc501d5bed45d0e6d444f53e29595da551d59e/aztec/rpc-wallet/src/types.ts#L111)
96
-
97
- Simulates a transaction without executing it.
98
-
99
- #### params
100
-
101
- > **params**: [`TransactionFunctionCall`](../type-aliases/TransactionFunctionCall.md)
102
-
103
- #### result
104
-
105
- > **result**: `unknown`
106
-
107
- #### Param
108
-
109
- The transaction to simulate
110
-
111
- #### Returns
112
-
113
- The simulation result
114
-
115
- ***
116
-
117
- ### wm\_getSupportedMethods
118
-
119
- > **wm\_getSupportedMethods**: `object`
120
-
121
- Defined in: [aztec/rpc-wallet/src/types.ts:120](https://github.com/WalletMesh/walletmesh-packages/blob/65bc501d5bed45d0e6d444f53e29595da551d59e/aztec/rpc-wallet/src/types.ts#L120)
122
-
123
- Returns the list of supported methods for the wallet.
124
-
125
- #### result
126
-
127
- > **result**: `string`[]
128
-
129
- #### Returns
130
-
131
- An array of supported methods
132
-
133
- #### Overrides
134
-
135
- `WalletMethodMap.wm_getSupportedMethods`
@@ -1,17 +0,0 @@
1
- [**@walletmesh/aztec-rpc-wallet v0.3.1**](../README.md)
2
-
3
- ***
4
-
5
- [@walletmesh/aztec-rpc-wallet](../globals.md) / AztecWalletEventMap
6
-
7
- # Interface: AztecWalletEventMap
8
-
9
- Defined in: [aztec/rpc-wallet/src/types.ts:125](https://github.com/WalletMesh/walletmesh-packages/blob/65bc501d5bed45d0e6d444f53e29595da551d59e/aztec/rpc-wallet/src/types.ts#L125)
10
-
11
- ## Extends
12
-
13
- - `JSONRPCEventMap`
14
-
15
- ## Indexable
16
-
17
- \[`event`: `string`\]: `unknown`
@@ -1,13 +0,0 @@
1
- [**@walletmesh/aztec-rpc-wallet v0.3.1**](../README.md)
2
-
3
- ***
4
-
5
- [@walletmesh/aztec-rpc-wallet](../globals.md) / AztecChainWalletMiddleware
6
-
7
- # Type Alias: AztecChainWalletMiddleware
8
-
9
- > **AztecChainWalletMiddleware**: `JSONRPCMiddleware`\<[`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md), [`AztecWalletContext`](AztecWalletContext.md)\>
10
-
11
- Defined in: [aztec/rpc-wallet/src/types.ts:149](https://github.com/WalletMesh/walletmesh-packages/blob/65bc501d5bed45d0e6d444f53e29595da551d59e/aztec/rpc-wallet/src/types.ts#L149)
12
-
13
- Type for Aztec Chain Wallet middleware.
@@ -1,29 +0,0 @@
1
- [**@walletmesh/aztec-rpc-wallet v0.3.1**](../README.md)
2
-
3
- ***
4
-
5
- [@walletmesh/aztec-rpc-wallet](../globals.md) / AztecWalletContext
6
-
7
- # Type Alias: AztecWalletContext
8
-
9
- > **AztecWalletContext**: `Record`\<`string`, `unknown`\> & `object`
10
-
11
- Defined in: [aztec/rpc-wallet/src/types.ts:133](https://github.com/WalletMesh/walletmesh-packages/blob/65bc501d5bed45d0e6d444f53e29595da551d59e/aztec/rpc-wallet/src/types.ts#L133)
12
-
13
- Holds the context passed through RPC middleware.
14
-
15
- ## Type declaration
16
-
17
- ### contractArtifactCache
18
-
19
- > **contractArtifactCache**: [`ContractArtifactCache`](../classes/ContractArtifactCache.md)
20
-
21
- ### pxe
22
-
23
- > **pxe**: `PXE`
24
-
25
- The PXE instance for the wallet
26
-
27
- ### wallet
28
-
29
- > **wallet**: `AccountWallet`
@@ -1,37 +0,0 @@
1
- [**@walletmesh/aztec-rpc-wallet v0.3.1**](../README.md)
2
-
3
- ***
4
-
5
- [@walletmesh/aztec-rpc-wallet](../globals.md) / AztecWalletMethodHandler
6
-
7
- # Type Alias: AztecWalletMethodHandler()\<T, M, C\>
8
-
9
- > **AztecWalletMethodHandler**\<`T`, `M`, `C`\>: (`context`, `params`, `accountWallet`) => `Promise`\<`T`\[`M`\]\[`"result"`\]\> \| `T`\[`M`\]\[`"result"`\]
10
-
11
- Defined in: [aztec/rpc-wallet/src/types.ts:286](https://github.com/WalletMesh/walletmesh-packages/blob/65bc501d5bed45d0e6d444f53e29595da551d59e/aztec/rpc-wallet/src/types.ts#L286)
12
-
13
- ## Type Parameters
14
-
15
- • **T** *extends* [`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md)
16
-
17
- • **M** *extends* keyof `T`
18
-
19
- • **C** *extends* [`AztecWalletContext`](AztecWalletContext.md)
20
-
21
- ## Parameters
22
-
23
- ### context
24
-
25
- `C`
26
-
27
- ### params
28
-
29
- `T`\[`M`\]\[`"params"`\]
30
-
31
- ### accountWallet
32
-
33
- `AccountWallet`
34
-
35
- ## Returns
36
-
37
- `Promise`\<`T`\[`M`\]\[`"result"`\]\> \| `T`\[`M`\]\[`"result"`\]
@@ -1,13 +0,0 @@
1
- [**@walletmesh/aztec-rpc-wallet v0.3.1**](../README.md)
2
-
3
- ***
4
-
5
- [@walletmesh/aztec-rpc-wallet](../globals.md) / AztecWalletMiddleware
6
-
7
- # Type Alias: AztecWalletMiddleware
8
-
9
- > **AztecWalletMiddleware**: `JSONRPCMiddleware`\<[`AztecWalletBaseMethodMap`](../interfaces/AztecWalletBaseMethodMap.md), [`AztecWalletContext`](AztecWalletContext.md)\>
10
-
11
- Defined in: [aztec/rpc-wallet/src/types.ts:144](https://github.com/WalletMesh/walletmesh-packages/blob/65bc501d5bed45d0e6d444f53e29595da551d59e/aztec/rpc-wallet/src/types.ts#L144)
12
-
13
- Type for Aztec Router Wallet middleware.
@@ -1,13 +0,0 @@
1
- [**@walletmesh/aztec-rpc-wallet v0.3.1**](../README.md)
2
-
3
- ***
4
-
5
- [@walletmesh/aztec-rpc-wallet](../globals.md) / AztecWalletRouterClient
6
-
7
- # Type Alias: AztecWalletRouterClient
8
-
9
- > **AztecWalletRouterClient**: `JSONRPCWalletClient`\<[`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md)\>
10
-
11
- Defined in: [aztec/rpc-wallet/src/types.ts:155](https://github.com/WalletMesh/walletmesh-packages/blob/65bc501d5bed45d0e6d444f53e29595da551d59e/aztec/rpc-wallet/src/types.ts#L155)
12
-
13
- Type for Aztec wallet router client.
@@ -1,33 +0,0 @@
1
- [**@walletmesh/aztec-rpc-wallet v0.3.1**](../README.md)
2
-
3
- ***
4
-
5
- [@walletmesh/aztec-rpc-wallet](../globals.md) / TransactionFunctionCall
6
-
7
- # Type Alias: TransactionFunctionCall
8
-
9
- > **TransactionFunctionCall**: `object`
10
-
11
- Defined in: [aztec/rpc-wallet/src/types.ts:49](https://github.com/WalletMesh/walletmesh-packages/blob/65bc501d5bed45d0e6d444f53e29595da551d59e/aztec/rpc-wallet/src/types.ts#L49)
12
-
13
- Represents a single function call to a contract.
14
-
15
- ## Type declaration
16
-
17
- ### args
18
-
19
- > **args**: `unknown`[]
20
-
21
- The arguments to pass to the function
22
-
23
- ### contractAddress
24
-
25
- > **contractAddress**: `string`
26
-
27
- The address of the contract to interact with
28
-
29
- ### functionName
30
-
31
- > **functionName**: `string`
32
-
33
- The name of the function to call
@@ -1,27 +0,0 @@
1
- [**@walletmesh/aztec-rpc-wallet v0.3.1**](../README.md)
2
-
3
- ***
4
-
5
- [@walletmesh/aztec-rpc-wallet](../globals.md) / TransactionParams
6
-
7
- # Type Alias: TransactionParams
8
-
9
- > **TransactionParams**: `object`
10
-
11
- Defined in: [aztec/rpc-wallet/src/types.ts:62](https://github.com/WalletMesh/walletmesh-packages/blob/65bc501d5bed45d0e6d444f53e29595da551d59e/aztec/rpc-wallet/src/types.ts#L62)
12
-
13
- Parameters for sending transactions.
14
-
15
- ## Type declaration
16
-
17
- ### authwits?
18
-
19
- > `optional` **authwits**: `string`[]
20
-
21
- Optional array of authorization witnesses for the transaction
22
-
23
- ### functionCalls
24
-
25
- > **functionCalls**: [`TransactionFunctionCall`](TransactionFunctionCall.md)[]
26
-
27
- Array of function calls to execute