@recoillink/sdk 0.0.0-stage → 45.0.1

package/dist/token/EvmXERC20Reader.js

@@ -0,0 +1,122 @@
+import { ethers } from 'ethers';
+import { Ownable__factory, ProxyAdmin__factory } from '@recoillink/core';
+import { eqAddress, normalizeAddress, rootLogger, } from '@recoillink/utils';
+import { proxyAdmin } from '../deploy/proxy.js';
+import { MultiProtocolProvider } from '../providers/MultiProtocolProvider.js';
+import { EvmEventLogsReader } from '../rpc/evm/EvmEventLogsReader.js';
+import { viemLogFromGetEventLogsResponse } from '../rpc/evm/utils.js';
+import { HyperlaneReader } from '../utils/HyperlaneReader.js';
+import { XERC20Type } from './types.js';
+import { CONFIGURATION_CHANGED_EVENT_SELECTOR } from './xerc20-abi.js';
+import { readXERC20Limits, toStandardLimits, toVeloLimits, } from './xerc20-limits.js';
+import { XERC20_LOG_SCAN_BLOCK_RANGE, deriveXERC20TokenType, latestConfigurationPerBridge, } from './xerc20.js';
+export { limitsAreZero, limitsMatch } from './xerc20-limits.js';
+/**
+ * Reader for on-chain XERC20 state.
+ * Reads limits and bridge configurations from XERC20 contracts.
+ */
+export class EvmXERC20Reader extends HyperlaneReader {
+    multiProvider;
+    logger = rootLogger.child({ module: 'EvmXERC20Reader' });
+    multiProtocolProvider;
+    constructor(multiProvider, chain) {
+        super(multiProvider, chain);
+        this.multiProvider = multiProvider;
+        this.multiProtocolProvider =
+            MultiProtocolProvider.fromMultiProvider(multiProvider);
+    }
+    async deriveXERC20TokenType(xERC20Address) {
+        return deriveXERC20TokenType(this.multiProvider, this.chain, xERC20Address);
+    }
+    /**
+     * Read current limits for the specified bridges.
+     */
+    async readLimits(xERC20Address, bridges, type) {
+        return readXERC20Limits({
+            multiProtocolProvider: this.multiProtocolProvider,
+            chain: this.multiProvider.getChainName(this.chain),
+            xERC20Address,
+            bridges,
+            type,
+            // Bound rather than passed by reference so a subclass overriding either
+            // still decides what its reader reports.
+            converters: {
+                toStandardLimits: (limits) => this.toStandardLimits(limits),
+                toVeloLimits: (rateLimits) => this.toVeloLimits(rateLimits),
+            },
+        });
+    }
+    /**
+     * Read all bridges configured on-chain for a Velodrome XERC20 by parsing ConfigurationChanged events.
+     * The scan covers the token's whole history, from the block it was deployed in
+     * to the chain head, over the block explorer where the chain has a usable one
+     * and over the paginated RPC otherwise.
+     *
+     * Returns an empty array for Standard XERC20, whose bridges this does not
+     * enumerate. They are enumerable: a Standard token announces them through
+     * BridgeLimitsSet, which getExtraLockBoxConfigs reads. Callers relying on
+     * this therefore fall back to the bridges their config names for a Standard
+     * token, which is why bringing the two paths together is worth doing.
+     */
+    async readOnChainBridges(xERC20Address, type) {
+        if (type === XERC20Type.Standard) {
+            this.logger.debug('Standard XERC20 bridge enumeration is not implemented here');
+            return [];
+        }
+        const logsReader = EvmEventLogsReader.fromConfig({ chain: this.chain, paginationBlockRange: XERC20_LOG_SCAN_BLOCK_RANGE }, this.multiProvider, this.logger);
+        const rawLogs = await logsReader.getLogsByTopic({
+            contractAddress: xERC20Address,
+            eventTopic: CONFIGURATION_CHANGED_EVENT_SELECTOR,
+        });
+        const bridgeToLatestLog = latestConfigurationPerBridge(rawLogs.map(viemLogFromGetEventLogsResponse));
+        // Filter to active bridges (non-zero limits)
+        const activeBridges = [];
+        for (const [bridge, log] of bridgeToLatestLog) {
+            const hasNonZeroLimits = log.args.bufferCap !== 0n || log.args.rateLimitPerSecond !== 0n;
+            if (hasNonZeroLimits) {
+                activeBridges.push(bridge);
+            }
+        }
+        return activeBridges;
+    }
+    /**
+     * Read the owner of the XERC20 token contract.
+     * This owner controls limit/bridge management (setBufferCap, addBridge, etc.).
+     * Returns undefined if the XERC20 does not expose `owner()` (e.g. a
+     * third-party token using AccessControl instead of Ownable) so callers on the
+     * warp read/apply path don't break on non-Ownable tokens.
+     */
+    async readOwner(xERC20Address) {
+        try {
+            const owner = await Ownable__factory.connect(xERC20Address, this.provider).owner();
+            return normalizeAddress(owner);
+        }
+        catch (error) {
+            this.logger.debug({ xERC20Address, error }, 'XERC20 does not expose owner(); treating owner as undefined');
+            return undefined;
+        }
+    }
+    /**
+     * Read the ProxyAdmin for the XERC20 proxy and its owner.
+     * The ProxyAdmin owner controls upgrades. Returns undefined if the XERC20 is
+     * not behind a transparent proxy.
+     */
+    async readProxyAdmin(xERC20Address) {
+        const proxyAdminAddress = await proxyAdmin(this.provider, xERC20Address);
+        if (eqAddress(proxyAdminAddress, ethers.constants.AddressZero)) {
+            return undefined;
+        }
+        const owner = await ProxyAdmin__factory.connect(proxyAdminAddress, this.provider).owner();
+        return {
+            address: normalizeAddress(proxyAdminAddress),
+            owner: normalizeAddress(owner),
+        };
+    }
+    toStandardLimits(limits) {
+        return toStandardLimits(limits);
+    }
+    toVeloLimits(rateLimits) {
+        return toVeloLimits(rateLimits);
+    }
+}
+//# sourceMappingURL=EvmXERC20Reader.js.map

