@shapeshiftoss/swapper 17.6.3 → 17.6.5

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

@@ -0,0 +1,18 @@
+import type { ChainId } from '@shapeshiftoss/caip';
+import type { OrderCreation } from '@shapeshiftoss/types';
+export type CowSwapGetTradesResponse = {
+    txHash: string;
+}[];
+export type CowSwapOrdersResponse = {
+    status: 'presignaturePending' | 'open' | 'fulfilled' | 'cancelled' | 'expired';
+};
+export type AffiliateAppDataFragment = {
+    partnerFee?: {
+        bps: number;
+        recipient: string;
+    };
+};
+export type CowMessageToSign = {
+    chainId: ChainId;
+    orderToSign: Omit<OrderCreation, 'signature'>;
+};

package/dist/{swappers/cow → cjs/swappers/CowSwapper}/utils/blacklist.js

@@ -11,4 +11,5 @@ exports.COWSWAP_UNSUPPORTED_ASSETS = Object.freeze([
      * as it's exchangeable value for native RUNE is currently decaying from 1 towards 0
      */
     'eip155:1/erc20:0x3155ba85d5f96b2d030a4966af206230e46849cb',
+    'eip155:100/erc20:0x51951afd273dec66d5c737f667cc8d1f5c8edf32',
 ]);

package/dist/cjs/swappers/CowSwapper/utils/cowService.d.ts

@@ -0,0 +1,6 @@
+import type { AxiosRequestConfig } from 'axios';
+export declare const cowService: {
+    get: <T = any>(url: string, config?: AxiosRequestConfig<any> | undefined) => Promise<import("@sniptt/monads").Result<import("axios").AxiosResponse<T, any, {}>, import("../../..").SwapErrorRight>>;
+    post: <T_1 = any>(url: string, data: any, config?: AxiosRequestConfig<any> | undefined) => Promise<import("@sniptt/monads").Result<import("axios").AxiosResponse<T_1, any, {}>, import("../../..").SwapErrorRight>>;
+    delete: <T_2 = any>(url: string, data: any, config?: AxiosRequestConfig<any> | undefined) => Promise<import("@sniptt/monads").Result<import("axios").AxiosResponse<T_2, any, {}>, import("../../..").SwapErrorRight>>;
+};

package/dist/cjs/swappers/CowSwapper/utils/cowService.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cowService = void 0;
+const utils_1 = require("../../../utils");
+const maxAge = 5 * 1000; // 5 seconds
+const cachedUrls = ['/mainnet/api/v1/quote', '/xdai/api/v1/quote'];
+const axiosConfig = {
+    timeout: 10000,
+    headers: {
+        Accept: 'application/json',
+        'Content-Type': 'application/json',
+    },
+};
+const cowServiceBase = (0, utils_1.createCache)(maxAge, cachedUrls, axiosConfig);
+exports.cowService = (0, utils_1.makeSwapperAxiosServiceMonadic)(cowServiceBase);

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

@@ -0,0 +1,44 @@
+import type { ChainId } from '@shapeshiftoss/caip';
+import type { Asset, OrderQuoteResponse } from '@shapeshiftoss/types';
+import type { Result } from '@sniptt/monads';
+import type { SwapErrorRight } from '../../../../types';
+export type CowSwapQuoteApiInputBase = {
+    appData: string;
+    appDataHash?: string;
+    buyToken: string;
+    from: string;
+    kind: string;
+    partiallyFillable: boolean;
+    receiver: string;
+    sellToken: string;
+    validTo: number;
+};
+export type CowSwapSellQuoteApiInput = CowSwapQuoteApiInputBase & {
+    sellAmountBeforeFee: string;
+};
+export declare const getNowPlusThirtyMinutesTimestamp: () => number;
+export declare const assertValidTrade: ({ buyAsset, sellAsset, supportedChainIds, }: {
+    buyAsset: Asset;
+    sellAsset: Asset;
+    supportedChainIds: ChainId[];
+}) => Result<boolean, SwapErrorRight>;
+type GetValuesFromQuoteResponseArgs = {
+    buyAsset: Asset;
+    sellAsset: Asset;
+    response: OrderQuoteResponse;
+    affiliateBps: string;
+    slippageTolerancePercentageDecimal: string;
+};
+export declare const deductAffiliateFeesFromAmount: ({ amount, affiliateBps, }: {
+    amount: string;
+    affiliateBps: string;
+}) => string;
+export declare const deductSlippageFromAmount: ({ amount, slippageTolerancePercentageDecimal, }: {
+    amount: string;
+    slippageTolerancePercentageDecimal: string;
+}) => string;
+export declare const getValuesFromQuoteResponse: ({ buyAsset, sellAsset, response, affiliateBps, slippageTolerancePercentageDecimal, }: GetValuesFromQuoteResponseArgs) => {
+    buyAmountBeforeFeesCryptoBaseUnit: string;
+    buyAmountAfterFeesCryptoBaseUnit: string;
+};
+export {};

