@aztec/wallet-sdk 0.0.1-commit.8afd444 → 0.0.1-commit.8c0b8ff
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/dest/base-wallet/base_wallet.d.ts +61 -34
- package/dest/base-wallet/base_wallet.d.ts.map +1 -1
- package/dest/base-wallet/base_wallet.js +201 -66
- 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 +39 -1
- package/dest/crypto.d.ts.map +1 -1
- package/dest/crypto.js +88 -0
- package/dest/extension/provider/extension_wallet.d.ts +4 -6
- package/dest/extension/provider/extension_wallet.d.ts.map +1 -1
- package/dest/extension/provider/extension_wallet.js +9 -2
- package/dest/extension/provider/index.d.ts +2 -2
- package/dest/extension/provider/index.d.ts.map +1 -1
- 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/types.d.ts +6 -5
- package/dest/manager/types.d.ts.map +1 -1
- package/dest/manager/wallet_manager.d.ts +1 -1
- package/dest/manager/wallet_manager.d.ts.map +1 -1
- package/dest/manager/wallet_manager.js +48 -18
- package/dest/types.d.ts +14 -2
- package/dest/types.d.ts.map +1 -1
- package/dest/types.js +4 -0
- package/package.json +19 -9
- package/src/base-wallet/base_wallet.ts +284 -118
- package/src/base-wallet/index.ts +7 -1
- package/src/base-wallet/utils.ts +240 -0
- package/src/crypto.ts +104 -0
- package/src/extension/provider/extension_wallet.ts +13 -10
- package/src/extension/provider/index.ts +1 -1
- 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/types.ts +5 -4
- package/src/manager/wallet_manager.ts +55 -23
- package/src/types.ts +13 -0
|
@@ -1,32 +1,37 @@
|
|
|
1
|
-
import type { Account } from '@aztec/aztec.js/account';
|
|
1
|
+
import type { Account, NoFrom } from '@aztec/aztec.js/account';
|
|
2
|
+
import { NO_FROM } from '@aztec/aztec.js/account';
|
|
2
3
|
import type { CallIntent, IntentInnerHash } from '@aztec/aztec.js/authorization';
|
|
3
|
-
import {
|
|
4
|
+
import {
|
|
5
|
+
type InteractionWaitOptions,
|
|
6
|
+
NO_WAIT,
|
|
7
|
+
type SendReturn,
|
|
8
|
+
extractOffchainOutput,
|
|
9
|
+
} from '@aztec/aztec.js/contracts';
|
|
4
10
|
import type { FeePaymentMethod } from '@aztec/aztec.js/fee';
|
|
5
11
|
import { waitForTx } from '@aztec/aztec.js/node';
|
|
6
|
-
import type {
|
|
7
|
-
Aliased,
|
|
8
|
-
AppCapabilities,
|
|
9
|
-
BatchResults,
|
|
10
|
-
BatchedMethod,
|
|
11
|
-
PrivateEvent,
|
|
12
|
-
PrivateEventFilter,
|
|
13
|
-
ProfileOptions,
|
|
14
|
-
SendOptions,
|
|
15
|
-
SimulateOptions,
|
|
16
|
-
Wallet,
|
|
17
|
-
WalletCapabilities,
|
|
18
|
-
} from '@aztec/aztec.js/wallet';
|
|
19
12
|
import {
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
13
|
+
type Aliased,
|
|
14
|
+
type AppCapabilities,
|
|
15
|
+
type BatchResults,
|
|
16
|
+
type BatchedMethod,
|
|
17
|
+
ContractInitializationStatus,
|
|
18
|
+
type ExecuteUtilityOptions,
|
|
19
|
+
type PrivateEvent,
|
|
20
|
+
type PrivateEventFilter,
|
|
21
|
+
type ProfileOptions,
|
|
22
|
+
type SendOptions,
|
|
23
|
+
type SimulateOptions,
|
|
24
|
+
TxSimulationResultWithAppOffset,
|
|
25
|
+
type Wallet,
|
|
26
|
+
type WalletCapabilities,
|
|
27
|
+
} from '@aztec/aztec.js/wallet';
|
|
25
28
|
import { AccountFeePaymentMethodOptions, type DefaultAccountEntrypointOptions } from '@aztec/entrypoints/account';
|
|
29
|
+
import { DefaultEntrypoint } from '@aztec/entrypoints/default';
|
|
26
30
|
import type { ChainInfo } from '@aztec/entrypoints/interfaces';
|
|
27
31
|
import { Fr } from '@aztec/foundation/curves/bn254';
|
|
28
32
|
import { createLogger } from '@aztec/foundation/log';
|
|
29
33
|
import type { FieldsOf } from '@aztec/foundation/types';
|
|
34
|
+
import { displayDebugLogs } from '@aztec/pxe/client/lazy';
|
|
30
35
|
import type { PXE, PackedPrivateEvent } from '@aztec/pxe/server';
|
|
31
36
|
import {
|
|
32
37
|
type ContractArtifact,
|
|
@@ -35,26 +40,32 @@ import {
|
|
|
35
40
|
decodeFromAbi,
|
|
36
41
|
} from '@aztec/stdlib/abi';
|
|
37
42
|
import type { AuthWitness } from '@aztec/stdlib/auth-witness';
|
|
38
|
-
import
|
|
43
|
+
import { AztecAddress } from '@aztec/stdlib/aztec-address';
|
|
39
44
|
import {
|
|
40
45
|
type ContractInstanceWithAddress,
|
|
46
|
+
type NodeInfo,
|
|
41
47
|
computePartialAddress,
|
|
42
48
|
getContractClassFromArtifact,
|
|
43
49
|
} from '@aztec/stdlib/contract';
|
|
44
50
|
import { SimulationError } from '@aztec/stdlib/errors';
|
|
45
|
-
import { Gas, GasSettings } from '@aztec/stdlib/gas';
|
|
46
|
-
import {
|
|
51
|
+
import { Gas, GasFees, GasSettings } from '@aztec/stdlib/gas';
|
|
52
|
+
import {
|
|
53
|
+
computeSiloedPrivateInitializationNullifier,
|
|
54
|
+
computeSiloedPublicInitializationNullifier,
|
|
55
|
+
} from '@aztec/stdlib/hash';
|
|
47
56
|
import type { AztecNode } from '@aztec/stdlib/interfaces/client';
|
|
48
|
-
import
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
57
|
+
import {
|
|
58
|
+
BlockHeader,
|
|
59
|
+
type TxExecutionRequest,
|
|
60
|
+
type TxProfileResult,
|
|
61
|
+
type UtilityExecutionResult,
|
|
53
62
|
} from '@aztec/stdlib/tx';
|
|
54
63
|
import { ExecutionPayload, mergeExecutionPayloads } from '@aztec/stdlib/tx';
|
|
55
64
|
|
|
56
65
|
import { inspect } from 'util';
|
|
57
66
|
|
|
67
|
+
import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simulateViaNode } from './utils.js';
|
|
68
|
+
|
|
58
69
|
/**
|
|
59
70
|
* Options to configure fee payment for a transaction
|
|
60
71
|
*/
|
|
@@ -65,26 +76,55 @@ export type FeeOptions = {
|
|
|
65
76
|
*/
|
|
66
77
|
walletFeePaymentMethod?: FeePaymentMethod;
|
|
67
78
|
/** Configuration options for the account to properly handle the selected fee payment method */
|
|
68
|
-
accountFeePaymentMethodOptions
|
|
79
|
+
accountFeePaymentMethodOptions?: AccountFeePaymentMethodOptions;
|
|
69
80
|
/** The gas settings to use for the transaction */
|
|
70
81
|
gasSettings: GasSettings;
|
|
71
82
|
};
|
|
72
83
|
|
|
84
|
+
/** Options for `simulateViaEntrypoint`. */
|
|
85
|
+
export type SimulateViaEntrypointOptions = Pick<
|
|
86
|
+
SimulateOptions,
|
|
87
|
+
'from' | 'additionalScopes' | 'skipTxValidation' | 'skipFeeEnforcement'
|
|
88
|
+
> & {
|
|
89
|
+
/** Fee options for the entrypoint */
|
|
90
|
+
feeOptions: FeeOptions;
|
|
91
|
+
};
|
|
92
|
+
|
|
93
|
+
/** Options for `completeFeeOptions`. */
|
|
94
|
+
export type CompleteFeeOptionsConfig = {
|
|
95
|
+
/** The address where the transaction is being sent from. */
|
|
96
|
+
from: AztecAddress | NoFrom;
|
|
97
|
+
/** The address paying for fees (if any fee payment method is embedded in the execution payload). */
|
|
98
|
+
feePayer?: AztecAddress;
|
|
99
|
+
/** User-provided partial gas settings. */
|
|
100
|
+
gasSettings?: Partial<FieldsOf<GasSettings>>;
|
|
101
|
+
/** If true, returns gas settings with high gas limits for estimation. If false, uses fallback limits. */
|
|
102
|
+
forEstimation?: boolean;
|
|
103
|
+
};
|
|
104
|
+
|
|
73
105
|
/**
|
|
74
106
|
* A base class for Wallet implementations
|
|
75
107
|
*/
|
|
76
108
|
export abstract class BaseWallet implements Wallet {
|
|
77
|
-
protected log = createLogger('wallet-sdk:base_wallet');
|
|
78
|
-
|
|
79
109
|
protected minFeePadding = 0.5;
|
|
80
110
|
protected cancellableTransactions = false;
|
|
111
|
+
// A wallet is instantiated for a particular chain, so chain info never changes during its lifetime.
|
|
112
|
+
// We cache it here because getChainInfo is called frequently (every tx simulation, send, auth wit, etc.).
|
|
113
|
+
private nodeInfoPromise: Promise<NodeInfo> | undefined;
|
|
81
114
|
|
|
82
115
|
// Protected because we want to force wallets to instantiate their own PXE.
|
|
83
116
|
protected constructor(
|
|
84
117
|
protected readonly pxe: PXE,
|
|
85
118
|
protected readonly aztecNode: AztecNode,
|
|
119
|
+
protected log = createLogger('wallet-sdk:base_wallet'),
|
|
86
120
|
) {}
|
|
87
121
|
|
|
122
|
+
protected scopesFrom(from: AztecAddress | NoFrom, additionalScopes: AztecAddress[] = []): AztecAddress[] {
|
|
123
|
+
const allScopes = from === NO_FROM ? additionalScopes : [from, ...additionalScopes];
|
|
124
|
+
const scopeSet = new Set(allScopes.map(address => address.toString()));
|
|
125
|
+
return [...scopeSet].map(AztecAddress.fromString);
|
|
126
|
+
}
|
|
127
|
+
|
|
88
128
|
protected abstract getAccountFromAddress(address: AztecAddress): Promise<Account>;
|
|
89
129
|
|
|
90
130
|
abstract getAccounts(): Promise<Aliased<AztecAddress>[]>;
|
|
@@ -102,32 +142,42 @@ export abstract class BaseWallet implements Wallet {
|
|
|
102
142
|
}
|
|
103
143
|
|
|
104
144
|
async getChainInfo(): Promise<ChainInfo> {
|
|
105
|
-
|
|
145
|
+
if (!this.nodeInfoPromise) {
|
|
146
|
+
this.nodeInfoPromise = this.aztecNode.getNodeInfo();
|
|
147
|
+
}
|
|
148
|
+
const { l1ChainId, rollupVersion } = await this.nodeInfoPromise;
|
|
106
149
|
return { chainId: new Fr(l1ChainId), version: new Fr(rollupVersion) };
|
|
107
150
|
}
|
|
108
151
|
|
|
109
152
|
protected async createTxExecutionRequestFromPayloadAndFee(
|
|
110
153
|
executionPayload: ExecutionPayload,
|
|
111
|
-
from: AztecAddress,
|
|
154
|
+
from: AztecAddress | NoFrom,
|
|
112
155
|
feeOptions: FeeOptions,
|
|
113
156
|
): Promise<TxExecutionRequest> {
|
|
114
157
|
const feeExecutionPayload = await feeOptions.walletFeePaymentMethod?.getExecutionPayload();
|
|
115
|
-
const executionOptions: DefaultAccountEntrypointOptions = {
|
|
116
|
-
txNonce: Fr.random(),
|
|
117
|
-
cancellable: this.cancellableTransactions,
|
|
118
|
-
feePaymentMethodOptions: feeOptions.accountFeePaymentMethodOptions,
|
|
119
|
-
};
|
|
120
158
|
const finalExecutionPayload = feeExecutionPayload
|
|
121
159
|
? mergeExecutionPayloads([feeExecutionPayload, executionPayload])
|
|
122
160
|
: executionPayload;
|
|
123
|
-
const fromAccount = await this.getAccountFromAddress(from);
|
|
124
161
|
const chainInfo = await this.getChainInfo();
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
chainInfo
|
|
129
|
-
|
|
130
|
-
|
|
162
|
+
|
|
163
|
+
if (from === NO_FROM) {
|
|
164
|
+
const entrypoint = new DefaultEntrypoint();
|
|
165
|
+
return entrypoint.createTxExecutionRequest(finalExecutionPayload, feeOptions.gasSettings, chainInfo);
|
|
166
|
+
} else {
|
|
167
|
+
const fromAccount = await this.getAccountFromAddress(from);
|
|
168
|
+
const executionOptions: DefaultAccountEntrypointOptions = {
|
|
169
|
+
txNonce: Fr.random(),
|
|
170
|
+
cancellable: this.cancellableTransactions,
|
|
171
|
+
// If from is an address, feeOptions include the way the account contract should handle the fee payment
|
|
172
|
+
feePaymentMethodOptions: feeOptions.accountFeePaymentMethodOptions!,
|
|
173
|
+
};
|
|
174
|
+
return fromAccount.createTxExecutionRequest(
|
|
175
|
+
finalExecutionPayload,
|
|
176
|
+
feeOptions.gasSettings,
|
|
177
|
+
chainInfo,
|
|
178
|
+
executionOptions,
|
|
179
|
+
);
|
|
180
|
+
}
|
|
131
181
|
}
|
|
132
182
|
|
|
133
183
|
public async createAuthWit(
|
|
@@ -176,31 +226,39 @@ export abstract class BaseWallet implements Wallet {
|
|
|
176
226
|
|
|
177
227
|
/**
|
|
178
228
|
* Completes partial user-provided fee options with wallet defaults.
|
|
179
|
-
* @param
|
|
180
|
-
* @param feePayer - The address paying for fees (if any fee payment method is embedded in the execution payload)
|
|
181
|
-
* @param gasSettings - User-provided partial gas settings
|
|
182
|
-
* @returns - Complete fee options that can be used to create a transaction execution request
|
|
229
|
+
* @param config - Fee completion config.
|
|
183
230
|
*/
|
|
184
|
-
protected async completeFeeOptions(
|
|
185
|
-
from
|
|
186
|
-
feePayer?: AztecAddress,
|
|
187
|
-
gasSettings?: Partial<FieldsOf<GasSettings>>,
|
|
188
|
-
): Promise<FeeOptions> {
|
|
231
|
+
protected async completeFeeOptions(config: CompleteFeeOptionsConfig): Promise<FeeOptions> {
|
|
232
|
+
const { from, feePayer, gasSettings, forEstimation } = config;
|
|
189
233
|
const maxFeesPerGas =
|
|
190
234
|
gasSettings?.maxFeesPerGas ?? (await this.aztecNode.getCurrentMinFees()).mul(1 + this.minFeePadding);
|
|
191
235
|
let accountFeePaymentMethodOptions;
|
|
192
|
-
//
|
|
193
|
-
//
|
|
194
|
-
if (
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
236
|
+
// If from is an address, we need to determine the appropriate fee payment method options for the
|
|
237
|
+
// account contract entrypoint to use
|
|
238
|
+
if (from !== NO_FROM) {
|
|
239
|
+
if (!feePayer) {
|
|
240
|
+
// The transaction does not include a fee payment method, so we set the flag
|
|
241
|
+
// for the account to use its fee juice balance
|
|
242
|
+
accountFeePaymentMethodOptions = AccountFeePaymentMethodOptions.PREEXISTING_FEE_JUICE;
|
|
243
|
+
} else {
|
|
244
|
+
// The transaction includes fee payment method, so we check if we are the fee payer for it
|
|
245
|
+
// (this can only happen if the embedded payment method is FeeJuiceWithClaim)
|
|
246
|
+
accountFeePaymentMethodOptions = from.equals(feePayer)
|
|
247
|
+
? AccountFeePaymentMethodOptions.FEE_JUICE_WITH_CLAIM
|
|
248
|
+
: AccountFeePaymentMethodOptions.EXTERNAL;
|
|
249
|
+
}
|
|
202
250
|
}
|
|
203
|
-
const
|
|
251
|
+
const gasSettingsOverrides = {
|
|
252
|
+
gasLimits: gasSettings?.gasLimits ? Gas.from(gasSettings.gasLimits) : undefined,
|
|
253
|
+
teardownGasLimits: gasSettings?.teardownGasLimits ? Gas.from(gasSettings.teardownGasLimits) : undefined,
|
|
254
|
+
maxFeesPerGas,
|
|
255
|
+
maxPriorityFeesPerGas: gasSettings?.maxPriorityFeesPerGas ?? GasFees.empty(),
|
|
256
|
+
};
|
|
257
|
+
// When estimating gas (simulation), use high limits so the simulation doesn't run out of gas.
|
|
258
|
+
// When sending for real, use protocol max limits that the network will actually accept.
|
|
259
|
+
const fullGasSettings = forEstimation
|
|
260
|
+
? GasSettings.forEstimation(gasSettingsOverrides)
|
|
261
|
+
: GasSettings.fallback(gasSettingsOverrides);
|
|
204
262
|
this.log.debug(`Using L2 gas settings`, fullGasSettings);
|
|
205
263
|
return {
|
|
206
264
|
gasSettings: fullGasSettings,
|
|
@@ -209,37 +267,6 @@ export abstract class BaseWallet implements Wallet {
|
|
|
209
267
|
};
|
|
210
268
|
}
|
|
211
269
|
|
|
212
|
-
/**
|
|
213
|
-
* Completes partial user-provided fee options with unreasonably high gas limits
|
|
214
|
-
* for gas estimation. Uses the same logic as completeFeeOptions but sets high limits
|
|
215
|
-
* to avoid running out of gas during estimation.
|
|
216
|
-
* @param from - The address where the transaction is being sent from
|
|
217
|
-
* @param feePayer - The address paying for fees (if any fee payment method is embedded in the execution payload)
|
|
218
|
-
* @param gasSettings - User-provided partial gas settings
|
|
219
|
-
*/
|
|
220
|
-
protected async completeFeeOptionsForEstimation(
|
|
221
|
-
from: AztecAddress,
|
|
222
|
-
feePayer?: AztecAddress,
|
|
223
|
-
gasSettings?: Partial<FieldsOf<GasSettings>>,
|
|
224
|
-
) {
|
|
225
|
-
const defaultFeeOptions = await this.completeFeeOptions(from, feePayer, gasSettings);
|
|
226
|
-
const {
|
|
227
|
-
gasSettings: { maxFeesPerGas, maxPriorityFeesPerGas },
|
|
228
|
-
} = defaultFeeOptions;
|
|
229
|
-
// Use unrealistically high gas limits for estimation to avoid running out of gas.
|
|
230
|
-
// They will be tuned down after the simulation.
|
|
231
|
-
const gasSettingsForEstimation = new GasSettings(
|
|
232
|
-
new Gas(GAS_ESTIMATION_DA_GAS_LIMIT, GAS_ESTIMATION_L2_GAS_LIMIT),
|
|
233
|
-
new Gas(GAS_ESTIMATION_TEARDOWN_DA_GAS_LIMIT, GAS_ESTIMATION_TEARDOWN_L2_GAS_LIMIT),
|
|
234
|
-
maxFeesPerGas,
|
|
235
|
-
maxPriorityFeesPerGas,
|
|
236
|
-
);
|
|
237
|
-
return {
|
|
238
|
-
...defaultFeeOptions,
|
|
239
|
-
gasSettings: gasSettingsForEstimation,
|
|
240
|
-
};
|
|
241
|
-
}
|
|
242
|
-
|
|
243
270
|
registerSender(address: AztecAddress, _alias: string = ''): Promise<AztecAddress> {
|
|
244
271
|
return this.pxe.registerSender(address);
|
|
245
272
|
}
|
|
@@ -282,32 +309,129 @@ export abstract class BaseWallet implements Wallet {
|
|
|
282
309
|
return instance;
|
|
283
310
|
}
|
|
284
311
|
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
opts
|
|
294
|
-
opts
|
|
312
|
+
/**
|
|
313
|
+
* Simulates calls through the standard PXE path (account entrypoint).
|
|
314
|
+
* @param executionPayload - The execution payload to simulate.
|
|
315
|
+
* @param opts - Simulation options.
|
|
316
|
+
*/
|
|
317
|
+
protected async simulateViaEntrypoint(executionPayload: ExecutionPayload, opts: SimulateViaEntrypointOptions) {
|
|
318
|
+
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(
|
|
319
|
+
executionPayload,
|
|
320
|
+
opts.from,
|
|
321
|
+
opts.feeOptions,
|
|
295
322
|
);
|
|
323
|
+
const result = await this.pxe.simulateTx(txRequest, {
|
|
324
|
+
simulatePublic: true,
|
|
325
|
+
skipTxValidation: opts.skipTxValidation,
|
|
326
|
+
skipFeeEnforcement: opts.skipFeeEnforcement,
|
|
327
|
+
scopes: this.scopesFrom(opts.from, opts.additionalScopes),
|
|
328
|
+
});
|
|
329
|
+
const appCallOffset = await this.computeAppCallOffset(opts.from, opts.feeOptions);
|
|
330
|
+
return TxSimulationResultWithAppOffset.fromResultAndOffset(result, appCallOffset);
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
/**
|
|
334
|
+
* Computes the index where the app's calls begin in the flattened array of calls (0 = entrypoint/root, 1..N = fee
|
|
335
|
+
* calls, N+1 = app).
|
|
336
|
+
* @param from - The sender address, or NO_FROM for the default entrypoint.
|
|
337
|
+
* @param feeOptions - Fee options containing the wallet fee payment method.
|
|
338
|
+
*/
|
|
339
|
+
protected async computeAppCallOffset(from: AztecAddress | NoFrom, feeOptions: FeeOptions): Promise<number> {
|
|
340
|
+
if (from === NO_FROM) {
|
|
341
|
+
return 0;
|
|
342
|
+
}
|
|
343
|
+
const feeExecutionPayload = await feeOptions.walletFeePaymentMethod?.getExecutionPayload();
|
|
344
|
+
return (feeExecutionPayload?.calls.length ?? 0) + 1; // +1 for entrypoint
|
|
345
|
+
}
|
|
346
|
+
|
|
347
|
+
/**
|
|
348
|
+
* Simulates a transaction, optimizing leading public static calls by running them directly
|
|
349
|
+
* on the node while sending the remaining calls through the standard PXE path.
|
|
350
|
+
* Return values from both paths are merged back in original call order.
|
|
351
|
+
* @param executionPayload - The execution payload to simulate.
|
|
352
|
+
* @param opts - Simulation options (from address, fee settings, etc.).
|
|
353
|
+
* @returns The merged simulation result.
|
|
354
|
+
*/
|
|
355
|
+
async simulateTx(
|
|
356
|
+
executionPayload: ExecutionPayload,
|
|
357
|
+
opts: SimulateOptions,
|
|
358
|
+
): Promise<TxSimulationResultWithAppOffset> {
|
|
359
|
+
const feeOptions = await this.completeFeeOptions({
|
|
360
|
+
from: opts.from,
|
|
361
|
+
feePayer: executionPayload.feePayer,
|
|
362
|
+
gasSettings: opts.fee?.gasSettings,
|
|
363
|
+
forEstimation: true,
|
|
364
|
+
});
|
|
365
|
+
const { optimizableCalls, remainingCalls } = extractOptimizablePublicStaticCalls(executionPayload);
|
|
366
|
+
const remainingPayload = { ...executionPayload, calls: remainingCalls };
|
|
367
|
+
|
|
368
|
+
const chainInfo = await this.getChainInfo();
|
|
369
|
+
let blockHeader: BlockHeader;
|
|
370
|
+
// PXE might not be synced yet, so we pull the latest header from the node
|
|
371
|
+
// To keep things consistent, we'll always try with PXE first
|
|
372
|
+
try {
|
|
373
|
+
blockHeader = await this.pxe.getSyncedBlockHeader();
|
|
374
|
+
} catch {
|
|
375
|
+
blockHeader = (await this.aztecNode.getBlockHeader())!;
|
|
376
|
+
}
|
|
377
|
+
|
|
378
|
+
const simulationOrigin = opts.from === NO_FROM ? AztecAddress.ZERO : opts.from;
|
|
379
|
+
const [optimizedResults, normalResult] = await Promise.all([
|
|
380
|
+
optimizableCalls.length > 0
|
|
381
|
+
? simulateViaNode(
|
|
382
|
+
this.aztecNode,
|
|
383
|
+
optimizableCalls,
|
|
384
|
+
simulationOrigin,
|
|
385
|
+
chainInfo,
|
|
386
|
+
feeOptions.gasSettings,
|
|
387
|
+
blockHeader,
|
|
388
|
+
opts.skipFeeEnforcement ?? true,
|
|
389
|
+
this.getContractName.bind(this),
|
|
390
|
+
)
|
|
391
|
+
: Promise.resolve([]),
|
|
392
|
+
remainingCalls.length > 0
|
|
393
|
+
? this.simulateViaEntrypoint(remainingPayload, {
|
|
394
|
+
from: opts.from,
|
|
395
|
+
feeOptions,
|
|
396
|
+
additionalScopes: opts.additionalScopes,
|
|
397
|
+
skipTxValidation: opts.skipTxValidation,
|
|
398
|
+
skipFeeEnforcement: opts.skipFeeEnforcement ?? true,
|
|
399
|
+
})
|
|
400
|
+
: Promise.resolve(null),
|
|
401
|
+
]);
|
|
402
|
+
|
|
403
|
+
return buildMergedSimulationResult(optimizedResults, normalResult);
|
|
296
404
|
}
|
|
297
405
|
|
|
298
406
|
async profileTx(executionPayload: ExecutionPayload, opts: ProfileOptions): Promise<TxProfileResult> {
|
|
299
|
-
const feeOptions = await this.completeFeeOptions(
|
|
407
|
+
const feeOptions = await this.completeFeeOptions({
|
|
408
|
+
from: opts.from,
|
|
409
|
+
feePayer: executionPayload.feePayer,
|
|
410
|
+
gasSettings: opts.fee?.gasSettings,
|
|
411
|
+
});
|
|
300
412
|
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
|
|
301
|
-
return this.pxe.profileTx(txRequest,
|
|
413
|
+
return this.pxe.profileTx(txRequest, {
|
|
414
|
+
profileMode: opts.profileMode,
|
|
415
|
+
skipProofGeneration: opts.skipProofGeneration ?? true,
|
|
416
|
+
scopes: this.scopesFrom(opts.from, opts.additionalScopes),
|
|
417
|
+
});
|
|
302
418
|
}
|
|
303
419
|
|
|
304
420
|
public async sendTx<W extends InteractionWaitOptions = undefined>(
|
|
305
421
|
executionPayload: ExecutionPayload,
|
|
306
422
|
opts: SendOptions<W>,
|
|
307
423
|
): Promise<SendReturn<W>> {
|
|
308
|
-
const feeOptions = await this.completeFeeOptions(
|
|
424
|
+
const feeOptions = await this.completeFeeOptions({
|
|
425
|
+
from: opts.from,
|
|
426
|
+
feePayer: executionPayload.feePayer,
|
|
427
|
+
gasSettings: opts.fee?.gasSettings,
|
|
428
|
+
});
|
|
309
429
|
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
|
|
310
|
-
const provenTx = await this.pxe.proveTx(txRequest);
|
|
430
|
+
const provenTx = await this.pxe.proveTx(txRequest, this.scopesFrom(opts.from, opts.additionalScopes));
|
|
431
|
+
const offchainOutput = extractOffchainOutput(
|
|
432
|
+
provenTx.getOffchainEffects(),
|
|
433
|
+
provenTx.publicInputs.constants.anchorBlockHeader.globalVariables.timestamp,
|
|
434
|
+
);
|
|
311
435
|
const tx = await provenTx.toTx();
|
|
312
436
|
const txHash = tx.getTxHash();
|
|
313
437
|
if (await this.aztecNode.getTxEffect(txHash)) {
|
|
@@ -321,12 +445,32 @@ export abstract class BaseWallet implements Wallet {
|
|
|
321
445
|
|
|
322
446
|
// If wait is NO_WAIT, return txHash immediately
|
|
323
447
|
if (opts.wait === NO_WAIT) {
|
|
324
|
-
return txHash as SendReturn<W>;
|
|
448
|
+
return { txHash, ...offchainOutput } as SendReturn<W>;
|
|
325
449
|
}
|
|
326
450
|
|
|
327
451
|
// Otherwise, wait for the full receipt (default behavior on wait: undefined)
|
|
328
452
|
const waitOpts = typeof opts.wait === 'object' ? opts.wait : undefined;
|
|
329
|
-
|
|
453
|
+
const receipt = await waitForTx(this.aztecNode, txHash, waitOpts);
|
|
454
|
+
|
|
455
|
+
// Display debug logs from public execution if present (served in test mode only)
|
|
456
|
+
if (receipt.debugLogs?.length) {
|
|
457
|
+
await displayDebugLogs(receipt.debugLogs, this.getContractName.bind(this));
|
|
458
|
+
}
|
|
459
|
+
|
|
460
|
+
return { receipt, ...offchainOutput } as SendReturn<W>;
|
|
461
|
+
}
|
|
462
|
+
|
|
463
|
+
/**
|
|
464
|
+
* Resolves a contract address to a human-readable name via PXE, if available.
|
|
465
|
+
* @param address - The contract address to resolve.
|
|
466
|
+
*/
|
|
467
|
+
protected async getContractName(address: AztecAddress): Promise<string | undefined> {
|
|
468
|
+
const instance = await this.pxe.getContractInstance(address);
|
|
469
|
+
if (!instance) {
|
|
470
|
+
return undefined;
|
|
471
|
+
}
|
|
472
|
+
const artifact = await this.pxe.getContractArtifact(instance.currentContractClassId);
|
|
473
|
+
return artifact?.name;
|
|
330
474
|
}
|
|
331
475
|
|
|
332
476
|
protected contextualizeError(err: Error, ...context: string[]): Error {
|
|
@@ -343,8 +487,8 @@ export abstract class BaseWallet implements Wallet {
|
|
|
343
487
|
return err;
|
|
344
488
|
}
|
|
345
489
|
|
|
346
|
-
|
|
347
|
-
return this.pxe.
|
|
490
|
+
executeUtility(call: FunctionCall, opts: ExecuteUtilityOptions): Promise<UtilityExecutionResult> {
|
|
491
|
+
return this.pxe.executeUtility(call, { authwits: opts.authWitnesses, scopes: opts.scopes });
|
|
348
492
|
}
|
|
349
493
|
|
|
350
494
|
async getPrivateEvents<T>(
|
|
@@ -367,17 +511,39 @@ export abstract class BaseWallet implements Wallet {
|
|
|
367
511
|
return decodedEvents;
|
|
368
512
|
}
|
|
369
513
|
|
|
514
|
+
/**
|
|
515
|
+
* Returns metadata about a contract, including whether it has been initialized, published, and updated.
|
|
516
|
+
* @param address - The contract address to query.
|
|
517
|
+
*/
|
|
370
518
|
async getContractMetadata(address: AztecAddress) {
|
|
371
519
|
const instance = await this.pxe.getContractInstance(address);
|
|
372
|
-
const
|
|
373
|
-
|
|
374
|
-
|
|
520
|
+
const publiclyRegisteredContractPromise = this.aztecNode.getContract(address);
|
|
521
|
+
|
|
522
|
+
let initializationStatus: ContractInitializationStatus;
|
|
523
|
+
if (instance) {
|
|
524
|
+
// We have the instance, so we can compute the private initialization nullifier (which includes init_hash and is
|
|
525
|
+
// emitted by both private and public initializers) and get a definitive INITIALIZED/UNINITIALIZED answer.
|
|
526
|
+
const initNullifier = await computeSiloedPrivateInitializationNullifier(address, instance.initializationHash);
|
|
527
|
+
const witness = await this.aztecNode.getNullifierMembershipWitness('latest', initNullifier);
|
|
528
|
+
initializationStatus = witness
|
|
529
|
+
? ContractInitializationStatus.INITIALIZED
|
|
530
|
+
: ContractInitializationStatus.UNINITIALIZED;
|
|
531
|
+
} else {
|
|
532
|
+
// Without the instance we lack the init_hash needed for the private nullifier. We fall back to checking the
|
|
533
|
+
// public initialization nullifier (computed from address alone). Not all contracts emit it (only those with
|
|
534
|
+
// public functions that require initialization checks), so its absence doesn't mean the contract is
|
|
535
|
+
// uninitialized.
|
|
536
|
+
const publicNullifier = await computeSiloedPublicInitializationNullifier(address);
|
|
537
|
+
const witness = await this.aztecNode.getNullifierMembershipWitness('latest', publicNullifier);
|
|
538
|
+
initializationStatus = witness ? ContractInitializationStatus.INITIALIZED : ContractInitializationStatus.UNKNOWN;
|
|
539
|
+
}
|
|
540
|
+
const publiclyRegisteredContract = await publiclyRegisteredContractPromise;
|
|
375
541
|
const isContractUpdated =
|
|
376
542
|
publiclyRegisteredContract &&
|
|
377
543
|
!publiclyRegisteredContract.currentContractClassId.equals(publiclyRegisteredContract.originalContractClassId);
|
|
378
544
|
return {
|
|
379
545
|
instance: instance ?? undefined,
|
|
380
|
-
|
|
546
|
+
initializationStatus,
|
|
381
547
|
isContractPublished: !!publiclyRegisteredContract,
|
|
382
548
|
isContractUpdated: !!isContractUpdated,
|
|
383
549
|
updatedContractClassId: isContractUpdated ? publiclyRegisteredContract.currentContractClassId : undefined,
|
package/src/base-wallet/index.ts
CHANGED
|
@@ -1 +1,7 @@
|
|
|
1
|
-
export {
|
|
1
|
+
export {
|
|
2
|
+
BaseWallet,
|
|
3
|
+
type CompleteFeeOptionsConfig,
|
|
4
|
+
type FeeOptions,
|
|
5
|
+
type SimulateViaEntrypointOptions,
|
|
6
|
+
} from './base_wallet.js';
|
|
7
|
+
export { simulateViaNode, buildMergedSimulationResult, extractOptimizablePublicStaticCalls } from './utils.js';
|