@aztec/wallet-sdk 0.0.1-commit.a072138 → 0.0.1-commit.a5db02d

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 (76) hide show
  1. package/README.md +125 -0
  2. package/dest/base-wallet/base_wallet.d.ts +99 -37
  3. package/dest/base-wallet/base_wallet.d.ts.map +1 -1
  4. package/dest/base-wallet/base_wallet.js +324 -100
  5. package/dest/base-wallet/get_gas_limits.d.ts +36 -0
  6. package/dest/base-wallet/get_gas_limits.d.ts.map +1 -0
  7. package/dest/base-wallet/get_gas_limits.js +55 -0
  8. package/dest/base-wallet/index.d.ts +4 -2
  9. package/dest/base-wallet/index.d.ts.map +1 -1
  10. package/dest/base-wallet/index.js +2 -0
  11. package/dest/base-wallet/utils.d.ts +52 -0
  12. package/dest/base-wallet/utils.d.ts.map +1 -0
  13. package/dest/base-wallet/utils.js +137 -0
  14. package/dest/crypto.d.ts +39 -1
  15. package/dest/crypto.d.ts.map +1 -1
  16. package/dest/crypto.js +88 -0
  17. package/dest/extension/handlers/background_connection_handler.d.ts +12 -2
  18. package/dest/extension/handlers/background_connection_handler.d.ts.map +1 -1
  19. package/dest/extension/handlers/background_connection_handler.js +44 -8
  20. package/dest/extension/handlers/content_script_connection_handler.d.ts +2 -1
  21. package/dest/extension/handlers/content_script_connection_handler.d.ts.map +1 -1
  22. package/dest/extension/handlers/content_script_connection_handler.js +19 -0
  23. package/dest/extension/handlers/internal_message_types.d.ts +3 -1
  24. package/dest/extension/handlers/internal_message_types.d.ts.map +1 -1
  25. package/dest/extension/handlers/internal_message_types.js +3 -1
  26. package/dest/extension/provider/extension_wallet.d.ts +27 -6
  27. package/dest/extension/provider/extension_wallet.d.ts.map +1 -1
  28. package/dest/extension/provider/extension_wallet.js +89 -11
  29. package/dest/extension/provider/index.d.ts +2 -2
  30. package/dest/extension/provider/index.d.ts.map +1 -1
  31. package/dest/iframe/handlers/iframe_connection_handler.d.ts +122 -0
  32. package/dest/iframe/handlers/iframe_connection_handler.d.ts.map +1 -0
  33. package/dest/iframe/handlers/iframe_connection_handler.js +239 -0
  34. package/dest/iframe/handlers/index.d.ts +2 -0
  35. package/dest/iframe/handlers/index.d.ts.map +1 -0
  36. package/dest/iframe/handlers/index.js +1 -0
  37. package/dest/iframe/provider/iframe_discovery.d.ts +25 -0
  38. package/dest/iframe/provider/iframe_discovery.d.ts.map +1 -0
  39. package/dest/iframe/provider/iframe_discovery.js +167 -0
  40. package/dest/iframe/provider/iframe_provider.d.ts +65 -0
  41. package/dest/iframe/provider/iframe_provider.d.ts.map +1 -0
  42. package/dest/iframe/provider/iframe_provider.js +257 -0
  43. package/dest/iframe/provider/iframe_wallet.d.ts +85 -0
  44. package/dest/iframe/provider/iframe_wallet.d.ts.map +1 -0
  45. package/dest/iframe/provider/iframe_wallet.js +269 -0
  46. package/dest/iframe/provider/index.d.ts +4 -0
  47. package/dest/iframe/provider/index.d.ts.map +1 -0
  48. package/dest/iframe/provider/index.js +3 -0
  49. package/dest/manager/types.d.ts +6 -5
  50. package/dest/manager/types.d.ts.map +1 -1
  51. package/dest/manager/wallet_manager.d.ts +1 -1
  52. package/dest/manager/wallet_manager.d.ts.map +1 -1
  53. package/dest/manager/wallet_manager.js +48 -18
  54. package/dest/types.d.ts +64 -2
  55. package/dest/types.d.ts.map +1 -1
  56. package/dest/types.js +29 -0
  57. package/package.json +19 -9
  58. package/src/base-wallet/base_wallet.ts +421 -157
  59. package/src/base-wallet/get_gas_limits.ts +88 -0
  60. package/src/base-wallet/index.ts +8 -1
  61. package/src/base-wallet/utils.ts +248 -0
  62. package/src/crypto.ts +104 -0
  63. package/src/extension/handlers/background_connection_handler.ts +42 -9
  64. package/src/extension/handlers/content_script_connection_handler.ts +18 -0
  65. package/src/extension/handlers/internal_message_types.ts +2 -0
  66. package/src/extension/provider/extension_wallet.ts +106 -17
  67. package/src/extension/provider/index.ts +1 -1
  68. package/src/iframe/handlers/iframe_connection_handler.ts +341 -0
  69. package/src/iframe/handlers/index.ts +7 -0
  70. package/src/iframe/provider/iframe_discovery.ts +185 -0
  71. package/src/iframe/provider/iframe_provider.ts +331 -0
  72. package/src/iframe/provider/iframe_wallet.ts +323 -0
  73. package/src/iframe/provider/index.ts +3 -0
  74. package/src/manager/types.ts +5 -4
  75. package/src/manager/wallet_manager.ts +55 -23
  76. package/src/types.ts +72 -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,30 @@ 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';
