@aztec/wallet-sdk 0.0.1-commit.b64cb54f6 → 0.0.1-commit.b8a057fa
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 +125 -0
- package/dest/base-wallet/base_wallet.d.ts +79 -42
- package/dest/base-wallet/base_wallet.d.ts.map +1 -1
- package/dest/base-wallet/base_wallet.js +250 -112
- package/dest/base-wallet/get_gas_limits.d.ts +36 -0
- package/dest/base-wallet/get_gas_limits.d.ts.map +1 -0
- package/dest/base-wallet/get_gas_limits.js +55 -0
- 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 +7 -4
- package/dest/base-wallet/utils.d.ts.map +1 -1
- package/dest/base-wallet/utils.js +11 -5
- package/dest/crypto.d.ts +39 -1
- package/dest/crypto.d.ts.map +1 -1
- package/dest/crypto.js +88 -0
- package/dest/extension/handlers/background_connection_handler.d.ts +12 -2
- package/dest/extension/handlers/background_connection_handler.d.ts.map +1 -1
- package/dest/extension/handlers/background_connection_handler.js +44 -8
- package/dest/extension/handlers/content_script_connection_handler.d.ts +2 -1
- package/dest/extension/handlers/content_script_connection_handler.d.ts.map +1 -1
- package/dest/extension/handlers/content_script_connection_handler.js +19 -0
- package/dest/extension/handlers/internal_message_types.d.ts +3 -1
- package/dest/extension/handlers/internal_message_types.d.ts.map +1 -1
- package/dest/extension/handlers/internal_message_types.js +3 -1
- package/dest/extension/provider/extension_wallet.d.ts +26 -6
- package/dest/extension/provider/extension_wallet.d.ts.map +1 -1
- package/dest/extension/provider/extension_wallet.js +80 -9
- 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 +122 -0
- package/dest/iframe/handlers/iframe_connection_handler.d.ts.map +1 -0
- package/dest/iframe/handlers/iframe_connection_handler.js +239 -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 +85 -0
- package/dest/iframe/provider/iframe_wallet.d.ts.map +1 -0
- package/dest/iframe/provider/iframe_wallet.js +269 -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 +3 -2
- 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 +46 -16
- package/dest/types.d.ts +64 -2
- package/dest/types.d.ts.map +1 -1
- package/dest/types.js +29 -0
- package/package.json +12 -8
- package/src/base-wallet/base_wallet.ts +330 -170
- package/src/base-wallet/get_gas_limits.ts +88 -0
- package/src/base-wallet/index.ts +7 -1
- package/src/base-wallet/utils.ts +15 -5
- package/src/crypto.ts +104 -0
- package/src/extension/handlers/background_connection_handler.ts +42 -9
- package/src/extension/handlers/content_script_connection_handler.ts +18 -0
- package/src/extension/handlers/internal_message_types.ts +2 -0
- package/src/extension/provider/extension_wallet.ts +94 -13
- package/src/extension/provider/index.ts +1 -1
- package/src/iframe/handlers/iframe_connection_handler.ts +341 -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 +323 -0
- package/src/iframe/provider/index.ts +3 -0
- package/src/manager/types.ts +2 -1
- package/src/manager/wallet_manager.ts +48 -14
- package/src/types.ts +72 -0
|
@@ -1,4 +1,5 @@
|
|
|
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
4
|
import {
|
|
4
5
|
type InteractionWaitOptions,
|
|
@@ -8,32 +9,29 @@ import {
|
|
|
8
9
|
} from '@aztec/aztec.js/contracts';
|
|
9
10
|
import type { FeePaymentMethod } from '@aztec/aztec.js/fee';
|
|
10
11
|
import { waitForTx } from '@aztec/aztec.js/node';
|
|
11
|
-
import type {
|
|
12
|
-
Aliased,
|
|
13
|
-
AppCapabilities,
|
|
14
|
-
BatchResults,
|
|
15
|
-
BatchedMethod,
|
|
16
|
-
ExecuteUtilityOptions,
|
|
17
|
-
PrivateEvent,
|
|
18
|
-
PrivateEventFilter,
|
|
19
|
-
ProfileOptions,
|
|
20
|
-
SendOptions,
|
|
21
|
-
SimulateOptions,
|
|
22
|
-
Wallet,
|
|
23
|
-
WalletCapabilities,
|
|
24
|
-
} from '@aztec/aztec.js/wallet';
|
|
25
12
|
import {
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
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';
|
|
31
28
|
import { AccountFeePaymentMethodOptions, type DefaultAccountEntrypointOptions } from '@aztec/entrypoints/account';
|
|
29
|
+
import { DefaultEntrypoint } from '@aztec/entrypoints/default';
|
|
32
30
|
import type { ChainInfo } from '@aztec/entrypoints/interfaces';
|
|
33
31
|
import { Fr } from '@aztec/foundation/curves/bn254';
|
|
34
32
|
import { createLogger } from '@aztec/foundation/log';
|
|
35
33
|
import type { FieldsOf } from '@aztec/foundation/types';
|
|
36
|
-
import {
|
|
34
|
+
import { displayDebugLogs } from '@aztec/pxe/client/lazy';
|
|
37
35
|
import type { PXE, PackedPrivateEvent } from '@aztec/pxe/server';
|
|
38
36
|
import {
|
|
39
37
|
type ContractArtifact,
|
|
@@ -43,26 +41,27 @@ import {
|
|
|
43
41
|
} from '@aztec/stdlib/abi';
|
|
44
42
|
import type { AuthWitness } from '@aztec/stdlib/auth-witness';
|
|
45
43
|
import { AztecAddress } from '@aztec/stdlib/aztec-address';
|
|
46
|
-
import {
|
|
47
|
-
type ContractInstanceWithAddress,
|
|
48
|
-
computePartialAddress,
|
|
49
|
-
getContractClassFromArtifact,
|
|
50
|
-
} from '@aztec/stdlib/contract';
|
|
44
|
+
import { type ContractInstancePreimage, type NodeInfo, computePartialAddress } from '@aztec/stdlib/contract';
|
|
51
45
|
import { SimulationError } from '@aztec/stdlib/errors';
|
|
52
|
-
import { Gas, GasSettings } from '@aztec/stdlib/gas';
|
|
53
|
-
import {
|
|
46
|
+
import { Gas, GasFees, GasSettings, ManaUsageEstimate } from '@aztec/stdlib/gas';
|
|
47
|
+
import {
|
|
48
|
+
computeSiloedPrivateInitializationNullifier,
|
|
49
|
+
computeSiloedPublicInitializationNullifier,
|
|
50
|
+
} from '@aztec/stdlib/hash';
|
|
54
51
|
import type { AztecNode } from '@aztec/stdlib/interfaces/client';
|
|
52
|
+
import { type MasterSecretKeys, deriveKeys, deriveKeysFromMasterSecretKeys } from '@aztec/stdlib/keys';
|
|
55
53
|
import {
|
|
56
54
|
BlockHeader,
|
|
55
|
+
ExecutionPayload,
|
|
57
56
|
type TxExecutionRequest,
|
|
58
57
|
type TxProfileResult,
|
|
59
|
-
TxSimulationResult,
|
|
60
58
|
type UtilityExecutionResult,
|
|
59
|
+
mergeExecutionPayloads,
|
|
61
60
|
} from '@aztec/stdlib/tx';
|
|
62
|
-
import { ExecutionPayload, mergeExecutionPayloads } from '@aztec/stdlib/tx';
|
|
63
61
|
|
|
64
62
|
import { inspect } from 'util';
|
|
65
63
|
|
|
64
|
+
import { assertGasLimitsWithinNetworkLimits } from './get_gas_limits.js';
|
|
66
65
|
import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simulateViaNode } from './utils.js';
|
|
67
66
|
|
|
68
67
|
/**
|
|
@@ -75,17 +74,49 @@ export type FeeOptions = {
|
|
|
75
74
|
*/
|
|
76
75
|
walletFeePaymentMethod?: FeePaymentMethod;
|
|
77
76
|
/** Configuration options for the account to properly handle the selected fee payment method */
|
|
78
|
-
accountFeePaymentMethodOptions
|
|
77
|
+
accountFeePaymentMethodOptions?: AccountFeePaymentMethodOptions;
|
|
79
78
|
/** The gas settings to use for the transaction */
|
|
80
79
|
gasSettings: GasSettings;
|
|
81
80
|
};
|
|
82
81
|
|
|
82
|
+
/** Options for `simulateViaEntrypoint`. */
|
|
83
|
+
export type SimulateViaEntrypointOptions = Pick<
|
|
84
|
+
SimulateOptions,
|
|
85
|
+
'from' | 'additionalScopes' | 'skipTxValidation' | 'skipFeeEnforcement' | 'sendMessagesAs' | 'overrides'
|
|
86
|
+
> & {
|
|
87
|
+
/** Fee options for the entrypoint */
|
|
88
|
+
feeOptions: FeeOptions;
|
|
89
|
+
};
|
|
90
|
+
|
|
91
|
+
/** Options for `completeFeeOptions`. */
|
|
92
|
+
export type CompleteFeeOptionsConfig = {
|
|
93
|
+
/** The address where the transaction is being sent from. */
|
|
94
|
+
from: AztecAddress | NoFrom;
|
|
95
|
+
/** The address paying for fees (if any fee payment method is embedded in the execution payload). */
|
|
96
|
+
feePayer?: AztecAddress;
|
|
97
|
+
/** User-provided partial gas settings. */
|
|
98
|
+
gasSettings?: Partial<FieldsOf<GasSettings>>;
|
|
99
|
+
/** If true, returns gas settings with high gas limits for estimation. If false, uses fallback limits. */
|
|
100
|
+
forEstimation?: boolean;
|
|
101
|
+
/**
|
|
102
|
+
* Assumed network congestion level for fee prediction. Controls how aggressively the wallet
|
|
103
|
+
* estimates future fees. Defaults to Limit (worst case) when not specified.
|
|
104
|
+
*/
|
|
105
|
+
congestionEstimate?: ManaUsageEstimate;
|
|
106
|
+
};
|
|
107
|
+
|
|
83
108
|
/**
|
|
84
109
|
* A base class for Wallet implementations
|
|
85
110
|
*/
|
|
86
111
|
export abstract class BaseWallet implements Wallet {
|
|
87
112
|
protected minFeePadding = 0.5;
|
|
88
113
|
protected cancellableTransactions = false;
|
|
114
|
+
// Poll interval (in seconds) injected into sendTx waits when the caller does not specify one. Left undefined on
|
|
115
|
+
// production wallets so the DefaultWaitOpts 1s cadence stands; test wallets talking to in-process nodes lower it.
|
|
116
|
+
protected defaultWaitInterval?: number;
|
|
117
|
+
// A wallet is instantiated for a particular chain, so chain info never changes during its lifetime.
|
|
118
|
+
// We cache it here because getChainInfo is called frequently (every tx simulation, send, auth wit, etc.).
|
|
119
|
+
private nodeInfoPromise: Promise<NodeInfo> | undefined;
|
|
89
120
|
|
|
90
121
|
// Protected because we want to force wallets to instantiate their own PXE.
|
|
91
122
|
protected constructor(
|
|
@@ -94,10 +125,21 @@ export abstract class BaseWallet implements Wallet {
|
|
|
94
125
|
protected log = createLogger('wallet-sdk:base_wallet'),
|
|
95
126
|
) {}
|
|
96
127
|
|
|
97
|
-
protected scopesFrom(from: AztecAddress, additionalScopes: AztecAddress[] = []): AztecAddress[] {
|
|
98
|
-
const allScopes = from
|
|
128
|
+
protected scopesFrom(from: AztecAddress | NoFrom, additionalScopes: AztecAddress[] = []): AztecAddress[] {
|
|
129
|
+
const allScopes = from === NO_FROM ? additionalScopes : [from, ...additionalScopes];
|
|
99
130
|
const scopeSet = new Set(allScopes.map(address => address.toString()));
|
|
100
|
-
return [...scopeSet].map(AztecAddress.
|
|
131
|
+
return [...scopeSet].map(AztecAddress.fromStringUnsafe);
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
/**
|
|
135
|
+
* Picks the sender address PXE should tag private messages with. Returns `undefined` when there is no signing
|
|
136
|
+
* account (`from === NO_FROM`) and no explicit override; in that case any private log emitted by the tx using
|
|
137
|
+
* the wallet-supplied default sender will fail the "Sender for tags is not set" assertion.
|
|
138
|
+
* @param from - Tx sender, or `NO_FROM`.
|
|
139
|
+
* @param sendMessagesAs - Explicit override.
|
|
140
|
+
*/
|
|
141
|
+
protected senderForTagsFrom(from: AztecAddress | NoFrom, sendMessagesAs?: AztecAddress): AztecAddress | undefined {
|
|
142
|
+
return sendMessagesAs ?? (from === NO_FROM ? undefined : from);
|
|
101
143
|
}
|
|
102
144
|
|
|
103
145
|
protected abstract getAccountFromAddress(address: AztecAddress): Promise<Account>;
|
|
@@ -112,37 +154,71 @@ export abstract class BaseWallet implements Wallet {
|
|
|
112
154
|
* @returns The aliased collection of AztecAddresses that form this wallet's address book
|
|
113
155
|
*/
|
|
114
156
|
async getAddressBook(): Promise<Aliased<AztecAddress>[]> {
|
|
115
|
-
const
|
|
116
|
-
return
|
|
157
|
+
const sources = await this.pxe.getTaggingSecretSources({ kind: 'address-derived' });
|
|
158
|
+
return sources.map(source => ({ item: source.sender, alias: '' }));
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
/**
|
|
162
|
+
* Fetches and caches the node info for the wallet's lifetime, since a wallet talks to a single network and
|
|
163
|
+
* node info never changes. A rejected fetch clears the cache so the next call retries instead of replaying
|
|
164
|
+
* the cached rejection forever — important because the gas-limit fill-in and validation (run on every send)
|
|
165
|
+
* depend on it.
|
|
166
|
+
*/
|
|
167
|
+
private getNodeInfo(): Promise<NodeInfo> {
|
|
168
|
+
if (!this.nodeInfoPromise) {
|
|
169
|
+
this.nodeInfoPromise = this.aztecNode.getNodeInfo().catch(err => {
|
|
170
|
+
this.nodeInfoPromise = undefined;
|
|
171
|
+
throw err;
|
|
172
|
+
});
|
|
173
|
+
}
|
|
174
|
+
return this.nodeInfoPromise;
|
|
117
175
|
}
|
|
118
176
|
|
|
119
177
|
async getChainInfo(): Promise<ChainInfo> {
|
|
120
|
-
const { l1ChainId, rollupVersion } = await this.
|
|
178
|
+
const { l1ChainId, rollupVersion } = await this.getNodeInfo();
|
|
121
179
|
return { chainId: new Fr(l1ChainId), version: new Fr(rollupVersion) };
|
|
122
180
|
}
|
|
123
181
|
|
|
182
|
+
/**
|
|
183
|
+
* Returns the maximum gas limits a single transaction may declare on this wallet's network (the
|
|
184
|
+
* node-advertised `txsLimits.gas`). Internal helper used to fill in default gas limits when sending a
|
|
185
|
+
* transaction without explicit limits, and to validate caller-provided limits before sending. Backed by
|
|
186
|
+
* the cached node info, since a wallet talks to a single network.
|
|
187
|
+
*/
|
|
188
|
+
protected async getMaxTxGasLimits(): Promise<Gas> {
|
|
189
|
+
const { txsLimits } = await this.getNodeInfo();
|
|
190
|
+
return new Gas(txsLimits.gas.daGas, txsLimits.gas.l2Gas);
|
|
191
|
+
}
|
|
192
|
+
|
|
124
193
|
protected async createTxExecutionRequestFromPayloadAndFee(
|
|
125
194
|
executionPayload: ExecutionPayload,
|
|
126
|
-
from: AztecAddress,
|
|
195
|
+
from: AztecAddress | NoFrom,
|
|
127
196
|
feeOptions: FeeOptions,
|
|
128
197
|
): Promise<TxExecutionRequest> {
|
|
129
198
|
const feeExecutionPayload = await feeOptions.walletFeePaymentMethod?.getExecutionPayload();
|
|
130
|
-
const executionOptions: DefaultAccountEntrypointOptions = {
|
|
131
|
-
txNonce: Fr.random(),
|
|
132
|
-
cancellable: this.cancellableTransactions,
|
|
133
|
-
feePaymentMethodOptions: feeOptions.accountFeePaymentMethodOptions,
|
|
134
|
-
};
|
|
135
199
|
const finalExecutionPayload = feeExecutionPayload
|
|
136
200
|
? mergeExecutionPayloads([feeExecutionPayload, executionPayload])
|
|
137
201
|
: executionPayload;
|
|
138
|
-
const fromAccount = await this.getAccountFromAddress(from);
|
|
139
202
|
const chainInfo = await this.getChainInfo();
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
chainInfo
|
|
144
|
-
|
|
145
|
-
|
|
203
|
+
|
|
204
|
+
if (from === NO_FROM) {
|
|
205
|
+
const entrypoint = new DefaultEntrypoint();
|
|
206
|
+
return entrypoint.createTxExecutionRequest(finalExecutionPayload, feeOptions.gasSettings, chainInfo);
|
|
207
|
+
} else {
|
|
208
|
+
const fromAccount = await this.getAccountFromAddress(from);
|
|
209
|
+
const executionOptions: DefaultAccountEntrypointOptions = {
|
|
210
|
+
txNonce: Fr.random(),
|
|
211
|
+
cancellable: this.cancellableTransactions,
|
|
212
|
+
// If from is an address, feeOptions include the way the account contract should handle the fee payment
|
|
213
|
+
feePaymentMethodOptions: feeOptions.accountFeePaymentMethodOptions!,
|
|
214
|
+
};
|
|
215
|
+
return fromAccount.createTxExecutionRequest(
|
|
216
|
+
finalExecutionPayload,
|
|
217
|
+
feeOptions.gasSettings,
|
|
218
|
+
chainInfo,
|
|
219
|
+
executionOptions,
|
|
220
|
+
);
|
|
221
|
+
}
|
|
146
222
|
}
|
|
147
223
|
|
|
148
224
|
public async createAuthWit(
|
|
@@ -191,31 +267,54 @@ export abstract class BaseWallet implements Wallet {
|
|
|
191
267
|
|
|
192
268
|
/**
|
|
193
269
|
* Completes partial user-provided fee options with wallet defaults.
|
|
194
|
-
* @param
|
|
195
|
-
* @param feePayer - The address paying for fees (if any fee payment method is embedded in the execution payload)
|
|
196
|
-
* @param gasSettings - User-provided partial gas settings
|
|
197
|
-
* @returns - Complete fee options that can be used to create a transaction execution request
|
|
270
|
+
* @param config - Fee completion config.
|
|
198
271
|
*/
|
|
199
|
-
protected async completeFeeOptions(
|
|
200
|
-
from
|
|
201
|
-
feePayer?: AztecAddress,
|
|
202
|
-
gasSettings?: Partial<FieldsOf<GasSettings>>,
|
|
203
|
-
): Promise<FeeOptions> {
|
|
272
|
+
protected async completeFeeOptions(config: CompleteFeeOptionsConfig): Promise<FeeOptions> {
|
|
273
|
+
const { from, feePayer, gasSettings, forEstimation, congestionEstimate } = config;
|
|
204
274
|
const maxFeesPerGas =
|
|
205
|
-
gasSettings?.maxFeesPerGas ?? (await this.
|
|
275
|
+
gasSettings?.maxFeesPerGas ?? (await this.getMinFees(congestionEstimate)).mul(1 + this.minFeePadding);
|
|
206
276
|
let accountFeePaymentMethodOptions;
|
|
207
|
-
//
|
|
208
|
-
//
|
|
209
|
-
if (
|
|
210
|
-
|
|
277
|
+
// If from is an address, we need to determine the appropriate fee payment method options for the
|
|
278
|
+
// account contract entrypoint to use
|
|
279
|
+
if (from !== NO_FROM) {
|
|
280
|
+
if (!feePayer) {
|
|
281
|
+
// The transaction does not include a fee payment method, so we set the flag
|
|
282
|
+
// for the account to use its fee juice balance
|
|
283
|
+
accountFeePaymentMethodOptions = AccountFeePaymentMethodOptions.PREEXISTING_FEE_JUICE;
|
|
284
|
+
} else {
|
|
285
|
+
// The transaction includes fee payment method, so we check if we are the fee payer for it
|
|
286
|
+
// (this can only happen if the embedded payment method is FeeJuiceWithClaim)
|
|
287
|
+
accountFeePaymentMethodOptions = from.equals(feePayer)
|
|
288
|
+
? AccountFeePaymentMethodOptions.FEE_JUICE_WITH_CLAIM
|
|
289
|
+
: AccountFeePaymentMethodOptions.EXTERNAL;
|
|
290
|
+
}
|
|
291
|
+
}
|
|
292
|
+
const gasSettingsOverrides = {
|
|
293
|
+
gasLimits: gasSettings?.gasLimits ? Gas.from(gasSettings.gasLimits) : undefined,
|
|
294
|
+
teardownGasLimits: gasSettings?.teardownGasLimits ? Gas.from(gasSettings.teardownGasLimits) : undefined,
|
|
295
|
+
maxFeesPerGas,
|
|
296
|
+
maxPriorityFeesPerGas: gasSettings?.maxPriorityFeesPerGas ?? GasFees.empty(),
|
|
297
|
+
};
|
|
298
|
+
// When estimating gas (simulation), use high limits so the simulation doesn't run out of gas.
|
|
299
|
+
// When sending for real without explicit limits, declare the most a single tx may use on this network
|
|
300
|
+
// (the node's per-tx admission limit), so the proposer does not skip the tx for over-declaring gas.
|
|
301
|
+
let fullGasSettings;
|
|
302
|
+
if (forEstimation) {
|
|
303
|
+
// Estimation deliberately uses very high internal limits and skips tx validation, so we do not
|
|
304
|
+
// validate against the network admission limit here.
|
|
305
|
+
fullGasSettings = GasSettings.forEstimation(gasSettingsOverrides);
|
|
211
306
|
} else {
|
|
212
|
-
|
|
213
|
-
//
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
307
|
+
const maxTxGasLimits = await this.getMaxTxGasLimits();
|
|
308
|
+
// If the caller declared explicit gas limits, reject them up front when they exceed the network's
|
|
309
|
+
// per-tx admission limit (mirroring the node's GasLimitsValidator). Otherwise fill in the limit.
|
|
310
|
+
if (gasSettingsOverrides.gasLimits) {
|
|
311
|
+
assertGasLimitsWithinNetworkLimits(gasSettingsOverrides.gasLimits, maxTxGasLimits);
|
|
312
|
+
}
|
|
313
|
+
fullGasSettings = GasSettings.fallback({
|
|
314
|
+
...gasSettingsOverrides,
|
|
315
|
+
gasLimits: gasSettingsOverrides.gasLimits ?? maxTxGasLimits,
|
|
316
|
+
});
|
|
217
317
|
}
|
|
218
|
-
const fullGasSettings: GasSettings = GasSettings.default({ ...gasSettings, maxFeesPerGas });
|
|
219
318
|
this.log.debug(`Using L2 gas settings`, fullGasSettings);
|
|
220
319
|
return {
|
|
221
320
|
gasSettings: fullGasSettings,
|
|
@@ -225,97 +324,104 @@ export abstract class BaseWallet implements Wallet {
|
|
|
225
324
|
}
|
|
226
325
|
|
|
227
326
|
/**
|
|
228
|
-
*
|
|
229
|
-
*
|
|
230
|
-
* to
|
|
231
|
-
* @param from - The address where the transaction is being sent from
|
|
232
|
-
* @param feePayer - The address paying for fees (if any fee payment method is embedded in the execution payload)
|
|
233
|
-
* @param gasSettings - User-provided partial gas settings
|
|
327
|
+
* Returns the worst-case min fee across predicted future slots.
|
|
328
|
+
* Falls back to getCurrentMinFees if the node doesn't support getPredictedMinFees.
|
|
329
|
+
* @param estimate - The mana usage estimate to use for fee prediction. Defaults to Limit for conservative estimation.
|
|
234
330
|
*/
|
|
235
|
-
protected async
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
maxPriorityFeesPerGas,
|
|
251
|
-
);
|
|
252
|
-
return {
|
|
253
|
-
...defaultFeeOptions,
|
|
254
|
-
gasSettings: gasSettingsForEstimation,
|
|
255
|
-
};
|
|
331
|
+
protected async getMinFees(estimate: ManaUsageEstimate = ManaUsageEstimate.Limit): Promise<GasFees> {
|
|
332
|
+
try {
|
|
333
|
+
const predicted = await this.aztecNode.getPredictedMinFees(estimate);
|
|
334
|
+
if (predicted.length === 0) {
|
|
335
|
+
return this.aztecNode.getCurrentMinFees();
|
|
336
|
+
}
|
|
337
|
+
return predicted.reduce((worst, fees) => (fees.feePerL2Gas > worst.feePerL2Gas ? fees : worst));
|
|
338
|
+
} catch (err: any) {
|
|
339
|
+
// Fallback for old nodes that don't support getPredictedMinFees.
|
|
340
|
+
// Only fall back on method-not-found errors (JSON-RPC code -32601); rethrow others.
|
|
341
|
+
if (err?.cause?.code === -32601 || err?.message?.includes('Method not found')) {
|
|
342
|
+
return this.aztecNode.getCurrentMinFees();
|
|
343
|
+
}
|
|
344
|
+
throw err;
|
|
345
|
+
}
|
|
256
346
|
}
|
|
257
347
|
|
|
258
|
-
registerSender(address: AztecAddress, _alias: string = ''): Promise<AztecAddress> {
|
|
259
|
-
|
|
348
|
+
async registerSender(address: AztecAddress, _alias: string = ''): Promise<AztecAddress> {
|
|
349
|
+
await this.pxe.registerTaggingSecretSource({ kind: 'address-derived', sender: address });
|
|
350
|
+
return address;
|
|
260
351
|
}
|
|
261
352
|
|
|
262
353
|
async registerContract(
|
|
263
|
-
instance:
|
|
354
|
+
instance: ContractInstancePreimage,
|
|
264
355
|
artifact?: ContractArtifact,
|
|
265
|
-
|
|
266
|
-
): Promise<
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
//
|
|
280
|
-
|
|
281
|
-
//
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
356
|
+
secretKeyOrKeys?: Fr | MasterSecretKeys,
|
|
357
|
+
): Promise<void> {
|
|
358
|
+
// Classes and instances are registered independently: register the artifact (if provided) then the instance.
|
|
359
|
+
// Neither call validates that the artifact matches the class the instance runs, a missing artifact only surfaces
|
|
360
|
+
// when the contract is later simulated.
|
|
361
|
+
if (artifact) {
|
|
362
|
+
await this.pxe.registerContractClass(artifact);
|
|
363
|
+
}
|
|
364
|
+
const contractAddress = await this.pxe.registerContract(instance);
|
|
365
|
+
|
|
366
|
+
if (secretKeyOrKeys) {
|
|
367
|
+
// PXE never receives the account seed (from which the message-signing/fallback secret keys could be re-derived):
|
|
368
|
+
// the wallet derives the keys here. Of these, PXE only reads and stores the four privacy secret keys and the
|
|
369
|
+
// message-signing and fallback *public* keys — it never touches the message-signing or fallback secret keys.
|
|
370
|
+
//
|
|
371
|
+
// Since PXE recomputes the address from those keys, we assert it matches the instance's address: a mismatch means
|
|
372
|
+
// the provided keys don't correspond to this account.
|
|
373
|
+
const derivedKeys =
|
|
374
|
+
secretKeyOrKeys instanceof Fr
|
|
375
|
+
? await deriveKeys(secretKeyOrKeys)
|
|
376
|
+
: await deriveKeysFromMasterSecretKeys(secretKeyOrKeys);
|
|
377
|
+
const { address } = await this.pxe.registerAccount(derivedKeys, await computePartialAddress(instance));
|
|
378
|
+
if (!address.equals(contractAddress)) {
|
|
379
|
+
throw new Error(
|
|
380
|
+
`Registered account address ${address.toString()} does not match contract instance address ${contractAddress.toString()}: the provided keys do not correspond to this account.`,
|
|
381
|
+
);
|
|
290
382
|
}
|
|
291
|
-
await this.pxe.registerContract({ artifact, instance });
|
|
292
383
|
}
|
|
384
|
+
}
|
|
293
385
|
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
}
|
|
297
|
-
return instance;
|
|
386
|
+
registerContractClass(artifact: ContractArtifact): Promise<void> {
|
|
387
|
+
return this.pxe.registerContractClass(artifact);
|
|
298
388
|
}
|
|
299
389
|
|
|
300
390
|
/**
|
|
301
391
|
* Simulates calls through the standard PXE path (account entrypoint).
|
|
302
392
|
* @param executionPayload - The execution payload to simulate.
|
|
303
|
-
* @param
|
|
304
|
-
* @param feeOptions - Fee options for the transaction.
|
|
305
|
-
* @param skipTxValidation - Whether to skip tx validation.
|
|
306
|
-
* @param skipFeeEnforcement - Whether to skip fee enforcement.
|
|
307
|
-
* @param scopes - The scopes to use for the simulation.
|
|
393
|
+
* @param opts - Simulation options.
|
|
308
394
|
*/
|
|
309
|
-
protected async simulateViaEntrypoint(
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
395
|
+
protected async simulateViaEntrypoint(executionPayload: ExecutionPayload, opts: SimulateViaEntrypointOptions) {
|
|
396
|
+
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(
|
|
397
|
+
executionPayload,
|
|
398
|
+
opts.from,
|
|
399
|
+
opts.feeOptions,
|
|
400
|
+
);
|
|
401
|
+
const result = await this.pxe.simulateTx(txRequest, {
|
|
402
|
+
simulatePublic: true,
|
|
403
|
+
skipTxValidation: opts.skipTxValidation,
|
|
404
|
+
skipFeeEnforcement: opts.skipFeeEnforcement,
|
|
405
|
+
scopes: this.scopesFrom(opts.from, opts.additionalScopes),
|
|
406
|
+
senderForTags: this.senderForTagsFrom(opts.from, opts.sendMessagesAs),
|
|
407
|
+
overrides: opts.overrides,
|
|
408
|
+
});
|
|
409
|
+
const appCallOffset = await this.computeAppCallOffset(opts.from, opts.feeOptions);
|
|
410
|
+
return TxSimulationResultWithAppOffset.fromResultAndOffset(result, appCallOffset);
|
|
411
|
+
}
|
|
412
|
+
|
|
413
|
+
/**
|
|
414
|
+
* Computes the index where the app's calls begin in the flattened array of calls (0 = entrypoint/root, 1..N = fee
|
|
415
|
+
* calls, N+1 = app).
|
|
416
|
+
* @param from - The sender address, or NO_FROM for the default entrypoint.
|
|
417
|
+
* @param feeOptions - Fee options containing the wallet fee payment method.
|
|
418
|
+
*/
|
|
419
|
+
protected async computeAppCallOffset(from: AztecAddress | NoFrom, feeOptions: FeeOptions): Promise<number> {
|
|
420
|
+
if (from === NO_FROM) {
|
|
421
|
+
return 0;
|
|
422
|
+
}
|
|
423
|
+
const feeExecutionPayload = await feeOptions.walletFeePaymentMethod?.getExecutionPayload();
|
|
424
|
+
return (feeExecutionPayload?.calls.length ?? 0) + 1; // +1 for entrypoint
|
|
319
425
|
}
|
|
320
426
|
|
|
321
427
|
/**
|
|
@@ -326,10 +432,17 @@ export abstract class BaseWallet implements Wallet {
|
|
|
326
432
|
* @param opts - Simulation options (from address, fee settings, etc.).
|
|
327
433
|
* @returns The merged simulation result.
|
|
328
434
|
*/
|
|
329
|
-
async simulateTx(
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
435
|
+
async simulateTx(
|
|
436
|
+
executionPayload: ExecutionPayload,
|
|
437
|
+
opts: SimulateOptions,
|
|
438
|
+
): Promise<TxSimulationResultWithAppOffset> {
|
|
439
|
+
const feeOptions = await this.completeFeeOptions({
|
|
440
|
+
from: opts.from,
|
|
441
|
+
feePayer: executionPayload.feePayer,
|
|
442
|
+
gasSettings: opts.fee?.gasSettings,
|
|
443
|
+
forEstimation: true,
|
|
444
|
+
congestionEstimate: opts.fee?.congestionEstimate,
|
|
445
|
+
});
|
|
333
446
|
const { optimizableCalls, remainingCalls } = extractOptimizablePublicStaticCalls(executionPayload);
|
|
334
447
|
const remainingPayload = { ...executionPayload, calls: remainingCalls };
|
|
335
448
|
|
|
@@ -340,31 +453,34 @@ export abstract class BaseWallet implements Wallet {
|
|
|
340
453
|
try {
|
|
341
454
|
blockHeader = await this.pxe.getSyncedBlockHeader();
|
|
342
455
|
} catch {
|
|
343
|
-
blockHeader = (await this.aztecNode.
|
|
456
|
+
blockHeader = (await this.aztecNode.getBlockData('latest'))!.header;
|
|
344
457
|
}
|
|
345
458
|
|
|
459
|
+
const simulationOrigin = opts.from === NO_FROM ? AztecAddress.ZERO : opts.from;
|
|
346
460
|
const [optimizedResults, normalResult] = await Promise.all([
|
|
347
461
|
optimizableCalls.length > 0
|
|
348
462
|
? simulateViaNode(
|
|
349
463
|
this.aztecNode,
|
|
350
464
|
optimizableCalls,
|
|
351
|
-
|
|
465
|
+
simulationOrigin,
|
|
352
466
|
chainInfo,
|
|
353
467
|
feeOptions.gasSettings,
|
|
354
468
|
blockHeader,
|
|
355
469
|
opts.skipFeeEnforcement ?? true,
|
|
356
470
|
this.getContractName.bind(this),
|
|
471
|
+
opts.overrides,
|
|
357
472
|
)
|
|
358
473
|
: Promise.resolve([]),
|
|
359
474
|
remainingCalls.length > 0
|
|
360
|
-
? this.simulateViaEntrypoint(
|
|
361
|
-
|
|
362
|
-
opts.from,
|
|
475
|
+
? this.simulateViaEntrypoint(remainingPayload, {
|
|
476
|
+
from: opts.from,
|
|
363
477
|
feeOptions,
|
|
364
|
-
|
|
365
|
-
opts.skipTxValidation,
|
|
366
|
-
opts.skipFeeEnforcement ?? true,
|
|
367
|
-
|
|
478
|
+
additionalScopes: opts.additionalScopes,
|
|
479
|
+
skipTxValidation: opts.skipTxValidation,
|
|
480
|
+
skipFeeEnforcement: opts.skipFeeEnforcement ?? true,
|
|
481
|
+
sendMessagesAs: opts.sendMessagesAs,
|
|
482
|
+
overrides: opts.overrides,
|
|
483
|
+
})
|
|
368
484
|
: Promise.resolve(null),
|
|
369
485
|
]);
|
|
370
486
|
|
|
@@ -372,12 +488,18 @@ export abstract class BaseWallet implements Wallet {
|
|
|
372
488
|
}
|
|
373
489
|
|
|
374
490
|
async profileTx(executionPayload: ExecutionPayload, opts: ProfileOptions): Promise<TxProfileResult> {
|
|
375
|
-
const feeOptions = await this.completeFeeOptions(
|
|
491
|
+
const feeOptions = await this.completeFeeOptions({
|
|
492
|
+
from: opts.from,
|
|
493
|
+
feePayer: executionPayload.feePayer,
|
|
494
|
+
gasSettings: opts.fee?.gasSettings,
|
|
495
|
+
congestionEstimate: opts.fee?.congestionEstimate,
|
|
496
|
+
});
|
|
376
497
|
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
|
|
377
498
|
return this.pxe.profileTx(txRequest, {
|
|
378
499
|
profileMode: opts.profileMode,
|
|
379
500
|
skipProofGeneration: opts.skipProofGeneration ?? true,
|
|
380
501
|
scopes: this.scopesFrom(opts.from, opts.additionalScopes),
|
|
502
|
+
senderForTags: this.senderForTagsFrom(opts.from, opts.sendMessagesAs),
|
|
381
503
|
});
|
|
382
504
|
}
|
|
383
505
|
|
|
@@ -385,16 +507,24 @@ export abstract class BaseWallet implements Wallet {
|
|
|
385
507
|
executionPayload: ExecutionPayload,
|
|
386
508
|
opts: SendOptions<W>,
|
|
387
509
|
): Promise<SendReturn<W>> {
|
|
388
|
-
const feeOptions = await this.completeFeeOptions(
|
|
510
|
+
const feeOptions = await this.completeFeeOptions({
|
|
511
|
+
from: opts.from,
|
|
512
|
+
feePayer: executionPayload.feePayer,
|
|
513
|
+
gasSettings: opts.fee?.gasSettings,
|
|
514
|
+
congestionEstimate: opts.fee?.congestionEstimate,
|
|
515
|
+
});
|
|
389
516
|
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
|
|
390
|
-
const provenTx = await this.pxe.proveTx(txRequest,
|
|
517
|
+
const provenTx = await this.pxe.proveTx(txRequest, {
|
|
518
|
+
scopes: this.scopesFrom(opts.from, opts.additionalScopes),
|
|
519
|
+
senderForTags: this.senderForTagsFrom(opts.from, opts.sendMessagesAs),
|
|
520
|
+
});
|
|
391
521
|
const offchainOutput = extractOffchainOutput(
|
|
392
522
|
provenTx.getOffchainEffects(),
|
|
393
523
|
provenTx.publicInputs.constants.anchorBlockHeader.globalVariables.timestamp,
|
|
394
524
|
);
|
|
395
525
|
const tx = await provenTx.toTx();
|
|
396
526
|
const txHash = tx.getTxHash();
|
|
397
|
-
if (await this.aztecNode.
|
|
527
|
+
if ((await this.aztecNode.getTxReceipt(txHash)).isMined()) {
|
|
398
528
|
throw new Error(`A settled tx with equal hash ${txHash.toString()} exists.`);
|
|
399
529
|
}
|
|
400
530
|
this.log.debug(`Sending transaction ${txHash}`);
|
|
@@ -409,11 +539,15 @@ export abstract class BaseWallet implements Wallet {
|
|
|
409
539
|
}
|
|
410
540
|
|
|
411
541
|
// Otherwise, wait for the full receipt (default behavior on wait: undefined)
|
|
412
|
-
const
|
|
542
|
+
const callerWaitOpts = typeof opts.wait === 'object' ? opts.wait : undefined;
|
|
543
|
+
const waitOpts =
|
|
544
|
+
this.defaultWaitInterval !== undefined && callerWaitOpts?.interval === undefined
|
|
545
|
+
? { ...callerWaitOpts, interval: this.defaultWaitInterval }
|
|
546
|
+
: callerWaitOpts;
|
|
413
547
|
const receipt = await waitForTx(this.aztecNode, txHash, waitOpts);
|
|
414
548
|
|
|
415
549
|
// Display debug logs from public execution if present (served in test mode only)
|
|
416
|
-
if (receipt.debugLogs?.length) {
|
|
550
|
+
if (receipt.isMined() && receipt.debugLogs?.length) {
|
|
417
551
|
await displayDebugLogs(receipt.debugLogs, this.getContractName.bind(this));
|
|
418
552
|
}
|
|
419
553
|
|
|
@@ -429,7 +563,11 @@ export abstract class BaseWallet implements Wallet {
|
|
|
429
563
|
if (!instance) {
|
|
430
564
|
return undefined;
|
|
431
565
|
}
|
|
432
|
-
|
|
566
|
+
// Contract names are class-stable (an upgrade preserves the contract name), so the original class artifact is a
|
|
567
|
+
// sufficient source for the display name without resolving the current class against the node.
|
|
568
|
+
// TODO: if a contract were to be upgraded and its original artifact never registered, then this would fail and we'd
|
|
569
|
+
// want to fallback to the current class.
|
|
570
|
+
const artifact = await this.pxe.getContractArtifact(instance.originalContractClassId);
|
|
433
571
|
return artifact?.name;
|
|
434
572
|
}
|
|
435
573
|
|
|
@@ -448,7 +586,7 @@ export abstract class BaseWallet implements Wallet {
|
|
|
448
586
|
}
|
|
449
587
|
|
|
450
588
|
executeUtility(call: FunctionCall, opts: ExecuteUtilityOptions): Promise<UtilityExecutionResult> {
|
|
451
|
-
return this.pxe.executeUtility(call, { authwits: opts.authWitnesses, scopes:
|
|
589
|
+
return this.pxe.executeUtility(call, { authwits: opts.authWitnesses, scopes: opts.scopes });
|
|
452
590
|
}
|
|
453
591
|
|
|
454
592
|
async getPrivateEvents<T>(
|
|
@@ -471,17 +609,39 @@ export abstract class BaseWallet implements Wallet {
|
|
|
471
609
|
return decodedEvents;
|
|
472
610
|
}
|
|
473
611
|
|
|
612
|
+
/**
|
|
613
|
+
* Returns metadata about a contract, including whether it has been initialized, published, and updated.
|
|
614
|
+
* @param address - The contract address to query.
|
|
615
|
+
*/
|
|
474
616
|
async getContractMetadata(address: AztecAddress) {
|
|
475
617
|
const instance = await this.pxe.getContractInstance(address);
|
|
476
|
-
const
|
|
477
|
-
|
|
478
|
-
|
|
618
|
+
const publiclyRegisteredContractPromise = this.aztecNode.getContract(address);
|
|
619
|
+
|
|
620
|
+
let initializationStatus: ContractInitializationStatus;
|
|
621
|
+
if (instance) {
|
|
622
|
+
// We have the instance, so we can compute the private initialization nullifier (which includes init_hash and is
|
|
623
|
+
// emitted by both private and public initializers) and get a definitive INITIALIZED/UNINITIALIZED answer.
|
|
624
|
+
const initNullifier = await computeSiloedPrivateInitializationNullifier(address, instance.initializationHash);
|
|
625
|
+
const witness = await this.aztecNode.getNullifierMembershipWitness('latest', initNullifier);
|
|
626
|
+
initializationStatus = witness
|
|
627
|
+
? ContractInitializationStatus.INITIALIZED
|
|
628
|
+
: ContractInitializationStatus.UNINITIALIZED;
|
|
629
|
+
} else {
|
|
630
|
+
// Without the instance we lack the init_hash needed for the private nullifier. We fall back to checking the
|
|
631
|
+
// public initialization nullifier (computed from address alone). Not all contracts emit it (only those with
|
|
632
|
+
// public functions that require initialization checks), so its absence doesn't mean the contract is
|
|
633
|
+
// uninitialized.
|
|
634
|
+
const publicNullifier = await computeSiloedPublicInitializationNullifier(address);
|
|
635
|
+
const witness = await this.aztecNode.getNullifierMembershipWitness('latest', publicNullifier);
|
|
636
|
+
initializationStatus = witness ? ContractInitializationStatus.INITIALIZED : ContractInitializationStatus.UNKNOWN;
|
|
637
|
+
}
|
|
638
|
+
const publiclyRegisteredContract = await publiclyRegisteredContractPromise;
|
|
479
639
|
const isContractUpdated =
|
|
480
640
|
publiclyRegisteredContract &&
|
|
481
641
|
!publiclyRegisteredContract.currentContractClassId.equals(publiclyRegisteredContract.originalContractClassId);
|
|
482
642
|
return {
|
|
483
643
|
instance: instance ?? undefined,
|
|
484
|
-
|
|
644
|
+
initializationStatus,
|
|
485
645
|
isContractPublished: !!publiclyRegisteredContract,
|
|
486
646
|
isContractUpdated: !!isContractUpdated,
|
|
487
647
|
updatedContractClassId: isContractUpdated ? publiclyRegisteredContract.currentContractClassId : undefined,
|