@aztec/wallet-sdk 0.0.1-commit.9b94fc1 → 0.0.1-commit.9badcec54

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 (105) hide show
  1. package/README.md +228 -331
  2. package/dest/base-wallet/base_wallet.d.ts +103 -43
  3. package/dest/base-wallet/base_wallet.d.ts.map +1 -1
  4. package/dest/base-wallet/base_wallet.js +282 -78
  5. package/dest/base-wallet/index.d.ts +3 -2
  6. package/dest/base-wallet/index.d.ts.map +1 -1
  7. package/dest/base-wallet/index.js +1 -0
  8. package/dest/base-wallet/utils.d.ts +50 -0
  9. package/dest/base-wallet/utils.d.ts.map +1 -0
  10. package/dest/base-wallet/utils.js +133 -0
  11. package/dest/crypto.d.ts +230 -0
  12. package/dest/crypto.d.ts.map +1 -0
  13. package/dest/crypto.js +482 -0
  14. package/dest/emoji_alphabet.d.ts +35 -0
  15. package/dest/emoji_alphabet.d.ts.map +1 -0
  16. package/dest/emoji_alphabet.js +299 -0
  17. package/dest/extension/handlers/background_connection_handler.d.ts +158 -0
  18. package/dest/extension/handlers/background_connection_handler.d.ts.map +1 -0
  19. package/dest/extension/handlers/background_connection_handler.js +258 -0
  20. package/dest/extension/handlers/content_script_connection_handler.d.ts +56 -0
  21. package/dest/extension/handlers/content_script_connection_handler.d.ts.map +1 -0
  22. package/dest/extension/handlers/content_script_connection_handler.js +174 -0
  23. package/dest/extension/handlers/index.d.ts +12 -0
  24. package/dest/extension/handlers/index.d.ts.map +1 -0
  25. package/dest/extension/handlers/index.js +10 -0
  26. package/dest/extension/handlers/internal_message_types.d.ts +63 -0
  27. package/dest/extension/handlers/internal_message_types.d.ts.map +1 -0
  28. package/dest/extension/handlers/internal_message_types.js +22 -0
  29. package/dest/extension/provider/extension_provider.d.ts +107 -0
  30. package/dest/extension/provider/extension_provider.d.ts.map +1 -0
  31. package/dest/extension/provider/extension_provider.js +160 -0
  32. package/dest/extension/provider/extension_wallet.d.ts +129 -0
  33. package/dest/extension/provider/extension_wallet.d.ts.map +1 -0
  34. package/dest/extension/provider/extension_wallet.js +278 -0
  35. package/dest/extension/provider/index.d.ts +3 -0
  36. package/dest/extension/provider/index.d.ts.map +1 -0
  37. package/dest/iframe/handlers/iframe_connection_handler.d.ts +118 -0
  38. package/dest/iframe/handlers/iframe_connection_handler.d.ts.map +1 -0
  39. package/dest/iframe/handlers/iframe_connection_handler.js +228 -0
  40. package/dest/iframe/handlers/index.d.ts +2 -0
  41. package/dest/iframe/handlers/index.d.ts.map +1 -0
  42. package/dest/iframe/handlers/index.js +1 -0
  43. package/dest/iframe/provider/iframe_discovery.d.ts +25 -0
  44. package/dest/iframe/provider/iframe_discovery.d.ts.map +1 -0
  45. package/dest/iframe/provider/iframe_discovery.js +167 -0
  46. package/dest/iframe/provider/iframe_provider.d.ts +65 -0
  47. package/dest/iframe/provider/iframe_provider.d.ts.map +1 -0
  48. package/dest/iframe/provider/iframe_provider.js +257 -0
  49. package/dest/iframe/provider/iframe_wallet.d.ts +68 -0
  50. package/dest/iframe/provider/iframe_wallet.d.ts.map +1 -0
  51. package/dest/iframe/provider/iframe_wallet.js +200 -0
  52. package/dest/iframe/provider/index.d.ts +4 -0
  53. package/dest/iframe/provider/index.d.ts.map +1 -0
  54. package/dest/iframe/provider/index.js +3 -0
  55. package/dest/manager/index.d.ts +2 -7
  56. package/dest/manager/index.d.ts.map +1 -1
  57. package/dest/manager/index.js +0 -4
  58. package/dest/manager/types.d.ts +109 -5
  59. package/dest/manager/types.d.ts.map +1 -1
  60. package/dest/manager/types.js +17 -1
  61. package/dest/manager/wallet_manager.d.ts +50 -7
  62. package/dest/manager/wallet_manager.d.ts.map +1 -1
  63. package/dest/manager/wallet_manager.js +208 -29
  64. package/dest/types.d.ts +135 -0
  65. package/dest/types.d.ts.map +1 -0
  66. package/dest/types.js +15 -0
  67. package/package.json +26 -13
  68. package/src/base-wallet/base_wallet.ts +388 -139
  69. package/src/base-wallet/index.ts +7 -1
  70. package/src/base-wallet/utils.ts +240 -0
  71. package/src/crypto.ts +603 -0
  72. package/src/emoji_alphabet.ts +317 -0
  73. package/src/extension/handlers/background_connection_handler.ts +423 -0
  74. package/src/extension/handlers/content_script_connection_handler.ts +246 -0
  75. package/src/extension/handlers/index.ts +25 -0
  76. package/src/extension/handlers/internal_message_types.ts +69 -0
  77. package/src/extension/provider/extension_provider.ts +233 -0
  78. package/src/extension/provider/extension_wallet.ts +324 -0
  79. package/src/extension/provider/index.ts +7 -0
  80. package/src/iframe/handlers/iframe_connection_handler.ts +328 -0
  81. package/src/iframe/handlers/index.ts +7 -0
  82. package/src/iframe/provider/iframe_discovery.ts +185 -0
  83. package/src/iframe/provider/iframe_provider.ts +331 -0
  84. package/src/iframe/provider/iframe_wallet.ts +229 -0
  85. package/src/iframe/provider/index.ts +3 -0
  86. package/src/manager/index.ts +3 -15
  87. package/src/manager/types.ts +113 -4
  88. package/src/manager/wallet_manager.ts +235 -30
  89. package/src/types.ts +145 -0
  90. package/dest/providers/extension/extension_provider.d.ts +0 -17
  91. package/dest/providers/extension/extension_provider.d.ts.map +0 -1
  92. package/dest/providers/extension/extension_provider.js +0 -56
  93. package/dest/providers/extension/extension_wallet.d.ts +0 -23
  94. package/dest/providers/extension/extension_wallet.d.ts.map +0 -1
  95. package/dest/providers/extension/extension_wallet.js +0 -96
  96. package/dest/providers/extension/index.d.ts +0 -4
  97. package/dest/providers/extension/index.d.ts.map +0 -1
  98. package/dest/providers/types.d.ts +0 -67
  99. package/dest/providers/types.d.ts.map +0 -1
  100. package/dest/providers/types.js +0 -3
  101. package/src/providers/extension/extension_provider.ts +0 -72
  102. package/src/providers/extension/extension_wallet.ts +0 -124
  103. package/src/providers/extension/index.ts +0 -3
  104. package/src/providers/types.ts +0 -71
  105. /package/dest/{providers/extension → extension/provider}/index.js +0 -0