package/dist/token/EvmXERC20Reader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EvmXERC20Reader.js","sourceRoot":"","sources":["../../src/token/EvmXERC20Reader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACzE,OAAO,EAEL,SAAS,EACT,gBAAgB,EAChB,UAAU,GACX,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAE9E,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAG9D,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,oCAAoC,EAAE,MAAM,iBAAiB,CAAC;AACvE,OAAO,EAIL,gBAAgB,EAChB,gBAAgB,EAChB,YAAY,GACb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,2BAA2B,EAC3B,qBAAqB,EACrB,4BAA4B,GAC7B,MAAM,aAAa,CAAC;AAQrB,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEhE;;;GAGG;AACH,MAAM,OAAO,eAAgB,SAAQ,eAAe;IAK7B,aAAa;IAJxB,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;IAChD,qBAAqB,CAAwB;IAEhE,YACqB,aAA4B,EAC/C,KAAoB;QAEpB,KAAK,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;6BAHT,aAAa;QAIhC,IAAI,CAAC,qBAAqB;YACxB,qBAAqB,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;IAC3D,CAAC;IAED,KAAK,CAAC,qBAAqB,CAAC,aAAsB;QAChD,OAAO,qBAAqB,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;IAC9E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CACd,aAAsB,EACtB,OAAkB,EAClB,IAAgB;QAEhB,OAAO,gBAAgB,CAAC;YACtB,qBAAqB,EAAE,IAAI,CAAC,qBAAqB;YACjD,KAAK,EAAE,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAClD,aAAa;YACb,OAAO;YACP,IAAI;YACJ,wEAAwE;YACxE,yCAAyC;YACzC,UAAU,EAAE;gBACV,gBAAgB,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC;gBAC3D,YAAY,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC;aAC5D;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,kBAAkB,CACtB,aAAsB,EACtB,IAAgB;QAEhB,IAAI,IAAI,KAAK,UAAU,CAAC,QAAQ,EAAE,CAAC;YACjC,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,4DAA4D,CAC7D,CAAC;YACF,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAC9C,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,oBAAoB,EAAE,2BAA2B,EAAE,EACxE,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,MAAM,CACZ,CAAC;QAEF,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,cAAc,CAAC;YAC9C,eAAe,EAAE,aAAa;YAC9B,UAAU,EAAE,oCAAoC;SACjD,CAAC,CAAC;QAEH,MAAM,iBAAiB,GAAG,4BAA4B,CACpD,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAC7C,CAAC;QAEF,6CAA6C;QAC7C,MAAM,aAAa,GAAc,EAAE,CAAC;QACpC,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,iBAAiB,EAAE,CAAC;YAC9C,MAAM,gBAAgB,GACpB,GAAG,CAAC,IAAI,CAAC,SAAS,KAAK,EAAE,IAAI,GAAG,CAAC,IAAI,CAAC,kBAAkB,KAAK,EAAE,CAAC;YAClE,IAAI,gBAAgB,EAAE,CAAC;gBACrB,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,CAAC,aAAsB;QACpC,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,MAAM,gBAAgB,CAAC,OAAO,CAC1C,aAAa,EACb,IAAI,CAAC,QAAQ,CACd,CAAC,KAAK,EAAE,CAAC;YACV,OAAO,gBAAgB,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,EAAE,aAAa,EAAE,KAAK,EAAE,EACxB,6DAA6D,CAC9D,CAAC;YACF,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,cAAc,CAClB,aAAsB;QAEtB,MAAM,iBAAiB,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QACzE,IAAI,SAAS,CAAC,iBAAiB,EAAE,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC;YAC/D,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,mBAAmB,CAAC,OAAO,CAC7C,iBAAiB,EACjB,IAAI,CAAC,QAAQ,CACd,CAAC,KAAK,EAAE,CAAC;QAEV,OAAO;YACL,OAAO,EAAE,gBAAgB,CAAC,iBAAiB,CAAC;YAC5C,KAAK,EAAE,gBAAgB,CAAC,KAAK,CAAC;SAC/B,CAAC;IACJ,CAAC;IAES,gBAAgB,CAAC,MAAoB;QAC7C,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IAES,YAAY,CAAC,UAA6B;QAClD,OAAO,YAAY,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC;CACF"}

package/dist/token/EvmXERC20Reader.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=EvmXERC20Reader.test.d.ts.map

package/dist/token/EvmXERC20Reader.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EvmXERC20Reader.test.d.ts","sourceRoot":"","sources":["../../src/token/EvmXERC20Reader.test.ts"],"names":[],"mappings":""}

package/dist/token/EvmXERC20Reader.test.js

