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