crypto-aio 0.0.3 → 0.1.0

package/dist/adapters/evm/fees.js

@@ -0,0 +1,234 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_MAX_FEE_PER_GAS = exports.TRANSFER_GAS = exports.FEE_PERCENTILES = exports.FEE_HISTORY_BLOCKS = void 0;
+exports.median = median;
+exports.feesFromHistory = feesFromHistory;
+exports.legacyPrice = legacyPrice;
+exports.gasLimitFrom = gasLimitFrom;
+exports.priceCap = priceCap;
+exports.capPrice = capPrice;
+exports.assertWithinCeiling = assertWithinCeiling;
+exports.parseFeeOverride = parseFeeOverride;
+exports.feeDraft = feeDraft;
+exports.feeOf = feeOf;
+exports.meetsBump = meetsBump;
+exports.minimumBump = minimumBump;
+/**
+ * The EVM fee policy: `evm-1559` or `evm-legacy` per network, an `upper`
+ * bound with the `expected` cost in the details, overrides, and replacement bumps. Pure
+ * functions over plain data; the driver does the I/O.
+ */
+const error_1 = require("../../core/errors/error");
+/**
+ * `eth_feeHistory` window and priority-fee percentiles for slow, normal and fast: the
+ * method the Polygon Gas Station documents (10th, 25th and 50th over the last 15 blocks).
+ */
+exports.FEE_HISTORY_BLOCKS = 15;
+exports.FEE_PERCENTILES = [10, 25, 50];
+const SPEED_INDEX = { slow: 0, normal: 1, fast: 2 };
+/** Legacy networks: `eth_gasPrice` scaled per speed, in percent. */
+const LEGACY_PERCENT = {
+    slow: 100n,
+    normal: 110n,
+    fast: 125n,
+};
+/** A plain transfer to an account without code costs exactly this much gas. */
+exports.TRANSFER_GAS = 21000n;
+/** Headroom over the node's estimate for anything but a plain transfer, in percent. */
+const GAS_HEADROOM_PERCENT = 120n;
+const ceilDiv = (a, b) => (a + b - 1n) / b;
+const max = (a, b) => (a > b ? a : b);
+const min = (a, b) => (a < b ? a : b);
+/** The lower median; `0n` for no values. */
+function median(values) {
+    if (values.length === 0)
+        return 0n;
+    const sorted = [...values].sort((a, b) => (a < b ? -1 : a > b ? 1 : 0));
+    return sorted[Math.floor((sorted.length - 1) / 2)];
+}
+const malformedHistory = () => new error_1.ProviderError('PROVIDER_UNAVAILABLE', 'malformed fee history');
+/**
+ * EIP-1559 prices for `speed`: the tip is the median, over the window, of the speed's
+ * percentile (at least `minTip`); the cap allows the next base fee to double. The history
+ * must answer a request for `FEE_PERCENTILES`: one without the next base fee, without
+ * reward rows, or with a reward row shorter than `FEE_PERCENTILES` is a retryable
+ * `PROVIDER_UNAVAILABLE`, never a tip of `minTip`.
+ */
+function feesFromHistory(history, speed, minTip) {
+    const baseFeePerGas = history.baseFeePerGas[history.baseFeePerGas.length - 1];
+    if (baseFeePerGas === undefined || history.reward.length === 0) {
+        throw malformedHistory();
+    }
+    const index = SPEED_INDEX[speed];
+    const tips = history.reward.map((row) => {
+        const tip = row[index];
+        if (row.length < exports.FEE_PERCENTILES.length || tip === undefined)
+            throw malformedHistory();
+        return tip;
+    });
+    const tip = max(median(tips), minTip);
+    return {
+        params: {
+            type: 'eip1559',
+            maxFeePerGas: 2n * baseFeePerGas + tip,
+            maxPriorityFeePerGas: tip,
+        },
+        baseFeePerGas,
+    };
+}
+function legacyPrice(gasPrice, speed) {
+    return { type: 'legacy', gasPrice: ceilDiv(gasPrice * LEGACY_PERCENT[speed], 100n) };
+}
+/** The node's estimate, with headroom unless it is a plain transfer. */
+function gasLimitFrom(estimate) {
+    return estimate === exports.TRANSFER_GAS
+        ? exports.TRANSFER_GAS
+        : ceilDiv(estimate * GAS_HEADROOM_PERCENT, 100n);
+}
+const invalid = (reason) => new error_1.ValidationError('INVALID_INTENT', reason);
+/**
+ * The default `maxFeePerGas`, the highest price per gas an EVM transaction signs, 1,000
+ * gwei. It bounds a plain transfer at 0.021 and a 65,000-gas token transfer at 0.065 of
+ * the native coin, however an endpoint prices the fee. A network whose base fee rises
+ * above the ceiling stalls its transfers as `FEE_TOO_LOW` until the fee falls or the
+ * option is raised.
+ */
+exports.DEFAULT_MAX_FEE_PER_GAS = 1000000000000n;
+/** The highest price per gas `params` may pay: the fee cap, or the legacy gas price. */
+function priceCap(params) {
+    return params.type === 'eip1559' ? params.maxFeePerGas : params.gasPrice;
+}
+/**
+ * A node's suggestion within the ceiling: the fee cap or gas price at most `ceiling`,
+ * and the tip at most the fee cap. No endpoint can raise what a transfer signs.
+ */
+function capPrice(params, ceiling) {
+    if (params.type === 'legacy')
+        return { type: 'legacy', gasPrice: min(params.gasPrice, ceiling) };
+    const maxFeePerGas = min(params.maxFeePerGas, ceiling);
+    return {
+        type: 'eip1559',
+        maxFeePerGas,
+        maxPriorityFeePerGas: min(params.maxPriorityFeePerGas, maxFeePerGas),
+    };
+}
+/**
+ * Refuses, before anything is signed, a fee whose price per gas is above `ceiling` (the
+ * handle's `maxFeePerGas`), whatever produced it: an explicit override, a stored fee, or a
+ * cancel's least bump. The details carry the price and the bound as decimal strings.
+ */
+function assertWithinCeiling(params, ceiling) {
+    const price = priceCap(params);
+    if (price <= ceiling)
+        return;
+    throw new error_1.ValidationError('INVALID_INTENT', 'the fee is above maxFeePerGas, the EVM handle option that bounds it (wei per gas)', { details: { required: price.toString(), maxFeePerGas: ceiling.toString() } });
+}
+/** Validates an `EvmFeeOverride` against the network's fee model. */
+function parseFeeOverride(override, model) {
+    const allowed = model === 'evm-1559'
+        ? ['maxFeePerGas', 'maxPriorityFeePerGas', 'gasLimit']
+        : ['gasPrice', 'gasLimit'];
+    const shape = model === 'evm-1559'
+        ? '{ maxFeePerGas, maxPriorityFeePerGas, gasLimit? }'
+        : '{ gasPrice, gasLimit? }';
+    const keys = Object.keys(override);
+    if (keys.some((key) => !allowed.includes(key))) {
+        throw invalid(`${model} fee overrides look like ${shape}`);
+    }
+    const amount = (key, min) => {
+        const value = override[key];
+        if (typeof value !== 'bigint' || value < min) {
+            throw invalid(`fee override '${key}' must be a bigint of at least ${min}`);
+        }
+        return value;
+    };
+    const gasLimit = override.gasLimit === undefined ? undefined : amount('gasLimit', exports.TRANSFER_GAS);
+    const limit = gasLimit !== undefined ? { gasLimit } : {};
+    if (model === 'evm-legacy') {
+        return { params: { type: 'legacy', gasPrice: amount('gasPrice', 1n) }, ...limit };
+    }
+    const maxFeePerGas = amount('maxFeePerGas', 1n);
+    const maxPriorityFeePerGas = amount('maxPriorityFeePerGas', 0n);
+    if (maxPriorityFeePerGas > maxFeePerGas) {
+        throw invalid('maxPriorityFeePerGas must not exceed maxFeePerGas');
+    }
+    return { params: { type: 'eip1559', maxFeePerGas, maxPriorityFeePerGas }, ...limit };
+}
+/** The fee draft for a transaction of `gasLimit` at `params`. */
+function feeDraft(speed, gasLimit, params, extra = {}) {
+    const cap = params.type === 'eip1559' ? params.maxFeePerGas : params.gasPrice;
+    const expectedPrice = params.type === 'eip1559' && extra.baseFeePerGas !== undefined
+        ? min(params.maxFeePerGas, extra.baseFeePerGas + params.maxPriorityFeePerGas)
+        : cap;
+    // `satisfies` checks the shape and keeps a literal type the draft's record accepts.
+    const details = {
+        gasLimit,
+        ...(params.type === 'eip1559'
+            ? {
+                maxFeePerGas: params.maxFeePerGas,
+                maxPriorityFeePerGas: params.maxPriorityFeePerGas,
+                ...(extra.baseFeePerGas !== undefined
+                    ? { baseFeePerGas: extra.baseFeePerGas }
+                    : {}),
+            }
+            : { gasPrice: params.gasPrice }),
+        ...(extra.l1Fee !== undefined ? { l1Fee: extra.l1Fee } : {}),
+        expected: gasLimit * expectedPrice + (extra.l1Fee ?? 0n),
+    };
+    return {
+        kind: params.type === 'eip1559' ? 'evm-1559' : 'evm-legacy',
+        speed,
+        charges: [
+            { asset: 'native', amount: gasLimit * cap, label: 'network' },
+            ...(extra.l1Fee !== undefined
+                ? [{ asset: 'native', amount: extra.l1Fee, label: 'l1-data' }]
+                : []),
+        ],
+        // The L1 data fee moves with L1 prices until inclusion, so it is only expected.
+        bound: extra.l1Fee !== undefined ? 'expected' : 'upper',
+        details,
+    };
+}
+/** The gas limit and prices a fee draft's details hold. */
+function feeOf(details) {
+    const { gasLimit, maxFeePerGas, maxPriorityFeePerGas, gasPrice } = details;
+    if (typeof gasLimit !== 'bigint')
+        throw invalid('the fee holds no EVM gas limit');
+    if (typeof maxFeePerGas === 'bigint' && typeof maxPriorityFeePerGas === 'bigint') {
+        return { gasLimit, params: { type: 'eip1559', maxFeePerGas, maxPriorityFeePerGas } };
+    }
+    if (typeof gasPrice === 'bigint')
+        return { gasLimit, params: { type: 'legacy', gasPrice } };
+    throw invalid('the fee holds no EVM gas prices');
+}
+/**
+ * Whether `next` may replace `previous` under a txpool's `percent` price bump: each price
+ * strictly higher, and at least `percent` higher (geth), so a zero tip must still rise.
+ */
+function meetsBump(previous, next, percent) {
+    const factor = BigInt(100 + percent);
+    const bumped = (before, after) => after > before && after * 100n >= before * factor;
+    if (previous.type === 'eip1559' && next.type === 'eip1559') {
+        return (bumped(previous.maxFeePerGas, next.maxFeePerGas) &&
+            bumped(previous.maxPriorityFeePerGas, next.maxPriorityFeePerGas));
+    }
+    if (previous.type === 'legacy' && next.type === 'legacy') {
+        return bumped(previous.gasPrice, next.gasPrice);
+    }
+    return false;
+}
+/** The smallest prices that meet the bump over `previous`: each strictly higher (geth). */
+function minimumBump(previous, percent) {
+    const up = (value) => {
+        const bumped = ceilDiv(value * BigInt(100 + percent), 100n);
+        return bumped > value ? bumped : value + 1n;
+    };
+    return previous.type === 'eip1559'
+        ? {
+            type: 'eip1559',
+            maxFeePerGas: up(previous.maxFeePerGas),
+            maxPriorityFeePerGas: up(previous.maxPriorityFeePerGas),
+        }
+        : { type: 'legacy', gasPrice: up(previous.gasPrice) };
+}
+//# sourceMappingURL=fees.js.map