@@ -1,28 +1,38 @@
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';
4
+ import {
5
+ type InteractionWaitOptions,
6
+ NO_WAIT,
7
+ type SendReturn,
8
+ extractOffchainOutput,
9
+ } from '@aztec/aztec.js/contracts';
3
10
  import type { FeePaymentMethod } from '@aztec/aztec.js/fee';
4
- import type {
5
- Aliased,
6
- BatchResults,
7
- BatchableMethods,
8
- BatchedMethod,
9
- ProfileOptions,
10
- SendOptions,
11
- SimulateOptions,
12
- Wallet,
13
- } from '@aztec/aztec.js/wallet';
11
+ import { waitForTx } from '@aztec/aztec.js/node';
14
12
  import {
15
- GAS_ESTIMATION_DA_GAS_LIMIT,
16
- GAS_ESTIMATION_L2_GAS_LIMIT,
17
- GAS_ESTIMATION_TEARDOWN_DA_GAS_LIMIT,
18
- GAS_ESTIMATION_TEARDOWN_L2_GAS_LIMIT,
19
- } 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';
20
28
  import { AccountFeePaymentMethodOptions, type DefaultAccountEntrypointOptions } from '@aztec/entrypoints/account';
29
+ import { DefaultEntrypoint } from '@aztec/entrypoints/default';
21
30
  import type { ChainInfo } from '@aztec/entrypoints/interfaces';
22
- import { Fr } from '@aztec/foundation/fields';
31
+ import { Fr } from '@aztec/foundation/curves/bn254';
23
32
  import { createLogger } from '@aztec/foundation/log';
24
33
  import type { FieldsOf } from '@aztec/foundation/types';
