@shapeshiftoss/swapper 17.8.0 → 19.0.0

package/dist/cjs/swappers/PortalsSwapper/getPortalsTradeQuote/getPortalsTradeQuote.js

@@ -1,230 +1,157 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPortalsTradeQuote = void 0;
-const caip_1 = require("@shapeshiftoss/caip");
-const chain_adapters_1 = require("@shapeshiftoss/chain-adapters");
 const utils_1 = require("@shapeshiftoss/utils");
 const monads_1 = require("@sniptt/monads");
-const viem_1 = require("viem");
-const __1 = require("../../..");
 const types_1 = require("../../../types");
 const utils_2 = require("../../../utils");
-const affiliateFee_1 = require("../../utils/affiliateFee");
-const helpers_1 = require("../../utils/helpers/helpers");
-const constants_1 = require("../constants");
+const helpers_1 = require("../../../utils/helpers");
 const fetchPortalsTradeOrder_1 = require("../utils/fetchPortalsTradeOrder");
+const getPortalsStepData_1 = require("../utils/getPortalsStepData");
+const getPortalsTradeContext_1 = require("../utils/getPortalsTradeContext");
 const helpers_2 = require("../utils/helpers");
-async function getPortalsTradeQuote(input, assertGetEvmChainAdapter, swapperConfig) {
-    const { sellAsset, buyAsset, sendAddress, accountNumber, affiliateBps, chainId, supportsEIP1559, sellAmountIncludingProtocolFeesCryptoBaseUnit, } = input;
-    const sellAssetChainId = sellAsset.chainId;
-    const buyAssetChainId = buyAsset.chainId;
-    if (!(0, helpers_2.isSupportedChainId)(sellAssetChainId)) {
-        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
-            message: `unsupported chainId`,
-            code: types_1.TradeQuoteError.UnsupportedChain,
-            details: { chainId: sellAsset.chainId },
-        }));
-    }
-    if (!(0, helpers_2.isSupportedChainId)(buyAssetChainId)) {
-        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
-            message: `unsupported chainId`,
-            code: types_1.TradeQuoteError.UnsupportedChain,
-            details: { chainId: buyAsset.chainId },
-        }));
-    }
-    const isCrossChain = sellAssetChainId !== buyAssetChainId;
-    // Not a decimal percentage, just a good ol' percentage e.g 1 for 1%
-    const affiliateBpsPercentage = (0, utils_1.convertBasisPointsToDecimalPercentage)(affiliateBps)
-        .times(100)
-        .toNumber();
-    const userSlippageTolerancePercentageDecimalOrDefault = input.slippageTolerancePercentageDecimal
-        ? (0, utils_1.bnOrZero)(input.slippageTolerancePercentageDecimal).times(100).toNumber()
-        : (0, utils_1.bnOrZero)((0, __1.getDefaultSlippageDecimalPercentageForSwapper)(types_1.SwapperName.Portals))
-            .times(100)
-            .toNumber();
-    if (!sendAddress)
-        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({ message: 'missing sendAddress' }));
-    const sellPortalsNetwork = constants_1.chainIdToPortalsNetwork[sellAssetChainId];
-    const buyPortalsNetwork = constants_1.chainIdToPortalsNetwork[buyAssetChainId];
-    if (!sellPortalsNetwork) {
-        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
-            message: `unsupported ChainId`,
-            code: types_1.TradeQuoteError.UnsupportedChain,
-            details: { chainId: sellAssetChainId },
-        }));
-    }
-    if (!buyPortalsNetwork) {
-        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
-            message: `unsupported ChainId`,
-            code: types_1.TradeQuoteError.UnsupportedChain,
-            details: { chainId: buyAssetChainId },
-        }));
-    }
-    const sellAssetAddress = (0, helpers_1.isNativeEvmAsset)(sellAsset.assetId)
-        ? viem_1.zeroAddress
-        : (0, caip_1.fromAssetId)(sellAsset.assetId).assetReference;
-    const buyAssetAddress = (0, helpers_1.isNativeEvmAsset)(buyAsset.assetId)
-        ? viem_1.zeroAddress
-        : (0, caip_1.fromAssetId)(buyAsset.assetId).assetReference;
-    const inputToken = `${sellPortalsNetwork}:${sellAssetAddress}`;
-    const outputToken = `${buyPortalsNetwork}:${buyAssetAddress}`;
-    try {
-        const maybePortalsTradeOrderResponse = await (0, fetchPortalsTradeOrder_1.fetchPortalsTradeOrder)({
+const getPortalsTradeQuote = async (input, deps) => {
+    const { sellAsset, buyAsset, accountNumber, affiliateBps, sellAmountIncludingProtocolFeesCryptoBaseUnit, } = input;
+    const assertion = (0, helpers_2.assertValidTrade)({ sellAsset, buyAsset });
+    if (assertion.isErr())
+        return (0, monads_1.Err)(assertion.unwrapErr());
+    const { sellChainId } = assertion.unwrap();
+    const addresses = (0, utils_2.assertQuoteAddresses)(input);
+    if (addresses.isErr())
+        return (0, monads_1.Err)(addresses.unwrapErr());
+    const { sendAddress, receiveAddress } = addresses.unwrap();
+    const maybeTokens = (0, helpers_2.getPortalsTokens)({ sellAsset, buyAsset });
+    if (maybeTokens.isErr())
+        return (0, monads_1.Err)(maybeTokens.unwrapErr());
+    const { inputToken, outputToken } = maybeTokens.unwrap();
+    const { affiliateBpsPercentage, slippageTolerancePercentage } = (0, helpers_2.getPortalsPercentages)({
+        affiliateBps,
+        slippageTolerancePercentageDecimal: input.slippageTolerancePercentageDecimal,
+    });
+    const maybePortalsTradeOrderResponse = await (0, fetchPortalsTradeOrder_1.fetchPortalsTradeOrder)({
+        sender: sendAddress,
+        inputToken,
+        outputToken,
+        inputAmount: sellAmountIncludingProtocolFeesCryptoBaseUnit,
+        slippageTolerancePercentage,
+        partner: (0, helpers_1.getTreasuryAddressFromChainId)(sellChainId),
+        feePercentage: affiliateBpsPercentage,
+        validate: true,
+        swapperConfig: deps.config,
+    })
+        .then(res => (0, monads_1.Ok)(res))
+        .catch(async (err) => {
+        if (err instanceof fetchPortalsTradeOrder_1.PortalsError) {
+            // We assume a PortalsError was thrown because the slippage tolerance was too high during simulation
+            // So we attempt another (failing) call with autoslippage which will give us the actual expected slippage
+            const portalsExpectedSlippage = await (0, fetchPortalsTradeOrder_1.fetchPortalsTradeOrder)({
+                sender: sendAddress,
+                inputToken,
+                outputToken,
+                inputAmount: sellAmountIncludingProtocolFeesCryptoBaseUnit,
+                autoSlippage: true,
+                partner: (0, helpers_1.getTreasuryAddressFromChainId)(sellChainId),
+                feePercentage: affiliateBpsPercentage,
+                validate: true,
+                swapperConfig: deps.config,
+            })
+                // This should never happen but could in very rare cases if original call failed on slippage slightly over 2.5% but this one succeeds on slightly under 2.5%
+                .then(res => res.context.slippageTolerancePercentage)
+                .catch(err => err.message.match(/Expected slippage is (.*?)%/)?.[1]);
+            // This should never happen as we don't have auto-slippage on for `/portal` as of now (2024-12-06, see https://github.com/shapeshift/web/pull/8293)
+            // But as soon as Portals implement auto-slippage for the estimate endpoint, we will most likely re-enable it, assuming it actually works
+            if (err.message.includes('Auto slippage exceeds'))
+                return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
+                    message: err.message,
+                    details: {
+                        expectedSlippage: portalsExpectedSlippage
+                            ? (0, utils_1.bn)(portalsExpectedSlippage).toFixed(2, utils_1.BigNumber.ROUND_HALF_UP)
+                            : undefined,
+                    },
+                    cause: err,
+                    code: types_1.TradeQuoteError.FinalQuoteMaxSlippageExceeded,
+                }));
+            if (err.message.includes('execution reverted'))
+                return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
+                    message: err.message,
+                    details: {
+                        expectedSlippage: portalsExpectedSlippage
+                            ? (0, utils_1.bn)(portalsExpectedSlippage).toFixed(2, utils_1.BigNumber.ROUND_HALF_UP)
+                            : undefined,
+                    },
+                    cause: err,
+                    code: types_1.TradeQuoteError.FinalQuoteExecutionReverted,
+                }));
+        }
+        // Validation simulates with the sender's live state, so an unapproved sender fails the
+        // order outright - refetch without validation and estimate under state override instead
+        return (0, fetchPortalsTradeOrder_1.fetchPortalsTradeOrder)({
             sender: sendAddress,
             inputToken,
             outputToken,
             inputAmount: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-            slippageTolerancePercentage: userSlippageTolerancePercentageDecimalOrDefault,
-            partner: (0, helpers_1.getTreasuryAddressFromChainId)(sellAsset.chainId),
+            slippageTolerancePercentage,
+            partner: (0, helpers_1.getTreasuryAddressFromChainId)(sellChainId),
             feePercentage: affiliateBpsPercentage,
-            validate: true,
-            swapperConfig,
+            validate: false,
+            swapperConfig: deps.config,
         })
             .then(res => (0, monads_1.Ok)(res))
