crypto-aio 0.0.3 → 0.2.0

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

@@ -0,0 +1,65 @@
+/**
+ * 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 highest gas limit a transaction signs: the handle's `maxGasLimit` option, else the
+     * network's `params.maxGasLimit`, else `DEFAULT_MAX_GAS_LIMIT`.
+     */
+    readonly maxGasLimit: 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,150 @@
+"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 options (`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', 'maxGasLimit']);
+const MAX_UINT256 = 2n ** 256n - 1n;
+/** The largest gas limit a transaction carries: clients read it as a `uint64`. */
+const MAX_UINT64 = 2n ** 64n - 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;
+}
+/**
+ * A gas-limit bound: a bigint of gas a transaction can carry, and at least a plain
+ * transfer's 21,000, below which nothing could be signed.
+ */
+function gasBound(value, name, fail) {
+    if (typeof value !== 'bigint' || value < fees_1.TRANSFER_GAS || value > MAX_UINT64) {
+        fail(`${name} must be a bigint of gas from 21,000 to 2^64 − 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);
+    // The gas-limit bound resolves the same way.
+    const ownGas = params.maxGasLimit;
+    const networkGas = ownGas === undefined ? undefined : gasBound(ownGas, 'params.maxGasLimit', fail);
+    const maxGasLimit = options.maxGasLimit !== undefined
+        ? gasBound(options.maxGasLimit, 'maxGasLimit', fail)
+        : (networkGas ?? fees_1.DEFAULT_MAX_GAS_LIMIT);
+    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,
+        maxGasLimit,
+    };
+}
+//# 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":";;;AAuIA,4CAgFC;AA/MD,mDAAsD;AACtD,iDAAoD;AACpD,iCAKgB;AAEhB,iFAAiF;AACpE,QAAA,gBAAgB,GAA0B;IACrD,QAAQ;IACR,YAAY;IACZ,sBAAsB;IACtB,iBAAiB;IACjB,cAAc;IACd,aAAa;IACb,QAAQ;CACT,CAAC;AAkCF;;;;GAIG;AACH,MAAM,WAAW,GAAsB,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC,CAAC;AAEtF,MAAM,WAAW,GAAG,EAAE,IAAI,IAAI,GAAG,EAAE,CAAC;AACpC,kFAAkF;AAClF,MAAM,UAAU,GAAG,EAAE,IAAI,GAAG,GAAG,EAAE,CAAC;AAElC,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;;;GAGG;AACH,SAAS,QAAQ,CAAC,KAAc,EAAE,IAAY,EAAE,IAA+B;IAC7E,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,GAAG,mBAAY,IAAI,KAAK,GAAG,UAAU,EAAE,CAAC;QAC5E,IAAI,CAAC,GAAG,IAAI,kDAAkD,CAAC,CAAC;IAClE,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,6CAA6C;IAC7C,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC;IAClC,MAAM,UAAU,GACd,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,oBAAoB,EAAE,IAAI,CAAC,CAAC;IAClF,MAAM,WAAW,GACf,OAAO,CAAC,WAAW,KAAK,SAAS;QAC/B,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,EAAE,aAAa,EAAE,IAAI,CAAC;QACpD,CAAC,CAAC,CAAC,UAAU,IAAI,4BAAqB,CAAC,CAAC;IAC5C,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;QACZ,WAAW;KACZ,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 {\n  DEFAULT_MAX_FEE_PER_GAS,\n  DEFAULT_MAX_GAS_LIMIT,\n  TRANSFER_GAS,\n  type EvmFeeModel,\n} 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   * The highest gas limit a transaction signs: the handle's `maxGasLimit` option, else the\n   * network's `params.maxGasLimit`, else `DEFAULT_MAX_GAS_LIMIT`.\n   */\n  readonly maxGasLimit: bigint;\n}\n\n/**\n * The only driver options (`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', 'maxGasLimit']);\n\nconst MAX_UINT256 = 2n ** 256n - 1n;\n/** The largest gas limit a transaction carries: clients read it as a `uint64`. */\nconst MAX_UINT64 = 2n ** 64n - 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/**\n * A gas-limit bound: a bigint of gas a transaction can carry, and at least a plain\n * transfer's 21,000, below which nothing could be signed.\n */\nfunction gasBound(value: unknown, name: string, fail: (reason: string) => never): bigint {\n  if (typeof value !== 'bigint' || value < TRANSFER_GAS || value > MAX_UINT64) {\n    fail(`${name} must be a bigint of gas from 21,000 to 2^64 − 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  // The gas-limit bound resolves the same way.\n  const ownGas = params.maxGasLimit;\n  const networkGas =\n    ownGas === undefined ? undefined : gasBound(ownGas, 'params.maxGasLimit', fail);\n  const maxGasLimit =\n    options.maxGasLimit !== undefined\n      ? gasBound(options.maxGasLimit, 'maxGasLimit', fail)\n      : (networkGas ?? DEFAULT_MAX_GAS_LIMIT);\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    maxGasLimit,\n  };\n}\n"]}

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

@@ -0,0 +1,35 @@
+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[];
+    /**
+     * Tokens: `erc20` refs, each registered under its EIP-55 checksummed contract, whatever
+     * case it is given in, so its alias and its transfers name one asset id.
+     */
+    readonly assets?: readonly AssetRegistration[];
+}
+/**
+ * A plugin for EVM chains of your own, served by the built-in EVM driver with either
+ * library. Every network and token is validated here, so bad data fails at registration.
+ */
+export declare function evmChainPlugin(options: EvmChainPluginOptions): Plugin;

package/dist/adapters/evm/plugin.js

@@ -0,0 +1,150 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EVM_PEER_DEPENDENCIES = void 0;
+exports.evmManifests = evmManifests;
+exports.evmPlugin = evmPlugin;
+exports.evmChainPlugin = evmChainPlugin;
+/**
+ * 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.
+ */
+const sha3_1 = require("@noble/hashes/sha3");
+const error_1 = require("../../core/errors/error");
+const bytes_1 = require("../../core/util/bytes");
+const chains_1 = require("./chains");
+const network_1 = require("./network");
+const presets_1 = require("./presets");
+const tokens_1 = require("./tokens");
+/** The SDK versions this adapter is validated against. */
+exports.EVM_PEER_DEPENDENCIES = {
+    ethers: { name: 'ethers', range: '^6.17.0' },
+    web3: { name: 'web3', range: '^4.16.0' },
+};
+/**
+ * The manifests' `load` functions, shared by every `evmManifests(...)` call, so that
+ * registering `evmPlugin()` or the same `evmChainPlugin(...)` again is the same plugin:
+ * the registry compares a plugin's functions by identity, and refuses a different plugin
+ * under a registered name. Each `require`s its client module, and with it the SDK, only
+ * when called.
+ */
+const loadEthers = async () => {
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
+    const mod = require('./ethers-client');
+    return mod.ethersDriverFactory;
+};
+const loadWeb3 = async () => {
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
+    const mod = require('./web3-client');
+    return mod.web3DriverFactory;
+};
+/** The `ethers` and `web3` manifests for `chains`, keyed `<family>/<library>`. */
+function evmManifests(family, chains) {
+    return [
+        {
+            family,
+            library: 'ethers',
+            chains,
+            capabilities: network_1.EVM_CAPABILITIES,
+            peerDependencies: [exports.EVM_PEER_DEPENDENCIES.ethers],
+            load: loadEthers,
+        },
+        {
+            family,
+            library: 'web3',
+            chains,
+            capabilities: network_1.EVM_CAPABILITIES,
+            peerDependencies: [exports.EVM_PEER_DEPENDENCIES.web3],
+            load: loadWeb3,
+        },
+    ];
+}
+/**
+ * The built-in EVM family: Ethereum, BNB Smart Chain, Polygon PoS, Avalanche C-Chain,
+ * Arbitrum One, OP Mainnet and Base, with their testnets.
+ */
+function evmPlugin() {
+    return {
+        name: 'evm',
+        chains: chains_1.EVM_CHAINS,
+        adapters: evmManifests('evm', chains_1.EVM_CHAINS.map((chain) => chain.id)),
+        presets: presets_1.EVM_PRESETS,
+        assets: tokens_1.EVM_TOKENS,
+    };
+}
+/** A plugin name: lower-case letters, digits and hyphens, starting with a letter. */
+const PLUGIN_NAME = /^[a-z][a-z0-9-]*$/;
+/** `0x` and 40 hex digits, in any case. */
+const HEX_ADDRESS = /^0x[0-9a-fA-F]{40}$/;
+/** EIP-55: each letter upper-cased where the keccak-256 of the lower-case hex has 8 or more. */
+function eip55(address) {
+    const hex = address.slice(2).toLowerCase();
+    const hash = (0, bytes_1.toHex)((0, sha3_1.keccak_256)((0, bytes_1.utf8ToBytes)(hex)));
+    let out = '0x';
+    for (let i = 0; i < hex.length; i++) {
+        const c = hex[i];
+        out += Number.parseInt(hash[i], 16) >= 8 ? c.toUpperCase() : c;
+    }
+    return out;
+}
+/**
+ * An ERC-20 registration under the contract the driver names it by. The driver normalizes
+ * every token ref it is given, reads or decodes to the EIP-55 form, and an asset id carries
+ * the contract as registered, so a lower-case registration would be a second asset of the
+ * same token: its alias would resolve to one id, and the token's own transfers, deposits
+ * and balances by ref to another. A mixed-case contract with a wrong checksum is a typo,
+ * refused as the driver refuses it in a transfer. The refusal never repeats the value.
+ */
+function erc20Registration(asset, name) {
+    const { ref } = asset;
+    if (ref === 'native')
+        return asset;
+    const fail = (reason) => {
+        throw new error_1.ConfigError('CONFIG_INVALID', `EVM chain plugin '${name}': the asset ${JSON.stringify(asset.metadata.symbol)} on ${asset.chain}:${asset.network} ${reason}`);
+    };
+    if (ref.standard !== 'erc20')
+        fail(`must use the 'erc20' standard`);
+    if (!HEX_ADDRESS.test(ref.contract))
+        fail('needs a 0x-prefixed 20-byte hex contract');
+    const contract = eip55(ref.contract);
+    const digits = ref.contract.slice(2);
+    const mixedCase = /[a-f]/.test(digits) && /[A-F]/.test(digits);
+    if (mixedCase && contract !== ref.contract)
+        fail('has a contract with a wrong checksum');
+    return contract === ref.contract ? asset : { ...asset, ref: { ...ref, contract } };
+}
+/**
+ * A plugin for EVM chains of your own, served by the built-in EVM driver with either
+ * library. Every network and token is validated here, so bad data fails at registration.
+ */
+function evmChainPlugin(options) {
+    if (!PLUGIN_NAME.test(options.name)) {
+        throw new error_1.ConfigError('CONFIG_INVALID', `EVM chain plugin name ${JSON.stringify(options.name)} must match ${String(PLUGIN_NAME)}`);
+    }
+    const name = `evm:${options.name}`;
+    for (const chain of options.chains) {
+        const fail = (reason) => {
+            throw new error_1.ConfigError('CONFIG_INVALID', `EVM chain '${chain.id}': ${reason}`);
+        };
+        if (chain.family !== 'evm')
+            fail(`its family must be 'evm'`);
+        if (chain.model !== 'account' || chain.ordering !== 'nonce') {
+            fail(`it must use the account model and nonce ordering`);
+        }
+        if (chain.schemes.length !== 1 || chain.schemes[0] !== 'secp256k1-ecdsa') {
+            fail(`its only scheme must be 'secp256k1-ecdsa'`);
+        }
+        for (const network of Object.values(chain.networks))
+            (0, network_1.evmNetworkConfig)(chain, network);
+    }
+    return {
+        name,
+        chains: options.chains,
+        adapters: evmManifests(name, options.chains.map((chain) => chain.id)),
+        ...(options.presets ? { presets: options.presets } : {}),
+        ...(options.assets
+            ? { assets: options.assets.map((asset) => erc20Registration(asset, name)) }
+            : {}),
+    };
+}
+//# sourceMappingURL=plugin.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../../src/adapters/evm/plugin.ts"],"names":[],"mappings":";;;AAiDA,oCAsBC;AAMD,8BAWC;AAoED,wCAiCC;AA7LD;;;;GAIG;AACH,6CAAgD;AAMhD,mDAAsD;AAKtD,iDAA2D;AAC3D,qCAAsC;AACtC,uCAA+D;AAC/D,uCAAwC;AACxC,qCAAsC;AAEtC,0DAA0D;AAC7C,QAAA,qBAAqB,GAChC;IACE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE;IAC5C,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE;CACzC,CAAC;AAEJ;;;;;;GAMG;AACH,MAAM,UAAU,GAAG,KAAK,IAA4B,EAAE;IACpD,iEAAiE;IACjE,MAAM,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAqC,CAAC;IAC3E,OAAO,GAAG,CAAC,mBAAmB,CAAC;AACjC,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,KAAK,IAA4B,EAAE;IAClD,iEAAiE;IACjE,MAAM,GAAG,GAAG,OAAO,CAAC,eAAe,CAAmC,CAAC;IACvE,OAAO,GAAG,CAAC,iBAAiB,CAAC;AAC/B,CAAC,CAAC;AAEF,kFAAkF;AAClF,SAAgB,YAAY,CAC1B,MAAc,EACd,MAAyB;IAEzB,OAAO;QACL;YACE,MAAM;YACN,OAAO,EAAE,QAAQ;YACjB,MAAM;YACN,YAAY,EAAE,0BAAgB;YAC9B,gBAAgB,EAAE,CAAC,6BAAqB,CAAC,MAAM,CAAC;YAChD,IAAI,EAAE,UAAU;SACjB;QACD;YACE,MAAM;YACN,OAAO,EAAE,MAAM;YACf,MAAM;YACN,YAAY,EAAE,0BAAgB;YAC9B,gBAAgB,EAAE,CAAC,6BAAqB,CAAC,IAAI,CAAC;YAC9C,IAAI,EAAE,QAAQ;SACf;KACF,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAgB,SAAS;IACvB,OAAO;QACL,IAAI,EAAE,KAAK;QACX,MAAM,EAAE,mBAAU;QAClB,QAAQ,EAAE,YAAY,CACpB,KAAK,EACL,mBAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CACpC;QACD,OAAO,EAAE,qBAAW;QACpB,MAAM,EAAE,mBAAU;KACnB,CAAC;AACJ,CAAC;AAED,qFAAqF;AACrF,MAAM,WAAW,GAAG,mBAAmB,CAAC;AAExC,2CAA2C;AAC3C,MAAM,WAAW,GAAG,qBAAqB,CAAC;AAE1C,gGAAgG;AAChG,SAAS,KAAK,CAAC,OAAe;IAC5B,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IAC3C,MAAM,IAAI,GAAG,IAAA,aAAK,EAAC,IAAA,iBAAU,EAAC,IAAA,mBAAW,EAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACjD,IAAI,GAAG,GAAG,IAAI,CAAC;IACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACpC,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAW,CAAC;QAC3B,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAW,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3E,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,iBAAiB,CAAC,KAAwB,EAAE,IAAY;IAC/D,MAAM,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;IACtB,IAAI,GAAG,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IACnC,MAAM,IAAI,GAAG,CAAC,MAAc,EAAS,EAAE;QACrC,MAAM,IAAI,mBAAW,CACnB,gBAAgB,EAChB,qBAAqB,IAAI,gBAAgB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,OAAO,IAAI,MAAM,EAAE,CAC9H,CAAC;IACJ,CAAC,CAAC;IACF,IAAI,GAAG,CAAC,QAAQ,KAAK,OAAO;QAAE,IAAI,CAAC,+BAA+B,CAAC,CAAC;IACpE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC;QAAE,IAAI,CAAC,0CAA0C,CAAC,CAAC;IACtF,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACrC,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACrC,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC/D,IAAI,SAAS,IAAI,QAAQ,KAAK,GAAG,CAAC,QAAQ;QACxC,IAAI,CAAC,sCAAsC,CAAC,CAAC;IAC/C,OAAO,QAAQ,KAAK,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,GAAG,EAAE,EAAE,GAAG,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC;AACrF,CAAC;AAmBD;;;GAGG;AACH,SAAgB,cAAc,CAAC,OAA8B;IAC3D,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,mBAAW,CACnB,gBAAgB,EAChB,yBAAyB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,MAAM,CAAC,WAAW,CAAC,EAAE,CAC1F,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAG,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC;IACnC,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnC,MAAM,IAAI,GAAG,CAAC,MAAc,EAAS,EAAE;YACrC,MAAM,IAAI,mBAAW,CAAC,gBAAgB,EAAE,cAAc,KAAK,CAAC,EAAE,MAAM,MAAM,EAAE,CAAC,CAAC;QAChF,CAAC,CAAC;QACF,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK;YAAE,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAC7D,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;YAC5D,IAAI,CAAC,kDAAkD,CAAC,CAAC;QAC3D,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,iBAAiB,EAAE,CAAC;YACzE,IAAI,CAAC,2CAA2C,CAAC,CAAC;QACpD,CAAC;QACD,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC;YAAE,IAAA,0BAAgB,EAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;IACD,OAAO;QACL,IAAI;QACJ,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,QAAQ,EAAE,YAAY,CACpB,IAAI,EACJ,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CACxC;QACD,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACxD,GAAG,CAAC,OAAO,CAAC,MAAM;YAChB,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,EAAE;YAC3E,CAAC,CAAC,EAAE,CAAC;KACR,CAAC;AACJ,CAAC","sourcesContent":["/**\n * The EVM family plugin: chains, tokens and provider presets as data, plus one\n * adapter manifest per library. SDK-free: only a manifest's `load()` requires a client\n * module, and with it the SDK. `ethers` is registered first, so it is the family default.\n */\nimport { keccak_256 } from '@noble/hashes/sha3';\nimport type {\n  AdapterManifest,\n  DriverFactory,\n  PeerDependency,\n} from '../../core/driver/types';\nimport { ConfigError } from '../../core/errors/error';\nimport type { ChainInfo } from '../../core/model/chain';\nimport type { AssetRegistration } from '../../core/registry/assets';\nimport type { Plugin } from '../../core/registry/plugin';\nimport type { ProviderPreset } from '../../core/registry/providers';\nimport { toHex, utf8ToBytes } from '../../core/util/bytes';\nimport { EVM_CHAINS } from './chains';\nimport { EVM_CAPABILITIES, evmNetworkConfig } from './network';\nimport { EVM_PRESETS } from './presets';\nimport { EVM_TOKENS } from './tokens';\n\n/** The SDK versions this adapter is validated against. */\nexport const EVM_PEER_DEPENDENCIES: Readonly<Record<'ethers' | 'web3', PeerDependency>> =\n  {\n    ethers: { name: 'ethers', range: '^6.17.0' },\n    web3: { name: 'web3', range: '^4.16.0' },\n  };\n\n/**\n * The manifests' `load` functions, shared by every `evmManifests(...)` call, so that\n * registering `evmPlugin()` or the same `evmChainPlugin(...)` again is the same plugin:\n * the registry compares a plugin's functions by identity, and refuses a different plugin\n * under a registered name. Each `require`s its client module, and with it the SDK, only\n * when called.\n */\nconst loadEthers = async (): Promise<DriverFactory> => {\n  // eslint-disable-next-line @typescript-eslint/no-require-imports\n  const mod = require('./ethers-client') as typeof import('./ethers-client');\n  return mod.ethersDriverFactory;\n};\n\nconst loadWeb3 = async (): Promise<DriverFactory> => {\n  // eslint-disable-next-line @typescript-eslint/no-require-imports\n  const mod = require('./web3-client') as typeof import('./web3-client');\n  return mod.web3DriverFactory;\n};\n\n/** The `ethers` and `web3` manifests for `chains`, keyed `<family>/<library>`. */\nexport function evmManifests(\n  family: string,\n  chains: readonly string[],\n): AdapterManifest[] {\n  return [\n    {\n      family,\n      library: 'ethers',\n      chains,\n      capabilities: EVM_CAPABILITIES,\n      peerDependencies: [EVM_PEER_DEPENDENCIES.ethers],\n      load: loadEthers,\n    },\n    {\n      family,\n      library: 'web3',\n      chains,\n      capabilities: EVM_CAPABILITIES,\n      peerDependencies: [EVM_PEER_DEPENDENCIES.web3],\n      load: loadWeb3,\n    },\n  ];\n}\n\n/**\n * The built-in EVM family: Ethereum, BNB Smart Chain, Polygon PoS, Avalanche C-Chain,\n * Arbitrum One, OP Mainnet and Base, with their testnets.\n */\nexport function evmPlugin(): Plugin {\n  return {\n    name: 'evm',\n    chains: EVM_CHAINS,\n    adapters: evmManifests(\n      'evm',\n      EVM_CHAINS.map((chain) => chain.id),\n    ),\n    presets: EVM_PRESETS,\n    assets: EVM_TOKENS,\n  };\n}\n\n/** A plugin name: lower-case letters, digits and hyphens, starting with a letter. */\nconst PLUGIN_NAME = /^[a-z][a-z0-9-]*$/;\n\n/** `0x` and 40 hex digits, in any case. */\nconst HEX_ADDRESS = /^0x[0-9a-fA-F]{40}$/;\n\n/** EIP-55: each letter upper-cased where the keccak-256 of the lower-case hex has 8 or more. */\nfunction eip55(address: string): string {\n  const hex = address.slice(2).toLowerCase();\n  const hash = toHex(keccak_256(utf8ToBytes(hex)));\n  let out = '0x';\n  for (let i = 0; i < hex.length; i++) {\n    const c = hex[i] as string;\n    out += Number.parseInt(hash[i] as string, 16) >= 8 ? c.toUpperCase() : c;\n  }\n  return out;\n}\n\n/**\n * An ERC-20 registration under the contract the driver names it by. The driver normalizes\n * every token ref it is given, reads or decodes to the EIP-55 form, and an asset id carries\n * the contract as registered, so a lower-case registration would be a second asset of the\n * same token: its alias would resolve to one id, and the token's own transfers, deposits\n * and balances by ref to another. A mixed-case contract with a wrong checksum is a typo,\n * refused as the driver refuses it in a transfer. The refusal never repeats the value.\n */\nfunction erc20Registration(asset: AssetRegistration, name: string): AssetRegistration {\n  const { ref } = asset;\n  if (ref === 'native') return asset;\n  const fail = (reason: string): never => {\n    throw new ConfigError(\n      'CONFIG_INVALID',\n      `EVM chain plugin '${name}': the asset ${JSON.stringify(asset.metadata.symbol)} on ${asset.chain}:${asset.network} ${reason}`,\n    );\n  };\n  if (ref.standard !== 'erc20') fail(`must use the 'erc20' standard`);\n  if (!HEX_ADDRESS.test(ref.contract)) fail('needs a 0x-prefixed 20-byte hex contract');\n  const contract = eip55(ref.contract);\n  const digits = ref.contract.slice(2);\n  const mixedCase = /[a-f]/.test(digits) && /[A-F]/.test(digits);\n  if (mixedCase && contract !== ref.contract)\n    fail('has a contract with a wrong checksum');\n  return contract === ref.contract ? asset : { ...asset, ref: { ...ref, contract } };\n}\n\nexport interface EvmChainPluginOptions {\n  /**\n   * A unique name matching `/^[a-z][a-z0-9-]*$/`. The plugin registers as `evm:<name>`, so\n   * it never collides with a family plugin, and its manifests as `evm:<name>/ethers` and\n   * `evm:<name>/web3`.\n   */\n  readonly name: string;\n  /** Chains with `family: 'evm'`, nonce ordering and the `secp256k1-ecdsa` scheme. */\n  readonly chains: readonly ChainInfo[];\n  readonly presets?: readonly ProviderPreset[];\n  /**\n   * Tokens: `erc20` refs, each registered under its EIP-55 checksummed contract, whatever\n   * case it is given in, so its alias and its transfers name one asset id.\n   */\n  readonly assets?: readonly AssetRegistration[];\n}\n\n/**\n * A plugin for EVM chains of your own, served by the built-in EVM driver with either\n * library. Every network and token is validated here, so bad data fails at registration.\n */\nexport function evmChainPlugin(options: EvmChainPluginOptions): Plugin {\n  if (!PLUGIN_NAME.test(options.name)) {\n    throw new ConfigError(\n      'CONFIG_INVALID',\n      `EVM chain plugin name ${JSON.stringify(options.name)} must match ${String(PLUGIN_NAME)}`,\n    );\n  }\n  const name = `evm:${options.name}`;\n  for (const chain of options.chains) {\n    const fail = (reason: string): never => {\n      throw new ConfigError('CONFIG_INVALID', `EVM chain '${chain.id}': ${reason}`);\n    };\n    if (chain.family !== 'evm') fail(`its family must be 'evm'`);\n    if (chain.model !== 'account' || chain.ordering !== 'nonce') {\n      fail(`it must use the account model and nonce ordering`);\n    }\n    if (chain.schemes.length !== 1 || chain.schemes[0] !== 'secp256k1-ecdsa') {\n      fail(`its only scheme must be 'secp256k1-ecdsa'`);\n    }\n    for (const network of Object.values(chain.networks)) evmNetworkConfig(chain, network);\n  }\n  return {\n    name,\n    chains: options.chains,\n    adapters: evmManifests(\n      name,\n      options.chains.map((chain) => chain.id),\n    ),\n    ...(options.presets ? { presets: options.presets } : {}),\n    ...(options.assets\n      ? { assets: options.assets.map((asset) => erc20Registration(asset, name)) }\n      : {}),\n  };\n}\n"]}

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

@@ -0,0 +1,2 @@
+import type { ProviderPreset } from '../../core/registry/providers';
+export declare const EVM_PRESETS: readonly ProviderPreset[];

package/dist/adapters/evm/presets.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EVM_PRESETS = void 0;
+/**
+ * EVM provider presets. Only URL templates verified against the provider's own
+ * documentation are listed; a preset refuses every other network with `CONFIG_INVALID`.
+ * `public` has no Ethereum entry: no operator-run public endpoint is documented for it.
+ * Keyed URLs are `Secret`s, so the key never reaches logs or errors.
+ */
+const error_1 = require("../../core/errors/error");
+const secret_1 = require("../../core/secret/secret");
+/**
+ * Free public endpoints named in each chain's own documentation: the chain operator's, or a
+ * third party's where the docs list one (Polygon's are drpc's).
+ */
+const PUBLIC = {
+    bsc: {
+        mainnet: 'https://bsc-dataseed.bnbchain.org',
+        testnet: 'https://bsc-testnet-dataseed.bnbchain.org',
+    },
+    polygon: {
+        mainnet: 'https://polygon.drpc.org',
+        amoy: 'https://polygon-amoy.drpc.org',
+    },
+    avalanche: {
+        mainnet: 'https://api.avax.network/ext/bc/C/rpc',
+        fuji: 'https://api.avax-test.network/ext/bc/C/rpc',
+    },
+    arbitrum: {
+        mainnet: 'https://arb1.arbitrum.io/rpc',
+        sepolia: 'https://sepolia-rollup.arbitrum.io/rpc',
+    },
+    optimism: {
+        mainnet: 'https://mainnet.optimism.io',
+        sepolia: 'https://sepolia.optimism.io',
+    },
+    base: { mainnet: 'https://mainnet.base.org', sepolia: 'https://sepolia.base.org' },
+};
+/** `https://<host>.g.alchemy.com/v2/<key>`. */
+const ALCHEMY = {
+    ethereum: { mainnet: 'eth-mainnet', sepolia: 'eth-sepolia', hoodi: 'eth-hoodi' },
+    bsc: { mainnet: 'bnb-mainnet', testnet: 'bnb-testnet' },
+    polygon: { mainnet: 'polygon-mainnet', amoy: 'polygon-amoy' },
+    avalanche: { mainnet: 'avax-mainnet', fuji: 'avax-fuji' },
+    arbitrum: { mainnet: 'arb-mainnet', sepolia: 'arb-sepolia' },
+    optimism: { mainnet: 'opt-mainnet', sepolia: 'opt-sepolia' },
+    base: { mainnet: 'base-mainnet', sepolia: 'base-sepolia' },
+};
+/** `https://<host>.infura.io/v3/<key>`. */
+const INFURA = {
+    ethereum: { mainnet: 'mainnet', sepolia: 'sepolia', hoodi: 'hoodi' },
+    bsc: { mainnet: 'bsc-mainnet', testnet: 'bsc-testnet' },
+    polygon: { mainnet: 'polygon-mainnet', amoy: 'polygon-amoy' },
+    avalanche: { mainnet: 'avalanche-mainnet', fuji: 'avalanche-fuji' },
+    arbitrum: { mainnet: 'arbitrum-mainnet', sepolia: 'arbitrum-sepolia' },
+    optimism: { mainnet: 'optimism-mainnet', sepolia: 'optimism-sepolia' },
+    base: { mainnet: 'base-mainnet', sepolia: 'base-sepolia' },
+};
+/** `https://rpc.ankr.com/<path>/<key>`: only the paths Ankr's documentation shows. */
+const ANKR = {
+    ethereum: { mainnet: 'eth' },
+    bsc: { mainnet: 'bsc' },
+    avalanche: { mainnet: 'avalanche' },
+    arbitrum: { mainnet: 'arbitrum' },
+    base: { mainnet: 'base' },
+};
+function entry(table, input) {
+    const value = table[input.chain]?.[input.network];
+    // Unreachable through the catalog, which asks `supports` first.
+    if (value === undefined)
+        throw new Error(`no entry for ${input.chain}:${input.network}`);
+    return value;
+}
+/** The revealed key; the error names the preset and network, never the key. */
+function apiKeyOf(name, input) {
+    const key = input.apiKey === undefined ? undefined : (0, secret_1.reveal)(input.apiKey);
+    if (typeof key !== 'string' || key.trim() === '') {
+        throw new error_1.ConfigError('CONFIG_INVALID', `provider preset '${name}' requires a non-empty apiKey for ${input.chain}:${input.network}`);
+    }
+    return key;
+}
+function keyed(name, table, url) {
+    return {
+        name,
+        kind: 'rpc',
+        requiresApiKey: true,
+        supports: (chain, network) => table[chain]?.[network] !== undefined,
+        endpoints: (input) => [
+            { name, url: (0, secret_1.secret)(url(entry(table, input), apiKeyOf(name, input))) },
+        ],
+    };
+}
+exports.EVM_PRESETS = [
+    {
+        name: 'public',
+        kind: 'rpc',
+        production: false,
+        supports: (chain, network) => PUBLIC[chain]?.[network] !== undefined,
+        endpoints: (input) => [{ name: 'public', url: entry(PUBLIC, input) }],
+    },
+    keyed('alchemy', ALCHEMY, (host, key) => `https://${host}.g.alchemy.com/v2/${key}`),
+    keyed('infura', INFURA, (host, key) => `https://${host}.infura.io/v3/${key}`),
+    keyed('ankr', ANKR, (path, key) => `https://rpc.ankr.com/${path}/${key}`),
+];
+//# sourceMappingURL=presets.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"presets.js","sourceRoot":"","sources":["../../../src/adapters/evm/presets.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,mDAAsD;AAEtD,qDAA0D;AAK1D;;;GAGG;AACH,MAAM,MAAM,GAAU;IACpB,GAAG,EAAE;QACH,OAAO,EAAE,mCAAmC;QAC5C,OAAO,EAAE,2CAA2C;KACrD;IACD,OAAO,EAAE;QACP,OAAO,EAAE,0BAA0B;QACnC,IAAI,EAAE,+BAA+B;KACtC;IACD,SAAS,EAAE;QACT,OAAO,EAAE,uCAAuC;QAChD,IAAI,EAAE,4CAA4C;KACnD;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,8BAA8B;QACvC,OAAO,EAAE,wCAAwC;KAClD;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,6BAA6B;QACtC,OAAO,EAAE,6BAA6B;KACvC;IACD,IAAI,EAAE,EAAE,OAAO,EAAE,0BAA0B,EAAE,OAAO,EAAE,0BAA0B,EAAE;CACnF,CAAC;AAEF,+CAA+C;AAC/C,MAAM,OAAO,GAAU;IACrB,QAAQ,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE;IAChF,GAAG,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,aAAa,EAAE;IACvD,OAAO,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAE,cAAc,EAAE;IAC7D,SAAS,EAAE,EAAE,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,WAAW,EAAE;IACzD,QAAQ,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,aAAa,EAAE;IAC5D,QAAQ,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,aAAa,EAAE;IAC5D,IAAI,EAAE,EAAE,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,cAAc,EAAE;CAC3D,CAAC;AAEF,2CAA2C;AAC3C,MAAM,MAAM,GAAU;IACpB,QAAQ,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE;IACpE,GAAG,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,aAAa,EAAE;IACvD,OAAO,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAE,cAAc,EAAE;IAC7D,SAAS,EAAE,EAAE,OAAO,EAAE,mBAAmB,EAAE,IAAI,EAAE,gBAAgB,EAAE;IACnE,QAAQ,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE,OAAO,EAAE,kBAAkB,EAAE;IACtE,QAAQ,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE,OAAO,EAAE,kBAAkB,EAAE;IACtE,IAAI,EAAE,EAAE,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,cAAc,EAAE;CAC3D,CAAC;AAEF,sFAAsF;AACtF,MAAM,IAAI,GAAU;IAClB,QAAQ,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;IAC5B,GAAG,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;IACvB,SAAS,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE;IACnC,QAAQ,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;IACjC,IAAI,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE;CAC1B,CAAC;AAEF,SAAS,KAAK,CAAC,KAAY,EAAE,KAAkB;IAC7C,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAClD,gEAAgE;IAChE,IAAI,KAAK,KAAK,SAAS;QACrB,MAAM,IAAI,KAAK,CAAC,gBAAgB,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IAClE,OAAO,KAAK,CAAC;AACf,CAAC;AAED,+EAA+E;AAC/E,SAAS,QAAQ,CAAC,IAAY,EAAE,KAAkB;IAChD,MAAM,GAAG,GAAY,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,eAAM,EAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACnF,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACjD,MAAM,IAAI,mBAAW,CACnB,gBAAgB,EAChB,oBAAoB,IAAI,qCAAqC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,OAAO,EAAE,CAC5F,CAAC;IACJ,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,KAAK,CACZ,IAAY,EACZ,KAAY,EACZ,GAA2C;IAE3C,OAAO;QACL,IAAI;QACJ,IAAI,EAAE,KAAK;QACX,cAAc,EAAE,IAAI;QACpB,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,SAAS;QACnE,SAAS,EAAE,CAAC,KAAK,EAA6B,EAAE,CAAC;YAC/C,EAAE,IAAI,EAAE,GAAG,EAAE,IAAA,eAAM,EAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE;SACvE;KACF,CAAC;AACJ,CAAC;AAEY,QAAA,WAAW,GAA8B;IACpD;QACE,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,KAAK;QACX,UAAU,EAAE,KAAK;QACjB,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,SAAS;QACpE,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC;KACtE;IACD,KAAK,CAAC,SAAS,EAAE,OAAO,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,WAAW,IAAI,qBAAqB,GAAG,EAAE,CAAC;IACnF,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,WAAW,IAAI,iBAAiB,GAAG,EAAE,CAAC;IAC7E,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,wBAAwB,IAAI,IAAI,GAAG,EAAE,CAAC;CAC1E,CAAC","sourcesContent":["/**\n * EVM provider presets. Only URL templates verified against the provider's own\n * documentation are listed; a preset refuses every other network with `CONFIG_INVALID`.\n * `public` has no Ethereum entry: no operator-run public endpoint is documented for it.\n * Keyed URLs are `Secret`s, so the key never reaches logs or errors.\n */\nimport { ConfigError } from '../../core/errors/error';\nimport type { PresetInput, ProviderPreset } from '../../core/registry/providers';\nimport { reveal, secret } from '../../core/secret/secret';\nimport type { EndpointConfig } from '../../core/transport/types';\n\ntype Table = Readonly<Record<string, Readonly<Record<string, string>>>>;\n\n/**\n * Free public endpoints named in each chain's own documentation: the chain operator's, or a\n * third party's where the docs list one (Polygon's are drpc's).\n */\nconst PUBLIC: Table = {\n  bsc: {\n    mainnet: 'https://bsc-dataseed.bnbchain.org',\n    testnet: 'https://bsc-testnet-dataseed.bnbchain.org',\n  },\n  polygon: {\n    mainnet: 'https://polygon.drpc.org',\n    amoy: 'https://polygon-amoy.drpc.org',\n  },\n  avalanche: {\n    mainnet: 'https://api.avax.network/ext/bc/C/rpc',\n    fuji: 'https://api.avax-test.network/ext/bc/C/rpc',\n  },\n  arbitrum: {\n    mainnet: 'https://arb1.arbitrum.io/rpc',\n    sepolia: 'https://sepolia-rollup.arbitrum.io/rpc',\n  },\n  optimism: {\n    mainnet: 'https://mainnet.optimism.io',\n    sepolia: 'https://sepolia.optimism.io',\n  },\n  base: { mainnet: 'https://mainnet.base.org', sepolia: 'https://sepolia.base.org' },\n};\n\n/** `https://<host>.g.alchemy.com/v2/<key>`. */\nconst ALCHEMY: Table = {\n  ethereum: { mainnet: 'eth-mainnet', sepolia: 'eth-sepolia', hoodi: 'eth-hoodi' },\n  bsc: { mainnet: 'bnb-mainnet', testnet: 'bnb-testnet' },\n  polygon: { mainnet: 'polygon-mainnet', amoy: 'polygon-amoy' },\n  avalanche: { mainnet: 'avax-mainnet', fuji: 'avax-fuji' },\n  arbitrum: { mainnet: 'arb-mainnet', sepolia: 'arb-sepolia' },\n  optimism: { mainnet: 'opt-mainnet', sepolia: 'opt-sepolia' },\n  base: { mainnet: 'base-mainnet', sepolia: 'base-sepolia' },\n};\n\n/** `https://<host>.infura.io/v3/<key>`. */\nconst INFURA: Table = {\n  ethereum: { mainnet: 'mainnet', sepolia: 'sepolia', hoodi: 'hoodi' },\n  bsc: { mainnet: 'bsc-mainnet', testnet: 'bsc-testnet' },\n  polygon: { mainnet: 'polygon-mainnet', amoy: 'polygon-amoy' },\n  avalanche: { mainnet: 'avalanche-mainnet', fuji: 'avalanche-fuji' },\n  arbitrum: { mainnet: 'arbitrum-mainnet', sepolia: 'arbitrum-sepolia' },\n  optimism: { mainnet: 'optimism-mainnet', sepolia: 'optimism-sepolia' },\n  base: { mainnet: 'base-mainnet', sepolia: 'base-sepolia' },\n};\n\n/** `https://rpc.ankr.com/<path>/<key>`: only the paths Ankr's documentation shows. */\nconst ANKR: Table = {\n  ethereum: { mainnet: 'eth' },\n  bsc: { mainnet: 'bsc' },\n  avalanche: { mainnet: 'avalanche' },\n  arbitrum: { mainnet: 'arbitrum' },\n  base: { mainnet: 'base' },\n};\n\nfunction entry(table: Table, input: PresetInput): string {\n  const value = table[input.chain]?.[input.network];\n  // Unreachable through the catalog, which asks `supports` first.\n  if (value === undefined)\n    throw new Error(`no entry for ${input.chain}:${input.network}`);\n  return value;\n}\n\n/** The revealed key; the error names the preset and network, never the key. */\nfunction apiKeyOf(name: string, input: PresetInput): string {\n  const key: unknown = input.apiKey === undefined ? undefined : reveal(input.apiKey);\n  if (typeof key !== 'string' || key.trim() === '') {\n    throw new ConfigError(\n      'CONFIG_INVALID',\n      `provider preset '${name}' requires a non-empty apiKey for ${input.chain}:${input.network}`,\n    );\n  }\n  return key;\n}\n\nfunction keyed(\n  name: string,\n  table: Table,\n  url: (value: string, key: string) => string,\n): ProviderPreset {\n  return {\n    name,\n    kind: 'rpc',\n    requiresApiKey: true,\n    supports: (chain, network) => table[chain]?.[network] !== undefined,\n    endpoints: (input): readonly EndpointConfig[] => [\n      { name, url: secret(url(entry(table, input), apiKeyOf(name, input))) },\n    ],\n  };\n}\n\nexport const EVM_PRESETS: readonly ProviderPreset[] = [\n  {\n    name: 'public',\n    kind: 'rpc',\n    production: false,\n    supports: (chain, network) => PUBLIC[chain]?.[network] !== undefined,\n    endpoints: (input) => [{ name: 'public', url: entry(PUBLIC, input) }],\n  },\n  keyed('alchemy', ALCHEMY, (host, key) => `https://${host}.g.alchemy.com/v2/${key}`),\n  keyed('infura', INFURA, (host, key) => `https://${host}.infura.io/v3/${key}`),\n  keyed('ankr', ANKR, (path, key) => `https://rpc.ankr.com/${path}/${key}`),\n];\n"]}

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

@@ -0,0 +1,19 @@
+import type { BlockSource, ProofSource } from '../../core/driver/types';
+import { type EvmContext } from './reader';
+/**
+ * The lowest height at or below `final` where `consumed` holds, given that it holds at
+ * `final`. A gallop back (`final` less 1, 2, 4, …) finds a height where it does not, then a
+ * bisection the first where it does. `consumed` never turns false again as the height
+ * grows, since an account's nonce never falls. Beyond `MAX_SEARCH_READS` reads, it decides
+ * nothing.
+ */
+export declare function consumptionHeight(consumed: (height: bigint) => Promise<boolean>, final: bigint): Promise<bigint>;
+export declare function createEvmProofs(ctx: EvmContext): ProofSource;
+/**
+ * Whether a block's `logsBloom` may hold `value` (a log's address or topic), by the
+ * yellow paper's M3:2048: three bits, each the low 11 bits of a byte pair of the value's
+ * keccak-256. `false` is definitive; `true` may be a false positive. No bloom may hold
+ * anything.
+ */
+export declare function mayHold(bloom: string | undefined, value: string): boolean;
+export declare function createEvmBlocks(ctx: EvmContext): BlockSource;