@aztec/wallet-sdk 0.0.1-commit.3fd054f6 → 0.0.1-commit.431c48d

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 +157 -0
  2. package/dest/base-wallet/base_wallet.d.ts +70 -43
  3. package/dest/base-wallet/base_wallet.d.ts.map +1 -1
  4. package/dest/base-wallet/base_wallet.js +247 -119
  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 +309 -167
  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,39 +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
4
  import {
5
+ DefaultWaitOpts,
4
6
  type InteractionWaitOptions,
5
7
  NO_WAIT,
6
8
  type SendReturn,
9
+ type WaitOpts,
7
10
  extractOffchainOutput,
8
11
  } from '@aztec/aztec.js/contracts';
9
12
  import type { FeePaymentMethod } from '@aztec/aztec.js/fee';
10
13
  import { waitForTx } from '@aztec/aztec.js/node';
11
- import type {
12
- Aliased,
13
- AppCapabilities,
14
- BatchResults,
15
- BatchedMethod,
16
- ExecuteUtilityOptions,
17
- PrivateEvent,
18
- PrivateEventFilter,
19
- ProfileOptions,
20
- SendOptions,
21
- SimulateOptions,
22
- Wallet,
23
- WalletCapabilities,
24
- } from '@aztec/aztec.js/wallet';
25
14
  import {
26
- GAS_ESTIMATION_DA_GAS_LIMIT,
27
- GAS_ESTIMATION_L2_GAS_LIMIT,
28
- GAS_ESTIMATION_TEARDOWN_DA_GAS_LIMIT,
29
- GAS_ESTIMATION_TEARDOWN_L2_GAS_LIMIT,
30
- } from '@aztec/constants';
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';
31
30
  import { AccountFeePaymentMethodOptions, type DefaultAccountEntrypointOptions } from '@aztec/entrypoints/account';
31
+ import { DefaultEntrypoint } from '@aztec/entrypoints/default';
32
32
  import type { ChainInfo } from '@aztec/entrypoints/interfaces';
33
33
  import { Fr } from '@aztec/foundation/curves/bn254';
34
34
  import { createLogger } from '@aztec/foundation/log';
35
35
  import type { FieldsOf } from '@aztec/foundation/types';
36
- import { type AccessScopes, displayDebugLogs } from '@aztec/pxe/client/lazy';
36
+ import { displayDebugLogs } from '@aztec/pxe/client/lazy';
37
37
  import type { PXE, PackedPrivateEvent } from '@aztec/pxe/server';
38
38
  import {
39
39
  type ContractArtifact,
@@ -43,26 +43,27 @@ import {
43
43
  } from '@aztec/stdlib/abi';
44
44
  import type { AuthWitness } from '@aztec/stdlib/auth-witness';
45
45
  import { AztecAddress } from '@aztec/stdlib/aztec-address';
46
- import {
47
- type ContractInstanceWithAddress,
48
- computePartialAddress,
49
- getContractClassFromArtifact,
50
- } from '@aztec/stdlib/contract';
46
+ import { type ContractInstancePreimage, type NodeInfo, computePartialAddress } from '@aztec/stdlib/contract';
51
47
  import { SimulationError } from '@aztec/stdlib/errors';
52
- import { Gas, GasSettings } from '@aztec/stdlib/gas';
53
- import { computeSiloedPrivateInitializationNullifier } 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';
54
53
  import type { AztecNode } from '@aztec/stdlib/interfaces/client';
54
+ import { type MasterSecretKeys, deriveKeys, deriveKeysFromMasterSecretKeys } from '@aztec/stdlib/keys';
55
55
  import {
56
56
  BlockHeader,
57
+ ExecutionPayload,
57
58
  type TxExecutionRequest,
58
59
  type TxProfileResult,
59
- TxSimulationResult,
60
60
  type UtilityExecutionResult,
61
+ mergeExecutionPayloads,
61
62
  } from '@aztec/stdlib/tx';
62
- import { ExecutionPayload, mergeExecutionPayloads } from '@aztec/stdlib/tx';
63
63
 
64
64
  import { inspect } from 'util';
65
65
 
66
+ import { assertGasLimitsWithinNetworkLimits } from './get_gas_limits.js';
66
67
  import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simulateViaNode } from './utils.js';
