@aztec/wallet-sdk 0.0.1-commit.d1f2d6c → 0.0.1-commit.d20b825a7

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 +93 -35
  2. package/dest/base-wallet/base_wallet.d.ts.map +1 -1
  3. package/dest/base-wallet/base_wallet.js +253 -69
  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 +347 -122
  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,30 +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
- BatchResults,
9
- BatchedMethod,
10
- PrivateEvent,
11
- PrivateEventFilter,
12
- ProfileOptions,
13
- SendOptions,
14
- SimulateOptions,
15
- Wallet,
16
- } from '@aztec/aztec.js/wallet';
17
12
  import {
18
- GAS_ESTIMATION_DA_GAS_LIMIT,
19
- GAS_ESTIMATION_L2_GAS_LIMIT,
20
- GAS_ESTIMATION_TEARDOWN_DA_GAS_LIMIT,
21
- GAS_ESTIMATION_TEARDOWN_L2_GAS_LIMIT,
22
- } 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';
23
28
  import { AccountFeePaymentMethodOptions, type DefaultAccountEntrypointOptions } from '@aztec/entrypoints/account';
29
+ import { DefaultEntrypoint } from '@aztec/entrypoints/default';
24
30
  import type { ChainInfo } from '@aztec/entrypoints/interfaces';
25
31
  import { Fr } from '@aztec/foundation/curves/bn254';
26
32
  import { createLogger } from '@aztec/foundation/log';
27
33
  import type { FieldsOf } from '@aztec/foundation/types';
34
+ import { displayDebugLogs } from '@aztec/pxe/client/lazy';
28
35
  import type { PXE, PackedPrivateEvent } from '@aztec/pxe/server';
