@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,4 +1,4 @@
1
- [**@walletmesh/aztec-rpc-wallet v0.3.1**](../README.md)
1
+ [**@walletmesh/aztec-rpc-wallet v0.4.1**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -6,6 +6,19 @@
6
6
 
7
7
  # Type Alias: AztecChainId
8
8
 
9
- > **AztecChainId**: `` `aztec:${string}` ``
9
+ > **AztecChainId** = `` `aztec:${string}` ``
10
10
 
11
- Defined in: [aztec/rpc-wallet/src/types.ts:296](https://github.com/WalletMesh/walletmesh-packages/blob/65bc501d5bed45d0e6d444f53e29595da551d59e/aztec/rpc-wallet/src/types.ts#L296)
11
+ Defined in: [aztec/rpc-wallet/src/types.ts:64](https://github.com/WalletMesh/walletmesh-packages/blob/c22c9775e630bf48780e547c01c8f5442dc5b36c/aztec/rpc-wallet/src/types.ts#L64)
12
+
13
+ Type-safe Aztec chain ID format following the CAIP-2 standard.
14
+
15
+ Format: `aztec:{reference}` where reference is typically:
16
+ - "mainnet" for the main Aztec network
17
+ - A numeric chain ID for test networks (e.g., "31337" for local development)
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ const mainnetChainId: AztecChainId = "aztec:mainnet";
23
+ const localChainId: AztecChainId = "aztec:31337";
24
+ ```
@@ -0,0 +1,20 @@
1
+ [**@walletmesh/aztec-rpc-wallet v0.4.1**](../README.md)
2
+
3
+ ***
4
+
5
+ [@walletmesh/aztec-rpc-wallet](../globals.md) / ALL\_AZTEC\_METHODS
6
+
7
+ # Variable: ALL\_AZTEC\_METHODS
8
+
9
+ > `const` **ALL\_AZTEC\_METHODS**: readonly \[`"aztec_getAddress"`, `"aztec_getCompleteAddress"`, `"aztec_getChainId"`, `"aztec_getVersion"`, `"aztec_sendTx"`, `"aztec_getTxReceipt"`, `"aztec_simulateTx"`, `"aztec_getNodeInfo"`, `"aztec_getBlockNumber"`, `"aztec_getCurrentBaseFees"`, `"aztec_registerSender"`, `"aztec_getSenders"`, `"aztec_removeSender"`, `"aztec_registerContract"`, `"aztec_registerContractClass"`, `"aztec_getContractMetadata"`, `"aztec_getContractClassMetadata"`, `"aztec_proveTx"`, `"aztec_profileTx"`, `"aztec_simulateUtility"`, `"aztec_getPrivateEvents"`, `"aztec_getPublicEvents"`, `"aztec_getPXEInfo"`, `"aztec_getBlock"`, `"aztec_createAuthWit"`, `"aztec_wmDeployContract"`, `"aztec_wmExecuteTx"`, `"aztec_wmSimulateTx"`\]
10
+
11
+ Defined in: [aztec/rpc-wallet/src/client/helpers.ts:17](https://github.com/WalletMesh/walletmesh-packages/blob/c22c9775e630bf48780e547c01c8f5442dc5b36c/aztec/rpc-wallet/src/client/helpers.ts#L17)
12
+
13
+ A comprehensive list of all JSON-RPC methods supported by the Aztec RPC wallet.
14
+ This array includes standard Aztec wallet methods as well as WalletMesh-specific extensions (prefixed with `wm_`).
15
+ It can be used when establishing a connection to request permissions for all available functionalities.
16
+
17
+ ## See
18
+
19
+ - [AztecWalletMethodMap](../interfaces/AztecWalletMethodMap.md) for detailed type information on each method.
20
+ - [connectAztec](../functions/connectAztec.md) and connectAztecWithWallet which use this list by default.
@@ -1,4 +1,4 @@
1
- [**@walletmesh/aztec-rpc-wallet v0.3.1**](../README.md)
1
+ [**@walletmesh/aztec-rpc-wallet v0.4.1**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -6,8 +6,13 @@
6
6
 
7
7
  # Variable: AztecWalletErrorMap
8
8
 
9
- > `const` **AztecWalletErrorMap**: `Record`\<`AztecWalletErrorType`, \{ `code`: `number`; `message`: `string`; \}\>
9
+ > `const` `readonly` **AztecWalletErrorMap**: `Record`\<`AztecWalletErrorType`, \{ `code`: `number`; `message`: `string`; \}\>
10
10
 
11
- Defined in: [aztec/rpc-wallet/src/errors.ts:37](https://github.com/WalletMesh/walletmesh-packages/blob/65bc501d5bed45d0e6d444f53e29595da551d59e/aztec/rpc-wallet/src/errors.ts#L37)
11
+ Defined in: [aztec/rpc-wallet/src/errors.ts:59](https://github.com/WalletMesh/walletmesh-packages/blob/c22c9775e630bf48780e547c01c8f5442dc5b36c/aztec/rpc-wallet/src/errors.ts#L59)
12
12
 
13
- Map of error codes and messages for Aztec Wallet RPC errors.
13
+ A map associating each AztecWalletErrorType with a specific JSON-RPC error code
14
+ and a human-readable message. This map is used by the [AztecWalletError](../classes/AztecWalletError.md) class
15
+ to construct standardized error objects.
16
+
17
+ The error codes are chosen from the range typically reserved for server-defined errors
18
+ in JSON-RPC (e.g., -32000 to -32099).
@@ -0,0 +1,45 @@
1
+ [**@walletmesh/aztec-rpc-wallet v0.4.1**](../README.md)
2
+
3
+ ***
4
+
5
+ [@walletmesh/aztec-rpc-wallet](../globals.md) / AztecWalletSerializer
6
+
7
+ # Variable: AztecWalletSerializer
8
+
9
+ > `const` **AztecWalletSerializer**: [`JSONRPCSerializer`](https://github.com/WalletMesh/walletmesh-packages/tree/main/core/jsonrpc/docs/interfaces/JSONRPCSerializer.md)\<`JSONRPCParams`, `unknown`\>
10
+
11
+ Defined in: [aztec/rpc-wallet/src/wallet/serializers.ts:265](https://github.com/WalletMesh/walletmesh-packages/blob/c22c9775e630bf48780e547c01c8f5442dc5b36c/aztec/rpc-wallet/src/wallet/serializers.ts#L265)
12
+
13
+ A comprehensive [JSONRPCSerializer](https://github.com/WalletMesh/walletmesh-packages/tree/main/core/jsonrpc/docs/interfaces/JSONRPCSerializer.md) for all Aztec wallet methods.
14
+
15
+ This serializer handles both parameters and results:
16
+
17
+ **Parameters (`params`):**
18
+ - `serialize`: Currently uses a fallback mechanism (`createFallbackSerializer`) which
19
+ stringifies parameters using `jsonStringify`. This assumes the client-side
20
+ (e.g., [AztecDappWallet](../classes/AztecDappWallet.md) via [AztecRouterProvider](../classes/AztecRouterProvider.md)) sends parameters
21
+ already in a format that can be processed by the `deserialize` logic after
22
+ basic JSON parsing.
23
+ - `deserialize`: Contains detailed, method-specific logic to parse the JSON string
24
+ of incoming parameters and reconstruct them into their correct Aztec types
25
+ (e.g., `AztecAddress.fromString`, `TxExecutionRequest.schema.parse`). It uses
26
+ Zod schemas and helper functions (`ensureParam`, `getOptionalParam`) for
27
+ validation and type conversion.
28
+
29
+ **Results (`result`):**
30
+ - `serialize`: For each method, it attempts to use a specific serializer defined in
31
+ `RESULT_SERIALIZERS`. These typically use `jsonStringify` with a Zod schema
32
+ for the specific result type (e.g., `AztecAddress.schema`, `TxHash.schema`).
33
+ If no specific serializer is found, it uses `createFallbackSerializer`.
34
+ - `deserialize`: Similar to result serialization, it uses `RESULT_SERIALIZERS`
35
+ to find a method-specific deserializer, often employing `jsonParseWithSchema`
36
+ with the appropriate Zod schema. If no specific deserializer exists, it may
37
+ return the raw data or attempt a simple JSON parse.
38
+
39
+ This serializer is crucial for ensuring that complex Aztec objects maintain their
40
+ type integrity and structure when transmitted over JSON-RPC.
41
+
42
+ ## See
43
+
44
+ - [AztecWalletMethodMap](../interfaces/AztecWalletMethodMap.md) for the definitions of methods, params, and results.
45
+ - [JSONRPCSerializer](https://github.com/WalletMesh/walletmesh-packages/tree/main/core/jsonrpc/docs/interfaces/JSONRPCSerializer.md) for the interface it implements.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@walletmesh/aztec-rpc-wallet",
3
- "version": "0.3.1",
3
+ "version": "0.4.1",
4
4
  "description": "",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -17,16 +17,18 @@
17
17
  "author": "",
18
18
  "license": "Apache-2.0",
19
19
  "devDependencies": {
20
- "typedoc": "^0.27.2",
21
- "typedoc-plugin-markdown": "^4.3.1"
20
+ "typedoc": "^0.28.4",
21
+ "typedoc-plugin-markdown": "^4.6.3"
22
22
  },
23
23
  "dependencies": {
24
- "@aztec/aztec.js": "0.76.2",
25
- "@aztec/circuit-types": "0.76.2",
26
- "@aztec/circuits.js": "0.76.2",
27
- "@aztec/foundation": "0.76.2",
28
- "@walletmesh/jsonrpc": "0.4.0",
29
- "@walletmesh/router": "0.4.0"
24
+ "@aztec/aztec.js": "0.87.8",
25
+ "@aztec/blob-lib": "0.87.8",
26
+ "@aztec/entrypoints": "0.87.8",
27
+ "@aztec/foundation": "0.87.8",
28
+ "@aztec/stdlib": "0.87.8",
29
+ "zod": "^3.25.67",
30
+ "@walletmesh/router": "^0.5.0",
31
+ "@walletmesh/jsonrpc": "^0.5.0"
30
32
  },
31
33
  "scripts": {
32
34
  "build": "tsc --build tsconfig.build.json",