add custom okx source

Author: dglowinski

src/swapService/config/mainnet.ts

@@ -69,6 +69,7 @@ const mainnetRoutingConfig: ChainRoutingConfig = [
           "li-fi",
           "open-ocean",
           "magpie",
+          "okx",
         ],
       },
     },

src/swapService/strategies/balmySDK/customSourceList.ts

@@ -15,6 +15,7 @@ import { CustomMagpieQuoteSource } from "./sources/magpieQuoteSource"
 import { CustomNeptuneQuoteSource } from "./sources/neptuneQuoteSource"
 import { CustomOdosQuoteSource } from "./sources/odosQuoteSource"
 import { CustomOkuQuoteSource } from "./sources/okuQuoteSource"
+import { CustomOKXDexQuoteSource } from "./sources/okxDexQuoteSource"
 import { CustomOneInchQuoteSource } from "./sources/oneInchQuoteSource"
 import { CustomOogaboogaQuoteSource } from "./sources/oogaboogaQuoteSource"
 import { CustomOpenOceanQuoteSource } from "./sources/openOceanQuoteSource"
@@ -38,6 +39,7 @@ const customSources = {
   magpie: new CustomMagpieQuoteSource(),
   kyberswap: new CustomKyberswapQuoteSource(),
   enso: new CustomEnsoQuoteSource(),
+  "okx-dex": new CustomOKXDexQuoteSource(),
   oku_bob_icecreamswap: new CustomOkuQuoteSource(
     "icecreamswap",
     "IceCreamSwap",

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

@@ -0,0 +1,243 @@
+import crypto from "node:crypto"
+import {
+  type Address,
+  Addresses,
+  type ChainId,
+  Chains,
+  type IFetchService,
+  type TimeString,
+  Uint,
+  isSameAddress,
+} from "@balmy/sdk"
+import type {
+  BuildTxParams,
+  IQuoteSource,
+  QuoteParams,
+  QuoteSourceMetadata,
+  SourceQuoteResponse,
+  SourceQuoteTransaction,
+} from "@balmy/sdk/dist/services/quotes/quote-sources/types"
+import { failed } from "@balmy/sdk/dist/services/quotes/quote-sources/utils"
+import qs from "qs"
+
+// https://www.okx.com/web3/build/docs/waas/okx-waas-supported-networks
+const SUPPORTED_CHAINS = [
+  Chains.ETHEREUM,
+  Chains.OPTIMISM,
+  Chains.POLYGON,
+  Chains.BNB_CHAIN,
+  Chains.OKC,
+  Chains.AVALANCHE,
+  Chains.FANTOM,
+  Chains.ARBITRUM,
+  Chains.LINEA,
+  Chains.BASE,
+  Chains.SCROLL,
+  Chains.BLAST,
+  Chains.POLYGON_ZKEVM,
+  Chains.FANTOM,
+  Chains.MANTLE,
+  Chains.METIS_ANDROMEDA,
+  Chains.ZK_SYNC_ERA,
+  Chains.SONIC,
+  {
+    chainId: 130,
+    name: "Unichain",
+  },
+]
+
+const OKX_DEX_METADATA: QuoteSourceMetadata<OKXDexSupport> = {
+  name: "OKX Dex",
+  supports: {
+    chains: SUPPORTED_CHAINS.map(({ chainId }) => chainId),
+    swapAndTransfer: true,
+    buyOrders: false,
+  },
+  logoURI: "ipfs://QmarS9mPPLegvNaazZ8Kqg1gLvkbsvQE2tkdF6uZCvBrFn",
+}
+type OKXDexConfig = { apiKey: string; secretKey: string; passphrase: string }
+type OKXDexSupport = { buyOrders: false; swapAndTransfer: true }
+type OKXDexData = { tx: SourceQuoteTransaction }
+export class CustomOKXDexQuoteSource
+  implements IQuoteSource<OKXDexSupport, OKXDexConfig>
+{
+  getMetadata() {
+    return OKX_DEX_METADATA
+  }
+
+  async quote({
+    components,
+    request,
+    config,
+  }: QuoteParams<OKXDexSupport, OKXDexConfig>): Promise<
+    SourceQuoteResponse<OKXDexData>
+  > {
+    const [approvalTargetResponse, quoteResponse] = await Promise.all([
+      calculateApprovalTarget({ components, request, config }),
+      calculateQuote({ components, request, config }),
+    ])
+    const {
+      data: [
+        {
+          routerResult: { toTokenAmount },
+          tx: { minReceiveAmount, to, value, data, gas },
+        },
+      ],
+    } = quoteResponse
+    const {
+      data: [{ dexContractAddress: approvalTarget }],
+    } = approvalTargetResponse
+
+    return {
+      sellAmount: request.order.sellAmount,
+      maxSellAmount: request.order.sellAmount,
+      buyAmount: BigInt(toTokenAmount),
+      minBuyAmount: BigInt(minReceiveAmount),
+      estimatedGas: BigInt(gas),
+      allowanceTarget: approvalTarget,
+      type: "sell",
+      customData: {
+        tx: {
+          calldata: data,
+          to,
+          value: BigInt(value ?? 0),
+        },
+      },
+    }
+  }
+
+  async buildTx({
+    request,
+  }: BuildTxParams<OKXDexConfig, OKXDexData>): Promise<SourceQuoteTransaction> {
+    return request.customData.tx
+  }
+
+  isConfigAndContextValidForQuoting(
+    config: Partial<OKXDexConfig> | undefined,
+  ): config is OKXDexConfig {
+    return !!config?.apiKey && !!config?.passphrase && !!config?.secretKey
+  }
+
+  isConfigAndContextValidForTxBuilding(
+    config: Partial<OKXDexConfig> | undefined,
+  ): config is OKXDexConfig {
+    return true
+  }
+}
+
+async function calculateApprovalTarget({
+  components: { fetchService },
+  request: {
+    chainId,
+    sellToken,
+    buyToken,
+    config: { timeout },
+  },
+  config,
+}: QuoteParams<OKXDexSupport, OKXDexConfig>) {
+  if (isSameAddress(sellToken, Addresses.NATIVE_TOKEN)) {
+    return { data: [{ dexContractAddress: Addresses.ZERO_ADDRESS }] }
+  }
+  const queryParams = {
+    chainId,
+    tokenContractAddress: sellToken,
+    approveAmount: Uint.MAX_256,
+  }
+  const queryString = qs.stringify(queryParams, {
+    skipNulls: true,
+    arrayFormat: "comma",
+  })
+  const path = `/api/v5/dex/aggregator/approve-transaction?${queryString}`
+  return fetch({
+    sellToken,
+    buyToken,
+    chainId,
+    path,
+    timeout,
+    config,
+    fetchService,
+  })
+}
+
+async function calculateQuote({
+  components: { fetchService },
+  request: {
+    chainId,
+    sellToken,
+    buyToken,
+    order,
+    config: { slippagePercentage, timeout },
+    accounts: { takeFrom, recipient },
+  },
+  config,
+}: QuoteParams<OKXDexSupport, OKXDexConfig>) {
+  const queryParams = {
+    chainIndex: chainId,
+    amount: order.sellAmount.toString(),
+    fromTokenAddress: sellToken,
+    toTokenAddress: buyToken,
+    slippage: slippagePercentage / 100,
+    userWalletAddress: takeFrom,
+    swapReceiverAddress: recipient,
+  }
+  const queryString = qs.stringify(queryParams, {
+    skipNulls: true,
+    arrayFormat: "comma",
+  })
+  const path = `/api/v5/dex/aggregator/swap?${queryString}`
+  return fetch({
+    sellToken,
+    buyToken,
+    chainId,
+    path,
+    timeout,
+    config,
+    fetchService,
+  })
+}
+
+async function fetch({
+  sellToken,
+  buyToken,
+  chainId,
+  path,
+  fetchService,
+  config,
+  timeout,
+}: {
+  sellToken: Address
+  buyToken: Address
+  chainId: ChainId
+  path: string
+  timeout?: TimeString
+  config: OKXDexConfig
+  fetchService: IFetchService
+}) {
+  const timestamp = new Date().toISOString()
+  const toHash = `${timestamp}GET${path}`
+  const sign = crypto
+    .createHmac("sha256", config.secretKey)
+    .update(toHash)
+    .digest("base64")
+
+  const headers: HeadersInit = {
+    ["OK-ACCESS-KEY"]: config.apiKey,
+    ["OK-ACCESS-PASSPHRASE"]: config.passphrase,
+    ["OK-ACCESS-TIMESTAMP"]: timestamp,
+    ["OK-ACCESS-SIGN"]: sign,
+  }
+
+  const url = `https://web3.okx.com${path}`
+  const response = await fetchService.fetch(url, { timeout, headers })
+  console.log("response: ", response.status)
+  if (!response.ok) {
+    failed(
+      OKX_DEX_METADATA,
+      chainId,
+      sellToken,
+      buyToken,
+      await response.text(),
+    )
+  }
+  return response.json()
+}