25
- import type { PXE } from '@aztec/pxe/server';
34
+ import { displayDebugLogs } from '@aztec/pxe/client/lazy';
35
+ import type { PXE, PackedPrivateEvent } from '@aztec/pxe/server';
26
36
  import {
27
37
  type ContractArtifact,
28
38
  type EventMetadataDefinition,
@@ -30,29 +40,33 @@ import {
30
40
  decodeFromAbi,
31
41
  } from '@aztec/stdlib/abi';
32
42
  import type { AuthWitness } from '@aztec/stdlib/auth-witness';
33
- import type { AztecAddress } from '@aztec/stdlib/aztec-address';
43
+ import { AztecAddress } from '@aztec/stdlib/aztec-address';
34
44
  import {
35
- type ContractClassMetadata,
36
45
  type ContractInstanceWithAddress,
37
- type ContractMetadata,
46
+ type NodeInfo,
38
47
  computePartialAddress,
39
48
  getContractClassFromArtifact,
40
49
  } from '@aztec/stdlib/contract';
41
50
  import { SimulationError } from '@aztec/stdlib/errors';
42
- import { Gas, GasSettings } from '@aztec/stdlib/gas';
51
+ import { Gas, GasFees, GasSettings, ManaUsageEstimate } from '@aztec/stdlib/gas';
52
+ import {
53
+ computeSiloedPrivateInitializationNullifier,
54
+ computeSiloedPublicInitializationNullifier,
55
+ } from '@aztec/stdlib/hash';
43
56
  import type { AztecNode } from '@aztec/stdlib/interfaces/client';
44
- import type {
45
- TxExecutionRequest,
46
- TxHash,
47
- TxProfileResult,
48
- TxReceipt,
49
- TxSimulationResult,
50
- UtilitySimulationResult,
57
+ import {
58
+ BlockHeader,
59
+ ExecutionPayload,
60
+ type TxExecutionRequest,
61
+ type TxProfileResult,
62
+ type UtilityExecutionResult,
63
+ mergeExecutionPayloads,
51
64
  } from '@aztec/stdlib/tx';
52
- import { ExecutionPayload, mergeExecutionPayloads } from '@aztec/stdlib/tx';
53
65
 
54
66
  import { inspect } from 'util';
55
67
 
68
+ import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simulateViaNode } from './utils.js';
69
+
56
70
  /**
57
71
  * Options to configure fee payment for a transaction
58
72
  */
@@ -63,26 +77,60 @@ export type FeeOptions = {
63
77
  */
64
78
  walletFeePaymentMethod?: FeePaymentMethod;
65
79
  /** Configuration options for the account to properly handle the selected fee payment method */
66
- accountFeePaymentMethodOptions: AccountFeePaymentMethodOptions;
80
+ accountFeePaymentMethodOptions?: AccountFeePaymentMethodOptions;
67
81
  /** The gas settings to use for the transaction */
68
82
  gasSettings: GasSettings;
69
83
  };
70
84
 
85
+ /** Options for `simulateViaEntrypoint`. */
86
+ export type SimulateViaEntrypointOptions = Pick<
87
+ SimulateOptions,
88
+ 'from' | 'additionalScopes' | 'skipTxValidation' | 'skipFeeEnforcement'
89
+ > & {
90
+ /** Fee options for the entrypoint */
91
+ feeOptions: FeeOptions;
92
+ };
93
+
94
+ /** Options for `completeFeeOptions`. */
95
+ export type CompleteFeeOptionsConfig = {
96
+ /** The address where the transaction is being sent from. */
97
+ from: AztecAddress | NoFrom;
98
+ /** The address paying for fees (if any fee payment method is embedded in the execution payload). */
99
+ feePayer?: AztecAddress;
100
+ /** User-provided partial gas settings. */
101
+ gasSettings?: Partial<FieldsOf<GasSettings>>;
102
+ /** If true, returns gas settings with high gas limits for estimation. If false, uses fallback limits. */
103
+ forEstimation?: boolean;
104
+ /**
105
+ * Assumed network congestion level for fee prediction. Controls how aggressively the wallet
106
+ * estimates future fees. Defaults to Limit (worst case) when not specified.
107
+ */
108
+ congestionEstimate?: ManaUsageEstimate;
109
+ };
110
+
71
111
  /**
72
112
  * A base class for Wallet implementations
73
113
  */
74
114
  export abstract class BaseWallet implements Wallet {
75
- protected log = createLogger('wallet-sdk:base_wallet');
76
-
77
- protected baseFeePadding = 0.5;
115
+ protected minFeePadding = 0.5;
78
116
  protected cancellableTransactions = false;
117
+ // A wallet is instantiated for a particular chain, so chain info never changes during its lifetime.
118
+ // We cache it here because getChainInfo is called frequently (every tx simulation, send, auth wit, etc.).
119
+ private nodeInfoPromise: Promise<NodeInfo> | undefined;
79
120
 
80
121
  // Protected because we want to force wallets to instantiate their own PXE.
81
122
  protected constructor(
82
123
  protected readonly pxe: PXE,
83
124
  protected readonly aztecNode: AztecNode,
125
+ protected log = createLogger('wallet-sdk:base_wallet'),
84
126
  ) {}
85
127
 
128
+ protected scopesFrom(from: AztecAddress | NoFrom, additionalScopes: AztecAddress[] = []): AztecAddress[] {
129
+ const allScopes = from === NO_FROM ? additionalScopes : [from, ...additionalScopes];
130
+ const scopeSet = new Set(allScopes.map(address => address.toString()));
131
+ return [...scopeSet].map(AztecAddress.fromString);
132
+ }
133
+
86
134
  protected abstract getAccountFromAddress(address: AztecAddress): Promise<Account>;
87
135
 
88
136
  abstract getAccounts(): Promise<Aliased<AztecAddress>[]>;
@@ -100,39 +148,71 @@ export abstract class BaseWallet implements Wallet {
100
148
  }
101
149
 
102
150
  async getChainInfo(): Promise<ChainInfo> {
103
- const { l1ChainId, rollupVersion } = await this.aztecNode.getNodeInfo();
151
+ if (!this.nodeInfoPromise) {
152
+ this.nodeInfoPromise = this.aztecNode.getNodeInfo();
153
+ }
154
+ const { l1ChainId, rollupVersion } = await this.nodeInfoPromise;
104
155
  return { chainId: new Fr(l1ChainId), version: new Fr(rollupVersion) };
105
156
  }
106
157
 
107
158
  protected async createTxExecutionRequestFromPayloadAndFee(
108
159
  executionPayload: ExecutionPayload,
109
- from: AztecAddress,
160
+ from: AztecAddress | NoFrom,
110
161
  feeOptions: FeeOptions,
111
162
  ): Promise<TxExecutionRequest> {
112
163
  const feeExecutionPayload = await feeOptions.walletFeePaymentMethod?.getExecutionPayload();
113
- const executionOptions: DefaultAccountEntrypointOptions = {
114
- txNonce: Fr.random(),
115
- cancellable: this.cancellableTransactions,
116
- feePaymentMethodOptions: feeOptions.accountFeePaymentMethodOptions,
117
- };
118
164
  const finalExecutionPayload = feeExecutionPayload
119
165
  ? mergeExecutionPayloads([feeExecutionPayload, executionPayload])
120
166
  : executionPayload;
121
- const fromAccount = await this.getAccountFromAddress(from);
122
- return fromAccount.createTxExecutionRequest(finalExecutionPayload, feeOptions.gasSettings, executionOptions);
167
+ const chainInfo = await this.getChainInfo();
168
+
169
+ if (from === NO_FROM) {
170
+ const entrypoint = new DefaultEntrypoint();
171
+ return entrypoint.createTxExecutionRequest(finalExecutionPayload, feeOptions.gasSettings, chainInfo);
172
+ } else {
173
+ const fromAccount = await this.getAccountFromAddress(from);
174
+ const executionOptions: DefaultAccountEntrypointOptions = {
175
+ txNonce: Fr.random(),
176
+ cancellable: this.cancellableTransactions,
177
+ // If from is an address, feeOptions include the way the account contract should handle the fee payment
178
+ feePaymentMethodOptions: feeOptions.accountFeePaymentMethodOptions!,
179
+ };
180
+ return fromAccount.createTxExecutionRequest(
181
+ finalExecutionPayload,
182
+ feeOptions.gasSettings,
183
+ chainInfo,
184
+ executionOptions,
185
+ );
186
+ }
123
187
  }
124
188
 
125
189
  public async createAuthWit(
126
190
  from: AztecAddress,
127
- messageHashOrIntent: Fr | IntentInnerHash | CallIntent,
191
+ messageHashOrIntent: IntentInnerHash | CallIntent,
128
192
  ): Promise<AuthWitness> {
129
193
  const account = await this.getAccountFromAddress(from);
130
- return account.createAuthWit(messageHashOrIntent);
194
+ const chainInfo = await this.getChainInfo();
195
+ return account.createAuthWit(messageHashOrIntent, chainInfo);
131
196
  }
132
197
 
133
- public async batch<const T extends readonly BatchedMethod<keyof BatchableMethods>[]>(
134
- methods: T,
135
- ): Promise<BatchResults<T>> {
198
+ /**
199
+ * Request capabilities from the wallet.
200
+ *
201
+ * This method is wallet-implementation-dependent and must be provided by classes extending BaseWallet.
202
+ * Embedded wallets typically don't support capability-based authorization (no user authorization flow),
203
+ * while external wallets (browser extensions, hardware wallets) implement this to reduce authorization
204
+ * friction by allowing apps to request permissions upfront.
205
+ *
206
+ * TODO: Consider making it abstract so implementing it is a conscious decision. Leaving it as-is
207
+ * while the feature stabilizes.
208
+ *
209
+ * @param _manifest - Application capability manifest declaring what operations the app needs
210
+ */
211
+ public requestCapabilities(_manifest: AppCapabilities): Promise<WalletCapabilities> {
212
+ throw new Error('Not implemented');
213
+ }
214
+
215
+ public async batch<const T extends readonly BatchedMethod[]>(methods: T): Promise<BatchResults<T>> {
136
216
  const results: any[] = [];
137
217
  for (const method of methods) {
138
218
  const { name, args } = method;
@@ -152,31 +232,39 @@ export abstract class BaseWallet implements Wallet {
152
232
 
153
233
  /**
154
234
  * Completes partial user-provided fee options with wallet defaults.
155
- * @param from - The address where the transaction is being sent from
156
- * @param feePayer - The address paying for fees (if any fee payment method is embedded in the execution payload)
157
- * @param gasSettings - User-provided partial gas settings
158
- * @returns - Complete fee options that can be used to create a transaction execution request
235
+ * @param config - Fee completion config.
159
236
  */
160
- protected async completeFeeOptions(
161
- from: AztecAddress,
162
- feePayer?: AztecAddress,
163
- gasSettings?: Partial<FieldsOf<GasSettings>>,
164
- ): Promise<FeeOptions> {
237
+ protected async completeFeeOptions(config: CompleteFeeOptionsConfig): Promise<FeeOptions> {
238
+ const { from, feePayer, gasSettings, forEstimation, congestionEstimate } = config;
165
239
  const maxFeesPerGas =
166
- gasSettings?.maxFeesPerGas ?? (await this.aztecNode.getCurrentBaseFees()).mul(1 + this.baseFeePadding);
240
+ gasSettings?.maxFeesPerGas ?? (await this.getMinFees(congestionEstimate)).mul(1 + this.minFeePadding);
167
241
  let accountFeePaymentMethodOptions;
168
- // The transaction does not include a fee payment method, so we set the flag
169
- // for the account to use its fee juice balance
170
- if (!feePayer) {
171
- accountFeePaymentMethodOptions = AccountFeePaymentMethodOptions.PREEXISTING_FEE_JUICE;
172
- } else {
173
- // The transaction includes fee payment method, so we check if we are the fee payer for it
174
- // (this can only happen if the embedded payment method is FeeJuiceWithClaim)
175
- accountFeePaymentMethodOptions = from.equals(feePayer)
176
- ? AccountFeePaymentMethodOptions.FEE_JUICE_WITH_CLAIM
177
- : AccountFeePaymentMethodOptions.EXTERNAL;
242
+ // If from is an address, we need to determine the appropriate fee payment method options for the
243
+ // account contract entrypoint to use
244
+ if (from !== NO_FROM) {
245
+ if (!feePayer) {
246
+ // The transaction does not include a fee payment method, so we set the flag
247
+ // for the account to use its fee juice balance
248
+ accountFeePaymentMethodOptions = AccountFeePaymentMethodOptions.PREEXISTING_FEE_JUICE;
249
+ } else {
250
+ // The transaction includes fee payment method, so we check if we are the fee payer for it
251
+ // (this can only happen if the embedded payment method is FeeJuiceWithClaim)
252
+ accountFeePaymentMethodOptions = from.equals(feePayer)
253
+ ? AccountFeePaymentMethodOptions.FEE_JUICE_WITH_CLAIM
254
+ : AccountFeePaymentMethodOptions.EXTERNAL;
255
+ }
178
256
  }
179
- const fullGasSettings: GasSettings = GasSettings.default({ ...gasSettings, maxFeesPerGas });
257
+ const gasSettingsOverrides = {
258
+ gasLimits: gasSettings?.gasLimits ? Gas.from(gasSettings.gasLimits) : undefined,
259
+ teardownGasLimits: gasSettings?.teardownGasLimits ? Gas.from(gasSettings.teardownGasLimits) : undefined,
260
+ maxFeesPerGas,
261
+ maxPriorityFeesPerGas: gasSettings?.maxPriorityFeesPerGas ?? GasFees.empty(),
262
+ };
263
+ // When estimating gas (simulation), use high limits so the simulation doesn't run out of gas.
264
+ // When sending for real, use protocol max limits that the network will actually accept.
265
+ const fullGasSettings = forEstimation
266
+ ? GasSettings.forEstimation(gasSettingsOverrides)
267
+ : GasSettings.fallback(gasSettingsOverrides);
180
268
  this.log.debug(`Using L2 gas settings`, fullGasSettings);
181
269
  return {
182
270
  gasSettings: fullGasSettings,
@@ -186,34 +274,25 @@ export abstract class BaseWallet implements Wallet {
186
274
  }
187
275
 
188
276
  /**
189
- * Completes partial user-provided fee options with unreasonably high gas limits
190
- * for gas estimation. Uses the same logic as completeFeeOptions but sets high limits
191
- * to avoid running out of gas during estimation.
192
- * @param from - The address where the transaction is being sent from
193
- * @param feePayer - The address paying for fees (if any fee payment method is embedded in the execution payload)
194
- * @param gasSettings - User-provided partial gas settings
277
+ * Returns the worst-case min fee across predicted future slots.
278
+ * Falls back to getCurrentMinFees if the node doesn't support getPredictedMinFees.
279
+ * @param estimate - The mana usage estimate to use for fee prediction. Defaults to Limit for conservative estimation.
195
280
  */
196
- protected async completeFeeOptionsForEstimation(
197
- from: AztecAddress,
198
- feePayer?: AztecAddress,
199
- gasSettings?: Partial<FieldsOf<GasSettings>>,
200
- ) {
201
- const defaultFeeOptions = await this.completeFeeOptions(from, feePayer, gasSettings);
202
- const {
203
- gasSettings: { maxFeesPerGas, maxPriorityFeesPerGas },
204
- } = defaultFeeOptions;
205
- // Use unrealistically high gas limits for estimation to avoid running out of gas.
206
- // They will be tuned down after the simulation.
207
- const gasSettingsForEstimation = new GasSettings(
208
- new Gas(GAS_ESTIMATION_DA_GAS_LIMIT, GAS_ESTIMATION_L2_GAS_LIMIT),
209
- new Gas(GAS_ESTIMATION_TEARDOWN_DA_GAS_LIMIT, GAS_ESTIMATION_TEARDOWN_L2_GAS_LIMIT),
210
- maxFeesPerGas,
211
- maxPriorityFeesPerGas,
212
- );
213
- return {
214
- ...defaultFeeOptions,
215
- gasSettings: gasSettingsForEstimation,
216
- };
281
+ protected async getMinFees(estimate: ManaUsageEstimate = ManaUsageEstimate.Limit): Promise<GasFees> {
282
+ try {
283
+ const predicted = await this.aztecNode.getPredictedMinFees(estimate);
284
+ if (predicted.length === 0) {
285
+ return this.aztecNode.getCurrentMinFees();
286
+ }
287
+ return predicted.reduce((worst, fees) => (fees.feePerL2Gas > worst.feePerL2Gas ? fees : worst));
288
+ } catch (err: any) {
289
+ // Fallback for old nodes that don't support getPredictedMinFees.
290
+ // Only fall back on method-not-found errors (JSON-RPC code -32601); rethrow others.
291
+ if (err?.cause?.code === -32601 || err?.message?.includes('Method not found')) {
292
+ return this.aztecNode.getCurrentMinFees();
293
+ }
294
+ throw err;
295
+ }
217
296
  }
218
297
 
219
298
  registerSender(address: AztecAddress, _alias: string = ''): Promise<AztecAddress> {
@@ -225,7 +304,7 @@ export abstract class BaseWallet implements Wallet {
225
304
  artifact?: ContractArtifact,
226
305
  secretKey?: Fr,
227
306
  ): Promise<ContractInstanceWithAddress> {
228
- const { contractInstance: existingInstance } = await this.pxe.getContractMetadata(instance.address);
307
+ const existingInstance = await this.pxe.getContractInstance(instance.address);
229
308
 
230
309
  if (existingInstance) {
231
310
  // Instance already registered in the wallet
@@ -242,13 +321,12 @@ export abstract class BaseWallet implements Wallet {
242
321
  // Instance not registered yet
243
322
  if (!artifact) {
244
323
  // Try to get the artifact from the wallet's contract class storage
245
- const classMetadata = await this.pxe.getContractClassMetadata(instance.currentContractClassId, true);
246
- if (!classMetadata.artifact) {
324
+ artifact = await this.pxe.getContractArtifact(instance.currentContractClassId);
325
+ if (!artifact) {
247
326
  throw new Error(
248
327
  `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()}`,
249
328
  );
250
329
  }
251
- artifact = classMetadata.artifact;
252
330
  }
253
331
  await this.pxe.registerContract({ artifact, instance });
254
332
  }
@@ -259,29 +337,132 @@ export abstract class BaseWallet implements Wallet {
259
337
  return instance;
260
338
  }
261
339
 
262
- async simulateTx(executionPayload: ExecutionPayload, opts: SimulateOptions): Promise<TxSimulationResult> {
263
- const feeOptions = opts.fee?.estimateGas
264
- ? await this.completeFeeOptionsForEstimation(opts.from, executionPayload.feePayer, opts.fee?.gasSettings)
265
- : await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
266
- const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
267
- return this.pxe.simulateTx(
268
- txRequest,
269
- true /* simulatePublic */,
270
- opts?.skipTxValidation,
271
- opts?.skipFeeEnforcement ?? true,
340
+ /**
341
+ * Simulates calls through the standard PXE path (account entrypoint).
342
+ * @param executionPayload - The execution payload to simulate.
343
+ * @param opts - Simulation options.
344
+ */
345
+ protected async simulateViaEntrypoint(executionPayload: ExecutionPayload, opts: SimulateViaEntrypointOptions) {
346
+ const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(
347
+ executionPayload,
348
+ opts.from,
349
+ opts.feeOptions,
272
350
  );
351
+ const result = await this.pxe.simulateTx(txRequest, {
352
+ simulatePublic: true,
353
+ skipTxValidation: opts.skipTxValidation,
354
+ skipFeeEnforcement: opts.skipFeeEnforcement,
355
+ scopes: this.scopesFrom(opts.from, opts.additionalScopes),
356
+ });
357
+ const appCallOffset = await this.computeAppCallOffset(opts.from, opts.feeOptions);
358
+ return TxSimulationResultWithAppOffset.fromResultAndOffset(result, appCallOffset);
359
+ }
360
+
361
+ /**
362
+ * Computes the index where the app's calls begin in the flattened array of calls (0 = entrypoint/root, 1..N = fee
363
+ * calls, N+1 = app).
364
+ * @param from - The sender address, or NO_FROM for the default entrypoint.
365
+ * @param feeOptions - Fee options containing the wallet fee payment method.
366
+ */
367
+ protected async computeAppCallOffset(from: AztecAddress | NoFrom, feeOptions: FeeOptions): Promise<number> {
368
+ if (from === NO_FROM) {
369
+ return 0;
370
+ }
371
+ const feeExecutionPayload = await feeOptions.walletFeePaymentMethod?.getExecutionPayload();
372
+ return (feeExecutionPayload?.calls.length ?? 0) + 1; // +1 for entrypoint
373
+ }
374
+
375
+ /**
376
+ * Simulates a transaction, optimizing leading public static calls by running them directly
377
+ * on the node while sending the remaining calls through the standard PXE path.
378
+ * Return values from both paths are merged back in original call order.
379
+ * @param executionPayload - The execution payload to simulate.
380
+ * @param opts - Simulation options (from address, fee settings, etc.).
381
+ * @returns The merged simulation result.
382
+ */
383
+ async simulateTx(
384
+ executionPayload: ExecutionPayload,
385
+ opts: SimulateOptions,
386
+ ): Promise<TxSimulationResultWithAppOffset> {
387
+ const feeOptions = await this.completeFeeOptions({
388
+ from: opts.from,
389
+ feePayer: executionPayload.feePayer,
390
+ gasSettings: opts.fee?.gasSettings,
391
+ forEstimation: true,
392
+ congestionEstimate: opts.fee?.congestionEstimate,
393
+ });
394
+ const { optimizableCalls, remainingCalls } = extractOptimizablePublicStaticCalls(executionPayload);
395
+ const remainingPayload = { ...executionPayload, calls: remainingCalls };
396
+
397
+ const chainInfo = await this.getChainInfo();
398
+ let blockHeader: BlockHeader;
399
+ // PXE might not be synced yet, so we pull the latest header from the node
400
+ // To keep things consistent, we'll always try with PXE first
401
+ try {
402
+ blockHeader = await this.pxe.getSyncedBlockHeader();
403
+ } catch {
404
+ blockHeader = (await this.aztecNode.getBlockHeader())!;
405
+ }
406
+
407
+ const simulationOrigin = opts.from === NO_FROM ? AztecAddress.ZERO : opts.from;
408
+ const [optimizedResults, normalResult] = await Promise.all([
409
+ optimizableCalls.length > 0
410
+ ? simulateViaNode(
411
+ this.aztecNode,
412
+ optimizableCalls,
413
+ simulationOrigin,
414
+ chainInfo,
415
+ feeOptions.gasSettings,
416
+ blockHeader,
417
+ opts.skipFeeEnforcement ?? true,
418
+ this.getContractName.bind(this),
419
+ )
420
+ : Promise.resolve([]),
421
+ remainingCalls.length > 0
422
+ ? this.simulateViaEntrypoint(remainingPayload, {
423
+ from: opts.from,
424
+ feeOptions,
425
+ additionalScopes: opts.additionalScopes,
426
+ skipTxValidation: opts.skipTxValidation,
427
+ skipFeeEnforcement: opts.skipFeeEnforcement ?? true,
428
+ })
429
+ : Promise.resolve(null),
430
+ ]);
431
+
432
+ return buildMergedSimulationResult(optimizedResults, normalResult);
273
433
  }
274
434
 
275
435
  async profileTx(executionPayload: ExecutionPayload, opts: ProfileOptions): Promise<TxProfileResult> {
276
- const feeOptions = await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
436
+ const feeOptions = await this.completeFeeOptions({
437
+ from: opts.from,
438
+ feePayer: executionPayload.feePayer,
439
+ gasSettings: opts.fee?.gasSettings,
440
+ congestionEstimate: opts.fee?.congestionEstimate,
441
+ });
277
442
  const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
278
- return this.pxe.profileTx(txRequest, opts.profileMode, opts.skipProofGeneration ?? true);
443
+ return this.pxe.profileTx(txRequest, {
444
+ profileMode: opts.profileMode,
445
+ skipProofGeneration: opts.skipProofGeneration ?? true,
446
+ scopes: this.scopesFrom(opts.from, opts.additionalScopes),
447
+ });
279
448
  }
280
449
 
281
- async sendTx(executionPayload: ExecutionPayload, opts: SendOptions): Promise<TxHash> {
282
- const feeOptions = await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
450
+ public async sendTx<W extends InteractionWaitOptions = undefined>(
451
+ executionPayload: ExecutionPayload,
452
+ opts: SendOptions<W>,
453
+ ): Promise<SendReturn<W>> {
454
+ const feeOptions = await this.completeFeeOptions({
455
+ from: opts.from,
456
+ feePayer: executionPayload.feePayer,
457
+ gasSettings: opts.fee?.gasSettings,
458
+ congestionEstimate: opts.fee?.congestionEstimate,
459
+ });
283
460
  const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
284
- const provenTx = await this.pxe.proveTx(txRequest);
461
+ const provenTx = await this.pxe.proveTx(txRequest, this.scopesFrom(opts.from, opts.additionalScopes));
462
+ const offchainOutput = extractOffchainOutput(
463
+ provenTx.getOffchainEffects(),
464
+ provenTx.publicInputs.constants.anchorBlockHeader.globalVariables.timestamp,
465
+ );
285
466
  const tx = await provenTx.toTx();
286
467
  const txHash = tx.getTxHash();
287
468
  if (await this.aztecNode.getTxEffect(txHash)) {
@@ -292,7 +473,35 @@ export abstract class BaseWallet implements Wallet {
292
473
  throw this.contextualizeError(err, inspect(tx));
293
474
  });
294
475
  this.log.info(`Sent transaction ${txHash}`);
295
- return txHash;
476
+
477
+ // If wait is NO_WAIT, return txHash immediately
478
+ if (opts.wait === NO_WAIT) {
479
+ return { txHash, ...offchainOutput } as SendReturn<W>;
480
+ }
481
+
482
+ // Otherwise, wait for the full receipt (default behavior on wait: undefined)
483
+ const waitOpts = typeof opts.wait === 'object' ? opts.wait : undefined;
484
+ const receipt = await waitForTx(this.aztecNode, txHash, waitOpts);
485
+
486
+ // Display debug logs from public execution if present (served in test mode only)
487
+ if (receipt.debugLogs?.length) {
488
+ await displayDebugLogs(receipt.debugLogs, this.getContractName.bind(this));
489
+ }
490
+
491
+ return { receipt, ...offchainOutput } as SendReturn<W>;
492
+ }
493
+
494
+ /**
495
+ * Resolves a contract address to a human-readable name via PXE, if available.
496
+ * @param address - The contract address to resolve.
497
+ */
498
+ protected async getContractName(address: AztecAddress): Promise<string | undefined> {
499
+ const instance = await this.pxe.getContractInstance(address);
500
+ if (!instance) {
501
+ return undefined;
502
+ }
503
+ const artifact = await this.pxe.getContractArtifact(instance.currentContractClassId);
504
+ return artifact?.name;
296
505
  }
297
506
 
298
507
  protected contextualizeError(err: Error, ...context: string[]): Error {
@@ -309,34 +518,74 @@ export abstract class BaseWallet implements Wallet {
309
518
  return err;
310
519
  }
311
520
 
312
- simulateUtility(call: FunctionCall, authwits?: AuthWitness[]): Promise<UtilitySimulationResult> {
313
- return this.pxe.simulateUtility(call, authwits);
314
- }
315
-
316
- getContractClassMetadata(id: Fr, includeArtifact: boolean = false): Promise<ContractClassMetadata> {
317
- return this.pxe.getContractClassMetadata(id, includeArtifact);
318
- }
319
- getContractMetadata(address: AztecAddress): Promise<ContractMetadata> {
320
- return this.pxe.getContractMetadata(address);
321
- }
322
-
323
- getTxReceipt(txHash: TxHash): Promise<TxReceipt> {
324
- return this.aztecNode.getTxReceipt(txHash);
521
+ executeUtility(call: FunctionCall, opts: ExecuteUtilityOptions): Promise<UtilityExecutionResult> {
522
+ return this.pxe.executeUtility(call, { authwits: opts.authWitnesses, scopes: opts.scopes });
325
523
  }
326
524
 
327
525
  async getPrivateEvents<T>(
328
- contractAddress: AztecAddress,
329
526
  eventDef: EventMetadataDefinition,
330
- from: number,
331
- limit: number,
332
- recipients: AztecAddress[] = [],
333
- ): Promise<T[]> {
334
- const events = await this.pxe.getPrivateEvents(contractAddress, eventDef.eventSelector, from, limit, recipients);
335
-
336
- const decodedEvents = events.map(
337
- (event: any /** PrivateEvent */): T => decodeFromAbi([eventDef.abiType], event.packedEvent) as T,
338
- );
527
+ eventFilter: PrivateEventFilter,
528
+ ): Promise<PrivateEvent<T>[]> {
529
+ const pxeEvents = await this.pxe.getPrivateEvents(eventDef.eventSelector, eventFilter);
530
+
531
+ const decodedEvents = pxeEvents.map((pxeEvent: PackedPrivateEvent): PrivateEvent<T> => {
532
+ return {
533
+ event: decodeFromAbi([eventDef.abiType], pxeEvent.packedEvent) as T,
534
+ metadata: {
535
+ l2BlockNumber: pxeEvent.l2BlockNumber,
536
+ l2BlockHash: pxeEvent.l2BlockHash,
537
+ txHash: pxeEvent.txHash,
538
+ },
539
+ };
540
+ });
339
541
 
340
542
  return decodedEvents;
341
543
  }
544
+
545
+ /**
546
+ * Returns metadata about a contract, including whether it has been initialized, published, and updated.
547
+ * @param address - The contract address to query.
548
+ */
549
+ async getContractMetadata(address: AztecAddress) {
550
+ const instance = await this.pxe.getContractInstance(address);
551
+ const publiclyRegisteredContractPromise = this.aztecNode.getContract(address);
552
+
553
+ let initializationStatus: ContractInitializationStatus;
554
+ if (instance) {
555
+ // We have the instance, so we can compute the private initialization nullifier (which includes init_hash and is
556
+ // emitted by both private and public initializers) and get a definitive INITIALIZED/UNINITIALIZED answer.
557
+ const initNullifier = await computeSiloedPrivateInitializationNullifier(address, instance.initializationHash);
558
+ const witness = await this.aztecNode.getNullifierMembershipWitness('latest', initNullifier);
559
+ initializationStatus = witness
560
+ ? ContractInitializationStatus.INITIALIZED
561
+ : ContractInitializationStatus.UNINITIALIZED;
562
+ } else {
563
+ // Without the instance we lack the init_hash needed for the private nullifier. We fall back to checking the
564
+ // public initialization nullifier (computed from address alone). Not all contracts emit it (only those with
565
+ // public functions that require initialization checks), so its absence doesn't mean the contract is
566
+ // uninitialized.
567
+ const publicNullifier = await computeSiloedPublicInitializationNullifier(address);
568
+ const witness = await this.aztecNode.getNullifierMembershipWitness('latest', publicNullifier);
569
+ initializationStatus = witness ? ContractInitializationStatus.INITIALIZED : ContractInitializationStatus.UNKNOWN;
570
+ }
571
+ const publiclyRegisteredContract = await publiclyRegisteredContractPromise;
572
+ const isContractUpdated =
573
+ publiclyRegisteredContract &&
574
+ !publiclyRegisteredContract.currentContractClassId.equals(publiclyRegisteredContract.originalContractClassId);
575
+ return {
576
+ instance: instance ?? undefined,
577
+ initializationStatus,
578
+ isContractPublished: !!publiclyRegisteredContract,
579
+ isContractUpdated: !!isContractUpdated,
580
+ updatedContractClassId: isContractUpdated ? publiclyRegisteredContract.currentContractClassId : undefined,
581
+ };
582
+ }
583
+
584
+ async getContractClassMetadata(id: Fr) {
585
+ const publiclyRegisteredContractClass = await this.aztecNode.getContractClass(id);
586
+ return {
587
+ isArtifactRegistered: !!(await this.pxe.getContractArtifact(id)),
588
+ isContractClassPubliclyRegistered: !!publiclyRegisteredContractClass,
589
+ };
590
+ }
342
591
  }