@shapeshiftoss/swapper 20.3.0 → 20.4.0

package/dist/cjs/swappers/ZrxSwapper/getZrxTradeQuote/getZrxTradeQuote.js

@@ -7,9 +7,11 @@ const types_1 = require("../../../types");
 const utils_1 = require("../../../utils");
 const helpers_1 = require("../../../utils/helpers");
 const fetchFromZrx_1 = require("../utils/fetchFromZrx");
+const getZrxNativeCheckDeadline_1 = require("../utils/getZrxNativeCheckDeadline");
 const getZrxStepData_1 = require("../utils/getZrxStepData");
 const getZrxTradeContext_1 = require("../utils/getZrxTradeContext");
 const helpers_2 = require("../utils/helpers");
+const isValidDeadlineSeconds = (deadline) => Number.isSafeInteger(deadline) && deadline > 0 && Number.isSafeInteger(deadline * 1000);
 const getZrxTradeQuote = async (input, deps) => {
     const { sellAsset, buyAsset, accountNumber, affiliateBps, sellAmountIncludingProtocolFeesCryptoBaseUnit, } = input;
     const maybeAddresses = (0, utils_1.assertQuoteAddresses)(input);
@@ -42,6 +44,16 @@ const getZrxTradeQuote = async (input, deps) => {
         return (0, monads_1.Err)(maybeZrxQuoteResponse.unwrapErr());
     const { sellAmount, buyAmount, fees, permit2, transaction, route } = maybeZrxQuoteResponse.unwrap();
     const permit2Eip712 = permit2?.eip712;
+    const permit2Deadline = permit2Eip712 ? Number(permit2Eip712.message.deadline) : undefined;
+    if (permit2Deadline !== undefined &&
+        ((typeof permit2Eip712?.message.deadline !== 'string' &&
+            typeof permit2Eip712?.message.deadline !== 'number') ||
+            !isValidDeadlineSeconds(permit2Deadline))) {
+        return (0, monads_1.Err)((0, utils_1.makeSwapErrorRight)({
+            message: 'Invalid Permit2 deadline from 0x response',
+            code: types_1.TradeQuoteError.InvalidResponse,
+        }));
+    }
     if (!(0, helpers_1.isNativeEvmAsset)(sellAsset.assetId) && !(0, helpers_2.isWrappedNativeSell)(route) && !permit2Eip712) {
         return (0, monads_1.Err)((0, utils_1.makeSwapErrorRight)({
             message: 'Missing required Permit2 metadata from 0x response',
@@ -56,6 +68,17 @@ const getZrxTradeQuote = async (input, deps) => {
             details: { transaction, permit2Eip712 },
         }));
     }
+    // Permit2 calldata is not decodable until the signature is spliced in, so only native sells are read
+    const nativeCheckDeadline = permit2Eip712
+        ? undefined
+        : (0, getZrxNativeCheckDeadline_1.getZrxNativeCheckDeadline)(transaction.data);
+    if (nativeCheckDeadline !== undefined && !isValidDeadlineSeconds(nativeCheckDeadline)) {
+        return (0, monads_1.Err)((0, utils_1.makeSwapErrorRight)({
+            message: 'Invalid NATIVE_CHECK deadline in 0x calldata',
+            code: types_1.TradeQuoteError.InvalidResponse,
+        }));
+    }
+    const deadlineSeconds = permit2Deadline ?? nativeCheckDeadline;
     const maybeContext = (0, getZrxTradeContext_1.getZrxTradeContext)({
         input,
         deps,
@@ -79,7 +102,7 @@ const getZrxTradeQuote = async (input, deps) => {
     const tradeQuote = {
         ...tradeCommon,
         quoteOrRate: 'quote',
-        deadline: Date.now() + helpers_1.FALLBACK_QUOTE_DEADLINE_MS,
+        deadline: deadlineSeconds === undefined ? undefined : deadlineSeconds * 1000,
         receiveAddress,
         steps: [
             {

package/dist/cjs/swappers/ZrxSwapper/getZrxTradeQuote/getZrxTradeQuote.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/swappers/ZrxSwapper/getZrxTradeQuote/getZrxTradeQuote.test.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const types_1 = require("@shapeshiftoss/types");
+const monads_1 = require("@sniptt/monads");
+const vitest_1 = require("vitest");
+const types_2 = require("../../../types");
+const assets_1 = require("../../../utils/test-data/assets");
+const fetchFromZrx_1 = require("../utils/fetchFromZrx");
+const getZrxTradeQuote_1 = require("./getZrxTradeQuote");
+vitest_1.vi.mock('../utils/fetchFromZrx', () => ({ fetchZrxQuote: vitest_1.vi.fn() }));
+vitest_1.vi.mock('../utils/getZrxStepData', () => ({
+    getZrxStepData: vitest_1.vi.fn(({ permit2Eip712 }) => Promise.resolve((0, monads_1.Ok)({
+        transactionData: {
+            type: 'evm',
+            chainId: 1,
+            to: '0x1111111111111111111111111111111111111111',
+            data: '0x1234',
+            value: '0',
+            ...(permit2Eip712 && {
+                signatureRequired: { type: 'permit2', eip712: permit2Eip712 },
+            }),
+        },
+        networkFeeCryptoBaseUnit: '100000',
+    }))),
+}));
+const input = {
+    sellAsset: assets_1.WETH,
+    buyAsset: assets_1.USDC_MAINNET,
+    sellAmountIncludingProtocolFeesCryptoBaseUnit: '1000000000000000000',
+    sendAddress: '0x1111111111111111111111111111111111111111',
+    receiveAddress: '0x1111111111111111111111111111111111111111',
+    accountNumber: 0,
+    affiliateBps: '0',
+    allowMultiHop: false,
+    quoteOrRate: 'quote',
+    chainId: types_1.KnownChainIds.EthereumMainnet,
+    supportsEIP1559: true,
+};
+const deps = {
+    assetsById: {},
+    config: { VITE_ZRX_BASE_URL: 'https://example.com' },
+};
+const typedData = (deadline) => ({
+    domain: { name: 'Permit2', chainId: 1 },
+    types: { PermitTransferFrom: [{ name: 'deadline', type: 'uint256' }] },
+    primaryType: 'PermitTransferFrom',
+    message: { deadline },
+});
+// Live Settler calldata for an ETH -> USDC sell, NATIVE_CHECK deadline 1791997786
+const nativeSellCalldata = '0x1fff991f000000000000000000000000ea8eb5ba11a3ea66f417ae29abf70c6fb4ba9626000000000000000000000000a0b86991c6218b36c1d19d4a2e9eb0ce3606eb48000000000000000000000000000000000000000000000000000000000e750ef800000000000000000000000000000000000000000000000000000000000000a0939d83c32b72441d72643cf60000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000800000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000024000000000000000000000000000000000000000000000000000000000000003600000000000000000000000000000000000000000000000000000000000000044bd01c226000000000000000000000000000000000000000000000000000000006acfb75a000000000000000000000000000000000000000000000000016345785d8a000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000010438c9c147000000000000000000000000eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee00000000000000000000000000000000000000000000000000000000000f4240000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2000000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000a00000000000000000000000000000000000000000000000000000000000000024d0e30db00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000e48d68a156000000000000000000000000666fedd4cdd4e890a5ad20e7b60975409435a64a00000000000000000000000000000000000000000000000000000000000f4240000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000040c02aaa39b223fe8d0a0e5c4f27ead9083c756cc201000064fffd8963efd1fc6a506488495d951d5263988d25a0b86991c6218b36c1d19d4a2e9eb0ce3606eb4800000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000008434ee90ca000000000000000000000000f5c4f3dc02c3fb9279495a8fef7b0741da956157000000000000000000000000a0b86991c6218b36c1d19d4a2e9eb0ce3606eb48000000000000000000000000000000000000000000000000000000000e9a9ab900000000000000000000000000000000000000000000000000000000000f424000000000000000000000000000000000000000000000000000000000';
+const quoteResponse = (eip712, data = '0x1234') => ({
+    blockNumber: '1',
+    buyAmount: '1000000',
+    buyToken: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
+    sellAmount: input.sellAmountIncludingProtocolFeesCryptoBaseUnit,
+    sellToken: '0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
+    fees: { integratorFee: null, zeroExFee: null, gasFee: null },
+    issues: { allowance: null, balance: null, simulationIncomplete: false, invalidSourcesPassed: [] },
+    liquidityAvailable: true,
+    minBuyAmount: '990000',
+    route: { fills: [], tokens: [] },
+    tokenMetadata: {
+        buyToken: { buyTaxBps: null, sellTaxBps: null },
+        sellToken: { buyTaxBps: null, sellTaxBps: null },
+    },
+    totalNetworkFee: null,
+    zid: 'test',
+    permit2: eip712 ? { type: 'Permit2', hash: '0x1234', eip712 } : null,
+    transaction: {
+        to: '0x1111111111111111111111111111111111111111',
+        data,
+        gas: '100000',
+        gasPrice: '1000000000',
+        value: '0',
+    },
+});
+(0, vitest_1.describe)('getZrxTradeQuote Permit2 deadline', () => {
+    (0, vitest_1.beforeEach)(() => {
+        vitest_1.vi.mocked(fetchFromZrx_1.fetchZrxQuote).mockResolvedValue((0, monads_1.Ok)(quoteResponse(typedData('1791934983'))));
+    });
+    vitest_1.it.each(['1791934983', 1791934983])('uses the provider deadline in milliseconds (%s)', async (deadline) => {
+        const eip712 = typedData(deadline);
+        vitest_1.vi.mocked(fetchFromZrx_1.fetchZrxQuote).mockResolvedValue((0, monads_1.Ok)(quoteResponse(eip712)));
+        const result = await (0, getZrxTradeQuote_1.getZrxTradeQuote)(input, deps);
+        (0, vitest_1.expect)(result.isOk()).toBe(true);
+        const [quote] = result.unwrap();
+        (0, vitest_1.expect)(quote.deadline).toBe(1791934983000);
+        (0, vitest_1.expect)(quote.steps[0].transactionData).toMatchObject({
+            signatureRequired: { eip712 },
+        });
+    });
+    vitest_1.it.each([undefined, null, true, '', 'invalid', '-1', '1.5', '9007199254740991'])('rejects an invalid Permit2 deadline (%s)', async (deadline) => {
+        vitest_1.vi.mocked(fetchFromZrx_1.fetchZrxQuote).mockResolvedValue((0, monads_1.Ok)(quoteResponse(typedData(deadline))));
+        const result = await (0, getZrxTradeQuote_1.getZrxTradeQuote)(input, deps);
+        (0, vitest_1.expect)(result.isErr()).toBe(true);
+        (0, vitest_1.expect)(result.unwrapErr().code).toBe(types_2.TradeQuoteError.InvalidResponse);
+    });
+    (0, vitest_1.it)('reads the NATIVE_CHECK deadline from native-token sell calldata', async () => {
+        vitest_1.vi.mocked(fetchFromZrx_1.fetchZrxQuote).mockResolvedValue((0, monads_1.Ok)(quoteResponse(null, nativeSellCalldata)));
+        const result = await (0, getZrxTradeQuote_1.getZrxTradeQuote)({ ...input, sellAsset: assets_1.ETH }, deps);
+        (0, vitest_1.expect)(result.isOk()).toBe(true);
+        (0, vitest_1.expect)(result.unwrap()[0].deadline).toBe(1791997786000);
+    });
+    (0, vitest_1.it)('leaves native-token quotes without a NATIVE_CHECK action free of a fabricated deadline', async () => {
+        vitest_1.vi.mocked(fetchFromZrx_1.fetchZrxQuote).mockResolvedValue((0, monads_1.Ok)(quoteResponse(null)));
+        const result = await (0, getZrxTradeQuote_1.getZrxTradeQuote)({ ...input, sellAsset: assets_1.ETH }, deps);
+        (0, vitest_1.expect)(result.isOk()).toBe(true);
+        (0, vitest_1.expect)(result.unwrap()[0].deadline).toBeUndefined();
+    });
+});

package/dist/cjs/swappers/ZrxSwapper/types.d.ts

@@ -1,5 +1,6 @@
 import { KnownChainIds } from '@shapeshiftoss/types';
-import type { Address, TypedData } from 'viem';
+import type { TypedData } from 'eip-712';
+import type { Address } from 'viem';
 import type { GetEvmTradeQuoteInput, GetEvmTradeRateInput } from '../../types';
 export type ZrxTradeQuoteInput = GetEvmTradeQuoteInput;
 export type ZrxTradeRateInput = GetEvmTradeRateInput;

package/dist/cjs/swappers/ZrxSwapper/utils/getZrxNativeCheckDeadline.d.ts

@@ -0,0 +1 @@
+export declare const getZrxNativeCheckDeadline: (data: string) => number | undefined;

package/dist/cjs/swappers/ZrxSwapper/utils/getZrxNativeCheckDeadline.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getZrxNativeCheckDeadline = void 0;
+const viem_1 = require("viem");
+const settlerAbi = (0, viem_1.parseAbi)([
+    'function execute((address recipient, address buyToken, uint256 minAmountOut) slippage, bytes[] actions, bytes32 zid)',
+    'function NATIVE_CHECK(uint256 deadline, uint256 msgValue)',
+]);
+const NATIVE_CHECK_SELECTOR = (0, viem_1.toFunctionSelector)('function NATIVE_CHECK(uint256,uint256)');
+// Native sells carry no Permit2, but Settler reverts with SignatureExpired past any NATIVE_CHECK deadline
+const getZrxNativeCheckDeadline = (data) => {
+    try {
+        const { functionName, args } = (0, viem_1.decodeFunctionData)({ abi: settlerAbi, data: data });
+        if (functionName !== 'execute')
+            return undefined;
+        const deadlines = args[1]
+            .filter(action => action.startsWith(NATIVE_CHECK_SELECTOR))
+            .map(action => (0, viem_1.decodeFunctionData)({ abi: settlerAbi, data: action }))
+            .flatMap(decoded => decoded.functionName === 'NATIVE_CHECK' ? [Number(decoded.args[0])] : []);
+        return deadlines.length ? Math.min(...deadlines) : undefined;
+    }
+    catch {
+        return undefined;
+    }
+};
+exports.getZrxNativeCheckDeadline = getZrxNativeCheckDeadline;

package/dist/cjs/types.d.ts

@@ -43,6 +43,7 @@ export type SwapperConfig = {
     VITE_COWSWAP_BASE_URL: string;
     VITE_PORTALS_BASE_URL: string;
     VITE_ZRX_BASE_URL: string;
+    VITE_FYND_BASE_URL: string;
     VITE_CHAINFLIP_API_KEY: string;
     VITE_CHAINFLIP_API_URL: string;
     VITE_FEATURE_CHAINFLIP_SWAP_DCA: boolean;
@@ -56,6 +57,7 @@ export type SwapperConfig = {
     VITE_ACROSS_API_KEY: string;
     VITE_DEBRIDGE_API_URL: string;
     VITE_BOB_GATEWAY_API_KEY: string;
+    VITE_SYMBIOSIS_API_URL: string;
 };
 export declare enum SwapperName {
     Thorchain = "THORChain",
@@ -76,7 +78,9 @@ export declare enum SwapperName {
     Stonfi = "STON.fi",
     Across = "Across",
     Debridge = "deBridge",
-    BobGateway = "BOB Gateway"
+    BobGateway = "BOB Gateway",
+    Symbiosis = "Symbiosis",
+    Fynd = "Fynd"
 }
 export type SwapSource = SwapperName | `${SwapperName} • ${string}`;
 export type SwapErrorRight = {
@@ -343,9 +347,6 @@ export type TradeStepCommon = {
     estimatedExecutionTimeMs: number | undefined;
     swapperMetadata?: SwapperMetadata;
     stonfiTransactionData?: StonfiTransactionData;
-    chainflipSpecific?: {
-        depositAddress?: string;
-    };
     affiliateFee?: AffiliateFee;
 };
 export type TradeQuoteStep = TradeStepCommon & {
@@ -452,7 +453,7 @@ export type TradeQuote = TradeQuoteBase & {
 } & {
     quoteOrRate: 'quote';
     receiveAddress: string;
-    deadline: number;
+    deadline?: number;
 };
 export type MultiHopTradeQuote = TradeQuote & {
     steps: MultiHopTradeQuoteSteps;

package/dist/cjs/types.js

@@ -22,6 +22,8 @@ var SwapperName;
     SwapperName["Across"] = "Across";
     SwapperName["Debridge"] = "deBridge";
     SwapperName["BobGateway"] = "BOB Gateway";
+    SwapperName["Symbiosis"] = "Symbiosis";
+    SwapperName["Fynd"] = "Fynd";
 })(SwapperName || (exports.SwapperName = SwapperName = {}));
 var TradeQuoteError;
 (function (TradeQuoteError) {

package/dist/cjs/utils/helpers.d.ts

@@ -1,7 +1,6 @@
 import type { AssetId, ChainId } from '@shapeshiftoss/caip';
 import type { TradeAmount, TradeStepCommon } from '../types';
 import { SwapperName } from '../types';
-export declare const FALLBACK_QUOTE_DEADLINE_MS = 60000;
 export declare const getTradeAmount: (input: {
     sellAmountIncludingProtocolFeesCryptoBaseUnit: string;
 } | {
@@ -10,5 +9,5 @@ export declare const getTradeAmount: (input: {
 export declare const normalizeEpochToMs: (value: number) => number;
 export declare const isNativeEvmAsset: (assetId: AssetId) => boolean;
 export declare const getTreasuryAddressFromChainId: (chainId: ChainId) => string;
-export type DepositAddressStep = Pick<TradeStepCommon, 'chainflipSpecific' | 'swapperMetadata'>;
+export type DepositAddressStep = Pick<TradeStepCommon, 'swapperMetadata'>;
 export declare const getDepositAddress: (step: DepositAddressStep, swapperName: SwapperName) => string | undefined;

package/dist/cjs/utils/helpers.js

@@ -1,12 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDepositAddress = exports.getTreasuryAddressFromChainId = exports.isNativeEvmAsset = exports.normalizeEpochToMs = exports.getTradeAmount = exports.FALLBACK_QUOTE_DEADLINE_MS = void 0;
+exports.getDepositAddress = exports.getTreasuryAddressFromChainId = exports.isNativeEvmAsset = exports.normalizeEpochToMs = exports.getTradeAmount = void 0;
 const caip_1 = require("@shapeshiftoss/caip");
 const types_1 = require("@shapeshiftoss/types");
 const utils_1 = require("@shapeshiftoss/utils");
 const types_2 = require("../types");
-// Deadline for providers without their own expiry - short enough to keep priced amounts honest
-exports.FALLBACK_QUOTE_DEADLINE_MS = 60_000;
 const getTradeAmount = (input) => 'buyAmountCryptoBaseUnit' in input
     ? { direction: 'exactOut', cryptoBaseUnit: input.buyAmountCryptoBaseUnit }
     : { direction: 'exactIn', cryptoBaseUnit: input.sellAmountIncludingProtocolFeesCryptoBaseUnit };
@@ -23,33 +21,8 @@ const normalizeEpochToMs = (value) => {
 };
 exports.normalizeEpochToMs = normalizeEpochToMs;
 const isNativeEvmAsset = (assetId) => {
-    const { chainId } = (0, caip_1.fromAssetId)(assetId);
-    switch (chainId) {
-        case types_1.KnownChainIds.EthereumMainnet:
-            return assetId === caip_1.ethAssetId;
-        case types_1.KnownChainIds.AvalancheMainnet:
-            return assetId === caip_1.avalancheAssetId;
-        case types_1.KnownChainIds.OptimismMainnet:
-            return assetId === caip_1.optimismAssetId;
-        case types_1.KnownChainIds.BnbSmartChainMainnet:
-            return assetId === caip_1.bscAssetId;
-        case types_1.KnownChainIds.PolygonMainnet:
-            return assetId === caip_1.polygonAssetId;
-        case types_1.KnownChainIds.GnosisMainnet:
-            return assetId === caip_1.gnosisAssetId;
-        case types_1.KnownChainIds.ArbitrumMainnet:
-            return assetId === caip_1.arbitrumAssetId;
-        case types_1.KnownChainIds.BaseMainnet:
-            return assetId === caip_1.baseAssetId;
-        case types_1.KnownChainIds.MonadMainnet:
-            return assetId === caip_1.monadAssetId;
-        case types_1.KnownChainIds.PlasmaMainnet:
-            return assetId === caip_1.plasmaAssetId;
-        case types_1.KnownChainIds.KatanaMainnet:
-            return assetId === caip_1.katanaAssetId;
-        default:
-            return false;
-    }
+    const { chainId, chainNamespace } = (0, caip_1.fromAssetId)(assetId);
+    return chainNamespace === caip_1.CHAIN_NAMESPACE.Evm && assetId === (0, utils_1.chainIdToFeeAssetId)(chainId);
 };
 exports.isNativeEvmAsset = isNativeEvmAsset;
 const DAO_TREASURY_BY_CHAIN_ID = {
@@ -84,8 +57,11 @@ const getTreasuryAddressFromChainId = (chainId) => {
 exports.getTreasuryAddressFromChainId = getTreasuryAddressFromChainId;
 const getDepositAddress = (step, swapperName) => {
     switch (swapperName) {
-        case types_2.SwapperName.Chainflip:
-            return step.chainflipSpecific?.depositAddress || undefined;
+        case types_2.SwapperName.Chainflip: {
+            if (step.swapperMetadata?.name !== 'chainflip')
+                return;
+            return step.swapperMetadata.depositAddress || undefined;
+        }
         case types_2.SwapperName.NearIntents: {
             if (step.swapperMetadata?.name !== 'nearIntents')
                 return;

package/dist/cjs/utils/helpers.test.js

@@ -57,7 +57,9 @@ const helpers_1 = require("./helpers");
 const makeStep = (step) => step;
 (0, vitest_1.describe)('getDepositAddress', () => {
     (0, vitest_1.it)('reads the chainflip deposit address', () => {
-        const step = makeStep({ chainflipSpecific: { depositAddress: 'bc1qdeposit' } });
+        const step = makeStep({
+            swapperMetadata: { name: 'chainflip', swapId: 1, depositAddress: 'bc1qdeposit' },
+        });
         (0, vitest_1.expect)((0, helpers_1.getDepositAddress)(step, types_2.SwapperName.Chainflip)).toBe('bc1qdeposit');
     });
     (0, vitest_1.it)('returns undefined when chainflip has no deposit address', () => {
@@ -80,7 +82,9 @@ const makeStep = (step) => step;
         (0, vitest_1.expect)((0, helpers_1.getDepositAddress)(step, types_2.SwapperName.NearIntents)).toBeUndefined();
     });
     (0, vitest_1.it)('returns undefined for swappers that do not use deposit addresses', () => {
-        const step = makeStep({ chainflipSpecific: { depositAddress: 'bc1qdeposit' } });
+        const step = makeStep({
+            swapperMetadata: { name: 'chainflip', swapId: 1, depositAddress: 'bc1qdeposit' },
+        });
         (0, vitest_1.expect)((0, helpers_1.getDepositAddress)(step, types_2.SwapperName.Relay)).toBeUndefined();
     });
 });