@shapeshiftoss/swapper 19.0.0 → 20.1.0

package/dist/esm/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/esm/types.js

@@ -30,6 +30,8 @@ export 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/esm/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/esm/utils/cowswap/index.js

@@ -158,3 +158,6 @@ export const getFullAppData = async (slippageTolerancePercentage, affiliateAppDa
     const { fullAppData, appDataKeccak256 } = await generateAppDataFromDoc(appDataDoc);
     return { appDataHash: appDataKeccak256, appData: fullAppData };
 };
+export const isLegacyAppData = (appData) => {
+    return appData.version === '0.4.0';
+};

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

@@ -1,5 +1,14 @@
 import type { AssetId, ChainId } from '@shapeshiftoss/caip';
+import type { TradeAmount, TradeStepCommon } from '../types.js';
+import { SwapperName } from '../types.js';
 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/esm/utils/helpers.js

@@ -1,8 +1,12 @@
 import { arbitrumAssetId, avalancheAssetId, baseAssetId, bscAssetId, ethAssetId, fromAssetId, gnosisAssetId, katanaAssetId, monadAssetId, optimismAssetId, plasmaAssetId, polygonAssetId, } from '@shapeshiftoss/caip';
 import { KnownChainIds } from '@shapeshiftoss/types';
 import { DAO_TREASURY_ARBITRUM, DAO_TREASURY_AVALANCHE, DAO_TREASURY_BASE, DAO_TREASURY_BITCOIN, DAO_TREASURY_BOB, DAO_TREASURY_BSC, DAO_TREASURY_ETHEREUM_MAINNET, DAO_TREASURY_GNOSIS, DAO_TREASURY_HYPEREVM, DAO_TREASURY_MONAD, DAO_TREASURY_OPTIMISM, DAO_TREASURY_POLYGON, DAO_TREASURY_SOLANA, DAO_TREASURY_STARKNET, DAO_TREASURY_TON, isTreasuryChainId, } from '@shapeshiftoss/utils';
+import { SwapperName } from '../types.js';
 // Deadline for providers without their own expiry - short enough to keep priced amounts honest
 export const FALLBACK_QUOTE_DEADLINE_MS = 60_000;