package/dist/adapters/evm/fees.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fees.js","sourceRoot":"","sources":["../../../src/adapters/evm/fees.ts"],"names":[],"mappings":";;;AA2CA,wBAIC;AAYD,0CAyBC;AAED,kCAEC;AAGD,oCAIC;AAcD,4BAEC;AAMD,4BASC;AAOD,kDAQC;AAGD,4CAmCC;AAGD,4BAuCC;AAGD,sBAYC;AAMD,8BAkBC;AAGD,kCAYC;AAnRD;;;;GAIG;AACH,mDAAyE;AAezE;;;GAGG;AACU,QAAA,kBAAkB,GAAG,EAAE,CAAC;AACxB,QAAA,eAAe,GAAsB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;AAC/D,MAAM,WAAW,GAAuC,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;AACxF,oEAAoE;AACpE,MAAM,cAAc,GAAuC;IACzD,IAAI,EAAE,IAAI;IACV,MAAM,EAAE,IAAI;IACZ,IAAI,EAAE,IAAI;CACX,CAAC;AACF,+EAA+E;AAClE,QAAA,YAAY,GAAG,MAAO,CAAC;AACpC,uFAAuF;AACvF,MAAM,oBAAoB,GAAG,IAAI,CAAC;AAElC,MAAM,OAAO,GAAG,CAAC,CAAS,EAAE,CAAS,EAAU,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;AACnE,MAAM,GAAG,GAAG,CAAC,CAAS,EAAE,CAAS,EAAU,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC9D,MAAM,GAAG,GAAG,CAAC,CAAS,EAAE,CAAS,EAAU,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAE9D,4CAA4C;AAC5C,SAAgB,MAAM,CAAC,MAAyB;IAC9C,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACnC,MAAM,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACxE,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAW,CAAC;AAC/D,CAAC;AAED,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAC5B,IAAI,qBAAa,CAAC,sBAAsB,EAAE,uBAAuB,CAAC,CAAC;AAErE;;;;;;GAMG;AACH,SAAgB,eAAe,CAC7B,OAAsB,EACtB,KAAe,EACf,MAAc;IAEd,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC9E,IAAI,aAAa,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/D,MAAM,gBAAgB,EAAE,CAAC;IAC3B,CAAC;IACD,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACtC,MAAM,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;QACvB,IAAI,GAAG,CAAC,MAAM,GAAG,uBAAe,CAAC,MAAM,IAAI,GAAG,KAAK,SAAS;YAC1D,MAAM,gBAAgB,EAAE,CAAC;QAC3B,OAAO,GAAG,CAAC;IACb,CAAC,CAAC,CAAC;IACH,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;IACtC,OAAO;QACL,MAAM,EAAE;YACN,IAAI,EAAE,SAAS;YACf,YAAY,EAAE,EAAE,GAAG,aAAa,GAAG,GAAG;YACtC,oBAAoB,EAAE,GAAG;SAC1B;QACD,aAAa;KACd,CAAC;AACJ,CAAC;AAED,SAAgB,WAAW,CAAC,QAAgB,EAAE,KAAe;IAC3D,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;AACvF,CAAC;AAED,wEAAwE;AACxE,SAAgB,YAAY,CAAC,QAAgB;IAC3C,OAAO,QAAQ,KAAK,oBAAY;QAC9B,CAAC,CAAC,oBAAY;QACd,CAAC,CAAC,OAAO,CAAC,QAAQ,GAAG,oBAAoB,EAAE,IAAI,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,OAAO,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,IAAI,uBAAe,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;AAElF;;;;;;GAMG;AACU,QAAA,uBAAuB,GAAG,cAAkB,CAAC;AAE1D,wFAAwF;AACxF,SAAgB,QAAQ,CAAC,MAAoB;IAC3C,OAAO,MAAM,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;AAC3E,CAAC;AAED;;;GAGG;AACH,SAAgB,QAAQ,CAAC,MAAoB,EAAE,OAAe;IAC5D,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ;QAC1B,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,CAAC;IACrE,MAAM,YAAY,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACvD,OAAO;QACL,IAAI,EAAE,SAAS;QACf,YAAY;QACZ,oBAAoB,EAAE,GAAG,CAAC,MAAM,CAAC,oBAAoB,EAAE,YAAY,CAAC;KACrE,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,MAAoB,EAAE,OAAe;IACvE,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC/B,IAAI,KAAK,IAAI,OAAO;QAAE,OAAO;IAC7B,MAAM,IAAI,uBAAe,CACvB,gBAAgB,EAChB,mFAAmF,EACnF,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,YAAY,EAAE,OAAO,CAAC,QAAQ,EAAE,EAAE,EAAE,CAC9E,CAAC;AACJ,CAAC;AAED,qEAAqE;AACrE,SAAgB,gBAAgB,CAC9B,QAAqB,EACrB,KAAkB;IAElB,MAAM,OAAO,GACX,KAAK,KAAK,UAAU;QAClB,CAAC,CAAC,CAAC,cAAc,EAAE,sBAAsB,EAAE,UAAU,CAAC;QACtD,CAAC,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAC/B,MAAM,KAAK,GACT,KAAK,KAAK,UAAU;QAClB,CAAC,CAAC,mDAAmD;QACrD,CAAC,CAAC,yBAAyB,CAAC;IAChC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;QAC/C,MAAM,OAAO,CAAC,GAAG,KAAK,4BAA4B,KAAK,EAAE,CAAC,CAAC;IAC7D,CAAC;IACD,MAAM,MAAM,GAAG,CAAC,GAAW,EAAE,GAAW,EAAU,EAAE;QAClD,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,GAAG,GAAG,EAAE,CAAC;YAC7C,MAAM,OAAO,CAAC,iBAAiB,GAAG,kCAAkC,GAAG,EAAE,CAAC,CAAC;QAC7E,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IACF,MAAM,QAAQ,GACZ,QAAQ,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE,oBAAY,CAAC,CAAC;IACjF,MAAM,KAAK,GAAG,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACzD,IAAI,KAAK,KAAK,YAAY,EAAE,CAAC;QAC3B,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC,EAAE,EAAE,GAAG,KAAK,EAAE,CAAC;IACpF,CAAC;IACD,MAAM,YAAY,GAAG,MAAM,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IAChD,MAAM,oBAAoB,GAAG,MAAM,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC;IAChE,IAAI,oBAAoB,GAAG,YAAY,EAAE,CAAC;QACxC,MAAM,OAAO,CAAC,mDAAmD,CAAC,CAAC;IACrE,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,oBAAoB,EAAE,EAAE,GAAG,KAAK,EAAE,CAAC;AACvF,CAAC;AAED,iEAAiE;AACjE,SAAgB,QAAQ,CACtB,KAA0B,EAC1B,QAAgB,EAChB,MAAoB,EACpB,QAAsE,EAAE;IAExE,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;IAC9E,MAAM,aAAa,GACjB,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,aAAa,KAAK,SAAS;QAC5D,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,EAAE,KAAK,CAAC,aAAa,GAAG,MAAM,CAAC,oBAAoB,CAAC;QAC7E,CAAC,CAAC,GAAG,CAAC;IACV,oFAAoF;IACpF,MAAM,OAAO,GAAG;QACd,QAAQ;QACR,GAAG,CAAC,MAAM,CAAC,IAAI,KAAK,SAAS;YAC3B,CAAC,CAAC;gBACE,YAAY,EAAE,MAAM,CAAC,YAAY;gBACjC,oBAAoB,EAAE,MAAM,CAAC,oBAAoB;gBACjD,GAAG,CAAC,KAAK,CAAC,aAAa,KAAK,SAAS;oBACnC,CAAC,CAAC,EAAE,aAAa,EAAE,KAAK,CAAC,aAAa,EAAE;oBACxC,CAAC,CAAC,EAAE,CAAC;aACR;YACH,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC;QAClC,GAAG,CAAC,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5D,QAAQ,EAAE,QAAQ,GAAG,aAAa,GAAG,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC;KACjC,CAAC;IAC1B,OAAO;QACL,IAAI,EAAE,MAAM,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY;QAC3D,KAAK;QACL,OAAO,EAAE;YACP,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAG,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE;YAC7D,GAAG,CAAC,KAAK,CAAC,KAAK,KAAK,SAAS;gBAC3B,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,QAAiB,EAAE,MAAM,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;gBACvE,CAAC,CAAC,EAAE,CAAC;SACR;QACD,gFAAgF;QAChF,KAAK,EAAE,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO;QACvD,OAAO;KACR,CAAC;AACJ,CAAC;AAED,2DAA2D;AAC3D,SAAgB,KAAK,CAAC,OAA0C;IAI9D,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,oBAAoB,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IAC3E,IAAI,OAAO,QAAQ,KAAK,QAAQ;QAAE,MAAM,OAAO,CAAC,gCAAgC,CAAC,CAAC;IAClF,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,OAAO,oBAAoB,KAAK,QAAQ,EAAE,CAAC;QACjF,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,oBAAoB,EAAE,EAAE,CAAC;IACvF,CAAC;IACD,IAAI,OAAO,QAAQ,KAAK,QAAQ;QAC9B,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,CAAC;IAC5D,MAAM,OAAO,CAAC,iCAAiC,CAAC,CAAC;AACnD,CAAC;AAED;;;GAGG;AACH,SAAgB,SAAS,CACvB,QAAsB,EACtB,IAAkB,EAClB,OAAe;IAEf,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,GAAG,OAAO,CAAC,CAAC;IACrC,MAAM,MAAM,GAAG,CAAC,MAAc,EAAE,KAAa,EAAE,EAAE,CAC/C,KAAK,GAAG,MAAM,IAAI,KAAK,GAAG,IAAI,IAAI,MAAM,GAAG,MAAM,CAAC;IACpD,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC3D,OAAO,CACL,MAAM,CAAC,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC;YAChD,MAAM,CAAC,QAAQ,CAAC,oBAAoB,EAAE,IAAI,CAAC,oBAAoB,CAAC,CACjE,CAAC;IACJ,CAAC;IACD,IAAI,QAAQ,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACzD,OAAO,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,2FAA2F;AAC3F,SAAgB,WAAW,CAAC,QAAsB,EAAE,OAAe;IACjE,MAAM,EAAE,GAAG,CAAC,KAAa,EAAE,EAAE;QAC3B,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,GAAG,MAAM,CAAC,GAAG,GAAG,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC;QAC5D,OAAO,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;IAC9C,CAAC,CAAC;IACF,OAAO,QAAQ,CAAC,IAAI,KAAK,SAAS;QAChC,CAAC,CAAC;YACE,IAAI,EAAE,SAAS;YACf,YAAY,EAAE,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC;YACvC,oBAAoB,EAAE,EAAE,CAAC,QAAQ,CAAC,oBAAoB,CAAC;SACxD;QACH,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;AAC1D,CAAC","sourcesContent":["/**\n * The EVM fee policy: `evm-1559` or `evm-legacy` per network, an `upper`\n * bound with the `expected` cost in the details, overrides, and replacement bumps. Pure\n * functions over plain data; the driver does the I/O.\n */\nimport { ProviderError, ValidationError } from '../../core/errors/error';\nimport type { FeeEstimateDraft, FeeOverride, FeeSpeed } from '../../core/model/fee';\nimport type { EvmFeeDetails, EvmFeeHistory } from './types';\n\nexport type EvmFeeModel = 'evm-1559' | 'evm-legacy';\n\n/** The per-gas prices of one transaction. */\nexport type EvmFeeParams =\n  | {\n      readonly type: 'eip1559';\n      readonly maxFeePerGas: bigint;\n      readonly maxPriorityFeePerGas: bigint;\n    }\n  | { readonly type: 'legacy'; readonly gasPrice: bigint };\n\n/**\n * `eth_feeHistory` window and priority-fee percentiles for slow, normal and fast: the\n * method the Polygon Gas Station documents (10th, 25th and 50th over the last 15 blocks).\n */\nexport const FEE_HISTORY_BLOCKS = 15;\nexport const FEE_PERCENTILES: readonly number[] = [10, 25, 50];\nconst SPEED_INDEX: Readonly<Record<FeeSpeed, number>> = { slow: 0, normal: 1, fast: 2 };\n/** Legacy networks: `eth_gasPrice` scaled per speed, in percent. */\nconst LEGACY_PERCENT: Readonly<Record<FeeSpeed, bigint>> = {\n  slow: 100n,\n  normal: 110n,\n  fast: 125n,\n};\n/** A plain transfer to an account without code costs exactly this much gas. */\nexport const TRANSFER_GAS = 21_000n;\n/** Headroom over the node's estimate for anything but a plain transfer, in percent. */\nconst GAS_HEADROOM_PERCENT = 120n;\n\nconst ceilDiv = (a: bigint, b: bigint): bigint => (a + b - 1n) / b;\nconst max = (a: bigint, b: bigint): bigint => (a > b ? a : b);\nconst min = (a: bigint, b: bigint): bigint => (a < b ? a : b);\n\n/** The lower median; `0n` for no values. */\nexport function median(values: readonly bigint[]): bigint {\n  if (values.length === 0) return 0n;\n  const sorted = [...values].sort((a, b) => (a < b ? -1 : a > b ? 1 : 0));\n  return sorted[Math.floor((sorted.length - 1) / 2)] as bigint;\n}\n\nconst malformedHistory = () =>\n  new ProviderError('PROVIDER_UNAVAILABLE', 'malformed fee history');\n\n/**\n * EIP-1559 prices for `speed`: the tip is the median, over the window, of the speed's\n * percentile (at least `minTip`); the cap allows the next base fee to double. The history\n * must answer a request for `FEE_PERCENTILES`: one without the next base fee, without\n * reward rows, or with a reward row shorter than `FEE_PERCENTILES` is a retryable\n * `PROVIDER_UNAVAILABLE`, never a tip of `minTip`.\n */\nexport function feesFromHistory(\n  history: EvmFeeHistory,\n  speed: FeeSpeed,\n  minTip: bigint,\n): { readonly params: EvmFeeParams; readonly baseFeePerGas: bigint } {\n  const baseFeePerGas = history.baseFeePerGas[history.baseFeePerGas.length - 1];\n  if (baseFeePerGas === undefined || history.reward.length === 0) {\n    throw malformedHistory();\n  }\n  const index = SPEED_INDEX[speed];\n  const tips = history.reward.map((row) => {\n    const tip = row[index];\n    if (row.length < FEE_PERCENTILES.length || tip === undefined)\n      throw malformedHistory();\n    return tip;\n  });\n  const tip = max(median(tips), minTip);\n  return {\n    params: {\n      type: 'eip1559',\n      maxFeePerGas: 2n * baseFeePerGas + tip,\n      maxPriorityFeePerGas: tip,\n    },\n    baseFeePerGas,\n  };\n}\n\nexport function legacyPrice(gasPrice: bigint, speed: FeeSpeed): EvmFeeParams {\n  return { type: 'legacy', gasPrice: ceilDiv(gasPrice * LEGACY_PERCENT[speed], 100n) };\n}\n\n/** The node's estimate, with headroom unless it is a plain transfer. */\nexport function gasLimitFrom(estimate: bigint): bigint {\n  return estimate === TRANSFER_GAS\n    ? TRANSFER_GAS\n    : ceilDiv(estimate * GAS_HEADROOM_PERCENT, 100n);\n}\n\nconst invalid = (reason: string) => new ValidationError('INVALID_INTENT', reason);\n\n/**\n * The default `maxFeePerGas`, the highest price per gas an EVM transaction signs, 1,000\n * gwei. It bounds a plain transfer at 0.021 and a 65,000-gas token transfer at 0.065 of\n * the native coin, however an endpoint prices the fee. A network whose base fee rises\n * above the ceiling stalls its transfers as `FEE_TOO_LOW` until the fee falls or the\n * option is raised.\n */\nexport const DEFAULT_MAX_FEE_PER_GAS = 1_000_000_000_000n;\n\n/** The highest price per gas `params` may pay: the fee cap, or the legacy gas price. */\nexport function priceCap(params: EvmFeeParams): bigint {\n  return params.type === 'eip1559' ? params.maxFeePerGas : params.gasPrice;\n}\n\n/**\n * A node's suggestion within the ceiling: the fee cap or gas price at most `ceiling`,\n * and the tip at most the fee cap. No endpoint can raise what a transfer signs.\n */\nexport function capPrice(params: EvmFeeParams, ceiling: bigint): EvmFeeParams {\n  if (params.type === 'legacy')\n    return { type: 'legacy', gasPrice: min(params.gasPrice, ceiling) };\n  const maxFeePerGas = min(params.maxFeePerGas, ceiling);\n  return {\n    type: 'eip1559',\n    maxFeePerGas,\n    maxPriorityFeePerGas: min(params.maxPriorityFeePerGas, maxFeePerGas),\n  };\n}\n\n/**\n * Refuses, before anything is signed, a fee whose price per gas is above `ceiling` (the\n * handle's `maxFeePerGas`), whatever produced it: an explicit override, a stored fee, or a\n * cancel's least bump. The details carry the price and the bound as decimal strings.\n */\nexport function assertWithinCeiling(params: EvmFeeParams, ceiling: bigint): void {\n  const price = priceCap(params);\n  if (price <= ceiling) return;\n  throw new ValidationError(\n    'INVALID_INTENT',\n    'the fee is above maxFeePerGas, the EVM handle option that bounds it (wei per gas)',\n    { details: { required: price.toString(), maxFeePerGas: ceiling.toString() } },\n  );\n}\n\n/** Validates an `EvmFeeOverride` against the network's fee model. */\nexport function parseFeeOverride(\n  override: FeeOverride,\n  model: EvmFeeModel,\n): { readonly params: EvmFeeParams; readonly gasLimit?: bigint } {\n  const allowed =\n    model === 'evm-1559'\n      ? ['maxFeePerGas', 'maxPriorityFeePerGas', 'gasLimit']\n      : ['gasPrice', 'gasLimit'];\n  const shape =\n    model === 'evm-1559'\n      ? '{ maxFeePerGas, maxPriorityFeePerGas, gasLimit? }'\n      : '{ gasPrice, gasLimit? }';\n  const keys = Object.keys(override);\n  if (keys.some((key) => !allowed.includes(key))) {\n    throw invalid(`${model} fee overrides look like ${shape}`);\n  }\n  const amount = (key: string, min: bigint): bigint => {\n    const value = override[key];\n    if (typeof value !== 'bigint' || value < min) {\n      throw invalid(`fee override '${key}' must be a bigint of at least ${min}`);\n    }\n    return value;\n  };\n  const gasLimit =\n    override.gasLimit === undefined ? undefined : amount('gasLimit', TRANSFER_GAS);\n  const limit = gasLimit !== undefined ? { gasLimit } : {};\n  if (model === 'evm-legacy') {\n    return { params: { type: 'legacy', gasPrice: amount('gasPrice', 1n) }, ...limit };\n  }\n  const maxFeePerGas = amount('maxFeePerGas', 1n);\n  const maxPriorityFeePerGas = amount('maxPriorityFeePerGas', 0n);\n  if (maxPriorityFeePerGas > maxFeePerGas) {\n    throw invalid('maxPriorityFeePerGas must not exceed maxFeePerGas');\n  }\n  return { params: { type: 'eip1559', maxFeePerGas, maxPriorityFeePerGas }, ...limit };\n}\n\n/** The fee draft for a transaction of `gasLimit` at `params`. */\nexport function feeDraft(\n  speed: FeeSpeed | 'custom',\n  gasLimit: bigint,\n  params: EvmFeeParams,\n  extra: { readonly baseFeePerGas?: bigint; readonly l1Fee?: bigint } = {},\n): FeeEstimateDraft {\n  const cap = params.type === 'eip1559' ? params.maxFeePerGas : params.gasPrice;\n  const expectedPrice =\n    params.type === 'eip1559' && extra.baseFeePerGas !== undefined\n      ? min(params.maxFeePerGas, extra.baseFeePerGas + params.maxPriorityFeePerGas)\n      : cap;\n  // `satisfies` checks the shape and keeps a literal type the draft's record accepts.\n  const details = {\n    gasLimit,\n    ...(params.type === 'eip1559'\n      ? {\n          maxFeePerGas: params.maxFeePerGas,\n          maxPriorityFeePerGas: params.maxPriorityFeePerGas,\n          ...(extra.baseFeePerGas !== undefined\n            ? { baseFeePerGas: extra.baseFeePerGas }\n            : {}),\n        }\n      : { gasPrice: params.gasPrice }),\n    ...(extra.l1Fee !== undefined ? { l1Fee: extra.l1Fee } : {}),\n    expected: gasLimit * expectedPrice + (extra.l1Fee ?? 0n),\n  } satisfies EvmFeeDetails;\n  return {\n    kind: params.type === 'eip1559' ? 'evm-1559' : 'evm-legacy',\n    speed,\n    charges: [\n      { asset: 'native', amount: gasLimit * cap, label: 'network' },\n      ...(extra.l1Fee !== undefined\n        ? [{ asset: 'native' as const, amount: extra.l1Fee, label: 'l1-data' }]\n        : []),\n    ],\n    // The L1 data fee moves with L1 prices until inclusion, so it is only expected.\n    bound: extra.l1Fee !== undefined ? 'expected' : 'upper',\n    details,\n  };\n}\n\n/** The gas limit and prices a fee draft's details hold. */\nexport function feeOf(details: Readonly<Record<string, unknown>>): {\n  readonly gasLimit: bigint;\n  readonly params: EvmFeeParams;\n} {\n  const { gasLimit, maxFeePerGas, maxPriorityFeePerGas, gasPrice } = details;\n  if (typeof gasLimit !== 'bigint') throw invalid('the fee holds no EVM gas limit');\n  if (typeof maxFeePerGas === 'bigint' && typeof maxPriorityFeePerGas === 'bigint') {\n    return { gasLimit, params: { type: 'eip1559', maxFeePerGas, maxPriorityFeePerGas } };\n  }\n  if (typeof gasPrice === 'bigint')\n    return { gasLimit, params: { type: 'legacy', gasPrice } };\n  throw invalid('the fee holds no EVM gas prices');\n}\n\n/**\n * Whether `next` may replace `previous` under a txpool's `percent` price bump: each price\n * strictly higher, and at least `percent` higher (geth), so a zero tip must still rise.\n */\nexport function meetsBump(\n  previous: EvmFeeParams,\n  next: EvmFeeParams,\n  percent: number,\n): boolean {\n  const factor = BigInt(100 + percent);\n  const bumped = (before: bigint, after: bigint) =>\n    after > before && after * 100n >= before * factor;\n  if (previous.type === 'eip1559' && next.type === 'eip1559') {\n    return (\n      bumped(previous.maxFeePerGas, next.maxFeePerGas) &&\n      bumped(previous.maxPriorityFeePerGas, next.maxPriorityFeePerGas)\n    );\n  }\n  if (previous.type === 'legacy' && next.type === 'legacy') {\n    return bumped(previous.gasPrice, next.gasPrice);\n  }\n  return false;\n}\n\n/** The smallest prices that meet the bump over `previous`: each strictly higher (geth). */\nexport function minimumBump(previous: EvmFeeParams, percent: number): EvmFeeParams {\n  const up = (value: bigint) => {\n    const bumped = ceilDiv(value * BigInt(100 + percent), 100n);\n    return bumped > value ? bumped : value + 1n;\n  };\n  return previous.type === 'eip1559'\n    ? {\n        type: 'eip1559',\n        maxFeePerGas: up(previous.maxFeePerGas),\n        maxPriorityFeePerGas: up(previous.maxPriorityFeePerGas),\n      }\n    : { type: 'legacy', gasPrice: up(previous.gasPrice) };\n}\n"]}

package/dist/adapters/evm/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * `crypto-aio/evm`: EVM chains of your own (`evmChainPlugin`), the SDK-free EVM types, and
+ * the `crypto-aio/native` client types: importing this entry types `native(bc, 'ethers')`
+ * as an ethers `JsonRpcApiProvider` and `native(bc, 'web3')` as a `Web3` instance.
+ *
+ * @module crypto-aio/evm
+ */
+import type { JsonRpcApiProvider } from 'ethers';
+import type { Web3 } from 'web3';
+declare module '../../index' {
+    interface NativeClientMap {
+        ethers: JsonRpcApiProvider;
+        web3: Web3;
+    }
+}
+export { EVM_PEER_DEPENDENCIES, evmChainPlugin } from './plugin';
+export type { EvmChainPluginOptions } from './plugin';
+export { DEFAULT_MAX_FEE_PER_GAS } from './fees';
+export { EVM_CAPABILITIES } from './network';
+export type { EvmExt, EvmFeeDetails, EvmFeeOverride } from './types';

package/dist/adapters/evm/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EVM_CAPABILITIES = exports.DEFAULT_MAX_FEE_PER_GAS = exports.evmChainPlugin = exports.EVM_PEER_DEPENDENCIES = void 0;
+var plugin_1 = require("./plugin");
+Object.defineProperty(exports, "EVM_PEER_DEPENDENCIES", { enumerable: true, get: function () { return plugin_1.EVM_PEER_DEPENDENCIES; } });
+Object.defineProperty(exports, "evmChainPlugin", { enumerable: true, get: function () { return plugin_1.evmChainPlugin; } });
+var fees_1 = require("./fees");
+Object.defineProperty(exports, "DEFAULT_MAX_FEE_PER_GAS", { enumerable: true, get: function () { return fees_1.DEFAULT_MAX_FEE_PER_GAS; } });
+var network_1 = require("./network");
+Object.defineProperty(exports, "EVM_CAPABILITIES", { enumerable: true, get: function () { return network_1.EVM_CAPABILITIES; } });
+//# sourceMappingURL=index.js.map

package/dist/adapters/evm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/adapters/evm/index.ts"],"names":[],"mappings":";;;AAmBA,mCAAiE;AAAxD,+GAAA,qBAAqB,OAAA;AAAE,wGAAA,cAAc,OAAA;AAE9C,+BAAiD;AAAxC,+GAAA,uBAAuB,OAAA;AAChC,qCAA6C;AAApC,2GAAA,gBAAgB,OAAA","sourcesContent":["/**\n * `crypto-aio/evm`: EVM chains of your own (`evmChainPlugin`), the SDK-free EVM types, and\n * the `crypto-aio/native` client types: importing this entry types `native(bc, 'ethers')`\n * as an ethers `JsonRpcApiProvider` and `native(bc, 'web3')` as a `Web3` instance.\n *\n * @module crypto-aio/evm\n */\nimport type { JsonRpcApiProvider } from 'ethers';\nimport type { Web3 } from 'web3';\n\n// Through the package entry, never a core module. SDK types appear only here, in the\n// adapter's entry, so the main entry's typings name no SDK.\ndeclare module '../../index' {\n  interface NativeClientMap {\n    ethers: JsonRpcApiProvider;\n    web3: Web3;\n  }\n}\n\nexport { EVM_PEER_DEPENDENCIES, evmChainPlugin } from './plugin';\nexport type { EvmChainPluginOptions } from './plugin';\nexport { DEFAULT_MAX_FEE_PER_GAS } from './fees';\nexport { EVM_CAPABILITIES } from './network';\nexport type { EvmExt, EvmFeeDetails, EvmFeeOverride } from './types';\n"]}

package/dist/adapters/evm/network.d.ts

@@ -0,0 +1,60 @@
+/**
+ * What the EVM driver needs from a network's registry entry (each network keeps its own
+ * registry identity, its decimal chain id), validated once when a driver is created, so a
+ * custom EVM chain with inconsistent data fails with `CONFIG_INVALID` instead of
+ * misbehaving.
+ */
+import type { Capability } from '../../core/model/capability';
+import type { ChainInfo, NetworkInfo } from '../../core/model/chain';
+import { type EvmFeeModel } from './fees';
+/** Every capability an EVM network can have; a network removes what it lacks. */
+export declare const EVM_CAPABILITIES: readonly Capability[];
+export type EvmFinality = {
+    readonly kind: 'tag';
+} | {
+    readonly kind: 'confirmations';
+    readonly confirmations: number;
+};
+export interface EvmNetworkConfig {
+    readonly chainId: bigint;
+    readonly feeModel: EvmFeeModel;
+    readonly finality: EvmFinality;
+    /** The txpool's price bump; `undefined` when the network has no replace or cancel. */
+    readonly minBumpPercent?: number;
+    readonly minPriorityFeePerGas: bigint;
+    /** OP Stack: transactions also pay an L1 data fee (`GasPriceOracle.getL1Fee`). */
+    readonly l1DataFee: boolean;
+    /**
+     * bor-based networks (`params.systemLogs: 'bor'`, as on Polygon PoS): receipts carry bor's
+     * `POLYGON_FEE_LOG` and `POLYGON_TRANSFER_LOG`.
+     */
+    readonly polygonSystemLogs: boolean;
+    readonly capabilities: ReadonlySet<Capability>;
+    /**
+     * The highest price per gas (wei) a transaction signs: the handle's
+     * `maxFeePerGas` option, else the network's `params.maxFeePerGas`, else
+     * `DEFAULT_MAX_FEE_PER_GAS`.
+     */
+    readonly maxFeePerGas: bigint;
+}
+/** The OP Stack `GasPriceOracle` predeploy. */
+export declare const GAS_PRICE_ORACLE = "0x420000000000000000000000000000000000000F";
+/**
+ * The `LogFeeTransfer(address,address,address,uint256,uint256,uint256,uint256,uint256)`
+ * system log that Polygon PoS's client (bor, `core/bor_fee_log.go`) adds to every
+ * fee-paying transaction, emitted from the MRC20 predeploy. It says nothing about code.
+ */
+export declare const POLYGON_FEE_LOG: {
+    readonly address: "0x0000000000000000000000000000000000001010";
+    readonly topic: "0x4dfe1bbbcf077ddc3e01291eea2d5c70c2b422b415d95645b9adcfd678cb1d63";
+};
+/**
+ * bor's `LogTransfer(address,address,address,uint256,uint256,uint256,uint256,uint256)`
+ * system log for a native POL value transfer (`core/evm.go` `Transfer`), from the same
+ * predeploy. Its topic is not ERC-20 `Transfer`'s, so it never decodes as a token movement.
+ */
+export declare const POLYGON_TRANSFER_LOG: {
+    readonly address: "0x0000000000000000000000000000000000001010";
+    readonly topic: "0xe6497e3ee548a3372136af2fcb0696db31fc6cf20260707645068bd3fe97f3c4";
+};
+export declare function evmNetworkConfig(chain: ChainInfo, network: NetworkInfo, options?: Readonly<Record<string, unknown>>): EvmNetworkConfig;

package/dist/adapters/evm/network.js

@@ -0,0 +1,131 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.POLYGON_TRANSFER_LOG = exports.POLYGON_FEE_LOG = exports.GAS_PRICE_ORACLE = exports.EVM_CAPABILITIES = void 0;
+exports.evmNetworkConfig = evmNetworkConfig;
+const error_1 = require("../../core/errors/error");
+const names_1 = require("../../core/util/names");
+const fees_1 = require("./fees");
+/** Every capability an EVM network can have; a network removes what it lacks. */
+exports.EVM_CAPABILITIES = [
+    'tokens',
+    'block-scan',
+    'hd-public-derivation',
+    'fee-market-1559',
+    'finality-tag',
+    'replace-fee',
+    'cancel',
+];
+/**
+ * The only driver option (`HandleOptions.options`) the EVM driver reads. Any other key is
+ * refused, so a typo, or another family's option such as Tron's `maxFeeLimit`, fails loudly
+ * instead of leaving the default in place.
+ */
+const OPTION_KEYS = Object.freeze(['maxFeePerGas']);
+const MAX_UINT256 = 2n ** 256n - 1n;
+/** A price ceiling: a bigint of wei per gas that an EVM transaction can carry. */
+function priceCeiling(value, name, fail) {
+    if (typeof value !== 'bigint' || value < 1n || value > MAX_UINT256) {
+        fail(`${name} must be a bigint of wei per gas from 1 to 2^256 − 1`);
+    }
+    return value;
+}
+/** The OP Stack `GasPriceOracle` predeploy. */
+exports.GAS_PRICE_ORACLE = '0x420000000000000000000000000000000000000F';
+/**
+ * The `LogFeeTransfer(address,address,address,uint256,uint256,uint256,uint256,uint256)`
+ * system log that Polygon PoS's client (bor, `core/bor_fee_log.go`) adds to every
+ * fee-paying transaction, emitted from the MRC20 predeploy. It says nothing about code.
+ */
+exports.POLYGON_FEE_LOG = {
+    address: '0x0000000000000000000000000000000000001010',
+    topic: '0x4dfe1bbbcf077ddc3e01291eea2d5c70c2b422b415d95645b9adcfd678cb1d63',
+};
+/**
+ * bor's `LogTransfer(address,address,address,uint256,uint256,uint256,uint256,uint256)`
+ * system log for a native POL value transfer (`core/evm.go` `Transfer`), from the same
+ * predeploy. Its topic is not ERC-20 `Transfer`'s, so it never decodes as a token movement.
+ */
+exports.POLYGON_TRANSFER_LOG = {
+    address: exports.POLYGON_FEE_LOG.address,
+    topic: '0xe6497e3ee548a3372136af2fcb0696db31fc6cf20260707645068bd3fe97f3c4',
+};
+function finalityOf(policy, fail) {
+    if (policy.kind === 'tag')
+        return { kind: 'tag' };
+    if (policy.kind === 'confirmations') {
+        // The final height is `head - confirmations + 1`, so fewer than one is the future.
+        const confirmations = policy.confirmations;
+        if (!Number.isSafeInteger(confirmations) || confirmations < 1) {
+            return fail('finality confirmations must be an integer of at least 1');
+        }
+        return { kind: 'confirmations', confirmations: confirmations };
+    }
+    return fail(`finality '${policy.kind}' is not an EVM policy (use 'tag' or 'confirmations')`);
+}
+function evmNetworkConfig(chain, network, options = {}) {
+    const fail = (reason) => {
+        throw new error_1.ConfigError('CONFIG_INVALID', `EVM network ${chain.id}:${network.id}: ${reason}`);
+    };
+    if (network.identity === undefined || !/^[1-9][0-9]*$/.test(network.identity)) {
+        fail('its identity must be the decimal chain id');
+    }
+    const feeModel = network.feeModel;
+    if (feeModel !== 'evm-1559' && feeModel !== 'evm-legacy') {
+        fail(`fee model '${feeModel}' is not 'evm-1559' or 'evm-legacy'`);
+    }
+    const finality = finalityOf(network.finality, fail);
+    const capabilities = new Set(exports.EVM_CAPABILITIES);
+    for (const c of network.capabilities?.add ?? [])
+        capabilities.add(c);
+    for (const c of network.capabilities?.remove ?? [])
+        capabilities.delete(c);
+    if (capabilities.has('fee-market-1559') !== (feeModel === 'evm-1559')) {
+        fail(`'fee-market-1559' must be present exactly on 'evm-1559' networks`);
+    }
+    if (capabilities.has('finality-tag') !== (finality.kind === 'tag')) {
+        fail(`'finality-tag' must be present exactly on 'tag' finality networks`);
+    }
+    // The fee policy computes `BigInt(100 + percent)`, which throws on a fraction.
+    const bump = network.replacement?.minBumpPercent;
+    if (bump !== undefined && !(Number.isSafeInteger(bump) && bump >= 0)) {
+        fail('replacement.minBumpPercent must be a non-negative integer');
+    }
+    const params = network.params ?? {};
+    const minTip = params.minPriorityFeePerGas;
+    if (minTip !== undefined && typeof minTip !== 'bigint') {
+        fail('params.minPriorityFeePerGas must be a bigint');
+    }
+    if (params.l1DataFee !== undefined && params.l1DataFee !== 'op-stack') {
+        fail(`params.l1DataFee must be 'op-stack'`);
+    }
+    // Data, not the chain id, so a bor chain served through evmChainPlugin can opt in.
+    if (params.systemLogs !== undefined && params.systemLogs !== 'bor') {
+        fail(`params.systemLogs must be 'bor'`);
+    }
+    // The refusal lists the accepted name, never the caller's key or its value: either may
+    // be a secret typed in the wrong place.
+    for (const key of Object.keys(options)) {
+        if (!OPTION_KEYS.includes(key))
+            fail((0, names_1.unknownName)('option', OPTION_KEYS));
+    }
+    // The handle's option, else the network entry's own, else the
+    // default. A network value is checked even where an option overrides it.
+    const own = params.maxFeePerGas;
+    const networkCeiling = own === undefined ? undefined : priceCeiling(own, 'params.maxFeePerGas', fail);
+    const maxFeePerGas = options.maxFeePerGas !== undefined
+        ? priceCeiling(options.maxFeePerGas, 'maxFeePerGas', fail)
+        : (networkCeiling ?? fees_1.DEFAULT_MAX_FEE_PER_GAS);
+    const replaces = capabilities.has('replace-fee') || capabilities.has('cancel');
+    return {
+        chainId: BigInt(network.identity),
+        feeModel: feeModel,
+        finality,
+        ...(replaces ? { minBumpPercent: network.replacement?.minBumpPercent ?? 10 } : {}),
+        minPriorityFeePerGas: minTip ?? 0n,
+        l1DataFee: params.l1DataFee === 'op-stack',
+        polygonSystemLogs: params.systemLogs === 'bor',
+        capabilities,
+        maxFeePerGas,
+    };
+}
+//# sourceMappingURL=network.js.map

package/dist/adapters/evm/network.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"network.js","sourceRoot":"","sources":["../../../src/adapters/evm/network.ts"],"names":[],"mappings":";;;AAgHA,4CAuEC;AA/KD,mDAAsD;AACtD,iDAAoD;AACpD,iCAAmE;AAEnE,iFAAiF;AACpE,QAAA,gBAAgB,GAA0B;IACrD,QAAQ;IACR,YAAY;IACZ,sBAAsB;IACtB,iBAAiB;IACjB,cAAc;IACd,aAAa;IACb,QAAQ;CACT,CAAC;AA6BF;;;;GAIG;AACH,MAAM,WAAW,GAAsB,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC;AAEvE,MAAM,WAAW,GAAG,EAAE,IAAI,IAAI,GAAG,EAAE,CAAC;AAEpC,kFAAkF;AAClF,SAAS,YAAY,CACnB,KAAc,EACd,IAAY,EACZ,IAA+B;IAE/B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,GAAG,EAAE,IAAI,KAAK,GAAG,WAAW,EAAE,CAAC;QACnE,IAAI,CAAC,GAAG,IAAI,sDAAsD,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,KAAe,CAAC;AACzB,CAAC;AAED,+CAA+C;AAClC,QAAA,gBAAgB,GAAG,4CAA4C,CAAC;AAE7E;;;;GAIG;AACU,QAAA,eAAe,GAAG;IAC7B,OAAO,EAAE,4CAA4C;IACrD,KAAK,EAAE,oEAAoE;CACnE,CAAC;AAEX;;;;GAIG;AACU,QAAA,oBAAoB,GAAG;IAClC,OAAO,EAAE,uBAAe,CAAC,OAAO;IAChC,KAAK,EAAE,oEAAoE;CACnE,CAAC;AAEX,SAAS,UAAU,CACjB,MAAsB,EACtB,IAA+B;IAE/B,IAAI,MAAM,CAAC,IAAI,KAAK,KAAK;QAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IAClD,IAAI,MAAM,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;QACpC,mFAAmF;QACnF,MAAM,aAAa,GAAY,MAAM,CAAC,aAAa,CAAC;QACpD,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,IAAK,aAAwB,GAAG,CAAC,EAAE,CAAC;YAC1E,OAAO,IAAI,CAAC,yDAAyD,CAAC,CAAC;QACzE,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,eAAe,EAAE,aAAa,EAAE,aAAuB,EAAE,CAAC;IAC3E,CAAC;IACD,OAAO,IAAI,CACT,aAAa,MAAM,CAAC,IAAI,uDAAuD,CAChF,CAAC;AACJ,CAAC;AAED,SAAgB,gBAAgB,CAC9B,KAAgB,EAChB,OAAoB,EACpB,UAA6C,EAAE;IAE/C,MAAM,IAAI,GAAG,CAAC,MAAc,EAAS,EAAE;QACrC,MAAM,IAAI,mBAAW,CACnB,gBAAgB,EAChB,eAAe,KAAK,CAAC,EAAE,IAAI,OAAO,CAAC,EAAE,KAAK,MAAM,EAAE,CACnD,CAAC;IACJ,CAAC,CAAC;IACF,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9E,IAAI,CAAC,2CAA2C,CAAC,CAAC;IACpD,CAAC;IACD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAClC,IAAI,QAAQ,KAAK,UAAU,IAAI,QAAQ,KAAK,YAAY,EAAE,CAAC;QACzD,IAAI,CAAC,cAAc,QAAQ,qCAAqC,CAAC,CAAC;IACpE,CAAC;IACD,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACpD,MAAM,YAAY,GAAG,IAAI,GAAG,CAAa,wBAAgB,CAAC,CAAC;IAC3D,KAAK,MAAM,CAAC,IAAI,OAAO,CAAC,YAAY,EAAE,GAAG,IAAI,EAAE;QAAE,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACrE,KAAK,MAAM,CAAC,IAAI,OAAO,CAAC,YAAY,EAAE,MAAM,IAAI,EAAE;QAAE,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3E,IAAI,YAAY,CAAC,GAAG,CAAC,iBAAiB,CAAC,KAAK,CAAC,QAAQ,KAAK,UAAU,CAAC,EAAE,CAAC;QACtE,IAAI,CAAC,kEAAkE,CAAC,CAAC;IAC3E,CAAC;IACD,IAAI,YAAY,CAAC,GAAG,CAAC,cAAc,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QACnE,IAAI,CAAC,mEAAmE,CAAC,CAAC;IAC5E,CAAC;IACD,+EAA+E;IAC/E,MAAM,IAAI,GAAY,OAAO,CAAC,WAAW,EAAE,cAAc,CAAC;IAC1D,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAK,IAAe,IAAI,CAAC,CAAC,EAAE,CAAC;QACjF,IAAI,CAAC,2DAA2D,CAAC,CAAC;IACpE,CAAC;IACD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC;IACpC,MAAM,MAAM,GAAG,MAAM,CAAC,oBAAoB,CAAC;IAC3C,IAAI,MAAM,KAAK,SAAS,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QACvD,IAAI,CAAC,8CAA8C,CAAC,CAAC;IACvD,CAAC;IACD,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS,IAAI,MAAM,CAAC,SAAS,KAAK,UAAU,EAAE,CAAC;QACtE,IAAI,CAAC,qCAAqC,CAAC,CAAC;IAC9C,CAAC;IACD,mFAAmF;IACnF,IAAI,MAAM,CAAC,UAAU,KAAK,SAAS,IAAI,MAAM,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;QACnE,IAAI,CAAC,iCAAiC,CAAC,CAAC;IAC1C,CAAC;IACD,uFAAuF;IACvF,wCAAwC;IACxC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACvC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,IAAI,CAAC,IAAA,mBAAW,EAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC;IAC3E,CAAC;IACD,8DAA8D;IAC9D,yEAAyE;IACzE,MAAM,GAAG,GAAG,MAAM,CAAC,YAAY,CAAC;IAChC,MAAM,cAAc,GAClB,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,EAAE,qBAAqB,EAAE,IAAI,CAAC,CAAC;IACjF,MAAM,YAAY,GAChB,OAAO,CAAC,YAAY,KAAK,SAAS;QAChC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,YAAY,EAAE,cAAc,EAAE,IAAI,CAAC;QAC1D,CAAC,CAAC,CAAC,cAAc,IAAI,8BAAuB,CAAC,CAAC;IAClD,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC/E,OAAO;QACL,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,QAAkB,CAAC;QAC3C,QAAQ,EAAE,QAAuB;QACjC,QAAQ;QACR,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,WAAW,EAAE,cAAc,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAClF,oBAAoB,EAAG,MAA6B,IAAI,EAAE;QAC1D,SAAS,EAAE,MAAM,CAAC,SAAS,KAAK,UAAU;QAC1C,iBAAiB,EAAE,MAAM,CAAC,UAAU,KAAK,KAAK;QAC9C,YAAY;QACZ,YAAY;KACb,CAAC;AACJ,CAAC","sourcesContent":["/**\n * What the EVM driver needs from a network's registry entry (each network keeps its own\n * registry identity, its decimal chain id), validated once when a driver is created, so a\n * custom EVM chain with inconsistent data fails with `CONFIG_INVALID` instead of\n * misbehaving.\n */\nimport type { Capability } from '../../core/model/capability';\nimport type { ChainInfo, FinalityPolicy, NetworkInfo } from '../../core/model/chain';\nimport { ConfigError } from '../../core/errors/error';\nimport { unknownName } from '../../core/util/names';\nimport { DEFAULT_MAX_FEE_PER_GAS, type EvmFeeModel } from './fees';\n\n/** Every capability an EVM network can have; a network removes what it lacks. */\nexport const EVM_CAPABILITIES: readonly Capability[] = [\n  'tokens',\n  'block-scan',\n  'hd-public-derivation',\n  'fee-market-1559',\n  'finality-tag',\n  'replace-fee',\n  'cancel',\n];\n\nexport type EvmFinality =\n  | { readonly kind: 'tag' }\n  | { readonly kind: 'confirmations'; readonly confirmations: number };\n\nexport interface EvmNetworkConfig {\n  readonly chainId: bigint;\n  readonly feeModel: EvmFeeModel;\n  readonly finality: EvmFinality;\n  /** The txpool's price bump; `undefined` when the network has no replace or cancel. */\n  readonly minBumpPercent?: number;\n  readonly minPriorityFeePerGas: bigint;\n  /** OP Stack: transactions also pay an L1 data fee (`GasPriceOracle.getL1Fee`). */\n  readonly l1DataFee: boolean;\n  /**\n   * bor-based networks (`params.systemLogs: 'bor'`, as on Polygon PoS): receipts carry bor's\n   * `POLYGON_FEE_LOG` and `POLYGON_TRANSFER_LOG`.\n   */\n  readonly polygonSystemLogs: boolean;\n  readonly capabilities: ReadonlySet<Capability>;\n  /**\n   * The highest price per gas (wei) a transaction signs: the handle's\n   * `maxFeePerGas` option, else the network's `params.maxFeePerGas`, else\n   * `DEFAULT_MAX_FEE_PER_GAS`.\n   */\n  readonly maxFeePerGas: bigint;\n}\n\n/**\n * The only driver option (`HandleOptions.options`) the EVM driver reads. Any other key is\n * refused, so a typo, or another family's option such as Tron's `maxFeeLimit`, fails loudly\n * instead of leaving the default in place.\n */\nconst OPTION_KEYS: readonly string[] = Object.freeze(['maxFeePerGas']);\n\nconst MAX_UINT256 = 2n ** 256n - 1n;\n\n/** A price ceiling: a bigint of wei per gas that an EVM transaction can carry. */\nfunction priceCeiling(\n  value: unknown,\n  name: string,\n  fail: (reason: string) => never,\n): bigint {\n  if (typeof value !== 'bigint' || value < 1n || value > MAX_UINT256) {\n    fail(`${name} must be a bigint of wei per gas from 1 to 2^256 − 1`);\n  }\n  return value as bigint;\n}\n\n/** The OP Stack `GasPriceOracle` predeploy. */\nexport const GAS_PRICE_ORACLE = '0x420000000000000000000000000000000000000F';\n\n/**\n * The `LogFeeTransfer(address,address,address,uint256,uint256,uint256,uint256,uint256)`\n * system log that Polygon PoS's client (bor, `core/bor_fee_log.go`) adds to every\n * fee-paying transaction, emitted from the MRC20 predeploy. It says nothing about code.\n */\nexport const POLYGON_FEE_LOG = {\n  address: '0x0000000000000000000000000000000000001010',\n  topic: '0x4dfe1bbbcf077ddc3e01291eea2d5c70c2b422b415d95645b9adcfd678cb1d63',\n} as const;\n\n/**\n * bor's `LogTransfer(address,address,address,uint256,uint256,uint256,uint256,uint256)`\n * system log for a native POL value transfer (`core/evm.go` `Transfer`), from the same\n * predeploy. Its topic is not ERC-20 `Transfer`'s, so it never decodes as a token movement.\n */\nexport const POLYGON_TRANSFER_LOG = {\n  address: POLYGON_FEE_LOG.address,\n  topic: '0xe6497e3ee548a3372136af2fcb0696db31fc6cf20260707645068bd3fe97f3c4',\n} as const;\n\nfunction finalityOf(\n  policy: FinalityPolicy,\n  fail: (reason: string) => never,\n): EvmFinality {\n  if (policy.kind === 'tag') return { kind: 'tag' };\n  if (policy.kind === 'confirmations') {\n    // The final height is `head - confirmations + 1`, so fewer than one is the future.\n    const confirmations: unknown = policy.confirmations;\n    if (!Number.isSafeInteger(confirmations) || (confirmations as number) < 1) {\n      return fail('finality confirmations must be an integer of at least 1');\n    }\n    return { kind: 'confirmations', confirmations: confirmations as number };\n  }\n  return fail(\n    `finality '${policy.kind}' is not an EVM policy (use 'tag' or 'confirmations')`,\n  );\n}\n\nexport function evmNetworkConfig(\n  chain: ChainInfo,\n  network: NetworkInfo,\n  options: Readonly<Record<string, unknown>> = {},\n): EvmNetworkConfig {\n  const fail = (reason: string): never => {\n    throw new ConfigError(\n      'CONFIG_INVALID',\n      `EVM network ${chain.id}:${network.id}: ${reason}`,\n    );\n  };\n  if (network.identity === undefined || !/^[1-9][0-9]*$/.test(network.identity)) {\n    fail('its identity must be the decimal chain id');\n  }\n  const feeModel = network.feeModel;\n  if (feeModel !== 'evm-1559' && feeModel !== 'evm-legacy') {\n    fail(`fee model '${feeModel}' is not 'evm-1559' or 'evm-legacy'`);\n  }\n  const finality = finalityOf(network.finality, fail);\n  const capabilities = new Set<Capability>(EVM_CAPABILITIES);\n  for (const c of network.capabilities?.add ?? []) capabilities.add(c);\n  for (const c of network.capabilities?.remove ?? []) capabilities.delete(c);\n  if (capabilities.has('fee-market-1559') !== (feeModel === 'evm-1559')) {\n    fail(`'fee-market-1559' must be present exactly on 'evm-1559' networks`);\n  }\n  if (capabilities.has('finality-tag') !== (finality.kind === 'tag')) {\n    fail(`'finality-tag' must be present exactly on 'tag' finality networks`);\n  }\n  // The fee policy computes `BigInt(100 + percent)`, which throws on a fraction.\n  const bump: unknown = network.replacement?.minBumpPercent;\n  if (bump !== undefined && !(Number.isSafeInteger(bump) && (bump as number) >= 0)) {\n    fail('replacement.minBumpPercent must be a non-negative integer');\n  }\n  const params = network.params ?? {};\n  const minTip = params.minPriorityFeePerGas;\n  if (minTip !== undefined && typeof minTip !== 'bigint') {\n    fail('params.minPriorityFeePerGas must be a bigint');\n  }\n  if (params.l1DataFee !== undefined && params.l1DataFee !== 'op-stack') {\n    fail(`params.l1DataFee must be 'op-stack'`);\n  }\n  // Data, not the chain id, so a bor chain served through evmChainPlugin can opt in.\n  if (params.systemLogs !== undefined && params.systemLogs !== 'bor') {\n    fail(`params.systemLogs must be 'bor'`);\n  }\n  // The refusal lists the accepted name, never the caller's key or its value: either may\n  // be a secret typed in the wrong place.\n  for (const key of Object.keys(options)) {\n    if (!OPTION_KEYS.includes(key)) fail(unknownName('option', OPTION_KEYS));\n  }\n  // The handle's option, else the network entry's own, else the\n  // default. A network value is checked even where an option overrides it.\n  const own = params.maxFeePerGas;\n  const networkCeiling =\n    own === undefined ? undefined : priceCeiling(own, 'params.maxFeePerGas', fail);\n  const maxFeePerGas =\n    options.maxFeePerGas !== undefined\n      ? priceCeiling(options.maxFeePerGas, 'maxFeePerGas', fail)\n      : (networkCeiling ?? DEFAULT_MAX_FEE_PER_GAS);\n  const replaces = capabilities.has('replace-fee') || capabilities.has('cancel');\n  return {\n    chainId: BigInt(network.identity as string),\n    feeModel: feeModel as EvmFeeModel,\n    finality,\n    ...(replaces ? { minBumpPercent: network.replacement?.minBumpPercent ?? 10 } : {}),\n    minPriorityFeePerGas: (minTip as bigint | undefined) ?? 0n,\n    l1DataFee: params.l1DataFee === 'op-stack',\n    polygonSystemLogs: params.systemLogs === 'bor',\n    capabilities,\n    maxFeePerGas,\n  };\n}\n"]}

