@aztec/wallet-sdk 0.0.1-commit.64b6bbb → 0.0.1-commit.69c59a8b3

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 (58) hide show
  1. package/dest/base-wallet/base_wallet.d.ts +59 -39
  2. package/dest/base-wallet/base_wallet.d.ts.map +1 -1
  3. package/dest/base-wallet/base_wallet.js +195 -75
  4. package/dest/base-wallet/index.d.ts +2 -2
  5. package/dest/base-wallet/index.d.ts.map +1 -1
  6. package/dest/base-wallet/utils.d.ts +5 -3
  7. package/dest/base-wallet/utils.d.ts.map +1 -1
  8. package/dest/base-wallet/utils.js +10 -5
  9. package/dest/crypto.d.ts +39 -1
  10. package/dest/crypto.d.ts.map +1 -1
  11. package/dest/crypto.js +88 -0
  12. package/dest/extension/provider/extension_wallet.d.ts +4 -6
  13. package/dest/extension/provider/extension_wallet.d.ts.map +1 -1
  14. package/dest/extension/provider/extension_wallet.js +9 -2
  15. package/dest/extension/provider/index.d.ts +2 -2
  16. package/dest/extension/provider/index.d.ts.map +1 -1
  17. package/dest/iframe/handlers/iframe_connection_handler.d.ts +118 -0
  18. package/dest/iframe/handlers/iframe_connection_handler.d.ts.map +1 -0
  19. package/dest/iframe/handlers/iframe_connection_handler.js +228 -0
  20. package/dest/iframe/handlers/index.d.ts +2 -0
  21. package/dest/iframe/handlers/index.d.ts.map +1 -0
  22. package/dest/iframe/handlers/index.js +1 -0
  23. package/dest/iframe/provider/iframe_discovery.d.ts +25 -0
  24. package/dest/iframe/provider/iframe_discovery.d.ts.map +1 -0
  25. package/dest/iframe/provider/iframe_discovery.js +167 -0
  26. package/dest/iframe/provider/iframe_provider.d.ts +65 -0
  27. package/dest/iframe/provider/iframe_provider.d.ts.map +1 -0
  28. package/dest/iframe/provider/iframe_provider.js +257 -0
  29. package/dest/iframe/provider/iframe_wallet.d.ts +68 -0
  30. package/dest/iframe/provider/iframe_wallet.d.ts.map +1 -0
  31. package/dest/iframe/provider/iframe_wallet.js +200 -0
  32. package/dest/iframe/provider/index.d.ts +4 -0
  33. package/dest/iframe/provider/index.d.ts.map +1 -0
  34. package/dest/iframe/provider/index.js +3 -0
  35. package/dest/manager/types.d.ts +6 -5
  36. package/dest/manager/types.d.ts.map +1 -1
  37. package/dest/manager/wallet_manager.d.ts +1 -1
  38. package/dest/manager/wallet_manager.d.ts.map +1 -1
  39. package/dest/manager/wallet_manager.js +48 -18
  40. package/dest/types.d.ts +14 -2
  41. package/dest/types.d.ts.map +1 -1
  42. package/dest/types.js +4 -0
  43. package/package.json +12 -8
  44. package/src/base-wallet/base_wallet.ts +269 -127
  45. package/src/base-wallet/index.ts +6 -1
  46. package/src/base-wallet/utils.ts +15 -4
  47. package/src/crypto.ts +104 -0
  48. package/src/extension/provider/extension_wallet.ts +13 -10
  49. package/src/extension/provider/index.ts +1 -1
  50. package/src/iframe/handlers/iframe_connection_handler.ts +328 -0
  51. package/src/iframe/handlers/index.ts +7 -0
  52. package/src/iframe/provider/iframe_discovery.ts +185 -0
  53. package/src/iframe/provider/iframe_provider.ts +331 -0
  54. package/src/iframe/provider/iframe_wallet.ts +229 -0
  55. package/src/iframe/provider/index.ts +3 -0
  56. package/src/manager/types.ts +5 -4
  57. package/src/manager/wallet_manager.ts +55 -23
  58. package/src/types.ts +13 -0
@@ -1,32 +1,37 @@
1
- import type { Account } from '@aztec/aztec.js/account';
1
+ import type { Account, NoFrom } from '@aztec/aztec.js/account';
2
+ import { NO_FROM } from '@aztec/aztec.js/account';
2
3
  import type { CallIntent, IntentInnerHash } from '@aztec/aztec.js/authorization';
3
- import { type InteractionWaitOptions, NO_WAIT, type SendReturn } from '@aztec/aztec.js/contracts';
4
+ import {
5
+ type InteractionWaitOptions,
6
+ NO_WAIT,
7
+ type SendReturn,
8
+ extractOffchainOutput,
9
+ } from '@aztec/aztec.js/contracts';
4
10
  import type { FeePaymentMethod } from '@aztec/aztec.js/fee';
5
11
  import { waitForTx } from '@aztec/aztec.js/node';
