@shapeshiftoss/swapper 19.0.0 → 20.1.0

package/dist/cjs/swappers/RelaySwapper/utils/types.d.ts

@@ -1,6 +1,8 @@
-import type { GetEvmTradeQuoteInput, GetEvmTradeRateInput, GetSolanaTradeQuoteInput, GetSolanaTradeRateInput, GetTronTradeQuoteInput, GetTronTradeRateInput, GetUtxoTradeQuoteInput, GetUtxoTradeRateInput } from '../../../types';
+import type { GetEvmTradeQuoteInput, GetEvmTradeRateInput, GetSolanaTradeQuoteInput, GetSolanaTradeRateInput, GetTronTradeQuoteInput, GetTronTradeRateInput, GetUtxoTradeQuoteInput, GetUtxoTradeRateInput, WithExactBuyAmount } from '../../../types';
 export type RelayTradeQuoteInput = GetEvmTradeQuoteInput | GetUtxoTradeQuoteInput | GetSolanaTradeQuoteInput | GetTronTradeQuoteInput;
 export type RelayTradeRateInput = GetEvmTradeRateInput | GetUtxoTradeRateInput | GetSolanaTradeRateInput | GetTronTradeRateInput;
+export type RelayExactOutputTradeQuoteInput = WithExactBuyAmount<RelayTradeQuoteInput>;
+export type RelayExactOutputTradeRateInput = WithExactBuyAmount<RelayTradeRateInput>;
 export type RelayTransactionMetadata = {
     to?: string;
     data?: string;
@@ -10,6 +12,20 @@ export type RelayMetadata = {
     relayId: string;
     data?: string;
 };
+export type RelayRequestTransaction = {
+    hash?: string;
+    chainId?: number;
+};
+export type RelayRequestData = {
+    failReason?: string;
+    refundFailReason?: string;
+    inTxs?: RelayRequestTransaction[];
+    outTxs?: RelayRequestTransaction[];
+};
+export type RelayRequest = {
+    status?: RelayStatus['status'];
+    data?: RelayRequestData;
+};
 export type RelayStatus = {
     status: 'success' | 'failure' | 'pending' | 'submitted' | 'depositing' | 'refund' | 'delayed' | 'waiting';
     details?: string;
@@ -64,6 +80,7 @@ export type RelayFees = {
     app: RelayCurrencyData;
 };
 export type QuoteDetails = {
+    currencyIn: RelayCurrencyData;
     currencyOut: RelayCurrencyData;
     rate: string;
     slippageTolerance: {

package/dist/cjs/swappers/SunioSwapper/utils/getSunioStepData.d.ts

@@ -3,6 +3,7 @@ import type { StepDataArgs, SwapErrorRight } from '../../../types';
 import type { SunioRoute, SunioTransactionData } from '../types';
 type BaseArgs = {
     route: SunioRoute;
+    sellAmountCryptoBaseUnit: string;
 };
 export type GetSunioStepDataArgs = StepDataArgs<BaseArgs>;
 type SunioRateStepData = {

package/dist/cjs/swappers/SunioSwapper/utils/getSunioStepData.js

@@ -6,12 +6,12 @@ const monads_1 = require("@sniptt/monads");
 const utils_2 = require("../../../utils");
 const estimateSunioNetworkFee_1 = require("./estimateSunioNetworkFee");
 async function getSunioStepData(args) {
-    const { type, route, sellAsset, from, input, deps } = args;
+    const { type, route, sellAsset, sellAmountCryptoBaseUnit, from, input, deps } = args;
     const estimateArgs = {
         rpcUrl: deps.config.VITE_TRON_NODE_URL,
         apiKey: deps.config.VITE_TRON_GRID_API_KEY,
         route,
-        sellAmountCryptoBaseUnit: input.sellAmountIncludingProtocolFeesCryptoBaseUnit,
+        sellAmountCryptoBaseUnit,
         isSellingNativeTrx: !(0, utils_1.contractAddressOrUndefined)(sellAsset.assetId),
         address: from,
         slippageTolerancePercentageDecimal: input.slippageTolerancePercentageDecimal,

package/dist/cjs/swappers/SunioSwapper/utils/getSunioTradeContext.js

@@ -83,7 +83,12 @@ const getSunioTradeContext = async ({ input, deps, }) => {
                 }),
             },
             protocolFees,
-            stepDataArgs: { deps, sellAsset, route: bestRoute },
+            stepDataArgs: {
+                deps,
+                sellAsset,
+                sellAmountCryptoBaseUnit: sellAmountIncludingProtocolFeesCryptoBaseUnit,
+                route: bestRoute,
+            },
         });
     }
     catch (error) {

package/dist/cjs/swappers/ThorchainSwapper/generated/generatedThorLongtailTokens.json

@@ -1016,6 +1016,7 @@
     "eip155:1/erc20:0x826180541412d574cf1336d22c0c0a287822678a",
     "eip155:1/erc20:0x2c06ba9e7f0daccbc1f6a33ea67e85bb68fbee3a",
     "eip155:1/erc20:0xcbb8f1bda10b9696c57e13bc128fe674769dcec0",
+    "eip155:1/erc20:0x72dfb2e44f59c5ad2bafe84314e5b99a7cd5075e",
     "eip155:43114/erc20:0xc891eb4cbdeff6e073e859e987815ed1505c2acd",
     "eip155:43114/erc20:0xd24c2ad096400b6fbcd2ad8b24e7acbc21a1da64",
     "eip155:43114/erc20:0x47c3118ad183712acd42648e9e522e13690f29a0",

package/dist/cjs/types.d.ts

@@ -93,6 +93,7 @@ export declare enum TradeQuoteError {
     NoRouteFound = "NoRouteFound",
     UnsupportedChain = "UnsupportedChain",
     CrossChainNotSupported = "CrossChainNotSupported",
+    ExactOutputNotSupported = "ExactOutputNotSupported",
     NetworkFeeEstimationFailed = "NetworkFeeEstimationFailed",
     TradingHalted = "TradingHalted",
     SellAmountBelowMinimum = "SellAmountBelowMinimum",
@@ -212,17 +213,30 @@ export type GetUtxoTradeRateInput = CommonTradeRateInput & {
 export type GetUtxoTradeQuoteInput = GetUtxoTradeQuoteWithWallet;
 export type GetTradeQuoteInput = GetUtxoTradeQuoteInput | GetEvmTradeQuoteInput | GetCosmosSdkTradeQuoteInput | GetTronTradeQuoteInput | GetNearTradeQuoteInput | GetTonTradeQuoteInput | GetSolanaTradeQuoteInput | GetStarknetTradeQuoteInput | GetSuiTradeQuoteInput;
 export type GetTradeRateInput = GetEvmTradeRateInput | GetCosmosSdkTradeRateInput | GetUtxoTradeRateInput | GetTronTradeRateInput | GetNearTradeRateInput | GetTonTradeRateInput | GetSolanaTradeRateInput | GetStarknetTradeRateInput | GetSuiTradeRateInput;
+export type WithExactBuyAmount<T extends {
+    sellAmountIncludingProtocolFeesCryptoBaseUnit: string;
+}> = T extends unknown ? Omit<T, 'sellAmountIncludingProtocolFeesCryptoBaseUnit'> & {
+    buyAmountCryptoBaseUnit: string;
+} : never;
+export type GetExactOutputTradeQuoteInput = WithExactBuyAmount<GetTradeQuoteInput>;
+export type GetExactOutputTradeRateInput = WithExactBuyAmount<GetTradeRateInput>;
+export type TradeAmount = {
+    direction: 'exactIn' | 'exactOut';
+    cryptoBaseUnit: string;
+};
 type StepDataBaseArgs = {
     deps: SwapperDeps;
     sellAsset: Asset;
 };
+type StepDataRateInput = GetTradeRateInput | GetExactOutputTradeRateInput;
+type StepDataQuoteInput = GetTradeQuoteInput | GetExactOutputTradeQuoteInput;
 export type StepDataArgs<Base, Rate = unknown, Quote = unknown> = (StepDataBaseArgs & Base & {
     type: 'rate';
-    input: GetTradeRateInput;
+    input: StepDataRateInput;
     from?: string;
 } & Rate) | (StepDataBaseArgs & Base & {
     type: 'quote';
-    input: GetTradeQuoteInput;
+    input: StepDataQuoteInput;
     from: string;
 } & Quote);
 export type EvmSwapperDeps = {
@@ -355,6 +369,7 @@ export type TradeCommon = {
     slippageTolerancePercentageDecimal: string | undefined;
     isLongtail?: boolean;
     swapperName: SwapperName;
+    isExactOutput?: boolean;
 };
 type TradeQuoteBase = TradeCommon & {
     receiveAddress: string | undefined;
@@ -559,6 +574,7 @@ export type CheckTradeStatusInput = {
 export type TradeStatus = {
     status: TxStatus;
     buyTxHash: string | undefined;
+    sellTxHash?: string | undefined;
     swapperTxId?: string | undefined;
     swapperTxLink?: string | undefined;
     message: string | [string, InterpolationOptions] | undefined;
@@ -568,6 +584,7 @@ export type TradeQuoteResult = Result<TradeQuote[], SwapErrorRight>;
 export type TradeRateResult = Result<TradeRate[], SwapErrorRight>;
 export type EvmMessageToSign = CowMessageToSign;
 export type Swapper = {
+    supportsExternalPayment?: boolean;
     executeEvmTransaction?: (txToSign: SignTx<EvmChainId>, callbacks: EvmTransactionExecutionProps) => Promise<string>;
     executeEvmMessage?: (txMetaToSign: EvmMessageToSign, callbacks: EvmMessageExecutionProps, config: SwapperConfig) => Promise<string>;
     executeUtxoTransaction?: (txToSign: SignTx<UtxoChainId>, callbacks: UtxoTransactionExecutionProps) => Promise<string>;
@@ -584,6 +601,8 @@ export type SwapperApi = {
     checkTradeStatus: (input: CheckTradeStatusInput) => Promise<TradeStatus>;
     getTradeQuote: (input: GetTradeQuoteInput, deps: SwapperDeps) => Promise<TradeQuoteResult>;
     getTradeRate: (input: GetTradeRateInput, deps: SwapperDeps) => Promise<TradeRateResult>;
+    getExactOutputTradeQuote?: (input: GetExactOutputTradeQuoteInput, deps: SwapperDeps) => Promise<TradeQuoteResult>;
+    getExactOutputTradeRate?: (input: GetExactOutputTradeRateInput, deps: SwapperDeps) => Promise<TradeRateResult>;
     getUnsignedEvmTransaction?: (input: GetUnsignedEvmTransactionArgs) => Promise<SignTx<EvmChainId>>;
     getUnsignedEvmMessage?: (input: GetUnsignedEvmMessageArgs) => Promise<EvmMessageToSign>;
     getUnsignedUtxoTransaction?: (input: GetUnsignedUtxoTransactionArgs) => Promise<SignTx<UtxoChainId>>;

package/dist/cjs/types.js

@@ -33,6 +33,8 @@ var TradeQuoteError;
     TradeQuoteError["UnsupportedChain"] = "UnsupportedChain";
     // the swapper can't swap across chains
     TradeQuoteError["CrossChainNotSupported"] = "CrossChainNotSupported";
+    // the swapper can quote this pair, but can't derive a sell amount from an exact buy amount
+    TradeQuoteError["ExactOutputNotSupported"] = "ExactOutputNotSupported";
     // the swapper wasn't able to get a network fee estimate
     TradeQuoteError["NetworkFeeEstimationFailed"] = "NetworkFeeEstimationFailed";
     // trading has been halted upstream

package/dist/cjs/utils/cowswap/index.d.ts

@@ -1,4 +1,5 @@
-import type { OrderClass1 } from '@cowprotocol/app-data/dist/generatedTypes/v1.3.0';
+import type { AppDataRootSchema as AppDataRootSchemaLegacy } from '@cowprotocol/app-data/dist/generatedTypes/v0.4.0';
+import type { AppDataRootSchema as AppDataRootSchemaLatest, OrderClass1 } from '@cowprotocol/app-data/dist/generatedTypes/v1.3.0';
 import type { ChainId } from '@shapeshiftoss/caip';
 import type { EvmChainAdapter } from '@shapeshiftoss/chain-adapters';
 import type { HDWallet } from '@shapeshiftoss/hdwallet-core';
@@ -22,3 +23,5 @@ export declare const getFullAppData: (slippageTolerancePercentage: string, affil
     appDataHash: string;
     appData: string;
 }>;
+export type ParsedAppData = AppDataRootSchemaLatest | AppDataRootSchemaLegacy;
+export declare const isLegacyAppData: (appData: ParsedAppData) => appData is AppDataRootSchemaLegacy;

package/dist/cjs/utils/cowswap/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFullAppData = exports.getAffiliateAppDataFragmentByChainId = exports.cowSwapTokenToAssetId = exports.signCowOrderCancellation = exports.signCowOrder = exports.signCowMessage = exports.assertGetCowNetwork = exports.getCowNetwork = void 0;
+exports.isLegacyAppData = exports.getFullAppData = exports.getAffiliateAppDataFragmentByChainId = exports.cowSwapTokenToAssetId = exports.signCowOrderCancellation = exports.signCowOrder = exports.signCowMessage = exports.assertGetCowNetwork = exports.getCowNetwork = void 0;
 const app_data_1 = require("@cowprotocol/app-data");
 const caip_1 = require("@shapeshiftoss/caip");
 const chain_adapters_1 = require("@shapeshiftoss/chain-adapters");
@@ -183,3 +183,7 @@ const getFullAppData = async (slippageTolerancePercentage, affiliateAppDataFragm
     return { appDataHash: appDataKeccak256, appData: fullAppData };
 };
 exports.getFullAppData = getFullAppData;
+const isLegacyAppData = (appData) => {
+    return appData.version === '0.4.0';
+};
+exports.isLegacyAppData = isLegacyAppData;

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

@@ -1,5 +1,14 @@
 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;
+} | {
+    buyAmountCryptoBaseUnit: string;
+}) => TradeAmount;
 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 declare const getDepositAddress: (step: DepositAddressStep, swapperName: SwapperName) => string | undefined;

package/dist/cjs/utils/helpers.js

@@ -1,11 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTreasuryAddressFromChainId = exports.isNativeEvmAsset = exports.normalizeEpochToMs = exports.FALLBACK_QUOTE_DEADLINE_MS = void 0;
+exports.getDepositAddress = exports.getTreasuryAddressFromChainId = exports.isNativeEvmAsset = exports.normalizeEpochToMs = exports.getTradeAmount = exports.FALLBACK_QUOTE_DEADLINE_MS = 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 };
+exports.getTradeAmount = getTradeAmount;
 // Bands are unambiguous for any realistic date: unix s land ~2e9, ms ~2e12, µs ~2e15, ns ~2e18
 const normalizeEpochToMs = (value) => {
     if (value < 1e12)
@@ -74,3 +79,20 @@ const getTreasuryAddressFromChainId = (chainId) => {
     return treasuryAddress;
 };
 exports.getTreasuryAddressFromChainId = getTreasuryAddressFromChainId;
+const getDepositAddress = (step, swapperName) => {
+    switch (swapperName) {
+        case types_2.SwapperName.Chainflip:
+            return step.chainflipSpecific?.depositAddress || undefined;
+        case types_2.SwapperName.NearIntents: {
+            if (step.swapperMetadata?.name !== 'nearIntents')
+                return;
+            const { depositAddress, depositMemo } = step.swapperMetadata;
+            if (depositMemo)
+                return;
+            return depositAddress || undefined;
+        }
+        default:
+            return;
+    }
+};
+exports.getDepositAddress = getDepositAddress;

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

@@ -4,6 +4,8 @@ const caip_1 = require("@shapeshiftoss/caip");
 const types_1 = require("@shapeshiftoss/types");
 const utils_1 = require("@shapeshiftoss/utils");
 const vitest_1 = require("vitest");
+const constants_1 = require("../constants");
+const types_2 = require("../types");
 const helpers_1 = require("./helpers");
 (0, vitest_1.describe)('getTreasuryAddressFromChainId', () => {
     // Affiliate and fee recipient addresses for every swapper flow through here, so pin the values
@@ -49,3 +51,42 @@ const helpers_1 = require("./helpers");
         (0, vitest_1.expect)((0, helpers_1.normalizeEpochToMs)(epochMs * 1e6)).toBe(epochMs);
     });
 });
+const makeStep = (step) => step;
+(0, vitest_1.describe)('getDepositAddress', () => {
+    (0, vitest_1.it)('reads the chainflip deposit address', () => {
+        const step = makeStep({ chainflipSpecific: { 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', () => {
+        (0, vitest_1.expect)((0, helpers_1.getDepositAddress)(makeStep({}), types_2.SwapperName.Chainflip)).toBeUndefined();
+    });
+    (0, vitest_1.it)('reads the near intents deposit address', () => {
+        const step = makeStep({
+            swapperMetadata: { name: 'nearIntents', depositAddress: '0xdeposit' },
+        });
+        (0, vitest_1.expect)((0, helpers_1.getDepositAddress)(step, types_2.SwapperName.NearIntents)).toBe('0xdeposit');
+    });
+    (0, vitest_1.it)('rejects a memo-bound near intents deposit address', () => {
+        const step = makeStep({
+            swapperMetadata: { name: 'nearIntents', depositAddress: 'EQdeposit', depositMemo: '12345' },
+        });
+        (0, vitest_1.expect)((0, helpers_1.getDepositAddress)(step, types_2.SwapperName.NearIntents)).toBeUndefined();
+    });
+    (0, vitest_1.it)('rejects an empty near intents deposit address', () => {
+        const step = makeStep({ swapperMetadata: { name: 'nearIntents', depositAddress: '' } });
+        (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' } });
+        (0, vitest_1.expect)((0, helpers_1.getDepositAddress)(step, types_2.SwapperName.Relay)).toBeUndefined();
+    });
+});
+(0, vitest_1.describe)('supportsExternalPayment', () => {
+    (0, vitest_1.it)('is flagged on exactly the externally paid swappers', () => {
+        const flagged = Object.entries(constants_1.swappers)
+            .filter(([, swapper]) => swapper?.supportsExternalPayment)
+            .map(([name]) => name)
+            .sort();
+        (0, vitest_1.expect)(flagged).toEqual([types_2.SwapperName.Chainflip, types_2.SwapperName.NearIntents].sort());
+    });
+});