@@ -0,0 +1,333 @@
+import { expect } from 'chai';
+import { BigNumber, providers, utils } from 'ethers';
+import sinon from 'sinon';
+import { ProtocolType, assert } from '@recoillink/utils';
+import { MultiProvider } from '../providers/MultiProvider.js';
+import { HyperlaneJsonRpcProvider } from '../providers/SmartProvider/HyperlaneJsonRpcProvider.js';
+import { ProviderMethod } from '../providers/SmartProvider/ProviderMethods.js';
+import { EvmEventLogsReader } from '../rpc/evm/EvmEventLogsReader.js';
+import { DEFAULT_CONTRACT_READ_CONCURRENCY } from '../consts/concurrency.js';
+import { EvmXERC20Reader } from './EvmXERC20Reader.js';
+import { EvmXERC20VSAdapter } from './adapters/EvmTokenAdapter.js';
+import { XERC20Type } from './types.js';
+import { CONFIGURATION_CHANGED_EVENT_SELECTOR } from './xerc20-abi.js';
+const CHAIN_NAME = 'paginatedchain';
+const CHAIN_ID = 31_337_000;
+const RPC_URL = 'http://provider';
+const XERC20_ADDRESS = '0x0000000000000000000000000000000000000abc';
+const LATEST_BLOCK = 100;
+const MAX_BLOCK_RANGE = 5;
+// The xERC20 has no code before this block, which is what the deployment block
+// search reads to place the lower bound of the scan.
+const DEPLOYMENT_BLOCK = 8;
+const CONTRACT_BYTECODE = '0x60806040';
+// Configured once, early enough in the chain's history that a scan reaching
+// only the most recent maxBlockRange * 10 blocks would miss it.
+const BRIDGE_ONLY_EARLY = '0xaAaAaAaaAaAaAaaAaAAAAAAAAaaaAaAaAaaAaaAa';
+const BRIDGE_RECENT = '0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB';
+const BRIDGE_DEACTIVATED = '0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC';
+// Configured early and reconfigured recently.
+const BRIDGE_RECONFIGURED = '0xDDdDddDdDdddDDddDDddDDDDdDdDDdDDdDDDDDDd';
+function configurationChangedLog(params) {
+    return {
+        address: XERC20_ADDRESS,
+        blockHash: utils.hexZeroPad(utils.hexValue(params.blockNumber), 32),
+        blockNumber: utils.hexValue(params.blockNumber),
+        data: utils.defaultAbiCoder.encode(['uint112', 'uint128'], [params.bufferCap, params.rateLimitPerSecond]),
+        logIndex: '0x0',
+        removed: false,
+        topics: [
+            CONFIGURATION_CHANGED_EVENT_SELECTOR,
+            utils.hexZeroPad(params.bridge.toLowerCase(), 32),
+        ],
+        transactionHash: utils.hexZeroPad(utils.hexValue(params.blockNumber), 32),
+        transactionIndex: '0x0',
+    };
+}
+const CONFIGURATION_LOGS = [
+    configurationChangedLog({
+        bridge: BRIDGE_ONLY_EARLY,
+        bufferCap: 1_000,
+        rateLimitPerSecond: 10,
+        blockNumber: 10,
+    }),
+    configurationChangedLog({
+        bridge: BRIDGE_RECONFIGURED,
+        bufferCap: 2_000,
+        rateLimitPerSecond: 20,
+        blockNumber: 20,
+    }),
+    configurationChangedLog({
+        bridge: BRIDGE_RECENT,
+        bufferCap: 3_000,
+        rateLimitPerSecond: 30,
+        blockNumber: 60,
+    }),
+    configurationChangedLog({
+        bridge: BRIDGE_DEACTIVATED,
+        bufferCap: 4_000,
+        rateLimitPerSecond: 40,
+        blockNumber: 70,
+    }),
+    configurationChangedLog({
+        bridge: BRIDGE_RECONFIGURED,
+        bufferCap: 5_000,
+        rateLimitPerSecond: 50,
+        blockNumber: 80,
+    }),
+    configurationChangedLog({
+        bridge: BRIDGE_DEACTIVATED,
+        bufferCap: 0,
+        rateLimitPerSecond: 0,
+        blockNumber: 90,
+    }),
+];
+function decodeBlockTag(tag) {
+    if (tag === 'latest' || tag === 'earliest')
+        return tag;
+    assert(typeof tag === 'string', `Expected a hex block tag, got ${typeof tag}`);
+    return BigNumber.from(tag).toNumber();
+}
+function resolveBlockTag(tag) {
+    if (tag === 'latest')
+        return LATEST_BLOCK;
+    if (tag === 'earliest')
+        return 0;
+    return tag;
+}
+// Records the block windows the transport was asked to serve and answers each
+// one with the fixture logs that fall inside it. eth_getCode is answered from
+// DEPLOYMENT_BLOCK so the reader's deployment block search has something to
+// converge on.
+function stubTransport() {
+    const served = [];
+    sinon.stub(providers.JsonRpcProvider.prototype, 'perform').callsFake(async (method, params) => {
+        if (method === ProviderMethod.GetBlockNumber)
+            return LATEST_BLOCK;
+        if (method === ProviderMethod.GetCode) {
+            const block = resolveBlockTag(decodeBlockTag(params.blockTag));
+            return block >= DEPLOYMENT_BLOCK ? CONTRACT_BYTECODE : '0x';
+        }
+        if (method !== ProviderMethod.GetLogs) {
+            throw new Error(`Unexpected method ${method}`);
+        }
+        if (!params.filter)
+            throw new Error('Missing log filter');
+        const window = [
+            decodeBlockTag(params.filter.fromBlock),
+            decodeBlockTag(params.filter.toBlock),
+        ];
+        served.push(window);
+        const fromBlock = resolveBlockTag(window[0]);
+        const toBlock = resolveBlockTag(window[1]);
+        return CONFIGURATION_LOGS.filter((log) => {
+            const blockNumber = BigNumber.from(log.blockNumber).toNumber();
+            return blockNumber >= fromBlock && blockNumber <= toBlock;
+        });
+    });
+    return served;
+}
+function createReader(pagination) {
+    const metadata = {
+        chainId: CHAIN_ID,
+        domainId: CHAIN_ID,
+        name: CHAIN_NAME,
+        protocol: ProtocolType.Ethereum,
+        rpcUrls: [{ http: RPC_URL, pagination }],
+    };
+    const multiProvider = new MultiProvider({ [CHAIN_NAME]: metadata });
+    multiProvider.setProvider(CHAIN_NAME, new HyperlaneJsonRpcProvider({ http: RPC_URL, pagination }, { chainId: CHAIN_ID, name: CHAIN_NAME }));
+    return new EvmXERC20Reader(multiProvider, CHAIN_NAME);
+}
+const OVERRIDE_BRIDGE = '0xEeEeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE';
+const LIMIT_BRIDGES = Array.from({ length: 12 }, (_value, index) => `0x${(index + 1).toString(16).padStart(2, '0').repeat(20)}`);
+function createLimitsReader(concurrency) {
+    const rpcUrl = { http: RPC_URL, concurrency };
+    const metadata = {
+        chainId: CHAIN_ID,
+        domainId: CHAIN_ID,
+        name: CHAIN_NAME,
+        protocol: ProtocolType.Ethereum,
+        rpcUrls: [rpcUrl],
+    };
+    const multiProvider = new MultiProvider({ [CHAIN_NAME]: metadata });
+    multiProvider.setProvider(CHAIN_NAME, new HyperlaneJsonRpcProvider(rpcUrl, {
+        chainId: CHAIN_ID,
+        name: CHAIN_NAME,
+    }));
+    return new EvmXERC20Reader(multiProvider, CHAIN_NAME);
+}
+function rateLimits(bufferCap) {
+    return {
+        rateLimitPerSecond: 1n,
+        bufferCap,
+        lastBufferUsedTime: 0,
+        bufferStored: 0n,
+        midPoint: 0n,
+    };
+}
+describe('EvmXERC20Reader', () => {
+    beforeEach(() => {
+        // The chain declares no block explorer, so the reader is RPC only and any
+        // fetch would be an unintended network call.
+        sinon
+            .stub(globalThis, 'fetch')
+            .rejects(new Error('Unexpected network request'));
+    });
+    afterEach(() => sinon.restore());
+    describe('readOnChainBridges', () => {
+        const cases = [
+            {
+                // The scan starts at the deployment block rather than block 0 and the
+                // transport serves every window between it and the head, so a bridge
+                // configured only in the first of them is still reported. The 93 block
+                // span is refused as more sub-queries than one request issues and the
+                // pagination halves it, so it arrives as two chunks of 46 blocks and
+                // the trailing block, each chunk split into windows of five.
+                name: 'returns bridges configured before the last maxBlockRange * 10 blocks',
+                pagination: { maxBlockRange: MAX_BLOCK_RANGE },
+                expectedWindows: [
+                    [8, 12],
+                    [13, 17],
+                    [18, 22],
+                    [23, 27],
+                    [28, 32],
+                    [33, 37],
+                    [38, 42],
+                    [43, 47],
+                    [48, 52],
+                    [53, 53],
+                    [54, 58],
+                    [59, 63],
+                    [64, 68],
+                    [69, 73],
+                    [74, 78],
+                    [79, 83],
+                    [84, 88],
+                    [89, 93],
+                    [94, 98],
+                    [99, 99],
+                    [100, 100],
+                ],
+                expectedBridges: [
+                    BRIDGE_ONLY_EARLY,
+                    BRIDGE_RECENT,
+                    BRIDGE_RECONFIGURED,
+                ],
+            },
+            {
+                name: 'returns every active bridge when the RPC declares no pagination',
+                pagination: undefined,
+                expectedWindows: [[8, 100]],
+                expectedBridges: [
+                    BRIDGE_ONLY_EARLY,
+                    BRIDGE_RECENT,
+                    BRIDGE_RECONFIGURED,
+                ],
+            },
+        ];
+        for (const testCase of cases) {
+            it(testCase.name, async () => {
+                const served = stubTransport();
+                const reader = createReader(testCase.pagination);
+                const bridges = await reader.readOnChainBridges(XERC20_ADDRESS, XERC20Type.Velo);
+                expect(served).to.deep.equal(testCase.expectedWindows);
+                expect(bridges).to.have.members(testCase.expectedBridges);
+            });
+        }
+        it('reads the ConfigurationChanged logs with the xERC20 scan block range', async () => {
+            const fromConfig = sinon.spy(EvmEventLogsReader, 'fromConfig');
+            const getLogsByTopic = sinon
+                .stub(EvmEventLogsReader.prototype, 'getLogsByTopic')
+                .resolves([]);
+            const reader = createReader({ maxBlockRange: MAX_BLOCK_RANGE });
+            const bridges = await reader.readOnChainBridges(XERC20_ADDRESS, XERC20Type.Velo);
+            expect(bridges).to.deep.equal([]);
+            expect(fromConfig.calledOnce).to.be.true;
+            expect(fromConfig.firstCall.args[0]).to.deep.equal({
+                chain: CHAIN_NAME,
+                paginationBlockRange: 1_000_000,
+            });
+            expect(getLogsByTopic.calledOnceWithExactly({
+                contractAddress: XERC20_ADDRESS,
+                eventTopic: CONFIGURATION_CHANGED_EVENT_SELECTOR,
+            })).to.be.true;
+        });
+        it('reads no logs for a Standard XERC20', async () => {
+            const fromConfig = sinon.spy(EvmEventLogsReader, 'fromConfig');
+            const reader = createReader({ maxBlockRange: MAX_BLOCK_RANGE });
+            const bridges = await reader.readOnChainBridges(XERC20_ADDRESS, XERC20Type.Standard);
+            expect(bridges).to.deep.equal([]);
+            expect(fromConfig.notCalled).to.be.true;
+        });
+    });
+    describe('readLimits', () => {
+        // The conversions are protected on a root-exported class, so an override is
+        // part of what the class promises. Reading through the module functions
+        // directly would leave one silently uncalled.
+        it('reports what a subclass override returns', async () => {
+            class OverridingReader extends EvmXERC20Reader {
+                toVeloLimits(rateLimit) {
+                    return {
+                        type: XERC20Type.Velo,
+                        bufferCap: `overridden-${rateLimit.bufferCap}`,
+                        rateLimitPerSecond: 'overridden',
+                    };
+                }
+            }
+            sinon
+                .stub(EvmXERC20VSAdapter.prototype, 'getRateLimits')
+                .resolves(rateLimits(7n));
+            const multiProvider = new MultiProvider({
+                [CHAIN_NAME]: {
+                    chainId: CHAIN_ID,
+                    domainId: CHAIN_ID,
+                    name: CHAIN_NAME,
+                    protocol: ProtocolType.Ethereum,
+                    rpcUrls: [{ http: RPC_URL }],
+                },
+            });
+            multiProvider.setProvider(CHAIN_NAME, new HyperlaneJsonRpcProvider({ http: RPC_URL }, { chainId: CHAIN_ID, name: CHAIN_NAME }));
+            const limits = await new OverridingReader(multiProvider, CHAIN_NAME).readLimits(XERC20_ADDRESS, [OVERRIDE_BRIDGE], XERC20Type.Velo);
+            expect(limits).to.deep.equal({
+                [OVERRIDE_BRIDGE]: {
+                    type: XERC20Type.Velo,
+                    bufferCap: 'overridden-7',
+                    rateLimitPerSecond: 'overridden',
+                },
+            });
+        });
+        // Discovery hands over every address the token ever announced, so an
+        // unbounded read opens that whole history at once against one provider.
+        const concurrencyCases = [
+            {
+                name: 'reads no more bridges at once than the chain allows',
+                configured: 3,
+                expectedPeak: 3,
+            },
+            {
+                name: 'reads one bridge at a time when the chain configures nothing',
+                expectedPeak: DEFAULT_CONTRACT_READ_CONCURRENCY,
+            },
+        ];
+        for (const testCase of concurrencyCases) {
+            it(testCase.name, async () => {
+                let inFlight = 0;
+                let peak = 0;
+                sinon
+                    .stub(EvmXERC20VSAdapter.prototype, 'getRateLimits')
+                    .callsFake(async () => {
+                    inFlight += 1;
+                    peak = Math.max(peak, inFlight);
+                    await new Promise((resolve) => setImmediate(resolve));
+                    inFlight -= 1;
+                    return rateLimits(1n);
+                });
+                const limits = await createLimitsReader(testCase.configured).readLimits(XERC20_ADDRESS, LIMIT_BRIDGES, XERC20Type.Velo);
+                expect(Object.keys(limits)).to.have.members(LIMIT_BRIDGES);
+                expect(peak).to.equal(testCase.expectedPeak);
+            });
+        }
+    });
+});
+//# sourceMappingURL=EvmXERC20Reader.test.js.map

