@aztec/wallet-sdk 0.0.1-commit.54489865 → 0.0.1-commit.5914bae
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 +75 -34
- package/dest/base-wallet/base_wallet.d.ts.map +1 -1
- package/dest/base-wallet/base_wallet.js +216 -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 +301 -116
- 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,30 +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
|
-
BatchResults,
|
|
9
|
-
BatchedMethod,
|
|
10
|
-
PrivateEvent,
|
|
11
|
-
PrivateEventFilter,
|
|
12
|
-
ProfileOptions,
|
|
13
|
-
SendOptions,
|
|
14
|
-
SimulateOptions,
|
|
15
|
-
Wallet,
|
|
16
|
-
} from '@aztec/aztec.js/wallet';
|
|
17
12
|
import {
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
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';
|
|
23
28
|
import { AccountFeePaymentMethodOptions, type DefaultAccountEntrypointOptions } from '@aztec/entrypoints/account';
|
|
29
|
+
import { DefaultEntrypoint } from '@aztec/entrypoints/default';
|
|
24
30
|
import type { ChainInfo } from '@aztec/entrypoints/interfaces';
|
|
25
31
|
import { Fr } from '@aztec/foundation/curves/bn254';
|
|
26
32
|
import { createLogger } from '@aztec/foundation/log';
|
|
27
33
|
import type { FieldsOf } from '@aztec/foundation/types';
|
|
34
|
+
import { displayDebugLogs } from '@aztec/pxe/client/lazy';
|
|
28
35
|
import type { PXE, PackedPrivateEvent } from '@aztec/pxe/server';
|
|
29
36
|
import {
|
|
30
37
|
type ContractArtifact,
|
|
@@ -33,26 +40,32 @@ import {
|
|
|
33
40
|
decodeFromAbi,
|
|
34
41
|
} from '@aztec/stdlib/abi';
|
|
35
42
|
import type { AuthWitness } from '@aztec/stdlib/auth-witness';
|
|
36
|
-
import
|
|
43
|
+
import { AztecAddress } from '@aztec/stdlib/aztec-address';
|
|
37
44
|
import {
|
|
38
45
|
type ContractInstanceWithAddress,
|
|
46
|
+
type NodeInfo,
|
|
39
47
|
computePartialAddress,
|
|
40
48
|
getContractClassFromArtifact,
|
|
41
49
|
} from '@aztec/stdlib/contract';
|
|
42
50
|
import { SimulationError } from '@aztec/stdlib/errors';
|
|
43
|
-
import { Gas, GasSettings } from '@aztec/stdlib/gas';
|
|
44
|
-
import {
|
|
51
|
+
import { Gas, GasFees, GasSettings } from '@aztec/stdlib/gas';
|
|
52
|
+
import {
|
|
53
|
+
computeSiloedPrivateInitializationNullifier,
|
|
54
|
+
computeSiloedPublicInitializationNullifier,
|
|
55
|
+
} from '@aztec/stdlib/hash';
|
|
45
56
|
import type { AztecNode } from '@aztec/stdlib/interfaces/client';
|
|
46
|
-
import
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
57
|
+
import {
|
|
58
|
+
BlockHeader,
|
|
59
|
+
type TxExecutionRequest,
|
|
60
|
+
type TxProfileResult,
|
|
61
|
+
type UtilityExecutionResult,
|
|
51
62
|
} from '@aztec/stdlib/tx';
|
|
52
63
|
import { ExecutionPayload, mergeExecutionPayloads } from '@aztec/stdlib/tx';
|
|
53
64
|
|
|
54
65
|
import { inspect } from 'util';
|
|
55
66
|
|
|
67
|
+
import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simulateViaNode } from './utils.js';
|
|
68
|
+
|
|
56
69
|
/**
|
|
57
70
|
* Options to configure fee payment for a transaction
|
|
58
71
|
*/
|
|
@@ -63,26 +76,55 @@ export type FeeOptions = {
|
|
|
63
76
|
*/
|
|
64
77
|
walletFeePaymentMethod?: FeePaymentMethod;
|
|
65
78
|
/** Configuration options for the account to properly handle the selected fee payment method */
|
|
66
|
-
accountFeePaymentMethodOptions
|
|
79
|
+
accountFeePaymentMethodOptions?: AccountFeePaymentMethodOptions;
|
|
67
80
|
/** The gas settings to use for the transaction */
|
|
68
81
|
gasSettings: GasSettings;
|
|
69
82
|
};
|
|
70
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
|
+
|
|
71
105
|
/**
|
|
72
106
|
* A base class for Wallet implementations
|
|
73
107
|
*/
|
|
74
108
|
export abstract class BaseWallet implements Wallet {
|
|
75
|
-
protected log = createLogger('wallet-sdk:base_wallet');
|
|
76
|
-
|
|
77
109
|
protected minFeePadding = 0.5;
|
|
78
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;
|
|
79
114
|
|
|
80
115
|
// Protected because we want to force wallets to instantiate their own PXE.
|
|
81
116
|
protected constructor(
|
|
82
117
|
protected readonly pxe: PXE,
|
|
83
118
|
protected readonly aztecNode: AztecNode,
|
|
119
|
+
protected log = createLogger('wallet-sdk:base_wallet'),
|
|
84
120
|
) {}
|
|
85
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
|
+
|
|
86
128
|
protected abstract getAccountFromAddress(address: AztecAddress): Promise<Account>;
|
|
87
129
|
|
|
88
130
|
abstract getAccounts(): Promise<Aliased<AztecAddress>[]>;
|
|
@@ -100,32 +142,42 @@ export abstract class BaseWallet implements Wallet {
|
|
|
100
142
|
}
|
|
101
143
|
|
|
102
144
|
async getChainInfo(): Promise<ChainInfo> {
|
|
103
|
-
|
|
145
|
+
if (!this.nodeInfoPromise) {
|
|
146
|
+
this.nodeInfoPromise = this.aztecNode.getNodeInfo();
|
|
147
|
+
}
|
|
148
|
+
const { l1ChainId, rollupVersion } = await this.nodeInfoPromise;
|
|
104
149
|
return { chainId: new Fr(l1ChainId), version: new Fr(rollupVersion) };
|
|
105
150
|
}
|
|
106
151
|
|
|
107
152
|
protected async createTxExecutionRequestFromPayloadAndFee(
|
|
108
153
|
executionPayload: ExecutionPayload,
|
|
109
|
-
from: AztecAddress,
|
|
154
|
+
from: AztecAddress | NoFrom,
|
|
110
155
|
feeOptions: FeeOptions,
|
|
111
156
|
): Promise<TxExecutionRequest> {
|
|
112
157
|
const feeExecutionPayload = await feeOptions.walletFeePaymentMethod?.getExecutionPayload();
|
|
113
|
-
const executionOptions: DefaultAccountEntrypointOptions = {
|
|
114
|
-
txNonce: Fr.random(),
|
|
115
|
-
cancellable: this.cancellableTransactions,
|
|
116
|
-
feePaymentMethodOptions: feeOptions.accountFeePaymentMethodOptions,
|
|
117
|
-
};
|
|
118
158
|
const finalExecutionPayload = feeExecutionPayload
|
|
119
159
|
? mergeExecutionPayloads([feeExecutionPayload, executionPayload])
|
|
120
160
|
: executionPayload;
|
|
121
|
-
const fromAccount = await this.getAccountFromAddress(from);
|
|
122
161
|
const chainInfo = await this.getChainInfo();
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
chainInfo
|
|
127
|
-
|
|
128
|
-
|
|
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
|
+
}
|
|
129
181
|
}
|
|
130
182
|
|
|
131
183
|
public async createAuthWit(
|
|
@@ -137,6 +189,23 @@ export abstract class BaseWallet implements Wallet {
|
|
|
137
189
|
return account.createAuthWit(messageHashOrIntent, chainInfo);
|
|
138
190
|
}
|
|
139
191
|
|
|
192
|
+
/**
|
|
193
|
+
* Request capabilities from the wallet.
|
|
194
|
+
*
|
|
195
|
+
* This method is wallet-implementation-dependent and must be provided by classes extending BaseWallet.
|
|
196
|
+
* Embedded wallets typically don't support capability-based authorization (no user authorization flow),
|
|
197
|
+
* while external wallets (browser extensions, hardware wallets) implement this to reduce authorization
|
|
198
|
+
* friction by allowing apps to request permissions upfront.
|
|
199
|
+
*
|
|
200
|
+
* TODO: Consider making it abstract so implementing it is a conscious decision. Leaving it as-is
|
|
201
|
+
* while the feature stabilizes.
|
|
202
|
+
*
|
|
203
|
+
* @param _manifest - Application capability manifest declaring what operations the app needs
|
|
204
|
+
*/
|
|
205
|
+
public requestCapabilities(_manifest: AppCapabilities): Promise<WalletCapabilities> {
|
|
206
|
+
throw new Error('Not implemented');
|
|
207
|
+
}
|
|
208
|
+
|
|
140
209
|
public async batch<const T extends readonly BatchedMethod[]>(methods: T): Promise<BatchResults<T>> {
|
|
141
210
|
const results: any[] = [];
|
|
142
211
|
for (const method of methods) {
|
|
@@ -157,31 +226,39 @@ export abstract class BaseWallet implements Wallet {
|
|
|
157
226
|
|
|
158
227
|
/**
|
|
159
228
|
* Completes partial user-provided fee options with wallet defaults.
|
|
160
|
-
* @param
|
|
161
|
-
* @param feePayer - The address paying for fees (if any fee payment method is embedded in the execution payload)
|
|
162
|
-
* @param gasSettings - User-provided partial gas settings
|
|
163
|
-
* @returns - Complete fee options that can be used to create a transaction execution request
|
|
229
|
+
* @param config - Fee completion config.
|
|
164
230
|
*/
|
|
165
|
-
protected async completeFeeOptions(
|
|
166
|
-
from
|
|
167
|
-
feePayer?: AztecAddress,
|
|
168
|
-
gasSettings?: Partial<FieldsOf<GasSettings>>,
|
|
169
|
-
): Promise<FeeOptions> {
|
|
231
|
+
protected async completeFeeOptions(config: CompleteFeeOptionsConfig): Promise<FeeOptions> {
|
|
232
|
+
const { from, feePayer, gasSettings, forEstimation } = config;
|
|
170
233
|
const maxFeesPerGas =
|
|
171
234
|
gasSettings?.maxFeesPerGas ?? (await this.aztecNode.getCurrentMinFees()).mul(1 + this.minFeePadding);
|
|
172
235
|
let accountFeePaymentMethodOptions;
|
|
173
|
-
//
|
|
174
|
-
//
|
|
175
|
-
if (
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
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
|
+
}
|
|
183
250
|
}
|
|
184
|
-
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);
|
|
185
262
|
this.log.debug(`Using L2 gas settings`, fullGasSettings);
|
|
186
263
|
return {
|
|
187
264
|
gasSettings: fullGasSettings,
|
|
@@ -190,37 +267,6 @@ export abstract class BaseWallet implements Wallet {
|
|
|
190
267
|
};
|
|
191
268
|
}
|
|
192
269
|
|
|
193
|
-
/**
|
|
194
|
-
* Completes partial user-provided fee options with unreasonably high gas limits
|
|
195
|
-
* for gas estimation. Uses the same logic as completeFeeOptions but sets high limits
|
|
196
|
-
* to avoid running out of gas during estimation.
|
|
197
|
-
* @param from - The address where the transaction is being sent from
|
|
198
|
-
* @param feePayer - The address paying for fees (if any fee payment method is embedded in the execution payload)
|
|
199
|
-
* @param gasSettings - User-provided partial gas settings
|
|
200
|
-
*/
|
|
201
|
-
protected async completeFeeOptionsForEstimation(
|
|
202
|
-
from: AztecAddress,
|
|
203
|
-
feePayer?: AztecAddress,
|
|
204
|
-
gasSettings?: Partial<FieldsOf<GasSettings>>,
|
|
205
|
-
) {
|
|
206
|
-
const defaultFeeOptions = await this.completeFeeOptions(from, feePayer, gasSettings);
|
|
207
|
-
const {
|
|
208
|
-
gasSettings: { maxFeesPerGas, maxPriorityFeesPerGas },
|
|
209
|
-
} = defaultFeeOptions;
|
|
210
|
-
// Use unrealistically high gas limits for estimation to avoid running out of gas.
|
|
211
|
-
// They will be tuned down after the simulation.
|
|
212
|
-
const gasSettingsForEstimation = new GasSettings(
|
|
213
|
-
new Gas(GAS_ESTIMATION_DA_GAS_LIMIT, GAS_ESTIMATION_L2_GAS_LIMIT),
|
|
214
|
-
new Gas(GAS_ESTIMATION_TEARDOWN_DA_GAS_LIMIT, GAS_ESTIMATION_TEARDOWN_L2_GAS_LIMIT),
|
|
215
|
-
maxFeesPerGas,
|
|
216
|
-
maxPriorityFeesPerGas,
|
|
217
|
-
);
|
|
218
|
-
return {
|
|
219
|
-
...defaultFeeOptions,
|
|
220
|
-
gasSettings: gasSettingsForEstimation,
|
|
221
|
-
};
|
|
222
|
-
}
|
|
223
|
-
|
|
224
270
|
registerSender(address: AztecAddress, _alias: string = ''): Promise<AztecAddress> {
|
|
225
271
|
return this.pxe.registerSender(address);
|
|
226
272
|
}
|
|
@@ -263,32 +309,129 @@ export abstract class BaseWallet implements Wallet {
|
|
|
263
309
|
return instance;
|
|
264
310
|
}
|
|
265
311
|
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
opts
|
|
275
|
-
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,
|
|
276
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);
|
|
277
404
|
}
|
|
278
405
|
|
|
279
406
|
async profileTx(executionPayload: ExecutionPayload, opts: ProfileOptions): Promise<TxProfileResult> {
|
|
280
|
-
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
|
+
});
|
|
281
412
|
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
|
|
282
|
-
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
|
+
});
|
|
283
418
|
}
|
|
284
419
|
|
|
285
420
|
public async sendTx<W extends InteractionWaitOptions = undefined>(
|
|
286
421
|
executionPayload: ExecutionPayload,
|
|
287
422
|
opts: SendOptions<W>,
|
|
288
423
|
): Promise<SendReturn<W>> {
|
|
289
|
-
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
|
+
});
|
|
290
429
|
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
|
|
291
|
-
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
|
+
);
|
|
292
435
|
const tx = await provenTx.toTx();
|
|
293
436
|
const txHash = tx.getTxHash();
|
|
294
437
|
if (await this.aztecNode.getTxEffect(txHash)) {
|
|
@@ -302,12 +445,32 @@ export abstract class BaseWallet implements Wallet {
|
|
|
302
445
|
|
|
303
446
|
// If wait is NO_WAIT, return txHash immediately
|
|
304
447
|
if (opts.wait === NO_WAIT) {
|
|
305
|
-
return txHash as SendReturn<W>;
|
|
448
|
+
return { txHash, ...offchainOutput } as SendReturn<W>;
|
|
306
449
|
}
|
|
307
450
|
|
|
308
451
|
// Otherwise, wait for the full receipt (default behavior on wait: undefined)
|
|
309
452
|
const waitOpts = typeof opts.wait === 'object' ? opts.wait : undefined;
|
|
310
|
-
|
|
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;
|
|
311
474
|
}
|
|
312
475
|
|
|
313
476
|
protected contextualizeError(err: Error, ...context: string[]): Error {
|
|
@@ -324,8 +487,8 @@ export abstract class BaseWallet implements Wallet {
|
|
|
324
487
|
return err;
|
|
325
488
|
}
|
|
326
489
|
|
|
327
|
-
|
|
328
|
-
return this.pxe.
|
|
490
|
+
executeUtility(call: FunctionCall, opts: ExecuteUtilityOptions): Promise<UtilityExecutionResult> {
|
|
491
|
+
return this.pxe.executeUtility(call, { authwits: opts.authWitnesses, scopes: opts.scopes });
|
|
329
492
|
}
|
|
330
493
|
|
|
331
494
|
async getPrivateEvents<T>(
|
|
@@ -348,17 +511,39 @@ export abstract class BaseWallet implements Wallet {
|
|
|
348
511
|
return decodedEvents;
|
|
349
512
|
}
|
|
350
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
|
+
*/
|
|
351
518
|
async getContractMetadata(address: AztecAddress) {
|
|
352
519
|
const instance = await this.pxe.getContractInstance(address);
|
|
353
|
-
const
|
|
354
|
-
|
|
355
|
-
|
|
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;
|
|
356
541
|
const isContractUpdated =
|
|
357
542
|
publiclyRegisteredContract &&
|
|
358
543
|
!publiclyRegisteredContract.currentContractClassId.equals(publiclyRegisteredContract.originalContractClassId);
|
|
359
544
|
return {
|
|
360
545
|
instance: instance ?? undefined,
|
|
361
|
-
|
|
546
|
+
initializationStatus,
|
|
362
547
|
isContractPublished: !!publiclyRegisteredContract,
|
|
363
548
|
isContractUpdated: !!isContractUpdated,
|
|
364
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';
|