39
- import {
40
- type ContractInstanceWithAddress,
41
- computePartialAddress,
42
- getContractClassFromArtifact,
43
- } from '@aztec/stdlib/contract';
43
+ import { AztecAddress } from '@aztec/stdlib/aztec-address';
44
+ import { type ContractInstancePreimage, type NodeInfo, computePartialAddress } from '@aztec/stdlib/contract';
44
45
  import { SimulationError } from '@aztec/stdlib/errors';
45
- import { Gas, GasSettings } from '@aztec/stdlib/gas';
46
- import { siloNullifier } from '@aztec/stdlib/hash';
46
+ import { Gas, GasFees, GasSettings, ManaUsageEstimate } from '@aztec/stdlib/gas';
47
+ import {
48
+ computeSiloedPrivateInitializationNullifier,
49
+ computeSiloedPublicInitializationNullifier,
50
+ } from '@aztec/stdlib/hash';
47
51
  import type { AztecNode } from '@aztec/stdlib/interfaces/client';
48
- import type {
49
- TxExecutionRequest,
50
- TxProfileResult,
51
- TxSimulationResult,
52
- UtilitySimulationResult,
52
+ import { type MasterSecretKeys, deriveKeys, deriveKeysFromMasterSecretKeys } from '@aztec/stdlib/keys';
53
+ import {
54
+ BlockHeader,
55
+ ExecutionPayload,
56
+ type TxExecutionRequest,
57
+ type TxProfileResult,
58
+ type UtilityExecutionResult,
59
+ mergeExecutionPayloads,
53
60
  } from '@aztec/stdlib/tx';
54
- import { ExecutionPayload, mergeExecutionPayloads } from '@aztec/stdlib/tx';
55
61
 
56
62
  import { inspect } from 'util';
57
63
 
64
+ import { assertGasLimitsWithinNetworkLimits } from './get_gas_limits.js';
65
+ import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simulateViaNode } from './utils.js';
66
+
58
67
  /**
59
68
  * Options to configure fee payment for a transaction
60
69
  */
@@ -65,26 +74,74 @@ export type FeeOptions = {
65
74
  */
66
75
  walletFeePaymentMethod?: FeePaymentMethod;
67
76
  /** Configuration options for the account to properly handle the selected fee payment method */
68
- accountFeePaymentMethodOptions: AccountFeePaymentMethodOptions;
77
+ accountFeePaymentMethodOptions?: AccountFeePaymentMethodOptions;
69
78
  /** The gas settings to use for the transaction */
70
79
  gasSettings: GasSettings;
71
80
  };
72
81
 
82
+ /** Options for `simulateViaEntrypoint`. */
83
+ export type SimulateViaEntrypointOptions = Pick<
84
+ SimulateOptions,
85
+ 'from' | 'additionalScopes' | 'skipTxValidation' | 'skipFeeEnforcement' | 'sendMessagesAs' | 'overrides'
86
+ > & {
87
+ /** Fee options for the entrypoint */
88
+ feeOptions: FeeOptions;
89
+ };
90
+
91
+ /** Options for `completeFeeOptions`. */
92
+ export type CompleteFeeOptionsConfig = {
93
+ /** The address where the transaction is being sent from. */
94
+ from: AztecAddress | NoFrom;
95
+ /** The address paying for fees (if any fee payment method is embedded in the execution payload). */
96
+ feePayer?: AztecAddress;
97
+ /** User-provided partial gas settings. */
98
+ gasSettings?: Partial<FieldsOf<GasSettings>>;
99
+ /** If true, returns gas settings with high gas limits for estimation. If false, uses fallback limits. */
100
+ forEstimation?: boolean;
101
+ /**
102
+ * Assumed network congestion level for fee prediction. Controls how aggressively the wallet
103
+ * estimates future fees. Defaults to Limit (worst case) when not specified.
104
+ */
105
+ congestionEstimate?: ManaUsageEstimate;
106
+ };
107
+
73
108
  /**
74
109
  * A base class for Wallet implementations
75
110
  */
