@shapeshiftoss/swapper 20.2.0 → 20.4.0

package/dist/esm/swappers/SymbiosisSwapper/utils/getSymbiosisStepData.test.js

@@ -0,0 +1,159 @@
+import { tronAssetId, tronChainId } from '@shapeshiftoss/caip';
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+import { TradeQuoteError } from '../../../types.js';
+import { getEvmNetworkFeeCryptoBaseUnit } from '../../../utils/evm/index.js';
+import { ETH, ETH_ARBITRUM, USDC_ARBITRUM } from '../../../utils/test-data/assets.js';
+import { getTronContractCallNetworkFeeCryptoBaseUnit } from '../../../utils/tron/index.js';
+import { getSymbiosisStepData } from './getSymbiosisStepData.js';
+vi.mock('../../../utils/evm', () => ({
+    getEvmNetworkFeeCryptoBaseUnit: vi.fn(),
+}));
+vi.mock('../../../utils/tron', () => ({
+    getTronContractCallFallbackFeeCryptoBaseUnit: vi.fn(),
+    getTronContractCallNetworkFeeCryptoBaseUnit: vi.fn(),
+}));
+const TRX = {
+    ...ETH,
+    assetId: tronAssetId,
+    chainId: tronChainId,
+    symbol: 'TRX',
+    precision: 6,
+};
+const ROUTER = '0x3743c756b64ECd0770f1d4f47696A73d2A46dcbe';
+const TRON_ROUTER = 'TPuaJ6gnYfE9gLUDFrbWbPx3tMnjG8max1';
+const FROM = '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045';
+const TRON_FROM = 'TLa2f6VPqDgRE67v1736s7bJ8Ray5wYjU7';
+const deps = {
+    assertGetEvmChainAdapter: vi.fn(() => ({})),
+    assertGetTronChainAdapter: vi.fn(() => ({})),
+};
+const quoteInput = { supportsEIP1559: true };
+const evmSwapTx = {
+    type: 'evm',
+    tx: { chainId: 42161, to: ROUTER, data: '0xa11b1198', value: '0' },
+};
+const tronSwapTx = {
+    type: 'tron',
+    tx: {
+        chainId: 728126428,
+        from: TRON_FROM,
+        to: TRON_ROUTER,
+        data: '0x0020',
+        value: '500000000',
+        feeLimit: 200000000,
+        functionSelector: 'metaRoute((bytes,bytes,address[],address,address,uint256,bool,address,bytes))',
+    },
+};
+const evmArgs = {
+    swapTx: evmSwapTx,
+    sellAsset: USDC_ARBITRUM,
+    sellAmountCryptoBaseUnit: '100000000',
+    spenderAddress: ROUTER,
+    tronFallbackEnergy: '470000',
+    from: FROM,
+    deps,
+};
+const tronArgs = {
+    swapTx: tronSwapTx,
+    sellAsset: TRX,
+    sellAmountCryptoBaseUnit: '500000000',
+    spenderAddress: '',
+    tronFallbackEnergy: '580000',
+    from: TRON_FROM,
+    deps,
+};
+describe('getSymbiosisStepData', () => {
+    beforeEach(() => {
+        vi.clearAllMocks();
+    });
+    describe('evm', () => {
+        it('fails to build when a token sell carries native value', async () => {
+            const swapTx = {
+                type: 'evm',
+                tx: { ...evmSwapTx.tx, value: '300000000000000' },
+            };
+            const result = await getSymbiosisStepData({
+                ...evmArgs,
+                swapTx,
+                type: 'quote',
+                input: quoteInput,
+            });
+            expect(result.unwrapErr().code).toBe(TradeQuoteError.InvalidResponse);
+            expect(getEvmNetworkFeeCryptoBaseUnit).not.toHaveBeenCalled();
+        });
+        it('fails to build when a native sell sends more than the sell amount', async () => {
+            const swapTx = {
+                type: 'evm',
+                tx: { ...evmSwapTx.tx, value: '50300000000000000' },
+            };
+            const result = await getSymbiosisStepData({
+                ...evmArgs,
+                swapTx,
+                sellAsset: ETH_ARBITRUM,
+                sellAmountCryptoBaseUnit: '50000000000000000',
+                type: 'quote',
+                input: quoteInput,
+            });
+            expect(result.unwrapErr().code).toBe(TradeQuoteError.InvalidResponse);
+            expect(getEvmNetworkFeeCryptoBaseUnit).not.toHaveBeenCalled();
+        });
+        it('fails to build when the payload is for another chain', async () => {
+            const swapTx = { type: 'evm', tx: { ...evmSwapTx.tx, chainId: 1 } };
+            const result = await getSymbiosisStepData({
+                ...evmArgs,
+                swapTx,
+                type: 'quote',
+                input: quoteInput,
+            });
+            expect(result.unwrapErr().code).toBe(TradeQuoteError.InvalidResponse);
+            expect(getEvmNetworkFeeCryptoBaseUnit).not.toHaveBeenCalled();
+        });
+        it('builds a native sell whose value is exactly the sell amount', async () => {
+            vi.mocked(getEvmNetworkFeeCryptoBaseUnit).mockResolvedValue('1234');
+            const swapTx = {
+                type: 'evm',
+                tx: { ...evmSwapTx.tx, value: '50000000000000000' },
+            };
+            const result = await getSymbiosisStepData({
+                ...evmArgs,
+                swapTx,
+                sellAsset: ETH_ARBITRUM,
+                sellAmountCryptoBaseUnit: '50000000000000000',
+                type: 'quote',
+                input: quoteInput,
+            });
+            expect(result.isOk()).toBe(true);
+        });
+    });
+    describe('tron', () => {
+        const expectedCall = { to: TRON_ROUTER, data: '0xa11b11980020', value: '500000000' };
+        it('assembles the contract call and prices it for a quote', async () => {
+            vi.mocked(getTronContractCallNetworkFeeCryptoBaseUnit).mockResolvedValue('45000000');
+            const result = await getSymbiosisStepData({ ...tronArgs, type: 'quote', input: quoteInput });
+            expect(result.unwrap()).toEqual({
+                transactionData: { type: 'tron', ...expectedCall },
+                networkFeeCryptoBaseUnit: '45000000',
+            });
+            expect(getTronContractCallNetworkFeeCryptoBaseUnit).toHaveBeenCalledWith(expect.objectContaining({
+                transactionData: expectedCall,
+                from: TRON_FROM,
+                spenderAddress: '',
+                fallbackEnergy: '580000',
+            }));
+        });
+        it('fails to build when the response has no function selector', async () => {
+            const swapTx = {
+                type: 'tron',
+                tx: { ...tronSwapTx.tx, functionSelector: undefined },
+            };
+            const result = await getSymbiosisStepData({
+                ...tronArgs,
+                swapTx,
+                type: 'quote',
+                input: quoteInput,
+            });
+            expect(result.unwrapErr().code).toBe(TradeQuoteError.InvalidResponse);
+            expect(getTronContractCallNetworkFeeCryptoBaseUnit).not.toHaveBeenCalled();
+        });
+    });
+});

