@aztec/aztec.js 0.0.1-commit.d3ec352c → 0.0.1-commit.d6f2b3f94

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (212) hide show
  1. package/dest/account/account.d.ts +25 -40
  2. package/dest/account/account.d.ts.map +1 -1
  3. package/dest/account/account.js +19 -47
  4. package/dest/account/account_contract.d.ts +9 -10
  5. package/dest/account/account_contract.d.ts.map +1 -1
  6. package/dest/account/account_with_secret_key.d.ts +21 -9
  7. package/dest/account/account_with_secret_key.d.ts.map +1 -1
  8. package/dest/account/account_with_secret_key.js +21 -4
  9. package/dest/account/index.d.ts +4 -3
  10. package/dest/account/index.d.ts.map +1 -1
  11. package/dest/account/index.js +2 -0
  12. package/dest/account/signerless_account.d.ts +6 -7
  13. package/dest/account/signerless_account.d.ts.map +1 -1
  14. package/dest/account/signerless_account.js +8 -11
  15. package/dest/api/account.d.ts +2 -4
  16. package/dest/api/account.d.ts.map +1 -1
  17. package/dest/api/account.js +1 -3
  18. package/dest/api/authorization.d.ts +2 -2
  19. package/dest/api/authorization.d.ts.map +1 -1
  20. package/dest/api/authorization.js +1 -1
  21. package/dest/api/contract.d.ts +18 -12
  22. package/dest/api/contract.d.ts.map +1 -1
  23. package/dest/api/contract.js +16 -10
  24. package/dest/api/deployment.d.ts +1 -2
  25. package/dest/api/deployment.d.ts.map +1 -1
  26. package/dest/api/deployment.js +0 -1
  27. package/dest/api/events.d.ts +10 -6
  28. package/dest/api/events.d.ts.map +1 -1
  29. package/dest/api/events.js +30 -20
  30. package/dest/api/fields.d.ts +4 -2
  31. package/dest/api/fields.d.ts.map +1 -1
  32. package/dest/api/fields.js +3 -1
  33. package/dest/api/keys.d.ts +1 -1
  34. package/dest/api/keys.js +1 -1
  35. package/dest/api/node.d.ts +8 -4
  36. package/dest/api/node.d.ts.map +1 -1
  37. package/dest/api/node.js +7 -3
  38. package/dest/api/protocol.d.ts +7 -1
  39. package/dest/api/protocol.d.ts.map +1 -1
  40. package/dest/api/protocol.js +6 -0
  41. package/dest/api/tx.d.ts +2 -2
  42. package/dest/api/tx.d.ts.map +1 -1
  43. package/dest/api/tx.js +1 -1
  44. package/dest/api/wallet.d.ts +3 -2
  45. package/dest/api/wallet.d.ts.map +1 -1
  46. package/dest/api/wallet.js +2 -1
  47. package/dest/authorization/call_authorization_request.d.ts +23 -2
  48. package/dest/authorization/call_authorization_request.d.ts.map +1 -1
  49. package/dest/contract/base_contract_interaction.d.ts +8 -10
  50. package/dest/contract/base_contract_interaction.d.ts.map +1 -1
  51. package/dest/contract/base_contract_interaction.js +5 -17
  52. package/dest/contract/batch_call.d.ts +1 -1
  53. package/dest/contract/batch_call.d.ts.map +1 -1
  54. package/dest/contract/batch_call.js +3 -1
  55. package/dest/contract/contract_base.d.ts +4 -1
  56. package/dest/contract/contract_base.d.ts.map +1 -1
  57. package/dest/contract/contract_function_interaction.d.ts +3 -12
  58. package/dest/contract/contract_function_interaction.d.ts.map +1 -1
  59. package/dest/contract/contract_function_interaction.js +6 -6
  60. package/dest/contract/deploy_method.d.ts +64 -17
  61. package/dest/contract/deploy_method.d.ts.map +1 -1
  62. package/dest/contract/deploy_method.js +42 -24
  63. package/dest/contract/interaction_options.d.ts +42 -5
  64. package/dest/contract/interaction_options.d.ts.map +1 -1
  65. package/dest/contract/interaction_options.js +8 -1
  66. package/dest/contract/protocol_contracts/auth-registry.d.ts +27 -0
  67. package/dest/contract/protocol_contracts/auth-registry.d.ts.map +1 -0
  68. package/dest/contract/protocol_contracts/auth-registry.js +558 -0
  69. package/dest/contract/protocol_contracts/contract-class-registry.d.ts +15 -0
  70. package/dest/contract/protocol_contracts/contract-class-registry.d.ts.map +1 -0
  71. package/dest/contract/protocol_contracts/contract-class-registry.js +127 -0
  72. package/dest/contract/protocol_contracts/contract-instance-registry.d.ts +22 -0
  73. package/dest/contract/protocol_contracts/contract-instance-registry.d.ts.map +1 -0
  74. package/dest/contract/protocol_contracts/contract-instance-registry.js +465 -0
  75. package/dest/contract/protocol_contracts/fee-juice.d.ts +21 -0
  76. package/dest/contract/protocol_contracts/fee-juice.d.ts.map +1 -0
  77. package/dest/contract/protocol_contracts/fee-juice.js +426 -0
  78. package/dest/contract/protocol_contracts/multi-call-entrypoint.d.ts +34 -0
  79. package/dest/contract/protocol_contracts/multi-call-entrypoint.d.ts.map +1 -0
  80. package/dest/contract/protocol_contracts/multi-call-entrypoint.js +585 -0
  81. package/dest/contract/protocol_contracts/public-checks.d.ts +26 -0
  82. package/dest/contract/protocol_contracts/public-checks.d.ts.map +1 -0
  83. package/dest/contract/protocol_contracts/public-checks.js +593 -0
  84. package/dest/contract/wait_for_proven.d.ts +2 -2
  85. package/dest/contract/wait_for_proven.d.ts.map +1 -1
  86. package/dest/contract/wait_for_proven.js +1 -1
  87. package/dest/contract/wait_opts.d.ts +16 -0
  88. package/dest/contract/wait_opts.d.ts.map +1 -0
  89. package/dest/contract/wait_opts.js +5 -0
  90. package/dest/deployment/publish_class.js +3 -3
  91. package/dest/deployment/publish_instance.d.ts +2 -2
  92. package/dest/deployment/publish_instance.d.ts.map +1 -1
  93. package/dest/deployment/publish_instance.js +3 -3
  94. package/dest/ethereum/portal_manager.d.ts +9 -6
  95. package/dest/ethereum/portal_manager.d.ts.map +1 -1
  96. package/dest/ethereum/portal_manager.js +17 -18
  97. package/dest/fee/fee_juice_payment_method_with_claim.js +7 -7
  98. package/dest/fee/private_fee_payment_method.js +11 -11
  99. package/dest/fee/public_fee_payment_method.js +11 -11
  100. package/dest/fee/sponsored_fee_payment.js +3 -3
  101. package/dest/scripts/generate_protocol_contract_types.d.ts +2 -0
  102. package/dest/scripts/generate_protocol_contract_types.d.ts.map +1 -0
  103. package/dest/scripts/generate_protocol_contract_types.js +120 -0
  104. package/dest/utils/abi_types.d.ts +2 -2
  105. package/dest/utils/abi_types.d.ts.map +1 -1
  106. package/dest/utils/authwit.d.ts +9 -7
  107. package/dest/utils/authwit.d.ts.map +1 -1
  108. package/dest/utils/authwit.js +6 -10
  109. package/dest/utils/cross_chain.d.ts +2 -2
  110. package/dest/utils/cross_chain.d.ts.map +1 -1
  111. package/dest/utils/fee_juice.js +1 -1
  112. package/dest/utils/field_compressed_string.js +1 -1
  113. package/dest/utils/node.d.ts +12 -1
  114. package/dest/utils/node.d.ts.map +1 -1
  115. package/dest/utils/node.js +46 -0
  116. package/dest/utils/pub_key.d.ts +2 -2
  117. package/dest/utils/pub_key.d.ts.map +1 -1
  118. package/dest/utils/pub_key.js +1 -1
  119. package/dest/wallet/account_entrypoint_meta_payment_method.d.ts +5 -8
  120. package/dest/wallet/account_entrypoint_meta_payment_method.d.ts.map +1 -1
  121. package/dest/wallet/account_entrypoint_meta_payment_method.js +28 -43
  122. package/dest/wallet/account_manager.d.ts +6 -9
  123. package/dest/wallet/account_manager.d.ts.map +1 -1
  124. package/dest/wallet/account_manager.js +6 -12
  125. package/dest/wallet/capabilities.d.ts +444 -0
  126. package/dest/wallet/capabilities.d.ts.map +1 -0
  127. package/dest/wallet/capabilities.js +3 -0
  128. package/dest/wallet/deploy_account_method.d.ts +35 -7
  129. package/dest/wallet/deploy_account_method.d.ts.map +1 -1
  130. package/dest/wallet/deploy_account_method.js +8 -6
  131. package/dest/wallet/index.d.ts +2 -1
  132. package/dest/wallet/index.d.ts.map +1 -1
  133. package/dest/wallet/index.js +1 -0
  134. package/dest/wallet/wallet.d.ts +1670 -984
  135. package/dest/wallet/wallet.d.ts.map +1 -1
  136. package/dest/wallet/wallet.js +206 -100
  137. package/package.json +24 -13
  138. package/src/account/account.ts +34 -58
  139. package/src/account/account_contract.ts +7 -8
  140. package/src/account/account_with_secret_key.ts +34 -9
  141. package/src/account/index.ts +3 -2
  142. package/src/account/signerless_account.ts +14 -13
  143. package/src/api/account.ts +9 -3
  144. package/src/api/authorization.ts +1 -0
  145. package/src/api/contract.ts +24 -9
  146. package/src/api/deployment.ts +0 -1
  147. package/src/api/events.ts +35 -27
  148. package/src/api/fields.ts +3 -1
  149. package/src/api/keys.ts +2 -2
  150. package/src/api/node.ts +7 -3
  151. package/src/api/protocol.ts +7 -0
  152. package/src/api/tx.ts +2 -0
  153. package/src/api/wallet.ts +51 -3
  154. package/src/authorization/call_authorization_request.ts +1 -1
  155. package/src/contract/base_contract_interaction.ts +27 -15
  156. package/src/contract/batch_call.ts +4 -2
  157. package/src/contract/contract_function_interaction.ts +13 -6
  158. package/src/contract/deploy_method.ts +123 -30
  159. package/src/contract/interaction_options.ts +49 -4
  160. package/src/contract/protocol_contracts/auth-registry.ts +351 -0
  161. package/src/contract/protocol_contracts/contract-class-registry.ts +96 -0
  162. package/src/contract/protocol_contracts/contract-instance-registry.ts +302 -0
  163. package/src/contract/protocol_contracts/fee-juice.ts +264 -0
  164. package/src/contract/protocol_contracts/multi-call-entrypoint.ts +332 -0
  165. package/src/contract/protocol_contracts/public-checks.ts +316 -0
  166. package/src/contract/wait_for_proven.ts +1 -1
  167. package/src/contract/wait_opts.ts +21 -0
  168. package/src/deployment/publish_class.ts +3 -3
  169. package/src/deployment/publish_instance.ts +3 -6
  170. package/src/ethereum/portal_manager.ts +20 -24
  171. package/src/fee/fee_juice_payment_method_with_claim.ts +6 -6
  172. package/src/fee/private_fee_payment_method.ts +8 -8
  173. package/src/fee/public_fee_payment_method.ts +9 -9
  174. package/src/fee/sponsored_fee_payment.ts +3 -3
  175. package/src/scripts/generate_protocol_contract_types.ts +150 -0
  176. package/src/utils/abi_types.ts +1 -1
  177. package/src/utils/authwit.ts +20 -8
  178. package/src/utils/cross_chain.ts +1 -1
  179. package/src/utils/fee_juice.ts +1 -1
  180. package/src/utils/field_compressed_string.ts +1 -1
  181. package/src/utils/node.ts +62 -0
  182. package/src/utils/pub_key.ts +2 -2
  183. package/src/wallet/account_entrypoint_meta_payment_method.ts +28 -60
  184. package/src/wallet/account_manager.ts +6 -14
  185. package/src/wallet/capabilities.ts +491 -0
  186. package/src/wallet/deploy_account_method.ts +38 -14
  187. package/src/wallet/index.ts +1 -0
  188. package/src/wallet/wallet.ts +352 -106
  189. package/dest/account/interface.d.ts +0 -19
  190. package/dest/account/interface.d.ts.map +0 -1
  191. package/dest/account/interface.js +0 -5
  192. package/dest/contract/deploy_sent_tx.d.ts +0 -48
  193. package/dest/contract/deploy_sent_tx.d.ts.map +0 -1
  194. package/dest/contract/deploy_sent_tx.js +0 -46
  195. package/dest/contract/protocol_contracts.d.ts +0 -9
  196. package/dest/contract/protocol_contracts.d.ts.map +0 -1
  197. package/dest/contract/protocol_contracts.js +0 -26
  198. package/dest/contract/sent_tx.d.ts +0 -51
  199. package/dest/contract/sent_tx.d.ts.map +0 -1
  200. package/dest/contract/sent_tx.js +0 -90
  201. package/dest/contract/unsafe_contract.d.ts +0 -15
  202. package/dest/contract/unsafe_contract.d.ts.map +0 -1
  203. package/dest/contract/unsafe_contract.js +0 -6
  204. package/dest/deployment/broadcast_function.d.ts +0 -24
  205. package/dest/deployment/broadcast_function.d.ts.map +0 -1
  206. package/dest/deployment/broadcast_function.js +0 -74
  207. package/src/account/interface.ts +0 -25
  208. package/src/contract/deploy_sent_tx.ts +0 -75
  209. package/src/contract/protocol_contracts.ts +0 -35
  210. package/src/contract/sent_tx.ts +0 -130
  211. package/src/contract/unsafe_contract.ts +0 -19
  212. package/src/deployment/broadcast_function.ts +0 -148