package/dist/token/EvmXERC20Reader.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EvmXERC20Reader.test.js","sourceRoot":"","sources":["../../src/token/EvmXERC20Reader.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AACrD,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAW,YAAY,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAGlE,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,wBAAwB,EAAE,MAAM,wDAAwD,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,MAAM,+CAA+C,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAEtE,OAAO,EAAE,iCAAiC,EAAE,MAAM,0BAA0B,CAAC;AAE7E,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAGnE,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,oCAAoC,EAAE,MAAM,iBAAiB,CAAC;AAEvE,MAAM,UAAU,GAAG,gBAAgB,CAAC;AACpC,MAAM,QAAQ,GAAG,UAAU,CAAC;AAC5B,MAAM,OAAO,GAAG,iBAAiB,CAAC;AAClC,MAAM,cAAc,GAAG,4CAA4C,CAAC;AACpE,MAAM,YAAY,GAAG,GAAG,CAAC;AACzB,MAAM,eAAe,GAAG,CAAC,CAAC;AAC1B,+EAA+E;AAC/E,qDAAqD;AACrD,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAC3B,MAAM,iBAAiB,GAAG,YAAY,CAAC;AAEvC,4EAA4E;AAC5E,gEAAgE;AAChE,MAAM,iBAAiB,GAAG,4CAA4C,CAAC;AACvE,MAAM,aAAa,GAAG,4CAA4C,CAAC;AACnE,MAAM,kBAAkB,GAAG,4CAA4C,CAAC;AACxE,8CAA8C;AAC9C,MAAM,mBAAmB,GAAG,4CAA4C,CAAC;AAgBzE,SAAS,uBAAuB,CAAC,MAKhC;IACC,OAAO;QACL,OAAO,EAAE,cAAc;QACvB,SAAS,EAAE,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,CAAC;QACnE,WAAW,EAAE,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC;QAC/C,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,MAAM,CAChC,CAAC,SAAS,EAAE,SAAS,CAAC,EACtB,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,kBAAkB,CAAC,CAC9C;QACD,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,KAAK;QACd,MAAM,EAAE;YACN,oCAAoC;YACpC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,EAAE,CAAC;SAClD;QACD,eAAe,EAAE,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,CAAC;QACzE,gBAAgB,EAAE,KAAK;KACxB,CAAC;AACJ,CAAC;AAED,MAAM,kBAAkB,GAAa;IACnC,uBAAuB,CAAC;QACtB,MAAM,EAAE,iBAAiB;QACzB,SAAS,EAAE,KAAK;QAChB,kBAAkB,EAAE,EAAE;QACtB,WAAW,EAAE,EAAE;KAChB,CAAC;IACF,uBAAuB,CAAC;QACtB,MAAM,EAAE,mBAAmB;QAC3B,SAAS,EAAE,KAAK;QAChB,kBAAkB,EAAE,EAAE;QACtB,WAAW,EAAE,EAAE;KAChB,CAAC;IACF,uBAAuB,CAAC;QACtB,MAAM,EAAE,aAAa;QACrB,SAAS,EAAE,KAAK;QAChB,kBAAkB,EAAE,EAAE;QACtB,WAAW,EAAE,EAAE;KAChB,CAAC;IACF,uBAAuB,CAAC;QACtB,MAAM,EAAE,kBAAkB;QAC1B,SAAS,EAAE,KAAK;QAChB,kBAAkB,EAAE,EAAE;QACtB,WAAW,EAAE,EAAE;KAChB,CAAC;IACF,uBAAuB,CAAC;QACtB,MAAM,EAAE,mBAAmB;QAC3B,SAAS,EAAE,KAAK;QAChB,kBAAkB,EAAE,EAAE;QACtB,WAAW,EAAE,EAAE;KAChB,CAAC;IACF,uBAAuB,CAAC;QACtB,MAAM,EAAE,kBAAkB;QAC1B,SAAS,EAAE,CAAC;QACZ,kBAAkB,EAAE,CAAC;QACrB,WAAW,EAAE,EAAE;KAChB,CAAC;CACH,CAAC;AAEF,SAAS,cAAc,CAAC,GAAY;IAClC,IAAI,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,UAAU;QAAE,OAAO,GAAG,CAAC;IACvD,MAAM,CACJ,OAAO,GAAG,KAAK,QAAQ,EACvB,iCAAiC,OAAO,GAAG,EAAE,CAC9C,CAAC;IACF,OAAO,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC;AACxC,CAAC;AAED,SAAS,eAAe,CAAC,GAAa;IACpC,IAAI,GAAG,KAAK,QAAQ;QAAE,OAAO,YAAY,CAAC;IAC1C,IAAI,GAAG,KAAK,UAAU;QAAE,OAAO,CAAC,CAAC;IACjC,OAAO,GAAG,CAAC;AACb,CAAC;AAED,8EAA8E;AAC9E,8EAA8E;AAC9E,4EAA4E;AAC5E,eAAe;AACf,SAAS,aAAa;IACpB,MAAM,MAAM,GAAgC,EAAE,CAAC;IAC/C,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,SAAS,CAClE,KAAK,EACH,MAAc,EACd,MAGC,EACD,EAAE;QACF,IAAI,MAAM,KAAK,cAAc,CAAC,cAAc;YAAE,OAAO,YAAY,CAAC;QAClE,IAAI,MAAM,KAAK,cAAc,CAAC,OAAO,EAAE,CAAC;YACtC,MAAM,KAAK,GAAG,eAAe,CAAC,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC/D,OAAO,KAAK,IAAI,gBAAgB,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC;QAC9D,CAAC;QACD,IAAI,MAAM,KAAK,cAAc,CAAC,OAAO,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,qBAAqB,MAAM,EAAE,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAyB;YACnC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC;YACvC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;SACtC,CAAC;QACF,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEpB,MAAM,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7C,MAAM,OAAO,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,OAAO,kBAAkB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;YACvC,MAAM,WAAW,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC/D,OAAO,WAAW,IAAI,SAAS,IAAI,WAAW,IAAI,OAAO,CAAC;QAC5D,CAAC,CAAC,CAAC;IACL,CAAC,CACF,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,YAAY,CAAC,UAAgC;IACpD,MAAM,QAAQ,GAAkB;QAC9B,OAAO,EAAE,QAAQ;QACjB,QAAQ,EAAE,QAAQ;QAClB,IAAI,EAAE,UAAU;QAChB,QAAQ,EAAE,YAAY,CAAC,QAAQ;QAC/B,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;KACzC,CAAC;IACF,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IACpE,aAAa,CAAC,WAAW,CACvB,UAAU,EACV,IAAI,wBAAwB,CAC1B,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,EAC7B,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,CACxC,CACF,CAAC;IACF,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;AACxD,CAAC;AAED,MAAM,eAAe,GAAY,4CAA4C,CAAC;AAC9E,MAAM,aAAa,GAAc,KAAK,CAAC,IAAI,CACzC,EAAE,MAAM,EAAE,EAAE,EAAE,EACd,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAChB,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAC9D,CAAC;AAEF,SAAS,kBAAkB,CAAC,WAAoB;IAC9C,MAAM,MAAM,GAAW,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC;IACtD,MAAM,QAAQ,GAAkB;QAC9B,OAAO,EAAE,QAAQ;QACjB,QAAQ,EAAE,QAAQ;QAClB,IAAI,EAAE,UAAU;QAChB,QAAQ,EAAE,YAAY,CAAC,QAAQ;QAC/B,OAAO,EAAE,CAAC,MAAM,CAAC;KAClB,CAAC;IACF,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IACpE,aAAa,CAAC,WAAW,CACvB,UAAU,EACV,IAAI,wBAAwB,CAAC,MAAM,EAAE;QACnC,OAAO,EAAE,QAAQ;QACjB,IAAI,EAAE,UAAU;KACjB,CAAC,CACH,CAAC;IACF,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;AACxD,CAAC;AAED,SAAS,UAAU,CAAC,SAAiB;IACnC,OAAO;QACL,kBAAkB,EAAE,EAAE;QACtB,SAAS;QACT,kBAAkB,EAAE,CAAC;QACrB,YAAY,EAAE,EAAE;QAChB,QAAQ,EAAE,EAAE;KACb,CAAC;AACJ,CAAC;AAED,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,UAAU,CAAC,GAAG,EAAE;QACd,0EAA0E;QAC1E,6CAA6C;QAC7C,KAAK;aACF,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC;aACzB,OAAO,CAAC,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IAEjC,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAQlC,MAAM,KAAK,GAAqB;YAC9B;gBACE,sEAAsE;gBACtE,qEAAqE;gBACrE,uEAAuE;gBACvE,sEAAsE;gBACtE,qEAAqE;gBACrE,6DAA6D;gBAC7D,IAAI,EAAE,sEAAsE;gBAC5E,UAAU,EAAE,EAAE,aAAa,EAAE,eAAe,EAAE;gBAC9C,eAAe,EAAE;oBACf,CAAC,CAAC,EAAE,EAAE,CAAC;oBACP,CAAC,EAAE,EAAE,EAAE,CAAC;oBACR,CAAC,EAAE,EAAE,EAAE,CAAC;oBACR,CAAC,EAAE,EAAE,EAAE,CAAC;oBACR,CAAC,EAAE,EAAE,EAAE,CAAC;oBACR,CAAC,EAAE,EAAE,EAAE,CAAC;oBACR,CAAC,EAAE,EAAE,EAAE,CAAC;oBACR,CAAC,EAAE,EAAE,EAAE,CAAC;oBACR,CAAC,EAAE,EAAE,EAAE,CAAC;oBACR,CAAC,EAAE,EAAE,EAAE,CAAC;oBACR,CAAC,EAAE,EAAE,EAAE,CAAC;oBACR,CAAC,EAAE,EAAE,EAAE,CAAC;oBACR,CAAC,EAAE,EAAE,EAAE,CAAC;oBACR,CAAC,EAAE,EAAE,EAAE,CAAC;oBACR,CAAC,EAAE,EAAE,EAAE,CAAC;oBACR,CAAC,EAAE,EAAE,EAAE,CAAC;oBACR,CAAC,EAAE,EAAE,EAAE,CAAC;oBACR,CAAC,EAAE,EAAE,EAAE,CAAC;oBACR,CAAC,EAAE,EAAE,EAAE,CAAC;oBACR,CAAC,EAAE,EAAE,EAAE,CAAC;oBACR,CAAC,GAAG,EAAE,GAAG,CAAC;iBACX;gBACD,eAAe,EAAE;oBACf,iBAAiB;oBACjB,aAAa;oBACb,mBAAmB;iBACpB;aACF;YACD;gBACE,IAAI,EAAE,iEAAiE;gBACvE,UAAU,EAAE,SAAS;gBACrB,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;gBAC3B,eAAe,EAAE;oBACf,iBAAiB;oBACjB,aAAa;oBACb,mBAAmB;iBACpB;aACF;SACF,CAAC;QAEF,KAAK,MAAM,QAAQ,IAAI,KAAK,EAAE,CAAC;YAC7B,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE;gBAC3B,MAAM,MAAM,GAAG,aAAa,EAAE,CAAC;gBAC/B,MAAM,MAAM,GAAG,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBAEjD,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAC7C,cAAc,EACd,UAAU,CAAC,IAAI,CAChB,CAAC;gBAEF,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;gBACvD,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;YAC5D,CAAC,CAAC,CAAC;QACL,CAAC;QAED,EAAE,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;YACpF,MAAM,UAAU,GAAG,KAAK,CAAC,GAAG,CAAC,kBAAkB,EAAE,YAAY,CAAC,CAAC;YAC/D,MAAM,cAAc,GAAG,KAAK;iBACzB,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,gBAAgB,CAAC;iBACpD,QAAQ,CAAC,EAAE,CAAC,CAAC;YAChB,MAAM,MAAM,GAAG,YAAY,CAAC,EAAE,aAAa,EAAE,eAAe,EAAE,CAAC,CAAC;YAEhE,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAC7C,cAAc,EACd,UAAU,CAAC,IAAI,CAChB,CAAC;YAEF,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAClC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YACzC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;gBACjD,KAAK,EAAE,UAAU;gBACjB,oBAAoB,EAAE,SAAS;aAChC,CAAC,CAAC;YACH,MAAM,CACJ,cAAc,CAAC,qBAAqB,CAAC;gBACnC,eAAe,EAAE,cAAc;gBAC/B,UAAU,EAAE,oCAAoC;aACjD,CAAC,CACH,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QACf,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;YACnD,MAAM,UAAU,GAAG,KAAK,CAAC,GAAG,CAAC,kBAAkB,EAAE,YAAY,CAAC,CAAC;YAC/D,MAAM,MAAM,GAAG,YAAY,CAAC,EAAE,aAAa,EAAE,eAAe,EAAE,CAAC,CAAC;YAEhE,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAC7C,cAAc,EACd,UAAU,CAAC,QAAQ,CACpB,CAAC;YAEF,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAClC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,4EAA4E;QAC5E,wEAAwE;QACxE,8CAA8C;QAC9C,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;YACxD,MAAM,gBAAiB,SAAQ,eAAe;gBACzB,YAAY,CAC7B,SAA4B;oBAE5B,OAAO;wBACL,IAAI,EAAE,UAAU,CAAC,IAAI;wBACrB,SAAS,EAAE,cAAc,SAAS,CAAC,SAAS,EAAE;wBAC9C,kBAAkB,EAAE,YAAY;qBACjC,CAAC;gBACJ,CAAC;aACF;YAED,KAAK;iBACF,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,eAAe,CAAC;iBACnD,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;YAC5B,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC;gBACtC,CAAC,UAAU,CAAC,EAAE;oBACZ,OAAO,EAAE,QAAQ;oBACjB,QAAQ,EAAE,QAAQ;oBAClB,IAAI,EAAE,UAAU;oBAChB,QAAQ,EAAE,YAAY,CAAC,QAAQ;oBAC/B,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;iBAC7B;aACF,CAAC,CAAC;YACH,aAAa,CAAC,WAAW,CACvB,UAAU,EACV,IAAI,wBAAwB,CAC1B,EAAE,IAAI,EAAE,OAAO,EAAE,EACjB,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,CACxC,CACF,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,IAAI,gBAAgB,CACvC,aAAa,EACb,UAAU,CACX,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,eAAe,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;YAEjE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;gBAC3B,CAAC,eAAe,CAAC,EAAE;oBACjB,IAAI,EAAE,UAAU,CAAC,IAAI;oBACrB,SAAS,EAAE,cAAc;oBACzB,kBAAkB,EAAE,YAAY;iBACjC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAQH,qEAAqE;QACrE,wEAAwE;QACxE,MAAM,gBAAgB,GAAsB;YAC1C;gBACE,IAAI,EAAE,qDAAqD;gBAC3D,UAAU,EAAE,CAAC;gBACb,YAAY,EAAE,CAAC;aAChB;YACD;gBACE,IAAI,EAAE,8DAA8D;gBACpE,YAAY,EAAE,iCAAiC;aAChD;SACF,CAAC;QAEF,KAAK,MAAM,QAAQ,IAAI,gBAAgB,EAAE,CAAC;YACxC,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE;gBAC3B,IAAI,QAAQ,GAAG,CAAC,CAAC;gBACjB,IAAI,IAAI,GAAG,CAAC,CAAC;gBACb,KAAK;qBACF,IAAI,CAAC,kBAAkB,CAAC,SAAS,EAAE,eAAe,CAAC;qBACnD,SAAS,CAAC,KAAK,IAAI,EAAE;oBACpB,QAAQ,IAAI,CAAC,CAAC;oBACd,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;oBAChC,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;oBACtD,QAAQ,IAAI,CAAC,CAAC;oBACd,OAAO,UAAU,CAAC,EAAE,CAAC,CAAC;gBACxB,CAAC,CAAC,CAAC;gBAEL,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,UAAU,CACrE,cAAc,EACd,aAAa,EACb,UAAU,CAAC,IAAI,CAChB,CAAC;gBAEF,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;gBAC3D,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/token/IToken.d.ts