package/dist/esm/swappers/SymbiosisSwapper/utils/getSymbiosisTradeContext.d.ts

@@ -0,0 +1,17 @@
+import type { Result } from '@sniptt/monads';
+import type { QuoteFeeData, SwapErrorRight, SwapperDeps, TradeCommon, TradeStepCommon } from '../../../types.js';
+import type { GetSymbiosisStepDataArgs } from './getSymbiosisStepData.js';
+import type { SymbiosisTradeQuoteInput, SymbiosisTradeRateInput } from './types.js';
+type SymbiosisTradeContext = {
+    tradeCommon: TradeCommon;
+    stepCommon: Omit<TradeStepCommon, 'feeData'>;
+    protocolFees: QuoteFeeData['protocolFees'];
+    stepDataArgs: Omit<GetSymbiosisStepDataArgs, 'type' | 'input'>;
+};
+export declare const getSymbiosisTradeContext: ({ input, deps, from, to, }: {
+    input: SymbiosisTradeQuoteInput | SymbiosisTradeRateInput;
+    deps: SwapperDeps;
+    from: string;
+    to: string;
+}) => Promise<Result<SymbiosisTradeContext, SwapErrorRight>>;
+export {};

package/dist/esm/swappers/SymbiosisSwapper/utils/getSymbiosisTradeContext.js

