@walletmesh/aztec-rpc-wallet 0.3.0 → 0.4.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 (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 -268
  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 +501 -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 +471 -470
  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 +9 -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 +586 -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 -296
  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 -504
  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 -649
  166. package/src/handlers/aztecAccountWallet.ts +0 -532
  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 -274
  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.0**](../README.md)
1
+ [**@walletmesh/aztec-rpc-wallet v0.4.0**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -6,14 +6,28 @@
6
6
 
7
7
  # Interface: AztecWalletMethodMap
8
8
 
9
- Defined in: [aztec/rpc-wallet/src/types.ts:161](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L161)
9
+ Defined in: [aztec/rpc-wallet/src/types.ts:117](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L117)
10
10
 
11
- Type for Aztec wallet RPC method map.
12
- This extends the AztecWalletBaseMethodMap with the methods used in by Aztec's `AccountWallet`
11
+ Defines the complete map of all JSON-RPC methods supported by the Aztec RPC Wallet.
12
+ This interface extends the base WalletMethodMap from `@walletmesh/router`
13
+ and specifies the parameter (`params`) and return (`result`) types for each Aztec-specific method.
14
+
15
+ This map is crucial for:
16
+ - Type safety in both client-side calls and wallet-side handlers.
17
+ - Guiding the implementation of serializers and deserializers.
18
+ - Documentation generation, as it serves as a single source of truth for method signatures.
19
+
20
+ Methods are loosely grouped by functionality (Chain/Node, Account, Sender, etc.).
21
+ "wm_" prefixed methods are typically WalletMesh-specific extensions or conveniences.
22
+
23
+ ## See
24
+
25
+ - [AztecDappWallet](../classes/AztecDappWallet.md) for the client-side implementation that calls these methods.
26
+ - createAztecHandlers for the wallet-side implementation that handles these methods.
13
27
 
14
28
  ## Extends
15
29
 
16
- - [`AztecWalletBaseMethodMap`](AztecWalletBaseMethodMap.md)
30
+ - `WalletMethodMap`
17
31
 
18
32
  ## Indexable
19
33
 
@@ -21,331 +35,258 @@ This extends the AztecWalletBaseMethodMap with the methods used in by Aztec's `A
21
35
 
22
36
  ## Properties
23
37
 
24
- ### aztec\_addAuthWitness
25
-
26
- > **aztec\_addAuthWitness**: `object`
38
+ ### aztec\_createAuthWit
27
39
 
28
- Defined in: [aztec/rpc-wallet/src/types.ts:196](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L196)
40
+ > **aztec\_createAuthWit**: `object`
29
41
 
30
- #### params
42
+ Defined in: [aztec/rpc-wallet/src/types.ts:201](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L201)
31
43
 
32
- > **params**: `object`
44
+ Creates an AuthWitness (authorization witness) for a given message hash or intent.
45
+ Used for delegating actions.
33
46
 
34
- ##### params.authWitness
47
+ #### params
35
48
 
36
- > **authWitness**: `AuthWitness`
49
+ > **params**: \[`Fr` \| `Buffer`\<`ArrayBufferLike`\> \| `IntentAction` \| `IntentInnerHash`\]
37
50
 
38
51
  #### result
39
52
 
40
- > **result**: `boolean`
41
-
42
- ***
43
-
44
- ### aztec\_addCapsule
45
-
46
- > **aztec\_addCapsule**: `object`
47
-
48
- Defined in: [aztec/rpc-wallet/src/types.ts:184](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L184)
53
+ > **result**: `AuthWitness`
49
54
 
50
- #### params
55
+ #### Param
51
56
 
52
- > **params**: `object`
57
+ A tuple containing the intent to authorize.
53
58
 
54
- ##### params.capsule
59
+ #### Param
55
60
 
56
- > **capsule**: `Fr`[]
61
+ intent - The message hash (Fr or `Buffer`), IntentInnerHash, or IntentAction to authorize.
57
62
 
58
- #### result
63
+ #### Returns
59
64
 
60
- > **result**: `boolean`
65
+ result - The created AuthWitness.
61
66
 
62
67
  ***
63
68
 
64
- ### aztec\_addNote
69
+ ### aztec\_getAddress
65
70
 
66
- > **aztec\_addNote**: `object`
71
+ > **aztec\_getAddress**: `object`
67
72
 
68
- Defined in: [aztec/rpc-wallet/src/types.ts:270](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L270)
73
+ Defined in: [aztec/rpc-wallet/src/types.ts:185](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L185)
69
74
 
70
- #### params
75
+ Retrieves the primary AztecAddress of the wallet's account.
71
76
 
72
- > **params**: `object`
73
-
74
- ##### params.note
77
+ #### params
75
78
 
76
- > **note**: `ExtendedNote`
79
+ > **params**: \[\]
77
80
 
78
81
  #### result
79
82
 
80
- > **result**: `boolean`
83
+ > **result**: `AztecAddress`
81
84
 
82
- ***
85
+ #### Param
83
86
 
84
- ### aztec\_addNullifiedNote
87
+ No parameters.
85
88
 
86
- > **aztec\_addNullifiedNote**: `object`
89
+ #### Returns
87
90
 
88
- Defined in: [aztec/rpc-wallet/src/types.ts:271](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L271)
91
+ result - The wallet's AztecAddress.
89
92
 
90
- #### params
93
+ ***
91
94
 
92
- > **params**: `object`
95
+ ### aztec\_getBlock
93
96
 
94
- ##### params.note
97
+ > **aztec\_getBlock**: `object`
95
98
 
96
- > **note**: `ExtendedNote`
99
+ Defined in: [aztec/rpc-wallet/src/types.ts:135](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L135)
97
100
 
98
- #### result
101
+ Retrieves a specific L2 block by its number.
99
102
 
100
- > **result**: `boolean`
103
+ #### params
101
104
 
102
- ***
105
+ > **params**: \[`number`\]
103
106
 
104
- ### aztec\_connect
107
+ #### result
105
108
 
106
- > **aztec\_connect**: `object`
109
+ > **result**: `L2Block`
107
110
 
108
- Defined in: [aztec/rpc-wallet/src/types.ts:88](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L88)
111
+ #### Param
109
112
 
110
- Connects to the Aztec network.
113
+ A tuple containing the block number.
111
114
 
112
- #### result
115
+ #### Param
113
116
 
114
- > **result**: `boolean`
117
+ blockNumber - The number of the block to retrieve.
115
118
 
116
119
  #### Returns
117
120
 
118
- A boolean indicating if the connection was successful
119
-
120
- #### Inherited from
121
-
122
- [`AztecWalletBaseMethodMap`](AztecWalletBaseMethodMap.md).[`aztec_connect`](AztecWalletBaseMethodMap.md#aztec_connect)
121
+ result - The L2Block data, or null/undefined if not found (behavior depends on PXE).
123
122
 
124
123
  ***
125
124
 
126
- ### aztec\_createAuthWit
127
-
128
- > **aztec\_createAuthWit**: `object`
125
+ ### aztec\_getBlockNumber
129
126
 
130
- Defined in: [aztec/rpc-wallet/src/types.ts:198](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L198)
127
+ > **aztec\_getBlockNumber**: `object`
131
128
 
132
- #### params
129
+ Defined in: [aztec/rpc-wallet/src/types.ts:141](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L141)
133
130
 
134
- > **params**: `object`
131
+ Retrieves the current (latest) L2 block number.
135
132
 
136
- ##### params.intent
133
+ #### params
137
134
 
138
- > **intent**: `Fr` \| `Buffer` \| `IntentAction` \| `IntentInnerHash`
135
+ > **params**: \[\]
139
136
 
140
137
  #### result
141
138
 
142
- > **result**: `AuthWitness`
143
-
144
- ***
145
-
146
- ### aztec\_createTxExecutionRequest
147
-
148
- > **aztec\_createTxExecutionRequest**: `object`
149
-
150
- Defined in: [aztec/rpc-wallet/src/types.ts:244](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L244)
139
+ > **result**: `number`
151
140
 
152
- #### params
141
+ #### Param
153
142
 
154
- > **params**: `object`
143
+ No parameters.
155
144
 
156
- ##### params.exec
145
+ #### Returns
157
146
 
158
- > **exec**: `ExecutionRequestInit`
147
+ result - The current block number.
159
148
 
160
- #### result
149
+ ***
161
150
 
162
- > **result**: `TxExecutionRequest`
151
+ ### aztec\_getChainId
163
152
 
164
- ***
153
+ > **aztec\_getChainId**: `object`
165
154
 
166
- ### aztec\_getAccount
155
+ Defined in: [aztec/rpc-wallet/src/types.ts:147](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L147)
167
156
 
168
- > **aztec\_getAccount**: `object`
157
+ Retrieves the chain ID of the connected Aztec network.
169
158
 
170
- Defined in: [aztec/rpc-wallet/src/types.ts:94](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L94)
159
+ #### params
171
160
 
172
- Gets the account address from the wallet.
161
+ > **params**: \[\]
173
162
 
174
163
  #### result
175
164
 
176
- > **result**: `string`
165
+ > **result**: `Fr`
177
166
 
178
- #### Returns
167
+ #### Param
179
168
 
180
- The account address as a string
169
+ No parameters.
181
170
 
182
- #### Inherited from
171
+ #### Returns
183
172
 
184
- [`AztecWalletBaseMethodMap`](AztecWalletBaseMethodMap.md).[`aztec_getAccount`](AztecWalletBaseMethodMap.md#aztec_getaccount)
173
+ result - The chain ID as an Fr.
185
174
 
186
175
  ***
187
176
 
188
- ### aztec\_getAddress
189
-
190
- > **aztec\_getAddress**: `object`
191
-
192
- Defined in: [aztec/rpc-wallet/src/types.ts:187](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L187)
193
-
194
- #### result
195
-
196
- > **result**: `AztecAddress`
197
-
198
- ***
177
+ ### aztec\_getCompleteAddress
199
178
 
200
- ### aztec\_getAuthWitness
179
+ > **aztec\_getCompleteAddress**: `object`
201
180
 
202
- > **aztec\_getAuthWitness**: `object`
181
+ Defined in: [aztec/rpc-wallet/src/types.ts:191](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L191)
203
182
 
204
- Defined in: [aztec/rpc-wallet/src/types.ts:197](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L197)
183
+ Retrieves the CompleteAddress of the wallet's account, including public keys.
205
184
 
206
185
  #### params
207
186
 
208
- > **params**: `object`
209
-
210
- ##### params.messageHash
211
-
212
- > **messageHash**: `Fr`
187
+ > **params**: \[\]
213
188
 
214
189
  #### result
215
190
 
216
- > **result**: `Fr`[]
217
-
218
- ***
219
-
220
- ### aztec\_getBlock
221
-
222
- > **aztec\_getBlock**: `object`
223
-
224
- Defined in: [aztec/rpc-wallet/src/types.ts:163](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L163)
225
-
226
- #### params
227
-
228
- > **params**: `object`
191
+ > **result**: `CompleteAddress`
229
192
 
230
- ##### params.number
193
+ #### Param
231
194
 
232
- > **number**: `number`
195
+ No parameters.
233
196
 
234
- #### result
197
+ #### Returns
235
198
 
236
- > **result**: `L2Block`
199
+ result - The wallet's CompleteAddress.
237
200
 
238
201
  ***
239
202
 
240
- ### aztec\_getBlockNumber
241
-
242
- > **aztec\_getBlockNumber**: `object`
203
+ ### aztec\_getContractClassMetadata
243
204
 
244
- Defined in: [aztec/rpc-wallet/src/types.ts:164](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L164)
205
+ > **aztec\_getContractClassMetadata**: `object`
245
206
 
246
- #### result
207
+ Defined in: [aztec/rpc-wallet/src/types.ts:258](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L258)
247
208
 
248
- > **result**: `number`
209
+ Retrieves ContractClassMetadata for a specific contract class.
249
210
 
250
- ***
211
+ #### params
251
212
 
252
- ### aztec\_getChainId
213
+ > **params**: \[`Fr`, `undefined` \| `boolean`\]
253
214
 
254
- > **aztec\_getChainId**: `object`
215
+ #### result
255
216
 
256
- Defined in: [aztec/rpc-wallet/src/types.ts:165](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L165)
217
+ > **result**: `ContractClassMetadata`
257
218
 
258
- #### result
219
+ #### Param
259
220
 
260
- > **result**: `number`
221
+ A tuple containing the class ID and an optional flag.
261
222
 
262
- ***
223
+ #### Param
263
224
 
264
- ### aztec\_getCompleteAddress
225
+ classId - The Fr ID of the contract class.
265
226
 
266
- > **aztec\_getCompleteAddress**: `object`
227
+ #### Param
267
228
 
268
- Defined in: [aztec/rpc-wallet/src/types.ts:188](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L188)
229
+ includeArtifact - Optional: Boolean indicating whether to include the full ContractArtifact.
269
230
 
270
- #### result
231
+ #### Returns
271
232
 
272
- > **result**: `CompleteAddress`
233
+ result - The ContractClassMetadata.
273
234
 
274
235
  ***
275
236
 
276
- ### aztec\_getContractClassLogs
277
-
278
- > **aztec\_getContractClassLogs**: `object`
237
+ ### aztec\_getContractMetadata
279
238
 
280
- Defined in: [aztec/rpc-wallet/src/types.ts:275](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L275)
239
+ > **aztec\_getContractMetadata**: `object`
281
240
 
282
- #### params
241
+ Defined in: [aztec/rpc-wallet/src/types.ts:247](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L247)
283
242
 
284
- > **params**: `object`
243
+ Retrieves ContractMetadata for a specific deployed contract.
285
244
 
286
- ##### params.filter
245
+ #### params
287
246
 
288
- > **filter**: `LogFilter`
247
+ > **params**: \[`AztecAddress`\]
289
248
 
290
249
  #### result
291
250
 
292
- > **result**: `GetContractClassLogsResponse`
293
-
294
- ***
295
-
296
- ### aztec\_getContractClassMetadata
297
-
298
- > **aztec\_getContractClassMetadata**: `object`
299
-
300
- Defined in: [aztec/rpc-wallet/src/types.ts:218](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L218)
301
-
302
- #### params
303
-
304
- > **params**: `object`
251
+ > **result**: `ContractMetadata`
305
252
 
306
- ##### params.id
253
+ #### Param
307
254
 
308
- > **id**: `Fr`
255
+ A tuple containing the contract's address.
309
256
 
310
- ##### params.includeArtifact?
257
+ #### Param
311
258
 
312
- > `optional` **includeArtifact**: `boolean`
259
+ contractAddress - The AztecAddress of the contract.
313
260
 
314
- #### result
261
+ #### Returns
315
262
 
316
- > **result**: `ContractClassMetadata`
263
+ result - The ContractMetadata for the specified contract.
317
264
 
318
265
  ***
319
266
 
320
- ### aztec\_getContractMetadata
321
-
322
- > **aztec\_getContractMetadata**: `object`
267
+ ### aztec\_getContracts
323
268
 
324
- Defined in: [aztec/rpc-wallet/src/types.ts:217](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L217)
269
+ > **aztec\_getContracts**: `object`
325
270
 
326
- #### params
271
+ Defined in: [aztec/rpc-wallet/src/types.ts:240](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L240)
327
272
 
328
- > **params**: `object`
273
+ Retrieves a list of all AztecAddresses of contracts known to the PXE/wallet.
329
274
 
330
- ##### params.address
275
+ #### params
331
276
 
332
- > **address**: `AztecAddress`
277
+ > **params**: \[\]
333
278
 
334
279
  #### result
335
280
 
336
- > **result**: `ContractMetadata`
337
-
338
- ***
281
+ > **result**: `AztecAddress`[]
339
282
 
340
- ### aztec\_getContracts
283
+ #### Param
341
284
 
342
- > **aztec\_getContracts**: `object`
285
+ No parameters.
343
286
 
344
- Defined in: [aztec/rpc-wallet/src/types.ts:216](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L216)
287
+ #### Returns
345
288
 
346
- #### result
347
-
348
- > **result**: `AztecAddress`[]
289
+ result - An array of contract AztecAddresses.
349
290
 
350
291
  ***
351
292
 
@@ -353,39 +294,25 @@ Defined in: [aztec/rpc-wallet/src/types.ts:216](https://github.com/WalletMesh/wa
353
294
 
354
295
  > **aztec\_getCurrentBaseFees**: `object`
355
296
 
356
- Defined in: [aztec/rpc-wallet/src/types.ts:170](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L170)
357
-
358
- #### result
359
-
360
- > **result**: `GasFees`
361
-
362
- ***
363
-
364
- ### aztec\_getL1ToL2MembershipWitness
365
-
366
- > **aztec\_getL1ToL2MembershipWitness**: `object`
297
+ Defined in: [aztec/rpc-wallet/src/types.ts:177](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L177)
367
298
 
368
- Defined in: [aztec/rpc-wallet/src/types.ts:178](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L178)
299
+ Retrieves the current base gas fees on the network.
369
300
 
370
301
  #### params
371
302
 
372
- > **params**: `object`
303
+ > **params**: \[\]
373
304
 
374
- ##### params.contractAddress
375
-
376
- > **contractAddress**: `AztecAddress`
377
-
378
- ##### params.messageHash
305
+ #### result
379
306
 
380
- > **messageHash**: `Fr`
307
+ > **result**: `GasFees`
381
308
 
382
- ##### params.secret
309
+ #### Param
383
310
 
384
- > **secret**: `Fr`
311
+ No parameters.
385
312
 
386
- #### result
313
+ #### Returns
387
314
 
388
- > **result**: \[`bigint`, `SiblingPath`\<`39`\>\]
315
+ result - A GasFees object.
389
316
 
390
317
  ***
391
318
 
@@ -393,63 +320,71 @@ Defined in: [aztec/rpc-wallet/src/types.ts:178](https://github.com/WalletMesh/wa
393
320
 
394
321
  > **aztec\_getNodeInfo**: `object`
395
322
 
396
- Defined in: [aztec/rpc-wallet/src/types.ts:167](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L167)
323
+ Defined in: [aztec/rpc-wallet/src/types.ts:159](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L159)
324
+
325
+ Retrieves comprehensive information about the connected Aztec node.
326
+
327
+ #### params
328
+
329
+ > **params**: \[\]
397
330
 
398
331
  #### result
399
332
 
400
333
  > **result**: `NodeInfo`
401
334
 
402
- ***
335
+ #### Param
336
+
337
+ No parameters.
403
338
 
404
- ### aztec\_getNotes
339
+ #### Returns
405
340
 
406
- > **aztec\_getNotes**: `object`
341
+ result - A NodeInfo object.
407
342
 
408
- Defined in: [aztec/rpc-wallet/src/types.ts:269](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L269)
343
+ ***
409
344
 
410
- #### params
345
+ ### aztec\_getPrivateEvents
411
346
 
412
- > **params**: `object`
347
+ > **aztec\_getPrivateEvents**: `object`
413
348
 
414
- ##### params.filter
349
+ Defined in: [aztec/rpc-wallet/src/types.ts:386](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L386)
415
350
 
416
- > **filter**: `NotesFilter`
351
+ Retrieves private (encrypted) events from the blockchain.
417
352
 
418
- #### result
353
+ #### params
419
354
 
420
- > **result**: `UniqueNote`[]
355
+ > **params**: \[`AztecAddress`, `EventMetadataDefinition`, `number`, `number`, `AztecAddress`[]\]
421
356
 
422
- ***
357
+ #### result
423
358
 
424
- ### aztec\_getPrivateEvents
359
+ > **result**: `unknown`[]
425
360
 
426
- > **aztec\_getPrivateEvents**: `object`
361
+ #### Param
427
362
 
428
- Defined in: [aztec/rpc-wallet/src/types.ts:276](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L276)
363
+ A tuple containing the query parameters.
429
364
 
430
- #### params
365
+ #### Param
431
366
 
432
- > **params**: `object`
367
+ contractAddress - AztecAddress of the emitting contract.
433
368
 
434
- ##### params.event
369
+ #### Param
435
370
 
436
- > **event**: `EventMetadataDefinition`
371
+ eventMetadata - EventMetadataDefinition for the event.
437
372
 
438
- ##### params.from
373
+ #### Param
439
374
 
440
- > **from**: `number`
375
+ fromBlock - Starting block number.
441
376
 
442
- ##### params.limit
377
+ #### Param
443
378
 
444
- > **limit**: `number`
379
+ numBlocks - Number of blocks to scan.
445
380
 
446
- ##### params.vpks?
381
+ #### Param
447
382
 
448
- > `optional` **vpks**: `Point`[]
383
+ recipients - Array of recipient AztecAddresses.
449
384
 
450
- #### result
385
+ #### Returns
451
386
 
452
- > **result**: `unknown`[]
387
+ result - An array of decoded private event data (type `unknown[]`, actual type depends on `eventMetadata`).
453
388
 
454
389
  ***
455
390
 
@@ -457,203 +392,213 @@ Defined in: [aztec/rpc-wallet/src/types.ts:276](https://github.com/WalletMesh/wa
457
392
 
458
393
  > **aztec\_getProvenBlockNumber**: `object`
459
394
 
460
- Defined in: [aztec/rpc-wallet/src/types.ts:168](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L168)
395
+ Defined in: [aztec/rpc-wallet/src/types.ts:165](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L165)
396
+
397
+ Retrieves the latest L2 block number that has been proven.
398
+
399
+ #### params
400
+
401
+ > **params**: \[\]
461
402
 
462
403
  #### result
463
404
 
464
405
  > **result**: `number`
465
406
 
466
- ***
467
-
468
- ### aztec\_getPublicEvents
407
+ #### Param
469
408
 
470
- > **aztec\_getPublicEvents**: `object`
409
+ No parameters.
471
410
 
472
- Defined in: [aztec/rpc-wallet/src/types.ts:280](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L280)
411
+ #### Returns
473
412
 
474
- #### params
413
+ result - The latest proven block number.
475
414
 
476
- > **params**: `object`
415
+ ***
477
416
 
478
- ##### params.event
417
+ ### aztec\_getPublicEvents
479
418
 
480
- > **event**: `EventMetadataDefinition`
419
+ > **aztec\_getPublicEvents**: `object`
481
420
 
482
- ##### params.from
421
+ Defined in: [aztec/rpc-wallet/src/types.ts:404](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L404)
483
422
 
484
- > **from**: `number`
423
+ Retrieves public (unencrypted) events from the blockchain.
485
424
 
486
- ##### params.limit
425
+ #### params
487
426
 
488
- > **limit**: `number`
427
+ > **params**: \[`EventMetadataDefinition`, `number`, `number`\]
489
428
 
490
429
  #### result
491
430
 
492
431
  > **result**: `unknown`[]
493
432
 
494
- ***
433
+ #### Param
495
434
 
496
- ### aztec\_getPublicLogs
435
+ A tuple containing the query parameters.
497
436
 
498
- > **aztec\_getPublicLogs**: `object`
437
+ #### Param
499
438
 
500
- Defined in: [aztec/rpc-wallet/src/types.ts:274](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L274)
439
+ eventMetadata - EventMetadataDefinition for the event.
501
440
 
502
- #### params
441
+ #### Param
503
442
 
504
- > **params**: `object`
443
+ fromBlock - Starting block number.
505
444
 
506
- ##### params.filter
445
+ #### Param
507
446
 
508
- > **filter**: `LogFilter`
447
+ limit - Maximum number of events to return.
509
448
 
510
- #### result
449
+ #### Returns
511
450
 
512
- > **result**: `GetPublicLogsResponse`
451
+ result - An array of decoded public event data (type `unknown[]`, actual type depends on `eventMetadata`).
513
452
 
514
453
  ***
515
454
 
516
- ### aztec\_getPublicStorageAt
455
+ ### aztec\_getPXEInfo
456
+
457
+ > **aztec\_getPXEInfo**: `object`
517
458
 
518
- > **aztec\_getPublicStorageAt**: `object`
459
+ Defined in: [aztec/rpc-wallet/src/types.ts:171](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L171)
519
460
 
520
- Defined in: [aztec/rpc-wallet/src/types.ts:240](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L240)
461
+ Retrieves information about the PXE service, including capabilities and version.
521
462
 
522
463
  #### params
523
464
 
524
- > **params**: `object`
465
+ > **params**: \[\]
525
466
 
526
- ##### params.contract
467
+ #### result
527
468
 
528
- > **contract**: `AztecAddress`
469
+ > **result**: `PXEInfo`
529
470
 
530
- ##### params.storageSlot
471
+ #### Param
531
472
 
532
- > **storageSlot**: `Fr`
473
+ No parameters.
533
474
 
534
- #### result
475
+ #### Returns
535
476
 
536
- > **result**: `any`
477
+ result - A PXEInfo object.
537
478
 
538
479
  ***
539
480
 
540
- ### aztec\_getPXEInfo
481
+ ### aztec\_getSenders
541
482
 
542
- > **aztec\_getPXEInfo**: `object`
483
+ > **aztec\_getSenders**: `object`
543
484
 
544
- Defined in: [aztec/rpc-wallet/src/types.ts:169](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L169)
485
+ Defined in: [aztec/rpc-wallet/src/types.ts:222](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L222)
545
486
 
546
- #### result
487
+ Retrieves a list of all currently authorized sender AztecAddresses.
547
488
 
548
- > **result**: `PXEInfo`
489
+ #### params
549
490
 
550
- ***
491
+ > **params**: \[\]
551
492
 
552
- ### aztec\_getRegisteredAccounts
493
+ #### result
553
494
 
554
- > **aztec\_getRegisteredAccounts**: `object`
495
+ > **result**: `AztecAddress`[]
555
496
 
556
- Defined in: [aztec/rpc-wallet/src/types.ts:193](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L193)
497
+ #### Param
557
498
 
558
- #### result
499
+ No parameters.
559
500
 
560
- > **result**: `CompleteAddress`[]
501
+ #### Returns
502
+
503
+ result - An array of authorized AztecAddresses.
561
504
 
562
505
  ***
563
506
 
564
- ### aztec\_getScopes
507
+ ### aztec\_getTxReceipt
565
508
 
566
- > **aztec\_getScopes**: `object`
509
+ > **aztec\_getTxReceipt**: `object`
567
510
 
568
- Defined in: [aztec/rpc-wallet/src/types.ts:174](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L174)
511
+ Defined in: [aztec/rpc-wallet/src/types.ts:312](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L312)
512
+
513
+ Retrieves the TxReceipt for a transaction.
514
+
515
+ #### params
516
+
517
+ > **params**: \[`TxHash`\]
569
518
 
570
519
  #### result
571
520
 
572
- > **result**: `AztecAddress`[]
521
+ > **result**: `TxReceipt`
573
522
 
574
- ***
523
+ #### Param
575
524
 
576
- ### aztec\_getSenders
525
+ A tuple containing the transaction hash.
577
526
 
578
- > **aztec\_getSenders**: `object`
527
+ #### Param
579
528
 
580
- Defined in: [aztec/rpc-wallet/src/types.ts:211](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L211)
529
+ txHash - The TxHash of the transaction.
581
530
 
582
- #### result
531
+ #### Returns
583
532
 
584
- > **result**: `AztecAddress`[]
533
+ result - The TxReceipt.
585
534
 
586
535
  ***
587
536
 
588
- ### aztec\_getTxEffect
589
-
590
- > **aztec\_getTxEffect**: `object`
537
+ ### aztec\_getVersion
591
538
 
592
- Defined in: [aztec/rpc-wallet/src/types.ts:249](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L249)
539
+ > **aztec\_getVersion**: `object`
593
540
 
594
- #### params
541
+ Defined in: [aztec/rpc-wallet/src/types.ts:153](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L153)
595
542
 
596
- > **params**: `object`
543
+ Retrieves the version of the connected PXE (Private Execution Environment) or node.
597
544
 
598
- ##### params.txHash
545
+ #### params
599
546
 
600
- > **txHash**: `TxHash`
547
+ > **params**: \[\]
601
548
 
602
549
  #### result
603
550
 
604
- > **result**: `InBlock`\<`TxEffect`\>
551
+ > **result**: `Fr`
605
552
 
606
- ***
607
-
608
- ### aztec\_getTxReceipt
553
+ #### Param
609
554
 
610
- > **aztec\_getTxReceipt**: `object`
555
+ No parameters.
611
556
 
612
- Defined in: [aztec/rpc-wallet/src/types.ts:250](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L250)
557
+ #### Returns
613
558
 
614
- #### params
559
+ result - The version as an Fr.
615
560
 
616
- > **params**: `object`
561
+ ***
617
562
 
618
- ##### params.txHash
563
+ ### aztec\_profileTx
619
564
 
620
- > **txHash**: `TxHash`
565
+ > **aztec\_profileTx**: `object`
621
566
 
622
- #### result
567
+ Defined in: [aztec/rpc-wallet/src/types.ts:345](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L345)
623
568
 
624
- > **result**: `TxReceipt`
569
+ Profiles a TxExecutionRequest for performance analysis.
625
570
 
626
- ***
571
+ #### params
627
572
 
628
- ### aztec\_getVersion
573
+ > **params**: \[`TxExecutionRequest`, (`"gates"` \| `"execution-steps"` \| `"full"`)?, `boolean`?, `AztecAddress`?\]
629
574
 
630
- > **aztec\_getVersion**: `object`
575
+ #### result
631
576
 
632
- Defined in: [aztec/rpc-wallet/src/types.ts:166](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L166)
577
+ > **result**: `TxProfileResult`
633
578
 
634
- #### result
579
+ #### Param
635
580
 
636
- > **result**: `number`
581
+ A tuple containing the profiling parameters.
637
582
 
638
- ***
583
+ #### Param
639
584
 
640
- ### aztec\_isL1ToL2MessageSynced
585
+ txRequest - The TxExecutionRequest to profile.
641
586
 
642
- > **aztec\_isL1ToL2MessageSynced**: `object`
587
+ #### Param
643
588
 
644
- Defined in: [aztec/rpc-wallet/src/types.ts:177](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L177)
589
+ profileMode - Optional: Profiling mode ('gates', 'execution-steps', 'full'). Defaults to 'gates'.
645
590
 
646
- #### params
591
+ #### Param
647
592
 
648
- > **params**: `object`
593
+ skipProofGeneration - Optional: Flag to skip proof generation. Defaults to `false`.
649
594
 
650
- ##### params.l1ToL2Message
595
+ #### Param
651
596
 
652
- > **l1ToL2Message**: `Fr`
597
+ msgSender - Optional: AztecAddress for profiling context.
653
598
 
654
- #### result
599
+ #### Returns
655
600
 
656
- > **result**: `boolean`
601
+ result - The TxProfileResult.
657
602
 
658
603
  ***
659
604
 
@@ -661,47 +606,33 @@ Defined in: [aztec/rpc-wallet/src/types.ts:177](https://github.com/WalletMesh/wa
661
606
 
662
607
  > **aztec\_proveTx**: `object`
663
608
 
664
- Defined in: [aztec/rpc-wallet/src/types.ts:245](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L245)
665
-
666
- #### params
667
-
668
- > **params**: `object`
609
+ Defined in: [aztec/rpc-wallet/src/types.ts:292](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L292)
669
610
 
670
- ##### params.privateExecutionResult
611
+ Generates proofs for a transaction execution request.
671
612
 
672
- > **privateExecutionResult**: `PrivateExecutionResult`
673
-
674
- ##### params.txRequest
613
+ #### params
675
614
 
676
- > **txRequest**: `TxExecutionRequest`
615
+ > **params**: \[`TxExecutionRequest`, `PrivateExecutionResult`?\]
677
616
 
678
617
  #### result
679
618
 
680
619
  > **result**: `TxProvingResult`
681
620
 
682
- ***
683
-
684
- ### aztec\_registerAccount
685
-
686
- > **aztec\_registerAccount**: `object`
687
-
688
- Defined in: [aztec/rpc-wallet/src/types.ts:189](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L189)
689
-
690
- #### params
621
+ #### Param
691
622
 
692
- > **params**: `object`
623
+ A tuple containing the request and optional private execution result.
693
624
 
694
- ##### params.partialAddress
625
+ #### Param
695
626
 
696
- > **partialAddress**: `Fr`
627
+ txRequest - The TxExecutionRequest to prove.
697
628
 
698
- ##### params.secretKey
629
+ #### Param
699
630
 
700
- > **secretKey**: `Fr`
631
+ privateExecutionResult - Optional: PrivateExecutionResult from a prior private simulation.
701
632
 
702
- #### result
633
+ #### Returns
703
634
 
704
- > **result**: `CompleteAddress`
635
+ result - The TxProvingResult, including the proven transaction.
705
636
 
706
637
  ***
707
638
 
@@ -709,33 +640,33 @@ Defined in: [aztec/rpc-wallet/src/types.ts:189](https://github.com/WalletMesh/wa
709
640
 
710
641
  > **aztec\_registerContract**: `object`
711
642
 
712
- Defined in: [aztec/rpc-wallet/src/types.ts:228](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L228)
643
+ Defined in: [aztec/rpc-wallet/src/types.ts:269](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L269)
713
644
 
714
- Registers a contract instance in the user's PXE.
645
+ Registers a deployed contract instance with the wallet.
715
646
 
716
647
  #### params
717
648
 
718
- > **params**: `object`
649
+ > **params**: \[`ContractInstanceWithAddress`, `undefined` \| `ContractArtifact`\]
719
650
 
720
- ##### params.artifact?
651
+ #### result
721
652
 
722
- > `optional` **artifact**: `ContractArtifact`
653
+ > **result**: `boolean`
723
654
 
724
- ##### params.instance
655
+ #### Param
725
656
 
726
- > **instance**: `ContractInstanceWithAddress`
657
+ A tuple containing the instance and optional artifact.
727
658
 
728
- #### result
659
+ #### Param
729
660
 
730
- > **result**: `boolean`
661
+ instance - The ContractInstanceWithAddress to register.
731
662
 
732
663
  #### Param
733
664
 
734
- The contract details to register
665
+ artifact - Optional: The ContractArtifact for the instance.
735
666
 
736
667
  #### Returns
737
668
 
738
- True if registration was successful
669
+ result - `true` if registration was successful.
739
670
 
740
671
  ***
741
672
 
@@ -743,17 +674,13 @@ True if registration was successful
743
674
 
744
675
  > **aztec\_registerContractClass**: `object`
745
676
 
746
- Defined in: [aztec/rpc-wallet/src/types.ts:238](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L238)
677
+ Defined in: [aztec/rpc-wallet/src/types.ts:279](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L279)
747
678
 
748
- Registers a contract class in the user's PXE.
679
+ Registers a contract class (bytecode and ABI) with the wallet.
749
680
 
750
681
  #### params
751
682
 
752
- > **params**: `object`
753
-
754
- ##### params.artifact
755
-
756
- > **artifact**: `ContractArtifact`
683
+ > **params**: \[`ContractArtifact`\]
757
684
 
758
685
  #### result
759
686
 
@@ -761,11 +688,15 @@ Registers a contract class in the user's PXE.
761
688
 
762
689
  #### Param
763
690
 
764
- The contract artifact to register
691
+ A tuple containing the artifact.
692
+
693
+ #### Param
694
+
695
+ artifact - The ContractArtifact to register.
765
696
 
766
697
  #### Returns
767
698
 
768
- True if registration was successful
699
+ result - `true` if registration was successful.
769
700
 
770
701
  ***
771
702
 
@@ -773,17 +704,13 @@ True if registration was successful
773
704
 
774
705
  > **aztec\_registerSender**: `object`
775
706
 
776
- Defined in: [aztec/rpc-wallet/src/types.ts:210](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L210)
707
+ Defined in: [aztec/rpc-wallet/src/types.ts:213](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L213)
777
708
 
778
- Registers a contact in the user's PXE
709
+ Registers a new authorized sender AztecAddress.
779
710
 
780
711
  #### params
781
712
 
782
- > **params**: `object`
783
-
784
- ##### params.sender
785
-
786
- > **sender**: `AztecAddress`
713
+ > **params**: \[`AztecAddress`\]
787
714
 
788
715
  #### result
789
716
 
@@ -791,11 +718,15 @@ Registers a contact in the user's PXE
791
718
 
792
719
  #### Param
793
720
 
794
- The sender (contact) address to register
721
+ A tuple containing the sender's address.
722
+
723
+ #### Param
724
+
725
+ senderAddress - The AztecAddress to authorize.
795
726
 
796
727
  #### Returns
797
728
 
798
- True if registration was successful
729
+ result - The registered AztecAddress.
799
730
 
800
731
  ***
801
732
 
@@ -803,191 +734,252 @@ True if registration was successful
803
734
 
804
735
  > **aztec\_removeSender**: `object`
805
736
 
806
- Defined in: [aztec/rpc-wallet/src/types.ts:212](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L212)
737
+ Defined in: [aztec/rpc-wallet/src/types.ts:229](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L229)
807
738
 
808
- #### params
739
+ Removes an AztecAddress from the list of authorized senders.
809
740
 
810
- > **params**: `object`
811
-
812
- ##### params.sender
741
+ #### params
813
742
 
814
- > **sender**: `AztecAddress`
743
+ > **params**: \[`AztecAddress`\]
815
744
 
816
745
  #### result
817
746
 
818
747
  > **result**: `boolean`
819
748
 
749
+ #### Param
750
+
751
+ A tuple containing the sender's address.
752
+
753
+ #### Param
754
+
755
+ senderAddress - The AztecAddress to de-authorize.
756
+
757
+ #### Returns
758
+
759
+ result - `true` if removal was successful.
760
+
820
761
  ***
821
762
 
822
- ### aztec\_sendTransaction
763
+ ### aztec\_sendTx
823
764
 
824
- > **aztec\_sendTransaction**: `object`
765
+ > **aztec\_sendTx**: `object`
825
766
 
826
- Defined in: [aztec/rpc-wallet/src/types.ts:101](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L101)
767
+ Defined in: [aztec/rpc-wallet/src/types.ts:302](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L302)
827
768
 
828
- Sends transactions to the Aztec network.
769
+ Sends a proven Tx (transaction) to the network.
829
770
 
830
771
  #### params
831
772
 
832
- > **params**: [`TransactionParams`](../type-aliases/TransactionParams.md)
773
+ > **params**: \[`Tx`\]
833
774
 
834
775
  #### result
835
776
 
836
- > **result**: `string`
777
+ > **result**: `TxHash`
837
778
 
838
779
  #### Param
839
780
 
840
- The transactions to execute and optional authorization witnesses
781
+ A tuple containing the proven transaction.
841
782
 
842
- #### Returns
783
+ #### Param
843
784
 
844
- The transaction hash as a string
785
+ tx - The proven Tx object to send.
845
786
 
846
- #### Inherited from
787
+ #### Returns
847
788
 
848
- [`AztecWalletBaseMethodMap`](AztecWalletBaseMethodMap.md).[`aztec_sendTransaction`](AztecWalletBaseMethodMap.md#aztec_sendtransaction)
789
+ result - The TxHash of the sent transaction.
849
790
 
850
791
  ***
851
792
 
852
- ### aztec\_sendTx
793
+ ### aztec\_simulateTx
853
794
 
854
- > **aztec\_sendTx**: `object`
795
+ > **aztec\_simulateTx**: `object`
855
796
 
856
- Defined in: [aztec/rpc-wallet/src/types.ts:243](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L243)
797
+ Defined in: [aztec/rpc-wallet/src/types.ts:326](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L326)
798
+
799
+ Simulates a TxExecutionRequest without sending it to the network.
857
800
 
858
801
  #### params
859
802
 
860
- > **params**: `object`
803
+ > **params**: \[`TxExecutionRequest`, `boolean`?, `AztecAddress`?, `boolean`?, `boolean`?\]
861
804
 
862
- ##### params.tx
805
+ #### result
863
806
 
864
- > **tx**: `Tx`
807
+ > **result**: `TxSimulationResult`
865
808
 
866
- #### result
809
+ #### Param
867
810
 
868
- > **result**: `TxHash`
811
+ A tuple containing the simulation parameters.
869
812
 
870
- ***
813
+ #### Param
871
814
 
872
- ### aztec\_setScopes
815
+ txRequest - The TxExecutionRequest to simulate.
873
816
 
874
- > **aztec\_setScopes**: `object`
817
+ #### Param
875
818
 
876
- Defined in: [aztec/rpc-wallet/src/types.ts:173](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L173)
819
+ simulatePublic - Optional: Whether to simulate public parts. Defaults to `false`.
877
820
 
878
- #### params
821
+ #### Param
879
822
 
880
- > **params**: `object`
823
+ msgSender - Optional: AztecAddress for simulation context.
881
824
 
882
- ##### params.scopes
825
+ #### Param
883
826
 
884
- > **scopes**: `AztecAddress`[]
827
+ skipTxValidation - Optional: Flag to skip validation. Defaults to `false`.
885
828
 
886
- #### result
829
+ #### Param
887
830
 
888
- > **result**: `boolean`
831
+ skipFeeEnforcement - Optional: Flag to skip fee enforcement. Defaults to `false`.
832
+
833
+ #### Returns
834
+
835
+ result - The TxSimulationResult.
889
836
 
890
837
  ***
891
838
 
892
- ### aztec\_simulateTransaction
839
+ ### aztec\_simulateUtility
893
840
 
894
- > **aztec\_simulateTransaction**: `object`
841
+ > **aztec\_simulateUtility**: `object`
895
842
 
896
- Defined in: [aztec/rpc-wallet/src/types.ts:111](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L111)
843
+ Defined in: [aztec/rpc-wallet/src/types.ts:364](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L364)
897
844
 
898
- Simulates a transaction without executing it.
845
+ Simulates a utility (view) function call.
899
846
 
900
847
  #### params
901
848
 
902
- > **params**: [`TransactionFunctionCall`](../type-aliases/TransactionFunctionCall.md)
849
+ > **params**: \[`string`, `unknown`[], `AztecAddress`, `AuthWitness`[]?, `AztecAddress`?\]
903
850
 
904
851
  #### result
905
852
 
906
- > **result**: `unknown`
853
+ > **result**: `UtilitySimulationResult`
907
854
 
908
855
  #### Param
909
856
 
910
- The transaction to simulate
857
+ A tuple containing the utility call parameters.
911
858
 
912
- #### Returns
859
+ #### Param
913
860
 
914
- The simulation result
861
+ functionName - Name of the utility function.
915
862
 
916
- #### Inherited from
863
+ #### Param
917
864
 
918
- [`AztecWalletBaseMethodMap`](AztecWalletBaseMethodMap.md).[`aztec_simulateTransaction`](AztecWalletBaseMethodMap.md#aztec_simulatetransaction)
865
+ args - Arguments for the function.
919
866
 
920
- ***
867
+ #### Param
921
868
 
922
- ### aztec\_simulateTx
869
+ to - AztecAddress of the contract/account.
923
870
 
924
- > **aztec\_simulateTx**: `object`
871
+ #### Param
925
872
 
926
- Defined in: [aztec/rpc-wallet/src/types.ts:252](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L252)
873
+ authWits - Optional: Array of AuthWitness.
927
874
 
928
- #### params
875
+ #### Param
876
+
877
+ from - Optional: Sender AztecAddress.
929
878
 
930
- > **params**: `object`
879
+ #### Returns
931
880
 
932
- ##### params.enforceFeePayment?
881
+ result - The UtilitySimulationResult.
933
882
 
934
- > `optional` **enforceFeePayment**: `boolean`
883
+ ***
935
884
 
936
- ##### params.msgSender?
885
+ ### aztec\_wmDeployContract
937
886
 
938
- > `optional` **msgSender**: `AztecAddress`
887
+ > **aztec\_wmDeployContract**: `object`
939
888
 
940
- ##### params.profile?
889
+ Defined in: [aztec/rpc-wallet/src/types.ts:434](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L434)
941
890
 
942
- > `optional` **profile**: `boolean`
891
+ WalletMesh specific: Deploys a new contract using its artifact and constructor arguments.
892
+ The wallet handles address computation, proving, and sending the deployment transaction.
943
893
 
944
- ##### params.simulatePublic
894
+ #### params
945
895
 
946
- > **simulatePublic**: `boolean`
896
+ > **params**: \[\{ `args`: `unknown`[]; `artifact`: `ContractArtifact`; `constructorName?`: `string`; \}\]
947
897
 
948
- ##### params.skipTxValidation?
898
+ #### result
949
899
 
950
- > `optional` **skipTxValidation**: `boolean`
900
+ > **result**: `object`
951
901
 
952
- ##### params.txRequest
902
+ ##### result.contractAddress
953
903
 
954
- > **txRequest**: `TxExecutionRequest`
904
+ > **contractAddress**: `AztecAddress`
955
905
 
956
- #### result
906
+ ##### result.txHash
957
907
 
958
- > **result**: `TxSimulationResult`
908
+ > **txHash**: `TxHash`
909
+
910
+ #### Param
911
+
912
+ A tuple containing the deployment parameters.
913
+
914
+ #### Param
915
+
916
+ deploymentParams - Object containing `artifact` (ContractArtifact), `args` (array),
917
+ and optional `constructorName` (string).
918
+
919
+ #### Returns
920
+
921
+ result - An object with `txHash` (TxHash) and `contractAddress` (AztecAddress).
959
922
 
960
923
  ***
961
924
 
962
- ### aztec\_simulateUnconstrained
925
+ ### aztec\_wmExecuteTx
926
+
927
+ > **aztec\_wmExecuteTx**: `object`
963
928
 
964
- > **aztec\_simulateUnconstrained**: `object`
929
+ Defined in: [aztec/rpc-wallet/src/types.ts:421](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L421)
965
930
 
966
- Defined in: [aztec/rpc-wallet/src/types.ts:263](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L263)
931
+ WalletMesh specific: Executes a contract function interaction using a pre-constructed ExecutionPayload.
932
+ The wallet handles simulation, proving, and sending.
967
933
 
968
934
  #### params
969
935
 
970
- > **params**: `object`
936
+ > **params**: \[`ExecutionPayload`\]
937
+
938
+ #### result
939
+
940
+ > **result**: `TxHash`
941
+
942
+ #### Param
943
+
944
+ A tuple containing the execution payload.
945
+
946
+ #### Param
947
+
948
+ executionPayload - The ExecutionPayload to execute.
971
949
 
972
- ##### params.args
950
+ #### Returns
951
+
952
+ result - The TxHash of the sent transaction.
973
953
 
974
- > **args**: `unknown`[]
954
+ ***
975
955
 
976
- ##### params.from?
956
+ ### aztec\_wmSimulateTx
977
957
 
978
- > `optional` **from**: `AztecAddress`
958
+ > **aztec\_wmSimulateTx**: `object`
979
959
 
980
- ##### params.functionName
960
+ Defined in: [aztec/rpc-wallet/src/types.ts:454](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L454)
981
961
 
982
- > **functionName**: `string`
962
+ WalletMesh specific: Simulates a contract function interaction using a pre-constructed ExecutionPayload.
983
963
 
984
- ##### params.to
964
+ #### params
985
965
 
986
- > **to**: `AztecAddress`
966
+ > **params**: \[`ExecutionPayload`\]
987
967
 
988
968
  #### result
989
969
 
990
- > **result**: `AbiDecoded`
970
+ > **result**: `TxSimulationResult`
971
+
972
+ #### Param
973
+
974
+ A tuple containing the execution payload.
975
+
976
+ #### Param
977
+
978
+ executionPayload - The ExecutionPayload to simulate.
979
+
980
+ #### Returns
981
+
982
+ result - The TxSimulationResult.
991
983
 
992
984
  ***
993
985
 
@@ -995,18 +987,27 @@ Defined in: [aztec/rpc-wallet/src/types.ts:263](https://github.com/WalletMesh/wa
995
987
 
996
988
  > **wm\_getSupportedMethods**: `object`
997
989
 
998
- Defined in: [aztec/rpc-wallet/src/types.ts:120](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L120)
990
+ Defined in: [aztec/rpc-wallet/src/types.ts:126](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L126)
999
991
 
1000
- Returns the list of supported methods for the wallet.
992
+ Retrieves a list of all JSON-RPC methods supported by this wallet implementation.
993
+ Allows clients to discover the capabilities of the wallet.
994
+
995
+ #### params
996
+
997
+ > **params**: \[\]
1001
998
 
1002
999
  #### result
1003
1000
 
1004
1001
  > **result**: `string`[]
1005
1002
 
1003
+ #### Param
1004
+
1005
+ No parameters.
1006
+
1006
1007
  #### Returns
1007
1008
 
1008
- An array of supported methods
1009
+ result - An array of strings, where each string is a supported method name.
1009
1010
 
1010
- #### Inherited from
1011
+ #### Overrides
1011
1012
 
1012
- [`AztecWalletBaseMethodMap`](AztecWalletBaseMethodMap.md).[`wm_getSupportedMethods`](AztecWalletBaseMethodMap.md#wm_getsupportedmethods)
1013
+ `WalletMethodMap.wm_getSupportedMethods`