@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.
- package/README.md +228 -331
- package/dest/base-wallet/base_wallet.d.ts +103 -43
- package/dest/base-wallet/base_wallet.d.ts.map +1 -1
- package/dest/base-wallet/base_wallet.js +282 -78
- 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 +50 -0
- package/dest/base-wallet/utils.d.ts.map +1 -0
- package/dest/base-wallet/utils.js +133 -0
- package/dest/crypto.d.ts +230 -0
- package/dest/crypto.d.ts.map +1 -0
- package/dest/crypto.js +482 -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 +129 -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/iframe/handlers/iframe_connection_handler.d.ts +118 -0
- package/dest/iframe/handlers/iframe_connection_handler.d.ts.map +1 -0
- package/dest/iframe/handlers/iframe_connection_handler.js +228 -0
- package/dest/iframe/handlers/index.d.ts +2 -0
- package/dest/iframe/handlers/index.d.ts.map +1 -0
- package/dest/iframe/handlers/index.js +1 -0
- package/dest/iframe/provider/iframe_discovery.d.ts +25 -0
- package/dest/iframe/provider/iframe_discovery.d.ts.map +1 -0
- package/dest/iframe/provider/iframe_discovery.js +167 -0
- package/dest/iframe/provider/iframe_provider.d.ts +65 -0
- package/dest/iframe/provider/iframe_provider.d.ts.map +1 -0
- package/dest/iframe/provider/iframe_provider.js +257 -0
- package/dest/iframe/provider/iframe_wallet.d.ts +68 -0
- package/dest/iframe/provider/iframe_wallet.d.ts.map +1 -0
- package/dest/iframe/provider/iframe_wallet.js +200 -0
- package/dest/iframe/provider/index.d.ts +4 -0
- package/dest/iframe/provider/index.d.ts.map +1 -0
- package/dest/iframe/provider/index.js +3 -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 +109 -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 +208 -29
- package/dest/types.d.ts +135 -0
- package/dest/types.d.ts.map +1 -0
- package/dest/types.js +15 -0
- package/package.json +26 -13
- package/src/base-wallet/base_wallet.ts +388 -139
- package/src/base-wallet/index.ts +7 -1
- package/src/base-wallet/utils.ts +240 -0
- package/src/crypto.ts +603 -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 +324 -0
- package/src/extension/provider/index.ts +7 -0
- package/src/iframe/handlers/iframe_connection_handler.ts +328 -0
- package/src/iframe/handlers/index.ts +7 -0
- package/src/iframe/provider/iframe_discovery.ts +185 -0
- package/src/iframe/provider/iframe_provider.ts +331 -0
- package/src/iframe/provider/iframe_wallet.ts +229 -0
- package/src/iframe/provider/index.ts +3 -0
- package/src/manager/index.ts +3 -15
- package/src/manager/types.ts +113 -4
- package/src/manager/wallet_manager.ts +235 -30
- package/src/types.ts +145 -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,29 +1,50 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { NO_FROM } from '@aztec/aztec.js/account';
|
|
2
|
+
import { NO_WAIT, extractOffchainOutput } from '@aztec/aztec.js/contracts';
|
|
3
|
+
import { waitForTx } from '@aztec/aztec.js/node';
|
|
4
|
+
import { ContractInitializationStatus, TxSimulationResultWithAppOffset } from '@aztec/aztec.js/wallet';
|
|
2
5
|
import { AccountFeePaymentMethodOptions } from '@aztec/entrypoints/account';
|
|
3
|
-
import {
|
|
6
|
+
import { DefaultEntrypoint } from '@aztec/entrypoints/default';
|
|
7
|
+
import { Fr } from '@aztec/foundation/curves/bn254';
|
|
4
8
|
import { createLogger } from '@aztec/foundation/log';
|
|
9
|
+
import { displayDebugLogs } from '@aztec/pxe/client/lazy';
|
|
5
10
|
import { decodeFromAbi } from '@aztec/stdlib/abi';
|
|
11
|
+
import { AztecAddress } from '@aztec/stdlib/aztec-address';
|
|
6
12
|
import { computePartialAddress, getContractClassFromArtifact } from '@aztec/stdlib/contract';
|
|
7
13
|
import { SimulationError } from '@aztec/stdlib/errors';
|
|
8
|
-
import { Gas, GasSettings } from '@aztec/stdlib/gas';
|
|
14
|
+
import { Gas, GasFees, GasSettings, ManaUsageEstimate } from '@aztec/stdlib/gas';
|
|
15
|
+
import { computeSiloedPrivateInitializationNullifier, computeSiloedPublicInitializationNullifier } from '@aztec/stdlib/hash';
|
|
9
16
|
import { mergeExecutionPayloads } from '@aztec/stdlib/tx';
|
|
10
17
|
import { inspect } from 'util';
|
|
18
|
+
import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simulateViaNode } from './utils.js';
|
|
11
19
|
/**
|
|
12
20
|
* A base class for Wallet implementations
|
|
13
21
|
*/ export class BaseWallet {
|
|
14
22
|
pxe;
|
|
15
23
|
aztecNode;
|
|
16
24
|
log;
|
|
17
|
-
|
|
25
|
+
minFeePadding;
|
|
18
26
|
cancellableTransactions;
|
|
27
|
+
// A wallet is instantiated for a particular chain, so chain info never changes during its lifetime.
|
|
28
|
+
// We cache it here because getChainInfo is called frequently (every tx simulation, send, auth wit, etc.).
|
|
29
|
+
nodeInfoPromise;
|
|
19
30
|
// Protected because we want to force wallets to instantiate their own PXE.
|
|
20
|
-
constructor(pxe, aztecNode){
|
|
31
|
+
constructor(pxe, aztecNode, log = createLogger('wallet-sdk:base_wallet')){
|
|
21
32
|
this.pxe = pxe;
|
|
22
33
|
this.aztecNode = aztecNode;
|
|
23
|
-
this.log =
|
|
24
|
-
this.
|
|
34
|
+
this.log = log;
|
|
35
|
+
this.minFeePadding = 0.5;
|
|
25
36
|
this.cancellableTransactions = false;
|
|
26
37
|
}
|
|
38
|
+
scopesFrom(from, additionalScopes = []) {
|
|
39
|
+
const allScopes = from === NO_FROM ? additionalScopes : [
|
|
40
|
+
from,
|
|
41
|
+
...additionalScopes
|
|
42
|
+
];
|
|
43
|
+
const scopeSet = new Set(allScopes.map((address)=>address.toString()));
|
|
44
|
+
return [
|
|
45
|
+
...scopeSet
|
|
46
|
+
].map(AztecAddress.fromString);
|
|
47
|
+
}
|
|
27
48
|
/**
|
|
28
49
|
* Returns the list of aliased contacts associated with the wallet.
|
|
29
50
|
* This base implementation directly returns PXE's senders, but note that in general contacts are a superset of senders.
|
|
@@ -38,7 +59,10 @@ import { inspect } from 'util';
|
|
|
38
59
|
}));
|
|
39
60
|
}
|
|
40
61
|
async getChainInfo() {
|
|
41
|
-
|
|
62
|
+
if (!this.nodeInfoPromise) {
|
|
63
|
+
this.nodeInfoPromise = this.aztecNode.getNodeInfo();
|
|
64
|
+
}
|
|
65
|
+
const { l1ChainId, rollupVersion } = await this.nodeInfoPromise;
|
|
42
66
|
return {
|
|
43
67
|
chainId: new Fr(l1ChainId),
|
|
44
68
|
version: new Fr(rollupVersion)
|
|
@@ -46,21 +70,44 @@ import { inspect } from 'util';
|
|
|
46
70
|
}
|
|
47
71
|
async createTxExecutionRequestFromPayloadAndFee(executionPayload, from, feeOptions) {
|
|
48
72
|
const feeExecutionPayload = await feeOptions.walletFeePaymentMethod?.getExecutionPayload();
|
|
49
|
-
const executionOptions = {
|
|
50
|
-
txNonce: Fr.random(),
|
|
51
|
-
cancellable: this.cancellableTransactions,
|
|
52
|
-
feePaymentMethodOptions: feeOptions.accountFeePaymentMethodOptions
|
|
53
|
-
};
|
|
54
73
|
const finalExecutionPayload = feeExecutionPayload ? mergeExecutionPayloads([
|
|
55
74
|
feeExecutionPayload,
|
|
56
75
|
executionPayload
|
|
57
76
|
]) : executionPayload;
|
|
58
|
-
const
|
|
59
|
-
|
|
77
|
+
const chainInfo = await this.getChainInfo();
|
|
78
|
+
if (from === NO_FROM) {
|
|
79
|
+
const entrypoint = new DefaultEntrypoint();
|
|
80
|
+
return entrypoint.createTxExecutionRequest(finalExecutionPayload, feeOptions.gasSettings, chainInfo);
|
|
81
|
+
} else {
|
|
82
|
+
const fromAccount = await this.getAccountFromAddress(from);
|
|
83
|
+
const executionOptions = {
|
|
84
|
+
txNonce: Fr.random(),
|
|
85
|
+
cancellable: this.cancellableTransactions,
|
|
86
|
+
// If from is an address, feeOptions include the way the account contract should handle the fee payment
|
|
87
|
+
feePaymentMethodOptions: feeOptions.accountFeePaymentMethodOptions
|
|
88
|
+
};
|
|
89
|
+
return fromAccount.createTxExecutionRequest(finalExecutionPayload, feeOptions.gasSettings, chainInfo, executionOptions);
|
|
90
|
+
}
|
|
60
91
|
}
|
|
61
92
|
async createAuthWit(from, messageHashOrIntent) {
|
|
62
93
|
const account = await this.getAccountFromAddress(from);
|
|
63
|
-
|
|
94
|
+
const chainInfo = await this.getChainInfo();
|
|
95
|
+
return account.createAuthWit(messageHashOrIntent, chainInfo);
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* Request capabilities from the wallet.
|
|
99
|
+
*
|
|
100
|
+
* This method is wallet-implementation-dependent and must be provided by classes extending BaseWallet.
|
|
101
|
+
* Embedded wallets typically don't support capability-based authorization (no user authorization flow),
|
|
102
|
+
* while external wallets (browser extensions, hardware wallets) implement this to reduce authorization
|
|
103
|
+
* friction by allowing apps to request permissions upfront.
|
|
104
|
+
*
|
|
105
|
+
* TODO: Consider making it abstract so implementing it is a conscious decision. Leaving it as-is
|
|
106
|
+
* while the feature stabilizes.
|
|
107
|
+
*
|
|
108
|
+
* @param _manifest - Application capability manifest declaring what operations the app needs
|
|
109
|
+
*/ requestCapabilities(_manifest) {
|
|
110
|
+
throw new Error('Not implemented');
|
|
64
111
|
}
|
|
65
112
|
async batch(methods) {
|
|
66
113
|
const results = [];
|
|
@@ -83,26 +130,33 @@ import { inspect } from 'util';
|
|
|
83
130
|
}
|
|
84
131
|
/**
|
|
85
132
|
* Completes partial user-provided fee options with wallet defaults.
|
|
86
|
-
* @param
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
*/ async completeFeeOptions(from, feePayer, gasSettings) {
|
|
91
|
-
const maxFeesPerGas = gasSettings?.maxFeesPerGas ?? (await this.aztecNode.getCurrentBaseFees()).mul(1 + this.baseFeePadding);
|
|
133
|
+
* @param config - Fee completion config.
|
|
134
|
+
*/ async completeFeeOptions(config) {
|
|
135
|
+
const { from, feePayer, gasSettings, forEstimation, congestionEstimate } = config;
|
|
136
|
+
const maxFeesPerGas = gasSettings?.maxFeesPerGas ?? (await this.getMinFees(congestionEstimate)).mul(1 + this.minFeePadding);
|
|
92
137
|
let accountFeePaymentMethodOptions;
|
|
93
|
-
//
|
|
94
|
-
//
|
|
95
|
-
if (
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
138
|
+
// If from is an address, we need to determine the appropriate fee payment method options for the
|
|
139
|
+
// account contract entrypoint to use
|
|
140
|
+
if (from !== NO_FROM) {
|
|
141
|
+
if (!feePayer) {
|
|
142
|
+
// The transaction does not include a fee payment method, so we set the flag
|
|
143
|
+
// for the account to use its fee juice balance
|
|
144
|
+
accountFeePaymentMethodOptions = AccountFeePaymentMethodOptions.PREEXISTING_FEE_JUICE;
|
|
145
|
+
} else {
|
|
146
|
+
// The transaction includes fee payment method, so we check if we are the fee payer for it
|
|
147
|
+
// (this can only happen if the embedded payment method is FeeJuiceWithClaim)
|
|
148
|
+
accountFeePaymentMethodOptions = from.equals(feePayer) ? AccountFeePaymentMethodOptions.FEE_JUICE_WITH_CLAIM : AccountFeePaymentMethodOptions.EXTERNAL;
|
|
149
|
+
}
|
|
101
150
|
}
|
|
102
|
-
const
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
151
|
+
const gasSettingsOverrides = {
|
|
152
|
+
gasLimits: gasSettings?.gasLimits ? Gas.from(gasSettings.gasLimits) : undefined,
|
|
153
|
+
teardownGasLimits: gasSettings?.teardownGasLimits ? Gas.from(gasSettings.teardownGasLimits) : undefined,
|
|
154
|
+
maxFeesPerGas,
|
|
155
|
+
maxPriorityFeesPerGas: gasSettings?.maxPriorityFeesPerGas ?? GasFees.empty()
|
|
156
|
+
};
|
|
157
|
+
// When estimating gas (simulation), use high limits so the simulation doesn't run out of gas.
|
|
158
|
+
// When sending for real, use protocol max limits that the network will actually accept.
|
|
159
|
+
const fullGasSettings = forEstimation ? GasSettings.forEstimation(gasSettingsOverrides) : GasSettings.fallback(gasSettingsOverrides);
|
|
106
160
|
this.log.debug(`Using L2 gas settings`, fullGasSettings);
|
|
107
161
|
return {
|
|
108
162
|
gasSettings: fullGasSettings,
|
|
@@ -111,28 +165,30 @@ import { inspect } from 'util';
|
|
|
111
165
|
};
|
|
112
166
|
}
|
|
113
167
|
/**
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
* to
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
168
|
+
* Returns the worst-case min fee across predicted future slots.
|
|
169
|
+
* Falls back to getCurrentMinFees if the node doesn't support getPredictedMinFees.
|
|
170
|
+
* @param estimate - The mana usage estimate to use for fee prediction. Defaults to Limit for conservative estimation.
|
|
171
|
+
*/ async getMinFees(estimate = ManaUsageEstimate.Limit) {
|
|
172
|
+
try {
|
|
173
|
+
const predicted = await this.aztecNode.getPredictedMinFees(estimate);
|
|
174
|
+
if (predicted.length === 0) {
|
|
175
|
+
return this.aztecNode.getCurrentMinFees();
|
|
176
|
+
}
|
|
177
|
+
return predicted.reduce((worst, fees)=>fees.feePerL2Gas > worst.feePerL2Gas ? fees : worst);
|
|
178
|
+
} catch (err) {
|
|
179
|
+
// Fallback for old nodes that don't support getPredictedMinFees.
|
|
180
|
+
// Only fall back on method-not-found errors (JSON-RPC code -32601); rethrow others.
|
|
181
|
+
if (err?.cause?.code === -32601 || err?.message?.includes('Method not found')) {
|
|
182
|
+
return this.aztecNode.getCurrentMinFees();
|
|
183
|
+
}
|
|
184
|
+
throw err;
|
|
185
|
+
}
|
|
130
186
|
}
|
|
131
187
|
registerSender(address, _alias = '') {
|
|
132
188
|
return this.pxe.registerSender(address);
|
|
133
189
|
}
|
|
134
190
|
async registerContract(instance, artifact, secretKey) {
|
|
135
|
-
const
|
|
191
|
+
const existingInstance = await this.pxe.getContractInstance(instance.address);
|
|
136
192
|
if (existingInstance) {
|
|
137
193
|
// Instance already registered in the wallet
|
|
138
194
|
if (artifact) {
|
|
@@ -148,11 +204,10 @@ import { inspect } from 'util';
|
|
|
148
204
|
// Instance not registered yet
|
|
149
205
|
if (!artifact) {
|
|
150
206
|
// Try to get the artifact from the wallet's contract class storage
|
|
151
|
-
|
|
152
|
-
if (!
|
|
207
|
+
artifact = await this.pxe.getContractArtifact(instance.currentContractClassId);
|
|
208
|
+
if (!artifact) {
|
|
153
209
|
throw new Error(`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()}`);
|
|
154
210
|
}
|
|
155
|
-
artifact = classMetadata.artifact;
|
|
156
211
|
}
|
|
157
212
|
await this.pxe.registerContract({
|
|
158
213
|
artifact,
|
|
@@ -164,20 +219,99 @@ import { inspect } from 'util';
|
|
|
164
219
|
}
|
|
165
220
|
return instance;
|
|
166
221
|
}
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
222
|
+
/**
|
|
223
|
+
* Simulates calls through the standard PXE path (account entrypoint).
|
|
224
|
+
* @param executionPayload - The execution payload to simulate.
|
|
225
|
+
* @param opts - Simulation options.
|
|
226
|
+
*/ async simulateViaEntrypoint(executionPayload, opts) {
|
|
227
|
+
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, opts.feeOptions);
|
|
228
|
+
const result = await this.pxe.simulateTx(txRequest, {
|
|
229
|
+
simulatePublic: true,
|
|
230
|
+
skipTxValidation: opts.skipTxValidation,
|
|
231
|
+
skipFeeEnforcement: opts.skipFeeEnforcement,
|
|
232
|
+
scopes: this.scopesFrom(opts.from, opts.additionalScopes)
|
|
233
|
+
});
|
|
234
|
+
const appCallOffset = await this.computeAppCallOffset(opts.from, opts.feeOptions);
|
|
235
|
+
return TxSimulationResultWithAppOffset.fromResultAndOffset(result, appCallOffset);
|
|
236
|
+
}
|
|
237
|
+
/**
|
|
238
|
+
* Computes the index where the app's calls begin in the flattened array of calls (0 = entrypoint/root, 1..N = fee
|
|
239
|
+
* calls, N+1 = app).
|
|
240
|
+
* @param from - The sender address, or NO_FROM for the default entrypoint.
|
|
241
|
+
* @param feeOptions - Fee options containing the wallet fee payment method.
|
|
242
|
+
*/ async computeAppCallOffset(from, feeOptions) {
|
|
243
|
+
if (from === NO_FROM) {
|
|
244
|
+
return 0;
|
|
245
|
+
}
|
|
246
|
+
const feeExecutionPayload = await feeOptions.walletFeePaymentMethod?.getExecutionPayload();
|
|
247
|
+
return (feeExecutionPayload?.calls.length ?? 0) + 1; // +1 for entrypoint
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* Simulates a transaction, optimizing leading public static calls by running them directly
|
|
251
|
+
* on the node while sending the remaining calls through the standard PXE path.
|
|
252
|
+
* Return values from both paths are merged back in original call order.
|
|
253
|
+
* @param executionPayload - The execution payload to simulate.
|
|
254
|
+
* @param opts - Simulation options (from address, fee settings, etc.).
|
|
255
|
+
* @returns The merged simulation result.
|
|
256
|
+
*/ async simulateTx(executionPayload, opts) {
|
|
257
|
+
const feeOptions = await this.completeFeeOptions({
|
|
258
|
+
from: opts.from,
|
|
259
|
+
feePayer: executionPayload.feePayer,
|
|
260
|
+
gasSettings: opts.fee?.gasSettings,
|
|
261
|
+
forEstimation: true,
|
|
262
|
+
congestionEstimate: opts.fee?.congestionEstimate
|
|
263
|
+
});
|
|
264
|
+
const { optimizableCalls, remainingCalls } = extractOptimizablePublicStaticCalls(executionPayload);
|
|
265
|
+
const remainingPayload = {
|
|
266
|
+
...executionPayload,
|
|
267
|
+
calls: remainingCalls
|
|
268
|
+
};
|
|
269
|
+
const chainInfo = await this.getChainInfo();
|
|
270
|
+
let blockHeader;
|
|
271
|
+
// PXE might not be synced yet, so we pull the latest header from the node
|
|
272
|
+
// To keep things consistent, we'll always try with PXE first
|
|
273
|
+
try {
|
|
274
|
+
blockHeader = await this.pxe.getSyncedBlockHeader();
|
|
275
|
+
} catch {
|
|
276
|
+
blockHeader = await this.aztecNode.getBlockHeader();
|
|
277
|
+
}
|
|
278
|
+
const simulationOrigin = opts.from === NO_FROM ? AztecAddress.ZERO : opts.from;
|
|
279
|
+
const [optimizedResults, normalResult] = await Promise.all([
|
|
280
|
+
optimizableCalls.length > 0 ? simulateViaNode(this.aztecNode, optimizableCalls, simulationOrigin, chainInfo, feeOptions.gasSettings, blockHeader, opts.skipFeeEnforcement ?? true, this.getContractName.bind(this)) : Promise.resolve([]),
|
|
281
|
+
remainingCalls.length > 0 ? this.simulateViaEntrypoint(remainingPayload, {
|
|
282
|
+
from: opts.from,
|
|
283
|
+
feeOptions,
|
|
284
|
+
additionalScopes: opts.additionalScopes,
|
|
285
|
+
skipTxValidation: opts.skipTxValidation,
|
|
286
|
+
skipFeeEnforcement: opts.skipFeeEnforcement ?? true
|
|
287
|
+
}) : Promise.resolve(null)
|
|
288
|
+
]);
|
|
289
|
+
return buildMergedSimulationResult(optimizedResults, normalResult);
|
|
171
290
|
}
|
|
172
291
|
async profileTx(executionPayload, opts) {
|
|
173
|
-
const feeOptions = await this.completeFeeOptions(
|
|
292
|
+
const feeOptions = await this.completeFeeOptions({
|
|
293
|
+
from: opts.from,
|
|
294
|
+
feePayer: executionPayload.feePayer,
|
|
295
|
+
gasSettings: opts.fee?.gasSettings,
|
|
296
|
+
congestionEstimate: opts.fee?.congestionEstimate
|
|
297
|
+
});
|
|
174
298
|
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
|
|
175
|
-
return this.pxe.profileTx(txRequest,
|
|
299
|
+
return this.pxe.profileTx(txRequest, {
|
|
300
|
+
profileMode: opts.profileMode,
|
|
301
|
+
skipProofGeneration: opts.skipProofGeneration ?? true,
|
|
302
|
+
scopes: this.scopesFrom(opts.from, opts.additionalScopes)
|
|
303
|
+
});
|
|
176
304
|
}
|
|
177
305
|
async sendTx(executionPayload, opts) {
|
|
178
|
-
const feeOptions = await this.completeFeeOptions(
|
|
306
|
+
const feeOptions = await this.completeFeeOptions({
|
|
307
|
+
from: opts.from,
|
|
308
|
+
feePayer: executionPayload.feePayer,
|
|
309
|
+
gasSettings: opts.fee?.gasSettings,
|
|
310
|
+
congestionEstimate: opts.fee?.congestionEstimate
|
|
311
|
+
});
|
|
179
312
|
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
|
|
180
|
-
const provenTx = await this.pxe.proveTx(txRequest);
|
|
313
|
+
const provenTx = await this.pxe.proveTx(txRequest, this.scopesFrom(opts.from, opts.additionalScopes));
|
|
314
|
+
const offchainOutput = extractOffchainOutput(provenTx.getOffchainEffects(), provenTx.publicInputs.constants.anchorBlockHeader.globalVariables.timestamp);
|
|
181
315
|
const tx = await provenTx.toTx();
|
|
182
316
|
const txHash = tx.getTxHash();
|
|
183
317
|
if (await this.aztecNode.getTxEffect(txHash)) {
|
|
@@ -188,7 +322,35 @@ import { inspect } from 'util';
|
|
|
188
322
|
throw this.contextualizeError(err, inspect(tx));
|
|
189
323
|
});
|
|
190
324
|
this.log.info(`Sent transaction ${txHash}`);
|
|
191
|
-
return txHash
|
|
325
|
+
// If wait is NO_WAIT, return txHash immediately
|
|
326
|
+
if (opts.wait === NO_WAIT) {
|
|
327
|
+
return {
|
|
328
|
+
txHash,
|
|
329
|
+
...offchainOutput
|
|
330
|
+
};
|
|
331
|
+
}
|
|
332
|
+
// Otherwise, wait for the full receipt (default behavior on wait: undefined)
|
|
333
|
+
const waitOpts = typeof opts.wait === 'object' ? opts.wait : undefined;
|
|
334
|
+
const receipt = await waitForTx(this.aztecNode, txHash, waitOpts);
|
|
335
|
+
// Display debug logs from public execution if present (served in test mode only)
|
|
336
|
+
if (receipt.debugLogs?.length) {
|
|
337
|
+
await displayDebugLogs(receipt.debugLogs, this.getContractName.bind(this));
|
|
338
|
+
}
|
|
339
|
+
return {
|
|
340
|
+
receipt,
|
|
341
|
+
...offchainOutput
|
|
342
|
+
};
|
|
343
|
+
}
|
|
344
|
+
/**
|
|
345
|
+
* Resolves a contract address to a human-readable name via PXE, if available.
|
|
346
|
+
* @param address - The contract address to resolve.
|
|
347
|
+
*/ async getContractName(address) {
|
|
348
|
+
const instance = await this.pxe.getContractInstance(address);
|
|
349
|
+
if (!instance) {
|
|
350
|
+
return undefined;
|
|
351
|
+
}
|
|
352
|
+
const artifact = await this.pxe.getContractArtifact(instance.currentContractClassId);
|
|
353
|
+
return artifact?.name;
|
|
192
354
|
}
|
|
193
355
|
contextualizeError(err, ...context) {
|
|
194
356
|
let contextStr = '';
|
|
@@ -203,23 +365,65 @@ import { inspect } from 'util';
|
|
|
203
365
|
}
|
|
204
366
|
return err;
|
|
205
367
|
}
|
|
206
|
-
|
|
207
|
-
return this.pxe.
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
368
|
+
executeUtility(call, opts) {
|
|
369
|
+
return this.pxe.executeUtility(call, {
|
|
370
|
+
authwits: opts.authWitnesses,
|
|
371
|
+
scopes: opts.scopes
|
|
372
|
+
});
|
|
211
373
|
}
|
|
212
|
-
|
|
213
|
-
|
|
374
|
+
async getPrivateEvents(eventDef, eventFilter) {
|
|
375
|
+
const pxeEvents = await this.pxe.getPrivateEvents(eventDef.eventSelector, eventFilter);
|
|
376
|
+
const decodedEvents = pxeEvents.map((pxeEvent)=>{
|
|
377
|
+
return {
|
|
378
|
+
event: decodeFromAbi([
|
|
379
|
+
eventDef.abiType
|
|
380
|
+
], pxeEvent.packedEvent),
|
|
381
|
+
metadata: {
|
|
382
|
+
l2BlockNumber: pxeEvent.l2BlockNumber,
|
|
383
|
+
l2BlockHash: pxeEvent.l2BlockHash,
|
|
384
|
+
txHash: pxeEvent.txHash
|
|
385
|
+
}
|
|
386
|
+
};
|
|
387
|
+
});
|
|
388
|
+
return decodedEvents;
|
|
214
389
|
}
|
|
215
|
-
|
|
216
|
-
|
|
390
|
+
/**
|
|
391
|
+
* Returns metadata about a contract, including whether it has been initialized, published, and updated.
|
|
392
|
+
* @param address - The contract address to query.
|
|
393
|
+
*/ async getContractMetadata(address) {
|
|
394
|
+
const instance = await this.pxe.getContractInstance(address);
|
|
395
|
+
const publiclyRegisteredContractPromise = this.aztecNode.getContract(address);
|
|
396
|
+
let initializationStatus;
|
|
397
|
+
if (instance) {
|
|
398
|
+
// We have the instance, so we can compute the private initialization nullifier (which includes init_hash and is
|
|
399
|
+
// emitted by both private and public initializers) and get a definitive INITIALIZED/UNINITIALIZED answer.
|
|
400
|
+
const initNullifier = await computeSiloedPrivateInitializationNullifier(address, instance.initializationHash);
|
|
401
|
+
const witness = await this.aztecNode.getNullifierMembershipWitness('latest', initNullifier);
|
|
402
|
+
initializationStatus = witness ? ContractInitializationStatus.INITIALIZED : ContractInitializationStatus.UNINITIALIZED;
|
|
403
|
+
} else {
|
|
404
|
+
// Without the instance we lack the init_hash needed for the private nullifier. We fall back to checking the
|
|
405
|
+
// public initialization nullifier (computed from address alone). Not all contracts emit it (only those with
|
|
406
|
+
// public functions that require initialization checks), so its absence doesn't mean the contract is
|
|
407
|
+
// uninitialized.
|
|
408
|
+
const publicNullifier = await computeSiloedPublicInitializationNullifier(address);
|
|
409
|
+
const witness = await this.aztecNode.getNullifierMembershipWitness('latest', publicNullifier);
|
|
410
|
+
initializationStatus = witness ? ContractInitializationStatus.INITIALIZED : ContractInitializationStatus.UNKNOWN;
|
|
411
|
+
}
|
|
412
|
+
const publiclyRegisteredContract = await publiclyRegisteredContractPromise;
|
|
413
|
+
const isContractUpdated = publiclyRegisteredContract && !publiclyRegisteredContract.currentContractClassId.equals(publiclyRegisteredContract.originalContractClassId);
|
|
414
|
+
return {
|
|
415
|
+
instance: instance ?? undefined,
|
|
416
|
+
initializationStatus,
|
|
417
|
+
isContractPublished: !!publiclyRegisteredContract,
|
|
418
|
+
isContractUpdated: !!isContractUpdated,
|
|
419
|
+
updatedContractClassId: isContractUpdated ? publiclyRegisteredContract.currentContractClassId : undefined
|
|
420
|
+
};
|
|
217
421
|
}
|
|
218
|
-
async
|
|
219
|
-
const
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
422
|
+
async getContractClassMetadata(id) {
|
|
423
|
+
const publiclyRegisteredContractClass = await this.aztecNode.getContractClass(id);
|
|
424
|
+
return {
|
|
425
|
+
isArtifactRegistered: !!await this.pxe.getContractArtifact(id),
|
|
426
|
+
isContractClassPubliclyRegistered: !!publiclyRegisteredContractClass
|
|
427
|
+
};
|
|
224
428
|
}
|
|
225
429
|
}
|
|
@@ -1,2 +1,3 @@
|
|
|
1
|
-
export { BaseWallet, type FeeOptions } from './base_wallet.js';
|
|
2
|
-
|
|
1
|
+
export { BaseWallet, type CompleteFeeOptionsConfig, type FeeOptions, type SimulateViaEntrypointOptions, } from './base_wallet.js';
|
|
2
|
+
export { simulateViaNode, buildMergedSimulationResult, extractOptimizablePublicStaticCalls } from './utils.js';
|
|
3
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9iYXNlLXdhbGxldC9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQ0wsVUFBVSxFQUNWLEtBQUssd0JBQXdCLEVBQzdCLEtBQUssVUFBVSxFQUNmLEtBQUssNEJBQTRCLEdBQ2xDLE1BQU0sa0JBQWtCLENBQUM7QUFDMUIsT0FBTyxFQUFFLGVBQWUsRUFBRSwyQkFBMkIsRUFBRSxtQ0FBbUMsRUFBRSxNQUFNLFlBQVksQ0FBQyJ9
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/base-wallet/index.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/base-wallet/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,KAAK,wBAAwB,EAC7B,KAAK,UAAU,EACf,KAAK,4BAA4B,GAClC,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,eAAe,EAAE,2BAA2B,EAAE,mCAAmC,EAAE,MAAM,YAAY,CAAC"}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import type { AztecNode } from '@aztec/aztec.js/node';
|
|
2
|
+
import { TxSimulationResultWithAppOffset } from '@aztec/aztec.js/wallet';
|
|
3
|
+
import type { ChainInfo } from '@aztec/entrypoints/interfaces';
|
|
4
|
+
import type { ContractNameResolver } from '@aztec/pxe/client/lazy';
|
|
5
|
+
import { type FunctionCall } from '@aztec/stdlib/abi';
|
|
6
|
+
import type { AztecAddress } from '@aztec/stdlib/aztec-address';
|
|
7
|
+
import type { GasSettings } from '@aztec/stdlib/gas';
|
|
8
|
+
import { type BlockHeader, type ExecutionPayload, TxSimulationResult } from '@aztec/stdlib/tx';
|
|
9
|
+
/**
|
|
10
|
+
* Splits an execution payload into a leading prefix of public static calls
|
|
11
|
+
* (eligible for direct node simulation) and the remaining calls.
|
|
12
|
+
*
|
|
13
|
+
* Only a leading run of public static calls is eligible for optimization.
|
|
14
|
+
* Any non-public-static call may enqueue public state mutations
|
|
15
|
+
* (e.g. private calls can enqueue public calls), so all calls that follow
|
|
16
|
+
* must go through the normal simulation path to see the correct state.
|
|
17
|
+
*
|
|
18
|
+
*/
|
|
19
|
+
export declare function extractOptimizablePublicStaticCalls(payload: ExecutionPayload): {
|
|
20
|
+
/** Leading public static calls eligible for direct node simulation. */
|
|
21
|
+
optimizableCalls: FunctionCall[];
|
|
22
|
+
/** All remaining calls. */
|
|
23
|
+
remainingCalls: FunctionCall[];
|
|
24
|
+
};
|
|
25
|
+
/**
|
|
26
|
+
* Simulates public static calls by splitting them into batches of MAX_ENQUEUED_CALLS_PER_CALL
|
|
27
|
+
* and sending each batch directly to the node.
|
|
28
|
+
*
|
|
29
|
+
* @param node - The Aztec node to simulate on.
|
|
30
|
+
* @param publicStaticCalls - Array of public static function calls to optimize.
|
|
31
|
+
* @param from - The account address making the calls.
|
|
32
|
+
* @param chainInfo - Chain information (chainId and version).
|
|
33
|
+
* @param gasSettings - Gas settings for the transaction.
|
|
34
|
+
* @param blockHeader - Block header to use as anchor.
|
|
35
|
+
* @param skipFeeEnforcement - Whether to skip fee enforcement during simulation.
|
|
36
|
+
* @returns Array of TxSimulationResult, one per batch.
|
|
37
|
+
*/
|
|
38
|
+
export declare function simulateViaNode(node: AztecNode, publicStaticCalls: FunctionCall[], from: AztecAddress, chainInfo: ChainInfo, gasSettings: GasSettings, blockHeader: BlockHeader, skipFeeEnforcement: boolean | undefined, getContractName: ContractNameResolver): Promise<TxSimulationResult[]>;
|
|
39
|
+
/**
|
|
40
|
+
* Merges simulation results from the optimized (public static) and normal paths.
|
|
41
|
+
* Since optimized calls are always a leading prefix, return values are simply
|
|
42
|
+
* concatenated: optimized first, then normal.
|
|
43
|
+
* Stats are taken from the normal result only (the optimized path doesn't produce them).
|
|
44
|
+
*
|
|
45
|
+
* @param optimizedResults - Results from optimized public static call batches.
|
|
46
|
+
* @param normalResult - Result from normal simulation (null if all calls were optimized).
|
|
47
|
+
* @returns A single TxSimulationResult with return values in original call order.
|
|
48
|
+
*/
|
|
49
|
+
export declare function buildMergedSimulationResult(optimizedResults: TxSimulationResult[], normalResult: TxSimulationResultWithAppOffset | null): TxSimulationResultWithAppOffset;
|
|
50
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9iYXNlLXdhbGxldC91dGlscy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssRUFBRSxTQUFTLEVBQUUsTUFBTSxzQkFBc0IsQ0FBQztBQUN0RCxPQUFPLEVBQUUsK0JBQStCLEVBQUUsTUFBTSx3QkFBd0IsQ0FBQztBQUV6RSxPQUFPLEtBQUssRUFBRSxTQUFTLEVBQUUsTUFBTSwrQkFBK0IsQ0FBQztBQUkvRCxPQUFPLEtBQUssRUFBRSxvQkFBb0IsRUFBRSxNQUFNLHdCQUF3QixDQUFDO0FBR25FLE9BQU8sRUFBRSxLQUFLLFlBQVksRUFBb0IsTUFBTSxtQkFBbUIsQ0FBQztBQUN4RSxPQUFPLEtBQUssRUFBRSxZQUFZLEVBQUUsTUFBTSw2QkFBNkIsQ0FBQztBQUNoRSxPQUFPLEtBQUssRUFBRSxXQUFXLEVBQUUsTUFBTSxtQkFBbUIsQ0FBQztBQVFyRCxPQUFPLEVBQ0wsS0FBSyxXQUFXLEVBQ2hCLEtBQUssZ0JBQWdCLEVBT3JCLGtCQUFrQixFQUNuQixNQUFNLGtCQUFrQixDQUFDO0FBRTFCOzs7Ozs7Ozs7R0FTRztBQUNILHdCQUFnQixtQ0FBbUMsQ0FBQyxPQUFPLEVBQUUsZ0JBQWdCLEdBQUc7SUFDOUUsdUVBQXVFO0lBQ3ZFLGdCQUFnQixFQUFFLFlBQVksRUFBRSxDQUFDO0lBQ2pDLDJCQUEyQjtJQUMzQixjQUFjLEVBQUUsWUFBWSxFQUFFLENBQUM7Q0FDaEMsQ0FPQTtBQXVHRDs7Ozs7Ozs7Ozs7O0dBWUc7QUFDSCx3QkFBc0IsZUFBZSxDQUNuQyxJQUFJLEVBQUUsU0FBUyxFQUNmLGlCQUFpQixFQUFFLFlBQVksRUFBRSxFQUNqQyxJQUFJLEVBQUUsWUFBWSxFQUNsQixTQUFTLEVBQUUsU0FBUyxFQUNwQixXQUFXLEVBQUUsV0FBVyxFQUN4QixXQUFXLEVBQUUsV0FBVyxFQUN4QixrQkFBa0IscUJBQWdCLEVBQ2xDLGVBQWUsRUFBRSxvQkFBb0IsR0FDcEMsT0FBTyxDQUFDLGtCQUFrQixFQUFFLENBQUMsQ0F3Qi9CO0FBRUQ7Ozs7Ozs7OztHQVNHO0FBQ0gsd0JBQWdCLDJCQUEyQixDQUN6QyxnQkFBZ0IsRUFBRSxrQkFBa0IsRUFBRSxFQUN0QyxZQUFZLEVBQUUsK0JBQStCLEdBQUcsSUFBSSxHQUNuRCwrQkFBK0IsQ0FxQmpDIn0=
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/base-wallet/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,+BAA+B,EAAE,MAAM,wBAAwB,CAAC;AAEzE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAI/D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAGnE,OAAO,EAAE,KAAK,YAAY,EAAoB,MAAM,mBAAmB,CAAC;AACxE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAQrD,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,gBAAgB,EAOrB,kBAAkB,EACnB,MAAM,kBAAkB,CAAC;AAE1B;;;;;;;;;GASG;AACH,wBAAgB,mCAAmC,CAAC,OAAO,EAAE,gBAAgB,GAAG;IAC9E,uEAAuE;IACvE,gBAAgB,EAAE,YAAY,EAAE,CAAC;IACjC,2BAA2B;IAC3B,cAAc,EAAE,YAAY,EAAE,CAAC;CAChC,CAOA;AAuGD;;;;;;;;;;;;GAYG;AACH,wBAAsB,eAAe,CACnC,IAAI,EAAE,SAAS,EACf,iBAAiB,EAAE,YAAY,EAAE,EACjC,IAAI,EAAE,YAAY,EAClB,SAAS,EAAE,SAAS,EACpB,WAAW,EAAE,WAAW,EACxB,WAAW,EAAE,WAAW,EACxB,kBAAkB,qBAAgB,EAClC,eAAe,EAAE,oBAAoB,GACpC,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAwB/B;AAED;;;;;;;;;GASG;AACH,wBAAgB,2BAA2B,CACzC,gBAAgB,EAAE,kBAAkB,EAAE,EACtC,YAAY,EAAE,+BAA+B,GAAG,IAAI,GACnD,+BAA+B,CAqBjC"}
|