@@ -0,0 +1,139 @@
+import { bn, isToken } from '@shapeshiftoss/utils';
+import { Err, Ok } from '@sniptt/monads';
+import axios from 'axios';
+import { v4 as uuid } from 'uuid';
+import { getDefaultSlippageDecimalPercentageForSwapper } from '../../../constants.js';
+import { SwapperName, TradeQuoteError } from '../../../types.js';
+import { getInputOutputRate, makeSwapErrorRight } from '../../../utils/index.js';
+import { buildAffiliateFee } from '../../../utils/affiliateFee.js';
+import { SYMBIOSIS_DISABLED_PROVIDERS, SYMBIOSIS_PARTNER_FEE_BPS, SYMBIOSIS_PARTNER_FEE_DESCRIPTION, } from './constants.js';
+import { assertValidTrade, getSymbiosisPartnerAddress, getSymbiosisProtocolFees, getSymbiosisSlippageBps, getSymbiosisTokenAddress, getSymbiosisTronFallbackEnergy, isSymbiosisRouteSupported, symbiosisErrorToTradeQuoteError, } from './helpers.js';
+import { symbiosisService } from './symbiosisService.js';
+export const getSymbiosisTradeContext = async ({ input, deps, from, to, }) => {
+    const { sellAsset, buyAsset, sellAmountIncludingProtocolFeesCryptoBaseUnit, affiliateBps } = input;
+    const assertion = assertValidTrade({ sellAsset, buyAsset });
+    if (assertion.isErr())
+        return Err(assertion.unwrapErr());
+    const { sellSymbiosisChainId, buySymbiosisChainId } = assertion.unwrap();
+    const slippageBps = getSymbiosisSlippageBps(input.slippageTolerancePercentageDecimal ??
+        getDefaultSlippageDecimalPercentageForSwapper(SwapperName.Symbiosis));
+    const maybePartnerAddress = getSymbiosisPartnerAddress(affiliateBps);
+    if (maybePartnerAddress.isErr())
+        return Err(maybePartnerAddress.unwrapErr());
+    const partnerAddress = maybePartnerAddress.unwrap();
+    const request = {
+        tokenAmountIn: {
+            chainId: sellSymbiosisChainId,
+            address: getSymbiosisTokenAddress(sellAsset),
+            decimals: sellAsset.precision,
+            amount: sellAmountIncludingProtocolFeesCryptoBaseUnit,
+        },
+        tokenOut: {
+            chainId: buySymbiosisChainId,
+            address: getSymbiosisTokenAddress(buyAsset),
+            decimals: buyAsset.precision,
+        },
+        from,
+        to,
+        slippage: slippageBps,
+        disabledProviders: SYMBIOSIS_DISABLED_PROVIDERS,
+        partnerAddress,
+    };
+    const maybeQuote = await symbiosisService.post(`${deps.config.VITE_SYMBIOSIS_API_URL}/v2/quote`, request);
+    if (maybeQuote.isErr()) {
+        const { cause } = maybeQuote.unwrapErr();
+        if (!axios.isAxiosError(cause)) {
+            return Err(makeSwapErrorRight({
+                message: 'Unknown error',
+                code: TradeQuoteError.UnknownError,
+                cause,
+            }));
+        }
+        if (cause.response?.status === 429) {
+            return Err(makeSwapErrorRight({
+                message: 'Symbiosis rate limit exceeded',
+                code: TradeQuoteError.RateLimitExceeded,
+            }));
+        }
+        const message = cause.response?.data?.message;
+        return Err(makeSwapErrorRight({
+            message: message ?? 'Symbiosis quote request failed',
+            code: symbiosisErrorToTradeQuoteError(message),
+        }));
+    }
+    const { data: quote } = maybeQuote.unwrap();
+    if (!isSymbiosisRouteSupported({ quote, sellAsset })) {
+        return Err(makeSwapErrorRight({
+            message: 'No Symbiosis route through its own liquidity',
+            code: TradeQuoteError.NoRouteFound,
+        }));
+    }
+    // The quote must carry the fee we report, otherwise Symbiosis is not collecting it on this route
+    if (partnerAddress &&
+        !quote.fees.some(fee => fee.description === SYMBIOSIS_PARTNER_FEE_DESCRIPTION)) {
+        return Err(makeSwapErrorRight({
+            message: 'Symbiosis quote is missing the partner fee',
+            code: TradeQuoteError.InvalidResponse,
+        }));
+    }
+    const buyAmountAfterFeesCryptoBaseUnit = quote.tokenAmountOut.amount;
+    const protocolFees = getSymbiosisProtocolFees(quote.fees);
+    const buyAmountBeforeFeesCryptoBaseUnit = bn(buyAmountAfterFeesCryptoBaseUnit)
+        .plus(protocolFees[buyAsset.assetId]?.amountCryptoBaseUnit ?? 0)
+        .toFixed(0);
+    const rate = getInputOutputRate({
+        sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
+        buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
+        sellAsset,
+        buyAsset,
+    });
+    const allowanceContract = isToken(sellAsset.assetId) ? quote.approveTo : '';
+    if (allowanceContract === undefined) {
+        return Err(makeSwapErrorRight({
+            message: 'Symbiosis returned no spender for a token sell',
+            code: TradeQuoteError.QueryFailed,
+        }));
+    }
+    return Ok({
+        tradeCommon: {
+            id: uuid(),
+            rate,
+            swapperName: SwapperName.Symbiosis,
+            affiliateBps: partnerAddress ? SYMBIOSIS_PARTNER_FEE_BPS : '0',
+            slippageTolerancePercentageDecimal: bn(slippageBps).div(10000).toString(),
+        },
+        stepCommon: {
+            allowanceContract,
+            rate,
+            buyAmountBeforeFeesCryptoBaseUnit,
+            buyAmountAfterFeesCryptoBaseUnit,
+            sellAmountIncludingProtocolFeesCryptoBaseUnit,
+            buyAsset,
+            sellAsset,
+            source: SwapperName.Symbiosis,
+            estimatedExecutionTimeMs: quote.estimatedTime * 1000,
+            // The fee accrues in sTokens on the Symbiosis chain - the buy asset figure is a display estimate
+            affiliateFee: partnerAddress
+                ? buildAffiliateFee({
+                    strategy: 'buy_asset',
+                    affiliateBps: SYMBIOSIS_PARTNER_FEE_BPS,
+                    sellAsset,
+                    buyAsset,
+                    sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
+                    buyAmountCryptoBaseUnit: buyAmountAfterFeesCryptoBaseUnit,
+                    isEstimate: true,
+                })
+                : undefined,
+        },
+        protocolFees,
+        stepDataArgs: {
+            swapTx: quote,
+            sellAsset,
+            sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
+            spenderAddress: allowanceContract,
+            tronFallbackEnergy: getSymbiosisTronFallbackEnergy(quote.labels),
+            from,
+            deps,
+        },
+    });
+};

