@shapeshiftoss/swapper 17.8.0 → 18.1.0

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

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getZrxTradeContext = void 0;
+const contracts_1 = require("@shapeshiftoss/contracts");
+const monads_1 = require("@sniptt/monads");
+const uuid_1 = require("uuid");
+const types_1 = require("../../../types");
+const affiliateFee_1 = require("../../../utils/affiliateFee");
+const helpers_1 = require("../../../utils/helpers");
+const helpers_2 = require("./helpers");
+const getZrxTradeContext = ({ input, deps, slippageTolerancePercentageDecimal, normalizedQuote, }) => {
+    const { assetsById } = deps;
+    const { sellAsset, buyAsset, affiliateBps, sellAmountIncludingProtocolFeesCryptoBaseUnit } = input;
+    const { buyAmount, sellAmount, fees, route } = normalizedQuote;
+    const rate = (0, helpers_2.calculateRate)({ buyAmount, sellAmount, buyAsset, sellAsset });
+    const maybeBuyAmountBeforeFeesCryptoBaseUnit = (0, helpers_2.calculateBuyAmountBeforeFeesCryptoBaseUnit)({
+        buyAmount,
+        fees,
+        buyAsset,
+        sellAsset,
+    });
+    if (maybeBuyAmountBeforeFeesCryptoBaseUnit.isErr())
+        return (0, monads_1.Err)(maybeBuyAmountBeforeFeesCryptoBaseUnit.unwrapErr());
+    // Native and fully wrapped-native sells need no Permit2 approval
+    const allowanceContract = (0, helpers_1.isNativeEvmAsset)(sellAsset.assetId) || (0, helpers_2.isWrappedNativeSell)(route) ? '' : contracts_1.PERMIT2_CONTRACT;
+    return (0, monads_1.Ok)({
+        tradeCommon: {
+            id: (0, uuid_1.v4)(),
+            rate,
+            swapperName: types_1.SwapperName.Zrx,
+            affiliateBps,
+            // Slippage protection is always enabled for 0x api v2 unlike api v1 which was only supported on specific pairs.
+            slippageTolerancePercentageDecimal,
+        },
+        stepCommon: {
+            // Assume instant execution since this is a same-chain AMM Tx which will happen within the same block
+            estimatedExecutionTimeMs: 0,
+            allowanceContract,
+            rate,
+            buyAsset,
+            sellAsset,
+            buyAmountBeforeFeesCryptoBaseUnit: maybeBuyAmountBeforeFeesCryptoBaseUnit.unwrap(),
+            buyAmountAfterFeesCryptoBaseUnit: buyAmount,
+            sellAmountIncludingProtocolFeesCryptoBaseUnit,
+            source: types_1.SwapperName.Zrx,
+            affiliateFee: (0, affiliateFee_1.buildAffiliateFee)({
+                strategy: 'buy_asset',
+                affiliateBps,
+                sellAsset,
+                buyAsset,
+                sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
+                buyAmountCryptoBaseUnit: buyAmount,
+            }),
+        },
+        protocolFees: (0, helpers_2.getProtocolFees)({ fees, sellAsset, assetsById }),
+        stepDataArgs: { deps, sellAsset },
+    });
+};
+exports.getZrxTradeContext = getZrxTradeContext;

package/dist/cjs/swappers/ZrxSwapper/utils/{helpers/helpers.d.ts → helpers.d.ts}

@@ -1,14 +1,17 @@
 import type { AssetId, ChainId } from '@shapeshiftoss/caip';
 import type { Asset, AssetsByIdPartial } from '@shapeshiftoss/types';
 import { KnownChainIds } from '@shapeshiftoss/types';
-import type { ZrxFees } from '../../types';
+import type { Result } from '@sniptt/monads';
+import type { SwapErrorRight } from '../../../types';
+import type { ZrxFees, ZrxPriceResponse } from '../types';
 export declare const assetIdToZrxToken: (assetId: AssetId) => string;
 export declare const zrxTokenToAssetId: (token: string, chainId: ChainId) => AssetId;
 export declare const isSupportedChainId: (chainId: ChainId) => chainId is KnownChainIds.EthereumMainnet | KnownChainIds.AvalancheMainnet | KnownChainIds.OptimismMainnet | KnownChainIds.BnbSmartChainMainnet | KnownChainIds.PolygonMainnet | KnownChainIds.ArbitrumMainnet | KnownChainIds.BaseMainnet;