67
68
 
68
69
  /**
@@ -75,7 +76,7 @@ export type FeeOptions = {
75
76
  */
76
77
  walletFeePaymentMethod?: FeePaymentMethod;
77
78
  /** Configuration options for the account to properly handle the selected fee payment method */
78
- accountFeePaymentMethodOptions: AccountFeePaymentMethodOptions;
79
+ accountFeePaymentMethodOptions?: AccountFeePaymentMethodOptions;
79
80
  /** The gas settings to use for the transaction */
80
81
  gasSettings: GasSettings;
81
82
  };
@@ -83,19 +84,41 @@ export type FeeOptions = {
83
84
  /** Options for `simulateViaEntrypoint`. */
84
85
  export type SimulateViaEntrypointOptions = Pick<
85
86
  SimulateOptions,
86
- 'from' | 'additionalScopes' | 'skipTxValidation' | 'skipFeeEnforcement'
87
+ 'from' | 'additionalScopes' | 'skipTxValidation' | 'skipFeeEnforcement' | 'sendMessagesAs' | 'overrides'
87
88
  > & {
88
89
  /** Fee options for the entrypoint */
89
90
  feeOptions: FeeOptions;
90
- /** Scopes to use for the simulation */
91
- scopes: AccessScopes;
92
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
+
93
110
  /**
94
111
  * A base class for Wallet implementations
95
112
  */
96
113
  export abstract class BaseWallet implements Wallet {
97
114
  protected minFeePadding = 0.5;
98
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;
99
122
 
100
123
  // Protected because we want to force wallets to instantiate their own PXE.
101
124
  protected constructor(
@@ -104,10 +127,28 @@ export abstract class BaseWallet implements Wallet {
104
127
  protected log = createLogger('wallet-sdk:base_wallet'),
105
128
  ) {}
106
129
 
107
- protected scopesFrom(from: AztecAddress, additionalScopes: AztecAddress[] = []): AztecAddress[] {
108
- 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];
109
139
  const scopeSet = new Set(allScopes.map(address => address.toString()));
110
- 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);
111
152
  }
112
153
 
113
154
  protected abstract getAccountFromAddress(address: AztecAddress): Promise<Account>;
@@ -122,37 +163,71 @@ export abstract class BaseWallet implements Wallet {
122
163
  * @returns The aliased collection of AztecAddresses that form this wallet's address book
123
164
  */
124
165
  async getAddressBook(): Promise<Aliased<AztecAddress>[]> {
125
- const senders: AztecAddress[] = await this.pxe.getSenders();
126
- 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;
127
184
  }
128
185
 
129
186
  async getChainInfo(): Promise<ChainInfo> {
130
- const { l1ChainId, rollupVersion } = await this.aztecNode.getNodeInfo();
187
+ const { l1ChainId, rollupVersion } = await this.getNodeInfo();
131
188
  return { chainId: new Fr(l1ChainId), version: new Fr(rollupVersion) };
132
189
  }
133
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
+
134
202
  protected async createTxExecutionRequestFromPayloadAndFee(
135
203
  executionPayload: ExecutionPayload,
136
- from: AztecAddress,
204
+ from: AztecAddress | NoFrom,
137
205
  feeOptions: FeeOptions,
138
206
  ): Promise<TxExecutionRequest> {
139
207
  const feeExecutionPayload = await feeOptions.walletFeePaymentMethod?.getExecutionPayload();
140
- const executionOptions: DefaultAccountEntrypointOptions = {
141
- txNonce: Fr.random(),
142
- cancellable: this.cancellableTransactions,
143
- feePaymentMethodOptions: feeOptions.accountFeePaymentMethodOptions,
144
- };
145
208
  const finalExecutionPayload = feeExecutionPayload
146
209
  ? mergeExecutionPayloads([feeExecutionPayload, executionPayload])
147
210
  : executionPayload;
148
- const fromAccount = await this.getAccountFromAddress(from);
149
211
  const chainInfo = await this.getChainInfo();
150
- return fromAccount.createTxExecutionRequest(
151
- finalExecutionPayload,
152
- feeOptions.gasSettings,
153
- chainInfo,
154
- executionOptions,
155
- );
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
+ }
156
231
  }
157
232
 
158
233
  public async createAuthWit(
@@ -201,31 +276,54 @@ export abstract class BaseWallet implements Wallet {
201
276
 
202
277
  /**
203
278
  * Completes partial user-provided fee options with wallet defaults.
204
- * @param from - The address where the transaction is being sent from
205
- * @param feePayer - The address paying for fees (if any fee payment method is embedded in the execution payload)
206
- * @param gasSettings - User-provided partial gas settings
207
- * @returns - Complete fee options that can be used to create a transaction execution request
279
+ * @param config - Fee completion config.
208
280
  */
209
- protected async completeFeeOptions(
210
- from: AztecAddress,
211
- feePayer?: AztecAddress,
212
- gasSettings?: Partial<FieldsOf<GasSettings>>,
213
- ): Promise<FeeOptions> {
281
+ protected async completeFeeOptions(config: CompleteFeeOptionsConfig): Promise<FeeOptions> {
282
+ const { from, feePayer, gasSettings, forEstimation, congestionEstimate } = config;
214
283
  const maxFeesPerGas =
215
- gasSettings?.maxFeesPerGas ?? (await this.aztecNode.getCurrentMinFees()).mul(1 + this.minFeePadding);
284
+ gasSettings?.maxFeesPerGas ?? (await this.getMinFees(congestionEstimate)).mul(1 + this.minFeePadding);
216
285
  let accountFeePaymentMethodOptions;
217
- // The transaction does not include a fee payment method, so we set the flag
218
- // for the account to use its fee juice balance
219
- if (!feePayer) {
220
- accountFeePaymentMethodOptions = AccountFeePaymentMethodOptions.PREEXISTING_FEE_JUICE;
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);
221
315
  } else {
222
- // The transaction includes fee payment method, so we check if we are the fee payer for it
223
- // (this can only happen if the embedded payment method is FeeJuiceWithClaim)
224
- accountFeePaymentMethodOptions = from.equals(feePayer)
225
- ? AccountFeePaymentMethodOptions.FEE_JUICE_WITH_CLAIM
226
- : AccountFeePaymentMethodOptions.EXTERNAL;
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
+ });
227
326
  }
228
- const fullGasSettings: GasSettings = GasSettings.default({ ...gasSettings, maxFeesPerGas });
229
327
  this.log.debug(`Using L2 gas settings`, fullGasSettings);
230
328
  return {
231
329
  gasSettings: fullGasSettings,
@@ -235,76 +333,67 @@ export abstract class BaseWallet implements Wallet {
235
333
  }
236
334
 
237
335
  /**
238
- * Completes partial user-provided fee options with unreasonably high gas limits
239
- * for gas estimation. Uses the same logic as completeFeeOptions but sets high limits
240
- * to avoid running out of gas during estimation.
241
- * @param from - The address where the transaction is being sent from
242
- * @param feePayer - The address paying for fees (if any fee payment method is embedded in the execution payload)
243
- * @param gasSettings - User-provided partial gas settings
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.
244
339
  */
245
- protected async completeFeeOptionsForEstimation(
246
- from: AztecAddress,
247
- feePayer?: AztecAddress,
248
- gasSettings?: Partial<FieldsOf<GasSettings>>,
249
- ) {
250
- const defaultFeeOptions = await this.completeFeeOptions(from, feePayer, gasSettings);
251
- const {
252
- gasSettings: { maxFeesPerGas, maxPriorityFeesPerGas },
253
- } = defaultFeeOptions;
254
- // Use unrealistically high gas limits for estimation to avoid running out of gas.
255
- // They will be tuned down after the simulation.
256
- const gasSettingsForEstimation = new GasSettings(
257
- new Gas(GAS_ESTIMATION_DA_GAS_LIMIT, GAS_ESTIMATION_L2_GAS_LIMIT),
258
- new Gas(GAS_ESTIMATION_TEARDOWN_DA_GAS_LIMIT, GAS_ESTIMATION_TEARDOWN_L2_GAS_LIMIT),
259
- maxFeesPerGas,
260
- maxPriorityFeesPerGas,
261
- );
262
- return {
263
- ...defaultFeeOptions,
264
- gasSettings: gasSettingsForEstimation,
265
- };
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
+ }
266
355
  }
267
356
 
268
- registerSender(address: AztecAddress, _alias: string = ''): Promise<AztecAddress> {
269
- 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;
270
360
  }
271
361
 
272
362
  async registerContract(
273
- instance: ContractInstanceWithAddress,
363
+ instance: ContractInstancePreimage,
274
364
  artifact?: ContractArtifact,
275
- secretKey?: Fr,
276
- ): Promise<ContractInstanceWithAddress> {
277
- const existingInstance = await this.pxe.getContractInstance(instance.address);
278
-
279
- if (existingInstance) {
280
- // Instance already registered in the wallet
281
- if (artifact) {
282
- const thisContractClass = await getContractClassFromArtifact(artifact);
283
- if (!thisContractClass.id.equals(existingInstance.currentContractClassId)) {
284
- // wallet holds an outdated version of this contract
285
- await this.pxe.updateContract(instance.address, artifact);
286
- instance.currentContractClassId = thisContractClass.id;
287
- }
288
- }
289
- // If no artifact provided, we just use the existing registration
290
- } else {
291
- // Instance not registered yet
292
- if (!artifact) {
293
- // Try to get the artifact from the wallet's contract class storage
294
- artifact = await this.pxe.getContractArtifact(instance.currentContractClassId);
295
- if (!artifact) {
296
- throw new Error(
297
- `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()}`,
298
- );
299
- }
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
+ );
300
391
  }
301
- await this.pxe.registerContract({ artifact, instance });
302
392
  }
393
+ }
303
394
 
304
- if (secretKey) {
305
- await this.pxe.registerAccount(secretKey, await computePartialAddress(instance));
306
- }
307
- return instance;
395
+ registerContractClass(artifact: ContractArtifact): Promise<void> {
396
+ return this.pxe.registerContractClass(artifact);
308
397
  }
309
398
 
310
399
  /**
@@ -318,12 +407,30 @@ export abstract class BaseWallet implements Wallet {
318
407
  opts.from,
319
408
  opts.feeOptions,
320
409
  );
321
- return this.pxe.simulateTx(txRequest, {
410
+ const result = await this.pxe.simulateTx(txRequest, {
322
411
  simulatePublic: true,
323
412
  skipTxValidation: opts.skipTxValidation,
324
413
  skipFeeEnforcement: opts.skipFeeEnforcement,
325
- scopes: opts.scopes,
414
+ scopes: this.scopesFrom(opts.from, opts.additionalScopes ?? [], opts.sendMessagesAs),
415
+ senderForTags: this.senderForTagsFrom(opts.from, opts.sendMessagesAs),
416
+ overrides: opts.overrides,
326
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
327
434
  }
328
435
 
329
436
  /**
@@ -334,10 +441,17 @@ export abstract class BaseWallet implements Wallet {
334
441
  * @param opts - Simulation options (from address, fee settings, etc.).
335
442
  * @returns The merged simulation result.
336
443
  */
337
- async simulateTx(executionPayload: ExecutionPayload, opts: SimulateOptions): Promise<TxSimulationResult> {
338
- const feeOptions = opts.fee?.estimateGas
339
- ? await this.completeFeeOptionsForEstimation(opts.from, executionPayload.feePayer, opts.fee?.gasSettings)
340
- : await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
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
+ });
341
455
  const { optimizableCalls, remainingCalls } = extractOptimizablePublicStaticCalls(executionPayload);
342
456
  const remainingPayload = { ...executionPayload, calls: remainingCalls };
343
457
 
@@ -348,29 +462,33 @@ export abstract class BaseWallet implements Wallet {
348
462
  try {
349
463
  blockHeader = await this.pxe.getSyncedBlockHeader();
350
464
  } catch {
351
- blockHeader = (await this.aztecNode.getBlockHeader())!;
465
+ blockHeader = (await this.aztecNode.getBlockData('latest'))!.header;
352
466
  }
353
467
 
468
+ const simulationOrigin = opts.from === NO_FROM ? AztecAddress.ZERO : opts.from;
354
469
  const [optimizedResults, normalResult] = await Promise.all([
355
470
  optimizableCalls.length > 0
356
471
  ? simulateViaNode(
357
472
  this.aztecNode,
358
473
  optimizableCalls,
359
- opts.from,
474
+ simulationOrigin,
360
475
  chainInfo,
361
476
  feeOptions.gasSettings,
362
477
  blockHeader,
363
478
  opts.skipFeeEnforcement ?? true,
364
479
  this.getContractName.bind(this),
480
+ opts.overrides,
365
481
  )
366
482
  : Promise.resolve([]),
367
483
  remainingCalls.length > 0
368
484
  ? this.simulateViaEntrypoint(remainingPayload, {
369
485
  from: opts.from,
370
486
  feeOptions,
371
- scopes: this.scopesFrom(opts.from, opts.additionalScopes),
487
+ additionalScopes: opts.additionalScopes,
372
488
  skipTxValidation: opts.skipTxValidation,
373
489
  skipFeeEnforcement: opts.skipFeeEnforcement ?? true,
490
+ sendMessagesAs: opts.sendMessagesAs,
491
+ overrides: opts.overrides,
374
492
  })
375
493
  : Promise.resolve(null),
376
494
  ]);
@@ -379,12 +497,18 @@ export abstract class BaseWallet implements Wallet {
379
497
  }
380
498
 
381
499
  async profileTx(executionPayload: ExecutionPayload, opts: ProfileOptions): Promise<TxProfileResult> {
382
- 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
+ });
383
506
  const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
384
507
  return this.pxe.profileTx(txRequest, {
385
508
  profileMode: opts.profileMode,
386
509
  skipProofGeneration: opts.skipProofGeneration ?? true,
387
- 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),
388
512
  });
