add custom enso source

Author: dglowinski

src/swapService/strategies/balmySDK/customSourceList.ts

@@ -1,5 +1,4 @@
 import { logQuoteTime } from "@/common/utils/logs"
-import { LOG_SLOW_QUERY_TIMEOUT_SECONDS } from "@/swapService/config/constants"
 import { parseHrtimeToSeconds } from "@/swapService/utils"
 import type {
   IFetchService,
@@ -9,7 +8,7 @@ import type {
   SourceListQuoteResponse,
 } from "@balmy/sdk"
 import { LocalSourceList } from "@balmy/sdk/dist/services/quotes/source-lists/local-source-list"
-import { stringify } from "viem"
+import { CustomEnsoQuoteSource } from "./sources/ensoQuoteSource"
 import { CustomKyberswapQuoteSource } from "./sources/kyberswapQuoteSource"
 import { CustomLiFiQuoteSource } from "./sources/lifiQuoteSource"
 import { CustomMagpieQuoteSource } from "./sources/magpieQuoteSource"
@@ -38,6 +37,7 @@ const customSources = {
   uniswap: new CustomUniswapQuoteSource(),
   magpie: new CustomMagpieQuoteSource(),
   kyberswap: new CustomKyberswapQuoteSource(),
+  enso: new CustomEnsoQuoteSource(),
   oku_bob_icecreamswap: new CustomOkuQuoteSource(
     "icecreamswap",
     "IceCreamSwap",

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

@@ -0,0 +1,140 @@
+import { Chains } from "@balmy/sdk"
+import type {
+  BuildTxParams,
+  IQuoteSource,
+  QuoteParams,
+  QuoteSourceMetadata,
+  SourceQuoteResponse,
+  SourceQuoteTransaction,
+} from "@balmy/sdk/dist/services/quotes/quote-sources/types"
+import {
+  addQuoteSlippage,
+  calculateAllowanceTarget,
+  checksum,
+  failed,
+} from "@balmy/sdk/dist/services/quotes/quote-sources/utils"
+import qs from "qs"
+
+const ENSO_METADATA: QuoteSourceMetadata<EnsoSupport> = {
+  name: "Enso",
+  supports: {
+    chains: [
+      Chains.ETHEREUM.chainId,
+      Chains.OPTIMISM.chainId,
+      Chains.BNB_CHAIN.chainId,
+      Chains.GNOSIS.chainId,
+      Chains.POLYGON.chainId,
+      Chains.BASE.chainId,
+      Chains.ARBITRUM.chainId,
+      Chains.AVALANCHE.chainId,
+      Chains.SONIC.chainId,
+      80094,
+    ],
+    swapAndTransfer: false,
+    buyOrders: false,
+  },
+  logoURI: "ipfs://QmWc9U7emJ7YvoLsxCvvJMxnEfMncJXrkqFpGoCP2LxZRJ",
+}
+type EnsoSupport = { buyOrders: false; swapAndTransfer: false }
+type EnsoConfig = {
+  apiKey: string
+  routingStrategy?: "router" | "delegate" | "ensowallet"
+}
+type EnsoData = { tx: SourceQuoteTransaction }
+export class CustomEnsoQuoteSource
+  implements IQuoteSource<EnsoSupport, EnsoConfig, EnsoData>
+{
+  getMetadata() {
+    return ENSO_METADATA
+  }
+
+  async quote({
+    components: { fetchService },
+    request: {
+      chainId,
+      sellToken,
+      buyToken,
+      order,
+      config: { slippagePercentage, timeout },
+      accounts: { takeFrom },
+    },
+    config,
+  }: QuoteParams<EnsoSupport, EnsoConfig>): Promise<
+    SourceQuoteResponse<EnsoData>
+  > {
+    const takeFromChecksummed = checksum(takeFrom)
+
+    const queryParams = {
+      fromAddress: takeFromChecksummed,
+      spender: takeFromChecksummed,
+      receiver: takeFromChecksummed,
+      tokenIn: sellToken,
+      amountIn: order.sellAmount.toString(),
+      tokenOut: buyToken,
+      routingStrategy: config?.routingStrategy ?? "router",
+      priceImpact: false,
+      chainId,
+      slippage: Math.floor(slippagePercentage * 100),
+      tokenInAmountToApprove: order.sellAmount.toString(),
+      tokenInAmountToTransfer: order.sellAmount.toString(),
+    }
+
+    const queryString = qs.stringify(queryParams, {
+      skipNulls: true,
+      arrayFormat: "comma",
+    })
+    const url = `https://api.enso.finance/api/v1/shortcuts/route?${queryString}`
+    const headers: Record<string, string> = {
+      "Content-Type": "application/json",
+    }
+    if (config.apiKey) {
+      headers["Authorization"] = `Bearer ${config.apiKey}`
+    }
+
+    const response = await fetchService.fetch(url, { timeout, headers })
+
+    if (!response.ok) {
+      failed(ENSO_METADATA, chainId, sellToken, buyToken, await response.text())
+    }
+
+    const {
+      amountOut,
+      // gas,
+      tx: { data, to, value },
+    } = await response.json()
+
+    const quote = {
+      sellAmount: order.sellAmount,
+      buyAmount: BigInt(amountOut),
+      allowanceTarget: calculateAllowanceTarget(sellToken, to),
+      // estimatedGas: BigInt(gas),
+      customData: {
+        tx: {
+          calldata: data,
+          to,
+          value: BigInt(value ?? 0),
+        },
+      },
+    }
+
+    return addQuoteSlippage(quote, order.type, slippagePercentage)
+  }
+
+  async buildTx({
+    request,
+  }: BuildTxParams<EnsoConfig, EnsoData>): Promise<SourceQuoteTransaction> {
+    return request.customData.tx
+  }
+
+  isConfigAndContextValidForQuoting(
+    config: Partial<EnsoConfig> | undefined,
+  ): config is EnsoConfig {
+    return !!config?.apiKey
+  }
+
+  isConfigAndContextValidForTxBuilding(
+    config: Partial<EnsoConfig> | undefined,
+  ): config is EnsoConfig {
+    return true
+  }
+}