@aztec/wallet-sdk 0.0.1-commit.4d79d1f2d → 0.0.1-commit.4d9804df
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 +86 -43
- package/dest/base-wallet/base_wallet.d.ts.map +1 -1
- package/dest/base-wallet/base_wallet.js +291 -117
- 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 +8 -4
- package/dest/base-wallet/utils.d.ts.map +1 -1
- package/dest/base-wallet/utils.js +15 -6
- 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 +27 -6
- package/dest/extension/provider/extension_wallet.d.ts.map +1 -1
- package/dest/extension/provider/extension_wallet.js +89 -11
- 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 +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 +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 +373 -175
- package/src/base-wallet/get_gas_limits.ts +88 -0
- package/src/base-wallet/index.ts +7 -1
- package/src/base-wallet/utils.ts +24 -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 +106 -17
- 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 +5 -4
- package/src/manager/wallet_manager.ts +55 -23
- package/src/types.ts +72 -0
|
@@ -1,16 +1,22 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { NO_FROM } from '@aztec/aztec.js/account';
|
|
2
|
+
import { NO_WAIT, extractOffchainOutput } from '@aztec/aztec.js/contracts';
|
|
2
3
|
import { waitForTx } from '@aztec/aztec.js/node';
|
|
3
|
-
import {
|
|
4
|
+
import { ContractInitializationStatus, TxSimulationResultWithAppOffset } from '@aztec/aztec.js/wallet';
|
|
4
5
|
import { AccountFeePaymentMethodOptions } from '@aztec/entrypoints/account';
|
|
6
|
+
import { DefaultEntrypoint } from '@aztec/entrypoints/default';
|
|
5
7
|
import { Fr } from '@aztec/foundation/curves/bn254';
|
|
6
8
|
import { createLogger } from '@aztec/foundation/log';
|
|
9
|
+
import { displayDebugLogs } from '@aztec/pxe/client/lazy';
|
|
7
10
|
import { decodeFromAbi } from '@aztec/stdlib/abi';
|
|
8
|
-
import {
|
|
11
|
+
import { AztecAddress } from '@aztec/stdlib/aztec-address';
|
|
12
|
+
import { computePartialAddress } from '@aztec/stdlib/contract';
|
|
9
13
|
import { SimulationError } from '@aztec/stdlib/errors';
|
|
10
|
-
import { Gas, GasSettings } from '@aztec/stdlib/gas';
|
|
11
|
-
import {
|
|
14
|
+
import { Gas, GasFees, GasSettings, ManaUsageEstimate } from '@aztec/stdlib/gas';
|
|
15
|
+
import { computeSiloedPrivateInitializationNullifier, computeSiloedPublicInitializationNullifier } from '@aztec/stdlib/hash';
|
|
16
|
+
import { deriveKeys, deriveKeysFromMasterSecretKeys } from '@aztec/stdlib/keys';
|
|
12
17
|
import { mergeExecutionPayloads } from '@aztec/stdlib/tx';
|
|
13
18
|
import { inspect } from 'util';
|
|
19
|
+
import { assertGasLimitsWithinNetworkLimits } from './get_gas_limits.js';
|
|
14
20
|
import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simulateViaNode } from './utils.js';
|
|
15
21
|
/**
|
|
16
22
|
* A base class for Wallet implementations
|
|
@@ -20,6 +26,12 @@ import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simul
|
|
|
20
26
|
log;
|
|
21
27
|
minFeePadding;
|
|
22
28
|
cancellableTransactions;
|
|
29
|
+
// Poll interval (in seconds) injected into sendTx waits when the caller does not specify one. Left undefined on
|
|
30
|
+
// production wallets so the DefaultWaitOpts 1s cadence stands; test wallets talking to in-process nodes lower it.
|
|
31
|
+
defaultWaitInterval;
|
|
32
|
+
// A wallet is instantiated for a particular chain, so chain info never changes during its lifetime.
|
|
33
|
+
// We cache it here because getChainInfo is called frequently (every tx simulation, send, auth wit, etc.).
|
|
34
|
+
nodeInfoPromise;
|
|
23
35
|
// Protected because we want to force wallets to instantiate their own PXE.
|
|
24
36
|
constructor(pxe, aztecNode, log = createLogger('wallet-sdk:base_wallet')){
|
|
25
37
|
this.pxe = pxe;
|
|
@@ -28,12 +40,32 @@ import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simul
|
|
|
28
40
|
this.minFeePadding = 0.5;
|
|
29
41
|
this.cancellableTransactions = false;
|
|
30
42
|
}
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
43
|
+
scopesFrom(from, additionalScopes, sendMessagesAs) {
|
|
44
|
+
// The sendMessagesAs account must be in scope so that its tagging secrets can be accessed.
|
|
45
|
+
const tagSenderScopes = sendMessagesAs ? [
|
|
46
|
+
sendMessagesAs
|
|
47
|
+
] : [];
|
|
48
|
+
const baseScopes = from === NO_FROM ? [] : [
|
|
35
49
|
from
|
|
36
50
|
];
|
|
51
|
+
const allScopes = [
|
|
52
|
+
...baseScopes,
|
|
53
|
+
...additionalScopes,
|
|
54
|
+
...tagSenderScopes
|
|
55
|
+
];
|
|
56
|
+
const scopeSet = new Set(allScopes.map((address)=>address.toString()));
|
|
57
|
+
return [
|
|
58
|
+
...scopeSet
|
|
59
|
+
].map(AztecAddress.fromStringUnsafe);
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Picks the sender address PXE should tag private messages with. Returns `undefined` when there is no signing
|
|
63
|
+
* account (`from === NO_FROM`) and no explicit override; in that case any private log emitted by the tx using
|
|
64
|
+
* the wallet-supplied default sender will fail the "Sender for tags is not set" assertion.
|
|
65
|
+
* @param from - Tx sender, or `NO_FROM`.
|
|
66
|
+
* @param sendMessagesAs - Explicit override.
|
|
67
|
+
*/ senderForTagsFrom(from, sendMessagesAs) {
|
|
68
|
+
return sendMessagesAs ?? (from === NO_FROM ? undefined : from);
|
|
37
69
|
}
|
|
38
70
|
/**
|
|
39
71
|
* Returns the list of aliased contacts associated with the wallet.
|
|
@@ -42,33 +74,64 @@ import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simul
|
|
|
42
74
|
* - Contacts: more general concept akin to a phone's contact list.
|
|
43
75
|
* @returns The aliased collection of AztecAddresses that form this wallet's address book
|
|
44
76
|
*/ async getAddressBook() {
|
|
45
|
-
const
|
|
46
|
-
|
|
47
|
-
|
|
77
|
+
const sources = await this.pxe.getTaggingSecretSources({
|
|
78
|
+
kind: 'address-derived'
|
|
79
|
+
});
|
|
80
|
+
return sources.map((source)=>({
|
|
81
|
+
item: source.sender,
|
|
48
82
|
alias: ''
|
|
49
83
|
}));
|
|
50
84
|
}
|
|
85
|
+
/**
|
|
86
|
+
* Fetches and caches the node info for the wallet's lifetime, since a wallet talks to a single network and
|
|
87
|
+
* node info never changes. A rejected fetch clears the cache so the next call retries instead of replaying
|
|
88
|
+
* the cached rejection forever — important because the gas-limit fill-in and validation (run on every send)
|
|
89
|
+
* depend on it.
|
|
90
|
+
*/ getNodeInfo() {
|
|
91
|
+
if (!this.nodeInfoPromise) {
|
|
92
|
+
this.nodeInfoPromise = this.aztecNode.getNodeInfo().catch((err)=>{
|
|
93
|
+
this.nodeInfoPromise = undefined;
|
|
94
|
+
throw err;
|
|
95
|
+
});
|
|
96
|
+
}
|
|
97
|
+
return this.nodeInfoPromise;
|
|
98
|
+
}
|
|
51
99
|
async getChainInfo() {
|
|
52
|
-
const { l1ChainId, rollupVersion } = await this.
|
|
100
|
+
const { l1ChainId, rollupVersion } = await this.getNodeInfo();
|
|
53
101
|
return {
|
|
54
102
|
chainId: new Fr(l1ChainId),
|
|
55
103
|
version: new Fr(rollupVersion)
|
|
56
104
|
};
|
|
57
105
|
}
|
|
106
|
+
/**
|
|
107
|
+
* Returns the maximum gas limits a single transaction may declare on this wallet's network (the
|
|
108
|
+
* node-advertised `txsLimits.gas`). Internal helper used to fill in default gas limits when sending a
|
|
109
|
+
* transaction without explicit limits, and to validate caller-provided limits before sending. Backed by
|
|
110
|
+
* the cached node info, since a wallet talks to a single network.
|
|
111
|
+
*/ async getMaxTxGasLimits() {
|
|
112
|
+
const { txsLimits } = await this.getNodeInfo();
|
|
113
|
+
return new Gas(txsLimits.gas.daGas, txsLimits.gas.l2Gas);
|
|
114
|
+
}
|
|
58
115
|
async createTxExecutionRequestFromPayloadAndFee(executionPayload, from, feeOptions) {
|
|
59
116
|
const feeExecutionPayload = await feeOptions.walletFeePaymentMethod?.getExecutionPayload();
|
|
60
|
-
const executionOptions = {
|
|
61
|
-
txNonce: Fr.random(),
|
|
62
|
-
cancellable: this.cancellableTransactions,
|
|
63
|
-
feePaymentMethodOptions: feeOptions.accountFeePaymentMethodOptions
|
|
64
|
-
};
|
|
65
117
|
const finalExecutionPayload = feeExecutionPayload ? mergeExecutionPayloads([
|
|
66
118
|
feeExecutionPayload,
|
|
67
119
|
executionPayload
|
|
68
120
|
]) : executionPayload;
|
|
69
|
-
const fromAccount = await this.getAccountFromAddress(from);
|
|
70
121
|
const chainInfo = await this.getChainInfo();
|
|
71
|
-
|
|
122
|
+
if (from === NO_FROM) {
|
|
123
|
+
const entrypoint = new DefaultEntrypoint();
|
|
124
|
+
return entrypoint.createTxExecutionRequest(finalExecutionPayload, feeOptions.gasSettings, chainInfo);
|
|
125
|
+
} else {
|
|
126
|
+
const fromAccount = await this.getAccountFromAddress(from);
|
|
127
|
+
const executionOptions = {
|
|
128
|
+
txNonce: Fr.random(),
|
|
129
|
+
cancellable: this.cancellableTransactions,
|
|
130
|
+
// If from is an address, feeOptions include the way the account contract should handle the fee payment
|
|
131
|
+
feePaymentMethodOptions: feeOptions.accountFeePaymentMethodOptions
|
|
132
|
+
};
|
|
133
|
+
return fromAccount.createTxExecutionRequest(finalExecutionPayload, feeOptions.gasSettings, chainInfo, executionOptions);
|
|
134
|
+
}
|
|
72
135
|
}
|
|
73
136
|
async createAuthWit(from, messageHashOrIntent) {
|
|
74
137
|
const account = await this.getAccountFromAddress(from);
|
|
@@ -111,26 +174,50 @@ import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simul
|
|
|
111
174
|
}
|
|
112
175
|
/**
|
|
113
176
|
* Completes partial user-provided fee options with wallet defaults.
|
|
114
|
-
* @param
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
*/ async completeFeeOptions(from, feePayer, gasSettings) {
|
|
119
|
-
const maxFeesPerGas = gasSettings?.maxFeesPerGas ?? (await this.aztecNode.getCurrentMinFees()).mul(1 + this.minFeePadding);
|
|
177
|
+
* @param config - Fee completion config.
|
|
178
|
+
*/ async completeFeeOptions(config) {
|
|
179
|
+
const { from, feePayer, gasSettings, forEstimation, congestionEstimate } = config;
|
|
180
|
+
const maxFeesPerGas = gasSettings?.maxFeesPerGas ?? (await this.getMinFees(congestionEstimate)).mul(1 + this.minFeePadding);
|
|
120
181
|
let accountFeePaymentMethodOptions;
|
|
121
|
-
//
|
|
122
|
-
//
|
|
123
|
-
if (
|
|
124
|
-
|
|
182
|
+
// If from is an address, we need to determine the appropriate fee payment method options for the
|
|
183
|
+
// account contract entrypoint to use
|
|
184
|
+
if (from !== NO_FROM) {
|
|
185
|
+
if (!feePayer) {
|
|
186
|
+
// The transaction does not include a fee payment method, so we set the flag
|
|
187
|
+
// for the account to use its fee juice balance
|
|
188
|
+
accountFeePaymentMethodOptions = AccountFeePaymentMethodOptions.PREEXISTING_FEE_JUICE;
|
|
189
|
+
} else {
|
|
190
|
+
// The transaction includes fee payment method, so we check if we are the fee payer for it
|
|
191
|
+
// (this can only happen if the embedded payment method is FeeJuiceWithClaim)
|
|
192
|
+
accountFeePaymentMethodOptions = from.equals(feePayer) ? AccountFeePaymentMethodOptions.FEE_JUICE_WITH_CLAIM : AccountFeePaymentMethodOptions.EXTERNAL;
|
|
193
|
+
}
|
|
194
|
+
}
|
|
195
|
+
const gasSettingsOverrides = {
|
|
196
|
+
gasLimits: gasSettings?.gasLimits ? Gas.from(gasSettings.gasLimits) : undefined,
|
|
197
|
+
teardownGasLimits: gasSettings?.teardownGasLimits ? Gas.from(gasSettings.teardownGasLimits) : undefined,
|
|
198
|
+
maxFeesPerGas,
|
|
199
|
+
maxPriorityFeesPerGas: gasSettings?.maxPriorityFeesPerGas ?? GasFees.empty()
|
|
200
|
+
};
|
|
201
|
+
// When estimating gas (simulation), use high limits so the simulation doesn't run out of gas.
|
|
202
|
+
// When sending for real without explicit limits, declare the most a single tx may use on this network
|
|
203
|
+
// (the node's per-tx admission limit), so the proposer does not skip the tx for over-declaring gas.
|
|
204
|
+
let fullGasSettings;
|
|
205
|
+
if (forEstimation) {
|
|
206
|
+
// Estimation deliberately uses very high internal limits and skips tx validation, so we do not
|
|
207
|
+
// validate against the network admission limit here.
|
|
208
|
+
fullGasSettings = GasSettings.forEstimation(gasSettingsOverrides);
|
|
125
209
|
} else {
|
|
126
|
-
|
|
127
|
-
//
|
|
128
|
-
|
|
210
|
+
const maxTxGasLimits = await this.getMaxTxGasLimits();
|
|
211
|
+
// If the caller declared explicit gas limits, reject them up front when they exceed the network's
|
|
212
|
+
// per-tx admission limit (mirroring the node's GasLimitsValidator). Otherwise fill in the limit.
|
|
213
|
+
if (gasSettingsOverrides.gasLimits) {
|
|
214
|
+
assertGasLimitsWithinNetworkLimits(gasSettingsOverrides.gasLimits, maxTxGasLimits);
|
|
215
|
+
}
|
|
216
|
+
fullGasSettings = GasSettings.fallback({
|
|
217
|
+
...gasSettingsOverrides,
|
|
218
|
+
gasLimits: gasSettingsOverrides.gasLimits ?? maxTxGasLimits
|
|
219
|
+
});
|
|
129
220
|
}
|
|
130
|
-
const fullGasSettings = GasSettings.default({
|
|
131
|
-
...gasSettings,
|
|
132
|
-
maxFeesPerGas
|
|
133
|
-
});
|
|
134
221
|
this.log.debug(`Using L2 gas settings`, fullGasSettings);
|
|
135
222
|
return {
|
|
136
223
|
gasSettings: fullGasSettings,
|
|
@@ -139,74 +226,85 @@ import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simul
|
|
|
139
226
|
};
|
|
140
227
|
}
|
|
141
228
|
/**
|
|
142
|
-
*
|
|
143
|
-
*
|
|
144
|
-
* to
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
const { gasSettings: { maxFeesPerGas, maxPriorityFeesPerGas } } = defaultFeeOptions;
|
|
151
|
-
// Use unrealistically high gas limits for estimation to avoid running out of gas.
|
|
152
|
-
// They will be tuned down after the simulation.
|
|
153
|
-
const gasSettingsForEstimation = new GasSettings(new Gas(GAS_ESTIMATION_DA_GAS_LIMIT, GAS_ESTIMATION_L2_GAS_LIMIT), new Gas(GAS_ESTIMATION_TEARDOWN_DA_GAS_LIMIT, GAS_ESTIMATION_TEARDOWN_L2_GAS_LIMIT), maxFeesPerGas, maxPriorityFeesPerGas);
|
|
154
|
-
return {
|
|
155
|
-
...defaultFeeOptions,
|
|
156
|
-
gasSettings: gasSettingsForEstimation
|
|
157
|
-
};
|
|
158
|
-
}
|
|
159
|
-
registerSender(address, _alias = '') {
|
|
160
|
-
return this.pxe.registerSender(address);
|
|
161
|
-
}
|
|
162
|
-
async registerContract(instance, artifact, secretKey) {
|
|
163
|
-
const existingInstance = await this.pxe.getContractInstance(instance.address);
|
|
164
|
-
if (existingInstance) {
|
|
165
|
-
// Instance already registered in the wallet
|
|
166
|
-
if (artifact) {
|
|
167
|
-
const thisContractClass = await getContractClassFromArtifact(artifact);
|
|
168
|
-
if (!thisContractClass.id.equals(existingInstance.currentContractClassId)) {
|
|
169
|
-
// wallet holds an outdated version of this contract
|
|
170
|
-
await this.pxe.updateContract(instance.address, artifact);
|
|
171
|
-
instance.currentContractClassId = thisContractClass.id;
|
|
172
|
-
}
|
|
229
|
+
* Returns the worst-case min fee across predicted future slots.
|
|
230
|
+
* Falls back to getCurrentMinFees if the node doesn't support getPredictedMinFees.
|
|
231
|
+
* @param estimate - The mana usage estimate to use for fee prediction. Defaults to Limit for conservative estimation.
|
|
232
|
+
*/ async getMinFees(estimate = ManaUsageEstimate.Limit) {
|
|
233
|
+
try {
|
|
234
|
+
const predicted = await this.aztecNode.getPredictedMinFees(estimate);
|
|
235
|
+
if (predicted.length === 0) {
|
|
236
|
+
return this.aztecNode.getCurrentMinFees();
|
|
173
237
|
}
|
|
174
|
-
|
|
175
|
-
}
|
|
176
|
-
//
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
if (!artifact) {
|
|
181
|
-
throw new Error(`Cannot register contract at ${instance.address.toString()}: artifact is required but not provided, and wallet does not have the artifact for contract class ${instance.currentContractClassId.toString()}`);
|
|
182
|
-
}
|
|
238
|
+
return predicted.reduce((worst, fees)=>fees.feePerL2Gas > worst.feePerL2Gas ? fees : worst);
|
|
239
|
+
} catch (err) {
|
|
240
|
+
// Fallback for old nodes that don't support getPredictedMinFees.
|
|
241
|
+
// Only fall back on method-not-found errors (JSON-RPC code -32601); rethrow others.
|
|
242
|
+
if (err?.cause?.code === -32601 || err?.message?.includes('Method not found')) {
|
|
243
|
+
return this.aztecNode.getCurrentMinFees();
|
|
183
244
|
}
|
|
184
|
-
|
|
185
|
-
artifact,
|
|
186
|
-
instance
|
|
187
|
-
});
|
|
245
|
+
throw err;
|
|
188
246
|
}
|
|
189
|
-
|
|
190
|
-
|
|
247
|
+
}
|
|
248
|
+
async registerSender(address, _alias = '') {
|
|
249
|
+
await this.pxe.registerTaggingSecretSource({
|
|
250
|
+
kind: 'address-derived',
|
|
251
|
+
sender: address
|
|
252
|
+
});
|
|
253
|
+
return address;
|
|
254
|
+
}
|
|
255
|
+
async registerContract(instance, artifact, secretKeyOrKeys) {
|
|
256
|
+
// Classes and instances are registered independently: register the artifact (if provided) then the instance.
|
|
257
|
+
// Neither call validates that the artifact matches the class the instance runs, a missing artifact only surfaces
|
|
258
|
+
// when the contract is later simulated.
|
|
259
|
+
if (artifact) {
|
|
260
|
+
await this.pxe.registerContractClass(artifact);
|
|
191
261
|
}
|
|
192
|
-
|
|
262
|
+
const contractAddress = await this.pxe.registerContract(instance);
|
|
263
|
+
if (secretKeyOrKeys) {
|
|
264
|
+
// PXE never receives the account seed (from which the message-signing/fallback secret keys could be re-derived):
|
|
265
|
+
// the wallet derives the keys here. Of these, PXE only reads and stores the four privacy secret keys and the
|
|
266
|
+
// message-signing and fallback *public* keys — it never touches the message-signing or fallback secret keys.
|
|
267
|
+
//
|
|
268
|
+
// Since PXE recomputes the address from those keys, we assert it matches the instance's address: a mismatch means
|
|
269
|
+
// the provided keys don't correspond to this account.
|
|
270
|
+
const derivedKeys = secretKeyOrKeys instanceof Fr ? await deriveKeys(secretKeyOrKeys) : await deriveKeysFromMasterSecretKeys(secretKeyOrKeys);
|
|
271
|
+
const { address } = await this.pxe.registerAccount(derivedKeys, await computePartialAddress(instance));
|
|
272
|
+
if (!address.equals(contractAddress)) {
|
|
273
|
+
throw new Error(`Registered account address ${address.toString()} does not match contract instance address ${contractAddress.toString()}: the provided keys do not correspond to this account.`);
|
|
274
|
+
}
|
|
275
|
+
}
|
|
276
|
+
}
|
|
277
|
+
registerContractClass(artifact) {
|
|
278
|
+
return this.pxe.registerContractClass(artifact);
|
|
193
279
|
}
|
|
194
280
|
/**
|
|
195
281
|
* Simulates calls through the standard PXE path (account entrypoint).
|
|
196
282
|
* @param executionPayload - The execution payload to simulate.
|
|
197
|
-
* @param
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
* @param scopes - The scopes to use for the simulation.
|
|
202
|
-
*/ async simulateViaEntrypoint(executionPayload, from, feeOptions, skipTxValidation, skipFeeEnforcement, scopes) {
|
|
203
|
-
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, from, feeOptions);
|
|
204
|
-
return this.pxe.simulateTx(txRequest, {
|
|
283
|
+
* @param opts - Simulation options.
|
|
284
|
+
*/ async simulateViaEntrypoint(executionPayload, opts) {
|
|
285
|
+
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, opts.feeOptions);
|
|
286
|
+
const result = await this.pxe.simulateTx(txRequest, {
|
|
205
287
|
simulatePublic: true,
|
|
206
|
-
skipTxValidation,
|
|
207
|
-
skipFeeEnforcement,
|
|
208
|
-
scopes
|
|
288
|
+
skipTxValidation: opts.skipTxValidation,
|
|
289
|
+
skipFeeEnforcement: opts.skipFeeEnforcement,
|
|
290
|
+
scopes: this.scopesFrom(opts.from, opts.additionalScopes ?? [], opts.sendMessagesAs),
|
|
291
|
+
senderForTags: this.senderForTagsFrom(opts.from, opts.sendMessagesAs),
|
|
292
|
+
overrides: opts.overrides
|
|
209
293
|
});
|
|
294
|
+
const appCallOffset = await this.computeAppCallOffset(opts.from, opts.feeOptions);
|
|
295
|
+
return TxSimulationResultWithAppOffset.fromResultAndOffset(result, appCallOffset);
|
|
296
|
+
}
|
|
297
|
+
/**
|
|
298
|
+
* Computes the index where the app's calls begin in the flattened array of calls (0 = entrypoint/root, 1..N = fee
|
|
299
|
+
* calls, N+1 = app).
|
|
300
|
+
* @param from - The sender address, or NO_FROM for the default entrypoint.
|
|
301
|
+
* @param feeOptions - Fee options containing the wallet fee payment method.
|
|
302
|
+
*/ async computeAppCallOffset(from, feeOptions) {
|
|
303
|
+
if (from === NO_FROM) {
|
|
304
|
+
return 0;
|
|
305
|
+
}
|
|
306
|
+
const feeExecutionPayload = await feeOptions.walletFeePaymentMethod?.getExecutionPayload();
|
|
307
|
+
return (feeExecutionPayload?.calls.length ?? 0) + 1; // +1 for entrypoint
|
|
210
308
|
}
|
|
211
309
|
/**
|
|
212
310
|
* Simulates a transaction, optimizing leading public static calls by running them directly
|
|
@@ -216,7 +314,13 @@ import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simul
|
|
|
216
314
|
* @param opts - Simulation options (from address, fee settings, etc.).
|
|
217
315
|
* @returns The merged simulation result.
|
|
218
316
|
*/ async simulateTx(executionPayload, opts) {
|
|
219
|
-
const feeOptions =
|
|
317
|
+
const feeOptions = await this.completeFeeOptions({
|
|
318
|
+
from: opts.from,
|
|
319
|
+
feePayer: executionPayload.feePayer,
|
|
320
|
+
gasSettings: opts.fee?.gasSettings,
|
|
321
|
+
forEstimation: true,
|
|
322
|
+
congestionEstimate: opts.fee?.congestionEstimate
|
|
323
|
+
});
|
|
220
324
|
const { optimizableCalls, remainingCalls } = extractOptimizablePublicStaticCalls(executionPayload);
|
|
221
325
|
const remainingPayload = {
|
|
222
326
|
...executionPayload,
|
|
@@ -229,30 +333,54 @@ import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simul
|
|
|
229
333
|
try {
|
|
230
334
|
blockHeader = await this.pxe.getSyncedBlockHeader();
|
|
231
335
|
} catch {
|
|
232
|
-
blockHeader = await this.aztecNode.
|
|
336
|
+
blockHeader = (await this.aztecNode.getBlockData('latest')).header;
|
|
233
337
|
}
|
|
338
|
+
const simulationOrigin = opts.from === NO_FROM ? AztecAddress.ZERO : opts.from;
|
|
234
339
|
const [optimizedResults, normalResult] = await Promise.all([
|
|
235
|
-
optimizableCalls.length > 0 ? simulateViaNode(this.aztecNode, optimizableCalls,
|
|
236
|
-
remainingCalls.length > 0 ? this.simulateViaEntrypoint(remainingPayload,
|
|
340
|
+
optimizableCalls.length > 0 ? simulateViaNode(this.aztecNode, optimizableCalls, simulationOrigin, chainInfo, feeOptions.gasSettings, blockHeader, opts.skipFeeEnforcement ?? true, this.getContractName.bind(this), opts.overrides) : Promise.resolve([]),
|
|
341
|
+
remainingCalls.length > 0 ? this.simulateViaEntrypoint(remainingPayload, {
|
|
342
|
+
from: opts.from,
|
|
343
|
+
feeOptions,
|
|
344
|
+
additionalScopes: opts.additionalScopes,
|
|
345
|
+
skipTxValidation: opts.skipTxValidation,
|
|
346
|
+
skipFeeEnforcement: opts.skipFeeEnforcement ?? true,
|
|
347
|
+
sendMessagesAs: opts.sendMessagesAs,
|
|
348
|
+
overrides: opts.overrides
|
|
349
|
+
}) : Promise.resolve(null)
|
|
237
350
|
]);
|
|
238
351
|
return buildMergedSimulationResult(optimizedResults, normalResult);
|
|
239
352
|
}
|
|
240
353
|
async profileTx(executionPayload, opts) {
|
|
241
|
-
const feeOptions = await this.completeFeeOptions(
|
|
354
|
+
const feeOptions = await this.completeFeeOptions({
|
|
355
|
+
from: opts.from,
|
|
356
|
+
feePayer: executionPayload.feePayer,
|
|
357
|
+
gasSettings: opts.fee?.gasSettings,
|
|
358
|
+
congestionEstimate: opts.fee?.congestionEstimate
|
|
359
|
+
});
|
|
242
360
|
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
|
|
243
361
|
return this.pxe.profileTx(txRequest, {
|
|
244
362
|
profileMode: opts.profileMode,
|
|
245
363
|
skipProofGeneration: opts.skipProofGeneration ?? true,
|
|
246
|
-
scopes: this.
|
|
364
|
+
scopes: this.scopesFrom(opts.from, opts.additionalScopes ?? [], opts.sendMessagesAs),
|
|
365
|
+
senderForTags: this.senderForTagsFrom(opts.from, opts.sendMessagesAs)
|
|
247
366
|
});
|
|
248
367
|
}
|
|
249
368
|
async sendTx(executionPayload, opts) {
|
|
250
|
-
const feeOptions = await this.completeFeeOptions(
|
|
369
|
+
const feeOptions = await this.completeFeeOptions({
|
|
370
|
+
from: opts.from,
|
|
371
|
+
feePayer: executionPayload.feePayer,
|
|
372
|
+
gasSettings: opts.fee?.gasSettings,
|
|
373
|
+
congestionEstimate: opts.fee?.congestionEstimate
|
|
374
|
+
});
|
|
251
375
|
const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
|
|
252
|
-
const provenTx = await this.pxe.proveTx(txRequest,
|
|
376
|
+
const provenTx = await this.pxe.proveTx(txRequest, {
|
|
377
|
+
scopes: this.scopesFrom(opts.from, opts.additionalScopes ?? [], opts.sendMessagesAs),
|
|
378
|
+
senderForTags: this.senderForTagsFrom(opts.from, opts.sendMessagesAs)
|
|
379
|
+
});
|
|
380
|
+
const offchainOutput = extractOffchainOutput(provenTx.getOffchainEffects(), provenTx.publicInputs.constants.anchorBlockHeader.globalVariables.timestamp);
|
|
253
381
|
const tx = await provenTx.toTx();
|
|
254
382
|
const txHash = tx.getTxHash();
|
|
255
|
-
if (await this.aztecNode.
|
|
383
|
+
if ((await this.aztecNode.getTxReceipt(txHash)).isMined()) {
|
|
256
384
|
throw new Error(`A settled tx with equal hash ${txHash.toString()} exists.`);
|
|
257
385
|
}
|
|
258
386
|
this.log.debug(`Sending transaction ${txHash}`);
|
|
@@ -262,11 +390,41 @@ import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simul
|
|
|
262
390
|
this.log.info(`Sent transaction ${txHash}`);
|
|
263
391
|
// If wait is NO_WAIT, return txHash immediately
|
|
264
392
|
if (opts.wait === NO_WAIT) {
|
|
265
|
-
return
|
|
393
|
+
return {
|
|
394
|
+
txHash,
|
|
395
|
+
...offchainOutput
|
|
396
|
+
};
|
|
266
397
|
}
|
|
267
398
|
// Otherwise, wait for the full receipt (default behavior on wait: undefined)
|
|
268
|
-
const
|
|
269
|
-
|
|
399
|
+
const callerWaitOpts = typeof opts.wait === 'object' ? opts.wait : undefined;
|
|
400
|
+
const waitOpts = this.defaultWaitInterval !== undefined && callerWaitOpts?.interval === undefined ? {
|
|
401
|
+
...callerWaitOpts,
|
|
402
|
+
interval: this.defaultWaitInterval
|
|
403
|
+
} : callerWaitOpts;
|
|
404
|
+
const receipt = await waitForTx(this.aztecNode, txHash, waitOpts);
|
|
405
|
+
// Display debug logs from public execution if present (served in test mode only)
|
|
406
|
+
if (receipt.isMined() && receipt.debugLogs?.length) {
|
|
407
|
+
await displayDebugLogs(receipt.debugLogs, this.getContractName.bind(this));
|
|
408
|
+
}
|
|
409
|
+
return {
|
|
410
|
+
receipt,
|
|
411
|
+
...offchainOutput
|
|
412
|
+
};
|
|
413
|
+
}
|
|
414
|
+
/**
|
|
415
|
+
* Resolves a contract address to a human-readable name via PXE, if available.
|
|
416
|
+
* @param address - The contract address to resolve.
|
|
417
|
+
*/ async getContractName(address) {
|
|
418
|
+
const instance = await this.pxe.getContractInstance(address);
|
|
419
|
+
if (!instance) {
|
|
420
|
+
return undefined;
|
|
421
|
+
}
|
|
422
|
+
// Contract names are class-stable (an upgrade preserves the contract name), so the original class artifact is a
|
|
423
|
+
// sufficient source for the display name without resolving the current class against the node.
|
|
424
|
+
// TODO: if a contract were to be upgraded and its original artifact never registered, then this would fail and we'd
|
|
425
|
+
// want to fallback to the current class.
|
|
426
|
+
const artifact = await this.pxe.getContractArtifact(instance.originalContractClassId);
|
|
427
|
+
return artifact?.name;
|
|
270
428
|
}
|
|
271
429
|
contextualizeError(err, ...context) {
|
|
272
430
|
let contextStr = '';
|
|
@@ -281,12 +439,10 @@ import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simul
|
|
|
281
439
|
}
|
|
282
440
|
return err;
|
|
283
441
|
}
|
|
284
|
-
|
|
285
|
-
return this.pxe.
|
|
442
|
+
executeUtility(call, opts) {
|
|
443
|
+
return this.pxe.executeUtility(call, {
|
|
286
444
|
authwits: opts.authWitnesses,
|
|
287
|
-
scopes:
|
|
288
|
-
opts.scope
|
|
289
|
-
]
|
|
445
|
+
scopes: opts.scopes
|
|
290
446
|
});
|
|
291
447
|
}
|
|
292
448
|
async getPrivateEvents(eventDef, eventFilter) {
|
|
@@ -305,15 +461,33 @@ import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simul
|
|
|
305
461
|
});
|
|
306
462
|
return decodedEvents;
|
|
307
463
|
}
|
|
308
|
-
|
|
464
|
+
/**
|
|
465
|
+
* Returns metadata about a contract, including whether it has been initialized, published, and updated.
|
|
466
|
+
* @param address - The contract address to query.
|
|
467
|
+
*/ async getContractMetadata(address) {
|
|
309
468
|
const instance = await this.pxe.getContractInstance(address);
|
|
310
|
-
const
|
|
311
|
-
|
|
312
|
-
|
|
469
|
+
const publiclyRegisteredContractPromise = this.aztecNode.getContract(address);
|
|
470
|
+
let initializationStatus;
|
|
471
|
+
if (instance) {
|
|
472
|
+
// We have the instance, so we can compute the private initialization nullifier (which includes init_hash and is
|
|
473
|
+
// emitted by both private and public initializers) and get a definitive INITIALIZED/UNINITIALIZED answer.
|
|
474
|
+
const initNullifier = await computeSiloedPrivateInitializationNullifier(address, instance.initializationHash);
|
|
475
|
+
const witness = await this.aztecNode.getNullifierMembershipWitness('latest', initNullifier);
|
|
476
|
+
initializationStatus = witness ? ContractInitializationStatus.INITIALIZED : ContractInitializationStatus.UNINITIALIZED;
|
|
477
|
+
} else {
|
|
478
|
+
// Without the instance we lack the init_hash needed for the private nullifier. We fall back to checking the
|
|
479
|
+
// public initialization nullifier (computed from address alone). Not all contracts emit it (only those with
|
|
480
|
+
// public functions that require initialization checks), so its absence doesn't mean the contract is
|
|
481
|
+
// uninitialized.
|
|
482
|
+
const publicNullifier = await computeSiloedPublicInitializationNullifier(address);
|
|
483
|
+
const witness = await this.aztecNode.getNullifierMembershipWitness('latest', publicNullifier);
|
|
484
|
+
initializationStatus = witness ? ContractInitializationStatus.INITIALIZED : ContractInitializationStatus.UNKNOWN;
|
|
485
|
+
}
|
|
486
|
+
const publiclyRegisteredContract = await publiclyRegisteredContractPromise;
|
|
313
487
|
const isContractUpdated = publiclyRegisteredContract && !publiclyRegisteredContract.currentContractClassId.equals(publiclyRegisteredContract.originalContractClassId);
|
|
314
488
|
return {
|
|
315
489
|
instance: instance ?? undefined,
|
|
316
|
-
|
|
490
|
+
initializationStatus,
|
|
317
491
|
isContractPublished: !!publiclyRegisteredContract,
|
|
318
492
|
isContractUpdated: !!isContractUpdated,
|
|
319
493
|
updatedContractClassId: isContractUpdated ? publiclyRegisteredContract.currentContractClassId : undefined
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { Gas, type GasUsed } from '@aztec/stdlib/gas';
|
|
2
|
+
/**
|
|
3
|
+
* Returns suggested total and teardown gas limits for a simulated tx, clamped to the network's per-tx
|
|
4
|
+
* admission limits.
|
|
5
|
+
*
|
|
6
|
+
* The network only admits transactions that declare up to `maxTxGasLimits` per dimension (the
|
|
7
|
+
* node-advertised `txsLimits.gas`). Wallets pass the value read from their own node info, but since node info
|
|
8
|
+
* is remote input it is defensively clamped here to the per-tx protocol maxima so a value above them is never
|
|
9
|
+
* honored. If the simulated usage already exceeds the resulting admission limits the tx can never be included,
|
|
10
|
+
* so this throws a descriptive error instead of returning a limit the node would reject. Otherwise it pads the
|
|
11
|
+
* usage and clamps each dimension to the admission limit.
|
|
12
|
+
* @param gasUsed - The gas actually consumed during simulation.
|
|
13
|
+
* @param maxTxGasLimits - The maximum gas a single tx may declare on this network (the node-advertised `txsLimits.gas`).
|
|
14
|
+
* @param pad - Fraction to pad the suggested gas limits by (as a decimal, e.g. 0.1 for 10%). The effective
|
|
15
|
+
* padding shrinks to zero as usage approaches the network limit, since the network will not admit a higher
|
|
16
|
+
* declared limit regardless of the buffer.
|
|
17
|
+
*/
|
|
18
|
+
export declare function getGasLimits(gasUsed: GasUsed, maxTxGasLimits: Gas, pad?: number): {
|
|
19
|
+
/**
|
|
20
|
+
* Gas limit for the tx, excluding teardown gas
|
|
21
|
+
*/
|
|
22
|
+
gasLimits: Gas;
|
|
23
|
+
/**
|
|
24
|
+
* Gas limit for the teardown phase
|
|
25
|
+
*/
|
|
26
|
+
teardownGasLimits: Gas;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* Validates that caller-declared gas limits do not exceed the network's per-tx admission limits, throwing a
|
|
30
|
+
* descriptive error per dimension when they do. The node's inbound validation checks declared
|
|
31
|
+
* `gasSettings.gasLimits`, so we mirror that here to surface the rejection locally before the tx is sent.
|
|
32
|
+
* @param gasLimits - The gas limits the transaction will declare.
|
|
33
|
+
* @param maxTxGasLimits - The maximum gas a single tx may declare on this network (the node-advertised `txsLimits.gas`).
|
|
34
|
+
*/
|
|
35
|
+
export declare function assertGasLimitsWithinNetworkLimits(gasLimits: Gas, maxTxGasLimits: Gas): void;
|
|
36
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ2V0X2dhc19saW1pdHMuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9iYXNlLXdhbGxldC9nZXRfZ2FzX2xpbWl0cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFDQSxPQUFPLEVBQUUsR0FBRyxFQUFFLEtBQUssT0FBTyxFQUFFLE1BQU0sbUJBQW1CLENBQUM7QUFFdEQ7Ozs7Ozs7Ozs7Ozs7OztHQWVHO0FBQ0gsd0JBQWdCLFlBQVksQ0FDMUIsT0FBTyxFQUFFLE9BQU8sRUFDaEIsY0FBYyxFQUFFLEdBQUcsRUFDbkIsR0FBRyxTQUFNLEdBQ1I7SUFDRDs7T0FFRztJQUNILFNBQVMsRUFBRSxHQUFHLENBQUM7SUFDZjs7T0FFRztJQUNILGlCQUFpQixFQUFFLEdBQUcsQ0FBQztDQUN4QixDQTZCQTtBQVFEOzs7Ozs7R0FNRztBQUNILHdCQUFnQixrQ0FBa0MsQ0FBQyxTQUFTLEVBQUUsR0FBRyxFQUFFLGNBQWMsRUFBRSxHQUFHLEdBQUcsSUFBSSxDQVc1RiJ9
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"get_gas_limits.d.ts","sourceRoot":"","sources":["../../src/base-wallet/get_gas_limits.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAE,KAAK,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAEtD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,OAAO,EAChB,cAAc,EAAE,GAAG,EACnB,GAAG,SAAM,GACR;IACD;;OAEG;IACH,SAAS,EAAE,GAAG,CAAC;IACf;;OAEG;IACH,iBAAiB,EAAE,GAAG,CAAC;CACxB,CA6BA;AAQD;;;;;;GAMG;AACH,wBAAgB,kCAAkC,CAAC,SAAS,EAAE,GAAG,EAAE,cAAc,EAAE,GAAG,GAAG,IAAI,CAW5F"}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { MAX_PROCESSABLE_L2_GAS, MAX_TX_DA_GAS } from '@aztec/constants';
|
|
2
|
+
import { Gas } from '@aztec/stdlib/gas';
|
|
3
|
+
/**
|
|
4
|
+
* Returns suggested total and teardown gas limits for a simulated tx, clamped to the network's per-tx
|
|
5
|
+
* admission limits.
|
|
6
|
+
*
|
|
7
|
+
* The network only admits transactions that declare up to `maxTxGasLimits` per dimension (the
|
|
8
|
+
* node-advertised `txsLimits.gas`). Wallets pass the value read from their own node info, but since node info
|
|
9
|
+
* is remote input it is defensively clamped here to the per-tx protocol maxima so a value above them is never
|
|
10
|
+
* honored. If the simulated usage already exceeds the resulting admission limits the tx can never be included,
|
|
11
|
+
* so this throws a descriptive error instead of returning a limit the node would reject. Otherwise it pads the
|
|
12
|
+
* usage and clamps each dimension to the admission limit.
|
|
13
|
+
* @param gasUsed - The gas actually consumed during simulation.
|
|
14
|
+
* @param maxTxGasLimits - The maximum gas a single tx may declare on this network (the node-advertised `txsLimits.gas`).
|
|
15
|
+
* @param pad - Fraction to pad the suggested gas limits by (as a decimal, e.g. 0.1 for 10%). The effective
|
|
16
|
+
* padding shrinks to zero as usage approaches the network limit, since the network will not admit a higher
|
|
17
|
+
* declared limit regardless of the buffer.
|
|
18
|
+
*/ export function getGasLimits(gasUsed, maxTxGasLimits, pad = 0.1) {
|
|
19
|
+
const { totalGas, teardownGas } = gasUsed;
|
|
20
|
+
// `maxTxGasLimits` is the node-advertised admission limit. Node info is remote input, so we defensively
|
|
21
|
+
// clamp to the per-tx protocol maxima so a value above them can never be honored.
|
|
22
|
+
const maxLimits = new Gas(Math.min(maxTxGasLimits.daGas, MAX_TX_DA_GAS), Math.min(maxTxGasLimits.l2Gas, MAX_PROCESSABLE_L2_GAS));
|
|
23
|
+
// The simulated usage must fit within the admission limits, otherwise the tx can never be included.
|
|
24
|
+
if (totalGas.daGas > maxLimits.daGas) {
|
|
25
|
+
throw new Error(`Transaction consumes ${totalGas.daGas} DA gas but the network only admits transactions declaring up to ${maxLimits.daGas} DA gas`);
|
|
26
|
+
}
|
|
27
|
+
if (totalGas.l2Gas > maxLimits.l2Gas) {
|
|
28
|
+
throw new Error(`Transaction consumes ${totalGas.l2Gas} L2 gas but the network only admits transactions declaring up to ${maxLimits.l2Gas} L2 gas`);
|
|
29
|
+
}
|
|
30
|
+
// Pad the limits by the buffer, then cap each dimension at the admission limit so the buffer cannot push a
|
|
31
|
+
// declared limit past what inbound validation accepts. Teardown is part of the total, so clamping it to the
|
|
32
|
+
// admission limit is safe.
|
|
33
|
+
return {
|
|
34
|
+
gasLimits: padGas(totalGas, pad, maxLimits),
|
|
35
|
+
teardownGasLimits: padGas(teardownGas, pad, maxLimits)
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
/** Pads each gas dimension, capping it at the network admission limit. */ function padGas(gas, pad, cap) {
|
|
39
|
+
const padded = gas.mul(1 + pad);
|
|
40
|
+
return new Gas(Math.min(padded.daGas, cap.daGas), Math.min(padded.l2Gas, cap.l2Gas));
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Validates that caller-declared gas limits do not exceed the network's per-tx admission limits, throwing a
|
|
44
|
+
* descriptive error per dimension when they do. The node's inbound validation checks declared
|
|
45
|
+
* `gasSettings.gasLimits`, so we mirror that here to surface the rejection locally before the tx is sent.
|
|
46
|
+
* @param gasLimits - The gas limits the transaction will declare.
|
|
47
|
+
* @param maxTxGasLimits - The maximum gas a single tx may declare on this network (the node-advertised `txsLimits.gas`).
|
|
48
|
+
*/ export function assertGasLimitsWithinNetworkLimits(gasLimits, maxTxGasLimits) {
|
|
49
|
+
if (gasLimits.daGas > maxTxGasLimits.daGas) {
|
|
50
|
+
throw new Error(`Declared DA gas limit (${gasLimits.daGas}) exceeds the maximum this network allows per tx (${maxTxGasLimits.daGas})`);
|
|
51
|
+
}
|
|
52
|
+
if (gasLimits.l2Gas > maxTxGasLimits.l2Gas) {
|
|
53
|
+
throw new Error(`Declared L2 gas limit (${gasLimits.l2Gas}) exceeds the maximum this network allows per tx (${maxTxGasLimits.l2Gas})`);
|
|
54
|
+
}
|
|
55
|
+
}
|