add spectra api support

Author: dglowinski

src/common/utils/tokenList.ts

@@ -16,6 +16,8 @@ export type TokenListItem = {
     pendleCrossChainPTPaired?: string
     isPendleLP?: boolean
     isPendleWrappedLP?: boolean
+    isSpectraPT?: boolean
+    spectraPool?: string
   }
 }
 

src/swapService/config/mainnet.ts

@@ -119,6 +119,7 @@ const mainnetRoutingConfig: ChainRoutingConfig = [
           "pendle",
           "okx-dex",
           "0x",
+          "spectra",
         ],
       },
     },
@@ -157,6 +158,7 @@ const mainnetRoutingConfig: ChainRoutingConfig = [
           "enso",
           "pendle",
           "0x",
+          "spectra",
         ],
       },
     },

src/swapService/strategies/balmySDK/customSourceList.ts

@@ -22,6 +22,7 @@ import { CustomOogaboogaQuoteSource } from "./sources/oogaboogaQuoteSource"
 import { CustomOpenOceanQuoteSource } from "./sources/openOceanQuoteSource"
 import { CustomParaswapQuoteSource } from "./sources/paraswapQuoteSource"
 import { CustomPendleQuoteSource } from "./sources/pendleQuoteSource"
+import { CustomSpectraQuoteSource } from "./sources/spectraQuoteSource"
 import { CustomUniswapQuoteSource } from "./sources/uniswapQuoteSource"
 
 import pendleAggregators from "./sources/pendle/pendleAggregators.json"