76
111
  export abstract class BaseWallet implements Wallet {
77
- protected log = createLogger('wallet-sdk:base_wallet');
78
-
79
112
  protected minFeePadding = 0.5;
80
113
  protected cancellableTransactions = false;
114
+ // Poll interval (in seconds) injected into sendTx waits when the caller does not specify one. Left undefined on
115
+ // production wallets so the DefaultWaitOpts 1s cadence stands; test wallets talking to in-process nodes lower it.
116
+ protected defaultWaitInterval?: number;
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;
81
120
 
82
121
  // Protected because we want to force wallets to instantiate their own PXE.
83
122
  protected constructor(
84
123
  protected readonly pxe: PXE,
85
124
  protected readonly aztecNode: AztecNode,
125
+ protected log = createLogger('wallet-sdk:base_wallet'),
86
126
  ) {}
87
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.fromStringUnsafe);
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 using
137
+ * the wallet-supplied default sender will fail the "Sender for tags is not set" assertion.
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
+
88
145
  protected abstract getAccountFromAddress(address: AztecAddress): Promise<Account>;
89
146
 
90
147
  abstract getAccounts(): Promise<Aliased<AztecAddress>[]>;
@@ -97,37 +154,71 @@ export abstract class BaseWallet implements Wallet {
97
154
  * @returns The aliased collection of AztecAddresses that form this wallet's address book
98
155
  */
99
156
  async getAddressBook(): Promise<Aliased<AztecAddress>[]> {
100
- const senders: AztecAddress[] = await this.pxe.getSenders();
101
- return senders.map(sender => ({ item: sender, alias: '' }));
157
+ const sources = await this.pxe.getTaggingSecretSources({ kind: 'address-derived' });
158
+ return sources.map(source => ({ item: source.sender, alias: '' }));
159
+ }
160
+
161
+ /**
162
+ * Fetches and caches the node info for the wallet's lifetime, since a wallet talks to a single network and
163
+ * node info never changes. A rejected fetch clears the cache so the next call retries instead of replaying
164
+ * the cached rejection forever — important because the gas-limit fill-in and validation (run on every send)
165
+ * depend on it.
166
+ */
167
+ private getNodeInfo(): Promise<NodeInfo> {
168
+ if (!this.nodeInfoPromise) {
169
+ this.nodeInfoPromise = this.aztecNode.getNodeInfo().catch(err => {
170
+ this.nodeInfoPromise = undefined;
171
+ throw err;
172
+ });
173
+ }
174
+ return this.nodeInfoPromise;
102
175
  }
103
176
 
104
177
  async getChainInfo(): Promise<ChainInfo> {
105
- const { l1ChainId, rollupVersion } = await this.aztecNode.getNodeInfo();
178
+ const { l1ChainId, rollupVersion } = await this.getNodeInfo();
106
179
  return { chainId: new Fr(l1ChainId), version: new Fr(rollupVersion) };
107
180
  }
108
181
 
182
+ /**
183
+ * Returns the maximum gas limits a single transaction may declare on this wallet's network (the
184
+ * node-advertised `txsLimits.gas`). Internal helper used to fill in default gas limits when sending a
185
+ * transaction without explicit limits, and to validate caller-provided limits before sending. Backed by
186
+ * the cached node info, since a wallet talks to a single network.
187
+ */
188
+ protected async getMaxTxGasLimits(): Promise<Gas> {
189
+ const { txsLimits } = await this.getNodeInfo();
190
+ return new Gas(txsLimits.gas.daGas, txsLimits.gas.l2Gas);
191
+ }
192
+
109
193
  protected async createTxExecutionRequestFromPayloadAndFee(
110
194
  executionPayload: ExecutionPayload,
111
- from: AztecAddress,
195
+ from: AztecAddress | NoFrom,
112
196
  feeOptions: FeeOptions,
113
197
  ): Promise<TxExecutionRequest> {
114
198
  const feeExecutionPayload = await feeOptions.walletFeePaymentMethod?.getExecutionPayload();
115
- const executionOptions: DefaultAccountEntrypointOptions = {
116
- txNonce: Fr.random(),
117
- cancellable: this.cancellableTransactions,
118
- feePaymentMethodOptions: feeOptions.accountFeePaymentMethodOptions,
119
- };
120
199
  const finalExecutionPayload = feeExecutionPayload
121
200
  ? mergeExecutionPayloads([feeExecutionPayload, executionPayload])
122
201
  : executionPayload;
123
- const fromAccount = await this.getAccountFromAddress(from);
124
202
  const chainInfo = await this.getChainInfo();
125
- return fromAccount.createTxExecutionRequest(
126
- finalExecutionPayload,
127
- feeOptions.gasSettings,
128
- chainInfo,
129
- executionOptions,
130
- );
203
+
204
+ if (from === NO_FROM) {
205
+ const entrypoint = new DefaultEntrypoint();
206
+ return entrypoint.createTxExecutionRequest(finalExecutionPayload, feeOptions.gasSettings, chainInfo);
207
+ } else {
208
+ const fromAccount = await this.getAccountFromAddress(from);
209
+ const executionOptions: DefaultAccountEntrypointOptions = {
210
+ txNonce: Fr.random(),
211
+ cancellable: this.cancellableTransactions,
212
+ // If from is an address, feeOptions include the way the account contract should handle the fee payment
213
+ feePaymentMethodOptions: feeOptions.accountFeePaymentMethodOptions!,
214
+ };
215
+ return fromAccount.createTxExecutionRequest(
216
+ finalExecutionPayload,
217
+ feeOptions.gasSettings,
218
+ chainInfo,
219
+ executionOptions,
220
+ );
221
+ }
131
222
  }
132
223
 
133
224
  public async createAuthWit(
@@ -176,31 +267,54 @@ export abstract class BaseWallet implements Wallet {
176
267
 
177
268
  /**
178
269
  * 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
270
+ * @param config - Fee completion config.
183
271
  */
184
- protected async completeFeeOptions(
185
- from: AztecAddress,
186
- feePayer?: AztecAddress,
187
- gasSettings?: Partial<FieldsOf<GasSettings>>,
188
- ): Promise<FeeOptions> {
272
+ protected async completeFeeOptions(config: CompleteFeeOptionsConfig): Promise<FeeOptions> {
273
+ const { from, feePayer, gasSettings, forEstimation, congestionEstimate } = config;
189
274
  const maxFeesPerGas =
190
- gasSettings?.maxFeesPerGas ?? (await this.aztecNode.getCurrentMinFees()).mul(1 + this.minFeePadding);
275
+ gasSettings?.maxFeesPerGas ?? (await this.getMinFees(congestionEstimate)).mul(1 + this.minFeePadding);
191
276
  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;
277
+ // If from is an address, we need to determine the appropriate fee payment method options for the
278
+ // account contract entrypoint to use
279
+ if (from !== NO_FROM) {
280
+ if (!feePayer) {
281
+ // The transaction does not include a fee payment method, so we set the flag
282
+ // for the account to use its fee juice balance
283
+ accountFeePaymentMethodOptions = AccountFeePaymentMethodOptions.PREEXISTING_FEE_JUICE;
284
+ } else {
285
+ // The transaction includes fee payment method, so we check if we are the fee payer for it
286
+ // (this can only happen if the embedded payment method is FeeJuiceWithClaim)
287
+ accountFeePaymentMethodOptions = from.equals(feePayer)
288
+ ? AccountFeePaymentMethodOptions.FEE_JUICE_WITH_CLAIM
289
+ : AccountFeePaymentMethodOptions.EXTERNAL;
290
+ }
291
+ }
292
+ const gasSettingsOverrides = {
293
+ gasLimits: gasSettings?.gasLimits ? Gas.from(gasSettings.gasLimits) : undefined,
294
+ teardownGasLimits: gasSettings?.teardownGasLimits ? Gas.from(gasSettings.teardownGasLimits) : undefined,
295
+ maxFeesPerGas,
296
+ maxPriorityFeesPerGas: gasSettings?.maxPriorityFeesPerGas ?? GasFees.empty(),
297
+ };
298
+ // When estimating gas (simulation), use high limits so the simulation doesn't run out of gas.
299
+ // When sending for real without explicit limits, declare the most a single tx may use on this network
300
+ // (the node's per-tx admission limit), so the proposer does not skip the tx for over-declaring gas.
301
+ let fullGasSettings;
302
+ if (forEstimation) {
303
+ // Estimation deliberately uses very high internal limits and skips tx validation, so we do not
304
+ // validate against the network admission limit here.
305
+ fullGasSettings = GasSettings.forEstimation(gasSettingsOverrides);
196
306
  } 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;
307
+ const maxTxGasLimits = await this.getMaxTxGasLimits();
308
+ // If the caller declared explicit gas limits, reject them up front when they exceed the network's
309
+ // per-tx admission limit (mirroring the node's GasLimitsValidator). Otherwise fill in the limit.
310
+ if (gasSettingsOverrides.gasLimits) {
311
+ assertGasLimitsWithinNetworkLimits(gasSettingsOverrides.gasLimits, maxTxGasLimits);
312
+ }
313
+ fullGasSettings = GasSettings.fallback({
314
+ ...gasSettingsOverrides,
315
+ gasLimits: gasSettingsOverrides.gasLimits ?? maxTxGasLimits,
316
+ });
202
317
  }
203
- const fullGasSettings: GasSettings = GasSettings.default({ ...gasSettings, maxFeesPerGas });
204
318
  this.log.debug(`Using L2 gas settings`, fullGasSettings);
205
319
  return {
206
320
  gasSettings: fullGasSettings,
@@ -210,107 +324,207 @@ export abstract class BaseWallet implements Wallet {
210
324
  }
211
325
 
212
326
  /**
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
327
+ * Returns the worst-case min fee across predicted future slots.
328
+ * Falls back to getCurrentMinFees if the node doesn't support getPredictedMinFees.
329
+ * @param estimate - The mana usage estimate to use for fee prediction. Defaults to Limit for conservative estimation.
219
330
  */
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
- };
331
+ protected async getMinFees(estimate: ManaUsageEstimate = ManaUsageEstimate.Limit): Promise<GasFees> {
332
+ try {
333
+ const predicted = await this.aztecNode.getPredictedMinFees(estimate);
334
+ if (predicted.length === 0) {
335
+ return this.aztecNode.getCurrentMinFees();
336
+ }
337
+ return predicted.reduce((worst, fees) => (fees.feePerL2Gas > worst.feePerL2Gas ? fees : worst));
338
+ } catch (err: any) {
339
+ // Fallback for old nodes that don't support getPredictedMinFees.
340
+ // Only fall back on method-not-found errors (JSON-RPC code -32601); rethrow others.
341
+ if (err?.cause?.code === -32601 || err?.message?.includes('Method not found')) {
342
+ return this.aztecNode.getCurrentMinFees();
343
+ }
344
+ throw err;
345
+ }
241
346
  }
242
347
 
243
- registerSender(address: AztecAddress, _alias: string = ''): Promise<AztecAddress> {
244
- return this.pxe.registerSender(address);
348
+ async registerSender(address: AztecAddress, _alias: string = ''): Promise<AztecAddress> {
349
+ await this.pxe.registerTaggingSecretSource({ kind: 'address-derived', sender: address });
350
+ return address;
245
351
  }
246
352
 
247
353
  async registerContract(
248
- instance: ContractInstanceWithAddress,
354
+ instance: ContractInstancePreimage,
249
355
  artifact?: ContractArtifact,
250
- secretKey?: Fr,
251
- ): Promise<ContractInstanceWithAddress> {
252
- const existingInstance = await this.pxe.getContractInstance(instance.address);
253
-
254
- if (existingInstance) {
255
- // Instance already registered in the wallet
256
- if (artifact) {
257
- const thisContractClass = await getContractClassFromArtifact(artifact);
258
- if (!thisContractClass.id.equals(existingInstance.currentContractClassId)) {
259
- // wallet holds an outdated version of this contract
260
- await this.pxe.updateContract(instance.address, artifact);
261
- instance.currentContractClassId = thisContractClass.id;
262
- }
263
- }
264
- // If no artifact provided, we just use the existing registration
265
- } else {
266
- // Instance not registered yet
267
- if (!artifact) {
268
- // Try to get the artifact from the wallet's contract class storage
269
- artifact = await this.pxe.getContractArtifact(instance.currentContractClassId);
270
- if (!artifact) {
271
- throw new Error(
272
- `Cannot register contract at ${instance.address.toString()}: artifact is required but not provided, and wallet does not have the artifact for contract class ${instance.currentContractClassId.toString()}`,
273
- );
274
- }
356
+ secretKeyOrKeys?: Fr | MasterSecretKeys,
357
+ ): Promise<void> {
358
+ // Classes and instances are registered independently: register the artifact (if provided) then the instance.
359
+ // Neither call validates that the artifact matches the class the instance runs, a missing artifact only surfaces
360
+ // when the contract is later simulated.
361
+ if (artifact) {
362
+ await this.pxe.registerContractClass(artifact);
363
+ }
364
+ const contractAddress = await this.pxe.registerContract(instance);
365
+
366
+ if (secretKeyOrKeys) {
367
+ // PXE never receives the account seed (from which the message-signing/fallback secret keys could be re-derived):
368
+ // the wallet derives the keys here. Of these, PXE only reads and stores the four privacy secret keys and the
369
+ // message-signing and fallback *public* keys — it never touches the message-signing or fallback secret keys.
370
+ //
371
+ // Since PXE recomputes the address from those keys, we assert it matches the instance's address: a mismatch means
372
+ // the provided keys don't correspond to this account.
373
+ const derivedKeys =
374
+ secretKeyOrKeys instanceof Fr
375
+ ? await deriveKeys(secretKeyOrKeys)
376
+ : await deriveKeysFromMasterSecretKeys(secretKeyOrKeys);
377
+ const { address } = await this.pxe.registerAccount(derivedKeys, await computePartialAddress(instance));
378
+ if (!address.equals(contractAddress)) {
379
+ throw new Error(
380
+ `Registered account address ${address.toString()} does not match contract instance address ${contractAddress.toString()}: the provided keys do not correspond to this account.`,
381
+ );
275
382
  }
276
- await this.pxe.registerContract({ artifact, instance });
277
383
  }
384
+ }
278
385
 
279
- if (secretKey) {
280
- await this.pxe.registerAccount(secretKey, await computePartialAddress(instance));
281
- }
282
- return instance;
386
+ registerContractClass(artifact: ContractArtifact): Promise<void> {
387
+ return this.pxe.registerContractClass(artifact);
283
388
  }
284
389
 
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,
390
+ /**
391
+ * Simulates calls through the standard PXE path (account entrypoint).
392
+ * @param executionPayload - The execution payload to simulate.
393
+ * @param opts - Simulation options.
394
+ */
395
+ protected async simulateViaEntrypoint(executionPayload: ExecutionPayload, opts: SimulateViaEntrypointOptions) {
396
+ const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(
397
+ executionPayload,
398
+ opts.from,
399
+ opts.feeOptions,
295
400
  );
401
+ const result = await this.pxe.simulateTx(txRequest, {
402
+ simulatePublic: true,
403
+ skipTxValidation: opts.skipTxValidation,
404
+ skipFeeEnforcement: opts.skipFeeEnforcement,
405
+ scopes: this.scopesFrom(opts.from, opts.additionalScopes),
406
+ senderForTags: this.senderForTagsFrom(opts.from, opts.sendMessagesAs),
407
+ overrides: opts.overrides,
408
+ });
409
+ const appCallOffset = await this.computeAppCallOffset(opts.from, opts.feeOptions);
410
+ return TxSimulationResultWithAppOffset.fromResultAndOffset(result, appCallOffset);
411
+ }
412
+
413
+ /**
414
+ * Computes the index where the app's calls begin in the flattened array of calls (0 = entrypoint/root, 1..N = fee
415
+ * calls, N+1 = app).
416
+ * @param from - The sender address, or NO_FROM for the default entrypoint.
417
+ * @param feeOptions - Fee options containing the wallet fee payment method.
418
+ */
419
+ protected async computeAppCallOffset(from: AztecAddress | NoFrom, feeOptions: FeeOptions): Promise<number> {
420
+ if (from === NO_FROM) {
421
+ return 0;
422
+ }
423
+ const feeExecutionPayload = await feeOptions.walletFeePaymentMethod?.getExecutionPayload();
424
+ return (feeExecutionPayload?.calls.length ?? 0) + 1; // +1 for entrypoint
425
+ }
426
+
427
+ /**
428
+ * Simulates a transaction, optimizing leading public static calls by running them directly
429
+ * on the node while sending the remaining calls through the standard PXE path.
430
+ * Return values from both paths are merged back in original call order.
431
+ * @param executionPayload - The execution payload to simulate.
432
+ * @param opts - Simulation options (from address, fee settings, etc.).
433
+ * @returns The merged simulation result.
434
+ */
435
+ async simulateTx(
436
+ executionPayload: ExecutionPayload,
437
+ opts: SimulateOptions,
438
+ ): Promise<TxSimulationResultWithAppOffset> {
439
+ const feeOptions = await this.completeFeeOptions({
440
+ from: opts.from,
441
+ feePayer: executionPayload.feePayer,
442
+ gasSettings: opts.fee?.gasSettings,
443
+ forEstimation: true,
444
+ congestionEstimate: opts.fee?.congestionEstimate,
445
+ });
446
+ const { optimizableCalls, remainingCalls } = extractOptimizablePublicStaticCalls(executionPayload);
447
+ const remainingPayload = { ...executionPayload, calls: remainingCalls };
448
+
449
+ const chainInfo = await this.getChainInfo();
450
+ let blockHeader: BlockHeader;
451
+ // PXE might not be synced yet, so we pull the latest header from the node
452
+ // To keep things consistent, we'll always try with PXE first
453
+ try {
454
+ blockHeader = await this.pxe.getSyncedBlockHeader();
455
+ } catch {
456
+ blockHeader = (await this.aztecNode.getBlockData('latest'))!.header;
457
+ }
458
+
459
+ const simulationOrigin = opts.from === NO_FROM ? AztecAddress.ZERO : opts.from;
460
+ const [optimizedResults, normalResult] = await Promise.all([
461
+ optimizableCalls.length > 0
462
+ ? simulateViaNode(
463
+ this.aztecNode,
464
+ optimizableCalls,
465
+ simulationOrigin,
466
+ chainInfo,
467
+ feeOptions.gasSettings,
468
+ blockHeader,
469
+ opts.skipFeeEnforcement ?? true,
470
+ this.getContractName.bind(this),
471
+ opts.overrides,
472
+ )
473
+ : Promise.resolve([]),
474
+ remainingCalls.length > 0
475
+ ? this.simulateViaEntrypoint(remainingPayload, {
476
+ from: opts.from,
477
+ feeOptions,
478
+ additionalScopes: opts.additionalScopes,
479
+ skipTxValidation: opts.skipTxValidation,
480
+ skipFeeEnforcement: opts.skipFeeEnforcement ?? true,
481
+ sendMessagesAs: opts.sendMessagesAs,
482
+ overrides: opts.overrides,
483
+ })
484
+ : Promise.resolve(null),
485
+ ]);
486
+
487
+ return buildMergedSimulationResult(optimizedResults, normalResult);
296
488
  }
297
489
 
298
490
  async profileTx(executionPayload: ExecutionPayload, opts: ProfileOptions): Promise<TxProfileResult> {
299
- const feeOptions = await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
491
+ const feeOptions = await this.completeFeeOptions({
492
+ from: opts.from,
493
+ feePayer: executionPayload.feePayer,
494
+ gasSettings: opts.fee?.gasSettings,
495
+ congestionEstimate: opts.fee?.congestionEstimate,
496
+ });
300
497
  const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
301
- return this.pxe.profileTx(txRequest, opts.profileMode, opts.skipProofGeneration ?? true);
498
+ return this.pxe.profileTx(txRequest, {
499
+ profileMode: opts.profileMode,
500
+ skipProofGeneration: opts.skipProofGeneration ?? true,
501
+ scopes: this.scopesFrom(opts.from, opts.additionalScopes),
502
+ senderForTags: this.senderForTagsFrom(opts.from, opts.sendMessagesAs),
503
+ });
302
504
  }
303
505
 
304
506
  public async sendTx<W extends InteractionWaitOptions = undefined>(
305
507
  executionPayload: ExecutionPayload,
306
508
  opts: SendOptions<W>,
307
509
  ): Promise<SendReturn<W>> {
308
- const feeOptions = await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
510
+ const feeOptions = await this.completeFeeOptions({
511
+ from: opts.from,
512
+ feePayer: executionPayload.feePayer,
513
+ gasSettings: opts.fee?.gasSettings,
514
+ congestionEstimate: opts.fee?.congestionEstimate,
515
+ });
309
516
  const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
310
- const provenTx = await this.pxe.proveTx(txRequest);
517
+ const provenTx = await this.pxe.proveTx(txRequest, {
518
+ scopes: this.scopesFrom(opts.from, opts.additionalScopes),
519
+ senderForTags: this.senderForTagsFrom(opts.from, opts.sendMessagesAs),
520
+ });
521
+ const offchainOutput = extractOffchainOutput(
522
+ provenTx.getOffchainEffects(),
523
+ provenTx.publicInputs.constants.anchorBlockHeader.globalVariables.timestamp,
524
+ );
311
525
  const tx = await provenTx.toTx();
312
526
  const txHash = tx.getTxHash();
313
- if (await this.aztecNode.getTxEffect(txHash)) {
527
+ if ((await this.aztecNode.getTxReceipt(txHash)).isMined()) {
314
528
  throw new Error(`A settled tx with equal hash ${txHash.toString()} exists.`);
315
529
  }
316
530
  this.log.debug(`Sending transaction ${txHash}`);
@@ -321,12 +535,40 @@ export abstract class BaseWallet implements Wallet {
321
535
 
322
536
  // If wait is NO_WAIT, return txHash immediately
323
537
  if (opts.wait === NO_WAIT) {
324
- return txHash as SendReturn<W>;
538
+ return { txHash, ...offchainOutput } as SendReturn<W>;
325
539
  }
326
540
 
327
541
  // Otherwise, wait for the full receipt (default behavior on wait: undefined)
328
- const waitOpts = typeof opts.wait === 'object' ? opts.wait : undefined;
329
- return (await waitForTx(this.aztecNode, txHash, waitOpts)) as SendReturn<W>;
542
+ const callerWaitOpts = typeof opts.wait === 'object' ? opts.wait : undefined;
543
+ const waitOpts =
544
+ this.defaultWaitInterval !== undefined && callerWaitOpts?.interval === undefined
545
+ ? { ...callerWaitOpts, interval: this.defaultWaitInterval }
546
+ : callerWaitOpts;
547
+ const receipt = await waitForTx(this.aztecNode, txHash, waitOpts);
548
+
549
+ // Display debug logs from public execution if present (served in test mode only)
550
+ if (receipt.isMined() && receipt.debugLogs?.length) {
551
+ await displayDebugLogs(receipt.debugLogs, this.getContractName.bind(this));
552
+ }
553
+
554
+ return { receipt, ...offchainOutput } as SendReturn<W>;
555
+ }
556
+
557
+ /**
558
+ * Resolves a contract address to a human-readable name via PXE, if available.
559
+ * @param address - The contract address to resolve.
560
+ */
561
+ protected async getContractName(address: AztecAddress): Promise<string | undefined> {
562
+ const instance = await this.pxe.getContractInstance(address);
563
+ if (!instance) {
564
+ return undefined;
565
+ }
566
+ // Contract names are class-stable (an upgrade preserves the contract name), so the original class artifact is a
567
+ // sufficient source for the display name without resolving the current class against the node.
568
+ // TODO: if a contract were to be upgraded and its original artifact never registered, then this would fail and we'd
569
+ // want to fallback to the current class.
570
+ const artifact = await this.pxe.getContractArtifact(instance.originalContractClassId);
571
+ return artifact?.name;
330
572
  }
331
573
 
332
574
  protected contextualizeError(err: Error, ...context: string[]): Error {
@@ -343,8 +585,8 @@ export abstract class BaseWallet implements Wallet {
343
585
  return err;
344
586
  }
345
587
 
346
- simulateUtility(call: FunctionCall, authwits?: AuthWitness[]): Promise<UtilitySimulationResult> {
347
- return this.pxe.simulateUtility(call, authwits);
588
+ executeUtility(call: FunctionCall, opts: ExecuteUtilityOptions): Promise<UtilityExecutionResult> {
589
+ return this.pxe.executeUtility(call, { authwits: opts.authWitnesses, scopes: opts.scopes });
348
590
  }
349
591
 
350
592
  async getPrivateEvents<T>(
@@ -367,17 +609,39 @@ export abstract class BaseWallet implements Wallet {
367
609
  return decodedEvents;
368
610
  }
369
611
 
612
+ /**
613
+ * Returns metadata about a contract, including whether it has been initialized, published, and updated.
614
+ * @param address - The contract address to query.
615
+ */
370
616
  async getContractMetadata(address: AztecAddress) {
371
617
  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);
618
+ const publiclyRegisteredContractPromise = this.aztecNode.getContract(address);
619
+
620
+ let initializationStatus: ContractInitializationStatus;
621
+ if (instance) {
622
+ // We have the instance, so we can compute the private initialization nullifier (which includes init_hash and is
623
+ // emitted by both private and public initializers) and get a definitive INITIALIZED/UNINITIALIZED answer.
624
+ const initNullifier = await computeSiloedPrivateInitializationNullifier(address, instance.initializationHash);
625
+ const witness = await this.aztecNode.getNullifierMembershipWitness('latest', initNullifier);
626
+ initializationStatus = witness
627
+ ? ContractInitializationStatus.INITIALIZED
628
+ : ContractInitializationStatus.UNINITIALIZED;
629
+ } else {
630
+ // Without the instance we lack the init_hash needed for the private nullifier. We fall back to checking the
631
+ // public initialization nullifier (computed from address alone). Not all contracts emit it (only those with
632
+ // public functions that require initialization checks), so its absence doesn't mean the contract is
633
+ // uninitialized.
634
+ const publicNullifier = await computeSiloedPublicInitializationNullifier(address);
635
+ const witness = await this.aztecNode.getNullifierMembershipWitness('latest', publicNullifier);
636
+ initializationStatus = witness ? ContractInitializationStatus.INITIALIZED : ContractInitializationStatus.UNKNOWN;
637
+ }
638
+ const publiclyRegisteredContract = await publiclyRegisteredContractPromise;
375
639
  const isContractUpdated =
376
640
  publiclyRegisteredContract &&
377
641
  !publiclyRegisteredContract.currentContractClassId.equals(publiclyRegisteredContract.originalContractClassId);
378
642
  return {
379
643
  instance: instance ?? undefined,
380
- isContractInitialized: !!initNullifierMembershipWitness,
644
+ initializationStatus,
381
645
  isContractPublished: !!publiclyRegisteredContract,
382
646
  isContractUpdated: !!isContractUpdated,
383
647
  updatedContractClassId: isContractUpdated ? publiclyRegisteredContract.currentContractClassId : undefined,