package/dist/adapters/evm/plugin.d.ts

@@ -0,0 +1,36 @@
+/**
+ * The EVM family plugin: chains, tokens and provider presets as data, plus one
+ * adapter manifest per library. SDK-free: only a manifest's `load()` requires a client
+ * module, and with it the SDK. `ethers` is registered first, so it is the family default.
+ */
+import type { AdapterManifest, PeerDependency } from '../../core/driver/types';
+import type { ChainInfo } from '../../core/model/chain';
+import type { AssetRegistration } from '../../core/registry/assets';
+import type { Plugin } from '../../core/registry/plugin';
+import type { ProviderPreset } from '../../core/registry/providers';
+/** The SDK versions this adapter is validated against. */
+export declare const EVM_PEER_DEPENDENCIES: Readonly<Record<'ethers' | 'web3', PeerDependency>>;
+/** The `ethers` and `web3` manifests for `chains`, keyed `<family>/<library>`. */
+export declare function evmManifests(family: string, chains: readonly string[]): AdapterManifest[];
+/**
+ * The built-in EVM family: Ethereum, BNB Smart Chain, Polygon PoS, Avalanche C-Chain,
+ * Arbitrum One, OP Mainnet and Base, with their testnets.
+ */
+export declare function evmPlugin(): Plugin;
+export interface EvmChainPluginOptions {
+    /**
+     * A unique name matching `/^[a-z][a-z0-9-]*$/`. The plugin registers as `evm:<name>`, so
+     * it never collides with a family plugin, and its manifests as `evm:<name>/ethers` and
+     * `evm:<name>/web3`.
+     */
+    readonly name: string;
+    /** Chains with `family: 'evm'`, nonce ordering and the `secp256k1-ecdsa` scheme. */
+    readonly chains: readonly ChainInfo[];
+    readonly presets?: readonly ProviderPreset[];
+    readonly assets?: readonly AssetRegistration[];
+}
+/**
+ * A plugin for EVM chains of your own, served by the built-in EVM driver with either
+ * library. Every network is validated here, so bad data fails at registration.
+ */
+export declare function evmChainPlugin(options: EvmChainPluginOptions): Plugin;