@@ -45,6 +46,7 @@ const customSources = {
   "okx-dex": new CustomOKXDexQuoteSource(),
   paraswap: new CustomParaswapQuoteSource(),
   "0x": new CustomZRXQuoteSource(),
+  spectra: new CustomSpectraQuoteSource(),
   oku_bob_icecreamswap: new CustomOkuQuoteSource(
     "icecreamswap",
     "IceCreamSwap",

src/swapService/strategies/balmySDK/sources/spectraQuoteSource.ts

@@ -0,0 +1,232 @@
+import type { TokenListItem } from "@/common/utils/tokenList"
+import { findToken } from "@/swapService/utils"
+import { Chains, type IFetchService } from "@balmy/sdk"
+import type {
+  BuildTxParams,
+  IQuoteSource,
+  QuoteParams,
+  QuoteSourceMetadata,
+  SourceQuoteResponse,
+  SourceQuoteTransaction,
+} from "@balmy/sdk/dist/services/quotes/quote-sources/types"
+import {
+  addQuoteSlippage,
+  calculateAllowanceTarget,
+  failed,
+} from "@balmy/sdk/dist/services/quotes/quote-sources/utils"
+import { log } from "@uniswap/smart-order-router"
+import qs from "qs"
+import { type Address, getAddress, isAddressEqual } from "viem"
+import { arbitrum, avalanche, base, bsc, mainnet, optimism } from "viem/chains"
+
+const SUPPORTED_CHAINS: Record<string, string> = {
+  [mainnet.id]: "mainnet",
+  [base.id]: "base",
+  [optimism.id]: "optimism",
+  [arbitrum.id]: "arbitrum",
+  [avalanche.id]: "avalanche",
+  [bsc.id]: "bsc",
+  [999]: "hyperevm",
+  [747474]: "katana",
+  [146]: "sonic",
+  [43111]: "hemi",
+}
+
+export const SPECTRA_METADATA: QuoteSourceMetadata<SpectraSupport> = {
+  name: "Spectra",
+  supports: {
+    chains: Object.keys(SUPPORTED_CHAINS).map(Number),
+    swapAndTransfer: true,
+    buyOrders: false,
+  },
+  logoURI: "",
+}
+type SpectraSupport = { buyOrders: false; swapAndTransfer: true }
+type SpectraConfig = object
+type SpectraData = { tx: SourceQuoteTransaction }
+
+type ExpiredPoolsCache = {
+  [chainId: number]: {
+    lastUpdated: number
+    pools: string[]
+  }
+}
+
+const todayUTC = () => new Date().setUTCHours(0, 0, 0, 0)
+
+export class CustomSpectraQuoteSource
+  implements IQuoteSource<SpectraSupport, SpectraConfig, SpectraData>
+{
+  private expiredPoolsCache: ExpiredPoolsCache = {}
+
+  getMetadata() {
+    return SPECTRA_METADATA
+  }
+
+  async quote(
+    params: QuoteParams<SpectraSupport, SpectraConfig>,
+  ): Promise<SourceQuoteResponse<SpectraData>> {
+    const { dstAmount, to, data } = await this.getQuote(params)
+    const quote = {
+      sellAmount: params.request.order.sellAmount,
+      buyAmount: BigInt(dstAmount),
+      allowanceTarget: calculateAllowanceTarget(params.request.sellToken, to),
+      customData: {
+        tx: {
+          to,
+          calldata: data,
+        },
+      },
+    }
+
+    return addQuoteSlippage(
+      quote,
+      params.request.order.type,
+      params.request.config.slippagePercentage,
+    )
+  }
+
+  async buildTx({
+    request,
+  }: BuildTxParams<
+    SpectraConfig,
+    SpectraData
+  >): Promise<SourceQuoteTransaction> {
+    return request.customData.tx
+  }
+
+  private async getQuote({
+    components: { fetchService },
+    request: {
+      chainId,
+      sellToken,
+      buyToken,
+      order,
+      config: { slippagePercentage, timeout },
+      accounts: { takeFrom, recipient },
+    },
+  }: QuoteParams<SpectraSupport, SpectraConfig>) {
+    const tokenIn = findToken(chainId, getAddress(sellToken))
+    const tokenOut = findToken(chainId, getAddress(buyToken))
+    if (!tokenIn || !tokenOut) throw new Error("Missing token in or out")
+    if (!tokenIn.meta?.isSpectraPT && !tokenOut.meta?.isSpectraPT) {
+      failed(
+        SPECTRA_METADATA,
+        chainId,
+        sellToken,
+        buyToken,
+        "Not Spectra PT tokens",
+      )
+    }
+    let url
+    if (tokenIn.meta?.isSpectraPT && tokenOut.meta?.isSpectraPT) {
+      // rollover
+      failed(SPECTRA_METADATA, chainId, sellToken, buyToken, "Not supported")
+    } else if (
+      tokenIn.meta?.isSpectraPT &&
+      (await this.isExpiredMarket(fetchService, chainId, tokenIn, timeout))
+    ) {
+      // redeem expired PT
+
+      const queryParams = {
+        receiver: recipient || takeFrom,
+        slippage: slippagePercentage, // (0 to 100)
+        tokenOut: buyToken,
+        amountIn: order.sellAmount.toString(),
+      }
+
+      const queryString = qs.stringify(queryParams)
+
+      url = `${getUrl(chainId)}/pts/${sellToken}/redeem?${queryString}`
+    } else {
+      // swap
+      const queryParams = {
+        tokenIn: sellToken,
+        tokenOut: buyToken,
+        receiver: recipient || takeFrom,
+        amountIn: order.sellAmount.toString(),
+        slippage: slippagePercentage, // 0 to 100
+      }
+
+      const queryString = qs.stringify(queryParams)
+
+      const spectraMarket =
+        tokenIn?.meta?.spectraPool || tokenOut?.meta?.spectraPool
+
+      url = `${getUrl(chainId)}/pools/${spectraMarket}/swap?${queryString}`
+    }
+
+    const response = await fetchService.fetch(url, {
+      timeout,
+    })
+
+    if (!response.ok) {
+      const msg =
+        (await response.text()) || `Failed with status ${response.status}`
+
+      log({ name: "[SPECTRA ERROR]", msg, recipient, url })
+      failed(SPECTRA_METADATA, chainId, sellToken, buyToken, msg)
+    }
+
+    const {
+      amountOut: dstAmount,
+      router: to,
+      calldata: data,
+    } = await response.json()
+
+    return { dstAmount, to, data }
+  }
+
+  private async isExpiredMarket(
+    fetchService: IFetchService,
+    chainId: number,
+    token: TokenListItem,
+    timeout?: string,
+  ) {
+    if (
+      !this.expiredPoolsCache[chainId] ||
+      this.expiredPoolsCache[chainId].lastUpdated !== todayUTC()
+    ) {
+      this.expiredPoolsCache[chainId] = {
+        pools: [],
+        lastUpdated: -1,
+      }
+
+      const url = `${getUrl(chainId)}/pools`
+      const response = await fetchService.fetch(url, {
+        timeout: timeout as any,
+      })
+
+      if (response.ok) {
+        const allPools = await response.json()
+
+        this.expiredPoolsCache[chainId] = {
+          pools: allPools
+            .filter((p: any) => p.maturity < (Date.now() / 1000).toFixed(0))
+            .map((p: any) => p.address),
+          lastUpdated: todayUTC(),
+        }
+      }
+    }
+
+    return !!this.expiredPoolsCache[chainId].pools.find((p) =>
+      isAddressEqual(p as Address, token.meta?.spectraPool as Address),
+    )
+  }
+
+  isConfigAndContextValidForQuoting(
+    config: Partial<SpectraConfig> | undefined,
+  ): config is SpectraConfig {
+    return true
+  }
+
+  isConfigAndContextValidForTxBuilding(
+    config: Partial<SpectraConfig> | undefined,
+  ): config is SpectraConfig {
+    return true
+  }
+}
+
+function getUrl(chainId: number) {
+  return `https://app.spectra.finance/api/v1/${SUPPORTED_CHAINS[chainId]}`
+}

tokenLists/tokenList_1.json

@@ -2333,7 +2333,7 @@
     "decimals": 18,
     "logoURI": "/tokens/1/0x50Bd66D59911F5e086Ec87aE43C811e0D059DD11.svg",
     "meta": {
-      "isSpectraMarket": true,
+      "isSpectraPT": true,
       "spectraPool": "0x593a8a7c12d8111e12945ff167389662a02b5ece"
     }
   },
@@ -2796,5 +2796,17 @@
       "provider": "DEFILLAMA",
       "poolId": "fef01bce-008a-43b0-85f9-5377a56411c4"
     }
+  },
+  {
+    "addressInfo": "0x7e840326632058e5c31327bb1e6ffd70679573ab",
+    "chainId": 1,
+    "decimals": 18,
+    "logoURI": "https://coin-images.coingecko.com/coins/images/35087/large/W_Token_%283%29.png?1758122686",
+    "name": "Principal Token: sw-stkGHO(GHO) 2026/01/31",
+    "symbol": "PT-sw-stkGHO(GHO)-2026/01/31",
+    "meta": {
+      "isSpectraPT": true,
+      "spectraPool": "0xfda98290209f6747fb24078cef8d3088b0c2801f"
+    }
   }
 ]