@@ -1,24 +1,20 @@
1
1
  import type { ChainInfo } from '@aztec/entrypoints/interfaces';
2
- import type { Fr } from '@aztec/foundation/fields';
2
+ import { BlockNumber, BlockNumberPositiveSchema } from '@aztec/foundation/branded-types';
3
+ import type { Fr } from '@aztec/foundation/curves/bn254';
3
4
  import {
5
+ type AbiDecoded,
4
6
  AbiTypeSchema,
5
7
  type ContractArtifact,
6
8
  ContractArtifactSchema,
7
9
  type EventMetadataDefinition,
8
- type FunctionCall,
9
- FunctionType,
10
+ FunctionCall,
10
11
  } from '@aztec/stdlib/abi';
11
12
  import { AuthWitness } from '@aztec/stdlib/auth-witness';
12
13
  import type { AztecAddress } from '@aztec/stdlib/aztec-address';
13
- import {
14
- type ContractClassMetadata,
15
- ContractClassWithIdSchema,
16
- type ContractInstanceWithAddress,
17
- ContractInstanceWithAddressSchema,
18
- type ContractMetadata,
19
- } from '@aztec/stdlib/contract';
14
+ import { type ContractInstanceWithAddress, ContractInstanceWithAddressSchema } from '@aztec/stdlib/contract';
20
15
  import { Gas } from '@aztec/stdlib/gas';