29
36
  import {
30
37
  type ContractArtifact,
@@ -33,26 +40,33 @@ import {
33
40
  decodeFromAbi,
34
41
  } from '@aztec/stdlib/abi';
35
42
  import type { AuthWitness } from '@aztec/stdlib/auth-witness';
36
- import type { AztecAddress } from '@aztec/stdlib/aztec-address';
43
+ import { AztecAddress } from '@aztec/stdlib/aztec-address';
37
44
  import {
38
45
  type ContractInstanceWithAddress,
46
+ type NodeInfo,
39
47
  computePartialAddress,
40
48
  getContractClassFromArtifact,
41
49
  } from '@aztec/stdlib/contract';
42
50
  import { SimulationError } from '@aztec/stdlib/errors';
43
- import { Gas, GasSettings } from '@aztec/stdlib/gas';
44
- 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';
45
56
  import type { AztecNode } from '@aztec/stdlib/interfaces/client';
46
- import type {
47
- TxExecutionRequest,
48
- TxProfileResult,
49
- TxSimulationResult,
50
- UtilitySimulationResult,
57
+ import {
58
+ BlockHeader,
59
+ ExecutionPayload,
60
+ type TxExecutionRequest,
61
+ type TxProfileResult,
62
+ type UtilityExecutionResult,
63
+ mergeExecutionPayloads,
51
64
  } from '@aztec/stdlib/tx';
52
- import { ExecutionPayload, mergeExecutionPayloads } from '@aztec/stdlib/tx';
53
65
 
54
66
  import { inspect } from 'util';
55
67
 
68
+ import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simulateViaNode } from './utils.js';
69
+
56
70
  /**
57
71
  * Options to configure fee payment for a transaction
58
72
  */
@@ -63,26 +77,71 @@ export type FeeOptions = {
63
77
  */
64
78
  walletFeePaymentMethod?: FeePaymentMethod;
65
79
  /** Configuration options for the account to properly handle the selected fee payment method */
66
- accountFeePaymentMethodOptions: AccountFeePaymentMethodOptions;
80
+ accountFeePaymentMethodOptions?: AccountFeePaymentMethodOptions;
67
81
  /** The gas settings to use for the transaction */
68
82
  gasSettings: GasSettings;
69
83
  };
70
84
 
85
+ /** Options for `simulateViaEntrypoint`. */
86
+ export type SimulateViaEntrypointOptions = Pick<
87
+ SimulateOptions,
88
+ 'from' | 'additionalScopes' | 'skipTxValidation' | 'skipFeeEnforcement' | 'sendMessagesAs'
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
+
71
111
  /**
72
112
  * A base class for Wallet implementations
73
113
  */
74
114
  export abstract class BaseWallet implements Wallet {
75
- protected log = createLogger('wallet-sdk:base_wallet');
76
-
77
115
  protected minFeePadding = 0.5;
78
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;
79
120
 
80
121
  // Protected because we want to force wallets to instantiate their own PXE.
81
122
  protected constructor(
82
123
  protected readonly pxe: PXE,
83
124
  protected readonly aztecNode: AztecNode,
125
+ protected log = createLogger('wallet-sdk:base_wallet'),
84
126
  ) {}
85
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
+
134
+ /**
135
+ * Picks the sender address PXE should tag private messages with. Returns `undefined` when there is no signing
136
+ * account (`from === NO_FROM`) and no explicit override; in that case any private log emitted by the tx will fail
137
+ * the contract-side `Sender for tags is not set` assertion unless `set_sender_for_tags` is called first.
138
+ * @param from - Tx sender, or `NO_FROM`.
139
+ * @param sendMessagesAs - Explicit override.
140
+ */
141
+ protected senderForTagsFrom(from: AztecAddress | NoFrom, sendMessagesAs?: AztecAddress): AztecAddress | undefined {
142
+ return sendMessagesAs ?? (from === NO_FROM ? undefined : from);
143
+ }
144
+
86
145
  protected abstract getAccountFromAddress(address: AztecAddress): Promise<Account>;
87
146
 
88
147
  abstract getAccounts(): Promise<Aliased<AztecAddress>[]>;
@@ -100,32 +159,42 @@ export abstract class BaseWallet implements Wallet {
100
159
  }
101
160
 
102
161
  async getChainInfo(): Promise<ChainInfo> {
103
- const { l1ChainId, rollupVersion } = await this.aztecNode.getNodeInfo();
162
+ if (!this.nodeInfoPromise) {
163
+ this.nodeInfoPromise = this.aztecNode.getNodeInfo();
164
+ }
165
+ const { l1ChainId, rollupVersion } = await this.nodeInfoPromise;
104
166
  return { chainId: new Fr(l1ChainId), version: new Fr(rollupVersion) };
105
167
  }
106
168
 
107
169
  protected async createTxExecutionRequestFromPayloadAndFee(
108
170
  executionPayload: ExecutionPayload,
109
- from: AztecAddress,
171
+ from: AztecAddress | NoFrom,
110
172
  feeOptions: FeeOptions,
111
173
  ): Promise<TxExecutionRequest> {
112
174
  const feeExecutionPayload = await feeOptions.walletFeePaymentMethod?.getExecutionPayload();
113
- const executionOptions: DefaultAccountEntrypointOptions = {
114
- txNonce: Fr.random(),
115
- cancellable: this.cancellableTransactions,
116
- feePaymentMethodOptions: feeOptions.accountFeePaymentMethodOptions,
117
- };
118
175
  const finalExecutionPayload = feeExecutionPayload
119
176
  ? mergeExecutionPayloads([feeExecutionPayload, executionPayload])
120
177
  : executionPayload;
121
- const fromAccount = await this.getAccountFromAddress(from);
122
178
  const chainInfo = await this.getChainInfo();
123
- return fromAccount.createTxExecutionRequest(
124
- finalExecutionPayload,
125
- feeOptions.gasSettings,
126
- chainInfo,
127
- executionOptions,
128
- );
179
+
180
+ if (from === NO_FROM) {
181
+ const entrypoint = new DefaultEntrypoint();
182
+ return entrypoint.createTxExecutionRequest(finalExecutionPayload, feeOptions.gasSettings, chainInfo);
183
+ } else {
184
+ const fromAccount = await this.getAccountFromAddress(from);
185
+ const executionOptions: DefaultAccountEntrypointOptions = {
186
+ txNonce: Fr.random(),
187
+ cancellable: this.cancellableTransactions,
188
+ // If from is an address, feeOptions include the way the account contract should handle the fee payment
189
+ feePaymentMethodOptions: feeOptions.accountFeePaymentMethodOptions!,
190
+ };
191
+ return fromAccount.createTxExecutionRequest(
192
+ finalExecutionPayload,
193
+ feeOptions.gasSettings,
194
+ chainInfo,
195
+ executionOptions,
196
+ );
197
+ }
129
198
  }
130
199
 
131
200
  public async createAuthWit(
@@ -137,6 +206,23 @@ export abstract class BaseWallet implements Wallet {
137
206
  return account.createAuthWit(messageHashOrIntent, chainInfo);
138
207
  }
139
208
 
209
+ /**
210
+ * Request capabilities from the wallet.
211
+ *
212
+ * This method is wallet-implementation-dependent and must be provided by classes extending BaseWallet.
213
+ * Embedded wallets typically don't support capability-based authorization (no user authorization flow),
214
+ * while external wallets (browser extensions, hardware wallets) implement this to reduce authorization
215
+ * friction by allowing apps to request permissions upfront.
216
+ *
217
+ * TODO: Consider making it abstract so implementing it is a conscious decision. Leaving it as-is
218
+ * while the feature stabilizes.
219
+ *
220
+ * @param _manifest - Application capability manifest declaring what operations the app needs
221
+ */
222
+ public requestCapabilities(_manifest: AppCapabilities): Promise<WalletCapabilities> {
223
+ throw new Error('Not implemented');
224
+ }
225
+
140
226
  public async batch<const T extends readonly BatchedMethod[]>(methods: T): Promise<BatchResults<T>> {
141
227
  const results: any[] = [];
142
228
  for (const method of methods) {
@@ -157,31 +243,39 @@ export abstract class BaseWallet implements Wallet {
157
243
 
158
244
  /**
159
245
  * Completes partial user-provided fee options with wallet defaults.
160
- * @param from - The address where the transaction is being sent from
161
- * @param feePayer - The address paying for fees (if any fee payment method is embedded in the execution payload)
162
- * @param gasSettings - User-provided partial gas settings
163
- * @returns - Complete fee options that can be used to create a transaction execution request
246
+ * @param config - Fee completion config.
164
247
  */
165
- protected async completeFeeOptions(
166
- from: AztecAddress,
167
- feePayer?: AztecAddress,
168
- gasSettings?: Partial<FieldsOf<GasSettings>>,
169
- ): Promise<FeeOptions> {
248
+ protected async completeFeeOptions(config: CompleteFeeOptionsConfig): Promise<FeeOptions> {
249
+ const { from, feePayer, gasSettings, forEstimation, congestionEstimate } = config;
170
250
  const maxFeesPerGas =
171
- gasSettings?.maxFeesPerGas ?? (await this.aztecNode.getCurrentMinFees()).mul(1 + this.minFeePadding);
251
+ gasSettings?.maxFeesPerGas ?? (await this.getMinFees(congestionEstimate)).mul(1 + this.minFeePadding);
172
252
  let accountFeePaymentMethodOptions;
173
- // The transaction does not include a fee payment method, so we set the flag
174
- // for the account to use its fee juice balance
175
- if (!feePayer) {
176
- accountFeePaymentMethodOptions = AccountFeePaymentMethodOptions.PREEXISTING_FEE_JUICE;
177
- } else {
178
- // The transaction includes fee payment method, so we check if we are the fee payer for it
179
- // (this can only happen if the embedded payment method is FeeJuiceWithClaim)
180
- accountFeePaymentMethodOptions = from.equals(feePayer)
181
- ? AccountFeePaymentMethodOptions.FEE_JUICE_WITH_CLAIM
182
- : AccountFeePaymentMethodOptions.EXTERNAL;
253
+ // If from is an address, we need to determine the appropriate fee payment method options for the
254
+ // account contract entrypoint to use
255
+ if (from !== NO_FROM) {
256
+ if (!feePayer) {
257
+ // The transaction does not include a fee payment method, so we set the flag
258
+ // for the account to use its fee juice balance
259
+ accountFeePaymentMethodOptions = AccountFeePaymentMethodOptions.PREEXISTING_FEE_JUICE;
260
+ } else {
261
+ // The transaction includes fee payment method, so we check if we are the fee payer for it
262
+ // (this can only happen if the embedded payment method is FeeJuiceWithClaim)
263
+ accountFeePaymentMethodOptions = from.equals(feePayer)
264
+ ? AccountFeePaymentMethodOptions.FEE_JUICE_WITH_CLAIM
265
+ : AccountFeePaymentMethodOptions.EXTERNAL;
266
+ }
183
267
  }
184
- const fullGasSettings: GasSettings = GasSettings.default({ ...gasSettings, maxFeesPerGas });
268
+ const gasSettingsOverrides = {
269
+ gasLimits: gasSettings?.gasLimits ? Gas.from(gasSettings.gasLimits) : undefined,
270
+ teardownGasLimits: gasSettings?.teardownGasLimits ? Gas.from(gasSettings.teardownGasLimits) : undefined,
271
+ maxFeesPerGas,
272
+ maxPriorityFeesPerGas: gasSettings?.maxPriorityFeesPerGas ?? GasFees.empty(),
273
+ };
274
+ // When estimating gas (simulation), use high limits so the simulation doesn't run out of gas.
275
+ // When sending for real, use protocol max limits that the network will actually accept.
276
+ const fullGasSettings = forEstimation
277
+ ? GasSettings.forEstimation(gasSettingsOverrides)
278
+ : GasSettings.fallback(gasSettingsOverrides);
185
279
  this.log.debug(`Using L2 gas settings`, fullGasSettings);
186
280
  return {
187
281
  gasSettings: fullGasSettings,
@@ -191,34 +285,25 @@ export abstract class BaseWallet implements Wallet {
191
285
  }
192
286
 
193
287
  /**
194
- * Completes partial user-provided fee options with unreasonably high gas limits
195
- * for gas estimation. Uses the same logic as completeFeeOptions but sets high limits
196
- * to avoid running out of gas during estimation.
197
- * @param from - The address where the transaction is being sent from
198
- * @param feePayer - The address paying for fees (if any fee payment method is embedded in the execution payload)
199
- * @param gasSettings - User-provided partial gas settings
288
+ * Returns the worst-case min fee across predicted future slots.
289
+ * Falls back to getCurrentMinFees if the node doesn't support getPredictedMinFees.
290
+ * @param estimate - The mana usage estimate to use for fee prediction. Defaults to Limit for conservative estimation.
200
291
  */
201
- protected async completeFeeOptionsForEstimation(
202
- from: AztecAddress,
203
- feePayer?: AztecAddress,
204
- gasSettings?: Partial<FieldsOf<GasSettings>>,
205
- ) {
206
- const defaultFeeOptions = await this.completeFeeOptions(from, feePayer, gasSettings);
207
- const {
208
- gasSettings: { maxFeesPerGas, maxPriorityFeesPerGas },
209
- } = defaultFeeOptions;
210
- // Use unrealistically high gas limits for estimation to avoid running out of gas.
211
- // They will be tuned down after the simulation.
212
- const gasSettingsForEstimation = new GasSettings(
213
- new Gas(GAS_ESTIMATION_DA_GAS_LIMIT, GAS_ESTIMATION_L2_GAS_LIMIT),
214
- new Gas(GAS_ESTIMATION_TEARDOWN_DA_GAS_LIMIT, GAS_ESTIMATION_TEARDOWN_L2_GAS_LIMIT),
215
- maxFeesPerGas,
216
- maxPriorityFeesPerGas,
217
- );
218
- return {
219
- ...defaultFeeOptions,
220
- gasSettings: gasSettingsForEstimation,
221
- };
292
+ protected async getMinFees(estimate: ManaUsageEstimate = ManaUsageEstimate.Limit): Promise<GasFees> {
293
+ try {
294
+ const predicted = await this.aztecNode.getPredictedMinFees(estimate);
295
+ if (predicted.length === 0) {
296
+ return this.aztecNode.getCurrentMinFees();
297
+ }
298
+ return predicted.reduce((worst, fees) => (fees.feePerL2Gas > worst.feePerL2Gas ? fees : worst));
299
+ } catch (err: any) {
300
+ // Fallback for old nodes that don't support getPredictedMinFees.
301
+ // Only fall back on method-not-found errors (JSON-RPC code -32601); rethrow others.
302
+ if (err?.cause?.code === -32601 || err?.message?.includes('Method not found')) {
303
+ return this.aztecNode.getCurrentMinFees();
304
+ }
305
+ throw err;
306
+ }
222
307
  }
223
308
 
224
309
  registerSender(address: AztecAddress, _alias: string = ''): Promise<AztecAddress> {
@@ -263,32 +348,138 @@ export abstract class BaseWallet implements Wallet {
263
348
  return instance;
264
349
  }
265
350
 
266
- async simulateTx(executionPayload: ExecutionPayload, opts: SimulateOptions): Promise<TxSimulationResult> {
267
- const feeOptions = opts.fee?.estimateGas
268
- ? await this.completeFeeOptionsForEstimation(opts.from, executionPayload.feePayer, opts.fee?.gasSettings)
269
- : await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
270
- const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
271
- return this.pxe.simulateTx(
272
- txRequest,
273
- true /* simulatePublic */,
274
- opts?.skipTxValidation,
275
- opts?.skipFeeEnforcement ?? true,
351
+ /**
352
+ * Simulates calls through the standard PXE path (account entrypoint).
353
+ * @param executionPayload - The execution payload to simulate.
354
+ * @param opts - Simulation options.
355
+ */
356
+ protected async simulateViaEntrypoint(executionPayload: ExecutionPayload, opts: SimulateViaEntrypointOptions) {
357
+ const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(
358
+ executionPayload,
359
+ opts.from,
360
+ opts.feeOptions,
276
361
  );
362
+ const result = await this.pxe.simulateTx(txRequest, {
363
+ simulatePublic: true,
364
+ skipTxValidation: opts.skipTxValidation,
365
+ skipFeeEnforcement: opts.skipFeeEnforcement,
366
+ scopes: this.scopesFrom(opts.from, opts.additionalScopes),
367
+ senderForTags: this.senderForTagsFrom(opts.from, opts.sendMessagesAs),
368
+ });
369
+ const appCallOffset = await this.computeAppCallOffset(opts.from, opts.feeOptions);
370
+ return TxSimulationResultWithAppOffset.fromResultAndOffset(result, appCallOffset);
371
+ }
372
+
373
+ /**
374
+ * Computes the index where the app's calls begin in the flattened array of calls (0 = entrypoint/root, 1..N = fee
375
+ * calls, N+1 = app).
376
+ * @param from - The sender address, or NO_FROM for the default entrypoint.
377
+ * @param feeOptions - Fee options containing the wallet fee payment method.
378
+ */
379
+ protected async computeAppCallOffset(from: AztecAddress | NoFrom, feeOptions: FeeOptions): Promise<number> {
380
+ if (from === NO_FROM) {
381
+ return 0;
382
+ }
383
+ const feeExecutionPayload = await feeOptions.walletFeePaymentMethod?.getExecutionPayload();
384
+ return (feeExecutionPayload?.calls.length ?? 0) + 1; // +1 for entrypoint
385
+ }
386
+
387
+ /**
388
+ * Simulates a transaction, optimizing leading public static calls by running them directly
389
+ * on the node while sending the remaining calls through the standard PXE path.
390
+ * Return values from both paths are merged back in original call order.
391
+ * @param executionPayload - The execution payload to simulate.
392
+ * @param opts - Simulation options (from address, fee settings, etc.).
393
+ * @returns The merged simulation result.
394
+ */
395
+ async simulateTx(
396
+ executionPayload: ExecutionPayload,
397
+ opts: SimulateOptions,
398
+ ): Promise<TxSimulationResultWithAppOffset> {
399
+ const feeOptions = await this.completeFeeOptions({
400
+ from: opts.from,
401
+ feePayer: executionPayload.feePayer,
402
+ gasSettings: opts.fee?.gasSettings,
403
+ forEstimation: true,
404
+ congestionEstimate: opts.fee?.congestionEstimate,
405
+ });
406
+ const { optimizableCalls, remainingCalls } = extractOptimizablePublicStaticCalls(executionPayload);
407
+ const remainingPayload = { ...executionPayload, calls: remainingCalls };
408
+
409
+ const chainInfo = await this.getChainInfo();
410
+ let blockHeader: BlockHeader;
411
+ // PXE might not be synced yet, so we pull the latest header from the node
412
+ // To keep things consistent, we'll always try with PXE first
413
+ try {
414
+ blockHeader = await this.pxe.getSyncedBlockHeader();
415
+ } catch {
416
+ blockHeader = (await this.aztecNode.getBlockHeader())!;
417
+ }
418
+
419
+ const simulationOrigin = opts.from === NO_FROM ? AztecAddress.ZERO : opts.from;
420
+ const [optimizedResults, normalResult] = await Promise.all([
421
+ optimizableCalls.length > 0
422
+ ? simulateViaNode(
423
+ this.aztecNode,
424
+ optimizableCalls,
425
+ simulationOrigin,
426
+ chainInfo,
427
+ feeOptions.gasSettings,
428
+ blockHeader,
429
+ opts.skipFeeEnforcement ?? true,
430
+ this.getContractName.bind(this),
431
+ )
432
+ : Promise.resolve([]),
433
+ remainingCalls.length > 0
434
+ ? this.simulateViaEntrypoint(remainingPayload, {
435
+ from: opts.from,
436
+ feeOptions,
437
+ additionalScopes: opts.additionalScopes,
438
+ skipTxValidation: opts.skipTxValidation,
439
+ skipFeeEnforcement: opts.skipFeeEnforcement ?? true,
440
+ sendMessagesAs: opts.sendMessagesAs,
441
+ })
442
+ : Promise.resolve(null),
443
+ ]);
444
+
445
+ return buildMergedSimulationResult(optimizedResults, normalResult);
277
446
  }
278
447
 
279
448
  async profileTx(executionPayload: ExecutionPayload, opts: ProfileOptions): Promise<TxProfileResult> {
280
- const feeOptions = await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
449
+ const feeOptions = await this.completeFeeOptions({
450
+ from: opts.from,
451
+ feePayer: executionPayload.feePayer,
452
+ gasSettings: opts.fee?.gasSettings,
453
+ congestionEstimate: opts.fee?.congestionEstimate,
454
+ });
281
455
  const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
282
- return this.pxe.profileTx(txRequest, opts.profileMode, opts.skipProofGeneration ?? true);
456
+ return this.pxe.profileTx(txRequest, {
457
+ profileMode: opts.profileMode,
458
+ skipProofGeneration: opts.skipProofGeneration ?? true,
459
+ scopes: this.scopesFrom(opts.from, opts.additionalScopes),
460
+ senderForTags: this.senderForTagsFrom(opts.from, opts.sendMessagesAs),
461
+ });
283
462
  }
284
463
 
285
464
  public async sendTx<W extends InteractionWaitOptions = undefined>(
286
465
  executionPayload: ExecutionPayload,
287
466
  opts: SendOptions<W>,
288
467
  ): Promise<SendReturn<W>> {
289
- const feeOptions = await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
468
+ const feeOptions = await this.completeFeeOptions({
469
+ from: opts.from,
470
+ feePayer: executionPayload.feePayer,
471
+ gasSettings: opts.fee?.gasSettings,
472
+ congestionEstimate: opts.fee?.congestionEstimate,
473
+ });
290
474
  const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
291
- const provenTx = await this.pxe.proveTx(txRequest);
475
+ const provenTx = await this.pxe.proveTx(txRequest, {
476
+ scopes: this.scopesFrom(opts.from, opts.additionalScopes),
477
+ senderForTags: this.senderForTagsFrom(opts.from, opts.sendMessagesAs),
478
+ });
479
+ const offchainOutput = extractOffchainOutput(
480
+ provenTx.getOffchainEffects(),
481
+ provenTx.publicInputs.constants.anchorBlockHeader.globalVariables.timestamp,
482
+ );
292
483
  const tx = await provenTx.toTx();
293
484
  const txHash = tx.getTxHash();
294
485
  if (await this.aztecNode.getTxEffect(txHash)) {
@@ -302,12 +493,32 @@ export abstract class BaseWallet implements Wallet {
302
493
 
303
494
  // If wait is NO_WAIT, return txHash immediately
304
495
  if (opts.wait === NO_WAIT) {
305
- return txHash as SendReturn<W>;
496
+ return { txHash, ...offchainOutput } as SendReturn<W>;
306
497
  }
307
498
 
308
499
  // Otherwise, wait for the full receipt (default behavior on wait: undefined)
309
500
  const waitOpts = typeof opts.wait === 'object' ? opts.wait : undefined;
310
- return (await waitForTx(this.aztecNode, txHash, waitOpts)) as SendReturn<W>;
501
+ const receipt = await waitForTx(this.aztecNode, txHash, waitOpts);
502
+
503
+ // Display debug logs from public execution if present (served in test mode only)
504
+ if (receipt.debugLogs?.length) {
505
+ await displayDebugLogs(receipt.debugLogs, this.getContractName.bind(this));
506
+ }
507
+
508
+ return { receipt, ...offchainOutput } as SendReturn<W>;
509
+ }
510
+
511
+ /**
512
+ * Resolves a contract address to a human-readable name via PXE, if available.
513
+ * @param address - The contract address to resolve.
514
+ */
515
+ protected async getContractName(address: AztecAddress): Promise<string | undefined> {
516
+ const instance = await this.pxe.getContractInstance(address);
517
+ if (!instance) {
518
+ return undefined;
519
+ }
520
+ const artifact = await this.pxe.getContractArtifact(instance.currentContractClassId);
521
+ return artifact?.name;
311
522
  }
312
523
 
313
524
  protected contextualizeError(err: Error, ...context: string[]): Error {
@@ -324,8 +535,8 @@ export abstract class BaseWallet implements Wallet {
324
535
  return err;
325
536
  }
326
537
 
327
- simulateUtility(call: FunctionCall, authwits?: AuthWitness[]): Promise<UtilitySimulationResult> {
328
- return this.pxe.simulateUtility(call, authwits);
538
+ executeUtility(call: FunctionCall, opts: ExecuteUtilityOptions): Promise<UtilityExecutionResult> {
539
+ return this.pxe.executeUtility(call, { authwits: opts.authWitnesses, scopes: opts.scopes });
329
540
  }
330
541
 
331
542
  async getPrivateEvents<T>(
@@ -348,26 +559,40 @@ export abstract class BaseWallet implements Wallet {
348
559
  return decodedEvents;
349
560
  }
350
561
 
562
+ /**
563
+ * Returns metadata about a contract, including whether it has been initialized, published, and updated.
564
+ * @param address - The contract address to query.
565
+ */
351
566
  async getContractMetadata(address: AztecAddress) {
352
567
  const instance = await this.pxe.getContractInstance(address);
353
- const initNullifier = await siloNullifier(address, address.toField());
354
- const publiclyRegisteredContract = await this.aztecNode.getContract(address);
355
- const [initNullifierMembershipWitness, publiclyRegisteredContractClass] = await Promise.all([
356
- this.aztecNode.getNullifierMembershipWitness('latest', initNullifier),
357
- publiclyRegisteredContract
358
- ? this.aztecNode.getContractClass(
359
- publiclyRegisteredContract.currentContractClassId || instance?.currentContractClassId,
360
- )
361
- : undefined,
362
- ]);
568
+ const publiclyRegisteredContractPromise = this.aztecNode.getContract(address);
569
+
570
+ let initializationStatus: ContractInitializationStatus;
571
+ if (instance) {
572
+ // We have the instance, so we can compute the private initialization nullifier (which includes init_hash and is
573
+ // emitted by both private and public initializers) and get a definitive INITIALIZED/UNINITIALIZED answer.
574
+ const initNullifier = await computeSiloedPrivateInitializationNullifier(address, instance.initializationHash);
575
+ const witness = await this.aztecNode.getNullifierMembershipWitness('latest', initNullifier);
576
+ initializationStatus = witness
577
+ ? ContractInitializationStatus.INITIALIZED
578
+ : ContractInitializationStatus.UNINITIALIZED;
579
+ } else {
580
+ // Without the instance we lack the init_hash needed for the private nullifier. We fall back to checking the
581
+ // public initialization nullifier (computed from address alone). Not all contracts emit it (only those with
582
+ // public functions that require initialization checks), so its absence doesn't mean the contract is
583
+ // uninitialized.
584
+ const publicNullifier = await computeSiloedPublicInitializationNullifier(address);
585
+ const witness = await this.aztecNode.getNullifierMembershipWitness('latest', publicNullifier);
586
+ initializationStatus = witness ? ContractInitializationStatus.INITIALIZED : ContractInitializationStatus.UNKNOWN;
587
+ }
588
+ const publiclyRegisteredContract = await publiclyRegisteredContractPromise;
363
589
  const isContractUpdated =
364
590
  publiclyRegisteredContract &&
365
591
  !publiclyRegisteredContract.currentContractClassId.equals(publiclyRegisteredContract.originalContractClassId);
366
592
  return {
367
593
  instance: instance ?? undefined,
368
- isContractInitialized: !!initNullifierMembershipWitness,
594
+ initializationStatus,
369
595
  isContractPublished: !!publiclyRegisteredContract,
370
- isContractClassPubliclyRegistered: !!publiclyRegisteredContractClass,
371
596
  isContractUpdated: !!isContractUpdated,
372
597
  updatedContractClassId: isContractUpdated ? publiclyRegisteredContract.currentContractClassId : undefined,
373
598
  };
@@ -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';