389
513
  }
390
514
 
@@ -392,18 +516,23 @@ export abstract class BaseWallet implements Wallet {
392
516
  executionPayload: ExecutionPayload,
393
517
  opts: SendOptions<W>,
394
518
  ): Promise<SendReturn<W>> {
395
- 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
+ });
396
525
  const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
397
- 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
+ });
398
530
  const offchainOutput = extractOffchainOutput(
399
531
  provenTx.getOffchainEffects(),
400
532
  provenTx.publicInputs.constants.anchorBlockHeader.globalVariables.timestamp,
401
533
  );
402
534
  const tx = await provenTx.toTx();
403
535
  const txHash = tx.getTxHash();
404
- if (await this.aztecNode.getTxEffect(txHash)) {
405
- throw new Error(`A settled tx with equal hash ${txHash.toString()} exists.`);
406
- }
407
536
  this.log.debug(`Sending transaction ${txHash}`);
408
537
  await this.aztecNode.sendTx(tx).catch(err => {
409
538
  throw this.contextualizeError(err, inspect(tx));
@@ -416,11 +545,17 @@ export abstract class BaseWallet implements Wallet {
416
545
  }
417
546
 
418
547
  // Otherwise, wait for the full receipt (default behavior on wait: undefined)
419
- const waitOpts = typeof opts.wait === 'object' ? opts.wait : undefined;
420
- 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 });
421
556
 
