@aztec/wallet-sdk 0.0.1-commit.fce3e4f → 0.0.1-commit.ffe5b04ea
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.
- package/README.md +228 -331
- package/dest/base-wallet/base_wallet.d.ts +64 -16
- package/dest/base-wallet/base_wallet.d.ts.map +1 -1
- package/dest/base-wallet/base_wallet.js +165 -33
- package/dest/base-wallet/index.d.ts +2 -1
- package/dest/base-wallet/index.d.ts.map +1 -1
- package/dest/base-wallet/index.js +1 -0
- package/dest/base-wallet/utils.d.ts +49 -0
- package/dest/base-wallet/utils.d.ts.map +1 -0
- package/dest/base-wallet/utils.js +131 -0
- package/dest/crypto.d.ts +192 -0
- package/dest/crypto.d.ts.map +1 -0
- package/dest/crypto.js +394 -0
- package/dest/emoji_alphabet.d.ts +35 -0
- package/dest/emoji_alphabet.d.ts.map +1 -0
- package/dest/emoji_alphabet.js +299 -0
- package/dest/extension/handlers/background_connection_handler.d.ts +158 -0
- package/dest/extension/handlers/background_connection_handler.d.ts.map +1 -0
- package/dest/extension/handlers/background_connection_handler.js +258 -0
- package/dest/extension/handlers/content_script_connection_handler.d.ts +56 -0
- package/dest/extension/handlers/content_script_connection_handler.d.ts.map +1 -0
- package/dest/extension/handlers/content_script_connection_handler.js +174 -0
- package/dest/extension/handlers/index.d.ts +12 -0
- package/dest/extension/handlers/index.d.ts.map +1 -0
- package/dest/extension/handlers/index.js +10 -0
- package/dest/extension/handlers/internal_message_types.d.ts +63 -0
- package/dest/extension/handlers/internal_message_types.d.ts.map +1 -0
- package/dest/extension/handlers/internal_message_types.js +22 -0
- package/dest/extension/provider/extension_provider.d.ts +107 -0
- package/dest/extension/provider/extension_provider.d.ts.map +1 -0
- package/dest/extension/provider/extension_provider.js +160 -0
- package/dest/extension/provider/extension_wallet.d.ts +132 -0
- package/dest/extension/provider/extension_wallet.d.ts.map +1 -0
- package/dest/extension/provider/extension_wallet.js +278 -0
- package/dest/extension/provider/index.d.ts +3 -0
- package/dest/extension/provider/index.d.ts.map +1 -0
- package/dest/manager/index.d.ts +2 -7
- package/dest/manager/index.d.ts.map +1 -1
- package/dest/manager/index.js +0 -4
- package/dest/manager/types.d.ts +108 -5
- package/dest/manager/types.d.ts.map +1 -1
- package/dest/manager/types.js +17 -1
- package/dest/manager/wallet_manager.d.ts +50 -7
- package/dest/manager/wallet_manager.d.ts.map +1 -1
- package/dest/manager/wallet_manager.js +178 -29
- package/dest/types.d.ts +123 -0
- package/dest/types.d.ts.map +1 -0
- package/dest/types.js +11 -0
- package/package.json +22 -13
- package/src/base-wallet/base_wallet.ts +213 -60
- package/src/base-wallet/index.ts +1 -0
- package/src/base-wallet/utils.ts +238 -0
- package/src/crypto.ts +499 -0
- package/src/emoji_alphabet.ts +317 -0
- package/src/extension/handlers/background_connection_handler.ts +423 -0
- package/src/extension/handlers/content_script_connection_handler.ts +246 -0
- package/src/extension/handlers/index.ts +25 -0
- package/src/extension/handlers/internal_message_types.ts +69 -0
- package/src/extension/provider/extension_provider.ts +233 -0
- package/src/extension/provider/extension_wallet.ts +329 -0
- package/src/extension/provider/index.ts +7 -0
- package/src/manager/index.ts +3 -15
- package/src/manager/types.ts +112 -4
- package/src/manager/wallet_manager.ts +202 -31
- package/src/types.ts +132 -0
- package/dest/providers/extension/extension_provider.d.ts +0 -17
- package/dest/providers/extension/extension_provider.d.ts.map +0 -1
- package/dest/providers/extension/extension_provider.js +0 -56
- package/dest/providers/extension/extension_wallet.d.ts +0 -23
- package/dest/providers/extension/extension_wallet.d.ts.map +0 -1
- package/dest/providers/extension/extension_wallet.js +0 -96
- package/dest/providers/extension/index.d.ts +0 -4
- package/dest/providers/extension/index.d.ts.map +0 -1
- package/dest/providers/types.d.ts +0 -67
- package/dest/providers/types.d.ts.map +0 -1
- package/dest/providers/types.js +0 -3
- package/src/providers/extension/extension_provider.ts +0 -72
- package/src/providers/extension/extension_wallet.ts +0 -124
- package/src/providers/extension/index.ts +0 -3
- package/src/providers/types.ts +0 -71
- /package/dest/{providers/extension → extension/provider}/index.js +0 -0
|
@@ -1,15 +1,26 @@
|
|
|
1
1
|
import type { Account } from '@aztec/aztec.js/account';
|
|
2
2
|
import type { CallIntent, IntentInnerHash } from '@aztec/aztec.js/authorization';
|
|
3
|
+
import {
|
|
4
|
+
type InteractionWaitOptions,
|
|
5
|
+
NO_WAIT,
|
|
6
|
+
type SendReturn,
|
|
7
|
+
extractOffchainOutput,
|
|
8
|
+
} from '@aztec/aztec.js/contracts';
|
|
3
9
|
import type { FeePaymentMethod } from '@aztec/aztec.js/fee';
|
|
10
|
+
import { waitForTx } from '@aztec/aztec.js/node';
|
|
4
11
|
import type {
|
|
5
12
|
Aliased,
|
|
13
|
+
AppCapabilities,
|
|
6
14
|
BatchResults,
|
|
7
|
-
BatchableMethods,
|
|
8
15
|
BatchedMethod,
|
|
16
|
+
ExecuteUtilityOptions,
|
|
17
|
+
PrivateEvent,
|
|
18
|
+
PrivateEventFilter,
|
|
9
19
|
ProfileOptions,
|
|
10
20
|
SendOptions,
|
|
11
21
|
SimulateOptions,
|
|
12
22
|
Wallet,
|
|
23
|
+
WalletCapabilities,
|
|
13
24
|
} from '@aztec/aztec.js/wallet';
|
|
14
25
|
import {
|
|
15
26
|
GAS_ESTIMATION_DA_GAS_LIMIT,
|
|
@@ -19,10 +30,11 @@ import {
|
|
|
19
30
|
} from '@aztec/constants';
|
|
20
31
|
import { AccountFeePaymentMethodOptions, type DefaultAccountEntrypointOptions } from '@aztec/entrypoints/account';
|
|
21
32
|
import type { ChainInfo } from '@aztec/entrypoints/interfaces';
|
|
22
|
-
import { Fr } from '@aztec/foundation/
|
|
33
|
+
import { Fr } from '@aztec/foundation/curves/bn254';
|
|
23
34
|
import { createLogger } from '@aztec/foundation/log';
|
|
24
35
|
import type { FieldsOf } from '@aztec/foundation/types';
|
|
25
|
-
import type
|
|
36
|
+
import { type AccessScopes, displayDebugLogs } from '@aztec/pxe/client/lazy';
|
|
37
|
+
import type { PXE, PackedPrivateEvent } from '@aztec/pxe/server';
|
|
26
38
|
import {
|
|
27
39
|
type ContractArtifact,
|
|
28
40
|
type EventMetadataDefinition,
|
|
@@ -30,29 +42,29 @@ import {
|
|
|
30
42
|
decodeFromAbi,
|
|
31
43
|
} from '@aztec/stdlib/abi';
|
|
32
44
|
import type { AuthWitness } from '@aztec/stdlib/auth-witness';
|
|
33
|
-
import
|
|
45
|
+
import { AztecAddress } from '@aztec/stdlib/aztec-address';
|
|
34
46
|
import {
|
|
35
|
-
type ContractClassMetadata,
|
|
36
47
|
type ContractInstanceWithAddress,
|
|
37
|
-
type ContractMetadata,
|
|
38
48
|
computePartialAddress,
|
|
39
49
|
getContractClassFromArtifact,
|
|
40
50
|
} from '@aztec/stdlib/contract';
|
|
41
51
|
import { SimulationError } from '@aztec/stdlib/errors';
|
|
42
52
|
import { Gas, GasSettings } from '@aztec/stdlib/gas';
|
|
53
|
+
import { siloNullifier } from '@aztec/stdlib/hash';
|
|
43
54
|
import type { AztecNode } from '@aztec/stdlib/interfaces/client';
|
|
44
|
-
import
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
TxProfileResult,
|
|
48
|
-
TxReceipt,
|
|
55
|
+
import {
|
|
56
|
+
BlockHeader,
|
|
57
|
+
type TxExecutionRequest,
|
|
58
|
+
type TxProfileResult,
|
|
49
59
|
TxSimulationResult,
|
|
50
|
-
|
|
60
|
+
type UtilityExecutionResult,
|
|
51
61
|
} from '@aztec/stdlib/tx';
|
|
52
62
|
import { ExecutionPayload, mergeExecutionPayloads } from '@aztec/stdlib/tx';
|
|
53
63
|
|
|
54
64
|
import { inspect } from 'util';
|
|
55
65
|
|
|
66
|
+
import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simulateViaNode } from './utils.js';
|
|
67
|
+
|
|
56
68
|
/**
|
|
57
69
|
* Options to configure fee payment for a transaction
|
|
58
70
|
*/
|
|
@@ -72,17 +84,22 @@ export type FeeOptions = {
|
|
|
72
84
|
* A base class for Wallet implementations
|
|
73
85
|
*/
|
|
74
86
|
export abstract class BaseWallet implements Wallet {
|
|
75
|
-
protected
|
|
76
|
-
|
|
77
|
-
protected baseFeePadding = 0.5;
|
|
87
|
+
protected minFeePadding = 0.5;
|
|
78
88
|
protected cancellableTransactions = false;
|
|
79
89
|
|
|
80
90
|
// Protected because we want to force wallets to instantiate their own PXE.
|
|
81
91
|
protected constructor(
|
|
82
92
|
protected readonly pxe: PXE,
|
|
83
93
|
protected readonly aztecNode: AztecNode,
|
|
94
|
+
protected log = createLogger('wallet-sdk:base_wallet'),
|
|
84
95
|
) {}
|
|
85
96
|
|
|
97
|
+
protected scopesFrom(from: AztecAddress, additionalScopes: AztecAddress[] = []): AztecAddress[] {
|
|
98
|
+
const allScopes = from.isZero() ? additionalScopes : [from, ...additionalScopes];
|
|
99
|
+
const scopeSet = new Set(allScopes.map(address => address.toString()));
|
|
100
|
+
return [...scopeSet].map(AztecAddress.fromString);
|
|
101
|
+
}
|
|
102
|
+
|
|
86
103
|
protected abstract getAccountFromAddress(address: AztecAddress): Promise<Account>;
|
|
87
104
|
|
|
88
105
|
abstract getAccounts(): Promise<Aliased<AztecAddress>[]>;
|
|
@@ -119,20 +136,42 @@ export abstract class BaseWallet implements Wallet {
|
|
|
119
136
|
? mergeExecutionPayloads([feeExecutionPayload, executionPayload])
|
|
120
137
|
: executionPayload;
|
|
121
138
|
const fromAccount = await this.getAccountFromAddress(from);
|
|
122
|
-
|
|
139
|
+
const chainInfo = await this.getChainInfo();
|
|
140
|
+
return fromAccount.createTxExecutionRequest(
|
|
141
|
+
finalExecutionPayload,
|
|
142
|
+
feeOptions.gasSettings,
|
|
143
|
+
chainInfo,
|
|
144
|
+
executionOptions,
|
|
145
|
+
);
|
|
123
146
|
}
|
|
124
147
|
|
|
125
148
|
public async createAuthWit(
|
|
126
149
|
from: AztecAddress,
|
|
127
|
-
messageHashOrIntent:
|
|
150
|
+
messageHashOrIntent: IntentInnerHash | CallIntent,
|
|
128
151
|
): Promise<AuthWitness> {
|
|
129
152
|
const account = await this.getAccountFromAddress(from);
|
|
130
|
-
|
|
153
|
+
const chainInfo = await this.getChainInfo();
|
|
154
|
+
return account.createAuthWit(messageHashOrIntent, chainInfo);
|
|
131
155
|
}
|
|
132
156
|
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
157
|
+
/**
|
|
158
|
+
* Request capabilities from the wallet.
|
|
159
|
+
*
|
|
160
|
+
* This method is wallet-implementation-dependent and must be provided by classes extending BaseWallet.
|
|
161
|
+
* Embedded wallets typically don't support capability-based authorization (no user authorization flow),
|
|
162
|
+
* while external wallets (browser extensions, hardware wallets) implement this to reduce authorization
|
|
163
|
+
* friction by allowing apps to request permissions upfront.
|
|
164
|
+
*
|
|
165
|
+
* TODO: Consider making it abstract so implementing it is a conscious decision. Leaving it as-is
|
|
166
|
+
* while the feature stabilizes.
|
|
167
|
+
*
|
|
168
|
+
* @param _manifest - Application capability manifest declaring what operations the app needs
|
|
169
|
+
*/
|
|
170
|
+
public requestCapabilities(_manifest: AppCapabilities): Promise<WalletCapabilities> {
|
|
171
|
+
throw new Error('Not implemented');
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
public async batch<const T extends readonly BatchedMethod[]>(methods: T): Promise<BatchResults<T>> {
|
|
136
175
|
const results: any[] = [];
|
|
137
176
|
for (const method of methods) {
|
|
138
177
|
const { name, args } = method;
|
|
@@ -163,7 +202,7 @@ export abstract class BaseWallet implements Wallet {
|
|
|
163
202
|
gasSettings?: Partial<FieldsOf<GasSettings>>,
|
|
164
203
|
): Promise<FeeOptions> {
|
|
165
204
|
const maxFeesPerGas =
|
|
166
|
-
gasSettings?.maxFeesPerGas ?? (await this.aztecNode.
|
|
205
|
+
gasSettings?.maxFeesPerGas ?? (await this.aztecNode.getCurrentMinFees()).mul(1 + this.minFeePadding);
|
|
167
206
|
let accountFeePaymentMethodOptions;
|
|
168
207
|
// The transaction does not include a fee payment method, so we set the flag
|
|
169
208
|
// for the account to use its fee juice balance
|
|
@@ -225,7 +264,7 @@ export abstract class BaseWallet implements Wallet {
|
|
|
225
264
|
artifact?: ContractArtifact,
|
|
226
265
|
secretKey?: Fr,
|
|
227
266
|
): Promise<ContractInstanceWithAddress> {
|
|
228
|
-
const
|
|
267
|
+
const existingInstance = await this.pxe.getContractInstance(instance.address);
|
|
229
268
|
|
|
230
269
|
if (existingInstance) {
|
|
231
270
|
// Instance already registered in the wallet
|
|
@@ -242,13 +281,12 @@ export abstract class BaseWallet implements Wallet {
|
|
|
242
281
|
// Instance not registered yet
|
|
243
282
|
if (!artifact) {
|
|
244
283
|
// Try to get the artifact from the wallet's contract class storage
|
|
245
|
-
|
|
246
|
-
if (!
|
|
284
|
+
artifact = await this.pxe.getContractArtifact(instance.currentContractClassId);
|
|
285
|
+
if (!artifact) {
|
|
247
286
|
throw new Error(
|
|
248
287
|
`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
288
|
);
|
|
250
289
|
}
|
|
251
|
-
artifact = classMetadata.artifact;
|
|
252
290
|
}
|
|
253
291
|
await this.pxe.registerContract({ artifact, instance });
|
|
254
292
|
}
|
|
@@ -259,29 +297,98 @@ export abstract class BaseWallet implements Wallet {
|
|
|
259
297
|
return instance;
|
|
260
298
|
}
|
|
261
299
|
|
|
300
|
+
/**
|
|
301
|
+
* Simulates calls through the standard PXE path (account entrypoint).
|
|
302
|
+
* @param executionPayload - The execution payload to simulate.
|
|
303
|
+
* @param from - The sender address.
|
|
304
|
+
* @param feeOptions - Fee options for the transaction.
|
|
305
|
+
* @param skipTxValidation - Whether to skip tx validation.
|
|
306
|
+
* @param skipFeeEnforcement - Whether to skip fee enforcement.
|
|
307
|
+
* @param scopes - The scopes to use for the simulation.
|
|
308
|
+
*/
|
|
309
|
+
protected async simulateViaEntrypoint(
|
|
310
|
+
executionPayload: ExecutionPayload,
|
|
311
|
+
from: AztecAddress,
|
|
312
|
+
feeOptions: FeeOptions,
|
|
313
|
+
scopes: AccessScopes,
|
|
314
|
+
skipTxValidation?: boolean,
|
|
315
|
+
skipFeeEnforcement?: boolean,
|
|
316
|
+
) {
|
|
317
|
+
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, from, feeOptions);
|
|
318
|
+
return this.pxe.simulateTx(txRequest, { simulatePublic: true, skipTxValidation, skipFeeEnforcement, scopes });
|
|
319
|
+
}
|
|
320
|
+
|
|
321
|
+
/**
|
|
322
|
+
* Simulates a transaction, optimizing leading public static calls by running them directly
|
|
323
|
+
* on the node while sending the remaining calls through the standard PXE path.
|
|
324
|
+
* Return values from both paths are merged back in original call order.
|
|
325
|
+
* @param executionPayload - The execution payload to simulate.
|
|
326
|
+
* @param opts - Simulation options (from address, fee settings, etc.).
|
|
327
|
+
* @returns The merged simulation result.
|
|
328
|
+
*/
|
|
262
329
|
async simulateTx(executionPayload: ExecutionPayload, opts: SimulateOptions): Promise<TxSimulationResult> {
|
|
263
330
|
const feeOptions = opts.fee?.estimateGas
|
|
264
331
|
? await this.completeFeeOptionsForEstimation(opts.from, executionPayload.feePayer, opts.fee?.gasSettings)
|
|
265
332
|
: await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
|
|
266
|
-
const
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
333
|
+
const { optimizableCalls, remainingCalls } = extractOptimizablePublicStaticCalls(executionPayload);
|
|
334
|
+
const remainingPayload = { ...executionPayload, calls: remainingCalls };
|
|
335
|
+
|
|
336
|
+
const chainInfo = await this.getChainInfo();
|
|
337
|
+
let blockHeader: BlockHeader;
|
|
338
|
+
// PXE might not be synced yet, so we pull the latest header from the node
|
|
339
|
+
// To keep things consistent, we'll always try with PXE first
|
|
340
|
+
try {
|
|
341
|
+
blockHeader = await this.pxe.getSyncedBlockHeader();
|
|
342
|
+
} catch {
|
|
343
|
+
blockHeader = (await this.aztecNode.getBlockHeader())!;
|
|
344
|
+
}
|
|
345
|
+
|
|
346
|
+
const [optimizedResults, normalResult] = await Promise.all([
|
|
347
|
+
optimizableCalls.length > 0
|
|
348
|
+
? simulateViaNode(
|
|
349
|
+
this.aztecNode,
|
|
350
|
+
optimizableCalls,
|
|
351
|
+
opts.from,
|
|
352
|
+
chainInfo,
|
|
353
|
+
feeOptions.gasSettings,
|
|
354
|
+
blockHeader,
|
|
355
|
+
opts.skipFeeEnforcement ?? true,
|
|
356
|
+
this.getContractName.bind(this),
|
|
357
|
+
)
|
|
358
|
+
: Promise.resolve([]),
|
|
359
|
+
remainingCalls.length > 0
|
|
360
|
+
? this.simulateViaEntrypoint(
|
|
361
|
+
remainingPayload,
|
|
362
|
+
opts.from,
|
|
363
|
+
feeOptions,
|
|
364
|
+
this.scopesFrom(opts.from, opts.additionalScopes),
|
|
365
|
+
opts.skipTxValidation,
|
|
366
|
+
opts.skipFeeEnforcement ?? true,
|
|
367
|
+
)
|
|
368
|
+
: Promise.resolve(null),
|
|
369
|
+
]);
|
|
370
|
+
|
|
371
|
+
return buildMergedSimulationResult(optimizedResults, normalResult);
|
|
273
372
|
}
|
|
274
373
|
|
|
275
374
|
async profileTx(executionPayload: ExecutionPayload, opts: ProfileOptions): Promise<TxProfileResult> {
|
|
276
375
|
const feeOptions = await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
|
|
277
376
|
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
|
|
278
|
-
return this.pxe.profileTx(txRequest,
|
|
377
|
+
return this.pxe.profileTx(txRequest, {
|
|
378
|
+
profileMode: opts.profileMode,
|
|
379
|
+
skipProofGeneration: opts.skipProofGeneration ?? true,
|
|
380
|
+
scopes: this.scopesFrom(opts.from, opts.additionalScopes),
|
|
381
|
+
});
|
|
279
382
|
}
|
|
280
383
|
|
|
281
|
-
async sendTx
|
|
384
|
+
public async sendTx<W extends InteractionWaitOptions = undefined>(
|
|
385
|
+
executionPayload: ExecutionPayload,
|
|
386
|
+
opts: SendOptions<W>,
|
|
387
|
+
): Promise<SendReturn<W>> {
|
|
282
388
|
const feeOptions = await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
|
|
283
389
|
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
|
|
284
|
-
const provenTx = await this.pxe.proveTx(txRequest);
|
|
390
|
+
const provenTx = await this.pxe.proveTx(txRequest, this.scopesFrom(opts.from, opts.additionalScopes));
|
|
391
|
+
const offchainOutput = extractOffchainOutput(provenTx.getOffchainEffects());
|
|
285
392
|
const tx = await provenTx.toTx();
|
|
286
393
|
const txHash = tx.getTxHash();
|
|
287
394
|
if (await this.aztecNode.getTxEffect(txHash)) {
|
|
@@ -292,7 +399,35 @@ export abstract class BaseWallet implements Wallet {
|
|
|
292
399
|
throw this.contextualizeError(err, inspect(tx));
|
|
293
400
|
});
|
|
294
401
|
this.log.info(`Sent transaction ${txHash}`);
|
|
295
|
-
|
|
402
|
+
|
|
403
|
+
// If wait is NO_WAIT, return txHash immediately
|
|
404
|
+
if (opts.wait === NO_WAIT) {
|
|
405
|
+
return { txHash, ...offchainOutput } as SendReturn<W>;
|
|
406
|
+
}
|
|
407
|
+
|
|
408
|
+
// Otherwise, wait for the full receipt (default behavior on wait: undefined)
|
|
409
|
+
const waitOpts = typeof opts.wait === 'object' ? opts.wait : undefined;
|
|
410
|
+
const receipt = await waitForTx(this.aztecNode, txHash, waitOpts);
|
|
411
|
+
|
|
412
|
+
// Display debug logs from public execution if present (served in test mode only)
|
|
413
|
+
if (receipt.debugLogs?.length) {
|
|
414
|
+
await displayDebugLogs(receipt.debugLogs, this.getContractName.bind(this));
|
|
415
|
+
}
|
|
416
|
+
|
|
417
|
+
return { receipt, ...offchainOutput } as SendReturn<W>;
|
|
418
|
+
}
|
|
419
|
+
|
|
420
|
+
/**
|
|
421
|
+
* Resolves a contract address to a human-readable name via PXE, if available.
|
|
422
|
+
* @param address - The contract address to resolve.
|
|
423
|
+
*/
|
|
424
|
+
protected async getContractName(address: AztecAddress): Promise<string | undefined> {
|
|
425
|
+
const instance = await this.pxe.getContractInstance(address);
|
|
426
|
+
if (!instance) {
|
|
427
|
+
return undefined;
|
|
428
|
+
}
|
|
429
|
+
const artifact = await this.pxe.getContractArtifact(instance.currentContractClassId);
|
|
430
|
+
return artifact?.name;
|
|
296
431
|
}
|
|
297
432
|
|
|
298
433
|
protected contextualizeError(err: Error, ...context: string[]): Error {
|
|
@@ -309,34 +444,52 @@ export abstract class BaseWallet implements Wallet {
|
|
|
309
444
|
return err;
|
|
310
445
|
}
|
|
311
446
|
|
|
312
|
-
|
|
313
|
-
return this.pxe.
|
|
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);
|
|
447
|
+
executeUtility(call: FunctionCall, opts: ExecuteUtilityOptions): Promise<UtilityExecutionResult> {
|
|
448
|
+
return this.pxe.executeUtility(call, { authwits: opts.authWitnesses, scopes: [opts.scope] });
|
|
325
449
|
}
|
|
326
450
|
|
|
327
451
|
async getPrivateEvents<T>(
|
|
328
|
-
contractAddress: AztecAddress,
|
|
329
452
|
eventDef: EventMetadataDefinition,
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
const
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
453
|
+
eventFilter: PrivateEventFilter,
|
|
454
|
+
): Promise<PrivateEvent<T>[]> {
|
|
455
|
+
const pxeEvents = await this.pxe.getPrivateEvents(eventDef.eventSelector, eventFilter);
|
|
456
|
+
|
|
457
|
+
const decodedEvents = pxeEvents.map((pxeEvent: PackedPrivateEvent): PrivateEvent<T> => {
|
|
458
|
+
return {
|
|
459
|
+
event: decodeFromAbi([eventDef.abiType], pxeEvent.packedEvent) as T,
|
|
460
|
+
metadata: {
|
|
461
|
+
l2BlockNumber: pxeEvent.l2BlockNumber,
|
|
462
|
+
l2BlockHash: pxeEvent.l2BlockHash,
|
|
463
|
+
txHash: pxeEvent.txHash,
|
|
464
|
+
},
|
|
465
|
+
};
|
|
466
|
+
});
|
|
339
467
|
|
|
340
468
|
return decodedEvents;
|
|
341
469
|
}
|
|
470
|
+
|
|
471
|
+
async getContractMetadata(address: AztecAddress) {
|
|
472
|
+
const instance = await this.pxe.getContractInstance(address);
|
|
473
|
+
const initNullifier = await siloNullifier(address, address.toField());
|
|
474
|
+
const publiclyRegisteredContract = await this.aztecNode.getContract(address);
|
|
475
|
+
const initNullifierMembershipWitness = await this.aztecNode.getNullifierMembershipWitness('latest', initNullifier);
|
|
476
|
+
const isContractUpdated =
|
|
477
|
+
publiclyRegisteredContract &&
|
|
478
|
+
!publiclyRegisteredContract.currentContractClassId.equals(publiclyRegisteredContract.originalContractClassId);
|
|
479
|
+
return {
|
|
480
|
+
instance: instance ?? undefined,
|
|
481
|
+
isContractInitialized: !!initNullifierMembershipWitness,
|
|
482
|
+
isContractPublished: !!publiclyRegisteredContract,
|
|
483
|
+
isContractUpdated: !!isContractUpdated,
|
|
484
|
+
updatedContractClassId: isContractUpdated ? publiclyRegisteredContract.currentContractClassId : undefined,
|
|
485
|
+
};
|
|
486
|
+
}
|
|
487
|
+
|
|
488
|
+
async getContractClassMetadata(id: Fr) {
|
|
489
|
+
const publiclyRegisteredContractClass = await this.aztecNode.getContractClass(id);
|
|
490
|
+
return {
|
|
491
|
+
isArtifactRegistered: !!(await this.pxe.getContractArtifact(id)),
|
|
492
|
+
isContractClassPubliclyRegistered: !!publiclyRegisteredContractClass,
|
|
493
|
+
};
|
|
494
|
+
}
|
|
342
495
|
}
|
package/src/base-wallet/index.ts
CHANGED
|
@@ -0,0 +1,238 @@
|
|
|
1
|
+
import type { AztecNode } from '@aztec/aztec.js/node';
|
|
2
|
+
import { MAX_ENQUEUED_CALLS_PER_CALL } from '@aztec/constants';
|
|
3
|
+
import type { ChainInfo } from '@aztec/entrypoints/interfaces';
|
|
4
|
+
import { makeTuple } from '@aztec/foundation/array';
|
|
5
|
+
import { Fr } from '@aztec/foundation/curves/bn254';
|
|
6
|
+
import type { Tuple } from '@aztec/foundation/serialize';
|
|
7
|
+
import type { ContractNameResolver } from '@aztec/pxe/client/lazy';
|
|
8
|
+
import { displayDebugLogs } from '@aztec/pxe/client/lazy';
|
|
9
|
+
import { generateSimulatedProvingResult } from '@aztec/pxe/simulator';
|
|
10
|
+
import { type FunctionCall, FunctionSelector } from '@aztec/stdlib/abi';
|
|
11
|
+
import type { AztecAddress } from '@aztec/stdlib/aztec-address';
|
|
12
|
+
import type { GasSettings } from '@aztec/stdlib/gas';
|
|
13
|
+
import {
|
|
14
|
+
ClaimedLengthArray,
|
|
15
|
+
CountedPublicCallRequest,
|
|
16
|
+
PrivateCircuitPublicInputs,
|
|
17
|
+
PublicCallRequest,
|
|
18
|
+
} from '@aztec/stdlib/kernel';
|
|
19
|
+
import { ChonkProof } from '@aztec/stdlib/proofs';
|
|
20
|
+
import {
|
|
21
|
+
type BlockHeader,
|
|
22
|
+
type ExecutionPayload,
|
|
23
|
+
HashedValues,
|
|
24
|
+
PrivateCallExecutionResult,
|
|
25
|
+
PrivateExecutionResult,
|
|
26
|
+
PublicSimulationOutput,
|
|
27
|
+
Tx,
|
|
28
|
+
TxContext,
|
|
29
|
+
TxSimulationResult,
|
|
30
|
+
} from '@aztec/stdlib/tx';
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* Splits an execution payload into a leading prefix of public static calls
|
|
34
|
+
* (eligible for direct node simulation) and the remaining calls.
|
|
35
|
+
*
|
|
36
|
+
* Only a leading run of public static calls is eligible for optimization.
|
|
37
|
+
* Any non-public-static call may enqueue public state mutations
|
|
38
|
+
* (e.g. private calls can enqueue public calls), so all calls that follow
|
|
39
|
+
* must go through the normal simulation path to see the correct state.
|
|
40
|
+
*
|
|
41
|
+
*/
|
|
42
|
+
export function extractOptimizablePublicStaticCalls(payload: ExecutionPayload): {
|
|
43
|
+
/** Leading public static calls eligible for direct node simulation. */
|
|
44
|
+
optimizableCalls: FunctionCall[];
|
|
45
|
+
/** All remaining calls. */
|
|
46
|
+
remainingCalls: FunctionCall[];
|
|
47
|
+
} {
|
|
48
|
+
const splitIndex = payload.calls.findIndex(call => !call.isPublicStatic());
|
|
49
|
+
const boundary = splitIndex === -1 ? payload.calls.length : splitIndex;
|
|
50
|
+
return {
|
|
51
|
+
optimizableCalls: payload.calls.slice(0, boundary),
|
|
52
|
+
remainingCalls: payload.calls.slice(boundary),
|
|
53
|
+
};
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* Simulates a batch of public static calls by bypassing account entrypoint and private execution,
|
|
58
|
+
* directly constructing a minimal Tx and calling node.simulatePublicCalls.
|
|
59
|
+
*
|
|
60
|
+
* @param node - The Aztec node to simulate on.
|
|
61
|
+
* @param publicStaticCalls - Array of public static function calls (max MAX_ENQUEUED_CALLS_PER_CALL).
|
|
62
|
+
* @param from - The account address making the calls.
|
|
63
|
+
* @param chainInfo - Chain information (chainId and version).
|
|
64
|
+
* @param gasSettings - Gas settings for the transaction.
|
|
65
|
+
* @param blockHeader - Block header to use as anchor.
|
|
66
|
+
* @param skipFeeEnforcement - Whether to skip fee enforcement during simulation.
|
|
67
|
+
* @returns TxSimulationResult with public return values.
|
|
68
|
+
*/
|
|
69
|
+
async function simulateBatchViaNode(
|
|
70
|
+
node: AztecNode,
|
|
71
|
+
publicStaticCalls: FunctionCall[],
|
|
72
|
+
from: AztecAddress,
|
|
73
|
+
chainInfo: ChainInfo,
|
|
74
|
+
gasSettings: GasSettings,
|
|
75
|
+
blockHeader: BlockHeader,
|
|
76
|
+
skipFeeEnforcement: boolean,
|
|
77
|
+
getContractName: ContractNameResolver,
|
|
78
|
+
): Promise<TxSimulationResult> {
|
|
79
|
+
const txContext = new TxContext(chainInfo.chainId, chainInfo.version, gasSettings);
|
|
80
|
+
|
|
81
|
+
const publicFunctionCalldata: HashedValues[] = [];
|
|
82
|
+
for (const call of publicStaticCalls) {
|
|
83
|
+
const calldata = await HashedValues.fromCalldata([call.selector.toField(), ...call.args]);
|
|
84
|
+
publicFunctionCalldata.push(calldata);
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
const publicCallRequests = makeTuple(MAX_ENQUEUED_CALLS_PER_CALL, i => {
|
|
88
|
+
const call = publicStaticCalls[i];
|
|
89
|
+
if (!call) {
|
|
90
|
+
return CountedPublicCallRequest.empty();
|
|
91
|
+
}
|
|
92
|
+
const publicCallRequest = new PublicCallRequest(from, call.to, call.isStatic, publicFunctionCalldata[i]!.hash);
|
|
93
|
+
// Counter starts at 1 (minRevertibleSideEffectCounter) so all calls are revertible
|
|
94
|
+
return new CountedPublicCallRequest(publicCallRequest, i + 1);
|
|
95
|
+
});
|
|
96
|
+
|
|
97
|
+
const publicCallRequestsArray: ClaimedLengthArray<CountedPublicCallRequest, typeof MAX_ENQUEUED_CALLS_PER_CALL> =
|
|
98
|
+
new ClaimedLengthArray(
|
|
99
|
+
publicCallRequests as Tuple<CountedPublicCallRequest, typeof MAX_ENQUEUED_CALLS_PER_CALL>,
|
|
100
|
+
publicStaticCalls.length,
|
|
101
|
+
);
|
|
102
|
+
|
|
103
|
+
const publicInputs = PrivateCircuitPublicInputs.from({
|
|
104
|
+
...PrivateCircuitPublicInputs.empty(),
|
|
105
|
+
anchorBlockHeader: blockHeader,
|
|
106
|
+
txContext: txContext,
|
|
107
|
+
publicCallRequests: publicCallRequestsArray,
|
|
108
|
+
startSideEffectCounter: new Fr(0),
|
|
109
|
+
endSideEffectCounter: new Fr(publicStaticCalls.length + 1),
|
|
110
|
+
});
|
|
111
|
+
|
|
112
|
+
// Minimal entrypoint structure — no real private execution, just public call requests
|
|
113
|
+
const emptyEntrypoint = new PrivateCallExecutionResult(
|
|
114
|
+
Buffer.alloc(0),
|
|
115
|
+
Buffer.alloc(0),
|
|
116
|
+
new Map(),
|
|
117
|
+
publicInputs,
|
|
118
|
+
[],
|
|
119
|
+
new Map(),
|
|
120
|
+
[],
|
|
121
|
+
[],
|
|
122
|
+
[],
|
|
123
|
+
[],
|
|
124
|
+
[],
|
|
125
|
+
);
|
|
126
|
+
|
|
127
|
+
const privateResult = new PrivateExecutionResult(emptyEntrypoint, Fr.random(), publicFunctionCalldata);
|
|
128
|
+
|
|
129
|
+
const provingResult = await generateSimulatedProvingResult(
|
|
130
|
+
privateResult,
|
|
131
|
+
(_contractAddress: AztecAddress, _functionSelector: FunctionSelector) => Promise.resolve(''),
|
|
132
|
+
node,
|
|
133
|
+
1, // minRevertibleSideEffectCounter
|
|
134
|
+
);
|
|
135
|
+
|
|
136
|
+
provingResult.publicInputs.feePayer = from;
|
|
137
|
+
|
|
138
|
+
const tx = await Tx.create({
|
|
139
|
+
data: provingResult.publicInputs,
|
|
140
|
+
chonkProof: ChonkProof.empty(),
|
|
141
|
+
contractClassLogFields: [],
|
|
142
|
+
publicFunctionCalldata: publicFunctionCalldata,
|
|
143
|
+
});
|
|
144
|
+
|
|
145
|
+
const publicOutput = await node.simulatePublicCalls(tx, skipFeeEnforcement);
|
|
146
|
+
|
|
147
|
+
if (publicOutput.revertReason) {
|
|
148
|
+
throw publicOutput.revertReason;
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
// Display debug logs from the public simulation.
|
|
152
|
+
await displayDebugLogs(publicOutput.debugLogs, getContractName);
|
|
153
|
+
|
|
154
|
+
return new TxSimulationResult(privateResult, provingResult.publicInputs, publicOutput, undefined);
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
/**
|
|
158
|
+
* Simulates public static calls by splitting them into batches of MAX_ENQUEUED_CALLS_PER_CALL
|
|
159
|
+
* and sending each batch directly to the node.
|
|
160
|
+
*
|
|
161
|
+
* @param node - The Aztec node to simulate on.
|
|
162
|
+
* @param publicStaticCalls - Array of public static function calls to optimize.
|
|
163
|
+
* @param from - The account address making the calls.
|
|
164
|
+
* @param chainInfo - Chain information (chainId and version).
|
|
165
|
+
* @param gasSettings - Gas settings for the transaction.
|
|
166
|
+
* @param blockHeader - Block header to use as anchor.
|
|
167
|
+
* @param skipFeeEnforcement - Whether to skip fee enforcement during simulation.
|
|
168
|
+
* @returns Array of TxSimulationResult, one per batch.
|
|
169
|
+
*/
|
|
170
|
+
export async function simulateViaNode(
|
|
171
|
+
node: AztecNode,
|
|
172
|
+
publicStaticCalls: FunctionCall[],
|
|
173
|
+
from: AztecAddress,
|
|
174
|
+
chainInfo: ChainInfo,
|
|
175
|
+
gasSettings: GasSettings,
|
|
176
|
+
blockHeader: BlockHeader,
|
|
177
|
+
skipFeeEnforcement: boolean = true,
|
|
178
|
+
getContractName: ContractNameResolver,
|
|
179
|
+
): Promise<TxSimulationResult[]> {
|
|
180
|
+
const batches: FunctionCall[][] = [];
|
|
181
|
+
|
|
182
|
+
for (let i = 0; i < publicStaticCalls.length; i += MAX_ENQUEUED_CALLS_PER_CALL) {
|
|
183
|
+
batches.push(publicStaticCalls.slice(i, i + MAX_ENQUEUED_CALLS_PER_CALL));
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
const results: TxSimulationResult[] = [];
|
|
187
|
+
|
|
188
|
+
for (const batch of batches) {
|
|
189
|
+
const result = await simulateBatchViaNode(
|
|
190
|
+
node,
|
|
191
|
+
batch,
|
|
192
|
+
from,
|
|
193
|
+
chainInfo,
|
|
194
|
+
gasSettings,
|
|
195
|
+
blockHeader,
|
|
196
|
+
skipFeeEnforcement,
|
|
197
|
+
getContractName,
|
|
198
|
+
);
|
|
199
|
+
results.push(result);
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
return results;
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
/**
|
|
206
|
+
* Merges simulation results from the optimized (public static) and normal paths.
|
|
207
|
+
* Since optimized calls are always a leading prefix, return values are simply
|
|
208
|
+
* concatenated: optimized first, then normal.
|
|
209
|
+
* Stats are taken from the normal result only (the optimized path doesn't produce them).
|
|
210
|
+
*
|
|
211
|
+
* @param optimizedResults - Results from optimized public static call batches.
|
|
212
|
+
* @param normalResult - Result from normal simulation (null if all calls were optimized).
|
|
213
|
+
* @returns A single TxSimulationResult with return values in original call order.
|
|
214
|
+
*/
|
|
215
|
+
export function buildMergedSimulationResult(
|
|
216
|
+
optimizedResults: TxSimulationResult[],
|
|
217
|
+
normalResult: TxSimulationResult | null,
|
|
218
|
+
): TxSimulationResult {
|
|
219
|
+
const optimizedReturnValues = optimizedResults.flatMap(r => r.publicOutput?.publicReturnValues ?? []);
|
|
220
|
+
const normalReturnValues = normalResult?.publicOutput?.publicReturnValues ?? [];
|
|
221
|
+
const allReturnValues = [...optimizedReturnValues, ...normalReturnValues];
|
|
222
|
+
|
|
223
|
+
const baseResult = normalResult ?? optimizedResults[0];
|
|
224
|
+
|
|
225
|
+
const mergedPublicOutput: PublicSimulationOutput | undefined = baseResult.publicOutput
|
|
226
|
+
? {
|
|
227
|
+
...baseResult.publicOutput,
|
|
228
|
+
publicReturnValues: allReturnValues,
|
|
229
|
+
}
|
|
230
|
+
: undefined;
|
|
231
|
+
|
|
232
|
+
return new TxSimulationResult(
|
|
233
|
+
baseResult.privateExecutionResult,
|
|
234
|
+
baseResult.publicInputs,
|
|
235
|
+
mergedPublicOutput,
|
|
236
|
+
normalResult?.stats,
|
|
237
|
+
);
|
|
238
|
+
}
|