@aztec/wallet-sdk 0.0.1-commit.5de5ca79e → 0.0.1-commit.6201a7b05

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 (57) hide show
  1. package/dest/base-wallet/base_wallet.d.ts +50 -40
  2. package/dest/base-wallet/base_wallet.d.ts.map +1 -1
  3. package/dest/base-wallet/base_wallet.js +140 -73
  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 +3 -2
  7. package/dest/base-wallet/utils.d.ts.map +1 -1
  8. package/dest/base-wallet/utils.js +3 -1
  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 +2 -5
  13. package/dest/extension/provider/extension_wallet.d.ts.map +1 -1
  14. package/dest/extension/provider/index.d.ts +2 -2
  15. package/dest/extension/provider/index.d.ts.map +1 -1
  16. package/dest/iframe/handlers/iframe_connection_handler.d.ts +118 -0
  17. package/dest/iframe/handlers/iframe_connection_handler.d.ts.map +1 -0
  18. package/dest/iframe/handlers/iframe_connection_handler.js +228 -0
  19. package/dest/iframe/handlers/index.d.ts +2 -0
  20. package/dest/iframe/handlers/index.d.ts.map +1 -0
  21. package/dest/iframe/handlers/index.js +1 -0
  22. package/dest/iframe/provider/iframe_discovery.d.ts +25 -0
  23. package/dest/iframe/provider/iframe_discovery.d.ts.map +1 -0
  24. package/dest/iframe/provider/iframe_discovery.js +167 -0
  25. package/dest/iframe/provider/iframe_provider.d.ts +65 -0
  26. package/dest/iframe/provider/iframe_provider.d.ts.map +1 -0
  27. package/dest/iframe/provider/iframe_provider.js +257 -0
  28. package/dest/iframe/provider/iframe_wallet.d.ts +68 -0
  29. package/dest/iframe/provider/iframe_wallet.d.ts.map +1 -0
  30. package/dest/iframe/provider/iframe_wallet.js +200 -0
  31. package/dest/iframe/provider/index.d.ts +4 -0
  32. package/dest/iframe/provider/index.d.ts.map +1 -0
  33. package/dest/iframe/provider/index.js +3 -0
  34. package/dest/manager/types.d.ts +3 -2
  35. package/dest/manager/types.d.ts.map +1 -1
  36. package/dest/manager/wallet_manager.d.ts +1 -1
  37. package/dest/manager/wallet_manager.d.ts.map +1 -1
  38. package/dest/manager/wallet_manager.js +46 -16
  39. package/dest/types.d.ts +14 -2
  40. package/dest/types.d.ts.map +1 -1
  41. package/dest/types.js +4 -0
  42. package/package.json +12 -8
  43. package/src/base-wallet/base_wallet.ts +203 -119
  44. package/src/base-wallet/index.ts +6 -1
  45. package/src/base-wallet/utils.ts +6 -4
  46. package/src/crypto.ts +104 -0
  47. package/src/extension/provider/extension_wallet.ts +1 -6
  48. package/src/extension/provider/index.ts +1 -1
  49. package/src/iframe/handlers/iframe_connection_handler.ts +328 -0
  50. package/src/iframe/handlers/index.ts +7 -0
  51. package/src/iframe/provider/iframe_discovery.ts +185 -0
  52. package/src/iframe/provider/iframe_provider.ts +331 -0
  53. package/src/iframe/provider/iframe_wallet.ts +229 -0
  54. package/src/iframe/provider/index.ts +3 -0
  55. package/src/manager/types.ts +2 -1
  56. package/src/manager/wallet_manager.ts +48 -14
  57. package/src/types.ts +13 -0