package/dist/cjs/swappers/CowSwapper/utils/helpers/helpers.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getValuesFromQuoteResponse = exports.deductSlippageFromAmount = exports.deductAffiliateFeesFromAmount = exports.assertValidTrade = exports.getNowPlusThirtyMinutesTimestamp = void 0;
+const caip_1 = require("@shapeshiftoss/caip");
+const utils_1 = require("@shapeshiftoss/utils");
+const monads_1 = require("@sniptt/monads");
+const types_1 = require("../../../../types");
+const utils_2 = require("../../../../utils");
+const getNowPlusThirtyMinutesTimestamp = () => {
+    const ts = new Date();
+    ts.setMinutes(ts.getMinutes() + 30);
+    return Math.round(ts.getTime() / 1000);
+};
+exports.getNowPlusThirtyMinutesTimestamp = getNowPlusThirtyMinutesTimestamp;
+const assertValidTrade = ({ buyAsset, sellAsset, supportedChainIds, }) => {
+    if (!supportedChainIds.includes(sellAsset.chainId)) {
+        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
+            message: `[CowSwap: assertValidTrade] - unsupported chainId`,
+            code: types_1.TradeQuoteError.UnsupportedChain,
+            details: { chainId: sellAsset.chainId },
+        }));
+    }
+    if (sellAsset.chainId !== buyAsset.chainId) {
+        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
+            message: `[CowSwap: assertValidTrade] - both assets must be on chainId ${sellAsset.chainId}`,
+            code: types_1.TradeQuoteError.CrossChainNotSupported,
+            details: { buyAsset, sellAsset },
+        }));
+    }
+    if ((0, caip_1.fromAssetId)(sellAsset.assetId).assetNamespace !== 'erc20') {
+        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
+            message: '[CowSwap: assertValidTrade] - Sell asset must be an ERC-20',
+            code: types_1.TradeQuoteError.UnsupportedTradePair,
+            details: { sellAsset },
+        }));
+    }
+    return (0, monads_1.Ok)(true);
+};
+exports.assertValidTrade = assertValidTrade;
+const deductAffiliateFeesFromAmount = ({ amount, affiliateBps, }) => {
+    const hasAffiliateFee = (0, utils_1.bnOrZero)(affiliateBps).gt(0);
+    if (!hasAffiliateFee)
+        return amount;
+    return (0, utils_1.bn)(amount)
+        .times((0, utils_1.bn)(1).minus((0, utils_1.convertBasisPointsToDecimalPercentage)(affiliateBps)))
+        .toFixed(0);
+};
+exports.deductAffiliateFeesFromAmount = deductAffiliateFeesFromAmount;
+const deductSlippageFromAmount = ({ amount, slippageTolerancePercentageDecimal, }) => {
+    return (0, utils_1.bn)(amount).minus((0, utils_1.bn)(amount).times(slippageTolerancePercentageDecimal)).toFixed(0);
+};
+exports.deductSlippageFromAmount = deductSlippageFromAmount;
+const getValuesFromQuoteResponse = ({ buyAsset, sellAsset, response, affiliateBps, slippageTolerancePercentageDecimal, }) => {
+    const { sellAmount: sellAmountAfterFeesCryptoBaseUnit, feeAmount: feeAmountInSellTokenCryptoBaseUnit, buyAmount, } = response.quote;
+    // Remove affiliate fees off the buyAmount to get the amount after affiliate fees
+    const buyAmountAfterAffiliateFeesCryptoBaseUnit = (0, exports.deductAffiliateFeesFromAmount)({
+        amount: buyAmount,
+        affiliateBps,
+    });
+    // And then remove slippage to get min out - note, order matters here, as the math used by CoW for the minimum
+    // is (quoted out - affiliate - slippage)
+    const buyAmountAfterAffiliateFeesAndSlippage = (0, exports.deductSlippageFromAmount)({
+        amount: buyAmountAfterAffiliateFeesCryptoBaseUnit,
+        slippageTolerancePercentageDecimal,
+    });
+    const buyAmountAfterAffiliateFeesCryptoPrecision = (0, utils_1.fromBaseUnit)(buyAmountAfterAffiliateFeesCryptoBaseUnit, buyAsset.precision);
+    const sellAmountCryptoPrecision = (0, utils_1.fromBaseUnit)(sellAmountAfterFeesCryptoBaseUnit, sellAsset.precision);
+    const rate = (0, utils_1.bnOrZero)(buyAmountAfterAffiliateFeesCryptoPrecision)
+        .div(sellAmountCryptoPrecision)
+        .toString();
+    const sellAmountBeforeFeesCryptoBaseUnit = (0, utils_1.bnOrZero)(sellAmountAfterFeesCryptoBaseUnit)
+        .plus(feeAmountInSellTokenCryptoBaseUnit)
+        .toFixed();
+    const buyAmountBeforeAffiliateAndProtocolFeesCryptoBaseUnit = (0, utils_1.convertPrecision)({
+        value: sellAmountBeforeFeesCryptoBaseUnit,
+        inputExponent: sellAsset.precision,
+        outputExponent: buyAsset.precision,
+    })
+        .times(rate)
+        .toFixed(0);
+    return {
+        buyAmountBeforeFeesCryptoBaseUnit: buyAmountBeforeAffiliateAndProtocolFeesCryptoBaseUnit,
+        buyAmountAfterFeesCryptoBaseUnit: buyAmountAfterAffiliateFeesAndSlippage,
+    };
+};
+exports.getValuesFromQuoteResponse = getValuesFromQuoteResponse;

