@recoillink/sdk 0.0.0-stage → 45.0.1

package/dist/gas/token-prices.test.js

@@ -0,0 +1,96 @@
+import { expect } from 'chai';
+import sinon from 'sinon';
+import { TestChainName, testChainMetadata } from '../consts/testChains.js';
+import { CoinGeckoTokenPriceGetter } from './token-prices.js';
+const MOCK_FETCH_CALLS = true;
+const ethereum = {};
+const solanamainnet = {};
+describe('TokenPriceGetter', () => {
+    let tokenPriceGetter;
+    const chainA = TestChainName.test1;
+    const chainB = TestChainName.test2;
+    const priceA = 2;
+    const priceB = 5;
+    let stub;
+    beforeEach(() => {
+        tokenPriceGetter = new CoinGeckoTokenPriceGetter({
+            // @ts-ignore TODO: remove once merged with main
+            chainMetadata: { ethereum, solanamainnet, ...testChainMetadata },
+            apiKey: 'test',
+            expirySeconds: 10,
+            sleepMsBetweenRequests: 10,
+        });
+        if (MOCK_FETCH_CALLS) {
+            stub = sinon
+                .stub(tokenPriceGetter, 'fetchPriceData')
+                .returns(Promise.resolve([priceA, priceB]));
+        }
+    });
+    afterEach(() => {
+        if (MOCK_FETCH_CALLS && stub) {
+            stub.restore();
+        }
+    });
+    describe('getTokenPriceByIds', () => {
+        it('returns token prices', async () => {
+            // stubbed results
+            expect(await tokenPriceGetter.getTokenPriceByIds(['ethereum', 'solana'])).to.eql([priceA, priceB]);
+        });
+    });
+    describe('getTokenPrice', () => {
+        it('returns a token price', async () => {
+            // hardcoded result of 1 for testnets
+            expect(await tokenPriceGetter.getTokenPrice(TestChainName.test1)).to.equal(1);
+            // stubbed result for non-testnet
+            expect(await tokenPriceGetter.getTokenPrice('ethereum')).to.equal(priceA);
+        });
+    });
+    describe('getTokenExchangeRate', () => {
+        it('returns a value consistent with getTokenPrice()', async () => {
+            // hardcoded result of 1 for testnets
+            expect(await tokenPriceGetter.getTokenExchangeRate(chainA, chainB)).to.equal(1);
+            // stubbed result for non-testnet
+            expect(await tokenPriceGetter.getTokenExchangeRate('ethereum', 'solanamainnet')).to.equal(priceA / priceB);
+        });
+    });
+    describe('prefetchTokenPrices / getCachedTokenPrice', () => {
+        let fetchStub;
+        afterEach(() => {
+            fetchStub?.restore();
+        });
+        it('warms the cache in one deduped batched pass', async () => {
+            fetchStub = sinon.stub(globalThis, 'fetch').resolves(new Response(JSON.stringify({
+                ethereum: { usd: 1900 },
+                bitcoin: { usd: 64000 },
+            }), { status: 200 }));
+            await tokenPriceGetter.prefetchTokenPrices([
+                'ethereum',
+                'bitcoin',
+                'ethereum',
+            ]);
+            expect(fetchStub.callCount).to.equal(1);
+            expect(tokenPriceGetter.getCachedTokenPrice('ethereum')).to.equal(1900);
+            expect(tokenPriceGetter.getCachedTokenPrice('bitcoin')).to.equal(64000);
+        });
+        it('skips ids with no returned price instead of dropping the batch', async () => {
+            fetchStub = sinon.stub(globalThis, 'fetch').resolves(new Response(JSON.stringify({ ethereum: { usd: 1900 } }), {
+                status: 200,
+            }));
+            await tokenPriceGetter.prefetchTokenPrices(['ethereum', 'unknown-token']);
+            expect(tokenPriceGetter.getCachedTokenPrice('ethereum')).to.equal(1900);
+            expect(tokenPriceGetter.getCachedTokenPrice('unknown-token')).to.equal(undefined);
+        });
+        it('chunks id lists that exceed the per-call limit', async () => {
+            // A list longer than the per-call cap must be split across requests
+            // rather than sent as one oversized (and rejected) batch.
+            fetchStub = sinon
+                .stub(globalThis, 'fetch')
+                .callsFake(async () => new Response(JSON.stringify({}), { status: 200 }));
+            const ids = Array.from({ length: 150 }, (_, i) => `id-${i}`);
+            await tokenPriceGetter.prefetchTokenPrices(ids);
+            // 150 ids at a 100-per-call cap => 2 requests.
+            expect(fetchStub.callCount).to.equal(2);
+        });
+    });
+});
+//# sourceMappingURL=token-prices.test.js.map