@@ -1,4 +1,5 @@
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
4
  import {
4
5
  type InteractionWaitOptions,
@@ -8,32 +9,29 @@ import {
8
9
  } from '@aztec/aztec.js/contracts';
9
10
  import type { FeePaymentMethod } from '@aztec/aztec.js/fee';
10
11
  import { waitForTx } from '@aztec/aztec.js/node';
11
- import type {
12
- Aliased,
13
- AppCapabilities,
14
- BatchResults,
15
- BatchedMethod,
16
- ExecuteUtilityOptions,
17
- PrivateEvent,
18
- PrivateEventFilter,
19
- ProfileOptions,
20
- SendOptions,
21
- SimulateOptions,
22
- Wallet,
23
- WalletCapabilities,
24
- } from '@aztec/aztec.js/wallet';
25
12
  import {
26
- GAS_ESTIMATION_DA_GAS_LIMIT,
27
- GAS_ESTIMATION_L2_GAS_LIMIT,
28
- GAS_ESTIMATION_TEARDOWN_DA_GAS_LIMIT,
29
- GAS_ESTIMATION_TEARDOWN_L2_GAS_LIMIT,
30
- } 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';
31
28
  import { AccountFeePaymentMethodOptions, type DefaultAccountEntrypointOptions } from '@aztec/entrypoints/account';
29
+ import { DefaultEntrypoint } from '@aztec/entrypoints/default';
32
30
  import type { ChainInfo } from '@aztec/entrypoints/interfaces';
33
31
  import { Fr } from '@aztec/foundation/curves/bn254';
34
32
  import { createLogger } from '@aztec/foundation/log';
35
33
  import type { FieldsOf } from '@aztec/foundation/types';
36
- import { type AccessScopes, displayDebugLogs } from '@aztec/pxe/client/lazy';
34
+ import { displayDebugLogs } from '@aztec/pxe/client/lazy';
37
35
  import type { PXE, PackedPrivateEvent } from '@aztec/pxe/server';
38
36
  import {
39
37
  type ContractArtifact,
@@ -45,21 +43,25 @@ import type { AuthWitness } from '@aztec/stdlib/auth-witness';
45
43
  import { AztecAddress } from '@aztec/stdlib/aztec-address';
46
44
  import {
47
45
  type ContractInstanceWithAddress,
46
+ type NodeInfo,
48
47
  computePartialAddress,
49
48
  getContractClassFromArtifact,
50
49
  } from '@aztec/stdlib/contract';
51
50
  import { SimulationError } from '@aztec/stdlib/errors';
52
- import { Gas, GasSettings } from '@aztec/stdlib/gas';
53
- import { computeSiloedPrivateInitializationNullifier } 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';
54
56
  import type { AztecNode } from '@aztec/stdlib/interfaces/client';
55
57
  import {
56
58
  BlockHeader,
59
+ ExecutionPayload,
57
60
  type TxExecutionRequest,
58
61
  type TxProfileResult,
59
- TxSimulationResult,
60
62
  type UtilityExecutionResult,
63
+ mergeExecutionPayloads,
61
64
  } from '@aztec/stdlib/tx';
62
- import { ExecutionPayload, mergeExecutionPayloads } from '@aztec/stdlib/tx';
63
65
 
64
66
  import { inspect } from 'util';
65
67
 
@@ -75,7 +77,7 @@ export type FeeOptions = {
75
77
  */
76
78
  walletFeePaymentMethod?: FeePaymentMethod;
77
79
  /** Configuration options for the account to properly handle the selected fee payment method */
78
- accountFeePaymentMethodOptions: AccountFeePaymentMethodOptions;
80
+ accountFeePaymentMethodOptions?: AccountFeePaymentMethodOptions;
79
81
  /** The gas settings to use for the transaction */
80
82
  gasSettings: GasSettings;
81
83
  };
@@ -83,19 +85,38 @@ export type FeeOptions = {
83
85
  /** Options for `simulateViaEntrypoint`. */
84
86
  export type SimulateViaEntrypointOptions = Pick<
85
87
  SimulateOptions,
86
- 'from' | 'additionalScopes' | 'skipTxValidation' | 'skipFeeEnforcement'
88
+ 'from' | 'additionalScopes' | 'skipTxValidation' | 'skipFeeEnforcement' | 'sendMessagesAs'
87
89
  > & {
88
90
  /** Fee options for the entrypoint */
89
91
  feeOptions: FeeOptions;
90
- /** Scopes to use for the simulation */
91
- scopes: AccessScopes;
92
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
+
93
111
  /**
94
112
  * A base class for Wallet implementations
95
113
  */
96
114
  export abstract class BaseWallet implements Wallet {
97
115
  protected minFeePadding = 0.5;
98
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;
99
120
 
100
121
  // Protected because we want to force wallets to instantiate their own PXE.
101
122
  protected constructor(
@@ -104,12 +125,23 @@ export abstract class BaseWallet implements Wallet {
104
125
  protected log = createLogger('wallet-sdk:base_wallet'),
105
126
  ) {}
106
127
 
107
- protected scopesFrom(from: AztecAddress, additionalScopes: AztecAddress[] = []): AztecAddress[] {
108
- const allScopes = from.isZero() ? additionalScopes : [from, ...additionalScopes];
128
+ protected scopesFrom(from: AztecAddress | NoFrom, additionalScopes: AztecAddress[] = []): AztecAddress[] {
129
+ const allScopes = from === NO_FROM ? additionalScopes : [from, ...additionalScopes];
109
130
  const scopeSet = new Set(allScopes.map(address => address.toString()));
110
131
  return [...scopeSet].map(AztecAddress.fromString);
111
132
  }
112
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
+
113
145
  protected abstract getAccountFromAddress(address: AztecAddress): Promise<Account>;
114
146
 
115
147
  abstract getAccounts(): Promise<Aliased<AztecAddress>[]>;
@@ -127,32 +159,42 @@ export abstract class BaseWallet implements Wallet {
127
159
  }
128
160
 
129
161
  async getChainInfo(): Promise<ChainInfo> {
130
- 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;
131
166
  return { chainId: new Fr(l1ChainId), version: new Fr(rollupVersion) };
132
167
  }
133
168
 
134
169
  protected async createTxExecutionRequestFromPayloadAndFee(
135
170
  executionPayload: ExecutionPayload,
136
- from: AztecAddress,
171
+ from: AztecAddress | NoFrom,
137
172
  feeOptions: FeeOptions,
138
173
  ): Promise<TxExecutionRequest> {
139
174
  const feeExecutionPayload = await feeOptions.walletFeePaymentMethod?.getExecutionPayload();
140
- const executionOptions: DefaultAccountEntrypointOptions = {
141
- txNonce: Fr.random(),
142
- cancellable: this.cancellableTransactions,
143
- feePaymentMethodOptions: feeOptions.accountFeePaymentMethodOptions,
144
- };
145
175
  const finalExecutionPayload = feeExecutionPayload
146
176
  ? mergeExecutionPayloads([feeExecutionPayload, executionPayload])
147
177
  : executionPayload;
148
- const fromAccount = await this.getAccountFromAddress(from);
149
178
  const chainInfo = await this.getChainInfo();
150
- return fromAccount.createTxExecutionRequest(
151
- finalExecutionPayload,
152
- feeOptions.gasSettings,
153
- chainInfo,
154
- executionOptions,
155
- );
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
+ }
156
198
  }
157
199
 
158
200
  public async createAuthWit(
@@ -201,31 +243,39 @@ export abstract class BaseWallet implements Wallet {
201
243
 
202
244
  /**
203
245
  * Completes partial user-provided fee options with wallet defaults.
204
- * @param from - The address where the transaction is being sent from
205
- * @param feePayer - The address paying for fees (if any fee payment method is embedded in the execution payload)
206
- * @param gasSettings - User-provided partial gas settings
207
- * @returns - Complete fee options that can be used to create a transaction execution request
246
+ * @param config - Fee completion config.
208
247
  */
209
- protected async completeFeeOptions(
210
- from: AztecAddress,
211
- feePayer?: AztecAddress,
212
- gasSettings?: Partial<FieldsOf<GasSettings>>,
213
- ): Promise<FeeOptions> {
248
+ protected async completeFeeOptions(config: CompleteFeeOptionsConfig): Promise<FeeOptions> {
249
+ const { from, feePayer, gasSettings, forEstimation, congestionEstimate } = config;
214
250
  const maxFeesPerGas =
215
- gasSettings?.maxFeesPerGas ?? (await this.aztecNode.getCurrentMinFees()).mul(1 + this.minFeePadding);
251
+ gasSettings?.maxFeesPerGas ?? (await this.getMinFees(congestionEstimate)).mul(1 + this.minFeePadding);
216
252
  let accountFeePaymentMethodOptions;
217
- // The transaction does not include a fee payment method, so we set the flag
218
- // for the account to use its fee juice balance
219
- if (!feePayer) {
220
- accountFeePaymentMethodOptions = AccountFeePaymentMethodOptions.PREEXISTING_FEE_JUICE;
221
- } else {
222
- // The transaction includes fee payment method, so we check if we are the fee payer for it
223
- // (this can only happen if the embedded payment method is FeeJuiceWithClaim)
224
- accountFeePaymentMethodOptions = from.equals(feePayer)
225
- ? AccountFeePaymentMethodOptions.FEE_JUICE_WITH_CLAIM
226
- : 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
+ }
227
267
  }
228
- 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);
229
279
  this.log.debug(`Using L2 gas settings`, fullGasSettings);
230
280
  return {
231
281
  gasSettings: fullGasSettings,
@@ -235,34 +285,25 @@ export abstract class BaseWallet implements Wallet {
235
285
  }
236
286
 
237
287
  /**
238
- * Completes partial user-provided fee options with unreasonably high gas limits
239
- * for gas estimation. Uses the same logic as completeFeeOptions but sets high limits
240
- * to avoid running out of gas during estimation.
241
- * @param from - The address where the transaction is being sent from
242
- * @param feePayer - The address paying for fees (if any fee payment method is embedded in the execution payload)
243
- * @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.
244
291
  */
245
- protected async completeFeeOptionsForEstimation(
246
- from: AztecAddress,
247
- feePayer?: AztecAddress,
248
- gasSettings?: Partial<FieldsOf<GasSettings>>,
249
- ) {
250
- const defaultFeeOptions = await this.completeFeeOptions(from, feePayer, gasSettings);
251
- const {
252
- gasSettings: { maxFeesPerGas, maxPriorityFeesPerGas },
253
- } = defaultFeeOptions;
254
- // Use unrealistically high gas limits for estimation to avoid running out of gas.
255
- // They will be tuned down after the simulation.
256
- const gasSettingsForEstimation = new GasSettings(
257
- new Gas(GAS_ESTIMATION_DA_GAS_LIMIT, GAS_ESTIMATION_L2_GAS_LIMIT),
258
- new Gas(GAS_ESTIMATION_TEARDOWN_DA_GAS_LIMIT, GAS_ESTIMATION_TEARDOWN_L2_GAS_LIMIT),
259
- maxFeesPerGas,
260
- maxPriorityFeesPerGas,
261
- );
262
- return {
263
- ...defaultFeeOptions,
264
- gasSettings: gasSettingsForEstimation,
265
- };
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
+ }
266
307
  }
267
308
 
268
309
  registerSender(address: AztecAddress, _alias: string = ''): Promise<AztecAddress> {
@@ -318,12 +359,29 @@ export abstract class BaseWallet implements Wallet {
318
359
  opts.from,
319
360
  opts.feeOptions,
320
361
  );
321
- return this.pxe.simulateTx(txRequest, {
362
+ const result = await this.pxe.simulateTx(txRequest, {
322
363
  simulatePublic: true,
323
364
  skipTxValidation: opts.skipTxValidation,
324
365
  skipFeeEnforcement: opts.skipFeeEnforcement,
325
- scopes: opts.scopes,
366
+ scopes: this.scopesFrom(opts.from, opts.additionalScopes),
367
+ senderForTags: this.senderForTagsFrom(opts.from, opts.sendMessagesAs),
326
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
327
385
  }
328
386
 
329
387
  /**
@@ -334,10 +392,17 @@ export abstract class BaseWallet implements Wallet {
334
392
  * @param opts - Simulation options (from address, fee settings, etc.).
335
393
  * @returns The merged simulation result.
336
394
  */
337
- async simulateTx(executionPayload: ExecutionPayload, opts: SimulateOptions): Promise<TxSimulationResult> {
338
- const feeOptions = opts.fee?.estimateGas
339
- ? await this.completeFeeOptionsForEstimation(opts.from, executionPayload.feePayer, opts.fee?.gasSettings)
340
- : await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
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
+ });
341
406
  const { optimizableCalls, remainingCalls } = extractOptimizablePublicStaticCalls(executionPayload);
342
407
  const remainingPayload = { ...executionPayload, calls: remainingCalls };
343
408
 
@@ -348,15 +413,16 @@ export abstract class BaseWallet implements Wallet {
348
413
  try {
349
414
  blockHeader = await this.pxe.getSyncedBlockHeader();
350
415
  } catch {
351
- blockHeader = (await this.aztecNode.getBlockHeader())!;
416
+ blockHeader = (await this.aztecNode.getBlockHeader('latest'))!;
352
417
  }
353
418
 
419
+ const simulationOrigin = opts.from === NO_FROM ? AztecAddress.ZERO : opts.from;
354
420
  const [optimizedResults, normalResult] = await Promise.all([
355
421
  optimizableCalls.length > 0
356
422
  ? simulateViaNode(
357
423
  this.aztecNode,
358
424
  optimizableCalls,
359
- opts.from,
425
+ simulationOrigin,
360
426
  chainInfo,
361
427
  feeOptions.gasSettings,
362
428
  blockHeader,
@@ -368,9 +434,10 @@ export abstract class BaseWallet implements Wallet {
368
434
  ? this.simulateViaEntrypoint(remainingPayload, {
369
435
  from: opts.from,
370
436
  feeOptions,
371
- scopes: this.scopesFrom(opts.from, opts.additionalScopes),
437
+ additionalScopes: opts.additionalScopes,
372
438
  skipTxValidation: opts.skipTxValidation,
373
439
  skipFeeEnforcement: opts.skipFeeEnforcement ?? true,
440
+ sendMessagesAs: opts.sendMessagesAs,
374
441
  })
375
442
  : Promise.resolve(null),
376
443
  ]);
@@ -379,12 +446,18 @@ export abstract class BaseWallet implements Wallet {
379
446
  }
380
447
 
381
448
  async profileTx(executionPayload: ExecutionPayload, opts: ProfileOptions): Promise<TxProfileResult> {
382
- 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
+ });
383
455
  const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
384
456
  return this.pxe.profileTx(txRequest, {
385
457
  profileMode: opts.profileMode,
386
458
  skipProofGeneration: opts.skipProofGeneration ?? true,
387
459
  scopes: this.scopesFrom(opts.from, opts.additionalScopes),
460
+ senderForTags: this.senderForTagsFrom(opts.from, opts.sendMessagesAs),
388
461
  });
389
462
  }
390
463
 
@@ -392,9 +465,17 @@ export abstract class BaseWallet implements Wallet {
392
465
  executionPayload: ExecutionPayload,
393
466
  opts: SendOptions<W>,
394
467
  ): Promise<SendReturn<W>> {
395
- 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
+ });
396
474
  const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
397
- const provenTx = await this.pxe.proveTx(txRequest, this.scopesFrom(opts.from, opts.additionalScopes));
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
+ });
398
479
  const offchainOutput = extractOffchainOutput(
399
480
  provenTx.getOffchainEffects(),
400
481
  provenTx.publicInputs.constants.anchorBlockHeader.globalVariables.timestamp,
@@ -455,7 +536,7 @@ export abstract class BaseWallet implements Wallet {
455
536
  }
456
537
 
457
538
  executeUtility(call: FunctionCall, opts: ExecuteUtilityOptions): Promise<UtilityExecutionResult> {
458
- return this.pxe.executeUtility(call, { authwits: opts.authWitnesses, scopes: [opts.scope] });
539
+ return this.pxe.executeUtility(call, { authwits: opts.authWitnesses, scopes: opts.scopes });
459
540
  }
460
541
 
461
542
  async getPrivateEvents<T>(
@@ -480,26 +561,29 @@ export abstract class BaseWallet implements Wallet {
480
561
 
481
562
  /**
482
563
  * Returns metadata about a contract, including whether it has been initialized, published, and updated.
483
- *
484
- * `isContractInitialized` requires the contract instance to be registered in the PXE (for `init_hash`). When the
485
- * instance is not available, `isContractInitialized` is `undefined` since it cannot be determined.
486
564
  * @param address - The contract address to query.
487
565
  */
488
566
  async getContractMetadata(address: AztecAddress) {
489
567
  const instance = await this.pxe.getContractInstance(address);
490
568
  const publiclyRegisteredContractPromise = this.aztecNode.getContract(address);
491
- // We check only the private initialization nullifier. It is emitted by both private and public initializers and
492
- // includes init_hash, preventing observers from determining initialization status from the address alone. Without
493
- // the instance (and thus init_hash), we can't compute it, so we return undefined.
494
- //
495
- // We skip the public initialization nullifier because it's not always emitted (contracts without public external
496
- // functions that require initialization checks won't emit it). If the private one exists, the public one was
497
- // created in the same tx and will also be present.
498
- let isContractInitialized: boolean | undefined = undefined;
569
+
570
+ let initializationStatus: ContractInitializationStatus;
499
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.
500
574
  const initNullifier = await computeSiloedPrivateInitializationNullifier(address, instance.initializationHash);
501
575
  const witness = await this.aztecNode.getNullifierMembershipWitness('latest', initNullifier);
502
- isContractInitialized = !!witness;
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;
503
587
  }
504
588
  const publiclyRegisteredContract = await publiclyRegisteredContractPromise;
505
589
  const isContractUpdated =
@@ -507,7 +591,7 @@ export abstract class BaseWallet implements Wallet {
507
591
  !publiclyRegisteredContract.currentContractClassId.equals(publiclyRegisteredContract.originalContractClassId);
508
592
  return {
509
593
  instance: instance ?? undefined,
510
- isContractInitialized,
594
+ initializationStatus,
511
595
  isContractPublished: !!publiclyRegisteredContract,
512
596
  isContractUpdated: !!isContractUpdated,
513
597
  updatedContractClassId: isContractUpdated ? publiclyRegisteredContract.currentContractClassId : undefined,
@@ -1,2 +1,7 @@
1
- export { BaseWallet, type FeeOptions, type SimulateViaEntrypointOptions } 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,4 +1,5 @@
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';
@@ -214,13 +215,13 @@ export async function simulateViaNode(
214
215
  */
215
216
  export function buildMergedSimulationResult(
216
217
  optimizedResults: TxSimulationResult[],
217
- normalResult: TxSimulationResult | null,
218
- ): TxSimulationResult {
218
+ normalResult: TxSimulationResultWithAppOffset | null,
219
+ ): TxSimulationResultWithAppOffset {
219
220
  const optimizedReturnValues = optimizedResults.flatMap(r => r.publicOutput?.publicReturnValues ?? []);
220
221
  const normalReturnValues = normalResult?.publicOutput?.publicReturnValues ?? [];
221
222
  const allReturnValues = [...optimizedReturnValues, ...normalReturnValues];
222
223
 
223
- const baseResult = normalResult ?? optimizedResults[0];
224
+ const baseResult: TxSimulationResult = normalResult ?? optimizedResults[0];
224
225
 
225
226
  const mergedPublicOutput: PublicSimulationOutput | undefined = baseResult.publicOutput
226
227
  ? {
@@ -229,10 +230,11 @@ export function buildMergedSimulationResult(
229
230
  }
230
231
  : undefined;
231
232
 
232
- return new TxSimulationResult(
233
+ const merged = new TxSimulationResult(
233
234
  baseResult.privateExecutionResult,
234
235
  baseResult.publicInputs,
235
236
  mergedPublicOutput,
236
237
  normalResult?.stats,
237
238
  );
239
+ return TxSimulationResultWithAppOffset.fromResultAndOffset(merged, normalResult?.appCallOffset ?? 0);
238
240
  }
package/src/crypto.ts CHANGED
@@ -497,3 +497,107 @@ export function hashToEmoji(hash: string, count: number = DEFAULT_EMOJI_GRID_SIZ
497
497
  }
498
498
  return emojis.join('');
499
499
  }
500
+
501
+ // ─── Passphrase-based encryption (PBKDF2 + AES-256-GCM) ───────────────────
502
+
503
+ /** Default PBKDF2 iteration count. High to compensate for short PINs (~1-2s on modern hardware). */
504
+ const DEFAULT_PBKDF2_ITERATIONS = 2_000_000;
505
+ const PBKDF2_SALT_BYTES = 16;
506
+ const PBKDF2_IV_BYTES = 12;
507
+
508
+ /**
509
+ * Derives an AES-256-GCM key from a passphrase using PBKDF2-SHA256.
510
+ *
511
+ * @param passphrase - The user-provided passphrase or PIN
512
+ * @param salt - Random salt bytes
513
+ * @param iterations - PBKDF2 iteration count (default: 2,000,000)
514
+ * @returns An AES-256-GCM CryptoKey
515
+ */
516
+ export async function deriveKeyFromPassphrase(
517
+ passphrase: string,
518
+ salt: Uint8Array,
519
+ iterations: number = DEFAULT_PBKDF2_ITERATIONS,
520
+ ): Promise<CryptoKey> {
521
+ const keyMaterial = await crypto.subtle.importKey('raw', new TextEncoder().encode(passphrase), 'PBKDF2', false, [
522
+ 'deriveKey',
523
+ ]);
524
+ return crypto.subtle.deriveKey(
525
+ { name: 'PBKDF2', salt: salt as BufferSource, iterations, hash: 'SHA-256' },
526
+ keyMaterial,
527
+ { name: 'AES-GCM', length: 256 },
528
+ false,
529
+ ['encrypt', 'decrypt'],
530
+ );
531
+ }
532
+
533
+ /**
534
+ * Encrypts arbitrary bytes with a passphrase using PBKDF2 + AES-256-GCM.
535
+ *
536
+ * Output layout: `[salt (16)] [iv (12)] [ciphertext (...)]`
537
+ *
538
+ * @param plaintext - Data to encrypt
539
+ * @param passphrase - User passphrase or PIN
540
+ * @param iterations - PBKDF2 iteration count (default: 2,000,000)
541
+ * @returns A Uint8Array containing salt + iv + ciphertext
542
+ */
543
+ export async function encryptWithPassphrase(
544
+ plaintext: Uint8Array,
545
+ passphrase: string,
546
+ iterations: number = DEFAULT_PBKDF2_ITERATIONS,
547
+ ): Promise<Uint8Array> {
548
+ const salt = crypto.getRandomValues(new Uint8Array(PBKDF2_SALT_BYTES));
549
+ const iv = crypto.getRandomValues(new Uint8Array(PBKDF2_IV_BYTES));
550
+ const key = await deriveKeyFromPassphrase(passphrase, salt, iterations);
551
+ const ciphertext = new Uint8Array(
552
+ await crypto.subtle.encrypt({ name: 'AES-GCM', iv }, key, plaintext as BufferSource),
553
+ );
554
+ const result = new Uint8Array(PBKDF2_SALT_BYTES + PBKDF2_IV_BYTES + ciphertext.length);
555
+ result.set(salt, 0);
556
+ result.set(iv, PBKDF2_SALT_BYTES);
557
+ result.set(ciphertext, PBKDF2_SALT_BYTES + PBKDF2_IV_BYTES);
558
+ return result;
559
+ }
560
+
561
+ /**
562
+ * Decrypts data produced by {@link encryptWithPassphrase}.
563
+ *
564
+ * @param data - The encrypted blob (salt + iv + ciphertext)
565
+ * @param passphrase - The passphrase used during encryption
566
+ * @param iterations - PBKDF2 iteration count (must match encryption)
567
+ * @returns The decrypted plaintext bytes
568
+ * @throws On wrong passphrase (AES-GCM auth tag mismatch)
569
+ */
570
+ export async function decryptWithPassphrase(
571
+ data: Uint8Array,
572
+ passphrase: string,
573
+ iterations: number = DEFAULT_PBKDF2_ITERATIONS,
574
+ ): Promise<Uint8Array> {
575
+ const salt = data.slice(0, PBKDF2_SALT_BYTES);
576
+ const iv = data.slice(PBKDF2_SALT_BYTES, PBKDF2_SALT_BYTES + PBKDF2_IV_BYTES);
577
+ const ciphertext = data.slice(PBKDF2_SALT_BYTES + PBKDF2_IV_BYTES);
578
+ const key = await deriveKeyFromPassphrase(passphrase, salt, iterations);
579
+ return new Uint8Array(await crypto.subtle.decrypt({ name: 'AES-GCM', iv }, key, ciphertext as BufferSource));
580
+ }
581
+
582
+ /**
583
+ * Converts a Uint8Array to a base64 string.
584
+ */
585
+ export function uint8ToBase64(bytes: Uint8Array): string {
586
+ let binary = '';
587
+ for (const b of bytes) {
588
+ binary += String.fromCharCode(b);
589
+ }
590
+ return btoa(binary);
591
+ }
592
+
593
+ /**
594
+ * Converts a base64 string to a Uint8Array.
595
+ */
596
+ export function base64ToUint8(b64: string): Uint8Array {
597
+ const binary = atob(b64);
598
+ const bytes = new Uint8Array(binary.length);
599
+ for (let i = 0; i < binary.length; i++) {
600
+ bytes[i] = binary.charCodeAt(i);
601
+ }
602
+ return bytes;
603
+ }