package/dist/esm/swappers/SymbiosisSwapper/utils/helpers.d.ts

@@ -0,0 +1,38 @@
+import type { AssetId, ChainId } from '@shapeshiftoss/caip';
+import type { Asset } from '@shapeshiftoss/types';
+import type { Result } from '@sniptt/monads';
+import type { QuoteFeeData, SwapErrorRight, TradeStatus } from '../../../types.js';
+import { TradeQuoteError } from '../../../types.js';
+import type { SymbiosisFee, SymbiosisQuoteResponse, SymbiosisToken, SymbiosisTxResponse } from './types.js';
+export declare const assertValidTrade: ({ sellAsset, buyAsset, }: {
+    sellAsset: Asset;
+    buyAsset: Asset;
+}) => Result<{
+    sellSymbiosisChainId: number;
+    buySymbiosisChainId: number;
+}, SwapErrorRight>;
+export declare const getSymbiosisTokenAddress: (asset: Asset) => string;
+export declare const getSymbiosisSlippageBps: (slippageTolerancePercentageDecimal: string) => number;
+export declare const getDefaultUserAddress: (chainId: ChainId) => string;
+export declare const getSymbiosisPartnerAddress: (affiliateBps: string) => Result<string | undefined, SwapErrorRight>;
+export declare const buildSymbiosisTronCallData: ({ functionSelector, data, }: {
+    functionSelector: string;
+    data: string;
+}) => string;
+export declare const getSymbiosisTronFallbackEnergy: (labels: string[]) => string;
+export declare const isSymbiosisRouteSupported: ({ quote, sellAsset, }: {
+    quote: SymbiosisQuoteResponse;
+    sellAsset: Asset;
+}) => boolean;
+export declare const getSymbiosisFeeAssetId: ({ chainId: symbiosisChainId, address, }: Pick<SymbiosisToken, 'chainId' | 'address'>) => AssetId | undefined;
+export declare const getSymbiosisProtocolFees: (fees: SymbiosisFee[]) => NonNullable<QuoteFeeData['protocolFees']>;
+export declare const symbiosisErrorToTradeQuoteError: (message: string | undefined) => TradeQuoteError;
+export declare const isTronSourceTxFailed: (tx: {
+    ret?: {
+        contractRet?: string;
+    }[];
+}) => boolean;
+export declare const getSymbiosisTradeStatus: ({ response, buySymbiosisChainId, }: {
+    response: SymbiosisTxResponse;
+    buySymbiosisChainId: number | undefined;
+}) => Pick<TradeStatus, 'status' | 'buyTxHash' | 'message'>;

