add bob and oku

Author: dglowinski

.env.template

@@ -28,6 +28,8 @@ RPC_URL_146=""
 RPC_URL_80094=""
 # unichain
 RPC_URL_130=""
+# bob
+RPC_URL_60808=""
 
 # Provider API keys
 LIFI_API_KEY=""

src/common/utils/contractBook.ts

@@ -11,6 +11,7 @@ const contractBook: any = {
       [146]: "0xbAf5B12c92711a3657DD4adA6b3C7801e83Bb56a",
       [80094]: "0x4A35e6A872cf35623cd3fD07ebECEDFc0170D705",
       [130]: "0x319E8ecd3BaB57fE684ca1aCfaB60c5603087B3A",
+      [60808]: "0x697Ca30D765c1603890D88AAffBa3BeCCe72059d",
     },
   },
   swapVerifier: {
@@ -23,6 +24,7 @@ const contractBook: any = {
       [146]: "0x003ef4048b45a5A79D4499aaBd52108B3Bc9209f",
       [80094]: "0x6fFf8Ac4AB123B62FF5e92aBb9fF702DCBD6C939",
       [130]: "0x7eaf8C22480129E5D7426e3A33880D7bE19B50a7",
+      [60808]: "0x296041DbdBC92171293F23c0a31e1574b791060d",
     },
   },
 }

src/swapService/config/bob.ts

@@ -0,0 +1,25 @@
+import { type ChainRoutingConfig, SwapperMode } from "../interface"
+import { StrategyBalmySDK, StrategyRepayWrapper } from "../strategies"
+
+const bobRoutingConfig: ChainRoutingConfig = [
+  // WRAPPERS
+  {
+    strategy: StrategyRepayWrapper.name(),
+    match: {
+      isRepay: true,
+      swapperModes: [SwapperMode.EXACT_IN],
+    },
+  },
+  // DEFAULTS
+  {
+    strategy: StrategyBalmySDK.name(),
+    config: {
+      sourcesFilter: {
+        includeSources: ["oku_bob_icecreamswap", "oku_bob_uniswap"],
+      },
+    },
+    match: {},
+  },
+]
+
+export default bobRoutingConfig

src/swapService/config/default.ts

@@ -24,6 +24,7 @@ const defaultRoutingConfig: ChainRoutingConfig = [
           "open-ocean",
           "uniswap",
           "0x",
+          "oku",
         ],
       },
     },

src/swapService/config/index.ts

@@ -2,6 +2,7 @@ import { base, mainnet } from "viem/chains"
 import type { RoutingConfig } from "../interface"
 import baseRoutingConfig from "./base"
 import beraRoutingConfig from "./bera"
+import bobRoutingConfig from "./bob"
 import defaultRoutingConfig from "./default"
 import mainnetRoutingConfig from "./mainnet"
 import swellRoutingConfig from "./swell"