package/dist/gas/token-prices.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"token-prices.test.js","sourceRoot":"","sources":["../../src/gas/token-prices.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAE3E,OAAO,EAAE,yBAAyB,EAAE,MAAM,mBAAmB,CAAC;AAE9D,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAE9B,MAAM,QAAQ,GAAsB,EAAE,CAAC;AACvC,MAAM,aAAa,GAAsB,EAAE,CAAC;AAE5C,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,IAAI,gBAA2C,CAAC;IAEhD,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC;IACnC,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC;IACnC,MAAM,MAAM,GAAG,CAAC,CAAC;IACjB,MAAM,MAAM,GAAG,CAAC,CAAC;IACjB,IAAI,IAAqB,CAAC;IAE1B,UAAU,CAAC,GAAG,EAAE;QACd,gBAAgB,GAAG,IAAI,yBAAyB,CAAC;YAC/C,gDAAgD;YAChD,aAAa,EAAE,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,iBAAiB,EAAE;YAChE,MAAM,EAAE,MAAM;YACd,aAAa,EAAE,EAAE;YACjB,sBAAsB,EAAE,EAAE;SAC3B,CAAC,CAAC;QAEH,IAAI,gBAAgB,EAAE,CAAC;YACrB,IAAI,GAAG,KAAK;iBACT,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;iBACxC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;QAChD,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,gBAAgB,IAAI,IAAI,EAAE,CAAC;YAC7B,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,EAAE,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;YACpC,kBAAkB;YAClB,MAAM,CACJ,MAAM,gBAAgB,CAAC,kBAAkB,CAAC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAClE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,EAAE,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;YACrC,qCAAqC;YACrC,MAAM,CACJ,MAAM,gBAAgB,CAAC,aAAa,CAAC,aAAa,CAAC,KAAK,CAAC,CAC1D,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACd,iCAAiC;YACjC,MAAM,CAAC,MAAM,gBAAgB,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QACpC,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;YAC/D,qCAAqC;YACrC,MAAM,CACJ,MAAM,gBAAgB,CAAC,oBAAoB,CAAC,MAAM,EAAE,MAAM,CAAC,CAC5D,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAEd,iCAAiC;YACjC,MAAM,CACJ,MAAM,gBAAgB,CAAC,oBAAoB,CACzC,UAAU,EACV,eAAe,CAChB,CACF,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACzD,IAAI,SAA0B,CAAC;QAE/B,SAAS,CAAC,GAAG,EAAE;YACb,SAAS,EAAE,OAAO,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;YAC3D,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,QAAQ,CAClD,IAAI,QAAQ,CACV,IAAI,CAAC,SAAS,CAAC;gBACb,QAAQ,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE;gBACvB,OAAO,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE;aACxB,CAAC,EACF,EAAE,MAAM,EAAE,GAAG,EAAE,CAChB,CACF,CAAC;YAEF,MAAM,gBAAgB,CAAC,mBAAmB,CAAC;gBACzC,UAAU;gBACV,SAAS;gBACT,UAAU;aACX,CAAC,CAAC;YAEH,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACxC,MAAM,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACxE,MAAM,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;YAC9E,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,QAAQ,CAClD,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE;gBACxD,MAAM,EAAE,GAAG;aACZ,CAAC,CACH,CAAC;YAEF,MAAM,gBAAgB,CAAC,mBAAmB,CAAC,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC,CAAC;YAE1E,MAAM,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACxE,MAAM,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CACpE,SAAS,CACV,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;YAC9D,oEAAoE;YACpE,0DAA0D;YAC1D,SAAS,GAAG,KAAK;iBACd,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC;iBACzB,SAAS,CACR,KAAK,IAAI,EAAE,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAC9D,CAAC;YAEJ,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAC7D,MAAM,gBAAgB,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;YAEhD,+CAA+C;YAC/C,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/gas/types.d.ts

@@ -0,0 +1,50 @@
+import { BigNumber } from 'ethers';
+import { z } from 'zod';
+import { InterchainGasPaymaster } from '@recoillink/core';
+import type { Address } from '@recoillink/utils';
+import type { CheckerViolation } from '../deploy/types.js';
+import { IgpSchema, IgpVersion } from '../hook/types.js';
+import { ChainMap, ChainName } from '../types.js';
+export type IgpConfig = z.infer<typeof IgpSchema>;
+export declare function igpSupportsOffchainFeeQuoting({ igpVersion, contractVersion, quoteSigners, }: {
+    igpVersion?: IgpVersion;
+    contractVersion?: string;
+    quoteSigners?: string[];
+}): boolean;
+export declare function assertTokenOracleConfigHasNativeRemotes(chain: ChainName, config: Pick<IgpConfig, 'overhead' | 'tokenOracleConfig'>): void;
+export declare enum IgpViolationType {
+    Beneficiary = "Beneficiary",
+    GasOracles = "GasOracles",
+    Overhead = "Overhead",
+    TokenGasOracles = "TokenGasOracles"
+}
+export interface IgpViolation extends CheckerViolation {
+    type: 'InterchainGasPaymaster';
+    subType: IgpViolationType;
+}
+export interface IgpBeneficiaryViolation extends IgpViolation {
+    subType: IgpViolationType.Beneficiary;
+    contract: InterchainGasPaymaster;
+    actual: Address;
+    expected: Address;
+}
+export interface IgpGasOraclesViolation extends IgpViolation {
+    subType: IgpViolationType.GasOracles;
+    contract: InterchainGasPaymaster;
+    actual: ChainMap<Address>;
+    expected: ChainMap<Address>;
+}
+export interface IgpOverheadViolation extends IgpViolation {
+    subType: IgpViolationType.Overhead;
+    contract: InterchainGasPaymaster;
+    actual: ChainMap<BigNumber>;
+    expected: ChainMap<BigNumber>;
+}
+export interface IgpTokenGasOraclesViolation extends IgpViolation {
+    subType: IgpViolationType.TokenGasOracles;
+    contract: InterchainGasPaymaster;
+    actual: ChainMap<Address>;
+    expected: ChainMap<Address>;
+    feeToken: Address;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/gas/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/gas/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAG1D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EACL,SAAS,EACT,UAAU,EAEX,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAElD,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAC;AAElD,wBAAgB,6BAA6B,CAAC,EAC5C,UAAU,EACV,eAAe,EACf,YAAY,GACb,EAAE;IACD,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,GAAG,OAAO,CAOV;AAED,wBAAgB,uCAAuC,CACrD,KAAK,EAAE,SAAS,EAChB,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,UAAU,GAAG,mBAAmB,CAAC,GACxD,IAAI,CAiBN;AAED,oBAAY,gBAAgB;IAC1B,WAAW,gBAAgB;IAC3B,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,eAAe,oBAAoB;CACpC;AAED,MAAM,WAAW,YAAa,SAAQ,gBAAgB;IACpD,IAAI,EAAE,wBAAwB,CAAC;IAC/B,OAAO,EAAE,gBAAgB,CAAC;CAC3B;AAED,MAAM,WAAW,uBAAwB,SAAQ,YAAY;IAC3D,OAAO,EAAE,gBAAgB,CAAC,WAAW,CAAC;IACtC,QAAQ,EAAE,sBAAsB,CAAC;IACjC,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,sBAAuB,SAAQ,YAAY;IAC1D,OAAO,EAAE,gBAAgB,CAAC,UAAU,CAAC;IACrC,QAAQ,EAAE,sBAAsB,CAAC;IACjC,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC1B,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACxD,OAAO,EAAE,gBAAgB,CAAC,QAAQ,CAAC;IACnC,QAAQ,EAAE,sBAAsB,CAAC;IACjC,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;IAC5B,QAAQ,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,2BAA4B,SAAQ,YAAY;IAC/D,OAAO,EAAE,gBAAgB,CAAC,eAAe,CAAC;IAC1C,QAAQ,EAAE,sBAAsB,CAAC;IACjC,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC1B,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC5B,QAAQ,EAAE,OAAO,CAAC;CACnB"}

package/dist/gas/types.js

@@ -0,0 +1,26 @@
+import { assert } from '@recoillink/utils';
+import { compareVersions } from 'compare-versions';
+import { IgpVersion, OFFCHAIN_QUOTED_IGP_VERSION, } from '../hook/types.js';
+export function igpSupportsOffchainFeeQuoting({ igpVersion, contractVersion, quoteSigners, }) {
+    return (igpVersion !== IgpVersion.Legacy &&
+        (quoteSigners !== undefined ||
+            (contractVersion !== undefined &&
+                compareVersions(contractVersion, OFFCHAIN_QUOTED_IGP_VERSION) >= 0)));
+}
+export function assertTokenOracleConfigHasNativeRemotes(chain, config) {
+    if (!config.tokenOracleConfig)
+        return;
+    const configuredNativeRemotes = new Set(Object.keys(config.overhead));
+    for (const [feeToken, oracleConfig] of Object.entries(config.tokenOracleConfig)) {
+        const missingNativeRemotes = Object.keys(oracleConfig).filter((remote) => !configuredNativeRemotes.has(remote));
+        assert(missingNativeRemotes.length === 0, `Token gas oracle config for ${feeToken} on ${chain} includes remotes without native gas oracle config: ${missingNativeRemotes.join(', ')}`);
+    }
+}
+export var IgpViolationType;
+(function (IgpViolationType) {
+    IgpViolationType["Beneficiary"] = "Beneficiary";
+    IgpViolationType["GasOracles"] = "GasOracles";
+    IgpViolationType["Overhead"] = "Overhead";
+    IgpViolationType["TokenGasOracles"] = "TokenGasOracles";
+})(IgpViolationType || (IgpViolationType = {}));
+//# sourceMappingURL=types.js.map

package/dist/gas/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/gas/types.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAInD,OAAO,EAEL,UAAU,EACV,2BAA2B,GAC5B,MAAM,kBAAkB,CAAC;AAK1B,MAAM,UAAU,6BAA6B,CAAC,EAC5C,UAAU,EACV,eAAe,EACf,YAAY,GAKb;IACC,OAAO,CACL,UAAU,KAAK,UAAU,CAAC,MAAM;QAChC,CAAC,YAAY,KAAK,SAAS;YACzB,CAAC,eAAe,KAAK,SAAS;gBAC5B,eAAe,CAAC,eAAe,EAAE,2BAA2B,CAAC,IAAI,CAAC,CAAC,CAAC,CACzE,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,uCAAuC,CACrD,KAAgB,EAChB,MAAyD;IAEzD,IAAI,CAAC,MAAM,CAAC,iBAAiB;QAAE,OAAO;IAEtC,MAAM,uBAAuB,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IACtE,KAAK,MAAM,CAAC,QAAQ,EAAE,YAAY,CAAC,IAAI,MAAM,CAAC,OAAO,CACnD,MAAM,CAAC,iBAAiB,CACzB,EAAE,CAAC;QACF,MAAM,oBAAoB,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,CAC3D,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,uBAAuB,CAAC,GAAG,CAAC,MAAM,CAAC,CACjD,CAAC;QACF,MAAM,CACJ,oBAAoB,CAAC,MAAM,KAAK,CAAC,EACjC,+BAA+B,QAAQ,OAAO,KAAK,uDAAuD,oBAAoB,CAAC,IAAI,CACjI,IAAI,CACL,EAAE,CACJ,CAAC;IACJ,CAAC;AACH,CAAC;AAED,MAAM,CAAN,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,6CAAyB,CAAA;IACzB,yCAAqB,CAAA;IACrB,uDAAmC,CAAA;AACrC,CAAC,EALW,gBAAgB,KAAhB,gBAAgB,QAK3B"}

package/dist/gas/utils.d.ts

@@ -0,0 +1,34 @@
+import { BigNumber as BigNumberJs } from 'bignumber.js';
+import { ProtocolType } from '@recoillink/utils';
+import { ChainMetadataManager } from '../metadata/ChainMetadataManager.js';
+import { AgentCosmosGasPrice } from '../metadata/agentConfig.js';
+import type { MultiProviderAdapter } from '../providers/MultiProviderAdapter.js';
+import { ChainMap, ChainName } from '../types.js';
+import { IgpCostData, ProtocolAgnositicGasOracleConfig } from './oracle/types.js';
+export interface GasPriceConfig {
+    amount: string;
+    decimals: number;
+}
+export interface NativeTokenPriceConfig {
+    price: string;
+    decimals: number;
+}
+export interface ChainGasOracleParams {
+    gasPrice: GasPriceConfig;
+    nativeToken: NativeTokenPriceConfig;
+}
+export declare function getGasPrice(mpp: MultiProviderAdapter, chain: string): Promise<GasPriceConfig>;
+export declare function getCosmosChainGasPrice(chain: ChainName, chainMetadataManager: ChainMetadataManager): Promise<AgentCosmosGasPrice>;
+export declare function getLocalStorageGasOracleConfig({ local, localProtocolType, gasOracleParams, exchangeRateMarginPct, gasPriceModifier, typicalCostGetter, onPrecisionFallback, }: {
+    local: ChainName;
+    localProtocolType: ProtocolType;
+    gasOracleParams: ChainMap<ChainGasOracleParams>;
+    exchangeRateMarginPct: number;
+    gasPriceModifier?: (local: ChainName, remote: ChainName, gasOracleConfig: ProtocolAgnositicGasOracleConfig) => Parameters<typeof BigNumberJs>[0];
+    typicalCostGetter?: (local: ChainName, remote: ChainName, gasOracleConfig: ProtocolAgnositicGasOracleConfig) => IgpCostData;
+    onPrecisionFallback?: (ctx: {
+        local: ChainName;
+        remote: ChainName;
+    }) => void;
+}): ChainMap<ProtocolAgnositicGasOracleConfig>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/gas/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/gas/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,IAAI,WAAW,EAAE,MAAM,cAAc,CAAC;AAGxD,OAAO,EACL,YAAY,EAKb,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGlD,OAAO,EACL,WAAW,EACX,gCAAgC,EAEjC,MAAM,mBAAmB,CAAC;AAE3B,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,cAAc,CAAC;IACzB,WAAW,EAAE,sBAAsB,CAAC;CACrC;AAED,wBAAsB,WAAW,CAC/B,GAAG,EAAE,oBAAoB,EACzB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,cAAc,CAAC,CA6BzB;AAGD,wBAAsB,sBAAsB,CAC1C,KAAK,EAAE,SAAS,EAChB,oBAAoB,EAAE,oBAAoB,GACzC,OAAO,CAAC,mBAAmB,CAAC,CAoD9B;AAuDD,wBAAgB,8BAA8B,CAAC,EAC7C,KAAK,EACL,iBAAiB,EACjB,eAAe,EACf,qBAAqB,EACrB,gBAAgB,EAChB,iBAAiB,EACjB,mBAAmB,GACpB,EAAE;IACD,KAAK,EAAE,SAAS,CAAC;IACjB,iBAAiB,EAAE,YAAY,CAAC;IAChC,eAAe,EAAE,QAAQ,CAAC,oBAAoB,CAAC,CAAC;IAChD,qBAAqB,EAAE,MAAM,CAAC;IAC9B,gBAAgB,CAAC,EAAE,CACjB,KAAK,EAAE,SAAS,EAChB,MAAM,EAAE,SAAS,EACjB,eAAe,EAAE,gCAAgC,KAC9C,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IACvC,iBAAiB,CAAC,EAAE,CAClB,KAAK,EAAE,SAAS,EAChB,MAAM,EAAE,SAAS,EACjB,eAAe,EAAE,gCAAgC,KAC9C,WAAW,CAAC;IAIjB,mBAAmB,CAAC,EAAE,CAAC,GAAG,EAAE;QAAE,KAAK,EAAE,SAAS,CAAC;QAAC,MAAM,EAAE,SAAS,CAAA;KAAE,KAAK,IAAI,CAAC;CAC9E,GAAG,QAAQ,CAAC,gCAAgC,CAAC,CAiF7C"}

package/dist/gas/utils.js

@@ -0,0 +1,246 @@
+import { BigNumber as BigNumberJs } from 'bignumber.js';
+import { ethers } from 'ethers';
+import { ProtocolType, assert, convertDecimals, objMap, rootLogger, } from '@recoillink/utils';
+import { getProtocolExchangeRateDecimals } from '../consts/igp.js';
+import { getCosmosRegistryChain } from '../utils/cosmos.js';
+export async function getGasPrice(mpp, chain) {
+    const protocolType = mpp.getProtocol(chain);
+    switch (protocolType) {
+        case ProtocolType.Tron:
+        case ProtocolType.Ethereum: {
+            const provider = mpp.getProvider(chain);
+            const gasPrice = await provider.provider.getGasPrice();
+            return {
+                amount: ethers.utils.formatUnits(gasPrice, 'gwei'),
+                decimals: 9,
+            };
+        }
+        case ProtocolType.Cosmos:
+        case ProtocolType.CosmosNative: {
+            const { amount } = await getCosmosChainGasPrice(chain, mpp);
+            return {
+                amount,
+                decimals: 1,
+            };
+        }
+        case ProtocolType.Sealevel:
+            // TODO get a reasonable value
+            return {
+                amount: '0.001',
+                decimals: 9,
+            };
+        default:
+            throw new Error(`Unsupported protocol type: ${protocolType}`);
+    }
+}
+// Gets the gas price for a Cosmos chain
+export async function getCosmosChainGasPrice(chain, chainMetadataManager) {
+    const metadata = chainMetadataManager.getChainMetadata(chain);
+    if (!metadata) {
+        throw new Error(`No metadata found for Cosmos chain ${chain}`);
+    }
+    if (metadata.protocol !== ProtocolType.Cosmos &&
+        metadata.protocol !== ProtocolType.CosmosNative) {
+        throw new Error(`Chain ${chain} is not a Cosmos chain`);
+    }
+    // Use the cosmos registry gas price first.
+    let cosmosRegistryChain;
+    try {
+        cosmosRegistryChain = await getCosmosRegistryChain(chain);
+    }
+    catch (err) {
+        // Fallback to our registry gas price from the metadata.
+        if (metadata.gasPrice) {
+            return metadata.gasPrice;
+        }
+        throw new Error(`No gas price found for Cosmos chain ${chain} in the registry or metadata`, {
+            cause: err,
+        });
+    }
+    const nativeToken = metadata.nativeToken;
+    if (!nativeToken) {
+        throw new Error(`No native token found for Cosmos chain ${chain}`);
+    }
+    if (!nativeToken.denom) {
+        throw new Error(`No denom found for native token on Cosmos chain ${chain}`);
+    }
+    const fee = cosmosRegistryChain.fees?.fee_tokens.find((fee) => {
+        return (fee.denom === nativeToken.denom || fee.denom === `u${nativeToken.denom}`);
+    });
+    if (!fee || fee.average_gas_price === undefined) {
+        throw new Error(`No gas price found for Cosmos chain ${chain}`);
+    }
+    return {
+        denom: fee.denom,
+        amount: fee.average_gas_price.toString(),
+    };
+}
+// Gets the exchange rate of the remote quoted in local tokens, not accounting for decimals.
+function getTokenExchangeRate({ local, remote, tokenPrices, exchangeRateMarginPct, }) {
+    // Workaround for chicken-egg dependency problem.
+    // We need to provide some default value here to satisfy the config on initial load,
+    // whilst knowing that it will get overwritten when a script actually gets run.
+    const defaultValue = '1';
+    const localValue = new BigNumberJs(tokenPrices[local] ?? defaultValue);
+    const remoteValue = new BigNumberJs(tokenPrices[remote] ?? defaultValue);
+    // Note this does not account for decimals!
+    let exchangeRate = remoteValue.div(localValue);
+    // Apply the premium
+    exchangeRate = exchangeRate.times(100 + exchangeRateMarginPct).div(100);
+    assert(exchangeRate.isGreaterThan(0), 'Exchange rate must be greater than 0, possible loss of precision');
+    return exchangeRate;
+}
+// Scales the (decimal-adjusted) exchange rate by the protocol's fixed-point
+// multiplier. Returns a float that may be < 1 (e.g. for a low-decimal fee token
+// paying for a high-decimal native chain); rounding to an integer and any
+// precision rebalancing against the gas price happen later in
+// adjustForPrecisionLoss.
+function scaleProtocolExchangeRate(localProtocolType, exchangeRate) {
+    const multiplierDecimals = getProtocolExchangeRateDecimals(localProtocolType);
+    return exchangeRate.times(new BigNumberJs(10).pow(multiplierDecimals));
+}
+// Gets the StorageGasOracleConfig for each remote chain for a particular local chain.
+// Accommodates small non-integer gas prices by scaling up the gas price
+// and scaling down the exchange rate by the same factor.
+// A gasPriceModifier can be supplied to adjust the gas price based on a prospective
+// gasOracleConfig.
+// Values take into consideration the local chain's needs depending on the protocol type,
+// e.g. the expected decimals of the token exchange rate, or whether to account for
+// a native token decimal difference in the exchange rate.
+// Therefore the values here can be applied directly to the chain's gas oracle.
+export function getLocalStorageGasOracleConfig({ local, localProtocolType, gasOracleParams, exchangeRateMarginPct, gasPriceModifier, typicalCostGetter, onPrecisionFallback, }) {
+    const remotes = Object.keys(gasOracleParams).filter((remote) => remote !== local);
+    const tokenPrices = objMap(gasOracleParams, (chain) => gasOracleParams[chain].nativeToken.price);
+    const localDecimals = gasOracleParams[local].nativeToken.decimals;
+    return remotes.reduce((agg, remote) => {
+        const remoteDecimals = gasOracleParams[remote].nativeToken.decimals;
+        // The exchange rate, not yet accounting for decimals, and potentially
+        // floating point.
+        let exchangeRateFloat = getTokenExchangeRate({
+            local,
+            remote,
+            tokenPrices,
+            exchangeRateMarginPct,
+        });
+        if (localProtocolType !== ProtocolType.Sealevel) {
+            // On all chains other than Sealevel, we need to adjust the exchange rate for decimals.
+            exchangeRateFloat = convertDecimals(remoteDecimals, localDecimals, exchangeRateFloat);
+        }
+        // Scale the exchange rate by the protocol's fixed-point factor. Kept as a
+        // float here; adjustForPrecisionLoss does the final integer rounding (and
+        // rebalances against the gas price if it would otherwise underflow).
+        const scaledExchangeRate = scaleProtocolExchangeRate(localProtocolType, exchangeRateFloat);
+        // First parse the gas price as a number, so we have floating point precision.
+        // Recall it's possible to have gas prices that are not integers, even
+        // after converting to the "wei" version of the token.
+        const gasPrice = new BigNumberJs(gasOracleParams[remote].gasPrice.amount).times(new BigNumberJs(10).pow(gasOracleParams[remote].gasPrice.decimals));
+        if (gasPrice.isNaN()) {
+            throw new Error(`Invalid gas price for chain ${remote}: ${gasOracleParams[remote].gasPrice.amount}`);
+        }
+        // Get a prospective gasOracleConfig, adjusting the gas price and exchange rate
+        // as needed to account for precision loss (e.g. if the gas price is super small).
+        let gasOracleConfig = adjustForPrecisionLoss(gasPrice, scaledExchangeRate, remoteDecimals, {
+            local,
+            remote,
+            onFallback: onPrecisionFallback,
+        });
+        // Apply the modifier if provided.
+        if (gasPriceModifier) {
+            // Once again adjust for precision loss after applying the modifier.
+            gasOracleConfig = adjustForPrecisionLoss(gasPriceModifier(local, remote, gasOracleConfig), new BigNumberJs(gasOracleConfig.tokenExchangeRate), remoteDecimals, { local, remote, onFallback: onPrecisionFallback });
+        }
+        if (typicalCostGetter) {
+            gasOracleConfig.typicalCost = typicalCostGetter(local, remote, gasOracleConfig);
+        }
+        return {
+            ...agg,
+            [remote]: gasOracleConfig,
+        };
+    }, {});
+}
+// Floor for the gas price after rebalancing a sub-unit exchange rate. Because
+// the final gas price is ceiled, keeping the rebalanced value at least 1000
+// bounds the relative quote error from that ceil to < 1 / 1000 = 0.1%.
+const MIN_REBALANCED_GAS_PRICE = 1000;
+function decimalMagnitude(value) {
+    if (value.lt(1))
+        return 0;
+    return value.integerValue(BigNumberJs.ROUND_FLOOR).toFixed(0).length - 1;
+}
+function adjustForPrecisionLoss(gasPrice, exchangeRate, remoteDecimals, 
+// Optional chain context. `local`/`remote` name the pair that underflowed so
+// the warning is actionable. If `onFallback` is supplied, it is invoked
+// instead of logging per-pair — letting callers aggregate the fallbacks into a
+// single summary rather than emitting one warning per chain pair.
+context) {
+    let newGasPrice = new BigNumberJs(gasPrice);
+    let newExchangeRate = exchangeRate;
+    // When the fee token has fewer decimals than the remote native token (e.g. a
+    // 6-decimal ERC20 fee token paying for an 18-decimal native chain), decimal
+    // conversion can push the scaled exchange rate below 1, where rounding to an
+    // integer would badly misprice (or zero out) the quote. The quote is the
+    // product gasPrice * exchangeRate, so shift magnitude from the gas price into
+    // the exchange rate by a power of ten: the product (and thus the quote) is
+    // preserved while the on-chain exchange rate keeps its precision. No-op for
+    // same-decimal native pairs, where the scaled rate is already >> 1.
+    if (newExchangeRate.lt(1)) {
+        const shiftMagnitude = decimalMagnitude(newGasPrice.div(MIN_REBALANCED_GAS_PRICE));
+        if (shiftMagnitude > 0) {
+            const factor = new BigNumberJs(10).pow(shiftMagnitude);
+            newExchangeRate = newExchangeRate.times(factor);
+            newGasPrice = newGasPrice.div(factor);
+        }
+        if (newExchangeRate.lt(1)) {
+            // Known limitation: gas prices below 10 * MIN_REBALANCED_GAS_PRICE do
+            // not have a full decimal digit of headroom to shift while preserving the
+            // final ceil rounding-error bound. In that no-headroom band, keep the
+            // original gas price and fall back to the minimum representable exchange
+            // rate instead of introducing a larger ceil error.
+            // When a caller wants to aggregate these (they can be many for a full
+            // chain matrix), hand off to its callback instead of logging per-pair.
+            if (context?.onFallback) {
+                context.onFallback({ local: context.local, remote: context.remote });
+            }
+            else {
+                rootLogger.warn(`Token exchange rate remains below 1 after precision rebalance${context ? ` for ${context.local} -> ${context.remote}` : ''}; falling back to minimum on-chain exchange rate. Original gas price: ${new BigNumberJs(gasPrice).toString()}, original exchange rate: ${exchangeRate.toString()}`);
+            }
+        }
+    }
+    // We may have very little precision, and ultimately need an integer value for
+    // the gas price that will be set on-chain. If this is the case, we scale up the
+    // gas price and scale down the exchange rate by the same factor.
+    if (newGasPrice.lt(10) && !newGasPrice.mod(1).isZero()) {
+        // Use the largest decimal scale that preserves the integer exchange rate
+        // that will actually be set on-chain.
+        for (let scalingMagnitude = 4; scalingMagnitude > 0; scalingMagnitude--) {
+            const gasPriceScalingFactor = new BigNumberJs(10).pow(scalingMagnitude);
+            const adjustedExchangeRate = newExchangeRate.div(gasPriceScalingFactor);
+            const adjustedExchangeRateInteger = adjustedExchangeRate.integerValue(BigNumberJs.ROUND_FLOOR);
+            const recoveredExchangeRate = adjustedExchangeRateInteger.times(gasPriceScalingFactor);
+            // Ensure the integer value recovers at least 99% of the original
+            // exchange rate. If it floors to zero, the final floor-to-one clamp would
+            // overquote, so try a smaller scale.
+            if (adjustedExchangeRateInteger.gt(0) &&
+                recoveredExchangeRate.times(100).div(newExchangeRate).gte(99)) {
+                newGasPrice = newGasPrice.times(gasPriceScalingFactor);
+                newExchangeRate = adjustedExchangeRate;
+                break;
+            }
+        }
+    }
+    const newGasPriceInteger = newGasPrice.integerValue(BigNumberJs.ROUND_CEIL);
+    assert(newGasPriceInteger.gt(0), 'Gas price must be greater than 0, possible loss of precision');
+    // Round the (possibly rebalanced) exchange rate to an integer, keeping a
+    // floor of 1 so a tiny-but-nonzero rate never collapses to 0.
+    let newExchangeRateInteger = newExchangeRate.integerValue(BigNumberJs.ROUND_FLOOR);
+    if (newExchangeRateInteger.lt(1)) {
+        newExchangeRateInteger = new BigNumberJs(1);
+    }
+    assert(newExchangeRateInteger.gt(0), `Token exchange rate must be greater than 0, possible loss of precision. Original exchange rate: ${exchangeRate.toString()}`);
+    return {
+        tokenExchangeRate: newExchangeRateInteger.toFixed(0),
+        gasPrice: newGasPriceInteger.toFixed(0),
+        tokenDecimals: remoteDecimals,
+    };
+}
+//# sourceMappingURL=utils.js.map

package/dist/gas/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/gas/utils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,IAAI,WAAW,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EACL,YAAY,EACZ,MAAM,EACN,eAAe,EACf,MAAM,EACN,UAAU,GACX,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,+BAA+B,EAAE,MAAM,kBAAkB,CAAC;AAKnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAuB5D,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,GAAyB,EACzB,KAAa;IAEb,MAAM,YAAY,GAAG,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAC5C,QAAQ,YAAY,EAAE,CAAC;QACrB,KAAK,YAAY,CAAC,IAAI,CAAC;QACvB,KAAK,YAAY,CAAC,QAAQ,EAAE,CAAC;YAC3B,MAAM,QAAQ,GAAG,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;YACxC,MAAM,QAAQ,GAAG,MAAO,QAAQ,CAAC,QAAqB,CAAC,WAAW,EAAE,CAAC;YACrE,OAAO;gBACL,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC;gBAClD,QAAQ,EAAE,CAAC;aACZ,CAAC;QACJ,CAAC;QACD,KAAK,YAAY,CAAC,MAAM,CAAC;QACzB,KAAK,YAAY,CAAC,YAAY,EAAE,CAAC;YAC/B,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,sBAAsB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YAC5D,OAAO;gBACL,MAAM;gBACN,QAAQ,EAAE,CAAC;aACZ,CAAC;QACJ,CAAC;QACD,KAAK,YAAY,CAAC,QAAQ;YACxB,8BAA8B;YAC9B,OAAO;gBACL,MAAM,EAAE,OAAO;gBACf,QAAQ,EAAE,CAAC;aACZ,CAAC;QACJ;YACE,MAAM,IAAI,KAAK,CAAC,8BAA8B,YAAY,EAAE,CAAC,CAAC;IAClE,CAAC;AACH,CAAC;AAED,wCAAwC;AACxC,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,KAAgB,EAChB,oBAA0C;IAE1C,MAAM,QAAQ,GAAG,oBAAoB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAC9D,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,sCAAsC,KAAK,EAAE,CAAC,CAAC;IACjE,CAAC;IACD,IACE,QAAQ,CAAC,QAAQ,KAAK,YAAY,CAAC,MAAM;QACzC,QAAQ,CAAC,QAAQ,KAAK,YAAY,CAAC,YAAY,EAC/C,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,SAAS,KAAK,wBAAwB,CAAC,CAAC;IAC1D,CAAC;IAED,2CAA2C;IAC3C,IAAI,mBAAmB,CAAC;IACxB,IAAI,CAAC;QACH,mBAAmB,GAAG,MAAM,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAC5D,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,wDAAwD;QACxD,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;YACtB,OAAO,QAAQ,CAAC,QAAQ,CAAC;QAC3B,CAAC;QACD,MAAM,IAAI,KAAK,CACb,uCAAuC,KAAK,8BAA8B,EAC1E;YACE,KAAK,EAAE,GAAG;SACX,CACF,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;IACzC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,0CAA0C,KAAK,EAAE,CAAC,CAAC;IACrE,CAAC;IACD,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,mDAAmD,KAAK,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED,MAAM,GAAG,GAAG,mBAAmB,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,CACnD,CAAC,GAAsB,EAAE,EAAE;QACzB,OAAO,CACL,GAAG,CAAC,KAAK,KAAK,WAAW,CAAC,KAAK,IAAI,GAAG,CAAC,KAAK,KAAK,IAAI,WAAW,CAAC,KAAK,EAAE,CACzE,CAAC;IACJ,CAAC,CACF,CAAC;IACF,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;QAChD,MAAM,IAAI,KAAK,CAAC,uCAAuC,KAAK,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO;QACL,KAAK,EAAE,GAAG,CAAC,KAAK;QAChB,MAAM,EAAE,GAAG,CAAC,iBAAiB,CAAC,QAAQ,EAAE;KACzC,CAAC;AACJ,CAAC;AAED,4FAA4F;AAC5F,SAAS,oBAAoB,CAAC,EAC5B,KAAK,EACL,MAAM,EACN,WAAW,EACX,qBAAqB,GAMtB;IACC,iDAAiD;IACjD,oFAAoF;IACpF,+EAA+E;IAC/E,MAAM,YAAY,GAAG,GAAG,CAAC;IACzB,MAAM,UAAU,GAAG,IAAI,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,YAAY,CAAC,CAAC;IACvE,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,YAAY,CAAC,CAAC;IAEzE,2CAA2C;IAC3C,IAAI,YAAY,GAAG,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC/C,oBAAoB;IACpB,YAAY,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,GAAG,qBAAqB,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAExE,MAAM,CACJ,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,EAC7B,kEAAkE,CACnE,CAAC;IACF,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,4EAA4E;AAC5E,gFAAgF;AAChF,0EAA0E;AAC1E,8DAA8D;AAC9D,0BAA0B;AAC1B,SAAS,yBAAyB,CAChC,iBAA+B,EAC/B,YAA8C;IAE9C,MAAM,kBAAkB,GAAG,+BAA+B,CAAC,iBAAiB,CAAC,CAAC;IAC9E,OAAO,YAAY,CAAC,KAAK,CAAC,IAAI,WAAW,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,CAAC;AACzE,CAAC;AAED,sFAAsF;AACtF,wEAAwE;AACxE,yDAAyD;AACzD,oFAAoF;AACpF,mBAAmB;AACnB,yFAAyF;AACzF,mFAAmF;AACnF,0DAA0D;AAC1D,+EAA+E;AAC/E,MAAM,UAAU,8BAA8B,CAAC,EAC7C,KAAK,EACL,iBAAiB,EACjB,eAAe,EACf,qBAAqB,EACrB,gBAAgB,EAChB,iBAAiB,EACjB,mBAAmB,GAoBpB;IACC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,CACjD,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,KAAK,KAAK,CAC7B,CAAC;IACF,MAAM,WAAW,GAAqB,MAAM,CAC1C,eAAe,EACf,CAAC,KAAK,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,KAAK,CACpD,CAAC;IACF,MAAM,aAAa,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC;IAClE,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;QACpC,MAAM,cAAc,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC;QACpE,sEAAsE;QACtE,kBAAkB;QAClB,IAAI,iBAAiB,GAAG,oBAAoB,CAAC;YAC3C,KAAK;YACL,MAAM;YACN,WAAW;YACX,qBAAqB;SACtB,CAAC,CAAC;QAEH,IAAI,iBAAiB,KAAK,YAAY,CAAC,QAAQ,EAAE,CAAC;YAChD,uFAAuF;YACvF,iBAAiB,GAAG,eAAe,CACjC,cAAc,EACd,aAAa,EACb,iBAAiB,CAClB,CAAC;QACJ,CAAC;QAED,0EAA0E;QAC1E,0EAA0E;QAC1E,qEAAqE;QACrE,MAAM,kBAAkB,GAAG,yBAAyB,CAClD,iBAAiB,EACjB,iBAAiB,CAClB,CAAC;QAEF,8EAA8E;QAC9E,sEAAsE;QACtE,sDAAsD;QACtD,MAAM,QAAQ,GAAG,IAAI,WAAW,CAC9B,eAAe,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CACxC,CAAC,KAAK,CAAC,IAAI,WAAW,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC5E,IAAI,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CACb,+BAA+B,MAAM,KAAK,eAAe,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,CACpF,CAAC;QACJ,CAAC;QAED,+EAA+E;QAC/E,kFAAkF;QAClF,IAAI,eAAe,GACjB,sBAAsB,CAAC,QAAQ,EAAE,kBAAkB,EAAE,cAAc,EAAE;YACnE,KAAK;YACL,MAAM;YACN,UAAU,EAAE,mBAAmB;SAChC,CAAC,CAAC;QAEL,kCAAkC;QAClC,IAAI,gBAAgB,EAAE,CAAC;YACrB,oEAAoE;YACpE,eAAe,GAAG,sBAAsB,CACtC,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,eAAe,CAAC,EAChD,IAAI,WAAW,CAAC,eAAe,CAAC,iBAAiB,CAAC,EAClD,cAAc,EACd,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,mBAAmB,EAAE,CACnD,CAAC;QACJ,CAAC;QAED,IAAI,iBAAiB,EAAE,CAAC;YACtB,eAAe,CAAC,WAAW,GAAG,iBAAiB,CAC7C,KAAK,EACL,MAAM,EACN,eAAe,CAChB,CAAC;QACJ,CAAC;QACD,OAAO;YACL,GAAG,GAAG;YACN,CAAC,MAAM,CAAC,EAAE,eAAe;SAC1B,CAAC;IACJ,CAAC,EAAE,EAAgD,CAAC,CAAC;AACvD,CAAC;AAED,8EAA8E;AAC9E,4EAA4E;AAC5E,uEAAuE;AACvE,MAAM,wBAAwB,GAAG,IAAI,CAAC;AAEtC,SAAS,gBAAgB,CAAC,KAAuC;IAC/D,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;QAAE,OAAO,CAAC,CAAC;IAC1B,OAAO,KAAK,CAAC,YAAY,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;AAC3E,CAAC;AAED,SAAS,sBAAsB,CAC7B,QAA2C,EAC3C,YAA8C,EAC9C,cAAsB;AACtB,6EAA6E;AAC7E,wEAAwE;AACxE,+EAA+E;AAC/E,kEAAkE;AAClE,OAIC;IAED,IAAI,WAAW,GAAG,IAAI,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC5C,IAAI,eAAe,GAAG,YAAY,CAAC;IAEnC,6EAA6E;IAC7E,4EAA4E;IAC5E,6EAA6E;IAC7E,yEAAyE;IACzE,8EAA8E;IAC9E,2EAA2E;IAC3E,4EAA4E;IAC5E,oEAAoE;IACpE,IAAI,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1B,MAAM,cAAc,GAAG,gBAAgB,CACrC,WAAW,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAC1C,CAAC;QAEF,IAAI,cAAc,GAAG,CAAC,EAAE,CAAC;YACvB,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YACvD,eAAe,GAAG,eAAe,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAChD,WAAW,GAAG,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACxC,CAAC;QAED,IAAI,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1B,sEAAsE;YACtE,0EAA0E;YAC1E,sEAAsE;YACtE,yEAAyE;YACzE,mDAAmD;YACnD,sEAAsE;YACtE,uEAAuE;YACvE,IAAI,OAAO,EAAE,UAAU,EAAE,CAAC;gBACxB,OAAO,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;YACvE,CAAC;iBAAM,CAAC;gBACN,UAAU,CAAC,IAAI,CACb,gEACE,OAAO,CAAC,CAAC,CAAC,QAAQ,OAAO,CAAC,KAAK,OAAO,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAC3D,yEAAyE,IAAI,WAAW,CACtF,QAAQ,CACT,CAAC,QAAQ,EAAE,6BAA6B,YAAY,CAAC,QAAQ,EAAE,EAAE,CACnE,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,8EAA8E;IAC9E,gFAAgF;IAChF,iEAAiE;IACjE,IAAI,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;QACvD,yEAAyE;QACzE,sCAAsC;QACtC,KAAK,IAAI,gBAAgB,GAAG,CAAC,EAAE,gBAAgB,GAAG,CAAC,EAAE,gBAAgB,EAAE,EAAE,CAAC;YACxE,MAAM,qBAAqB,GAAG,IAAI,WAAW,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;YACxE,MAAM,oBAAoB,GAAG,eAAe,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;YACxE,MAAM,2BAA2B,GAAG,oBAAoB,CAAC,YAAY,CACnE,WAAW,CAAC,WAAW,CACxB,CAAC;YACF,MAAM,qBAAqB,GAAG,2BAA2B,CAAC,KAAK,CAC7D,qBAAqB,CACtB,CAAC;YAEF,iEAAiE;YACjE,0EAA0E;YAC1E,qCAAqC;YACrC,IACE,2BAA2B,CAAC,EAAE,CAAC,CAAC,CAAC;gBACjC,qBAAqB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAC7D,CAAC;gBACD,WAAW,GAAG,WAAW,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;gBACvD,eAAe,GAAG,oBAAoB,CAAC;gBACvC,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,kBAAkB,GAAG,WAAW,CAAC,YAAY,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAC5E,MAAM,CACJ,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC,EACxB,8DAA8D,CAC/D,CAAC;IAEF,yEAAyE;IACzE,8DAA8D;IAC9D,IAAI,sBAAsB,GAAG,eAAe,CAAC,YAAY,CACvD,WAAW,CAAC,WAAW,CACxB,CAAC;IACF,IAAI,sBAAsB,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACjC,sBAAsB,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;IAC9C,CAAC;IACD,MAAM,CACJ,sBAAsB,CAAC,EAAE,CAAC,CAAC,CAAC,EAC5B,mGAAmG,YAAY,CAAC,QAAQ,EAAE,EAAE,CAC7H,CAAC;IAEF,OAAO;QACL,iBAAiB,EAAE,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC;QACpD,QAAQ,EAAE,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC;QACvC,aAAa,EAAE,cAAc;KAC9B,CAAC;AACJ,CAAC"}

package/dist/gas/utils.test.d.ts

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

package/dist/gas/utils.test.d.ts.map

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

package/dist/gas/utils.test.js

@@ -0,0 +1,132 @@
+import { expect } from 'chai';
+import { ProtocolType } from '@recoillink/utils';
+import { getLocalStorageGasOracleConfig, } from './utils.js';
+// Fee quote the IGP computes for a message, in the local (fee-token) base unit:
+//   quote = gasAmount * gasPrice * tokenExchangeRate / 1e10
+const EXCHANGE_RATE_SCALE = 1e10;
+const MAX_REBALANCED_QUOTE_ROUNDING_ERROR = 1 / 1000;
+function quote(config, gasAmount) {
+    return ((gasAmount * Number(config.gasPrice) * Number(config.tokenExchangeRate)) /
+        EXCHANGE_RATE_SCALE);
+}
+describe('getLocalStorageGasOracleConfig', () => {
+    it('leaves same-decimal native pairs unchanged (no rebalance)', () => {
+        // local + remote both 18-decimal native tokens; remote worth 2x local.
+        const gasOracleParams = {
+            local: {
+                gasPrice: { amount: '1', decimals: 9 },
+                nativeToken: { price: '1', decimals: 18 },
+            },
+            remote: {
+                gasPrice: { amount: '1', decimals: 9 }, // 1 gwei = 1e9 wei
+                nativeToken: { price: '2', decimals: 18 },
+            },
+        };
+        const config = getLocalStorageGasOracleConfig({
+            local: 'local',
+            localProtocolType: ProtocolType.Ethereum,
+            gasOracleParams,
+            exchangeRateMarginPct: 0,
+        });
+        // exchangeRate = (2/1) * 1e10 ; gasPrice = 1e9 ; both pass through as-is.
+        expect(config.remote.tokenExchangeRate).to.equal('20000000000');
+        expect(config.remote.gasPrice).to.equal('1000000000');
+    });
+    it('rebalances a sub-unit exchange rate for a low-decimal fee token', () => {
+        // 6-decimal fee token paying for an 18-decimal remote, remote worth 10x.
+        // Naively the scaled exchange rate is (10) * 10^(6-18) * 1e10 = 0.1, which
+        // would floor to 1 and overprice the quote 10x. The rebalance must keep it
+        // representable while preserving the quote.
+        const gasOracleParams = {
+            feeToken: {
+                gasPrice: { amount: '1', decimals: 9 },
+                nativeToken: { price: '1', decimals: 6 },
+            },
+            remote: {
+                gasPrice: { amount: '50', decimals: 9 }, // 50 gwei = 5e10 wei
+                nativeToken: { price: '10', decimals: 18 },
+            },
+        };
+        const config = getLocalStorageGasOracleConfig({
+            local: 'feeToken',
+            localProtocolType: ProtocolType.Ethereum,
+            gasOracleParams,
+            exchangeRateMarginPct: 0,
+        }).remote;
+        // Exchange rate must be representable before integer rounding.
+        expect(Number(config.tokenExchangeRate)).to.be.at.least(1);
+        // The quote (gasPrice * exchangeRate product) must match the intended value:
+        // intended per-gas = 5e10 * 0.1 / 1e10 = 0.5 base units per unit gas.
+        const gasAmount = 200_000;
+        expect(quote(config, gasAmount)).to.be.approximately(0.5 * gasAmount, 0.5 * gasAmount * MAX_REBALANCED_QUOTE_ROUNDING_ERROR);
+    });
+    it('preserves precision for non-power-of-ten exchange rates', () => {
+        // 6-decimal fee token paying for an 18-decimal remote, remote worth 15x.
+        // Naively the scaled exchange rate is 0.15. Shifting only one digit makes
+        // this 1.5, which floors to 1 and underquotes by 33%; using all safe
+        // gas-price headroom keeps the floor rounding error negligible.
+        const gasOracleParams = {
+            feeToken: {
+                gasPrice: { amount: '1', decimals: 9 },
+                nativeToken: { price: '1', decimals: 6 },
+            },
+            remote: {
+                gasPrice: { amount: '50', decimals: 9 }, // 50 gwei = 5e10 wei
+                nativeToken: { price: '15', decimals: 18 },
+            },
+        };
+        const config = getLocalStorageGasOracleConfig({
+            local: 'feeToken',
+            localProtocolType: ProtocolType.Ethereum,
+            gasOracleParams,
+            exchangeRateMarginPct: 0,
+        }).remote;
+        const gasAmount = 200_000;
+        expect(quote(config, gasAmount)).to.be.approximately(0.75 * gasAmount, 0.75 * gasAmount * MAX_REBALANCED_QUOTE_ROUNDING_ERROR);
+    });
+    it('falls back to the floor when there is no gas price headroom to rebalance', () => {
+        // gasPrice in wei (5) is below MIN_REBALANCED_GAS_PRICE, so shifting any
+        // magnitude into the exchange rate would exceed the rounding-error bound.
+        // This documents the known fallback limitation: the quote is overpriced by
+        // the sub-1 exchange rate factor rather than preserving precision.
+        const gasOracleParams = {
+            feeToken: {
+                gasPrice: { amount: '1', decimals: 9 },
+                nativeToken: { price: '1', decimals: 6 },
+            },
+            remote: {
+                gasPrice: { amount: '5', decimals: 0 }, // <10 wei
+                nativeToken: { price: '10', decimals: 18 },
+            },
+        };
+        const config = getLocalStorageGasOracleConfig({
+            local: 'feeToken',
+            localProtocolType: ProtocolType.Ethereum,
+            gasOracleParams,
+            exchangeRateMarginPct: 0,
+        }).remote;
+        expect(config.tokenExchangeRate).to.equal('1');
+        expect(config.gasPrice).to.equal('5');
+    });
+    it('uses a smaller gas price scale when the exchange rate would floor to zero', () => {
+        const gasOracleParams = {
+            local: {
+                gasPrice: { amount: '1', decimals: 0 },
+                nativeToken: { price: '1', decimals: 18 },
+            },
+            remote: {
+                gasPrice: { amount: '0.5', decimals: 0 },
+                nativeToken: { price: '0.0000001', decimals: 18 },
+            },
+        };
+        const config = getLocalStorageGasOracleConfig({
+            local: 'local',
+            localProtocolType: ProtocolType.Ethereum,
+            gasOracleParams,
+            exchangeRateMarginPct: 0,
+        }).remote;
+        expect(config.tokenExchangeRate).to.equal('1');
+        expect(config.gasPrice).to.equal('500');
+    });
+});
+//# sourceMappingURL=utils.test.js.map