6
- import type {
7
- Aliased,
8
- AppCapabilities,
9
- BatchResults,
10
- BatchedMethod,
11
- PrivateEvent,
12
- PrivateEventFilter,
13
- ProfileOptions,
14
- SendOptions,
15
- SimulateOptions,
16
- Wallet,
17
- WalletCapabilities,
18
- } from '@aztec/aztec.js/wallet';
19
12
  import {
20
- GAS_ESTIMATION_DA_GAS_LIMIT,
21
- GAS_ESTIMATION_L2_GAS_LIMIT,
22
- GAS_ESTIMATION_TEARDOWN_DA_GAS_LIMIT,
23
- GAS_ESTIMATION_TEARDOWN_L2_GAS_LIMIT,
24
- } from '@aztec/constants';
13
+ type Aliased,
14
+ type AppCapabilities,
15
+ type BatchResults,
16
+ type BatchedMethod,
17
+ ContractInitializationStatus,
18
+ type ExecuteUtilityOptions,
19
+ type PrivateEvent,
20
+ type PrivateEventFilter,
21
+ type ProfileOptions,
22
+ type SendOptions,
23
+ type SimulateOptions,
24
+ TxSimulationResultWithAppOffset,
25
+ type Wallet,
26
+ type WalletCapabilities,
27
+ } from '@aztec/aztec.js/wallet';
25
28
  import { AccountFeePaymentMethodOptions, type DefaultAccountEntrypointOptions } from '@aztec/entrypoints/account';
29
+ import { DefaultEntrypoint } from '@aztec/entrypoints/default';
26
30
  import type { ChainInfo } from '@aztec/entrypoints/interfaces';
27
31
  import { Fr } from '@aztec/foundation/curves/bn254';
28
32
  import { createLogger } from '@aztec/foundation/log';
29
33
  import type { FieldsOf } from '@aztec/foundation/types';
34
+ import { displayDebugLogs } from '@aztec/pxe/client/lazy';
30
35
  import type { PXE, PackedPrivateEvent } from '@aztec/pxe/server';