@@ -0,0 +1,21 @@
+import type { Address } from '@recoillink/utils';
+import type { MultiProviderAdapter } from '../providers/MultiProviderAdapter.js';
+import type { ChainName } from '../types.js';
+import type { TokenAmount } from './TokenAmount.js';
+import type { ITokenMetadata } from './ITokenMetadata.js';
+import type { TokenConnection } from './TokenConnection.js';
+import type { IHypTokenAdapter, ITokenAdapter } from './adapters/ITokenAdapter.js';
+export type { ITokenMetadata, TokenArgs } from './ITokenMetadata.js';
+export { TokenConfigSchema } from './ITokenMetadata.js';
+export interface IToken extends ITokenMetadata {
+    getConnections(): TokenConnection<IToken>[];
+    getConnectionForChain(chain: ChainName): TokenConnection<IToken> | undefined;
+    addConnection(connection: TokenConnection<IToken>): IToken;
+    removeConnection(token: IToken): IToken;
+    getAdapter(multiProvider: MultiProviderAdapter): ITokenAdapter<unknown>;
+    getHypAdapter(multiProvider: MultiProviderAdapter<{
+        mailbox?: Address;
+    }>, destination?: ChainName): IHypTokenAdapter<unknown>;
+    getBalance(multiProvider: MultiProviderAdapter, address: Address): Promise<TokenAmount<IToken>>;
+}
+//# sourceMappingURL=IToken.d.ts.map