21
- import { AbiDecodedSchema, type ApiSchemaFor, type ZodFor, optional, schemas } from '@aztec/stdlib/schemas';
16
+ import { AbiDecodedSchema, type ApiSchemaFor, optional, schemas, zodFor } from '@aztec/stdlib/schemas';
17
+ import type { ExecutionPayload, InTx } from '@aztec/stdlib/tx';
22
18
  import {
23
19
  Capsule,
24
20
  HashedValues,
@@ -27,19 +23,23 @@ import {
27
23
  TxReceipt,
28
24
  TxSimulationResult,
29
25
  UtilitySimulationResult,
26
+ inTxSchema,
30
27
  } from '@aztec/stdlib/tx';
31
- import type { ExecutionPayload } from '@aztec/stdlib/tx';
32
28
 
33
29
  import { z } from 'zod';
34
30
 
35
- import type {
36
- FeeEstimationOptions,
37
- GasSettingsOption,
38
- ProfileInteractionOptions,
39
- SendInteractionOptions,
40
- SimulateInteractionOptions,
31
+ import {
32
+ type FeeEstimationOptions,
33
+ type GasSettingsOption,
34
+ type InteractionWaitOptions,
35
+ NO_WAIT,
36
+ type ProfileInteractionOptions,
37
+ type SendInteractionOptionsWithoutWait,
38
+ type SendReturn,
39
+ type SimulateInteractionOptions,
41
40
  } from '../contract/interaction_options.js';
42
41
  import type { CallIntent, IntentInnerHash } from '../utils/authwit.js';
42
+ import type { AppCapabilities, WalletCapabilities } from './capabilities.js';
43
43
 
44
44
  /**
45
45
  * A wrapper type that allows any item to be associated with an alias.
@@ -57,7 +57,7 @@ export type Aliased<T> = {
57
57
 
58
58
  /**
59
59
  * Options for simulating interactions with the wallet. Overrides the fee settings of an interaction with
60
- * a simplified version that only hints at the wallet wether the interaction contains a
60
+ * a simplified version that only hints at the wallet whether the interaction contains a
61
61
  * fee payment method or not
62
62
  */
63
63
  export type SimulateOptions = Omit<SimulateInteractionOptions, 'fee'> & {
@@ -67,7 +67,7 @@ export type SimulateOptions = Omit<SimulateInteractionOptions, 'fee'> & {
67
67
 
68
68
  /**
69
69
  * Options for profiling interactions with the wallet. Overrides the fee settings of an interaction with
70
- * a simplified version that only hints at the wallet wether the interaction contains a
70
+ * a simplified version that only hints at the wallet whether the interaction contains a
71
71
  * fee payment method or not
72
72
  */
73
73
  export type ProfileOptions = Omit<ProfileInteractionOptions, 'fee'> & {
@@ -77,45 +77,54 @@ export type ProfileOptions = Omit<ProfileInteractionOptions, 'fee'> & {
77
77
 
78
78
  /**
79
79
  * Options for sending/proving interactions with the wallet. Overrides the fee settings of an interaction with
80
- * a simplified version that only hints at the wallet wether the interaction contains a
80
+ * a simplified version that only hints at the wallet whether the interaction contains a
81
81
  * fee payment method or not
82
82
  */
83
- export type SendOptions = Omit<SendInteractionOptions, 'fee'> & {
83
+ export type SendOptions<W extends InteractionWaitOptions = undefined> = Omit<
84
+ SendInteractionOptionsWithoutWait,
85
+ 'fee'
86
+ > & {
84
87
  /** The fee options */
85
88
  fee?: GasSettingsOption;
89
+ /** Whether to wait for the transaction to be mined */
90
+ wait?: W;
86
91
  };
87
92
 
88
93
  /**
89
- * Helper type that represents all methods that can be batched.
94
+ * Helper type that represents all methods that can be batched (all methods except batch itself).
90
95
  */
91
- export type BatchableMethods = Pick<
92
- Wallet,
93
- 'registerContract' | 'sendTx' | 'registerSender' | 'simulateUtility' | 'simulateTx'
94
- >;
96
+ export type BatchableMethods = Omit<Wallet, 'batch'>;
95
97
 
96
98
  /**
97
- * From the batchable methods, we create a type that represents a method call with its name and arguments.
98
- * This is what the wallet will accept as arguments to the `batch` method.
99
+ * A method call with its name and arguments.
99
100
  */
100
- export type BatchedMethod<T extends keyof BatchableMethods> = {
101
+ type BatchedMethodInternal<T extends keyof BatchableMethods> = {
101
102
  /** The method name */
102
103
  name: T;
103
104
  /** The method arguments */
104
105
  args: Parameters<BatchableMethods[T]>;
105
106
  };
106
107
 
108
+ /**
109
+ * Union of all possible batched method calls.
110
+ * This ensures type safety: the `args` must match the specific `name`.
111
+ */
112
+ export type BatchedMethod = {
113
+ [K in keyof BatchableMethods]: BatchedMethodInternal<K>;
114
+ }[keyof BatchableMethods];
115
+
107
116
  /**
108
117
  * Helper type to extract the return type of a batched method
109
118
  */
110
119
  export type BatchedMethodResult<T> =
111
- T extends BatchedMethod<infer K> ? Awaited<ReturnType<BatchableMethods[K]>> : never;
120
+ T extends BatchedMethodInternal<infer K> ? Awaited<ReturnType<BatchableMethods[K]>> : never;
112
121
 
113
122
  /**
114
123
  * Wrapper type for batch results that includes the method name for discriminated union deserialization.
115
124
  * Each result is wrapped as \{ name: 'methodName', result: ActualResult \} to allow proper deserialization
116
125
  * when AztecAddress and TxHash would otherwise be ambiguous (both are hex strings).
117
126
  */
118
- export type BatchedMethodResultWrapper<T extends BatchedMethod<keyof BatchableMethods>> = {
127
+ export type BatchedMethodResultWrapper<T extends BatchedMethod> = {
119
128
  /** The method name */
120
129
  name: T['name'];
121
130
  /** The method result */
@@ -125,25 +134,108 @@ export type BatchedMethodResultWrapper<T extends BatchedMethod<keyof BatchableMe
125
134
  /**
126
135
  * Maps a tuple of BatchedMethod to a tuple of their wrapped return types
127
136
  */
128
- export type BatchResults<T extends readonly BatchedMethod<keyof BatchableMethods>[]> = {
137
+ export type BatchResults<T extends readonly BatchedMethod[]> = {
129
138
  [K in keyof T]: BatchedMethodResultWrapper<T[K]>;
130
139
  };
131
140
 
141
+ /**
142
+ * Base filter options for event queries.
143
+ */
144
+ export type EventFilterBase = {
145
+ /** Transaction in which the events were emitted. */
146
+ txHash?: TxHash;
147
+ /** The block number from which to start fetching events (inclusive).
148
+ * Optional. If provided, it must be greater or equal than 1.
149
+ * Defaults to the initial L2 block number (INITIAL_L2_BLOCK_NUM).
150
+ */
151
+ fromBlock?: BlockNumber;
152
+ /** The block number until which to fetch logs (not inclusive).
153
+ * Optional. If provided, it must be greater than fromBlock.
154
+ */
155
+ toBlock?: BlockNumber;
156
+ };
157
+
158
+ /**
159
+ * Filter options when querying private events.
160
+ */
161
+ export type PrivateEventFilter = EventFilterBase & {
162
+ /** The address of the contract that emitted the events. */
163
+ contractAddress: AztecAddress;
164
+ /** Addresses of accounts that are in scope for this filter. */
165
+ scopes: AztecAddress[];
166
+ };
167
+
168
+ /**
169
+ * Filter options when querying public events.
170
+ */
171
+ export type PublicEventFilter = EventFilterBase & {
172
+ /** The address of the contract that emitted the events. */
173
+ contractAddress?: AztecAddress;
174
+ };
175
+
176
+ /**
177
+ * An ABI decoded event with associated metadata.
178
+ * @typeParam T - The decoded event type
179
+ * @typeParam M - Additional metadata fields (empty by default)
180
+ */
181
+ export type Event<T, M extends object = object> = {
182
+ /** The ABI decoded event */
183
+ event: T;
184
+ /** Metadata describing event context information such as tx and block */
185
+ metadata: InTx & M;
186
+ };
187
+
188
+ /** An ABI decoded private event with associated metadata. */
189
+ export type PrivateEvent<T> = Event<T>;
190
+
191
+ /** An ABI decoded public event with associated metadata (includes contract address). */
192
+ export type PublicEvent<T> = Event<
193
+ T,
194
+ {
195
+ /**
196
+ * Address of the contract that emitted this event
197
+ */
198
+ contractAddress: AztecAddress;
199
+ }
200
+ >;
201
+
202
+ /**
203
+ * Contract metadata including deployment and registration status.
204
+ */
205
+ export type ContractMetadata = {
206
+ /** The contract instance */
207
+ instance?: ContractInstanceWithAddress;
208
+ /** Whether the contract has been initialized (init nullifier exists) */
209
+ isContractInitialized: boolean;
210
+ /** Whether the contract instance is publicly deployed on-chain */
211
+ isContractPublished: boolean;
212
+ /** Whether the contract has been updated to a different class */
213
+ isContractUpdated: boolean;
214
+ /** The updated contract class ID if the contract has been updated */
215
+ updatedContractClassId?: Fr | undefined;
216
+ };
217
+
218
+ /**
219
+ * Contract class metadata.
220
+ */
221
+ export type ContractClassMetadata = {
222
+ /** Whether the artifact is registered in the wallet */
223
+ isArtifactRegistered: boolean;
224
+ /** Whether the contract class is publicly registered on-chain */
225
+ isContractClassPubliclyRegistered: boolean;
226
+ };
227
+
132
228
  /**
133
229
  * The wallet interface.
134
230
  */
135
231
  export type Wallet = {
136
- getContractClassMetadata(id: Fr, includeArtifact?: boolean): Promise<ContractClassMetadata>;
137
- getContractMetadata(address: AztecAddress): Promise<ContractMetadata>;
138
232
  getPrivateEvents<T>(
139
- contractAddress: AztecAddress,
140
233
  eventMetadata: EventMetadataDefinition,
141
- from: number,
142
- numBlocks: number,
143
- recipients: AztecAddress[],
144
- ): Promise<T[]>;
234
+ eventFilter: PrivateEventFilter,
235
+ ): Promise<PrivateEvent<T>[]>;
145
236
  getChainInfo(): Promise<ChainInfo>;
146
- getTxReceipt(txHash: TxHash): Promise<TxReceipt>;
237
+ getContractMetadata(address: AztecAddress): Promise<ContractMetadata>;
238
+ getContractClassMetadata(id: Fr): Promise<ContractClassMetadata>;
147
239
  registerSender(address: AztecAddress, alias?: string): Promise<AztecAddress>;
148
240
  getAddressBook(): Promise<Aliased<AztecAddress>[]>;
149
241
  getAccounts(): Promise<Aliased<AztecAddress>[]>;
@@ -155,24 +247,17 @@ export type Wallet = {
155
247
  simulateTx(exec: ExecutionPayload, opts: SimulateOptions): Promise<TxSimulationResult>;
156
248
  simulateUtility(call: FunctionCall, authwits?: AuthWitness[]): Promise<UtilitySimulationResult>;
157
249
  profileTx(exec: ExecutionPayload, opts: ProfileOptions): Promise<TxProfileResult>;
158
- sendTx(exec: ExecutionPayload, opts: SendOptions): Promise<TxHash>;
159
- createAuthWit(from: AztecAddress, messageHashOrIntent: Fr | IntentInnerHash | CallIntent): Promise<AuthWitness>;
160
- batch<const T extends readonly BatchedMethod<keyof BatchableMethods>[]>(methods: T): Promise<BatchResults<T>>;
250
+ sendTx<W extends InteractionWaitOptions = undefined>(
251
+ exec: ExecutionPayload,
252
+ opts: SendOptions<W>,
253
+ ): Promise<SendReturn<W>>;
254
+ createAuthWit(from: AztecAddress, messageHashOrIntent: IntentInnerHash | CallIntent): Promise<AuthWitness>;
255
+ requestCapabilities(manifest: AppCapabilities): Promise<WalletCapabilities>;
256
+ batch<const T extends readonly BatchedMethod[]>(methods: T): Promise<BatchResults<T>>;
161
257
  };
162
258
 
163
- export const FunctionCallSchema = z.object({
164
- name: z.string(),
165
- to: schemas.AztecAddress,
166
- selector: schemas.FunctionSelector,
167
- type: z.nativeEnum(FunctionType),
168
- isStatic: z.boolean(),
169
- hideMsgSender: z.boolean(),
170
- args: z.array(schemas.Fr),
171
- returnTypes: z.array(AbiTypeSchema),
172
- });
173
-
174
259
  export const ExecutionPayloadSchema = z.object({
175
- calls: z.array(FunctionCallSchema),
260
+ calls: z.array(FunctionCall.schema),
176
261
  authWitnesses: z.array(AuthWitness.schema),
177
262
  capsules: z.array(Capsule.schema),
178
263
  extraHashedArgs: z.array(HashedValues.schema),
@@ -195,11 +280,19 @@ export const WalletSimulationFeeOptionSchema = GasSettingsOptionSchema.extend({
195
280
  estimateGas: optional(z.boolean()),
196
281
  });
197
282
 
283
+ export const WaitOptsSchema = z.object({
284
+ ignoreDroppedReceiptsFor: optional(z.number()),
285
+ timeout: optional(z.number()),
286
+ interval: optional(z.number()),
287
+ dontThrowOnRevert: optional(z.boolean()),
288
+ });
289
+
198
290
  export const SendOptionsSchema = z.object({
199
291
  from: schemas.AztecAddress,
200
292
  authWitnesses: optional(z.array(AuthWitness.schema)),
201
293
  capsules: optional(z.array(Capsule.schema)),
202
294
  fee: optional(GasSettingsOptionSchema),
295
+ wait: optional(z.union([z.literal(NO_WAIT), WaitOptsSchema])),
203
296
  });
204
297
 
205
298
  export const SimulateOptionsSchema = z.object({
@@ -218,67 +311,189 @@ export const ProfileOptionsSchema = SimulateOptionsSchema.extend({
218
311
  });
219
312
 
220
313
  export const MessageHashOrIntentSchema = z.union([
221
- schemas.Fr,
222
314
  z.object({ consumer: schemas.AztecAddress, innerHash: schemas.Fr }),
223
315
  z.object({
224
316
  caller: schemas.AztecAddress,
225
- call: FunctionCallSchema,
317
+ call: FunctionCall.schema,
226
318
  }),
227
319
  ]);
228
320
 
229
- export const BatchedMethodSchema = z.union([
230
- z.object({
231
- name: z.literal('registerSender'),
232
- args: z.tuple([schemas.AztecAddress, optional(z.string())]),
233
- }),
234
- z.object({
235
- name: z.literal('registerContract'),
236
- args: z.tuple([ContractInstanceWithAddressSchema, optional(ContractArtifactSchema), optional(schemas.Fr)]),
237
- }),
238
- z.object({
239
- name: z.literal('sendTx'),
240
- args: z.tuple([ExecutionPayloadSchema, SendOptionsSchema]),
241
- }),
321
+ export const EventMetadataDefinitionSchema = z.object({
322
+ eventSelector: schemas.EventSelector,
323
+ abiType: AbiTypeSchema,
324
+ fieldNames: z.array(z.string()),
325
+ });
326
+
327
+ const EventFilterBaseSchema = z.object({
328
+ txHash: optional(TxHash.schema),
329
+ fromBlock: optional(BlockNumberPositiveSchema),
330
+ toBlock: optional(BlockNumberPositiveSchema),
331
+ });
332
+
333
+ export const PrivateEventFilterSchema = EventFilterBaseSchema.extend({
334
+ contractAddress: schemas.AztecAddress,
335
+ scopes: z.array(schemas.AztecAddress),
336
+ });
337
+
338
+ export const PublicEventFilterSchema = EventFilterBaseSchema.extend({
339
+ contractAddress: optional(schemas.AztecAddress),
340
+ });
341
+
342
+ export const PrivateEventSchema: z.ZodType<any> = zodFor<PrivateEvent<AbiDecoded>>()(
242
343
  z.object({
243
- name: z.literal('simulateUtility'),
244
- args: z.tuple([FunctionCallSchema, optional(z.array(AuthWitness.schema))]),
344
+ event: AbiDecodedSchema,
345
+ metadata: inTxSchema(),
245
346
  }),
347
+ );
348
+
349
+ export const PublicEventSchema = zodFor<PublicEvent<AbiDecoded>>()(
246
350
  z.object({
247
- name: z.literal('simulateTx'),
248
- args: z.tuple([ExecutionPayloadSchema, SimulateOptionsSchema]),
351
+ event: AbiDecodedSchema,
352
+ metadata: z.intersection(inTxSchema(), z.object({ contractAddress: schemas.AztecAddress })),
249
353
  }),
250
- ]);
354
+ );
251
355
 
252
356
  export const ContractMetadataSchema = z.object({
253
- contractInstance: z.union([ContractInstanceWithAddressSchema, z.undefined()]),
357
+ instance: optional(ContractInstanceWithAddressSchema),
254
358
  isContractInitialized: z.boolean(),
255
359
  isContractPublished: z.boolean(),
256
- }) satisfies ZodFor<ContractMetadata>;
360
+ isContractUpdated: z.boolean(),
361
+ updatedContractClassId: optional(schemas.Fr),
362
+ });
257
363
 
258
364
  export const ContractClassMetadataSchema = z.object({
259
- contractClass: z.union([ContractClassWithIdSchema, z.undefined()]),
365
+ isArtifactRegistered: z.boolean(),
260
366
  isContractClassPubliclyRegistered: z.boolean(),
261
- artifact: z.union([ContractArtifactSchema, z.undefined()]),
262
- }) satisfies ZodFor<ContractClassMetadata>;
367
+ });
263
368
 
264
- export const EventMetadataDefinitionSchema = z.object({
265
- eventSelector: schemas.EventSelector,
266
- abiType: AbiTypeSchema,
267
- fieldNames: z.array(z.string()),
369
+ export const ContractFunctionPatternSchema = z.object({
370
+ contract: z.union([schemas.AztecAddress, z.literal('*')]),
371
+ function: z.union([z.string(), z.literal('*')]),
268
372
  });
269
373
 
270
- export const WalletSchema: ApiSchemaFor<Wallet> = {
374
+ export const AccountsCapabilitySchema = z.object({
375
+ type: z.literal('accounts'),
376
+ canGet: optional(z.boolean()),
377
+ canCreateAuthWit: optional(z.boolean()),
378
+ });
379
+
380
+ export const GrantedAccountsCapabilitySchema = AccountsCapabilitySchema.extend({
381
+ accounts: z.array(z.object({ alias: z.string(), item: schemas.AztecAddress })),
382
+ });
383
+
384
+ export const ContractsCapabilitySchema = z.object({
385
+ type: z.literal('contracts'),
386
+ contracts: z.union([z.literal('*'), z.array(schemas.AztecAddress)]),
387
+ canRegister: optional(z.boolean()),
388
+ canGetMetadata: optional(z.boolean()),
389
+ });
390
+
391
+ export const GrantedContractsCapabilitySchema = ContractsCapabilitySchema;
392
+
393
+ export const ContractClassesCapabilitySchema = z.object({
394
+ type: z.literal('contractClasses'),
395
+ classes: z.union([z.literal('*'), z.array(schemas.Fr)]),
396
+ canGetMetadata: z.boolean(),
397
+ });
398
+
399
+ export const GrantedContractClassesCapabilitySchema = ContractClassesCapabilitySchema;
400
+
401
+ export const SimulationCapabilitySchema = z.object({
402
+ type: z.literal('simulation'),
403
+ transactions: optional(
404
+ z.object({
405
+ scope: z.union([z.literal('*'), z.array(ContractFunctionPatternSchema)]),
406
+ }),
407
+ ),
408
+ utilities: optional(
409
+ z.object({
410
+ scope: z.union([z.literal('*'), z.array(ContractFunctionPatternSchema)]),
411
+ }),
412
+ ),
413
+ });
414
+
415
+ export const GrantedSimulationCapabilitySchema = SimulationCapabilitySchema;
416
+
417
+ export const TransactionCapabilitySchema = z.object({
418
+ type: z.literal('transaction'),
419
+ scope: z.union([z.literal('*'), z.array(ContractFunctionPatternSchema)]),
420
+ });
421
+
422
+ export const GrantedTransactionCapabilitySchema = TransactionCapabilitySchema;
423
+
424
+ export const DataCapabilitySchema = z.object({
425
+ type: z.literal('data'),
426
+ addressBook: optional(z.boolean()),
427
+ privateEvents: optional(
428
+ z.object({
429
+ contracts: z.union([z.literal('*'), z.array(schemas.AztecAddress)]),
430
+ }),
431
+ ),
432
+ });
433
+
434
+ export const GrantedDataCapabilitySchema = DataCapabilitySchema;
435
+
436
+ export const CapabilitySchema = z.discriminatedUnion('type', [
437
+ AccountsCapabilitySchema,
438
+ ContractsCapabilitySchema,
439
+ ContractClassesCapabilitySchema,
440
+ SimulationCapabilitySchema,
441
+ TransactionCapabilitySchema,
442
+ DataCapabilitySchema,
443
+ ]);
444
+
445
+ export const GrantedCapabilitySchema = z.discriminatedUnion('type', [
446
+ GrantedAccountsCapabilitySchema,
447
+ GrantedContractsCapabilitySchema,
448
+ GrantedContractClassesCapabilitySchema,
449
+ GrantedSimulationCapabilitySchema,
450
+ GrantedTransactionCapabilitySchema,
451
+ GrantedDataCapabilitySchema,
452
+ ]);
453
+
454
+ export const AppCapabilitiesSchema = z.object({
455
+ version: z.literal('1.0'),
456
+ metadata: z.object({
457
+ name: z.string(),
458
+ version: z.string(),
459
+ description: optional(z.string()),
460
+ url: optional(z.string()),
461
+ icon: optional(z.string()),
462
+ }),
463
+ capabilities: z.array(CapabilitySchema),
464
+ behavior: optional(
465
+ z.object({
466
+ mode: optional(z.enum(['strict', 'permissive'])),
467
+ expiration: optional(z.number()),
468
+ }),
469
+ ),
470
+ });
471
+
472
+ export const WalletCapabilitiesSchema = z.object({
473
+ version: z.literal('1.0'),
474
+ granted: z.array(GrantedCapabilitySchema),
475
+ wallet: z.object({
476
+ name: z.string(),
477
+ version: z.string(),
478
+ }),
479
+ expiresAt: optional(z.number()),
480
+ });
481
+
482
+ /**
483
+ * Record of all wallet method schemas (excluding batch).
484
+ * This is the single source of truth for method schemas - batch schemas are derived from this.
485
+ */
486
+ const WalletMethodSchemas = {
271
487
  getChainInfo: z
272
488
  .function()
273
489
  .args()
274
490
  .returns(z.object({ chainId: schemas.Fr, version: schemas.Fr })),
275
- getContractClassMetadata: z.function().args(schemas.Fr, optional(z.boolean())).returns(ContractClassMetadataSchema),
276
491
  getContractMetadata: z.function().args(schemas.AztecAddress).returns(ContractMetadataSchema),
277
- getTxReceipt: z.function().args(TxHash.schema).returns(TxReceipt.schema),
492
+ getContractClassMetadata: z.function().args(schemas.Fr).returns(ContractClassMetadataSchema),
278
493
  getPrivateEvents: z
279
494
  .function()
280
- .args(schemas.AztecAddress, EventMetadataDefinitionSchema, z.number(), z.number(), z.array(schemas.AztecAddress))
281
- .returns(z.array(AbiDecodedSchema)),
495
+ .args(EventMetadataDefinitionSchema, PrivateEventFilterSchema)
496
+ .returns(z.array(PrivateEventSchema)),
282
497
  registerSender: z.function().args(schemas.AztecAddress, optional(z.string())).returns(schemas.AztecAddress),
283
498
  getAddressBook: z
284
499
  .function()
@@ -295,24 +510,55 @@ export const WalletSchema: ApiSchemaFor<Wallet> = {
295
510
  simulateTx: z.function().args(ExecutionPayloadSchema, SimulateOptionsSchema).returns(TxSimulationResult.schema),
296
511
  simulateUtility: z
297
512
  .function()
298
- .args(FunctionCallSchema, optional(z.array(AuthWitness.schema)))
513
+ .args(FunctionCall.schema, optional(z.array(AuthWitness.schema)))
299
514
  .returns(UtilitySimulationResult.schema),
300
515
  profileTx: z.function().args(ExecutionPayloadSchema, ProfileOptionsSchema).returns(TxProfileResult.schema),
301
- sendTx: z.function().args(ExecutionPayloadSchema, SendOptionsSchema).returns(TxHash.schema),
516
+ sendTx: z
517
+ .function()
518
+ .args(ExecutionPayloadSchema, SendOptionsSchema)
519
+ .returns(z.union([TxHash.schema, TxReceipt.schema])),
302
520
  createAuthWit: z.function().args(schemas.AztecAddress, MessageHashOrIntentSchema).returns(AuthWitness.schema),
521
+ requestCapabilities: z.function().args(AppCapabilitiesSchema).returns(WalletCapabilitiesSchema),
522
+ };
523
+
524
+ /**
525
+ * Creates batch schemas from the individual wallet methods.
526
+ * This allows us to define them once and derive batch schemas automatically,
527
+ * reducing duplication and ensuring consistency.
528
+ */
529
+ function createBatchSchemas<T extends Record<string, z.ZodFunction<z.ZodTuple<any, any>, z.ZodTypeAny>>>(
530
+ methodSchemas: T,
531
+ ) {
532
+ const names = Object.keys(methodSchemas) as (keyof T)[];
533
+
534
+ const namesAndArgs = names.map(name =>
535
+ z.object({
536
+ name: z.literal(name),
537
+ args: methodSchemas[name].parameters(),
538
+ }),
539
+ );
540
+
541
+ const namesAndReturns = names.map(name =>
542
+ z.object({
543
+ name: z.literal(name),
544
+ result: methodSchemas[name].returnType(),
545
+ }),
546
+ );
547
+
548
+ // Type assertion needed because discriminatedUnion expects a tuple type [T, T, ...T[]]
549
+ // but we're building the array dynamically. The runtime behavior is correct.
550
+ return {
551
+ input: z.discriminatedUnion('name', namesAndArgs as [(typeof namesAndArgs)[0], ...typeof namesAndArgs]),
552
+ output: z.discriminatedUnion('name', namesAndReturns as [(typeof namesAndReturns)[0], ...typeof namesAndReturns]),
553
+ };
554
+ }
555
+
556
+ const { input: BatchedMethodSchema, output: BatchedResultSchema } = createBatchSchemas(WalletMethodSchemas);
557
+
558
+ export { BatchedMethodSchema, BatchedResultSchema };
559
+
560
+ export const WalletSchema: ApiSchemaFor<Wallet> = {
561
+ ...WalletMethodSchemas,
303
562
  // @ts-expect-error - ApiSchemaFor cannot properly type generic methods with readonly arrays
304
- batch: z
305
- .function()
306
- .args(z.array(BatchedMethodSchema))
307
- .returns(
308
- z.array(
309
- z.discriminatedUnion('name', [
310
- z.object({ name: z.literal('registerSender'), result: schemas.AztecAddress }),
311
- z.object({ name: z.literal('registerContract'), result: ContractInstanceWithAddressSchema }),
312
- z.object({ name: z.literal('sendTx'), result: TxHash.schema }),
313
- z.object({ name: z.literal('simulateUtility'), result: UtilitySimulationResult.schema }),
314
- z.object({ name: z.literal('simulateTx'), result: TxSimulationResult.schema }),
315
- ]),
316
- ),
317
- ),
563
+ batch: z.function().args(z.array(BatchedMethodSchema)).returns(z.array(BatchedResultSchema)),
318
564
  };
@@ -1,19 +0,0 @@
1
- import type { AuthWitnessProvider, EntrypointInterface } from '@aztec/entrypoints/interfaces';
2
- import type { Fr } from '@aztec/foundation/fields';
3
- import type { AztecAddress } from '@aztec/stdlib/aztec-address';
4
- import type { CompleteAddress } from '@aztec/stdlib/contract';
5
- /**
6
- * Handler for interfacing with an account. Knows how to create transaction execution
7
- * requests and authorize actions for its corresponding account.
8
- */
9
- export interface AccountInterface extends EntrypointInterface, AuthWitnessProvider {
10
- /** Returns the complete address for this account. */
11
- getCompleteAddress(): CompleteAddress;
12
- /** Returns the address for this account. */
13
- getAddress(): AztecAddress;
14
- /** Returns the chain id for this account */
15
- getChainId(): Fr;
16
- /** Returns the rollup version for this account */
17
- getVersion(): Fr;
18
- }
19
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW50ZXJmYWNlLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYWNjb3VudC9pbnRlcmZhY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLEVBQUUsbUJBQW1CLEVBQUUsbUJBQW1CLEVBQUUsTUFBTSwrQkFBK0IsQ0FBQztBQUM5RixPQUFPLEtBQUssRUFBRSxFQUFFLEVBQUUsTUFBTSwwQkFBMEIsQ0FBQztBQUNuRCxPQUFPLEtBQUssRUFBRSxZQUFZLEVBQUUsTUFBTSw2QkFBNkIsQ0FBQztBQUNoRSxPQUFPLEtBQUssRUFBRSxlQUFlLEVBQUUsTUFBTSx3QkFBd0IsQ0FBQztBQUk5RDs7O0dBR0c7QUFDSCxNQUFNLFdBQVcsZ0JBQWlCLFNBQVEsbUJBQW1CLEVBQUUsbUJBQW1CO0lBQ2hGLHFEQUFxRDtJQUNyRCxrQkFBa0IsSUFBSSxlQUFlLENBQUM7SUFFdEMsNENBQTRDO0lBQzVDLFVBQVUsSUFBSSxZQUFZLENBQUM7SUFFM0IsNENBQTRDO0lBQzVDLFVBQVUsSUFBSSxFQUFFLENBQUM7SUFFakIsa0RBQWtEO0lBQ2xELFVBQVUsSUFBSSxFQUFFLENBQUM7Q0FDbEIifQ==
@@ -1 +0,0 @@
1
- {"version":3,"file":"interface.d.ts","sourceRoot":"","sources":["../../src/account/interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAC9F,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAI9D;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB,EAAE,mBAAmB;IAChF,qDAAqD;IACrD,kBAAkB,IAAI,eAAe,CAAC;IAEtC,4CAA4C;IAC5C,UAAU,IAAI,YAAY,CAAC;IAE3B,4CAA4C;IAC5C,UAAU,IAAI,EAAE,CAAC;IAEjB,kDAAkD;IAClD,UAAU,IAAI,EAAE,CAAC;CAClB"}
@@ -1,5 +0,0 @@
1
- // docs:start:account-interface
2
- /**
3
- * Handler for interfacing with an account. Knows how to create transaction execution
4
- * requests and authorize actions for its corresponding account.
5
- */ export { }; // docs:end:account-interface