package/dist/cjs/swappers/CowSwapper/utils/helpers/helpers.test.d.ts

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

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

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const cowswap_utils_1 = require("../../../../cowswap-utils");
+const helpers_1 = require("./helpers");
+vitest_1.vi.mock('../cowService', async () => {
+    const axios = await vitest_1.vi.importMock('axios');
+    axios.create = vitest_1.vi.fn(() => axios);
+    return {
+        cowService: axios.create(),
+    };
+});
+(0, vitest_1.describe)('utils', () => {
+    (0, vitest_1.describe)('getNowPlusThirtyMinutesTimestamp', () => {
+        const mockDay = '2020-12-31';
+        const mockTime = 'T23:59:59.000Z';
+        const mockDate = `${mockDay}${mockTime}`;
+        (0, vitest_1.beforeEach)(() => vitest_1.vi
+            .useFakeTimers()
+            .setSystemTime(new Date(mockDate)));
+        (0, vitest_1.afterEach)(() => {
+            vitest_1.vi.restoreAllMocks();
+            vitest_1.vi.useRealTimers();
+        });
+        (0, vitest_1.it)('should return the timestamp corresponding to current time + 30 minutes (UTC)', () => {
+            const timestamp = (0, helpers_1.getNowPlusThirtyMinutesTimestamp)();
+            (0, vitest_1.expect)(timestamp).toEqual(1609460999);
+            (0, vitest_1.expect)(new Date(timestamp * 1000).toUTCString()).toEqual('Fri, 01 Jan 2021 00:29:59 GMT');
+        });
+    });
+    (0, vitest_1.describe)('getFullAppData', () => {
+        (0, vitest_1.it)('should return correct AppData for given inputs for no affiliate fee', async () => {
+            const slippageTolerancePercentage = '0.005'; // 0.5%
+            const affiliateAppDataFragment = {}; // no affiliate fee
+            const result = await (0, cowswap_utils_1.getFullAppData)(slippageTolerancePercentage, affiliateAppDataFragment, 'market');
+            (0, vitest_1.expect)(result).toHaveProperty('appDataHash');
+            (0, vitest_1.expect)(result).toHaveProperty('appData');
+            (0, vitest_1.expect)(result).toEqual({
+                appDataHash: '0x41fffc0127f56060cc551652721d84c336f87649a20c51fcff5b8841dfeabe5b',
+                appData: '{"appCode":"shapeshift","metadata":{"orderClass":{"orderClass":"market"},"quote":{"slippageBips":50}},"version":"1.3.0"}',
+            });
+        });
+        (0, vitest_1.it)('should return correct AppData for given inputs for affiliate fee', async () => {
+            const slippageTolerancePercentage = '0.005'; // 0.5%
+            const affiliateAppDataFragment = {
+                partnerFee: {
+                    bps: 48,
+                    recipient: '0xb0E3175341794D1dc8E5F02a02F9D26989EbedB3',
+                },
+            };
+            const result = await (0, cowswap_utils_1.getFullAppData)(slippageTolerancePercentage, affiliateAppDataFragment, 'market');
+            (0, vitest_1.expect)(result).toHaveProperty('appDataHash');
+            (0, vitest_1.expect)(result).toHaveProperty('appData');
+            (0, vitest_1.expect)(result).toEqual({
+                appDataHash: '0x6a731164dc2bb01874c1537079a3f543894da3b5803dcfed23aaf8396c919be2',
+                appData: '{"appCode":"shapeshift","metadata":{"orderClass":{"orderClass":"market"},"partnerFee":{"bps":48,"recipient":"0xb0E3175341794D1dc8E5F02a02F9D26989EbedB3"},"quote":{"slippageBips":50}},"version":"1.3.0"}',
+            });
+        });
+    });
+});