package/dist/token/IToken.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IToken.d.ts","sourceRoot":"","sources":["../../src/token/IToken.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EACV,gBAAgB,EAChB,aAAa,EACd,MAAM,6BAA6B,CAAC;AACrC,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD,MAAM,WAAW,MAAO,SAAQ,cAAc;IAC5C,cAAc,IAAI,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;IAC5C,qBAAqB,CAAC,KAAK,EAAE,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IAC7E,aAAa,CAAC,UAAU,EAAE,eAAe,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAC3D,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IAExC,UAAU,CAAC,aAAa,EAAE,oBAAoB,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IACxE,aAAa,CACX,aAAa,EAAE,oBAAoB,CAAC;QAAE,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,EAC1D,WAAW,CAAC,EAAE,SAAS,GACtB,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAE7B,UAAU,CACR,aAAa,EAAE,oBAAoB,EACnC,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;CACjC"}

package/dist/token/IToken.js

@@ -0,0 +1,2 @@
+export { TokenConfigSchema } from './ITokenMetadata.js';
+//# sourceMappingURL=IToken.js.map

package/dist/token/IToken.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IToken.js","sourceRoot":"","sources":["../../src/token/IToken.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/token/ITokenMetadata.d.ts

@@ -0,0 +1,90 @@
+import { z } from 'zod';
+import { Address, Numberish, ProtocolType } from '@recoillink/utils';
+import type { ChainName } from '../types.js';
+import type { TokenAmount } from './TokenAmount.js';
+import { type TokenConnection } from './TokenConnection.js';
+import { TokenStandard } from './TokenStandard.js';
+export declare const TokenConfigSchema: z.ZodObject<{
+    chainName: z.ZodString;
+    standard: z.ZodEnum<typeof TokenStandard>;
+    tokenType: z.ZodOptional<z.ZodEnum<{
+        readonly synthetic: 'synthetic';
+        readonly syntheticRebase: 'syntheticRebase';
+        readonly syntheticUri: 'syntheticUri';
+        readonly collateral: 'collateral';
+        readonly collateralVault: 'collateralVault';
+        readonly collateralVaultRebase: 'collateralVaultRebase';
+        readonly XERC20: 'xERC20';
+        readonly XERC20Lockbox: 'xERC20Lockbox';
+        readonly collateralFiat: 'collateralFiat';
+        readonly collateralUri: 'collateralUri';
+        readonly collateralCctp: 'collateralCctp';
+        readonly collateralEverclear: 'collateralEverclear';
+        readonly collateralDepositAddress: 'collateralDepositAddress';
+        readonly collateralOft: 'collateralOft';
+        readonly atomicLocalRebalancing: 'atomicLocalRebalancing';
+        readonly native: 'native';
+        readonly nativeOpL2: 'nativeOpL2';
+        readonly nativeOpL1: 'nativeOpL1';
+        readonly ethEverclear: 'ethEverclear';
+        readonly nativeScaled: 'nativeScaled';
+        readonly crossCollateral: 'crossCollateral';
+        readonly unknown: 'unknown';
+    }>>;
+    decimals: z.ZodNumber;
+    symbol: z.ZodString;
+    name: z.ZodString;
+    addressOrDenom: z.ZodPipe<z.ZodNullable<z.ZodString>, z.ZodTransform<string, string | null>>;
+    collateralAddressOrDenom: z.ZodOptional<z.ZodString>;
+    igpTokenAddressOrDenom: z.ZodOptional<z.ZodString>;
+    logoURI: z.ZodOptional<z.ZodString>;
+    connections: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodUnion<[z.ZodObject<{
+        type: z.ZodOptional<z.ZodLiteral<import("./TokenConnection.js").TokenConnectionType.Hyperlane>>;
+        token: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<import("./TokenConnection.js").TokenConnectionType.Ibc>;
+        token: z.ZodString;
+        sourcePort: z.ZodString;
+        sourceChannel: z.ZodString;
+    }, z.core.$strip>]>, z.ZodObject<{
+        type: z.ZodLiteral<import("./TokenConnection.js").TokenConnectionType.IbcHyperlane>;
+        token: z.ZodString;
+        sourcePort: z.ZodString;
+        sourceChannel: z.ZodString;
+        intermediateChainName: z.ZodString;
+        intermediateIbcDenom: z.ZodString;
+        intermediateRouterAddress: z.ZodString;
+    }, z.core.$strip>]>>>;
+    coinGeckoId: z.ZodOptional<z.ZodString>;
+    scale: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodObject<{
+        numerator: z.ZodNumber;
+        denominator: z.ZodNumber;
+    }, z.core.$strip>, z.ZodObject<{
+        numerator: z.ZodPipe<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, z.ZodTransform<bigint, string | number | bigint>>;
+        denominator: z.ZodPipe<z.ZodUnion<[z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, z.ZodString]>, z.ZodTransform<bigint, string | number | bigint>>;
+    }, z.core.$strip>]>>;
+    warpRouteId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type TokenArgs = Omit<z.infer<typeof TokenConfigSchema>, 'addressOrDenom' | 'connections'> & {
+    addressOrDenom: Address | string;
+    connections?: Array<TokenConnection>;
+};
+export interface ITokenMetadata extends TokenArgs {
+    protocol: ProtocolType;
+    amount(amount: Numberish): TokenAmount<this>;
+    isNft(): boolean;
+    isNative(): boolean;
+    isHypNative(): boolean;
+    isCollateralized(): boolean;
+    isHypToken(): boolean;
+    isIbcToken(): boolean;
+    isMultiChainToken(): boolean;
+    isCrossCollateralToken(): boolean;
+    getConnections(): TokenConnection[];
+    getConnectionForChain(chain: ChainName): TokenConnection | undefined;
+    addConnection(connection: TokenConnection): ITokenMetadata;
+    removeConnection(token: ITokenMetadata): ITokenMetadata;
+    equals(token?: ITokenMetadata): boolean;
+    isFungibleWith(token?: ITokenMetadata): boolean;
+}
+//# sourceMappingURL=ITokenMetadata.d.ts.map

