feat: use open-ocean pro endpoint

Author: dglowinski

src/swapService/strategies/balmySDK/customSourceList.ts

@@ -2,6 +2,7 @@ import type { IFetchService, IProviderService } from "@balmy/sdk"
 import { LocalSourceList } from "@balmy/sdk/dist/services/quotes/source-lists/local-source-list"
 import { CustomLiFiQuoteSource } from "./lifiQuoteSource"
 import { CustomOneInchQuoteSource } from "./oneInchQuoteSource"
+import { CustomOpenOceanQuoteSource } from "./openOceanQuoteSource"
 import { CustomPendleQuoteSource } from "./pendleQuoteSource"
 type ConstructorParameters = {
   providerService: IProviderService
@@ -12,6 +13,7 @@ const customSources = {
   "1inch": new CustomOneInchQuoteSource(),
   "li-fi": new CustomLiFiQuoteSource(),
   pendle: new CustomPendleQuoteSource(),
+  "open-ocean": new CustomOpenOceanQuoteSource(),
 }
 export class CustomSourceList extends LocalSourceList {
   constructor({ providerService, fetchService }: ConstructorParameters) {

src/swapService/strategies/balmySDK/openOceanQuoteSource.ts

@@ -0,0 +1,192 @@
+import {
+  type Address,
+  Addresses,
+  type ChainId,
+  Chains,
+  isSameAddress,
+} from "@balmy/sdk"
+import type { GasPrice } from "@balmy/sdk/dist/services/gas/types"
+import { AlwaysValidConfigAndContextSource } from "@balmy/sdk/dist/services/quotes/quote-sources/base/always-valid-source"
+import type {
+  BuildTxParams,
+  QuoteParams,
+  QuoteSourceMetadata,
+  SourceQuoteResponse,
+  SourceQuoteTransaction,
+} from "@balmy/sdk/dist/services/quotes/quote-sources/types"
+import {
+  calculateAllowanceTarget,
+  failed,
+} from "@balmy/sdk/dist/services/quotes/quote-sources/utils"
+import qs from "qs"
+import { formatUnits } from "viem"
+
+// https://docs.openocean.finance/dev/supported-chains
+const SUPPORTED_CHAINS: Record<
+  ChainId,
+  { chainKey: string; nativeAsset?: Address }
+> = {
+  [Chains.ETHEREUM.chainId]: { chainKey: "eth" },
+  [Chains.BNB_CHAIN.chainId]: { chainKey: "bsc" },
+  [Chains.POLYGON.chainId]: {
+    chainKey: "polygon",
+    nativeAsset: "0x0000000000000000000000000000000000001010",
+  },
+  [Chains.BASE.chainId]: { chainKey: "base" },
+  [Chains.LINEA.chainId]: { chainKey: "linea" },
+  [Chains.FANTOM.chainId]: {
+    chainKey: "fantom",
+    nativeAsset: "0x0000000000000000000000000000000000000000",
+  },
+  [Chains.AVALANCHE.chainId]: {
+    chainKey: "avax",
+    nativeAsset: "0x0000000000000000000000000000000000000000",
+  },
+  [Chains.ARBITRUM.chainId]: { chainKey: "arbitrum" },
+  [Chains.OPTIMISM.chainId]: { chainKey: "optimism" },
+  [Chains.MOONRIVER.chainId]: { chainKey: "moonriver" },
+  [Chains.AURORA.chainId]: { chainKey: "aurora" },
+  [Chains.CRONOS.chainId]: {
+    chainKey: "cronos",
+    nativeAsset: "0x0000000000000000000000000000000000000000",
+  },
+  [Chains.HARMONY_SHARD_0.chainId]: { chainKey: "harmony" },
+  [Chains.KAVA.chainId]: { chainKey: "kava" },
+  [Chains.METIS_ANDROMEDA.chainId]: {
+    chainKey: "metis",
+    nativeAsset: "0xdeaddeaddeaddeaddeaddeaddeaddeaddead0000",
+  },
+  [Chains.CELO.chainId]: {
+    chainKey: "celo",
+    nativeAsset: "0x471ece3750da237f93b8e339c536989b8978a438",
+  },
+  [Chains.POLYGON_ZKEVM.chainId]: { chainKey: "polygon_zkevm" },
+  [Chains.ONTOLOGY.chainId]: { chainKey: "ontvm" },
+  [Chains.GNOSIS.chainId]: {
+    chainKey: "xdai",
+    nativeAsset: "0x0000000000000000000000000000000000000000",
+  },
+  [Chains.opBNB.chainId]: { chainKey: "opbnb" },
+  [Chains.BLAST.chainId]: { chainKey: "blast" },
+  [Chains.ROOTSTOCK.chainId]: { chainKey: "rootstock" },
+  [Chains.MODE.chainId]: { chainKey: "mode" },
+}
+
+const OPEN_OCEAN_METADATA: QuoteSourceMetadata<OpenOceanSupport> = {
+  name: "Open Ocean",
+  supports: {
+    chains: Object.keys(SUPPORTED_CHAINS).map(Number),
+    swapAndTransfer: true,
+    buyOrders: false,
+  },
+  logoURI: "ipfs://QmP7bVENjMmobmjJcPFX6VbFTmj6pKmFNqv7Qkyqui44dT",
+}
+type OpenOceanSupport = { buyOrders: false; swapAndTransfer: true }
+type OpenOceanConfig = { sourceAllowlist?: string[]; apiKey?: string }
+type OpenOceanData = { tx: SourceQuoteTransaction }
+export class CustomOpenOceanQuoteSource extends AlwaysValidConfigAndContextSource<
+  OpenOceanSupport,
+  OpenOceanConfig,
+  OpenOceanData
+> {
+  getMetadata() {
+    return OPEN_OCEAN_METADATA
+  }
+
+  async quote({
+    components: { fetchService },
+    request: {
+      chainId,
+      sellToken,
+      buyToken,
+      order,
+      accounts: { takeFrom, recipient },
+      config: { slippagePercentage, timeout },
+      external,
+    },
+    config,
+  }: QuoteParams<OpenOceanSupport, OpenOceanConfig>): Promise<
+    SourceQuoteResponse<OpenOceanData>
+  > {
+    const [{ sellToken: sellTokenDataResult }, gasPriceResult] =
+      await Promise.all([
+        external.tokenData.request(),
+        external.gasPrice.request(),
+      ])
+    const legacyGasPrice = eip1159ToLegacy(gasPriceResult)
+    const gasPrice = Number.parseFloat(formatUnits(legacyGasPrice, 9))
+    const amount = formatUnits(order.sellAmount, sellTokenDataResult.decimals)
+    const { chainKey, nativeAsset } = SUPPORTED_CHAINS[chainId]
+    const native = nativeAsset ?? Addresses.NATIVE_TOKEN
+    const queryParams = {
+      inTokenAddress: isSameAddress(sellToken, Addresses.NATIVE_TOKEN)
+        ? native
+        : sellToken,
+      outTokenAddress: isSameAddress(buyToken, Addresses.NATIVE_TOKEN)
+        ? native
+        : buyToken,
+      amount: amount,
+      slippage: slippagePercentage,
+      gasPrice: gasPrice,
+      account: recipient ?? takeFrom,
+      referrer: config.referrer?.address,
+      enabledDexIds: config.sourceAllowlist,
+    }
+    const queryString = qs.stringify(queryParams, {
+      skipNulls: true,
+      arrayFormat: "comma",
+    })
+    const url = `https://open-api-pro.openocean.finance/v3/${chainKey}/swap_quote?${queryString}`
+    const headers: Record<string, string> = {}
+    if (config.apiKey) {
+      headers["apikey"] = config.apiKey
+    }
+
+    const response = await fetchService.fetch(url, { timeout, headers })
+    if (!response.ok) {
+      failed(
+        OPEN_OCEAN_METADATA,
+        chainId,
+        sellToken,
+        buyToken,
+        await response.text(),
+      )
+    }
+    const {
+      data: { outAmount, estimatedGas, minOutAmount, to, value, data },
+    } = await response.json()
+
+    return {
+      sellAmount: order.sellAmount,
+      maxSellAmount: order.sellAmount,
+      buyAmount: BigInt(outAmount),
+      minBuyAmount: BigInt(minOutAmount),
+      type: "sell",
+      estimatedGas: BigInt(estimatedGas),
+      allowanceTarget: calculateAllowanceTarget(sellToken, to),
+      customData: {
+        tx: {
+          to,
+          calldata: data,
+          value: BigInt(value ?? 0),
+        },
+      },
+    }
+  }
+
+  async buildTx({
+    request,
+  }: BuildTxParams<
+    OpenOceanConfig,
+    OpenOceanData
+  >): Promise<SourceQuoteTransaction> {
+    return request.customData.tx
+  }
+}
+
+function eip1159ToLegacy(gasPrice: GasPrice): bigint {
+  if ("gasPrice" in gasPrice) {
+    return BigInt(gasPrice.gasPrice)
+  }
+  return BigInt(gasPrice.maxFeePerGas)
+}

src/swapService/strategies/balmySDK/pendleQuoteSource.ts

@@ -1,6 +1,5 @@
 import { findToken } from "@/swapService/utils"
 import { Chains } from "@balmy/sdk"
-import { isSameAddress } from "@balmy/sdk"
 import type {
   BuildTxParams,
   IQuoteSource,
@@ -15,7 +14,7 @@ import {
   failed,
 } from "@balmy/sdk/dist/services/quotes/quote-sources/utils"
 import qs from "qs"
-import { Address, getAddress } from "viem"
+import { getAddress } from "viem"
 
 // https://api-v2.pendle.finance/core/docs#/Chains/ChainsController_getSupportedChainIds
 export const PENDLE_METADATA: QuoteSourceMetadata<PendleSupport> = {
@@ -51,6 +50,7 @@ export class CustomPendleQuoteSource
     params: QuoteParams<PendleSupport, PendleConfig>,
   ): Promise<SourceQuoteResponse<PendleData>> {
     const { dstAmount, to, data } = await this.getQuote(params)
+    console.log("pendle: ", dstAmount)
 
     const quote = {
       sellAmount: params.request.order.sellAmount,

src/swapService/strategies/strategyBalmySDK.ts

@@ -98,6 +98,9 @@ export class StrategyBalmySDK {
             pendle: {
               apiKey: String(process.env.PENDLE_API_KEY),
             },
+            "open-ocean": {
+              apiKey: String(process.env.OPENOCEAN_API_KEY),
+            },
           },
         },
       },
@@ -295,7 +298,6 @@ export class StrategyBalmySDK {
     sourcesFilter?: SourcesFilter,
   ) {
     // TODO type
-    // console.log('this.sdk.quoteService: ', this.sdk.quoteService);
     const bestQuote = await this.sdk.quoteService.getBestQuote({
       request: this.#getSDKQuoteFromSwapParams(swapParams, sourcesFilter),
       config: {