@@ -11,6 +12,7 @@ const routingConfig: RoutingConfig = {
   [base.id]: baseRoutingConfig,
   [1923]: swellRoutingConfig,
   [80094]: beraRoutingConfig,
+  [60808]: bobRoutingConfig,
 }
 
 export const getRoutingConfig = (chainId: number) => {

src/swapService/strategies/balmySDK/customSourceList.ts

@@ -3,6 +3,7 @@ import { LocalSourceList } from "@balmy/sdk/dist/services/quotes/source-lists/lo
 import { CustomLiFiQuoteSource } from "./lifiQuoteSource"
 import { CustomNeptuneQuoteSource } from "./neptuneQuoteSource"
 import { CustomOdosQuoteSource } from "./odosQuoteSource"
+import { CustomOkuQuoteSource } from "./okuQuoteSource"
 import { CustomOneInchQuoteSource } from "./oneInchQuoteSource"
 import { CustomOogaboogaQuoteSource } from "./oogaboogaQuoteSource"
 import { CustomOpenOceanQuoteSource } from "./openOceanQuoteSource"
@@ -23,6 +24,12 @@ const customSources = {
   odos: new CustomOdosQuoteSource(),
   oogabooga: new CustomOogaboogaQuoteSource(),
   uniswap: new CustomUniswapQuoteSource(),
+  oku_bob_icecreamswap: new CustomOkuQuoteSource(
+    "icecreamswap",
+    "IceCreamSwap",
+    [60808],
+  ),
+  oku_bob_uniswap: new CustomOkuQuoteSource("usor", "Uniswap", [60808]),
 }
 export class CustomSourceList extends LocalSourceList {
   constructor({ providerService, fetchService }: ConstructorParameters) {

src/swapService/strategies/balmySDK/okuQuoteSource.ts

@@ -0,0 +1,192 @@
+import {
+  type Address,
+  Addresses,
+  type ChainId,
+  Chains,
+  Contract,
+  type GasPrice,
+  type TimeString,
+  type TokenAddress,
+  calculateDeadline,
+  getChainByKey,
+  isSameAddress,
+} from "@balmy/sdk"
+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 {
+  addQuoteSlippage,
+  calculateAllowanceTarget,
+  failed,
+} from "@balmy/sdk/dist/services/quotes/quote-sources/utils"
+import { type Address as ViemAddress, formatUnits, parseUnits } from "viem"
+
+const CHAINS: Record<ChainId, string> = {
+  [60808]: "bob",
+}
+
+const OKU_METADATA: QuoteSourceMetadata<OkuSupport> = {
+  name: "Oku",
+  supports: {
+    chains: Object.keys(CHAINS).map(Number),
+    swapAndTransfer: false,
+    buyOrders: true,
+  },
+  logoURI: "ipfs://QmS2Kf7sZz7DrcwWU9nNG8eGt2126G2p2c9PTDFT774sW7",
+}
+
+type OkuSupport = { buyOrders: true; swapAndTransfer: false }
+type OkuConfig = object
+type OkuData = {
+  coupon: any
+  signingRequest: any
+  txValidFor: TimeString | undefined
+  takeFrom: Address
+  tx: SourceQuoteTransaction
+}
+
+export class CustomOkuQuoteSource extends AlwaysValidConfigAndContextSource<
+  OkuSupport,
+  OkuConfig,
+  OkuData
+> {
+  private market: string
+  private marketName: string
+  private chains: number[] | undefined
+
+  constructor(market = "usor", marketName = "Uniswap", chains?: number[]) {
+    super()
+    this.market = market
+    this.marketName = marketName
+    this.chains = chains
+  }
+  getMetadata() {
+    return {
+      ...OKU_METADATA,
+      name: `${OKU_METADATA.name} ${this.marketName}`,
+      supports: {
+        ...OKU_METADATA.supports,
+        chains: this.chains || OKU_METADATA.supports.chains,
+      },
+    }
+  }
+
+  async quote({
+    components: { fetchService },
+    request: {
+      chainId,
+      sellToken,
+      buyToken,
+      order,
+      config: { slippagePercentage, timeout, txValidFor },
+      accounts: { takeFrom },
+      external,
+    },
+  }: QuoteParams<OkuSupport>): Promise<SourceQuoteResponse<OkuData>> {
+    const chain = getChainByKey(chainId)
+    if (
+      chain &&
+      isSameAddress(chain.wToken, sellToken) &&
+      isSameAddress(Addresses.NATIVE_TOKEN, buyToken)
+    )
+      throw new Error("Native token wrap not supported by this source")
+    if (
+      chain &&
+      isSameAddress(Addresses.NATIVE_TOKEN, sellToken) &&
+      isSameAddress(chain.wToken, buyToken)
+    )
+      throw new Error("Native token wrap not supported by this source")
+
+    const [gasPrice, tokenData] = await Promise.all([
+      external.gasPrice.request(),
+      external.tokenData.request(),
+    ])
+    const body = {
+      chain: CHAINS[chainId],
+      account: takeFrom,
+      gasPrice: Number(eip1159ToLegacy(gasPrice)),
+      isExactIn: order.type === "sell",
+      inTokenAddress: mapToken(sellToken),
+      outTokenAddress: mapToken(buyToken),
+      slippage: slippagePercentage * 100,
+      ...(order.type === "sell"
+        ? {
+            inTokenAmount: formatUnits(
+              order.sellAmount,
+              tokenData.sellToken.decimals,
+            ),
+          }
+        : {
+            outTokenAmount: formatUnits(
+              order.buyAmount,
+              tokenData.buyToken.decimals,
+            ),
+          }),
+    }
+    const quoteResponse = await fetchService.fetch(
+      `https://canoe.v2.icarus.tools/market/${this.market}/swap_quote`,
+      {
+        method: "POST",
+        body: JSON.stringify(body),
+        headers: { "Content-Type": "application/json" },
+        timeout,
+      },
+    )
+    if (!quoteResponse.ok) {
+      failed(
+        OKU_METADATA,
+        chainId,
+        sellToken,
+        buyToken,
+        await quoteResponse.text(),
+      )
+    }
+    const response = await quoteResponse.json()
+    const { coupon, inAmount, outAmount, signingRequest } = response
+    const sellAmount = parseUnits(inAmount, tokenData.sellToken.decimals)
+    const buyAmount = parseUnits(outAmount, tokenData.buyToken.decimals)
+    const to = coupon.raw.executionInformation.trade.to
+    const quote = {
+      sellAmount,
+      buyAmount,
+      type: order.type,
+      allowanceTarget: calculateAllowanceTarget(sellToken, to),
+      customData: {
+        coupon,
+        signingRequest,
+        txValidFor,
+        takeFrom,
+        tx: {
+          to,
+          calldata: coupon.raw.executionInformation.trade.data,
+          value: coupon.raw.executionInformation.trade.value,
+        },
+      },
+    }
+    return addQuoteSlippage(quote, order.type, slippagePercentage)
+  }
+
+  async buildTx({
+    request,
+  }: BuildTxParams<OkuConfig, OkuData>): Promise<SourceQuoteTransaction> {
+    return request.customData.tx
+  }
+}
+
+function mapToken(address: TokenAddress) {
+  return isSameAddress(address, Addresses.NATIVE_TOKEN)
+    ? Addresses.ZERO_ADDRESS
+    : (address as ViemAddress)
+}
+
+function eip1159ToLegacy(gasPrice: GasPrice): bigint {
+  if ("gasPrice" in gasPrice) {
+    return BigInt(gasPrice.gasPrice)
+  }
+  return BigInt(gasPrice.maxFeePerGas)
+}

tokenLists/tokenList_60808.json

@@ -0,0 +1,20 @@
+[
+  {
+    "addressInfo": "0x03C7054BCB39f7b2e5B2c7AcB37583e32D70Cfa3",
+    "chainId": 60808,
+    "name": "WBTC",
+    "symbol": "WBTC",
+    "decimals": 8,
+    "logoURI": "https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/ethereum/assets/0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2/logo.png",
+    "meta": {}
+  },
+  {
+    "addressInfo": "0xA45d4121b3D47719FF57a947A9d961539Ba33204",
+    "chainId": 60808,
+    "name": "LBTC",
+    "symbol": "LBTC",
+    "decimals": 8,
+    "logoURI": "https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/ethereum/assets/0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2/logo.png",
+    "meta": {}
+  }
+]