package/dist/token/ITokenMetadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITokenMetadata.d.ts","sourceRoot":"","sources":["../../src/token/ITokenMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGrE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EACL,KAAK,eAAe,EAErB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAMnD,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAqD5B,CAAC;AAEH,MAAM,MAAM,SAAS,GAAG,IAAI,CAC1B,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,EACjC,gBAAgB,GAAG,aAAa,CACjC,GAAG;IACF,cAAc,EAAE,OAAO,GAAG,MAAM,CAAC;IACjC,WAAW,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;CACtC,CAAC;AAEF,MAAM,WAAW,cAAe,SAAQ,SAAS;IAC/C,QAAQ,EAAE,YAAY,CAAC;IAEvB,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAE7C,KAAK,IAAI,OAAO,CAAC;IACjB,QAAQ,IAAI,OAAO,CAAC;IACpB,WAAW,IAAI,OAAO,CAAC;IACvB,gBAAgB,IAAI,OAAO,CAAC;IAC5B,UAAU,IAAI,OAAO,CAAC;IACtB,UAAU,IAAI,OAAO,CAAC;IACtB,iBAAiB,IAAI,OAAO,CAAC;IAC7B,sBAAsB,IAAI,OAAO,CAAC;IAElC,cAAc,IAAI,eAAe,EAAE,CAAC;IAEpC,qBAAqB,CAAC,KAAK,EAAE,SAAS,GAAG,eAAe,GAAG,SAAS,CAAC;IACrE,aAAa,CAAC,UAAU,EAAE,eAAe,GAAG,cAAc,CAAC;IAC3D,gBAAgB,CAAC,KAAK,EAAE,cAAc,GAAG,cAAc,CAAC;IAExD,MAAM,CAAC,KAAK,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC;IACxC,cAAc,CAAC,KAAK,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC;CACjD"}