-            .catch(async (err) => {
-            if (err instanceof fetchPortalsTradeOrder_1.PortalsError) {
-                // We assume a PortalsError was thrown because the slippage tolerance was too high during simulation
-                // So we attempt another (failing) call with autoslippage which will give us the actual expected slippage
-                const portalsExpectedSlippage = await (0, fetchPortalsTradeOrder_1.fetchPortalsTradeOrder)({
-                    sender: sendAddress,
-                    inputToken,
-                    outputToken,
-                    inputAmount: sellAmountIncludingProtocolFeesCryptoBaseUnit,
-                    autoSlippage: true,
-                    partner: (0, helpers_1.getTreasuryAddressFromChainId)(sellAsset.chainId),
-                    feePercentage: affiliateBpsPercentage,
-                    validate: true,
-                    swapperConfig,
-                })
-                    // This should never happen but could in very rare cases if original call failed on slippage slightly over 2.5% but this one succeeds on slightly under 2.5%
-                    .then(res => res.context.slippageTolerancePercentage)
-                    .catch(err => err.message.match(/Expected slippage is (.*?)%/)?.[1]);
-                // This should never happen as we don't have auto-slippage on for `/portal` as of now (2024-12-06, see https://github.com/shapeshift/web/pull/8293)
-                // But as soon as Portals implement auto-slippage for the estimate endpoint, we will most likely re-enable it, assuming it actually works
-                if (err.message.includes('Auto slippage exceeds'))
-                    return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
-                        message: err.message,
-                        details: {
-                            expectedSlippage: portalsExpectedSlippage
-                                ? (0, utils_1.bn)(portalsExpectedSlippage).toFixed(2, utils_1.BigNumber.ROUND_HALF_UP)
-                                : undefined,
-                        },
-                        cause: err,
-                        code: types_1.TradeQuoteError.FinalQuoteMaxSlippageExceeded,
-                    }));
-                if (err.message.includes('execution reverted'))
-                    return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
-                        message: err.message,
-                        details: {
-                            expectedSlippage: portalsExpectedSlippage
-                                ? (0, utils_1.bn)(portalsExpectedSlippage).toFixed(2, utils_1.BigNumber.ROUND_HALF_UP)
-                                : undefined,
-                        },
-                        cause: err,
-                        code: types_1.TradeQuoteError.FinalQuoteExecutionReverted,
-                    }));
-            }
-            return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
-                message: 'failed to get Portals quote',
-                cause: err,
-                code: types_1.TradeQuoteError.NetworkFeeEstimationFailed,
-            }));
-        });
-        if (maybePortalsTradeOrderResponse.isErr())
-            return (0, monads_1.Err)(maybePortalsTradeOrderResponse.unwrapErr());
-        const portalsTradeOrderResponse = maybePortalsTradeOrderResponse.unwrap();
-        const { context: { orderId, outputAmount, minOutputAmount, target, feeAmount, gasLimit, feeToken }, tx, } = portalsTradeOrderResponse;
-        const allowanceContract = isCrossChain ? target : (0, helpers_2.getPortalsRouterAddressByChainId)(chainId);
-        const buyAmountAfterFeesCryptoBaseUnit = isCrossChain ? minOutputAmount : outputAmount;
-        const protocolFeeAsset = feeToken === inputToken ? sellAsset : buyAsset;
-        if (!tx)
-            throw new Error('Portals Tx simulation failed upstream');
-        const inputOutputRate = (0, utils_2.getInputOutputRate)({
-            sellAmountCryptoBaseUnit: input.sellAmountIncludingProtocolFeesCryptoBaseUnit,
-            buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
-            sellAsset,
-            buyAsset,
-        });
-        const adapter = assertGetEvmChainAdapter(chainId);
-        const { average } = await adapter.getGasFeeData();
-        const networkFeeCryptoBaseUnit = chain_adapters_1.evm.calcNetworkFeeCryptoBaseUnit({
-            ...average,
-            supportsEIP1559: Boolean(supportsEIP1559),
-            // times 1 isn't a mistake, it's just so we can write this comment above to mention that Portals already add a
-            // buffer of ~15% to the gas limit
-            gasLimit: (0, utils_1.bnOrZero)(gasLimit).times(1).toFixed(),
-        });
-        // Don't use Portals' slippageTolerancePercentage field (it's what we requested, not what they applied)
-        // Instead, calculate the actual buffer Portals applied from the amounts
-        const actualBufferDecimal = (0, utils_1.bnOrZero)(buyAmountAfterFeesCryptoBaseUnit)
-            .minus(minOutputAmount)
-            .div(buyAmountAfterFeesCryptoBaseUnit)
-            .toString();
-        // Reverse the buffer to recover the expected output (minOutput / (1 - buffer) = output)
-        const buyAmountBeforeSlippageCryptoBaseUnit = (0, utils_1.bnOrZero)(minOutputAmount)
-            .div((0, utils_1.bn)(1).minus(actualBufferDecimal))
-            .toFixed(0);
-        const slippageTolerancePercentageDecimal = actualBufferDecimal;
-        const tradeQuote = {
-            id: orderId,
-            quoteOrRate: 'quote',
-            receiveAddress: input.receiveAddress,
-            affiliateBps,
-            rate: inputOutputRate,
-            slippageTolerancePercentageDecimal,
-            swapperName: types_1.SwapperName.Portals,
-            steps: [
-                {
-                    accountNumber,
-                    allowanceContract,
-                    rate: inputOutputRate,
-                    buyAsset,
-                    sellAsset,
-                    buyAmountBeforeFeesCryptoBaseUnit: buyAmountBeforeSlippageCryptoBaseUnit,
-                    buyAmountAfterFeesCryptoBaseUnit,
-                    sellAmountIncludingProtocolFeesCryptoBaseUnit: input.sellAmountIncludingProtocolFeesCryptoBaseUnit,
-                    feeData: {
-                        networkFeeCryptoBaseUnit,
-                        protocolFees: {
-                            [protocolFeeAsset.assetId]: {
-                                amountCryptoBaseUnit: feeAmount,
-                                asset: protocolFeeAsset,
-                                requiresBalance: false,
-                            },
-                        },
-                    },
-                    source: types_1.SwapperName.Portals,
-                    estimatedExecutionTimeMs: isCrossChain ? 300000 : 0,
-                    portalsTransactionMetadata: {
-                        ...tx,
-                        isCrossChain,
-                        buyAssetChainId: isCrossChain ? buyAssetChainId : undefined,
-                        expiry: portalsTradeOrderResponse.context.expiry
-                            ? Number(portalsTradeOrderResponse.context.expiry)
-                            : undefined,
-                        steps: portalsTradeOrderResponse.context.steps,
-                        route: portalsTradeOrderResponse.context.route,
-                    },
-                    affiliateFee: (0, affiliateFee_1.buildAffiliateFee)({
-                        strategy: 'buy_asset',
-                        affiliateBps,
-                        sellAsset,
-                        buyAsset,
-                        sellAmountCryptoBaseUnit: input.sellAmountIncludingProtocolFeesCryptoBaseUnit,
-                        buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
-                        isEstimate: true,
-                    }),
-                },
-            ],
-        };
-        return (0, monads_1.Ok)(tradeQuote);
-    }
-    catch (err) {
-        return (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
+            .catch(() => (0, monads_1.Err)((0, utils_2.makeSwapErrorRight)({
             message: 'failed to get Portals quote',
             cause: err,
             code: types_1.TradeQuoteError.NetworkFeeEstimationFailed,
-        }));
-    }
-}
+        })));
+    });
+    if (maybePortalsTradeOrderResponse.isErr())
+        return (0, monads_1.Err)(maybePortalsTradeOrderResponse.unwrapErr());
+    const { context: orderContext, tx } = maybePortalsTradeOrderResponse.unwrap();
+    if (!tx)
+        return (0, monads_1.Err)((0, utils_2.makeTradeStepBuildFailedErr)('getPortalsTradeQuote'));
+    const maybeContext = (0, getPortalsTradeContext_1.getPortalsTradeContext)({
+        input,
+        deps,
+        sellChainId,
+        inputToken,
+        orderContext,
+        tx,
+    });
+    if (maybeContext.isErr())
+        return (0, monads_1.Err)(maybeContext.unwrapErr());
+    const { tradeCommon, stepCommon, protocolFees, stepDataArgs } = maybeContext.unwrap();
+    const maybeStepData = await (0, getPortalsStepData_1.getPortalsStepData)({
+        ...stepDataArgs,
+        type: 'quote',
+        input,
+        from: sendAddress,
+    });
+    if (maybeStepData.isErr())
+        return (0, monads_1.Err)(maybeStepData.unwrapErr());
+    const { transactionData, networkFeeCryptoBaseUnit } = maybeStepData.unwrap();
+    // Nullable in practice (live validated orders return null) - numeric or ISO when supplied
+    const expiryMs = (() => {
+        if (!orderContext.expiry)
+            return undefined;
+        const numeric = Number(orderContext.expiry);
+        if (Number.isFinite(numeric))
+            return (0, helpers_1.normalizeEpochToMs)(numeric);
+        const parsed = Date.parse(orderContext.expiry);
+        return Number.isNaN(parsed) ? undefined : parsed;
+    })();
+    const tradeQuote = {
+        ...tradeCommon,
+        quoteOrRate: 'quote',
+        deadline: expiryMs ?? Date.now() + helpers_1.FALLBACK_QUOTE_DEADLINE_MS,
+        receiveAddress,
+        steps: [
+            {
+                ...stepCommon,
+                accountNumber,
+                transactionData,
+                feeData: { networkFeeCryptoBaseUnit, protocolFees },
+            },
+        ],
+    };
+    return (0, monads_1.Ok)([tradeQuote]);
+};
 exports.getPortalsTradeQuote = getPortalsTradeQuote;

package/dist/cjs/swappers/PortalsSwapper/getPortalsTradeRate/getPortalsTradeRate.d.ts

@@ -1,5 +1,4 @@
-import type { ChainId } from '@shapeshiftoss/caip';
-import type { EvmChainAdapter } from '@shapeshiftoss/chain-adapters';
 import type { Result } from '@sniptt/monads';
-import type { GetEvmTradeRateInput, SwapErrorRight, SwapperConfig, TradeRate } from '../../../types';
-export declare function getPortalsTradeRate(input: GetEvmTradeRateInput, assertGetEvmChainAdapter: (chainId: ChainId) => EvmChainAdapter, swapperConfig: SwapperConfig): Promise<Result<TradeRate, SwapErrorRight>>;
+import type { SwapErrorRight, SwapperDeps, TradeRate } from '../../../types';
+import type { PortalsTradeRateInput } from '../types';
+export declare const getPortalsTradeRate: (input: PortalsTradeRateInput, deps: SwapperDeps) => Promise<Result<TradeRate[], SwapErrorRight>>;