package/dist/cjs/swappers/JupiterSwapper/JupiterSwapper.d.ts

@@ -0,0 +1,2 @@
+import type { Swapper } from '../../types';
+export declare const jupiterSwapper: Swapper;

package/dist/cjs/swappers/JupiterSwapper/JupiterSwapper.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jupiterSwapper = void 0;
+const __1 = require("../..");
+const errorPatterns_1 = require("./errorPatterns");
+exports.jupiterSwapper = {
+    executeSolanaTransaction: async (txToSign, callbacks) => {
+        try {
+            const txid = await (0, __1.executeSolanaTransaction)(txToSign, callbacks);
+            return txid;
+        }
+        catch (e) {
+            if (e instanceof Error) {
+                const errorMessage = e.message;
+                const swapperErrorType = Object.keys(errorPatterns_1.JUPITER_ERRORS).reduce((acc, errorPattern) => {
+                    if (errorMessage.includes(errorPattern)) {
+                        acc = errorPatterns_1.JUPITER_ERRORS[errorPattern];
+                    }
+                    return acc;
+                }, undefined);
+                if (swapperErrorType)
+                    throw new errorPatterns_1.SolanaLogsError(swapperErrorType);
+            }
+            throw e;
+        }
+    },
+};

package/dist/cjs/swappers/JupiterSwapper/endpoints.d.ts

@@ -0,0 +1,2 @@
+import type { SwapperApi } from '../../types';
+export declare const jupiterApi: SwapperApi;

package/dist/cjs/swappers/JupiterSwapper/endpoints.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jupiterApi = void 0;
+const getSolanaTransactionFees_1 = require("../../solana-utils/getSolanaTransactionFees");
+const getUnsignedSolanaTransaction_1 = require("../../solana-utils/getUnsignedSolanaTransaction");
+const utils_1 = require("../../utils");
+const getTradeQuote_1 = require("./swapperApi/getTradeQuote");
+const getTradeRate_1 = require("./swapperApi/getTradeRate");
+exports.jupiterApi = {
+    getTradeRate: getTradeRate_1.getTradeRate,
+    getTradeQuote: getTradeQuote_1.getTradeQuote,
+    getUnsignedSolanaTransaction: getUnsignedSolanaTransaction_1.getUnsignedSolanaTransaction,
+    getSolanaTransactionFees: getSolanaTransactionFees_1.getSolanaTransactionFees,
+    checkTradeStatus: utils_1.checkSolanaSwapStatus,
+};