422
557
  // Display debug logs from public execution if present (served in test mode only)
423
- if (receipt.debugLogs?.length) {
558
+ if (receipt.isMined() && receipt.debugLogs?.length) {
424
559
  await displayDebugLogs(receipt.debugLogs, this.getContractName.bind(this));
425
560
  }
426
561
 
@@ -436,7 +571,11 @@ export abstract class BaseWallet implements Wallet {
436
571
  if (!instance) {
437
572
  return undefined;
438
573
  }
439
- 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);
440
579
  return artifact?.name;
441
580
  }
442
581
 
@@ -455,7 +594,7 @@ export abstract class BaseWallet implements Wallet {
455
594
  }
456
595
 
457
596
  executeUtility(call: FunctionCall, opts: ExecuteUtilityOptions): Promise<UtilityExecutionResult> {
458
- return this.pxe.executeUtility(call, { authwits: opts.authWitnesses, scopes: [opts.scope] });
597
+ return this.pxe.executeUtility(call, { authwits: opts.authWitnesses, scopes: opts.scopes });
459
598
  }
460
599
 
461
600
  async getPrivateEvents<T>(
@@ -480,26 +619,29 @@ export abstract class BaseWallet implements Wallet {
480
619
 
481
620
  /**
482
621
  * Returns metadata about a contract, including whether it has been initialized, published, and updated.
483
- *
484
- * `isContractInitialized` requires the contract instance to be registered in the PXE (for `init_hash`). When the
485
- * instance is not available, `isContractInitialized` is `undefined` since it cannot be determined.
486
622
  * @param address - The contract address to query.
487
623
  */
488
624
  async getContractMetadata(address: AztecAddress) {
489
625
  const instance = await this.pxe.getContractInstance(address);
490
626
  const publiclyRegisteredContractPromise = this.aztecNode.getContract(address);
491
- // We check only the private initialization nullifier. It is emitted by both private and public initializers and
492
- // includes init_hash, preventing observers from determining initialization status from the address alone. Without
493
- // the instance (and thus init_hash), we can't compute it, so we return undefined.
494
- //
495
- // We skip the public initialization nullifier because it's not always emitted (contracts without public external
496
- // functions that require initialization checks won't emit it). If the private one exists, the public one was
497
- // created in the same tx and will also be present.
498
- let isContractInitialized: boolean | undefined = undefined;
627
+
628
+ let initializationStatus: ContractInitializationStatus;
499
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.
500
632
  const initNullifier = await computeSiloedPrivateInitializationNullifier(address, instance.initializationHash);
501
633
  const witness = await this.aztecNode.getNullifierMembershipWitness('latest', initNullifier);
502
- isContractInitialized = !!witness;
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;
503
645
  }
504
646
  const publiclyRegisteredContract = await publiclyRegisteredContractPromise;
505
647
  const isContractUpdated =
@@ -507,7 +649,7 @@ export abstract class BaseWallet implements Wallet {
507
649
  !publiclyRegisteredContract.currentContractClassId.equals(publiclyRegisteredContract.originalContractClassId);
508
650
  return {
509
651
  instance: instance ?? undefined,
510
- isContractInitialized,
652
+ initializationStatus,
511
653
  isContractPublished: !!publiclyRegisteredContract,
512
654
  isContractUpdated: !!isContractUpdated,
513
655
  updatedContractClassId: isContractUpdated ? publiclyRegisteredContract.currentContractClassId : undefined,