31
36
  import {
32
37
  type ContractArtifact,
@@ -35,23 +40,28 @@ import {
35
40
  decodeFromAbi,
36
41
  } from '@aztec/stdlib/abi';
37
42
  import type { AuthWitness } from '@aztec/stdlib/auth-witness';
38
- import type { AztecAddress } from '@aztec/stdlib/aztec-address';
43
+ import { AztecAddress } from '@aztec/stdlib/aztec-address';
39
44
  import {
40
45
  type ContractInstanceWithAddress,
46
+ type NodeInfo,
41
47
  computePartialAddress,
42
48
  getContractClassFromArtifact,
43
49
  } from '@aztec/stdlib/contract';
44
50
  import { SimulationError } from '@aztec/stdlib/errors';
45
- import { Gas, GasSettings } from '@aztec/stdlib/gas';
46
- import { siloNullifier } from '@aztec/stdlib/hash';
51
+ import { Gas, GasFees, GasSettings, ManaUsageEstimate } from '@aztec/stdlib/gas';
52
+ import {
53
+ computeSiloedPrivateInitializationNullifier,
54
+ computeSiloedPublicInitializationNullifier,
55
+ } from '@aztec/stdlib/hash';
47
56
  import type { AztecNode } from '@aztec/stdlib/interfaces/client';
48
57
  import {
58
+ BlockHeader,
59
+ ExecutionPayload,
49
60
  type TxExecutionRequest,
50
61
  type TxProfileResult,
51
- TxSimulationResult,
52
- type UtilitySimulationResult,
62
+ type UtilityExecutionResult,
63
+ mergeExecutionPayloads,
53
64
  } from '@aztec/stdlib/tx';
54
- import { ExecutionPayload, mergeExecutionPayloads } from '@aztec/stdlib/tx';
55
65
 
56
66
  import { inspect } from 'util';
57
67
 
@@ -67,26 +77,60 @@ export type FeeOptions = {
67
77
  */
68
78
  walletFeePaymentMethod?: FeePaymentMethod;
69
79
  /** Configuration options for the account to properly handle the selected fee payment method */
70
- accountFeePaymentMethodOptions: AccountFeePaymentMethodOptions;
80
+ accountFeePaymentMethodOptions?: AccountFeePaymentMethodOptions;
71
81
  /** The gas settings to use for the transaction */
72
82
  gasSettings: GasSettings;
73
83
  };
74
84
 
85
+ /** Options for `simulateViaEntrypoint`. */
86
+ export type SimulateViaEntrypointOptions = Pick<
87
+ SimulateOptions,
88
+ 'from' | 'additionalScopes' | 'skipTxValidation' | 'skipFeeEnforcement'
89
+ > & {
90
+ /** Fee options for the entrypoint */
91
+ feeOptions: FeeOptions;
92
+ };
93
+
94
+ /** Options for `completeFeeOptions`. */
95
+ export type CompleteFeeOptionsConfig = {
96
+ /** The address where the transaction is being sent from. */
97
+ from: AztecAddress | NoFrom;
98
+ /** The address paying for fees (if any fee payment method is embedded in the execution payload). */
99
+ feePayer?: AztecAddress;
100
+ /** User-provided partial gas settings. */
101
+ gasSettings?: Partial<FieldsOf<GasSettings>>;
102
+ /** If true, returns gas settings with high gas limits for estimation. If false, uses fallback limits. */
103
+ forEstimation?: boolean;
104
+ /**
105
+ * Assumed network congestion level for fee prediction. Controls how aggressively the wallet
106
+ * estimates future fees. Defaults to Limit (worst case) when not specified.
107
+ */
108
+ congestionEstimate?: ManaUsageEstimate;
109
+ };
110
+
75
111
  /**
76
112
  * A base class for Wallet implementations
77
113
  */
78
114
  export abstract class BaseWallet implements Wallet {
79
- protected log = createLogger('wallet-sdk:base_wallet');
80
-
81
115
  protected minFeePadding = 0.5;
82
116
  protected cancellableTransactions = false;
117
+ // A wallet is instantiated for a particular chain, so chain info never changes during its lifetime.
118
+ // We cache it here because getChainInfo is called frequently (every tx simulation, send, auth wit, etc.).
119
+ private nodeInfoPromise: Promise<NodeInfo> | undefined;
83
120
 
84
121
  // Protected because we want to force wallets to instantiate their own PXE.
85
122
  protected constructor(
86
123
  protected readonly pxe: PXE,
87
124
  protected readonly aztecNode: AztecNode,
125
+ protected log = createLogger('wallet-sdk:base_wallet'),
88
126
  ) {}
89
127
 
128
+ protected scopesFrom(from: AztecAddress | NoFrom, additionalScopes: AztecAddress[] = []): AztecAddress[] {
129
+ const allScopes = from === NO_FROM ? additionalScopes : [from, ...additionalScopes];
130
+ const scopeSet = new Set(allScopes.map(address => address.toString()));
131
+ return [...scopeSet].map(AztecAddress.fromString);
132
+ }
133
+
90
134
  protected abstract getAccountFromAddress(address: AztecAddress): Promise<Account>;
91
135
 
92
136
  abstract getAccounts(): Promise<Aliased<AztecAddress>[]>;
@@ -104,32 +148,42 @@ export abstract class BaseWallet implements Wallet {
104
148
  }
105
149
 
106
150
  async getChainInfo(): Promise<ChainInfo> {
107
- const { l1ChainId, rollupVersion } = await this.aztecNode.getNodeInfo();
151
+ if (!this.nodeInfoPromise) {
152
+ this.nodeInfoPromise = this.aztecNode.getNodeInfo();
153
+ }
154
+ const { l1ChainId, rollupVersion } = await this.nodeInfoPromise;
108
155
  return { chainId: new Fr(l1ChainId), version: new Fr(rollupVersion) };
109
156
  }
110
157
 
111
158
  protected async createTxExecutionRequestFromPayloadAndFee(
112
159
  executionPayload: ExecutionPayload,
113
- from: AztecAddress,
160
+ from: AztecAddress | NoFrom,
114
161
  feeOptions: FeeOptions,
115
162
  ): Promise<TxExecutionRequest> {
116
163
  const feeExecutionPayload = await feeOptions.walletFeePaymentMethod?.getExecutionPayload();
117
- const executionOptions: DefaultAccountEntrypointOptions = {
118
- txNonce: Fr.random(),
119
- cancellable: this.cancellableTransactions,
120
- feePaymentMethodOptions: feeOptions.accountFeePaymentMethodOptions,
121
- };
122
164
  const finalExecutionPayload = feeExecutionPayload
123
165
  ? mergeExecutionPayloads([feeExecutionPayload, executionPayload])
124
166
  : executionPayload;
125
- const fromAccount = await this.getAccountFromAddress(from);
126
167
  const chainInfo = await this.getChainInfo();
127
- return fromAccount.createTxExecutionRequest(
128
- finalExecutionPayload,
129
- feeOptions.gasSettings,
130
- chainInfo,
131
- executionOptions,
132
- );
168
+
169
+ if (from === NO_FROM) {
170
+ const entrypoint = new DefaultEntrypoint();
171
+ return entrypoint.createTxExecutionRequest(finalExecutionPayload, feeOptions.gasSettings, chainInfo);
172
+ } else {
173
+ const fromAccount = await this.getAccountFromAddress(from);
174
+ const executionOptions: DefaultAccountEntrypointOptions = {
175
+ txNonce: Fr.random(),
176
+ cancellable: this.cancellableTransactions,
177
+ // If from is an address, feeOptions include the way the account contract should handle the fee payment
178
+ feePaymentMethodOptions: feeOptions.accountFeePaymentMethodOptions!,
179
+ };
180
+ return fromAccount.createTxExecutionRequest(
181
+ finalExecutionPayload,
182
+ feeOptions.gasSettings,
183
+ chainInfo,
184
+ executionOptions,
185
+ );
186
+ }
133
187
  }
134
188
 
135
189
  public async createAuthWit(
@@ -178,31 +232,39 @@ export abstract class BaseWallet implements Wallet {
178
232
 
179
233
  /**
180
234
  * Completes partial user-provided fee options with wallet defaults.
181
- * @param from - The address where the transaction is being sent from
182
- * @param feePayer - The address paying for fees (if any fee payment method is embedded in the execution payload)
183
- * @param gasSettings - User-provided partial gas settings
184
- * @returns - Complete fee options that can be used to create a transaction execution request
235
+ * @param config - Fee completion config.
185
236
  */
186
- protected async completeFeeOptions(
187
- from: AztecAddress,
188
- feePayer?: AztecAddress,
189
- gasSettings?: Partial<FieldsOf<GasSettings>>,
190
- ): Promise<FeeOptions> {
237
+ protected async completeFeeOptions(config: CompleteFeeOptionsConfig): Promise<FeeOptions> {
238
+ const { from, feePayer, gasSettings, forEstimation, congestionEstimate } = config;
191
239
  const maxFeesPerGas =
192
- gasSettings?.maxFeesPerGas ?? (await this.aztecNode.getCurrentMinFees()).mul(1 + this.minFeePadding);
240
+ gasSettings?.maxFeesPerGas ?? (await this.getMinFees(congestionEstimate)).mul(1 + this.minFeePadding);
193
241
  let accountFeePaymentMethodOptions;
194
- // The transaction does not include a fee payment method, so we set the flag
195
- // for the account to use its fee juice balance
196
- if (!feePayer) {
197
- accountFeePaymentMethodOptions = AccountFeePaymentMethodOptions.PREEXISTING_FEE_JUICE;
198
- } else {
199
- // The transaction includes fee payment method, so we check if we are the fee payer for it
200
- // (this can only happen if the embedded payment method is FeeJuiceWithClaim)
201
- accountFeePaymentMethodOptions = from.equals(feePayer)
202
- ? AccountFeePaymentMethodOptions.FEE_JUICE_WITH_CLAIM
203
- : AccountFeePaymentMethodOptions.EXTERNAL;
242
+ // If from is an address, we need to determine the appropriate fee payment method options for the
243
+ // account contract entrypoint to use
244
+ if (from !== NO_FROM) {
245
+ if (!feePayer) {
246
+ // The transaction does not include a fee payment method, so we set the flag
247
+ // for the account to use its fee juice balance
248
+ accountFeePaymentMethodOptions = AccountFeePaymentMethodOptions.PREEXISTING_FEE_JUICE;
249
+ } else {
250
+ // The transaction includes fee payment method, so we check if we are the fee payer for it
251
+ // (this can only happen if the embedded payment method is FeeJuiceWithClaim)
252
+ accountFeePaymentMethodOptions = from.equals(feePayer)
253
+ ? AccountFeePaymentMethodOptions.FEE_JUICE_WITH_CLAIM
254
+ : AccountFeePaymentMethodOptions.EXTERNAL;
255
+ }
204
256
  }
205
- const fullGasSettings: GasSettings = GasSettings.default({ ...gasSettings, maxFeesPerGas });
257
+ const gasSettingsOverrides = {
258
+ gasLimits: gasSettings?.gasLimits ? Gas.from(gasSettings.gasLimits) : undefined,
259
+ teardownGasLimits: gasSettings?.teardownGasLimits ? Gas.from(gasSettings.teardownGasLimits) : undefined,
260
+ maxFeesPerGas,
261
+ maxPriorityFeesPerGas: gasSettings?.maxPriorityFeesPerGas ?? GasFees.empty(),
262
+ };
263
+ // When estimating gas (simulation), use high limits so the simulation doesn't run out of gas.
264
+ // When sending for real, use protocol max limits that the network will actually accept.
265
+ const fullGasSettings = forEstimation
266
+ ? GasSettings.forEstimation(gasSettingsOverrides)
267
+ : GasSettings.fallback(gasSettingsOverrides);
206
268
  this.log.debug(`Using L2 gas settings`, fullGasSettings);
207
269
  return {
208
270
  gasSettings: fullGasSettings,
@@ -212,34 +274,25 @@ export abstract class BaseWallet implements Wallet {
212
274
  }
213
275
 
214
276
  /**
215
- * Completes partial user-provided fee options with unreasonably high gas limits
216
- * for gas estimation. Uses the same logic as completeFeeOptions but sets high limits
217
- * to avoid running out of gas during estimation.
218
- * @param from - The address where the transaction is being sent from
219
- * @param feePayer - The address paying for fees (if any fee payment method is embedded in the execution payload)
220
- * @param gasSettings - User-provided partial gas settings
277
+ * Returns the worst-case min fee across predicted future slots.
278
+ * Falls back to getCurrentMinFees if the node doesn't support getPredictedMinFees.
279
+ * @param estimate - The mana usage estimate to use for fee prediction. Defaults to Limit for conservative estimation.
221
280
  */
222
- protected async completeFeeOptionsForEstimation(
223
- from: AztecAddress,
224
- feePayer?: AztecAddress,
225
- gasSettings?: Partial<FieldsOf<GasSettings>>,
226
- ) {
227
- const defaultFeeOptions = await this.completeFeeOptions(from, feePayer, gasSettings);
228
- const {
229
- gasSettings: { maxFeesPerGas, maxPriorityFeesPerGas },
230
- } = defaultFeeOptions;
231
- // Use unrealistically high gas limits for estimation to avoid running out of gas.
232
- // They will be tuned down after the simulation.
233
- const gasSettingsForEstimation = new GasSettings(
234
- new Gas(GAS_ESTIMATION_DA_GAS_LIMIT, GAS_ESTIMATION_L2_GAS_LIMIT),
235
- new Gas(GAS_ESTIMATION_TEARDOWN_DA_GAS_LIMIT, GAS_ESTIMATION_TEARDOWN_L2_GAS_LIMIT),
236
- maxFeesPerGas,
237
- maxPriorityFeesPerGas,
238
- );
239
- return {
240
- ...defaultFeeOptions,
241
- gasSettings: gasSettingsForEstimation,
242
- };
281
+ protected async getMinFees(estimate: ManaUsageEstimate = ManaUsageEstimate.Limit): Promise<GasFees> {
282
+ try {
283
+ const predicted = await this.aztecNode.getPredictedMinFees(estimate);
284
+ if (predicted.length === 0) {
285
+ return this.aztecNode.getCurrentMinFees();
286
+ }
287
+ return predicted.reduce((worst, fees) => (fees.feePerL2Gas > worst.feePerL2Gas ? fees : worst));
288
+ } catch (err: any) {
289
+ // Fallback for old nodes that don't support getPredictedMinFees.
290
+ // Only fall back on method-not-found errors (JSON-RPC code -32601); rethrow others.
291
+ if (err?.cause?.code === -32601 || err?.message?.includes('Method not found')) {
292
+ return this.aztecNode.getCurrentMinFees();
293
+ }
294
+ throw err;
295
+ }
243
296
  }
244
297
 
245
298
  registerSender(address: AztecAddress, _alias: string = ''): Promise<AztecAddress> {
@@ -287,20 +340,36 @@ export abstract class BaseWallet implements Wallet {
287
340
  /**
288
341
  * Simulates calls through the standard PXE path (account entrypoint).
289
342
  * @param executionPayload - The execution payload to simulate.
290
- * @param from - The sender address.
291
- * @param feeOptions - Fee options for the transaction.
292
- * @param skipTxValidation - Whether to skip tx validation.
293
- * @param skipFeeEnforcement - Whether to skip fee enforcement.
343
+ * @param opts - Simulation options.
294
344
  */
295
- protected async simulateViaEntrypoint(
296
- executionPayload: ExecutionPayload,
297
- from: AztecAddress,
298
- feeOptions: FeeOptions,
299
- skipTxValidation?: boolean,
300
- skipFeeEnforcement?: boolean,
301
- ) {
302
- const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, from, feeOptions);
303
- return this.pxe.simulateTx(txRequest, { simulatePublic: true, skipTxValidation, skipFeeEnforcement });
345
+ protected async simulateViaEntrypoint(executionPayload: ExecutionPayload, opts: SimulateViaEntrypointOptions) {
346
+ const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(
347
+ executionPayload,
348
+ opts.from,
349
+ opts.feeOptions,
350
+ );
351
+ const result = await this.pxe.simulateTx(txRequest, {
352
+ simulatePublic: true,
353
+ skipTxValidation: opts.skipTxValidation,
354
+ skipFeeEnforcement: opts.skipFeeEnforcement,
355
+ scopes: this.scopesFrom(opts.from, opts.additionalScopes),
356
+ });
357
+ const appCallOffset = await this.computeAppCallOffset(opts.from, opts.feeOptions);
358
+ return TxSimulationResultWithAppOffset.fromResultAndOffset(result, appCallOffset);
359
+ }
360
+
361
+ /**
362
+ * Computes the index where the app's calls begin in the flattened array of calls (0 = entrypoint/root, 1..N = fee
363
+ * calls, N+1 = app).
364
+ * @param from - The sender address, or NO_FROM for the default entrypoint.
365
+ * @param feeOptions - Fee options containing the wallet fee payment method.
366
+ */
367
+ protected async computeAppCallOffset(from: AztecAddress | NoFrom, feeOptions: FeeOptions): Promise<number> {
368
+ if (from === NO_FROM) {
369
+ return 0;
370
+ }
371
+ const feeExecutionPayload = await feeOptions.walletFeePaymentMethod?.getExecutionPayload();
372
+ return (feeExecutionPayload?.calls.length ?? 0) + 1; // +1 for entrypoint
304
373
  }
305
374
 
306
375
  /**
@@ -311,36 +380,52 @@ export abstract class BaseWallet implements Wallet {
311
380
  * @param opts - Simulation options (from address, fee settings, etc.).
312
381
  * @returns The merged simulation result.
313
382
  */
314
- async simulateTx(executionPayload: ExecutionPayload, opts: SimulateOptions): Promise<TxSimulationResult> {
315
- const feeOptions = opts.fee?.estimateGas
316
- ? await this.completeFeeOptionsForEstimation(opts.from, executionPayload.feePayer, opts.fee?.gasSettings)
317
- : await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
383
+ async simulateTx(
384
+ executionPayload: ExecutionPayload,
385
+ opts: SimulateOptions,
386
+ ): Promise<TxSimulationResultWithAppOffset> {
387
+ const feeOptions = await this.completeFeeOptions({
388
+ from: opts.from,
389
+ feePayer: executionPayload.feePayer,
390
+ gasSettings: opts.fee?.gasSettings,
391
+ forEstimation: true,
392
+ congestionEstimate: opts.fee?.congestionEstimate,
393
+ });
318
394
  const { optimizableCalls, remainingCalls } = extractOptimizablePublicStaticCalls(executionPayload);
319
395
  const remainingPayload = { ...executionPayload, calls: remainingCalls };
320
396
 
321
397
  const chainInfo = await this.getChainInfo();
322
- const blockHeader = await this.pxe.getSyncedBlockHeader();
398
+ let blockHeader: BlockHeader;
399
+ // PXE might not be synced yet, so we pull the latest header from the node
400
+ // To keep things consistent, we'll always try with PXE first
401
+ try {
402
+ blockHeader = await this.pxe.getSyncedBlockHeader();
403
+ } catch {
404
+ blockHeader = (await this.aztecNode.getBlockHeader())!;
405
+ }
323
406
 
407
+ const simulationOrigin = opts.from === NO_FROM ? AztecAddress.ZERO : opts.from;
324
408
  const [optimizedResults, normalResult] = await Promise.all([
325
409
  optimizableCalls.length > 0
326
410
  ? simulateViaNode(
327
411
  this.aztecNode,
328
412
  optimizableCalls,
329
- opts.from,
413
+ simulationOrigin,
330
414
  chainInfo,
331
415
  feeOptions.gasSettings,
332
416
  blockHeader,
333
417
  opts.skipFeeEnforcement ?? true,
418
+ this.getContractName.bind(this),
334
419
  )
335
420
  : Promise.resolve([]),
336
421
  remainingCalls.length > 0
337
- ? this.simulateViaEntrypoint(
338
- remainingPayload,
339
- opts.from,
422
+ ? this.simulateViaEntrypoint(remainingPayload, {
423
+ from: opts.from,
340
424
  feeOptions,
341
- opts.skipTxValidation,
342
- opts.skipFeeEnforcement ?? true,
343
- )
425
+ additionalScopes: opts.additionalScopes,
426
+ skipTxValidation: opts.skipTxValidation,
427
+ skipFeeEnforcement: opts.skipFeeEnforcement ?? true,
428
+ })
344
429
  : Promise.resolve(null),
345
430
  ]);
346
431
 
@@ -348,11 +433,17 @@ export abstract class BaseWallet implements Wallet {
348
433
  }
349
434
 
350
435
  async profileTx(executionPayload: ExecutionPayload, opts: ProfileOptions): Promise<TxProfileResult> {
351
- const feeOptions = await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
436
+ const feeOptions = await this.completeFeeOptions({
437
+ from: opts.from,
438
+ feePayer: executionPayload.feePayer,
439
+ gasSettings: opts.fee?.gasSettings,
440
+ congestionEstimate: opts.fee?.congestionEstimate,
441
+ });
352
442
  const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
353
443
  return this.pxe.profileTx(txRequest, {
354
444
  profileMode: opts.profileMode,
355
445
  skipProofGeneration: opts.skipProofGeneration ?? true,
446
+ scopes: this.scopesFrom(opts.from, opts.additionalScopes),
356
447
  });
357
448
  }
358
449
 
@@ -360,9 +451,18 @@ export abstract class BaseWallet implements Wallet {
360
451
  executionPayload: ExecutionPayload,
361
452
  opts: SendOptions<W>,
362
453
  ): Promise<SendReturn<W>> {
363
- const feeOptions = await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
454
+ const feeOptions = await this.completeFeeOptions({
455
+ from: opts.from,
456
+ feePayer: executionPayload.feePayer,
457
+ gasSettings: opts.fee?.gasSettings,
458
+ congestionEstimate: opts.fee?.congestionEstimate,
459
+ });
364
460
  const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
365
- const provenTx = await this.pxe.proveTx(txRequest);
461
+ const provenTx = await this.pxe.proveTx(txRequest, this.scopesFrom(opts.from, opts.additionalScopes));
462
+ const offchainOutput = extractOffchainOutput(
463
+ provenTx.getOffchainEffects(),
464
+ provenTx.publicInputs.constants.anchorBlockHeader.globalVariables.timestamp,
465
+ );
366
466
  const tx = await provenTx.toTx();
367
467
  const txHash = tx.getTxHash();
368
468
  if (await this.aztecNode.getTxEffect(txHash)) {
@@ -376,12 +476,32 @@ export abstract class BaseWallet implements Wallet {
376
476
 
377
477
  // If wait is NO_WAIT, return txHash immediately
378
478
  if (opts.wait === NO_WAIT) {
379
- return txHash as SendReturn<W>;
479
+ return { txHash, ...offchainOutput } as SendReturn<W>;
380
480
  }
381
481
 
382
482
  // Otherwise, wait for the full receipt (default behavior on wait: undefined)
383
483
  const waitOpts = typeof opts.wait === 'object' ? opts.wait : undefined;
384
- return (await waitForTx(this.aztecNode, txHash, waitOpts)) as SendReturn<W>;
484
+ const receipt = await waitForTx(this.aztecNode, txHash, waitOpts);
485
+
486
+ // Display debug logs from public execution if present (served in test mode only)
487
+ if (receipt.debugLogs?.length) {
488
+ await displayDebugLogs(receipt.debugLogs, this.getContractName.bind(this));
489
+ }
490
+
491
+ return { receipt, ...offchainOutput } as SendReturn<W>;
492
+ }
493
+
494
+ /**
495
+ * Resolves a contract address to a human-readable name via PXE, if available.
496
+ * @param address - The contract address to resolve.
497
+ */
498
+ protected async getContractName(address: AztecAddress): Promise<string | undefined> {
499
+ const instance = await this.pxe.getContractInstance(address);
500
+ if (!instance) {
501
+ return undefined;
502
+ }
503
+ const artifact = await this.pxe.getContractArtifact(instance.currentContractClassId);
504
+ return artifact?.name;
385
505
  }
386
506
 
387
507
  protected contextualizeError(err: Error, ...context: string[]): Error {
@@ -398,8 +518,8 @@ export abstract class BaseWallet implements Wallet {
398
518
  return err;
399
519
  }
400
520
 
401
- simulateUtility(call: FunctionCall, authwits?: AuthWitness[]): Promise<UtilitySimulationResult> {
402
- return this.pxe.simulateUtility(call, { authwits });
521
+ executeUtility(call: FunctionCall, opts: ExecuteUtilityOptions): Promise<UtilityExecutionResult> {
522
+ return this.pxe.executeUtility(call, { authwits: opts.authWitnesses, scopes: opts.scopes });
403
523
  }
404
524
 
405
525
  async getPrivateEvents<T>(
@@ -422,17 +542,39 @@ export abstract class BaseWallet implements Wallet {
422
542
  return decodedEvents;
423
543
  }
424
544
 
545
+ /**
546
+ * Returns metadata about a contract, including whether it has been initialized, published, and updated.
547
+ * @param address - The contract address to query.
548
+ */
425
549
  async getContractMetadata(address: AztecAddress) {
426
550
  const instance = await this.pxe.getContractInstance(address);
427
- const initNullifier = await siloNullifier(address, address.toField());
428
- const publiclyRegisteredContract = await this.aztecNode.getContract(address);
429
- const initNullifierMembershipWitness = await this.aztecNode.getNullifierMembershipWitness('latest', initNullifier);
551
+ const publiclyRegisteredContractPromise = this.aztecNode.getContract(address);
552
+
553
+ let initializationStatus: ContractInitializationStatus;
554
+ if (instance) {
555
+ // We have the instance, so we can compute the private initialization nullifier (which includes init_hash and is
556
+ // emitted by both private and public initializers) and get a definitive INITIALIZED/UNINITIALIZED answer.
557
+ const initNullifier = await computeSiloedPrivateInitializationNullifier(address, instance.initializationHash);
558
+ const witness = await this.aztecNode.getNullifierMembershipWitness('latest', initNullifier);
559
+ initializationStatus = witness
560
+ ? ContractInitializationStatus.INITIALIZED
561
+ : ContractInitializationStatus.UNINITIALIZED;
562
+ } else {
563
+ // Without the instance we lack the init_hash needed for the private nullifier. We fall back to checking the
564
+ // public initialization nullifier (computed from address alone). Not all contracts emit it (only those with
565
+ // public functions that require initialization checks), so its absence doesn't mean the contract is
566
+ // uninitialized.
567
+ const publicNullifier = await computeSiloedPublicInitializationNullifier(address);
568
+ const witness = await this.aztecNode.getNullifierMembershipWitness('latest', publicNullifier);
569
+ initializationStatus = witness ? ContractInitializationStatus.INITIALIZED : ContractInitializationStatus.UNKNOWN;
570
+ }
571
+ const publiclyRegisteredContract = await publiclyRegisteredContractPromise;
430
572
  const isContractUpdated =
431
573
  publiclyRegisteredContract &&
432
574
  !publiclyRegisteredContract.currentContractClassId.equals(publiclyRegisteredContract.originalContractClassId);
433
575
  return {
434
576
  instance: instance ?? undefined,
435
- isContractInitialized: !!initNullifierMembershipWitness,
577
+ initializationStatus,
436
578
  isContractPublished: !!publiclyRegisteredContract,
437
579
  isContractUpdated: !!isContractUpdated,
438
580
  updatedContractClassId: isContractUpdated ? publiclyRegisteredContract.currentContractClassId : undefined,
@@ -1,2 +1,7 @@
1
- export { BaseWallet, type FeeOptions } from './base_wallet.js';
1
+ export {
2
+ BaseWallet,
3
+ type CompleteFeeOptionsConfig,
4
+ type FeeOptions,
5
+ type SimulateViaEntrypointOptions,
6
+ } from './base_wallet.js';
2
7
  export { simulateViaNode, buildMergedSimulationResult, extractOptimizablePublicStaticCalls } from './utils.js';
@@ -1,9 +1,12 @@
1
1
  import type { AztecNode } from '@aztec/aztec.js/node';
2
+ import { TxSimulationResultWithAppOffset } from '@aztec/aztec.js/wallet';
2
3
  import { MAX_ENQUEUED_CALLS_PER_CALL } from '@aztec/constants';
3
4
  import type { ChainInfo } from '@aztec/entrypoints/interfaces';
4
5
  import { makeTuple } from '@aztec/foundation/array';
5
6
  import { Fr } from '@aztec/foundation/curves/bn254';
6
7
  import type { Tuple } from '@aztec/foundation/serialize';
8
+ import type { ContractNameResolver } from '@aztec/pxe/client/lazy';
9
+ import { displayDebugLogs } from '@aztec/pxe/client/lazy';
7
10
  import { generateSimulatedProvingResult } from '@aztec/pxe/simulator';
8
11
  import { type FunctionCall, FunctionSelector } from '@aztec/stdlib/abi';
9
12
  import type { AztecAddress } from '@aztec/stdlib/aztec-address';
@@ -72,6 +75,7 @@ async function simulateBatchViaNode(
72
75
  gasSettings: GasSettings,
73
76
  blockHeader: BlockHeader,
74
77
  skipFeeEnforcement: boolean,
78
+ getContractName: ContractNameResolver,
75
79
  ): Promise<TxSimulationResult> {
76
80
  const txContext = new TxContext(chainInfo.chainId, chainInfo.version, gasSettings);
77
81
 
@@ -126,6 +130,7 @@ async function simulateBatchViaNode(
126
130
  const provingResult = await generateSimulatedProvingResult(
127
131
  privateResult,
128
132
  (_contractAddress: AztecAddress, _functionSelector: FunctionSelector) => Promise.resolve(''),
133
+ node,
129
134
  1, // minRevertibleSideEffectCounter
130
135
  );
131
136
 
@@ -144,6 +149,9 @@ async function simulateBatchViaNode(
144
149
  throw publicOutput.revertReason;
145
150
  }
146
151
 
152
+ // Display debug logs from the public simulation.
153
+ await displayDebugLogs(publicOutput.debugLogs, getContractName);
154
+
147
155
  return new TxSimulationResult(privateResult, provingResult.publicInputs, publicOutput, undefined);
148
156
  }
149
157
 
@@ -168,6 +176,7 @@ export async function simulateViaNode(
168
176
  gasSettings: GasSettings,
169
177
  blockHeader: BlockHeader,
170
178
  skipFeeEnforcement: boolean = true,
179
+ getContractName: ContractNameResolver,
171
180
  ): Promise<TxSimulationResult[]> {
172
181
  const batches: FunctionCall[][] = [];
173
182
 
@@ -186,6 +195,7 @@ export async function simulateViaNode(
186
195
  gasSettings,
187
196
  blockHeader,
188
197
  skipFeeEnforcement,
198
+ getContractName,
189
199
  );
190
200
  results.push(result);
191
201
  }
@@ -205,13 +215,13 @@ export async function simulateViaNode(
205
215
  */
206
216
  export function buildMergedSimulationResult(
207
217
  optimizedResults: TxSimulationResult[],
208
- normalResult: TxSimulationResult | null,
209
- ): TxSimulationResult {
218
+ normalResult: TxSimulationResultWithAppOffset | null,
219
+ ): TxSimulationResultWithAppOffset {
210
220
  const optimizedReturnValues = optimizedResults.flatMap(r => r.publicOutput?.publicReturnValues ?? []);
211
221
  const normalReturnValues = normalResult?.publicOutput?.publicReturnValues ?? [];
212
222
  const allReturnValues = [...optimizedReturnValues, ...normalReturnValues];
213
223
 
214
- const baseResult = normalResult ?? optimizedResults[0];
224
+ const baseResult: TxSimulationResult = normalResult ?? optimizedResults[0];
215
225
 
216
226
  const mergedPublicOutput: PublicSimulationOutput | undefined = baseResult.publicOutput
217
227
  ? {
@@ -220,10 +230,11 @@ export function buildMergedSimulationResult(
220
230
  }
221
231
  : undefined;
222
232
 
223
- return new TxSimulationResult(
233
+ const merged = new TxSimulationResult(
224
234
  baseResult.privateExecutionResult,
225
235
  baseResult.publicInputs,
226
236
  mergedPublicOutput,
227
237
  normalResult?.stats,
228
238
  );
239
+ return TxSimulationResultWithAppOffset.fromResultAndOffset(merged, normalResult?.appCallOffset ?? 0);
229
240
  }