+export declare const isWrappedNativeSell: (route: ZrxPriceResponse['route']) => boolean;
 export declare const assertValidTrade: ({ buyAsset, sellAsset, }: {
     buyAsset: Asset;
     sellAsset: Asset;
-}) => import("@sniptt/monads/build/result/result").ResErr<unknown, import("../../../../types").SwapErrorRight> | import("@sniptt/monads/build/result/result").ResOk<boolean, never>;
+}) => import("@sniptt/monads/build/result/result").ResOk<boolean, never> | import("@sniptt/monads/build/result/result").ResErr<unknown, SwapErrorRight>;
 export declare const calculateRate: ({ buyAmount, sellAmount, buyAsset, sellAsset, }: {
     buyAmount: string;
     sellAmount: string;
@@ -20,7 +23,7 @@ export declare const calculateBuyAmountBeforeFeesCryptoBaseUnit: ({ buyAmount, f
     fees: ZrxFees;
     buyAsset: Asset;
     sellAsset: Asset;
-}) => string | import("@sniptt/monads/build/result/result").ResErr<unknown, import("../../../../types").SwapErrorRight>;
+}) => Result<string, SwapErrorRight>;
 export declare const getProtocolFees: ({ fees, sellAsset, assetsById, }: {
     fees: ZrxFees;
     sellAsset: Asset;

package/dist/cjs/swappers/ZrxSwapper/utils/{helpers/helpers.js → helpers.js}

@@ -1,15 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getProtocolFees = exports.calculateBuyAmountBeforeFeesCryptoBaseUnit = exports.calculateRate = exports.assertValidTrade = exports.isSupportedChainId = exports.zrxTokenToAssetId = exports.assetIdToZrxToken = void 0;
+exports.getProtocolFees = exports.calculateBuyAmountBeforeFeesCryptoBaseUnit = exports.calculateRate = exports.assertValidTrade = exports.isWrappedNativeSell = exports.isSupportedChainId = exports.zrxTokenToAssetId = exports.assetIdToZrxToken = void 0;
 const caip_1 = require("@shapeshiftoss/caip");
 const types_1 = require("@shapeshiftoss/types");
 const utils_1 = require("@shapeshiftoss/utils");
 const monads_1 = require("@sniptt/monads");
 const viem_1 = require("viem");
-const types_2 = require("../../../../types");
-const utils_2 = require("../../../../utils");
-const types_3 = require("../../types");
-const constants_1 = require("../constants");
+const types_2 = require("../../../types");
+const utils_2 = require("../../../utils");
+const types_3 = require("../types");
+const constants_1 = require("./constants");
 // converts an asset to zrx token (symbol or contract address)
 const assetIdToZrxToken = (assetId) => {
     const { assetReference, assetNamespace } = (0, caip_1.fromAssetId)(assetId);
@@ -75,6 +75,9 @@ const isSupportedChainId = (chainId) => {
     return types_3.zrxSupportedChainIds.includes(chainId);
 };
 exports.isSupportedChainId = isSupportedChainId;
+// A fully wrapped-native sell (e.g. WETH->ETH) needs no Permit2 allowance
+const isWrappedNativeSell = (route) => route.fills.some(fill => fill.source === 'Wrapped_Native' && fill.proportionBps === '10000');
+exports.isWrappedNativeSell = isWrappedNativeSell;
 const assertValidTrade = ({ buyAsset, sellAsset, }) => {
     const sellAssetChainId = sellAsset.chainId;
     const buyAssetChainId = buyAsset.chainId;
@@ -125,7 +128,7 @@ const calculateBuyAmountBeforeFeesCryptoBaseUnit = ({ buyAmount, fees, buyAsset,
     }
     // We can safely add the integrator fee now we know its the correct asset.
     const integratorFeeCryptoBaseUnit = fees.integratorFee?.amount ?? '0';
-    return (0, utils_1.bn)(buyAmount).plus(integratorFeeCryptoBaseUnit).toFixed();
+    return (0, monads_1.Ok)((0, utils_1.bn)(buyAmount).plus(integratorFeeCryptoBaseUnit).toFixed());
 };
 exports.calculateBuyAmountBeforeFeesCryptoBaseUnit = calculateBuyAmountBeforeFeesCryptoBaseUnit;
 const getProtocolFees = ({ fees, sellAsset, assetsById, }) => {