@aztec/wallet-sdk 0.0.1-commit.96dac018d → 0.0.1-commit.9a89641

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