package/dist/esm/swappers/SymbiosisSwapper/utils/helpers.js

@@ -0,0 +1,156 @@
+import { ASSET_NAMESPACE, fromAssetId, toAssetId, tronChainId } from '@shapeshiftoss/caip';
+import { tron } from '@shapeshiftoss/chain-adapters';
+import { TxStatus } from '@shapeshiftoss/unchained-client';
+import { bn, bnOrZero, chainIdToFeeAssetId, isToken } from '@shapeshiftoss/utils';
+import { Err, Ok } from '@sniptt/monads';
+import { getAddress, keccak256, toHex } from 'viem';
+import { TradeQuoteError } from '../../../types.js';
+import { makeSwapErrorRight } from '../../../utils/index.js';
+import { chainIdToSymbiosisChainId, DEFAULT_SYMBIOSIS_EVM_USER_ADDRESS, DEFAULT_SYMBIOSIS_TRON_USER_ADDRESS, SYMBIOSIS_CROSSCHAIN_SWAP_KIND, SYMBIOSIS_MAX_SLIPPAGE_BPS, SYMBIOSIS_MIN_SLIPPAGE_BPS, SYMBIOSIS_PARTNER_ADDRESS, SYMBIOSIS_PARTNER_FEE_BPS, SYMBIOSIS_PARTNER_SWAP_LABEL, SYMBIOSIS_SEMI_CENTRALIZED_LABEL, SYMBIOSIS_SRC_CHAIN_SWAP_LABEL, SYMBIOSIS_TRON_BRIDGE_ENERGY, SYMBIOSIS_TRON_SOURCE_SWAP_ENERGY, symbiosisChainIdToChainId, } from './constants.js';
+import { SymbiosisStatusCode } from './types.js';
+export const assertValidTrade = ({ sellAsset, buyAsset, }) => {
+    const sellSymbiosisChainId = chainIdToSymbiosisChainId[sellAsset.chainId];
+    const buySymbiosisChainId = chainIdToSymbiosisChainId[buyAsset.chainId];
+    if (sellSymbiosisChainId === undefined) {
+        return Err(makeSwapErrorRight({
+            message: `Sell asset chain '${sellAsset.chainId}' not supported by Symbiosis`,
+            code: TradeQuoteError.UnsupportedChain,
+        }));
+    }
+    if (buySymbiosisChainId === undefined) {
+        return Err(makeSwapErrorRight({
+            message: `Buy asset chain '${buyAsset.chainId}' not supported by Symbiosis`,
+            code: TradeQuoteError.UnsupportedChain,
+        }));
+    }
+    if (sellAsset.chainId === buyAsset.chainId) {
+        return Err(makeSwapErrorRight({
+            message: 'Symbiosis same-chain swaps are not supported',
+            code: TradeQuoteError.UnsupportedTradePair,
+        }));
+    }
+    return Ok({ sellSymbiosisChainId, buySymbiosisChainId });
+};
+export const getSymbiosisTokenAddress = (asset) => {
+    if (!isToken(asset.assetId))
+        return '';
+    const { assetReference } = fromAssetId(asset.assetId);
+    if (asset.chainId === tronChainId)
+        return tron.toTronHex(assetReference);
+    return getAddress(assetReference);
+};
+export const getSymbiosisSlippageBps = (slippageTolerancePercentageDecimal) => {
+    const bps = Math.round(bnOrZero(slippageTolerancePercentageDecimal).times(10000).toNumber());
+    return Math.min(Math.max(bps, SYMBIOSIS_MIN_SLIPPAGE_BPS), SYMBIOSIS_MAX_SLIPPAGE_BPS);
+};
+export const getDefaultUserAddress = (chainId) => chainId === tronChainId ? DEFAULT_SYMBIOSIS_TRON_USER_ADDRESS : DEFAULT_SYMBIOSIS_EVM_USER_ADDRESS;
+// Symbiosis fixes the partner rate on its side, so only a fee-free swap or the registered rate can be honored
+export const getSymbiosisPartnerAddress = (affiliateBps) => {
+    const requestedBps = bnOrZero(affiliateBps);
+    if (requestedBps.isZero())
+        return Ok(undefined);
+    if (requestedBps.eq(SYMBIOSIS_PARTNER_FEE_BPS))
+        return Ok(SYMBIOSIS_PARTNER_ADDRESS);
+    return Err(makeSwapErrorRight({
+        message: `Symbiosis only supports a ${SYMBIOSIS_PARTNER_FEE_BPS} bps affiliate fee, got ${affiliateBps}`,
+        code: TradeQuoteError.UnsupportedTradePair,
+    }));
+};
+// Symbiosis returns the function signature and its encoded parameters separately
+export const buildSymbiosisTronCallData = ({ functionSelector, data, }) => {
+    const selector = keccak256(toHex(functionSelector)).slice(0, 10);
+    const parameters = data.startsWith('0x') ? data.slice(2) : data;
+    return `${selector}${parameters}`;
+};
+export const getSymbiosisTronFallbackEnergy = (labels) => labels.includes(SYMBIOSIS_SRC_CHAIN_SWAP_LABEL)
+    ? SYMBIOSIS_TRON_SOURCE_SWAP_ENERGY
+    : SYMBIOSIS_TRON_BRIDGE_ENERGY;
+export const isSymbiosisRouteSupported = ({ quote, sellAsset, }) => {
+    if (quote.kind !== SYMBIOSIS_CROSSCHAIN_SWAP_KIND)
+        return false;
+    if (quote.labels.includes(SYMBIOSIS_PARTNER_SWAP_LABEL))
+        return false;
+    if (quote.labels.includes(SYMBIOSIS_SEMI_CENTRALIZED_LABEL))
+        return false;
+    const expectedType = sellAsset.chainId === tronChainId ? 'tron' : 'evm';
+    return quote.type === expectedType;
+};
+export const getSymbiosisFeeAssetId = ({ chainId: symbiosisChainId, address, }) => {
+    const chainId = symbiosisChainIdToChainId[symbiosisChainId];
+    if (!chainId)
+        return;
+    if (!address)
+        return chainIdToFeeAssetId(chainId);
+    if (chainId === tronChainId) {
+        return toAssetId({
+            chainId,
+            assetNamespace: ASSET_NAMESPACE.trc20,
+            assetReference: tron.toTronBase58(address),
+        });
+    }
+    return toAssetId({
+        chainId,
+        assetNamespace: ASSET_NAMESPACE.erc20,
+        assetReference: address.toLowerCase(),
+    });
+};
+// Fees on the Symbiosis host chain are charged in sTokens we have no asset for - they are already net of the buy amount
+export const getSymbiosisProtocolFees = (fees) => fees.reduce((acc, { value }) => {
+    const assetId = getSymbiosisFeeAssetId(value);
+    const chainId = symbiosisChainIdToChainId[value.chainId];
+    if (!assetId || !chainId)
+        return acc;
+    acc[assetId] = {
+        amountCryptoBaseUnit: bnOrZero(acc[assetId]?.amountCryptoBaseUnit)
+            .plus(value.amount)
+            .toFixed(0),
+        asset: { symbol: value.symbol, chainId, precision: value.decimals },
+        requiresBalance: false,
+    };
+    return acc;
+}, {});
+export const symbiosisErrorToTradeQuoteError = (message) => {
+    if (message?.startsWith('Amount is too low'))
+        return TradeQuoteError.SellAmountBelowTradeFee;
+    if (message === 'This swap is not available')
+        return TradeQuoteError.NoRouteFound;
+    return TradeQuoteError.QueryFailed;
+};
+// A mined Tron call that did not succeed (REVERT, OUT_OF_ENERGY, ...) never reaches Symbiosis, which answers not found for it
+export const isTronSourceTxFailed = (tx) => {
+    const contractRet = tx.ret?.[0]?.contractRet;
+    return contractRet !== undefined && contractRet !== 'SUCCESS';
+};
+export const getSymbiosisTradeStatus = ({ response, buySymbiosisChainId, }) => {
+    const { status, tx, transitTokenSent } = response;
+    switch (status.code) {
+        case SymbiosisStatusCode.Success: {
+            // Until the operation is indexed, Symbiosis answers Success for the plain source transaction
+            if (tx?.chainId !== buySymbiosisChainId) {
+                return { status: TxStatus.Pending, buyTxHash: undefined, message: undefined };
+            }
+            const message = transitTokenSent
+                ? `Received ${bn(transitTokenSent.amount)
+                    .shiftedBy(-transitTokenSent.decimals)
+                    .toFixed()} ${transitTokenSent.symbol} instead of the buy asset`
+                : undefined;
+            return { status: TxStatus.Confirmed, buyTxHash: tx?.hash, message };
+        }
+        case SymbiosisStatusCode.Pending:
+            return { status: TxStatus.Pending, buyTxHash: undefined, message: undefined };
+        case SymbiosisStatusCode.Stuck:
+            return {
+                status: TxStatus.Pending,
+                buyTxHash: undefined,
+                message: 'Swap is stuck and is being reverted by Symbiosis',
+            };
+        case SymbiosisStatusCode.Reverted:
+            return {
+                status: TxStatus.Failed,
+                buyTxHash: undefined,
+                message: 'Swap was reverted by Symbiosis',
+            };
+        default:
+            return { status: TxStatus.Unknown, buyTxHash: undefined, message: undefined };
+    }
+};