+export const getTradeAmount = (input) => 'buyAmountCryptoBaseUnit' in input
+    ? { direction: 'exactOut', cryptoBaseUnit: input.buyAmountCryptoBaseUnit }
+    : { direction: 'exactIn', cryptoBaseUnit: input.sellAmountIncludingProtocolFeesCryptoBaseUnit };
 // Bands are unambiguous for any realistic date: unix s land ~2e9, ms ~2e12, µs ~2e15, ns ~2e18
 export const normalizeEpochToMs = (value) => {
     if (value < 1e12)
@@ -68,3 +72,19 @@ export const getTreasuryAddressFromChainId = (chainId) => {
         throw new Error(`[getTreasuryAddressFromChainId] - Unsupported chainId: ${chainId}`);
     return treasuryAddress;
 };
+export const getDepositAddress = (step, swapperName) => {
+    switch (swapperName) {
+        case SwapperName.Chainflip:
+            return step.chainflipSpecific?.depositAddress || undefined;
+        case SwapperName.NearIntents: {
+            if (step.swapperMetadata?.name !== 'nearIntents')
+                return;
+            const { depositAddress, depositMemo } = step.swapperMetadata;
+            if (depositMemo)
+                return;
+            return depositAddress || undefined;
+        }
+        default:
+            return;
+    }
+};

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

@@ -2,7 +2,9 @@ import { thorchainChainId } from '@shapeshiftoss/caip';
 import { KnownChainIds } from '@shapeshiftoss/types';
 import { treasuryChainIds } from '@shapeshiftoss/utils';
 import { describe, expect, it } from 'vitest';
-import { getTreasuryAddressFromChainId, normalizeEpochToMs } from './helpers.js';
+import { swappers } from '../constants.js';
+import { SwapperName } from '../types.js';
+import { getDepositAddress, getTreasuryAddressFromChainId, normalizeEpochToMs } from './helpers.js';
 describe('getTreasuryAddressFromChainId', () => {
     // Affiliate and fee recipient addresses for every swapper flow through here, so pin the values
     // rather than the wiring - a chain pointing at another chain's treasury misroutes revenue silently
@@ -47,3 +49,42 @@ describe('normalizeEpochToMs', () => {
         expect(normalizeEpochToMs(epochMs * 1e6)).toBe(epochMs);
     });
 });
+const makeStep = (step) => step;
+describe('getDepositAddress', () => {
+    it('reads the chainflip deposit address', () => {
+        const step = makeStep({ chainflipSpecific: { depositAddress: 'bc1qdeposit' } });
+        expect(getDepositAddress(step, SwapperName.Chainflip)).toBe('bc1qdeposit');
+    });
+    it('returns undefined when chainflip has no deposit address', () => {
+        expect(getDepositAddress(makeStep({}), SwapperName.Chainflip)).toBeUndefined();
+    });
+    it('reads the near intents deposit address', () => {
+        const step = makeStep({
+            swapperMetadata: { name: 'nearIntents', depositAddress: '0xdeposit' },
+        });
+        expect(getDepositAddress(step, SwapperName.NearIntents)).toBe('0xdeposit');
+    });
+    it('rejects a memo-bound near intents deposit address', () => {
+        const step = makeStep({
+            swapperMetadata: { name: 'nearIntents', depositAddress: 'EQdeposit', depositMemo: '12345' },
+        });
+        expect(getDepositAddress(step, SwapperName.NearIntents)).toBeUndefined();
+    });
+    it('rejects an empty near intents deposit address', () => {
+        const step = makeStep({ swapperMetadata: { name: 'nearIntents', depositAddress: '' } });
+        expect(getDepositAddress(step, SwapperName.NearIntents)).toBeUndefined();
+    });
+    it('returns undefined for swappers that do not use deposit addresses', () => {
+        const step = makeStep({ chainflipSpecific: { depositAddress: 'bc1qdeposit' } });
+        expect(getDepositAddress(step, SwapperName.Relay)).toBeUndefined();
+    });
+});
+describe('supportsExternalPayment', () => {
+    it('is flagged on exactly the externally paid swappers', () => {
+        const flagged = Object.entries(swappers)
+            .filter(([, swapper]) => swapper?.supportsExternalPayment)
+            .map(([name]) => name)
+            .sort();
+        expect(flagged).toEqual([SwapperName.Chainflip, SwapperName.NearIntents].sort());
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapeshiftoss/swapper",
-  "version": "19.0.0",
+  "version": "20.1.0",
   "repository": "https://github.com/shapeshift/web",
   "license": "MIT",
   "type": "module",
@@ -28,7 +28,7 @@
     "@coral-xyz/anchor": "0.29.0",
     "@cowprotocol/app-data": "^2.3.0",
     "@defuse-protocol/one-click-sdk-typescript": "^0.1.1-0.2",
-    "@gobob/bob-sdk": "5.8.1",
+    "@gobob/bob-sdk": "5.11.1",
     "@mysten/sui": "^1.45.2",
     "@shapeshiftoss/bitcoinjs-lib": "7.0.0-shapeshift.0",
     "@sniptt/monads": "^0.5.10",
@@ -52,11 +52,11 @@
     "viem": "2.55.11",
     "@shapeshiftoss/caip": "^8.16.10",
     "@shapeshiftoss/hdwallet-core": "^1.62.41",
-    "@shapeshiftoss/types": "^9.0.0",
-    "@shapeshiftoss/unchained-client": "^10.14.11",
     "@shapeshiftoss/contracts": "^1.0.7",
-    "@shapeshiftoss/utils": "^1.1.0",
-    "@shapeshiftoss/chain-adapters": "^11.5.1"
+    "@shapeshiftoss/types": "^9.0.1",
+    "@shapeshiftoss/chain-adapters": "^11.5.1",
+    "@shapeshiftoss/utils": "^1.1.1",
+    "@shapeshiftoss/unchained-client": "^10.14.11"
   },
   "devDependencies": {
     "@types/lodash": "^4.14.178",