@aztec/wallet-sdk 0.0.1-commit.ee80a48 → 0.0.1-commit.f103f88

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