@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.
- package/CHANGELOG.md +26 -0
- package/README.md +290 -228
- package/dist/.tsbuildinfo +1 -1
- package/dist/client/aztec-dapp-wallet.d.ts +401 -0
- package/dist/client/aztec-dapp-wallet.d.ts.map +1 -0
- package/dist/client/aztec-dapp-wallet.js +705 -0
- package/dist/client/aztec-router-provider.d.ts +58 -0
- package/dist/client/aztec-router-provider.d.ts.map +1 -0
- package/dist/client/aztec-router-provider.js +62 -0
- package/dist/client/helpers.d.ts +44 -0
- package/dist/client/helpers.d.ts.map +1 -0
- package/dist/client/helpers.js +79 -0
- package/dist/client/register-serializers.d.ts +41 -0
- package/dist/client/register-serializers.d.ts.map +1 -0
- package/dist/client/register-serializers.js +97 -0
- package/dist/contractArtifactCache.d.ts +49 -32
- package/dist/contractArtifactCache.d.ts.map +1 -1
- package/dist/contractArtifactCache.js +47 -34
- package/dist/errors.d.ts +50 -8
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js +50 -10
- package/dist/index.d.ts +53 -40
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +52 -17
- package/dist/types.d.ts +345 -268
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +10 -8
- package/dist/wallet/create-node.d.ts +73 -0
- package/dist/wallet/create-node.d.ts.map +1 -0
- package/dist/wallet/create-node.js +99 -0
- package/dist/wallet/handlers/account.d.ts +67 -0
- package/dist/wallet/handlers/account.d.ts.map +1 -0
- package/dist/wallet/handlers/account.js +85 -0
- package/dist/wallet/handlers/contract-interaction.d.ts +77 -0
- package/dist/wallet/handlers/contract-interaction.d.ts.map +1 -0
- package/dist/wallet/handlers/contract-interaction.js +219 -0
- package/dist/wallet/handlers/contract.d.ts +96 -0
- package/dist/wallet/handlers/contract.d.ts.map +1 -0
- package/dist/wallet/handlers/contract.js +146 -0
- package/dist/wallet/handlers/event.d.ts +62 -0
- package/dist/wallet/handlers/event.d.ts.map +1 -0
- package/dist/wallet/handlers/event.js +85 -0
- package/dist/wallet/handlers/index.d.ts +88 -0
- package/dist/wallet/handlers/index.d.ts.map +1 -0
- package/dist/wallet/handlers/index.js +47 -0
- package/dist/wallet/handlers/node.d.ts +117 -0
- package/dist/wallet/handlers/node.d.ts.map +1 -0
- package/dist/wallet/handlers/node.js +196 -0
- package/dist/wallet/handlers/senders.d.ts +70 -0
- package/dist/wallet/handlers/senders.d.ts.map +1 -0
- package/dist/wallet/handlers/senders.js +92 -0
- package/dist/wallet/handlers/transaction.d.ts +123 -0
- package/dist/wallet/handlers/transaction.d.ts.map +1 -0
- package/dist/wallet/handlers/transaction.js +191 -0
- package/dist/wallet/serializers.d.ts +75 -0
- package/dist/wallet/serializers.d.ts.map +1 -0
- package/dist/wallet/serializers.js +501 -0
- package/docs/README.md +290 -229
- package/docs/classes/AztecDappWallet.md +1304 -0
- package/docs/classes/AztecRouterProvider.md +1058 -0
- package/docs/classes/AztecWalletError.md +124 -47
- package/docs/classes/ContractArtifactCache.md +48 -31
- package/docs/functions/connectAztec.md +62 -0
- package/docs/functions/createAztecWallet.md +46 -0
- package/docs/functions/createAztecWalletNode.md +96 -0
- package/docs/functions/registerAztecSerializers.md +61 -0
- package/docs/functions/registerWalletAztecSerializers.md +39 -0
- package/docs/globals.md +16 -14
- package/docs/interfaces/AztecHandlerContext.md +54 -0
- package/docs/interfaces/AztecWalletContext.md +50 -0
- package/docs/interfaces/AztecWalletMethodMap.md +471 -470
- package/docs/type-aliases/AztecChainId.md +16 -3
- package/docs/variables/ALL_AZTEC_METHODS.md +20 -0
- package/docs/variables/AztecWalletErrorMap.md +9 -4
- package/docs/variables/AztecWalletSerializer.md +45 -0
- package/package.json +9 -9
- package/src/client/aztec-dapp-wallet.test.ts +628 -0
- package/src/client/aztec-dapp-wallet.ts +879 -0
- package/src/client/aztec-router-provider.test.ts +235 -0
- package/src/client/aztec-router-provider.ts +64 -0
- package/src/client/helpers.test.ts +187 -0
- package/src/client/helpers.ts +91 -0
- package/src/client/register-serializers.ts +108 -0
- package/src/contractArtifactCache.test.ts +21 -10
- package/src/contractArtifactCache.ts +54 -35
- package/src/errors.ts +58 -10
- package/src/index.test.ts +2 -6
- package/src/index.ts +73 -37
- package/src/types.ts +379 -217
- package/src/wallet/create-node.test.ts +332 -0
- package/src/wallet/create-node.ts +120 -0
- package/src/wallet/handlers/account.test.ts +172 -0
- package/src/wallet/handlers/account.ts +99 -0
- package/src/wallet/handlers/contract-interaction.test.ts +248 -0
- package/src/wallet/handlers/contract-interaction.ts +269 -0
- package/src/wallet/handlers/contract.test.ts +245 -0
- package/src/wallet/handlers/contract.ts +174 -0
- package/src/wallet/handlers/event.test.ts +216 -0
- package/src/wallet/handlers/event.ts +99 -0
- package/src/wallet/handlers/index.ts +84 -0
- package/src/wallet/handlers/node.test.ts +304 -0
- package/src/wallet/handlers/node.ts +230 -0
- package/src/wallet/handlers/senders.test.ts +172 -0
- package/src/wallet/handlers/senders.ts +106 -0
- package/src/wallet/handlers/transaction.test.ts +371 -0
- package/src/wallet/handlers/transaction.ts +239 -0
- package/src/wallet/serializers.test.ts +253 -0
- package/src/wallet/serializers.ts +586 -0
- package/typedoc.json +23 -1
- package/dist/aztecRemoteWallet.d.ts +0 -70
- package/dist/aztecRemoteWallet.d.ts.map +0 -1
- package/dist/aztecRemoteWallet.js +0 -335
- package/dist/chainProvider.d.ts +0 -56
- package/dist/chainProvider.d.ts.map +0 -1
- package/dist/chainProvider.js +0 -98
- package/dist/handlers/aztecAccountWallet.d.ts +0 -4
- package/dist/handlers/aztecAccountWallet.d.ts.map +0 -1
- package/dist/handlers/aztecAccountWallet.js +0 -296
- package/dist/handlers/transactions.d.ts +0 -21
- package/dist/handlers/transactions.d.ts.map +0 -1
- package/dist/handlers/transactions.js +0 -98
- package/dist/handlers.d.ts +0 -27
- package/dist/handlers.d.ts.map +0 -1
- package/dist/handlers.js +0 -55
- package/dist/provider.d.ts +0 -105
- package/dist/provider.d.ts.map +0 -1
- package/dist/provider.js +0 -160
- package/dist/serializers/account.d.ts +0 -164
- package/dist/serializers/account.d.ts.map +0 -1
- package/dist/serializers/account.js +0 -244
- package/dist/serializers/contract.d.ts +0 -62
- package/dist/serializers/contract.d.ts.map +0 -1
- package/dist/serializers/contract.js +0 -130
- package/dist/serializers/index.d.ts +0 -21
- package/dist/serializers/index.d.ts.map +0 -1
- package/dist/serializers/index.js +0 -154
- package/dist/serializers/log.d.ts +0 -66
- package/dist/serializers/log.d.ts.map +0 -1
- package/dist/serializers/log.js +0 -222
- package/dist/serializers/note.d.ts +0 -124
- package/dist/serializers/note.d.ts.map +0 -1
- package/dist/serializers/note.js +0 -208
- package/dist/serializers/transaction.d.ts +0 -99
- package/dist/serializers/transaction.d.ts.map +0 -1
- package/dist/serializers/transaction.js +0 -275
- package/dist/wallet.d.ts +0 -62
- package/dist/wallet.d.ts.map +0 -1
- package/dist/wallet.js +0 -77
- package/docs/classes/AztecChainProvider.md +0 -553
- package/docs/classes/AztecChainWallet.md +0 -409
- package/docs/classes/AztecProvider.md +0 -1112
- package/docs/interfaces/AztecWalletBaseMethodMap.md +0 -135
- package/docs/interfaces/AztecWalletEventMap.md +0 -17
- package/docs/type-aliases/AztecChainWalletMiddleware.md +0 -13
- package/docs/type-aliases/AztecWalletContext.md +0 -29
- package/docs/type-aliases/AztecWalletMethodHandler.md +0 -37
- package/docs/type-aliases/AztecWalletMiddleware.md +0 -13
- package/docs/type-aliases/AztecWalletRouterClient.md +0 -13
- package/docs/type-aliases/TransactionFunctionCall.md +0 -33
- package/docs/type-aliases/TransactionParams.md +0 -27
- package/src/aztecRemoteWallet.test.ts +0 -504
- package/src/aztecRemoteWallet.ts +0 -467
- package/src/chainProvider.test.ts +0 -401
- package/src/chainProvider.ts +0 -116
- package/src/handlers/aztecAccountWallet.test.ts +0 -649
- package/src/handlers/aztecAccountWallet.ts +0 -532
- package/src/handlers/transactions.ts +0 -124
- package/src/handlers.test.ts +0 -270
- package/src/handlers.ts +0 -70
- package/src/provider.test.ts +0 -274
- package/src/provider.ts +0 -189
- package/src/serializers/account.test.ts +0 -125
- package/src/serializers/account.ts +0 -301
- package/src/serializers/contract.test.ts +0 -24
- package/src/serializers/contract.ts +0 -183
- package/src/serializers/index.test.ts +0 -136
- package/src/serializers/index.ts +0 -191
- package/src/serializers/log.test.ts +0 -286
- package/src/serializers/log.ts +0 -292
- package/src/serializers/note.test.ts +0 -125
- package/src/serializers/note.ts +0 -250
- package/src/serializers/transaction.test.ts +0 -320
- package/src/serializers/transaction.ts +0 -409
- package/src/wallet.test.ts +0 -275
- package/src/wallet.ts +0 -94
@@ -1,4 +1,4 @@
|
|
1
|
-
[**@walletmesh/aztec-rpc-wallet v0.
|
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:
|
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
|
-
|
12
|
-
This extends the
|
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
|
-
-
|
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\
|
25
|
-
|
26
|
-
> **aztec\_addAuthWitness**: `object`
|
38
|
+
### aztec\_createAuthWit
|
27
39
|
|
28
|
-
|
40
|
+
> **aztec\_createAuthWit**: `object`
|
29
41
|
|
30
|
-
|
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
|
-
|
44
|
+
Creates an AuthWitness (authorization witness) for a given message hash or intent.
|
45
|
+
Used for delegating actions.
|
33
46
|
|
34
|
-
|
47
|
+
#### params
|
35
48
|
|
36
|
-
> **
|
49
|
+
> **params**: \[`Fr` \| `Buffer`\<`ArrayBufferLike`\> \| `IntentAction` \| `IntentInnerHash`\]
|
37
50
|
|
38
51
|
#### result
|
39
52
|
|
40
|
-
> **result**: `
|
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
|
-
####
|
55
|
+
#### Param
|
51
56
|
|
52
|
-
|
57
|
+
A tuple containing the intent to authorize.
|
53
58
|
|
54
|
-
|
59
|
+
#### Param
|
55
60
|
|
56
|
-
|
61
|
+
intent - The message hash (Fr or `Buffer`), IntentInnerHash, or IntentAction to authorize.
|
57
62
|
|
58
|
-
####
|
63
|
+
#### Returns
|
59
64
|
|
60
|
-
|
65
|
+
result - The created AuthWitness.
|
61
66
|
|
62
67
|
***
|
63
68
|
|
64
|
-
### aztec\
|
69
|
+
### aztec\_getAddress
|
65
70
|
|
66
|
-
> **aztec\
|
71
|
+
> **aztec\_getAddress**: `object`
|
67
72
|
|
68
|
-
Defined in: [aztec/rpc-wallet/src/types.ts:
|
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
|
-
|
75
|
+
Retrieves the primary AztecAddress of the wallet's account.
|
71
76
|
|
72
|
-
|
73
|
-
|
74
|
-
##### params.note
|
77
|
+
#### params
|
75
78
|
|
76
|
-
> **
|
79
|
+
> **params**: \[\]
|
77
80
|
|
78
81
|
#### result
|
79
82
|
|
80
|
-
> **result**: `
|
83
|
+
> **result**: `AztecAddress`
|
81
84
|
|
82
|
-
|
85
|
+
#### Param
|
83
86
|
|
84
|
-
|
87
|
+
No parameters.
|
85
88
|
|
86
|
-
|
89
|
+
#### Returns
|
87
90
|
|
88
|
-
|
91
|
+
result - The wallet's AztecAddress.
|
89
92
|
|
90
|
-
|
93
|
+
***
|
91
94
|
|
92
|
-
|
95
|
+
### aztec\_getBlock
|
93
96
|
|
94
|
-
|
97
|
+
> **aztec\_getBlock**: `object`
|
95
98
|
|
96
|
-
|
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
|
-
|
101
|
+
Retrieves a specific L2 block by its number.
|
99
102
|
|
100
|
-
|
103
|
+
#### params
|
101
104
|
|
102
|
-
|
105
|
+
> **params**: \[`number`\]
|
103
106
|
|
104
|
-
|
107
|
+
#### result
|
105
108
|
|
106
|
-
> **
|
109
|
+
> **result**: `L2Block`
|
107
110
|
|
108
|
-
|
111
|
+
#### Param
|
109
112
|
|
110
|
-
|
113
|
+
A tuple containing the block number.
|
111
114
|
|
112
|
-
####
|
115
|
+
#### Param
|
113
116
|
|
114
|
-
|
117
|
+
blockNumber - The number of the block to retrieve.
|
115
118
|
|
116
119
|
#### Returns
|
117
120
|
|
118
|
-
|
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\
|
127
|
-
|
128
|
-
> **aztec\_createAuthWit**: `object`
|
125
|
+
### aztec\_getBlockNumber
|
129
126
|
|
130
|
-
|
127
|
+
> **aztec\_getBlockNumber**: `object`
|
131
128
|
|
132
|
-
|
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
|
-
|
131
|
+
Retrieves the current (latest) L2 block number.
|
135
132
|
|
136
|
-
|
133
|
+
#### params
|
137
134
|
|
138
|
-
> **
|
135
|
+
> **params**: \[\]
|
139
136
|
|
140
137
|
#### result
|
141
138
|
|
142
|
-
> **result**: `
|
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
|
-
####
|
141
|
+
#### Param
|
153
142
|
|
154
|
-
|
143
|
+
No parameters.
|
155
144
|
|
156
|
-
|
145
|
+
#### Returns
|
157
146
|
|
158
|
-
|
147
|
+
result - The current block number.
|
159
148
|
|
160
|
-
|
149
|
+
***
|
161
150
|
|
162
|
-
|
151
|
+
### aztec\_getChainId
|
163
152
|
|
164
|
-
|
153
|
+
> **aztec\_getChainId**: `object`
|
165
154
|
|
166
|
-
|
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
|
-
|
157
|
+
Retrieves the chain ID of the connected Aztec network.
|
169
158
|
|
170
|
-
|
159
|
+
#### params
|
171
160
|
|
172
|
-
|
161
|
+
> **params**: \[\]
|
173
162
|
|
174
163
|
#### result
|
175
164
|
|
176
|
-
> **result**: `
|
165
|
+
> **result**: `Fr`
|
177
166
|
|
178
|
-
####
|
167
|
+
#### Param
|
179
168
|
|
180
|
-
|
169
|
+
No parameters.
|
181
170
|
|
182
|
-
####
|
171
|
+
#### Returns
|
183
172
|
|
184
|
-
|
173
|
+
result - The chain ID as an Fr.
|
185
174
|
|
186
175
|
***
|
187
176
|
|
188
|
-
### aztec\
|
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
|
-
|
179
|
+
> **aztec\_getCompleteAddress**: `object`
|
201
180
|
|
202
|
-
|
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
|
-
|
183
|
+
Retrieves the CompleteAddress of the wallet's account, including public keys.
|
205
184
|
|
206
185
|
#### params
|
207
186
|
|
208
|
-
> **params**:
|
209
|
-
|
210
|
-
##### params.messageHash
|
211
|
-
|
212
|
-
> **messageHash**: `Fr`
|
187
|
+
> **params**: \[\]
|
213
188
|
|
214
189
|
#### result
|
215
190
|
|
216
|
-
> **result**: `
|
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
|
-
|
193
|
+
#### Param
|
231
194
|
|
232
|
-
|
195
|
+
No parameters.
|
233
196
|
|
234
|
-
####
|
197
|
+
#### Returns
|
235
198
|
|
236
|
-
|
199
|
+
result - The wallet's CompleteAddress.
|
237
200
|
|
238
201
|
***
|
239
202
|
|
240
|
-
### aztec\
|
241
|
-
|
242
|
-
> **aztec\_getBlockNumber**: `object`
|
203
|
+
### aztec\_getContractClassMetadata
|
243
204
|
|
244
|
-
|
205
|
+
> **aztec\_getContractClassMetadata**: `object`
|
245
206
|
|
246
|
-
|
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
|
-
|
209
|
+
Retrieves ContractClassMetadata for a specific contract class.
|
249
210
|
|
250
|
-
|
211
|
+
#### params
|
251
212
|
|
252
|
-
|
213
|
+
> **params**: \[`Fr`, `undefined` \| `boolean`\]
|
253
214
|
|
254
|
-
|
215
|
+
#### result
|
255
216
|
|
256
|
-
|
217
|
+
> **result**: `ContractClassMetadata`
|
257
218
|
|
258
|
-
####
|
219
|
+
#### Param
|
259
220
|
|
260
|
-
|
221
|
+
A tuple containing the class ID and an optional flag.
|
261
222
|
|
262
|
-
|
223
|
+
#### Param
|
263
224
|
|
264
|
-
|
225
|
+
classId - The Fr ID of the contract class.
|
265
226
|
|
266
|
-
|
227
|
+
#### Param
|
267
228
|
|
268
|
-
|
229
|
+
includeArtifact - Optional: Boolean indicating whether to include the full ContractArtifact.
|
269
230
|
|
270
|
-
####
|
231
|
+
#### Returns
|
271
232
|
|
272
|
-
|
233
|
+
result - The ContractClassMetadata.
|
273
234
|
|
274
235
|
***
|
275
236
|
|
276
|
-
### aztec\
|
277
|
-
|
278
|
-
> **aztec\_getContractClassLogs**: `object`
|
237
|
+
### aztec\_getContractMetadata
|
279
238
|
|
280
|
-
|
239
|
+
> **aztec\_getContractMetadata**: `object`
|
281
240
|
|
282
|
-
|
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
|
-
|
243
|
+
Retrieves ContractMetadata for a specific deployed contract.
|
285
244
|
|
286
|
-
|
245
|
+
#### params
|
287
246
|
|
288
|
-
> **
|
247
|
+
> **params**: \[`AztecAddress`\]
|
289
248
|
|
290
249
|
#### result
|
291
250
|
|
292
|
-
> **result**: `
|
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
|
-
|
253
|
+
#### Param
|
307
254
|
|
308
|
-
|
255
|
+
A tuple containing the contract's address.
|
309
256
|
|
310
|
-
|
257
|
+
#### Param
|
311
258
|
|
312
|
-
|
259
|
+
contractAddress - The AztecAddress of the contract.
|
313
260
|
|
314
|
-
####
|
261
|
+
#### Returns
|
315
262
|
|
316
|
-
|
263
|
+
result - The ContractMetadata for the specified contract.
|
317
264
|
|
318
265
|
***
|
319
266
|
|
320
|
-
### aztec\
|
321
|
-
|
322
|
-
> **aztec\_getContractMetadata**: `object`
|
267
|
+
### aztec\_getContracts
|
323
268
|
|
324
|
-
|
269
|
+
> **aztec\_getContracts**: `object`
|
325
270
|
|
326
|
-
|
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
|
-
|
273
|
+
Retrieves a list of all AztecAddresses of contracts known to the PXE/wallet.
|
329
274
|
|
330
|
-
|
275
|
+
#### params
|
331
276
|
|
332
|
-
> **
|
277
|
+
> **params**: \[\]
|
333
278
|
|
334
279
|
#### result
|
335
280
|
|
336
|
-
> **result**: `
|
337
|
-
|
338
|
-
***
|
281
|
+
> **result**: `AztecAddress`[]
|
339
282
|
|
340
|
-
|
283
|
+
#### Param
|
341
284
|
|
342
|
-
|
285
|
+
No parameters.
|
343
286
|
|
344
|
-
|
287
|
+
#### Returns
|
345
288
|
|
346
|
-
|
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:
|
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
|
-
|
299
|
+
Retrieves the current base gas fees on the network.
|
369
300
|
|
370
301
|
#### params
|
371
302
|
|
372
|
-
> **params**:
|
303
|
+
> **params**: \[\]
|
373
304
|
|
374
|
-
|
375
|
-
|
376
|
-
> **contractAddress**: `AztecAddress`
|
377
|
-
|
378
|
-
##### params.messageHash
|
305
|
+
#### result
|
379
306
|
|
380
|
-
> **
|
307
|
+
> **result**: `GasFees`
|
381
308
|
|
382
|
-
|
309
|
+
#### Param
|
383
310
|
|
384
|
-
|
311
|
+
No parameters.
|
385
312
|
|
386
|
-
####
|
313
|
+
#### Returns
|
387
314
|
|
388
|
-
|
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:
|
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
|
-
|
339
|
+
#### Returns
|
405
340
|
|
406
|
-
|
341
|
+
result - A NodeInfo object.
|
407
342
|
|
408
|
-
|
343
|
+
***
|
409
344
|
|
410
|
-
|
345
|
+
### aztec\_getPrivateEvents
|
411
346
|
|
412
|
-
> **
|
347
|
+
> **aztec\_getPrivateEvents**: `object`
|
413
348
|
|
414
|
-
|
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
|
-
|
351
|
+
Retrieves private (encrypted) events from the blockchain.
|
417
352
|
|
418
|
-
####
|
353
|
+
#### params
|
419
354
|
|
420
|
-
> **
|
355
|
+
> **params**: \[`AztecAddress`, `EventMetadataDefinition`, `number`, `number`, `AztecAddress`[]\]
|
421
356
|
|
422
|
-
|
357
|
+
#### result
|
423
358
|
|
424
|
-
|
359
|
+
> **result**: `unknown`[]
|
425
360
|
|
426
|
-
|
361
|
+
#### Param
|
427
362
|
|
428
|
-
|
363
|
+
A tuple containing the query parameters.
|
429
364
|
|
430
|
-
####
|
365
|
+
#### Param
|
431
366
|
|
432
|
-
|
367
|
+
contractAddress - AztecAddress of the emitting contract.
|
433
368
|
|
434
|
-
|
369
|
+
#### Param
|
435
370
|
|
436
|
-
|
371
|
+
eventMetadata - EventMetadataDefinition for the event.
|
437
372
|
|
438
|
-
|
373
|
+
#### Param
|
439
374
|
|
440
|
-
|
375
|
+
fromBlock - Starting block number.
|
441
376
|
|
442
|
-
|
377
|
+
#### Param
|
443
378
|
|
444
|
-
|
379
|
+
numBlocks - Number of blocks to scan.
|
445
380
|
|
446
|
-
|
381
|
+
#### Param
|
447
382
|
|
448
|
-
|
383
|
+
recipients - Array of recipient AztecAddresses.
|
449
384
|
|
450
|
-
####
|
385
|
+
#### Returns
|
451
386
|
|
452
|
-
|
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:
|
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
|
-
|
409
|
+
No parameters.
|
471
410
|
|
472
|
-
|
411
|
+
#### Returns
|
473
412
|
|
474
|
-
|
413
|
+
result - The latest proven block number.
|
475
414
|
|
476
|
-
|
415
|
+
***
|
477
416
|
|
478
|
-
|
417
|
+
### aztec\_getPublicEvents
|
479
418
|
|
480
|
-
> **
|
419
|
+
> **aztec\_getPublicEvents**: `object`
|
481
420
|
|
482
|
-
|
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
|
-
|
423
|
+
Retrieves public (unencrypted) events from the blockchain.
|
485
424
|
|
486
|
-
|
425
|
+
#### params
|
487
426
|
|
488
|
-
> **
|
427
|
+
> **params**: \[`EventMetadataDefinition`, `number`, `number`\]
|
489
428
|
|
490
429
|
#### result
|
491
430
|
|
492
431
|
> **result**: `unknown`[]
|
493
432
|
|
494
|
-
|
433
|
+
#### Param
|
495
434
|
|
496
|
-
|
435
|
+
A tuple containing the query parameters.
|
497
436
|
|
498
|
-
|
437
|
+
#### Param
|
499
438
|
|
500
|
-
|
439
|
+
eventMetadata - EventMetadataDefinition for the event.
|
501
440
|
|
502
|
-
####
|
441
|
+
#### Param
|
503
442
|
|
504
|
-
|
443
|
+
fromBlock - Starting block number.
|
505
444
|
|
506
|
-
|
445
|
+
#### Param
|
507
446
|
|
508
|
-
|
447
|
+
limit - Maximum number of events to return.
|
509
448
|
|
510
|
-
####
|
449
|
+
#### Returns
|
511
450
|
|
512
|
-
|
451
|
+
result - An array of decoded public event data (type `unknown[]`, actual type depends on `eventMetadata`).
|
513
452
|
|
514
453
|
***
|
515
454
|
|
516
|
-
### aztec\
|
455
|
+
### aztec\_getPXEInfo
|
456
|
+
|
457
|
+
> **aztec\_getPXEInfo**: `object`
|
517
458
|
|
518
|
-
|
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
|
-
|
461
|
+
Retrieves information about the PXE service, including capabilities and version.
|
521
462
|
|
522
463
|
#### params
|
523
464
|
|
524
|
-
> **params**:
|
465
|
+
> **params**: \[\]
|
525
466
|
|
526
|
-
|
467
|
+
#### result
|
527
468
|
|
528
|
-
> **
|
469
|
+
> **result**: `PXEInfo`
|
529
470
|
|
530
|
-
|
471
|
+
#### Param
|
531
472
|
|
532
|
-
|
473
|
+
No parameters.
|
533
474
|
|
534
|
-
####
|
475
|
+
#### Returns
|
535
476
|
|
536
|
-
|
477
|
+
result - A PXEInfo object.
|
537
478
|
|
538
479
|
***
|
539
480
|
|
540
|
-
### aztec\
|
481
|
+
### aztec\_getSenders
|
541
482
|
|
542
|
-
> **aztec\
|
483
|
+
> **aztec\_getSenders**: `object`
|
543
484
|
|
544
|
-
Defined in: [aztec/rpc-wallet/src/types.ts:
|
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
|
-
|
487
|
+
Retrieves a list of all currently authorized sender AztecAddresses.
|
547
488
|
|
548
|
-
|
489
|
+
#### params
|
549
490
|
|
550
|
-
|
491
|
+
> **params**: \[\]
|
551
492
|
|
552
|
-
|
493
|
+
#### result
|
553
494
|
|
554
|
-
> **
|
495
|
+
> **result**: `AztecAddress`[]
|
555
496
|
|
556
|
-
|
497
|
+
#### Param
|
557
498
|
|
558
|
-
|
499
|
+
No parameters.
|
559
500
|
|
560
|
-
|
501
|
+
#### Returns
|
502
|
+
|
503
|
+
result - An array of authorized AztecAddresses.
|
561
504
|
|
562
505
|
***
|
563
506
|
|
564
|
-
### aztec\
|
507
|
+
### aztec\_getTxReceipt
|
565
508
|
|
566
|
-
> **aztec\
|
509
|
+
> **aztec\_getTxReceipt**: `object`
|
567
510
|
|
568
|
-
Defined in: [aztec/rpc-wallet/src/types.ts:
|
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**: `
|
521
|
+
> **result**: `TxReceipt`
|
573
522
|
|
574
|
-
|
523
|
+
#### Param
|
575
524
|
|
576
|
-
|
525
|
+
A tuple containing the transaction hash.
|
577
526
|
|
578
|
-
|
527
|
+
#### Param
|
579
528
|
|
580
|
-
|
529
|
+
txHash - The TxHash of the transaction.
|
581
530
|
|
582
|
-
####
|
531
|
+
#### Returns
|
583
532
|
|
584
|
-
|
533
|
+
result - The TxReceipt.
|
585
534
|
|
586
535
|
***
|
587
536
|
|
588
|
-
### aztec\
|
589
|
-
|
590
|
-
> **aztec\_getTxEffect**: `object`
|
537
|
+
### aztec\_getVersion
|
591
538
|
|
592
|
-
|
539
|
+
> **aztec\_getVersion**: `object`
|
593
540
|
|
594
|
-
|
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
|
-
|
543
|
+
Retrieves the version of the connected PXE (Private Execution Environment) or node.
|
597
544
|
|
598
|
-
|
545
|
+
#### params
|
599
546
|
|
600
|
-
> **
|
547
|
+
> **params**: \[\]
|
601
548
|
|
602
549
|
#### result
|
603
550
|
|
604
|
-
> **result**: `
|
551
|
+
> **result**: `Fr`
|
605
552
|
|
606
|
-
|
607
|
-
|
608
|
-
### aztec\_getTxReceipt
|
553
|
+
#### Param
|
609
554
|
|
610
|
-
|
555
|
+
No parameters.
|
611
556
|
|
612
|
-
|
557
|
+
#### Returns
|
613
558
|
|
614
|
-
|
559
|
+
result - The version as an Fr.
|
615
560
|
|
616
|
-
|
561
|
+
***
|
617
562
|
|
618
|
-
|
563
|
+
### aztec\_profileTx
|
619
564
|
|
620
|
-
> **
|
565
|
+
> **aztec\_profileTx**: `object`
|
621
566
|
|
622
|
-
|
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
|
-
|
569
|
+
Profiles a TxExecutionRequest for performance analysis.
|
625
570
|
|
626
|
-
|
571
|
+
#### params
|
627
572
|
|
628
|
-
|
573
|
+
> **params**: \[`TxExecutionRequest`, (`"gates"` \| `"execution-steps"` \| `"full"`)?, `boolean`?, `AztecAddress`?\]
|
629
574
|
|
630
|
-
|
575
|
+
#### result
|
631
576
|
|
632
|
-
|
577
|
+
> **result**: `TxProfileResult`
|
633
578
|
|
634
|
-
####
|
579
|
+
#### Param
|
635
580
|
|
636
|
-
|
581
|
+
A tuple containing the profiling parameters.
|
637
582
|
|
638
|
-
|
583
|
+
#### Param
|
639
584
|
|
640
|
-
|
585
|
+
txRequest - The TxExecutionRequest to profile.
|
641
586
|
|
642
|
-
|
587
|
+
#### Param
|
643
588
|
|
644
|
-
|
589
|
+
profileMode - Optional: Profiling mode ('gates', 'execution-steps', 'full'). Defaults to 'gates'.
|
645
590
|
|
646
|
-
####
|
591
|
+
#### Param
|
647
592
|
|
648
|
-
|
593
|
+
skipProofGeneration - Optional: Flag to skip proof generation. Defaults to `false`.
|
649
594
|
|
650
|
-
|
595
|
+
#### Param
|
651
596
|
|
652
|
-
|
597
|
+
msgSender - Optional: AztecAddress for profiling context.
|
653
598
|
|
654
|
-
####
|
599
|
+
#### Returns
|
655
600
|
|
656
|
-
|
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:
|
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
|
-
|
611
|
+
Generates proofs for a transaction execution request.
|
671
612
|
|
672
|
-
|
673
|
-
|
674
|
-
##### params.txRequest
|
613
|
+
#### params
|
675
614
|
|
676
|
-
> **
|
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
|
-
|
623
|
+
A tuple containing the request and optional private execution result.
|
693
624
|
|
694
|
-
|
625
|
+
#### Param
|
695
626
|
|
696
|
-
|
627
|
+
txRequest - The TxExecutionRequest to prove.
|
697
628
|
|
698
|
-
|
629
|
+
#### Param
|
699
630
|
|
700
|
-
|
631
|
+
privateExecutionResult - Optional: PrivateExecutionResult from a prior private simulation.
|
701
632
|
|
702
|
-
####
|
633
|
+
#### Returns
|
703
634
|
|
704
|
-
|
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:
|
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
|
645
|
+
Registers a deployed contract instance with the wallet.
|
715
646
|
|
716
647
|
#### params
|
717
648
|
|
718
|
-
> **params**: `
|
649
|
+
> **params**: \[`ContractInstanceWithAddress`, `undefined` \| `ContractArtifact`\]
|
719
650
|
|
720
|
-
|
651
|
+
#### result
|
721
652
|
|
722
|
-
>
|
653
|
+
> **result**: `boolean`
|
723
654
|
|
724
|
-
|
655
|
+
#### Param
|
725
656
|
|
726
|
-
|
657
|
+
A tuple containing the instance and optional artifact.
|
727
658
|
|
728
|
-
####
|
659
|
+
#### Param
|
729
660
|
|
730
|
-
|
661
|
+
instance - The ContractInstanceWithAddress to register.
|
731
662
|
|
732
663
|
#### Param
|
733
664
|
|
734
|
-
The
|
665
|
+
artifact - Optional: The ContractArtifact for the instance.
|
735
666
|
|
736
667
|
#### Returns
|
737
668
|
|
738
|
-
|
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:
|
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
|
679
|
+
Registers a contract class (bytecode and ABI) with the wallet.
|
749
680
|
|
750
681
|
#### params
|
751
682
|
|
752
|
-
> **params**: `
|
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
|
-
|
691
|
+
A tuple containing the artifact.
|
692
|
+
|
693
|
+
#### Param
|
694
|
+
|
695
|
+
artifact - The ContractArtifact to register.
|
765
696
|
|
766
697
|
#### Returns
|
767
698
|
|
768
|
-
|
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:
|
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
|
709
|
+
Registers a new authorized sender AztecAddress.
|
779
710
|
|
780
711
|
#### params
|
781
712
|
|
782
|
-
> **params**: `
|
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
|
-
|
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
|
-
|
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:
|
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
|
-
|
739
|
+
Removes an AztecAddress from the list of authorized senders.
|
809
740
|
|
810
|
-
|
811
|
-
|
812
|
-
##### params.sender
|
741
|
+
#### params
|
813
742
|
|
814
|
-
> **
|
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\
|
763
|
+
### aztec\_sendTx
|
823
764
|
|
824
|
-
> **aztec\
|
765
|
+
> **aztec\_sendTx**: `object`
|
825
766
|
|
826
|
-
Defined in: [aztec/rpc-wallet/src/types.ts:
|
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
|
769
|
+
Sends a proven Tx (transaction) to the network.
|
829
770
|
|
830
771
|
#### params
|
831
772
|
|
832
|
-
> **params**: [`
|
773
|
+
> **params**: \[`Tx`\]
|
833
774
|
|
834
775
|
#### result
|
835
776
|
|
836
|
-
> **result**: `
|
777
|
+
> **result**: `TxHash`
|
837
778
|
|
838
779
|
#### Param
|
839
780
|
|
840
|
-
|
781
|
+
A tuple containing the proven transaction.
|
841
782
|
|
842
|
-
####
|
783
|
+
#### Param
|
843
784
|
|
844
|
-
The
|
785
|
+
tx - The proven Tx object to send.
|
845
786
|
|
846
|
-
####
|
787
|
+
#### Returns
|
847
788
|
|
848
|
-
|
789
|
+
result - The TxHash of the sent transaction.
|
849
790
|
|
850
791
|
***
|
851
792
|
|
852
|
-
### aztec\
|
793
|
+
### aztec\_simulateTx
|
853
794
|
|
854
|
-
> **aztec\
|
795
|
+
> **aztec\_simulateTx**: `object`
|
855
796
|
|
856
|
-
Defined in: [aztec/rpc-wallet/src/types.ts:
|
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**: `
|
803
|
+
> **params**: \[`TxExecutionRequest`, `boolean`?, `AztecAddress`?, `boolean`?, `boolean`?\]
|
861
804
|
|
862
|
-
|
805
|
+
#### result
|
863
806
|
|
864
|
-
> **
|
807
|
+
> **result**: `TxSimulationResult`
|
865
808
|
|
866
|
-
####
|
809
|
+
#### Param
|
867
810
|
|
868
|
-
|
811
|
+
A tuple containing the simulation parameters.
|
869
812
|
|
870
|
-
|
813
|
+
#### Param
|
871
814
|
|
872
|
-
|
815
|
+
txRequest - The TxExecutionRequest to simulate.
|
873
816
|
|
874
|
-
|
817
|
+
#### Param
|
875
818
|
|
876
|
-
|
819
|
+
simulatePublic - Optional: Whether to simulate public parts. Defaults to `false`.
|
877
820
|
|
878
|
-
####
|
821
|
+
#### Param
|
879
822
|
|
880
|
-
|
823
|
+
msgSender - Optional: AztecAddress for simulation context.
|
881
824
|
|
882
|
-
|
825
|
+
#### Param
|
883
826
|
|
884
|
-
|
827
|
+
skipTxValidation - Optional: Flag to skip validation. Defaults to `false`.
|
885
828
|
|
886
|
-
####
|
829
|
+
#### Param
|
887
830
|
|
888
|
-
|
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\
|
839
|
+
### aztec\_simulateUtility
|
893
840
|
|
894
|
-
> **aztec\
|
841
|
+
> **aztec\_simulateUtility**: `object`
|
895
842
|
|
896
|
-
Defined in: [aztec/rpc-wallet/src/types.ts:
|
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
|
845
|
+
Simulates a utility (view) function call.
|
899
846
|
|
900
847
|
#### params
|
901
848
|
|
902
|
-
> **params**: [`
|
849
|
+
> **params**: \[`string`, `unknown`[], `AztecAddress`, `AuthWitness`[]?, `AztecAddress`?\]
|
903
850
|
|
904
851
|
#### result
|
905
852
|
|
906
|
-
> **result**: `
|
853
|
+
> **result**: `UtilitySimulationResult`
|
907
854
|
|
908
855
|
#### Param
|
909
856
|
|
910
|
-
|
857
|
+
A tuple containing the utility call parameters.
|
911
858
|
|
912
|
-
####
|
859
|
+
#### Param
|
913
860
|
|
914
|
-
|
861
|
+
functionName - Name of the utility function.
|
915
862
|
|
916
|
-
####
|
863
|
+
#### Param
|
917
864
|
|
918
|
-
|
865
|
+
args - Arguments for the function.
|
919
866
|
|
920
|
-
|
867
|
+
#### Param
|
921
868
|
|
922
|
-
|
869
|
+
to - AztecAddress of the contract/account.
|
923
870
|
|
924
|
-
|
871
|
+
#### Param
|
925
872
|
|
926
|
-
|
873
|
+
authWits - Optional: Array of AuthWitness.
|
927
874
|
|
928
|
-
####
|
875
|
+
#### Param
|
876
|
+
|
877
|
+
from - Optional: Sender AztecAddress.
|
929
878
|
|
930
|
-
|
879
|
+
#### Returns
|
931
880
|
|
932
|
-
|
881
|
+
result - The UtilitySimulationResult.
|
933
882
|
|
934
|
-
|
883
|
+
***
|
935
884
|
|
936
|
-
|
885
|
+
### aztec\_wmDeployContract
|
937
886
|
|
938
|
-
>
|
887
|
+
> **aztec\_wmDeployContract**: `object`
|
939
888
|
|
940
|
-
|
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
|
-
|
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
|
-
|
894
|
+
#### params
|
945
895
|
|
946
|
-
> **
|
896
|
+
> **params**: \[\{ `args`: `unknown`[]; `artifact`: `ContractArtifact`; `constructorName?`: `string`; \}\]
|
947
897
|
|
948
|
-
|
898
|
+
#### result
|
949
899
|
|
950
|
-
>
|
900
|
+
> **result**: `object`
|
951
901
|
|
952
|
-
#####
|
902
|
+
##### result.contractAddress
|
953
903
|
|
954
|
-
> **
|
904
|
+
> **contractAddress**: `AztecAddress`
|
955
905
|
|
956
|
-
|
906
|
+
##### result.txHash
|
957
907
|
|
958
|
-
> **
|
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\
|
925
|
+
### aztec\_wmExecuteTx
|
926
|
+
|
927
|
+
> **aztec\_wmExecuteTx**: `object`
|
963
928
|
|
964
|
-
|
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
|
-
|
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**: `
|
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
|
-
|
950
|
+
#### Returns
|
951
|
+
|
952
|
+
result - The TxHash of the sent transaction.
|
973
953
|
|
974
|
-
|
954
|
+
***
|
975
955
|
|
976
|
-
|
956
|
+
### aztec\_wmSimulateTx
|
977
957
|
|
978
|
-
>
|
958
|
+
> **aztec\_wmSimulateTx**: `object`
|
979
959
|
|
980
|
-
|
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
|
-
|
962
|
+
WalletMesh specific: Simulates a contract function interaction using a pre-constructed ExecutionPayload.
|
983
963
|
|
984
|
-
|
964
|
+
#### params
|
985
965
|
|
986
|
-
> **
|
966
|
+
> **params**: \[`ExecutionPayload`\]
|
987
967
|
|
988
968
|
#### result
|
989
969
|
|
990
|
-
> **result**: `
|
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:
|
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
|
-
|
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
|
1009
|
+
result - An array of strings, where each string is a supported method name.
|
1009
1010
|
|
1010
|
-
####
|
1011
|
+
#### Overrides
|
1011
1012
|
|
1012
|
-
|
1013
|
+
`WalletMethodMap.wm_getSupportedMethods`
|