@hyperlane-xyz/sdk 35.2.0 → 36.0.0

package/dist/fee/feeConfigMapping.test.d.ts.map

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

package/dist/fee/feeConfigMapping.test.js

@@ -0,0 +1,204 @@
+import { FeeParamsType, FeeStrategyType, FeeType, } from '@hyperlane-xyz/provider-sdk/fee';
+import { expect } from 'chai';
+import { tokenFeeInputToFeeConfig } from './feeConfigMapping.js';
+import { TokenFeeConfigInputSchema, TokenFeeType, } from './types.js';
+const OWNER = '0x0000000000000000000000000000000000000001';
+const SIGNER_A = '0x000000000000000000000000000000000000000A';
+const SIGNER_B = '0x000000000000000000000000000000000000000B';
+describe('tokenFeeInputToFeeConfig', () => {
+    it('maps LinearFee with bps', () => {
+        const input = {
+            type: TokenFeeType.LinearFee,
+            owner: OWNER,
+            bps: 50,
+        };
+        expect(tokenFeeInputToFeeConfig(input)).to.deep.equal({
+            type: FeeType.linear,
+            owner: OWNER,
+            beneficiary: OWNER,
+            params: { type: FeeParamsType.bps, bps: 50 },
+        });
+    });
+    it('maps ProgressiveFee with raw params', () => {
+        const input = {
+            type: TokenFeeType.ProgressiveFee,
+            owner: OWNER,
+            maxFee: 1000n,
+            halfAmount: 500n,
+        };
+        expect(tokenFeeInputToFeeConfig(input)).to.deep.equal({
+            type: FeeType.progressive,
+            owner: OWNER,
+            beneficiary: OWNER,
+            params: {
+                type: FeeParamsType.raw,
+                maxFee: '1000',
+                halfAmount: '500',
+            },
+        });
+    });
+    it('maps RegressiveFee with raw params', () => {
+        const input = {
+            type: TokenFeeType.RegressiveFee,
+            owner: OWNER,
+            maxFee: 2000n,
+            halfAmount: 750n,
+        };
+        expect(tokenFeeInputToFeeConfig(input)).to.deep.equal({
+            type: FeeType.regressive,
+            owner: OWNER,
+            beneficiary: OWNER,
+            params: {
+                type: FeeParamsType.raw,
+                maxFee: '2000',
+                halfAmount: '750',
+            },
+        });
+    });
+    it('maps OffchainQuotedLinearFee with signers', () => {
+        const input = {
+            type: TokenFeeType.OffchainQuotedLinearFee,
+            owner: OWNER,
+            bps: 25,
+            quoteSigners: [SIGNER_A, SIGNER_B],
+        };
+        expect(tokenFeeInputToFeeConfig(input)).to.deep.equal({
+            type: FeeType.offchainQuotedLinear,
+            owner: OWNER,
+            beneficiary: OWNER,
+            params: { type: FeeParamsType.bps, bps: 25 },
+            quoteSigners: [SIGNER_A, SIGNER_B],
+        });
+    });
+    it('defaults OffchainQuotedLinearFee signers to empty array when undefined', () => {
+        const input = {
+            type: TokenFeeType.OffchainQuotedLinearFee,
+            owner: OWNER,
+            bps: 25,
+        };
+        const result = tokenFeeInputToFeeConfig(input);
+        expect(result.type).to.equal(FeeType.offchainQuotedLinear);
+        if (result.type === FeeType.offchainQuotedLinear) {
+            expect(result.quoteSigners).to.deep.equal([]);
+        }
+    });
+    it('maps RoutingFee over per-destination leaf strategies', () => {
+        const input = {
+            type: TokenFeeType.RoutingFee,
+            owner: OWNER,
+            feeContracts: {
+                anvil1: { type: TokenFeeType.LinearFee, owner: OWNER, bps: 50 },
+                anvil2: {
+                    type: TokenFeeType.OffchainQuotedLinearFee,
+                    owner: OWNER,
+                    bps: 75,
+                    quoteSigners: [SIGNER_A],
+                },
+            },
+        };
+        expect(tokenFeeInputToFeeConfig(input)).to.deep.equal({
+            type: FeeType.routing,
+            owner: OWNER,
+            beneficiary: OWNER,
+            routes: {
+                anvil1: {
+                    type: FeeStrategyType.linear,
+                    params: { type: FeeParamsType.bps, bps: 50 },
+                },
+                anvil2: {
+                    type: FeeStrategyType.offchainQuotedLinear,
+                    params: { type: FeeParamsType.bps, bps: 75 },
+                    quoteSigners: [SIGNER_A],
+                },
+            },
+        });
+    });
+    it('maps CrossCollateralRoutingFee over nested per-destination strategies', () => {
+        const input = {
+            type: TokenFeeType.CrossCollateralRoutingFee,
+            owner: OWNER,
+            feeContracts: {
+                anvil1: {
+                    [SIGNER_A]: {
+                        type: TokenFeeType.RegressiveFee,
+                        owner: OWNER,
+                        maxFee: 100n,
+                        halfAmount: 50n,
+                    },
+                },
+            },
+        };
+        expect(tokenFeeInputToFeeConfig(input)).to.deep.equal({
+            type: FeeType.crossCollateralRouting,
+            owner: OWNER,
+            beneficiary: OWNER,
+            routes: {
+                anvil1: {
+                    [SIGNER_A]: {
+                        type: FeeStrategyType.regressive,
+                        params: {
+                            type: FeeParamsType.raw,
+                            maxFee: '100',
+                            halfAmount: '50',
+                        },
+                    },
+                },
+            },
+        });
+    });
+    it('maps parsed LinearFee with raw params — schema injects derived bps but raw wins', () => {
+        const parsed = TokenFeeConfigInputSchema.parse({
+            type: TokenFeeType.LinearFee,
+            owner: OWNER,
+            maxFee: 1000n,
+            halfAmount: 500n,
+        });
+        expect(tokenFeeInputToFeeConfig(parsed)).to.deep.equal({
+            type: FeeType.linear,
+            owner: OWNER,
+            beneficiary: OWNER,
+            params: {
+                type: FeeParamsType.raw,
+                maxFee: '1000',
+                halfAmount: '500',
+            },
+        });
+    });
+    it('maps parsed OffchainQuotedLinearFee with raw params — schema injects derived bps but raw wins', () => {
+        const parsed = TokenFeeConfigInputSchema.parse({
+            type: TokenFeeType.OffchainQuotedLinearFee,
+            owner: OWNER,
+            maxFee: 1000n,
+            halfAmount: 500n,
+            quoteSigners: [SIGNER_A],
+        });
+        expect(tokenFeeInputToFeeConfig(parsed)).to.deep.equal({
+            type: FeeType.offchainQuotedLinear,
+            owner: OWNER,
+            beneficiary: OWNER,
+            params: {
+                type: FeeParamsType.raw,
+                maxFee: '1000',
+                halfAmount: '500',
+            },
+            quoteSigners: [SIGNER_A],
+        });
+    });
+    it('throws when a routing strategy is nested inside another routing strategy', () => {
+        const input = {
+            type: TokenFeeType.RoutingFee,
+            owner: OWNER,
+            feeContracts: {
+                anvil1: {
+                    type: TokenFeeType.RoutingFee,
+                    owner: OWNER,
+                    feeContracts: {
+                        anvil2: { type: TokenFeeType.LinearFee, owner: OWNER, bps: 50 },
+                    },
+                },
+            },
+        };
+        expect(() => tokenFeeInputToFeeConfig(input)).to.throw(/Cannot nest RoutingFee inside a routing fee/);
+    });
+});
+//# sourceMappingURL=feeConfigMapping.test.js.map