package/dist/esm/swappers/SymbiosisSwapper/utils/helpers.test.d.ts

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

package/dist/esm/swappers/SymbiosisSwapper/utils/helpers.test.js

@@ -0,0 +1,149 @@
+import { usdtOnTronAssetId } from '@shapeshiftoss/caip';
+import { TxStatus } from '@shapeshiftoss/unchained-client';
+import { describe, expect, it } from 'vitest';
+import { SYMBIOSIS_PARTNER_ADDRESS } from './constants.js';
+import { buildSymbiosisTronCallData, getSymbiosisFeeAssetId, getSymbiosisPartnerAddress, getSymbiosisProtocolFees, getSymbiosisSlippageBps, getSymbiosisTradeStatus, isTronSourceTxFailed, } from './helpers.js';
+import { SymbiosisStatusCode } from './types.js';
+const BSC_USDC_ADDRESS = '0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d';
+const BSC_USDC_ASSET_ID = 'eip155:56/erc20:0x8ac76a51cc950d9822d68b83fe1ad97b32cd580d';
+// The fees array of a live Arbitrum USDC -> BSC quote: one host chain sToken entry, one destination entry
+const liveFees = [
+    {
+        provider: 'symbiosis',
+        description: 'Cross-chain fee',
+        value: {
+            symbol: 'sUSDC',
+            address: '0xc317169a336b484f65B0AB4A794bBe66a7491E83',
+            amount: '250000',
+            chainId: 13863860,
+            decimals: 6,
+        },
+    },
+    {
+        provider: 'symbiosis',
+        description: 'Cross-chain fee',
+        value: {
+            symbol: 'USDC',
+            address: BSC_USDC_ADDRESS,
+            amount: '250000000000000000',
+            chainId: 56,
+            decimals: 18,
+        },
+    },
+];
+describe('getSymbiosisSlippageBps', () => {
+    it('raises slippage below the Symbiosis minimum to 10 bps', () => {
+        expect(getSymbiosisSlippageBps('0.0005')).toBe(10);
+        expect(getSymbiosisSlippageBps('0')).toBe(10);
+    });
+    it('lowers slippage above the Symbiosis maximum to 1000 bps', () => {
+        expect(getSymbiosisSlippageBps('0.25')).toBe(1000);
+    });
+});
+describe('getSymbiosisPartnerAddress', () => {
+    it('sends the partner address at the registered rate', () => {
+        expect(getSymbiosisPartnerAddress('60').unwrap()).toBe(SYMBIOSIS_PARTNER_ADDRESS);
+    });
+    it('omits the partner address for a fee-free swap', () => {
+        expect(getSymbiosisPartnerAddress('0').unwrap()).toBeUndefined();
+    });
+    it('rejects any other rate instead of silently dropping the fee', () => {
+        expect(getSymbiosisPartnerAddress('30').isErr()).toBe(true);
+        expect(getSymbiosisPartnerAddress('80').isErr()).toBe(true);
+    });
+});
+describe('buildSymbiosisTronCallData', () => {
+    const functionSelector = 'metaRoute((bytes,bytes,address[],address,address,uint256,bool,address,bytes))';
+    it('prefixes the parameters with the 4-byte selector of the signature', () => {
+        const data = `0x${'00'.repeat(31)}20`;
+        expect(buildSymbiosisTronCallData({ functionSelector, data })).toBe(`0xa11b1198${'00'.repeat(31)}20`);
+    });
+});
+describe('getSymbiosisFeeAssetId', () => {
+    it('maps a Tron hex address to its base58 trc20 asset id', () => {
+        expect(getSymbiosisFeeAssetId({
+            chainId: 728126428,
+            address: '0xa614f803b6fd780986a42c78ec9c7f77e6ded13c',
+        })).toBe(usdtOnTronAssetId);
+    });
+});
+describe('getSymbiosisProtocolFees', () => {
+    it('keeps resolvable fees and skips host chain sToken fees', () => {
+        expect(getSymbiosisProtocolFees(liveFees)).toEqual({
+            [BSC_USDC_ASSET_ID]: {
+                amountCryptoBaseUnit: '250000000000000000',
+                asset: { symbol: 'USDC', chainId: 'eip155:56', precision: 18 },
+                requiresBalance: false,
+            },
+        });
+    });
+    it('sums fees charged in the same asset', () => {
+        const fees = getSymbiosisProtocolFees([liveFees[1], liveFees[1]]);
+        expect(fees[BSC_USDC_ASSET_ID]?.amountCryptoBaseUnit).toBe('500000000000000000');
+    });
+});
+describe('getSymbiosisTradeStatus', () => {
+    const buySymbiosisChainId = 56;
+    const makeResponse = (overrides) => ({
+        status: { code: SymbiosisStatusCode.Success, text: 'Success' },
+        txIn: { hash: '0xsell', chainId: 42161 },
+        tx: { hash: '0xbuy', chainId: 56 },
+        ...overrides,
+    });
+    it('confirms with the destination hash once the destination tx is on the buy chain', () => {
+        expect(getSymbiosisTradeStatus({ response: makeResponse({}), buySymbiosisChainId })).toEqual({
+            status: TxStatus.Confirmed,
+            buyTxHash: '0xbuy',
+            message: undefined,
+        });
+    });
+    it('stays pending when Success describes the source transaction itself', () => {
+        const response = makeResponse({ tx: { hash: '0xsell', chainId: 42161 } });
+        expect(getSymbiosisTradeStatus({ response, buySymbiosisChainId })).toEqual({
+            status: TxStatus.Pending,
+            buyTxHash: undefined,
+            message: undefined,
+        });
+    });
+    it('names the transit token when the destination swap did not complete', () => {
+        const response = makeResponse({
+            transitTokenSent: {
+                chainId: 56,
+                address: BSC_USDC_ADDRESS,
+                decimals: 18,
+                symbol: 'USDC',
+                amount: '250000000000000000',
+            },
+        });
+        expect(getSymbiosisTradeStatus({ response, buySymbiosisChainId })).toEqual({
+            status: TxStatus.Confirmed,
+            buyTxHash: '0xbuy',
+            message: 'Received 0.25 USDC instead of the buy asset',
+        });
+    });
+    it('maps pending, stuck, reverted and not found', () => {
+        const pending = makeResponse({ status: { code: SymbiosisStatusCode.Pending, text: '' } });
+        const stuck = makeResponse({ status: { code: SymbiosisStatusCode.Stuck, text: '' } });
+        const reverted = makeResponse({ status: { code: SymbiosisStatusCode.Reverted, text: '' } });
+        const notFound = makeResponse({ status: { code: SymbiosisStatusCode.NotFound, text: '' } });
+        expect(getSymbiosisTradeStatus({ response: pending, buySymbiosisChainId }).status).toBe(TxStatus.Pending);
+        expect(getSymbiosisTradeStatus({ response: stuck, buySymbiosisChainId })).toEqual({
+            status: TxStatus.Pending,
+            buyTxHash: undefined,
+            message: 'Swap is stuck and is being reverted by Symbiosis',
+        });
+        expect(getSymbiosisTradeStatus({ response: reverted, buySymbiosisChainId })).toEqual({
+            status: TxStatus.Failed,
+            buyTxHash: undefined,
+            message: 'Swap was reverted by Symbiosis',
+        });
+        expect(getSymbiosisTradeStatus({ response: notFound, buySymbiosisChainId }).status).toBe(TxStatus.Unknown);
+    });
+});
+describe('isTronSourceTxFailed', () => {
+    it('is true for any contract result other than SUCCESS', () => {
+        expect(isTronSourceTxFailed({ ret: [{ contractRet: 'REVERT' }] })).toBe(true);
+        expect(isTronSourceTxFailed({ ret: [{ contractRet: 'OUT_OF_ENERGY' }] })).toBe(true);
+        expect(isTronSourceTxFailed({ ret: [{ contractRet: 'SUCCESS' }] })).toBe(false);
+    });
+});

package/dist/esm/swappers/SymbiosisSwapper/utils/symbiosisService.d.ts

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