@aztec/wallet-sdk 0.0.1-commit.6d3c34e → 0.0.1-commit.7035c9bd6
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 +218 -355
- package/dest/base-wallet/base_wallet.d.ts +71 -13
- package/dest/base-wallet/base_wallet.d.ts.map +1 -1
- package/dest/base-wallet/base_wallet.js +168 -25
- package/dest/base-wallet/index.d.ts +3 -2
- 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 +73 -27
- package/dest/crypto.d.ts.map +1 -1
- package/dest/crypto.js +219 -41
- 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/{providers/extension → extension/provider}/index.js +0 -1
- 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 +55 -15
- package/dest/types.d.ts.map +1 -1
- package/dest/types.js +10 -2
- package/package.json +18 -11
- package/src/base-wallet/base_wallet.ts +222 -46
- package/src/base-wallet/index.ts +2 -1
- package/src/base-wallet/utils.ts +238 -0
- package/src/crypto.ts +263 -47
- 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 -9
- package/src/manager/types.ts +112 -4
- package/src/manager/wallet_manager.ts +202 -31
- package/src/types.ts +57 -14
- 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 -95
- package/dest/providers/extension/extension_wallet.d.ts.map +0 -1
- package/dest/providers/extension/extension_wallet.js +0 -225
- package/dest/providers/extension/index.d.ts +0 -5
- package/dest/providers/extension/index.d.ts.map +0 -1
- package/src/providers/extension/extension_provider.ts +0 -72
- package/src/providers/extension/extension_wallet.ts +0 -275
- package/src/providers/extension/index.ts +0 -11
|
@@ -1,17 +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,
|
|
9
17
|
PrivateEvent,
|
|
10
18
|
PrivateEventFilter,
|
|
11
19
|
ProfileOptions,
|
|
12
20
|
SendOptions,
|
|
13
21
|
SimulateOptions,
|
|
14
22
|
Wallet,
|
|
23
|
+
WalletCapabilities,
|
|
15
24
|
} from '@aztec/aztec.js/wallet';
|
|
16
25
|
import {
|
|
17
26
|
GAS_ESTIMATION_DA_GAS_LIMIT,
|
|
@@ -24,6 +33,7 @@ import type { ChainInfo } from '@aztec/entrypoints/interfaces';
|
|
|
24
33
|
import { Fr } from '@aztec/foundation/curves/bn254';
|
|
25
34
|
import { createLogger } from '@aztec/foundation/log';
|
|
26
35
|
import type { FieldsOf } from '@aztec/foundation/types';
|
|
36
|
+
import { type AccessScopes, displayDebugLogs } from '@aztec/pxe/client/lazy';
|
|
27
37
|
import type { PXE, PackedPrivateEvent } from '@aztec/pxe/server';
|
|
28
38
|
import {
|
|
29
39
|
type ContractArtifact,
|
|
@@ -32,29 +42,29 @@ import {
|
|
|
32
42
|
decodeFromAbi,
|
|
33
43
|
} from '@aztec/stdlib/abi';
|
|
34
44
|
import type { AuthWitness } from '@aztec/stdlib/auth-witness';
|
|
35
|
-
import
|
|
45
|
+
import { AztecAddress } from '@aztec/stdlib/aztec-address';
|
|
36
46
|
import {
|
|
37
|
-
type ContractClassMetadata,
|
|
38
47
|
type ContractInstanceWithAddress,
|
|
39
|
-
type ContractMetadata,
|
|
40
48
|
computePartialAddress,
|
|
41
49
|
getContractClassFromArtifact,
|
|
42
50
|
} from '@aztec/stdlib/contract';
|
|
43
51
|
import { SimulationError } from '@aztec/stdlib/errors';
|
|
44
52
|
import { Gas, GasSettings } from '@aztec/stdlib/gas';
|
|
53
|
+
import { computeSiloedPrivateInitializationNullifier } from '@aztec/stdlib/hash';
|
|
45
54
|
import type { AztecNode } from '@aztec/stdlib/interfaces/client';
|
|
46
|
-
import
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
TxProfileResult,
|
|
50
|
-
TxReceipt,
|
|
55
|
+
import {
|
|
56
|
+
BlockHeader,
|
|
57
|
+
type TxExecutionRequest,
|
|
58
|
+
type TxProfileResult,
|
|
51
59
|
TxSimulationResult,
|
|
52
|
-
|
|
60
|
+
type UtilityExecutionResult,
|
|
53
61
|
} from '@aztec/stdlib/tx';
|
|
54
62
|
import { ExecutionPayload, mergeExecutionPayloads } from '@aztec/stdlib/tx';
|
|
55
63
|
|
|
56
64
|
import { inspect } from 'util';
|
|
57
65
|
|
|
66
|
+
import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simulateViaNode } from './utils.js';
|
|
67
|
+
|
|
58
68
|
/**
|
|
59
69
|
* Options to configure fee payment for a transaction
|
|
60
70
|
*/
|
|
@@ -70,12 +80,20 @@ export type FeeOptions = {
|
|
|
70
80
|
gasSettings: GasSettings;
|
|
71
81
|
};
|
|
72
82
|
|
|
83
|
+
/** Options for `simulateViaEntrypoint`. */
|
|
84
|
+
export type SimulateViaEntrypointOptions = Pick<
|
|
85
|
+
SimulateOptions,
|
|
86
|
+
'from' | 'additionalScopes' | 'skipTxValidation' | 'skipFeeEnforcement'
|
|
87
|
+
> & {
|
|
88
|
+
/** Fee options for the entrypoint */
|
|
89
|
+
feeOptions: FeeOptions;
|
|
90
|
+
/** Scopes to use for the simulation */
|
|
91
|
+
scopes: AccessScopes;
|
|
92
|
+
};
|
|
73
93
|
/**
|
|
74
94
|
* A base class for Wallet implementations
|
|
75
95
|
*/
|
|
76
96
|
export abstract class BaseWallet implements Wallet {
|
|
77
|
-
protected log = createLogger('wallet-sdk:base_wallet');
|
|
78
|
-
|
|
79
97
|
protected minFeePadding = 0.5;
|
|
80
98
|
protected cancellableTransactions = false;
|
|
81
99
|
|
|
@@ -83,8 +101,15 @@ export abstract class BaseWallet implements Wallet {
|
|
|
83
101
|
protected constructor(
|
|
84
102
|
protected readonly pxe: PXE,
|
|
85
103
|
protected readonly aztecNode: AztecNode,
|
|
104
|
+
protected log = createLogger('wallet-sdk:base_wallet'),
|
|
86
105
|
) {}
|
|
87
106
|
|
|
107
|
+
protected scopesFrom(from: AztecAddress, additionalScopes: AztecAddress[] = []): AztecAddress[] {
|
|
108
|
+
const allScopes = from.isZero() ? additionalScopes : [from, ...additionalScopes];
|
|
109
|
+
const scopeSet = new Set(allScopes.map(address => address.toString()));
|
|
110
|
+
return [...scopeSet].map(AztecAddress.fromString);
|
|
111
|
+
}
|
|
112
|
+
|
|
88
113
|
protected abstract getAccountFromAddress(address: AztecAddress): Promise<Account>;
|
|
89
114
|
|
|
90
115
|
abstract getAccounts(): Promise<Aliased<AztecAddress>[]>;
|
|
@@ -121,20 +146,42 @@ export abstract class BaseWallet implements Wallet {
|
|
|
121
146
|
? mergeExecutionPayloads([feeExecutionPayload, executionPayload])
|
|
122
147
|
: executionPayload;
|
|
123
148
|
const fromAccount = await this.getAccountFromAddress(from);
|
|
124
|
-
|
|
149
|
+
const chainInfo = await this.getChainInfo();
|
|
150
|
+
return fromAccount.createTxExecutionRequest(
|
|
151
|
+
finalExecutionPayload,
|
|
152
|
+
feeOptions.gasSettings,
|
|
153
|
+
chainInfo,
|
|
154
|
+
executionOptions,
|
|
155
|
+
);
|
|
125
156
|
}
|
|
126
157
|
|
|
127
158
|
public async createAuthWit(
|
|
128
159
|
from: AztecAddress,
|
|
129
|
-
messageHashOrIntent:
|
|
160
|
+
messageHashOrIntent: IntentInnerHash | CallIntent,
|
|
130
161
|
): Promise<AuthWitness> {
|
|
131
162
|
const account = await this.getAccountFromAddress(from);
|
|
132
|
-
|
|
163
|
+
const chainInfo = await this.getChainInfo();
|
|
164
|
+
return account.createAuthWit(messageHashOrIntent, chainInfo);
|
|
133
165
|
}
|
|
134
166
|
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
167
|
+
/**
|
|
168
|
+
* Request capabilities from the wallet.
|
|
169
|
+
*
|
|
170
|
+
* This method is wallet-implementation-dependent and must be provided by classes extending BaseWallet.
|
|
171
|
+
* Embedded wallets typically don't support capability-based authorization (no user authorization flow),
|
|
172
|
+
* while external wallets (browser extensions, hardware wallets) implement this to reduce authorization
|
|
173
|
+
* friction by allowing apps to request permissions upfront.
|
|
174
|
+
*
|
|
175
|
+
* TODO: Consider making it abstract so implementing it is a conscious decision. Leaving it as-is
|
|
176
|
+
* while the feature stabilizes.
|
|
177
|
+
*
|
|
178
|
+
* @param _manifest - Application capability manifest declaring what operations the app needs
|
|
179
|
+
*/
|
|
180
|
+
public requestCapabilities(_manifest: AppCapabilities): Promise<WalletCapabilities> {
|
|
181
|
+
throw new Error('Not implemented');
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
public async batch<const T extends readonly BatchedMethod[]>(methods: T): Promise<BatchResults<T>> {
|
|
138
185
|
const results: any[] = [];
|
|
139
186
|
for (const method of methods) {
|
|
140
187
|
const { name, args } = method;
|
|
@@ -227,7 +274,7 @@ export abstract class BaseWallet implements Wallet {
|
|
|
227
274
|
artifact?: ContractArtifact,
|
|
228
275
|
secretKey?: Fr,
|
|
229
276
|
): Promise<ContractInstanceWithAddress> {
|
|
230
|
-
const
|
|
277
|
+
const existingInstance = await this.pxe.getContractInstance(instance.address);
|
|
231
278
|
|
|
232
279
|
if (existingInstance) {
|
|
233
280
|
// Instance already registered in the wallet
|
|
@@ -244,13 +291,12 @@ export abstract class BaseWallet implements Wallet {
|
|
|
244
291
|
// Instance not registered yet
|
|
245
292
|
if (!artifact) {
|
|
246
293
|
// Try to get the artifact from the wallet's contract class storage
|
|
247
|
-
|
|
248
|
-
if (!
|
|
294
|
+
artifact = await this.pxe.getContractArtifact(instance.currentContractClassId);
|
|
295
|
+
if (!artifact) {
|
|
249
296
|
throw new Error(
|
|
250
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()}`,
|
|
251
298
|
);
|
|
252
299
|
}
|
|
253
|
-
artifact = classMetadata.artifact;
|
|
254
300
|
}
|
|
255
301
|
await this.pxe.registerContract({ artifact, instance });
|
|
256
302
|
}
|
|
@@ -261,29 +307,98 @@ export abstract class BaseWallet implements Wallet {
|
|
|
261
307
|
return instance;
|
|
262
308
|
}
|
|
263
309
|
|
|
310
|
+
/**
|
|
311
|
+
* Simulates calls through the standard PXE path (account entrypoint).
|
|
312
|
+
* @param executionPayload - The execution payload to simulate.
|
|
313
|
+
* @param opts - Simulation options.
|
|
314
|
+
*/
|
|
315
|
+
protected async simulateViaEntrypoint(executionPayload: ExecutionPayload, opts: SimulateViaEntrypointOptions) {
|
|
316
|
+
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(
|
|
317
|
+
executionPayload,
|
|
318
|
+
opts.from,
|
|
319
|
+
opts.feeOptions,
|
|
320
|
+
);
|
|
321
|
+
return this.pxe.simulateTx(txRequest, {
|
|
322
|
+
simulatePublic: true,
|
|
323
|
+
skipTxValidation: opts.skipTxValidation,
|
|
324
|
+
skipFeeEnforcement: opts.skipFeeEnforcement,
|
|
325
|
+
scopes: opts.scopes,
|
|
326
|
+
});
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
/**
|
|
330
|
+
* Simulates a transaction, optimizing leading public static calls by running them directly
|
|
331
|
+
* on the node while sending the remaining calls through the standard PXE path.
|
|
332
|
+
* Return values from both paths are merged back in original call order.
|
|
333
|
+
* @param executionPayload - The execution payload to simulate.
|
|
334
|
+
* @param opts - Simulation options (from address, fee settings, etc.).
|
|
335
|
+
* @returns The merged simulation result.
|
|
336
|
+
*/
|
|
264
337
|
async simulateTx(executionPayload: ExecutionPayload, opts: SimulateOptions): Promise<TxSimulationResult> {
|
|
265
338
|
const feeOptions = opts.fee?.estimateGas
|
|
266
339
|
? await this.completeFeeOptionsForEstimation(opts.from, executionPayload.feePayer, opts.fee?.gasSettings)
|
|
267
340
|
: await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
|
|
268
|
-
const
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
341
|
+
const { optimizableCalls, remainingCalls } = extractOptimizablePublicStaticCalls(executionPayload);
|
|
342
|
+
const remainingPayload = { ...executionPayload, calls: remainingCalls };
|
|
343
|
+
|
|
344
|
+
const chainInfo = await this.getChainInfo();
|
|
345
|
+
let blockHeader: BlockHeader;
|
|
346
|
+
// PXE might not be synced yet, so we pull the latest header from the node
|
|
347
|
+
// To keep things consistent, we'll always try with PXE first
|
|
348
|
+
try {
|
|
349
|
+
blockHeader = await this.pxe.getSyncedBlockHeader();
|
|
350
|
+
} catch {
|
|
351
|
+
blockHeader = (await this.aztecNode.getBlockHeader())!;
|
|
352
|
+
}
|
|
353
|
+
|
|
354
|
+
const [optimizedResults, normalResult] = await Promise.all([
|
|
355
|
+
optimizableCalls.length > 0
|
|
356
|
+
? simulateViaNode(
|
|
357
|
+
this.aztecNode,
|
|
358
|
+
optimizableCalls,
|
|
359
|
+
opts.from,
|
|
360
|
+
chainInfo,
|
|
361
|
+
feeOptions.gasSettings,
|
|
362
|
+
blockHeader,
|
|
363
|
+
opts.skipFeeEnforcement ?? true,
|
|
364
|
+
this.getContractName.bind(this),
|
|
365
|
+
)
|
|
366
|
+
: Promise.resolve([]),
|
|
367
|
+
remainingCalls.length > 0
|
|
368
|
+
? this.simulateViaEntrypoint(remainingPayload, {
|
|
369
|
+
from: opts.from,
|
|
370
|
+
feeOptions,
|
|
371
|
+
scopes: this.scopesFrom(opts.from, opts.additionalScopes),
|
|
372
|
+
skipTxValidation: opts.skipTxValidation,
|
|
373
|
+
skipFeeEnforcement: opts.skipFeeEnforcement ?? true,
|
|
374
|
+
})
|
|
375
|
+
: Promise.resolve(null),
|
|
376
|
+
]);
|
|
377
|
+
|
|
378
|
+
return buildMergedSimulationResult(optimizedResults, normalResult);
|
|
275
379
|
}
|
|
276
380
|
|
|
277
381
|
async profileTx(executionPayload: ExecutionPayload, opts: ProfileOptions): Promise<TxProfileResult> {
|
|
278
382
|
const feeOptions = await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
|
|
279
383
|
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
|
|
280
|
-
return this.pxe.profileTx(txRequest,
|
|
384
|
+
return this.pxe.profileTx(txRequest, {
|
|
385
|
+
profileMode: opts.profileMode,
|
|
386
|
+
skipProofGeneration: opts.skipProofGeneration ?? true,
|
|
387
|
+
scopes: this.scopesFrom(opts.from, opts.additionalScopes),
|
|
388
|
+
});
|
|
281
389
|
}
|
|
282
390
|
|
|
283
|
-
async sendTx
|
|
391
|
+
public async sendTx<W extends InteractionWaitOptions = undefined>(
|
|
392
|
+
executionPayload: ExecutionPayload,
|
|
393
|
+
opts: SendOptions<W>,
|
|
394
|
+
): Promise<SendReturn<W>> {
|
|
284
395
|
const feeOptions = await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
|
|
285
396
|
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
|
|
286
|
-
const provenTx = await this.pxe.proveTx(txRequest);
|
|
397
|
+
const provenTx = await this.pxe.proveTx(txRequest, this.scopesFrom(opts.from, opts.additionalScopes));
|
|
398
|
+
const offchainOutput = extractOffchainOutput(
|
|
399
|
+
provenTx.getOffchainEffects(),
|
|
400
|
+
provenTx.publicInputs.constants.anchorBlockHeader.globalVariables.timestamp,
|
|
401
|
+
);
|
|
287
402
|
const tx = await provenTx.toTx();
|
|
288
403
|
const txHash = tx.getTxHash();
|
|
289
404
|
if (await this.aztecNode.getTxEffect(txHash)) {
|
|
@@ -294,7 +409,35 @@ export abstract class BaseWallet implements Wallet {
|
|
|
294
409
|
throw this.contextualizeError(err, inspect(tx));
|
|
295
410
|
});
|
|
296
411
|
this.log.info(`Sent transaction ${txHash}`);
|
|
297
|
-
|
|
412
|
+
|
|
413
|
+
// If wait is NO_WAIT, return txHash immediately
|
|
414
|
+
if (opts.wait === NO_WAIT) {
|
|
415
|
+
return { txHash, ...offchainOutput } as SendReturn<W>;
|
|
416
|
+
}
|
|
417
|
+
|
|
418
|
+
// 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);
|
|
421
|
+
|
|
422
|
+
// Display debug logs from public execution if present (served in test mode only)
|
|
423
|
+
if (receipt.debugLogs?.length) {
|
|
424
|
+
await displayDebugLogs(receipt.debugLogs, this.getContractName.bind(this));
|
|
425
|
+
}
|
|
426
|
+
|
|
427
|
+
return { receipt, ...offchainOutput } as SendReturn<W>;
|
|
428
|
+
}
|
|
429
|
+
|
|
430
|
+
/**
|
|
431
|
+
* Resolves a contract address to a human-readable name via PXE, if available.
|
|
432
|
+
* @param address - The contract address to resolve.
|
|
433
|
+
*/
|
|
434
|
+
protected async getContractName(address: AztecAddress): Promise<string | undefined> {
|
|
435
|
+
const instance = await this.pxe.getContractInstance(address);
|
|
436
|
+
if (!instance) {
|
|
437
|
+
return undefined;
|
|
438
|
+
}
|
|
439
|
+
const artifact = await this.pxe.getContractArtifact(instance.currentContractClassId);
|
|
440
|
+
return artifact?.name;
|
|
298
441
|
}
|
|
299
442
|
|
|
300
443
|
protected contextualizeError(err: Error, ...context: string[]): Error {
|
|
@@ -311,19 +454,8 @@ export abstract class BaseWallet implements Wallet {
|
|
|
311
454
|
return err;
|
|
312
455
|
}
|
|
313
456
|
|
|
314
|
-
|
|
315
|
-
return this.pxe.
|
|
316
|
-
}
|
|
317
|
-
|
|
318
|
-
getContractClassMetadata(id: Fr, includeArtifact: boolean = false): Promise<ContractClassMetadata> {
|
|
319
|
-
return this.pxe.getContractClassMetadata(id, includeArtifact);
|
|
320
|
-
}
|
|
321
|
-
getContractMetadata(address: AztecAddress): Promise<ContractMetadata> {
|
|
322
|
-
return this.pxe.getContractMetadata(address);
|
|
323
|
-
}
|
|
324
|
-
|
|
325
|
-
getTxReceipt(txHash: TxHash): Promise<TxReceipt> {
|
|
326
|
-
return this.aztecNode.getTxReceipt(txHash);
|
|
457
|
+
executeUtility(call: FunctionCall, opts: ExecuteUtilityOptions): Promise<UtilityExecutionResult> {
|
|
458
|
+
return this.pxe.executeUtility(call, { authwits: opts.authWitnesses, scopes: [opts.scope] });
|
|
327
459
|
}
|
|
328
460
|
|
|
329
461
|
async getPrivateEvents<T>(
|
|
@@ -345,4 +477,48 @@ export abstract class BaseWallet implements Wallet {
|
|
|
345
477
|
|
|
346
478
|
return decodedEvents;
|
|
347
479
|
}
|
|
480
|
+
|
|
481
|
+
/**
|
|
482
|
+
* 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
|
+
* @param address - The contract address to query.
|
|
487
|
+
*/
|
|
488
|
+
async getContractMetadata(address: AztecAddress) {
|
|
489
|
+
const instance = await this.pxe.getContractInstance(address);
|
|
490
|
+
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;
|
|
499
|
+
if (instance) {
|
|
500
|
+
const initNullifier = await computeSiloedPrivateInitializationNullifier(address, instance.initializationHash);
|
|
501
|
+
const witness = await this.aztecNode.getNullifierMembershipWitness('latest', initNullifier);
|
|
502
|
+
isContractInitialized = !!witness;
|
|
503
|
+
}
|
|
504
|
+
const publiclyRegisteredContract = await publiclyRegisteredContractPromise;
|
|
505
|
+
const isContractUpdated =
|
|
506
|
+
publiclyRegisteredContract &&
|
|
507
|
+
!publiclyRegisteredContract.currentContractClassId.equals(publiclyRegisteredContract.originalContractClassId);
|
|
508
|
+
return {
|
|
509
|
+
instance: instance ?? undefined,
|
|
510
|
+
isContractInitialized,
|
|
511
|
+
isContractPublished: !!publiclyRegisteredContract,
|
|
512
|
+
isContractUpdated: !!isContractUpdated,
|
|
513
|
+
updatedContractClassId: isContractUpdated ? publiclyRegisteredContract.currentContractClassId : undefined,
|
|
514
|
+
};
|
|
515
|
+
}
|
|
516
|
+
|
|
517
|
+
async getContractClassMetadata(id: Fr) {
|
|
518
|
+
const publiclyRegisteredContractClass = await this.aztecNode.getContractClass(id);
|
|
519
|
+
return {
|
|
520
|
+
isArtifactRegistered: !!(await this.pxe.getContractArtifact(id)),
|
|
521
|
+
isContractClassPubliclyRegistered: !!publiclyRegisteredContractClass,
|
|
522
|
+
};
|
|
523
|
+
}
|
|
348
524
|
}
|
package/src/base-wallet/index.ts
CHANGED
|
@@ -1 +1,2 @@
|
|
|
1
|
-
export { BaseWallet, type FeeOptions } from './base_wallet.js';
|
|
1
|
+
export { BaseWallet, type FeeOptions, type SimulateViaEntrypointOptions } from './base_wallet.js';
|
|
2
|
+
export { simulateViaNode, buildMergedSimulationResult, extractOptimizablePublicStaticCalls } from './utils.js';
|
|
@@ -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
|
+
}
|