@aztec/wallet-sdk 0.0.1-commit.4d79d1f2d → 0.0.1-commit.4d9804df

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