package/dist/fee/feeConfigMapping.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"feeConfigMapping.test.js","sourceRoot":"","sources":["../../src/fee/feeConfigMapping.test.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,eAAe,EACf,OAAO,GACR,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,OAAO,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,EACL,yBAAyB,EACzB,YAAY,GAEb,MAAM,YAAY,CAAC;AAEpB,MAAM,KAAK,GAAG,4CAA4C,CAAC;AAC3D,MAAM,QAAQ,GAAG,4CAA4C,CAAC;AAC9D,MAAM,QAAQ,GAAG,4CAA4C,CAAC;AAE9D,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACjC,MAAM,KAAK,GAAwB;YACjC,IAAI,EAAE,YAAY,CAAC,SAAS;YAC5B,KAAK,EAAE,KAAK;YACZ,GAAG,EAAE,EAAE;SACR,CAAC;QAEF,MAAM,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;YACpD,IAAI,EAAE,OAAO,CAAC,MAAM;YACpB,KAAK,EAAE,KAAK;YACZ,WAAW,EAAE,KAAK;YAClB,MAAM,EAAE,EAAE,IAAI,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE;SAC7C,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,KAAK,GAAwB;YACjC,IAAI,EAAE,YAAY,CAAC,cAAc;YACjC,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,KAAK;YACb,UAAU,EAAE,IAAI;SACjB,CAAC;QAEF,MAAM,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;YACpD,IAAI,EAAE,OAAO,CAAC,WAAW;YACzB,KAAK,EAAE,KAAK;YACZ,WAAW,EAAE,KAAK;YAClB,MAAM,EAAE;gBACN,IAAI,EAAE,aAAa,CAAC,GAAG;gBACvB,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE,KAAK;aAClB;SACF,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,MAAM,KAAK,GAAwB;YACjC,IAAI,EAAE,YAAY,CAAC,aAAa;YAChC,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,KAAK;YACb,UAAU,EAAE,IAAI;SACjB,CAAC;QAEF,MAAM,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;YACpD,IAAI,EAAE,OAAO,CAAC,UAAU;YACxB,KAAK,EAAE,KAAK;YACZ,WAAW,EAAE,KAAK;YAClB,MAAM,EAAE;gBACN,IAAI,EAAE,aAAa,CAAC,GAAG;gBACvB,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE,KAAK;aAClB;SACF,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,KAAK,GAAwB;YACjC,IAAI,EAAE,YAAY,CAAC,uBAAuB;YAC1C,KAAK,EAAE,KAAK;YACZ,GAAG,EAAE,EAAE;YACP,YAAY,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC;SACnC,CAAC;QAEF,MAAM,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;YACpD,IAAI,EAAE,OAAO,CAAC,oBAAoB;YAClC,KAAK,EAAE,KAAK;YACZ,WAAW,EAAE,KAAK;YAClB,MAAM,EAAE,EAAE,IAAI,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE;YAC5C,YAAY,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC;SACnC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wEAAwE,EAAE,GAAG,EAAE;QAChF,MAAM,KAAK,GAAwB;YACjC,IAAI,EAAE,YAAY,CAAC,uBAAuB;YAC1C,KAAK,EAAE,KAAK;YACZ,GAAG,EAAE,EAAE;SACR,CAAC;QAEF,MAAM,MAAM,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAC3D,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,oBAAoB,EAAE,CAAC;YACjD,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAChD,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,KAAK,GAAwB;YACjC,IAAI,EAAE,YAAY,CAAC,UAAU;YAC7B,KAAK,EAAE,KAAK;YACZ,YAAY,EAAE;gBACZ,MAAM,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE;gBAC/D,MAAM,EAAE;oBACN,IAAI,EAAE,YAAY,CAAC,uBAAuB;oBAC1C,KAAK,EAAE,KAAK;oBACZ,GAAG,EAAE,EAAE;oBACP,YAAY,EAAE,CAAC,QAAQ,CAAC;iBACzB;aACF;SACF,CAAC;QAEF,MAAM,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;YACpD,IAAI,EAAE,OAAO,CAAC,OAAO;YACrB,KAAK,EAAE,KAAK;YACZ,WAAW,EAAE,KAAK;YAClB,MAAM,EAAE;gBACN,MAAM,EAAE;oBACN,IAAI,EAAE,eAAe,CAAC,MAAM;oBAC5B,MAAM,EAAE,EAAE,IAAI,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE;iBAC7C;gBACD,MAAM,EAAE;oBACN,IAAI,EAAE,eAAe,CAAC,oBAAoB;oBAC1C,MAAM,EAAE,EAAE,IAAI,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE;oBAC5C,YAAY,EAAE,CAAC,QAAQ,CAAC;iBACzB;aACF;SACF,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uEAAuE,EAAE,GAAG,EAAE;QAC/E,MAAM,KAAK,GAAwB;YACjC,IAAI,EAAE,YAAY,CAAC,yBAAyB;YAC5C,KAAK,EAAE,KAAK;YACZ,YAAY,EAAE;gBACZ,MAAM,EAAE;oBACN,CAAC,QAAQ,CAAC,EAAE;wBACV,IAAI,EAAE,YAAY,CAAC,aAAa;wBAChC,KAAK,EAAE,KAAK;wBACZ,MAAM,EAAE,IAAI;wBACZ,UAAU,EAAE,GAAG;qBAChB;iBACF;aACF;SACF,CAAC;QAEF,MAAM,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;YACpD,IAAI,EAAE,OAAO,CAAC,sBAAsB;YACpC,KAAK,EAAE,KAAK;YACZ,WAAW,EAAE,KAAK;YAClB,MAAM,EAAE;gBACN,MAAM,EAAE;oBACN,CAAC,QAAQ,CAAC,EAAE;wBACV,IAAI,EAAE,eAAe,CAAC,UAAU;wBAChC,MAAM,EAAE;4BACN,IAAI,EAAE,aAAa,CAAC,GAAG;4BACvB,MAAM,EAAE,KAAK;4BACb,UAAU,EAAE,IAAI;yBACjB;qBACF;iBACF;aACF;SACF,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iFAAiF,EAAE,GAAG,EAAE;QACzF,MAAM,MAAM,GAAG,yBAAyB,CAAC,KAAK,CAAC;YAC7C,IAAI,EAAE,YAAY,CAAC,SAAS;YAC5B,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,KAAK;YACb,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;QAEH,MAAM,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;YACrD,IAAI,EAAE,OAAO,CAAC,MAAM;YACpB,KAAK,EAAE,KAAK;YACZ,WAAW,EAAE,KAAK;YAClB,MAAM,EAAE;gBACN,IAAI,EAAE,aAAa,CAAC,GAAG;gBACvB,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE,KAAK;aAClB;SACF,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+FAA+F,EAAE,GAAG,EAAE;QACvG,MAAM,MAAM,GAAG,yBAAyB,CAAC,KAAK,CAAC;YAC7C,IAAI,EAAE,YAAY,CAAC,uBAAuB;YAC1C,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,KAAK;YACb,UAAU,EAAE,IAAI;YAChB,YAAY,EAAE,CAAC,QAAQ,CAAC;SACzB,CAAC,CAAC;QAEH,MAAM,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;YACrD,IAAI,EAAE,OAAO,CAAC,oBAAoB;YAClC,KAAK,EAAE,KAAK;YACZ,WAAW,EAAE,KAAK;YAClB,MAAM,EAAE;gBACN,IAAI,EAAE,aAAa,CAAC,GAAG;gBACvB,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE,KAAK;aAClB;YACD,YAAY,EAAE,CAAC,QAAQ,CAAC;SACzB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0EAA0E,EAAE,GAAG,EAAE;QAClF,MAAM,KAAK,GAAwB;YACjC,IAAI,EAAE,YAAY,CAAC,UAAU;YAC7B,KAAK,EAAE,KAAK;YACZ,YAAY,EAAE;gBACZ,MAAM,EAAE;oBACN,IAAI,EAAE,YAAY,CAAC,UAAU;oBAC7B,KAAK,EAAE,KAAK;oBACZ,YAAY,EAAE;wBACZ,MAAM,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE;qBAChE;iBACF;aACF;SACF,CAAC;QAEF,MAAM,CAAC,GAAG,EAAE,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CACpD,6CAA6C,CAC9C,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}