package/dist/cjs/swappers/JupiterSwapper/errorPatterns.d.ts

@@ -0,0 +1,15 @@
+export declare class SolanaLogsError extends Error {
+    constructor(name: string);
+}
+export declare enum JUPITER_ERROR_PATTERNS {
+    SLIPPAGE_TOLERANCE_EXCEEDED = "SlippageToleranceExceeded",
+    JUPITER_SLIPPAGE_ERROR_CODE = "0x1771",
+    UNDER_MINIMUM_AMOUNT = "RequireGteViolated",
+    CONSUMED_MORE_FEES = "exceeded CUs meter"
+}
+export declare enum JUPITER_ERROR_NAME {
+    SLIPPAGE_TOLERANCE_EXCEEDED = "SlippageToleranceExceeded",
+    UNDER_MINIMUM_AMOUNT = "UnderMinimumAmount",
+    CONSUMED_MORE_FEES = "ConsumedMoreFees"
+}
+export declare const JUPITER_ERRORS: Record<JUPITER_ERROR_PATTERNS | string, string>;

package/dist/cjs/swappers/JupiterSwapper/errorPatterns.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JUPITER_ERRORS = exports.JUPITER_ERROR_NAME = exports.JUPITER_ERROR_PATTERNS = exports.SolanaLogsError = void 0;
+class SolanaLogsError extends Error {
+    constructor(name) {
+        super(name);
+        this.name = name;
+    }
+}
+exports.SolanaLogsError = SolanaLogsError;
+var JUPITER_ERROR_PATTERNS;
+(function (JUPITER_ERROR_PATTERNS) {
+    JUPITER_ERROR_PATTERNS["SLIPPAGE_TOLERANCE_EXCEEDED"] = "SlippageToleranceExceeded";
+    JUPITER_ERROR_PATTERNS["JUPITER_SLIPPAGE_ERROR_CODE"] = "0x1771";
+    JUPITER_ERROR_PATTERNS["UNDER_MINIMUM_AMOUNT"] = "RequireGteViolated";
+    JUPITER_ERROR_PATTERNS["CONSUMED_MORE_FEES"] = "exceeded CUs meter";
+})(JUPITER_ERROR_PATTERNS || (exports.JUPITER_ERROR_PATTERNS = JUPITER_ERROR_PATTERNS = {}));
+var JUPITER_ERROR_NAME;
+(function (JUPITER_ERROR_NAME) {
+    JUPITER_ERROR_NAME["SLIPPAGE_TOLERANCE_EXCEEDED"] = "SlippageToleranceExceeded";
+    JUPITER_ERROR_NAME["UNDER_MINIMUM_AMOUNT"] = "UnderMinimumAmount";
+    JUPITER_ERROR_NAME["CONSUMED_MORE_FEES"] = "ConsumedMoreFees";
+})(JUPITER_ERROR_NAME || (exports.JUPITER_ERROR_NAME = JUPITER_ERROR_NAME = {}));
+exports.JUPITER_ERRORS = {
+    [JUPITER_ERROR_PATTERNS.SLIPPAGE_TOLERANCE_EXCEEDED]: JUPITER_ERROR_NAME.SLIPPAGE_TOLERANCE_EXCEEDED,
+    [JUPITER_ERROR_PATTERNS.JUPITER_SLIPPAGE_ERROR_CODE]: JUPITER_ERROR_NAME.SLIPPAGE_TOLERANCE_EXCEEDED,
+    [JUPITER_ERROR_PATTERNS.UNDER_MINIMUM_AMOUNT]: JUPITER_ERROR_NAME.UNDER_MINIMUM_AMOUNT,
+    [JUPITER_ERROR_PATTERNS.CONSUMED_MORE_FEES]: JUPITER_ERROR_NAME.CONSUMED_MORE_FEES,
+};