@cetusprotocol/aggregator-sdk 0.3.0 → 0.3.2

package/src/client.ts

@@ -1,5 +1,5 @@
 import Decimal from "decimal.js"
-import { SuiClient } from "@mysten/sui/client"
+import { getFullnodeUrl, SuiClient } from "@mysten/sui/client"
 import {
   Transaction,
   TransactionObjectArgument,
@@ -15,6 +15,9 @@ import {
   getRouterResult,
   Router,
   RouterData,
+  getDeepbookV3Config,
+  processEndpoint,
+  DeepbookV3Config,
 } from "."
 import { Aftermath } from "./transaction/aftermath"
 import { DeepbookV2 } from "./transaction/deepbook_v2"
@@ -32,6 +35,7 @@ import { Volo } from "./transaction/volo"
 import { Bluemove } from "./transaction/bluemove"
 import { CoinAsset } from "./types/sui"
 import { buildInputCoin } from "./utils/coin"
+import { DeepbookV3 } from "./transaction/deepbook_v3"
 
 export const CETUS = "CETUS"
 export const DEEPBOOKV2 = "DEEPBOOK"
@@ -45,6 +49,9 @@ export const HAEDAL = "HAEDAL"
 export const VOLO = "VOLO"
 export const AFSUI = "AFSUI"
 export const BLUEMOVE = "BLUEMOVE"
+export const DEEPBOOKV3 = "DEEPBOOKV3"
+
+export const DEFAULT_ENDPOINT = "https://api-sui.cetus.zone/router_v2"
 
 export type BuildRouterSwapParams = {
   routers: Router[]
@@ -53,6 +60,9 @@ export type BuildRouterSwapParams = {
   slippage: number
   txb: Transaction
   partner?: string
+  // This parameter is used to pass the Deep token object. When using the DeepBook V3 provider,
+  // users must pay fees with Deep tokens in non-whitelisted pools.
+  deepbookv3DeepFee?: TransactionObjectArgument
 }
 
 export type BuildFastRouterSwapParams = {
@@ -63,6 +73,7 @@ export type BuildFastRouterSwapParams = {
   partner?: string
   isMergeTragetCoin?: boolean
   refreshAllCoins?: boolean
+  payDeepFeeAmount?: number
 }
 
 export interface SwapInPoolsParams {
@@ -85,15 +96,19 @@ export class AggregatorClient {
   public env: Env
   private allCoins: CoinAsset[]
 
-  constructor(endpoint: string, signer: string, client: SuiClient, env: Env) {
-    this.endpoint = endpoint
-    this.client = client
-    this.signer = signer
-    this.env = env
+  constructor(endpoint?: string, signer?: string, client?: SuiClient, env?: Env) {
+    this.endpoint = endpoint ? processEndpoint(endpoint) : DEFAULT_ENDPOINT
+    this.client = client || new SuiClient({url: getFullnodeUrl('mainnet')})
+    this.signer = signer || ""
+    this.env = env || Env.Mainnet
     this.allCoins = []
   }
 
   async getAllCoins(): Promise<CoinAsset[]> {
+    if (this.signer === "") {
+      throw new Error("Signer is required, but not provided.")
+    }
+
     let cursor = null
     let limit = 50
     const allCoins: CoinAsset[] = []
@@ -127,7 +142,8 @@ export class AggregatorClient {
     inputCoin: TransactionObjectArgument,
     routers: Router[],
     amountOutLimit: BN,
-    partner?: string
+    partner?: string,
+    deepbookv3DeepFee?: TransactionObjectArgument,
   ) {
     if (routers.length === 0) {
       throw new Error("No router found")
@@ -144,7 +160,7 @@ export class AggregatorClient {
       let nextCoin = inputCoins[i] as TransactionObjectArgument
       for (const path of routers[i].path) {
         const dex = this.newDex(path.provider, partner)
-        nextCoin = await dex.swap(this, txb, path, nextCoin)
+        nextCoin = await dex.swap(this, txb, path, nextCoin, deepbookv3DeepFee)
       }
 
       outputCoins.push(nextCoin)
@@ -229,7 +245,7 @@ export class AggregatorClient {
   async routerSwap(
     params: BuildRouterSwapParams
   ): Promise<TransactionObjectArgument> {
-    const { routers, inputCoin, slippage, byAmountIn, txb, partner } = params
+    const { routers, inputCoin, slippage, byAmountIn, txb, partner, deepbookv3DeepFee } = params
     const amountIn = routers.reduce(
       (acc, router) => acc.add(router.amountIn),
       new BN(0)
@@ -250,7 +266,8 @@ export class AggregatorClient {
         inputCoin,
         routers,
         new BN(amountLimit),
-        partner
+        partner,
+        deepbookv3DeepFee
       )
       return targetCoin
     }
@@ -280,6 +297,7 @@ export class AggregatorClient {
       partner,
       isMergeTragetCoin,
       refreshAllCoins,
+      payDeepFeeAmount,
     } = params
     if (refreshAllCoins || this.allCoins.length === 0) {
       this.allCoins = await this.getAllCoins()
@@ -306,6 +324,17 @@ export class AggregatorClient {
       BigInt(amount.toString()),
       fromCoinType
     )
+
+    let deepCoin
+    if (payDeepFeeAmount && payDeepFeeAmount > 0) {
+      deepCoin = buildInputCoin(
+        txb,
+        this.allCoins,
+        BigInt(payDeepFeeAmount),
+        this.deepbookv3DeepFeeType()
+      ).targetCoin
+    }
+
     const targetCoin = await this.routerSwap({
       routers,
       inputCoin: buildFromCoinRes.targetCoin,
@@ -313,6 +342,7 @@ export class AggregatorClient {
       byAmountIn,
       txb,
       partner,
+      deepbookv3DeepFee: deepCoin,
     })
 
     if (isMergeTragetCoin) {
@@ -335,11 +365,29 @@ export class AggregatorClient {
     }
   }
 
+  // Include cetus、deepbookv2、flowxv2 & v3、kriyav2 & v3、turbos、aftermath、haedal、afsui、volo、bluemove
   publishedAt(): string {
     if (this.env === Env.Mainnet) {
-      return "0x764b8132a94d35abc9dfd91b23a0757b2a717d5ecb04c03098794aa2a508db91"
+      return "0xf98ed029af555e4a103febf26243dc33ac09a7ea1b2da7e414c728b25b729086" // version 3
+    } else {
+      return "0x0ed287d6c3fe4962d0994ffddc1d19a15fba6a81533f3f0dcc2bbcedebce0637"
+    }
+  }
+
+  // Include deepbookv3
+  publishedAtV2(): string {
+    if (this.env === Env.Mainnet) {
+      return "0x43811be4677f5a5de7bf2dac740c10abddfaa524aee6b18e910eeadda8a2f6ae" // version 1
     } else {
-      return "0x6cbaa3e9fbe902d90191b12f315932bc58079cba422bafbd4b4369f80e61f595"
+      return "0x0ed287d6c3fe4962d0994ffddc1d19a15fba6a81533f3f0dcc2bbcedebce0637"
+    }
+  }
+
+  deepbookv3DeepFeeType(): string {
+    if (this.env === Env.Mainnet) {
+      return "0xdeeb7a4662eec9f2f3def03fb937a663dddaa2e215b8078a284d026b7946c270::deep::DEEP"
+    } else {
+      return "0x36dbef866a1d62bf7328989a10fb2f07d769f4ee587c0de4a0a256e57e0a58a8::deep::DEEP"
     }
   }
 
@@ -372,7 +420,7 @@ export class AggregatorClient {
       targetCoin = coins[0]
     }
 
-    const res = txb.moveCall({
+    txb.moveCall({
       target: `${this.publishedAt()}::utils::check_coin_threshold`,
       typeArguments: [coinType],
       arguments: [targetCoin, txb.pure.u64(amountLimit.toString())],
@@ -386,6 +434,8 @@ export class AggregatorClient {
         return new Cetus(this.env, partner)
       case DEEPBOOKV2:
         return new DeepbookV2(this.env)
+      case DEEPBOOKV3:
+        return new DeepbookV3(this.env)
       case KRIYA:
         return new KriyaV2(this.env)
       case KRIYAV3:
@@ -441,10 +491,27 @@ export class AggregatorClient {
     })
     return res
   }
+
+  async getDeepbookV3Config(): Promise<DeepbookV3Config | null> {
+    const res = await getDeepbookV3Config(this.endpoint)
+    if (res) {
+      return res.data
+    }
+    return null
+  }
 }
 
 export function parseRouterResponse(data: any): RouterData {
-  return {
+  let totalDeepFee = 0
+  for (const route of data.routes) {
+    for (const path of route.path) {
+      if (path.extended_details && path.extended_details.deepbookv3_deep_fee) {
+        totalDeepFee += Number(path.extended_details.deepbookv3_deep_fee)
+      }
+    }
+  }
+
+  let routerData: RouterData = {
     amountIn: new BN(data.amount_in.toString()),
     amountOut: new BN(data.amount_out.toString()),
     insufficientLiquidity: false,
@@ -461,13 +528,15 @@ export function parseRouterResponse(data: any): RouterData {
           if (
             path.provider === TURBOS ||
             path.provider === AFTERMATH ||
-            path.provider === CETUS
+            path.provider === CETUS ||
+            path.provider === DEEPBOOKV3
           ) {
             extendedDetails = {
               aftermathLpSupplyType:
                 path.extended_details?.aftermath_lp_supply_type,
               turbosFeeType: path.extended_details?.turbos_fee_type,
               afterSqrtPrice: path.extended_details?.after_sqrt_price,
+              deepbookv3DeepFee: path.extended_details?.deepbookv3_deep_fee,
             }
           }
 
@@ -489,5 +558,8 @@ export function parseRouterResponse(data: any): RouterData {
         initialPrice: new Decimal(route.initial_price.toString()),
       }
     }),
+    totalDeepFee: totalDeepFee,
   }
+
+  return routerData
 }

package/src/transaction/afsui.ts

@@ -3,7 +3,6 @@ import {
   TransactionObjectArgument,
 } from "@mysten/sui/transactions"
 import { AggregatorClient, Dex, Env, Path } from ".."
-import { SUI_SYSTEM_ADDRESS } from "@mysten/sui/utils"
 
 export class Afsui implements Dex {
   private stakedSuiVault: string

package/src/transaction/aftermath.ts

@@ -1,8 +1,6 @@
 import {
   Transaction,
-  TransactionArgument,
   TransactionObjectArgument,
-  TransactionResult,
 } from "@mysten/sui/transactions"
 import { AggregatorClient, Dex, Env, Path } from ".."
 import BN from "bn.js"

package/src/transaction/deepbook_v2.ts

@@ -1,6 +1,5 @@
 import {
   Transaction,
-  TransactionArgument,
   TransactionObjectArgument,
 } from "@mysten/sui/transactions"
 import { AggregatorClient, CLOCK_ADDRESS, Dex, Env, Path } from ".."

package/src/transaction/deepbook_v3.ts

@@ -0,0 +1,58 @@
+import {
+  Transaction,
+  TransactionArgument,
+  TransactionObjectArgument,
+} from "@mysten/sui/transactions"
+import { AggregatorClient, CLOCK_ADDRESS, Dex, Env, Path } from ".."
+import { mintZeroCoin } from "~/utils/coin"
+
+export type CetusFlashSwapResult = {
+  targetCoin: TransactionObjectArgument
+  flashReceipt: TransactionObjectArgument
+  payAmount: TransactionArgument
+}
+
+export class DeepbookV3 implements Dex {
+  private deepbookV3Config: string
+
+  constructor(env: Env) {
+    this.deepbookV3Config =
+      env === Env.Mainnet
+        ? "0xe4099d0cda04f3aa80028fac91a9b3dbe50d08f2ff42aa2c29473926e34ca48c"
+        : "0xe19b5d072346cae83a037d4e3c8492068a74410a74e5830b3a68012db38296aa"
+  }
+
+  async swap(
+    client: AggregatorClient,
+    txb: Transaction,
+    path: Path,
+    inputCoin: TransactionObjectArgument,
+    deepbookv3DeepFee?: TransactionObjectArgument
+  ): Promise<TransactionObjectArgument> {
+    const { direction, from, target } = path
+    const [func, coinAType, coinBType] = direction
+      ? ["swap_a2b", from, target]
+      : ["swap_b2a", target, from]
+
+    let deepFee
+    if (deepbookv3DeepFee) {
+      deepFee = deepbookv3DeepFee
+    } else {
+      deepFee = mintZeroCoin(txb, client.deepbookv3DeepFeeType())
+    }
+
+    const args = [
+      txb.object(this.deepbookV3Config),
+      txb.object(path.id),
+      inputCoin,
+      deepFee,
+      txb.object(CLOCK_ADDRESS),
+    ]
+    const res = txb.moveCall({
+      target: `${client.publishedAtV2()}::deepbookv3::${func}`,
+      typeArguments: [coinAType, coinBType],
+      arguments: args,
+    }) as TransactionArgument
+    return res
+  }
+}

package/src/transaction/index.ts

@@ -12,6 +12,7 @@ export interface Dex {
     client: AggregatorClient,
     ptb: Transaction,
     path: Path,
-    inputCoin: TransactionObjectArgument
+    inputCoin: TransactionObjectArgument,
+    deepbookv3DeepFee?: TransactionObjectArgument
   ): Promise<TransactionObjectArgument>
 }

package/src/transaction/swap.ts

@@ -7,6 +7,7 @@ import { checkInvalidSuiAddress } from "~/utils/transaction"
 import { SuiClient } from "@mysten/sui/client"
 import { BN } from "bn.js"
 import { sqrtPriceX64ToPrice } from "~/math"
+import { error } from "console"
 
 export async function swapInPools(
   client: SuiClient,
@@ -25,6 +26,10 @@ export async function swapInPools(
   const coinB = direction ? targetCoin : fromCoin
 
   const typeArguments = [coinA, coinB]
+  console.log("typeArguments", typeArguments)
+
+  console.log("pools", pools)
+
   for (let i = 0; i < pools.length; i++) {
     const args = [
       tx.object(pools[i]),
@@ -51,6 +56,7 @@ export async function swapInPools(
     sender,
   })
   if (simulateRes.error != null) {
+    console.log("simulateRes.error", simulateRes.error)
     throw new AggregateError(
       "Aggregator package not set",
       ConfigErrorCode.SimulateError

package/src/transaction/volo.ts

@@ -3,7 +3,6 @@ import {
   TransactionObjectArgument,
 } from "@mysten/sui/transactions"
 import { AggregatorClient, Dex, Env, Path } from ".."
-import { SUI_SYSTEM_ADDRESS } from "@mysten/sui/utils"
 
 export class Volo implements Dex {
   private nativePool: string

package/src/utils/api.ts

@@ -0,0 +1,6 @@
+export function processEndpoint(endpoint: string): string {
+  if (endpoint.endsWith("/find_routes")) {
+    return endpoint.replace("/find_routes", "")
+  }
+  return endpoint
+}

package/src/utils/coin.ts

@@ -76,8 +76,8 @@ export function buildInputCoin(
   let totalCoinBalance = CoinUtils.calculateTotalBalance(usedCoinAsests)
   if (totalCoinBalance < amount) {
     throw new AggregateError(
-      "Insufficient balance when build merge coin",
-      TransactionErrorCode.InsufficientBalance
+      "Insufficient balance when build merge coin, coinType: " + coinType,
+      TransactionErrorCode.InsufficientBalance  + coinType
     )
   }
 

package/src/utils/index.ts

@@ -1,2 +1,5 @@
 export * from './contracts'
 export * from './msafe'
+export * from './api'
+export * from './coin'
+export * from './transaction'

package/test.json

@@ -0,0 +1,5 @@
+[
+  [Path { id: "0x0d1b1746d220bd5ebac5231c7685480a16f1c707a46306095a4c67dc7ce4dcae", edge_id: "0x0d1b1746d220bd5ebac5231c7685480a16f1c707a46306095a4c67dc7ce4dcae", provider: "DEEPBOOKV3", from: "0x36dbef866a1d62bf7328989a10fb2f07d769f4ee587c0de4a0a256e57e0a58a8::deep::DEEP", target: "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI", direction: true, fee_rate: Decimal(0), lot_size: 1000000, amount_in: 0, amount_out: 0, max_depth: 3, extended_details: None, allow_bidirection: true
+    }
+  ]
+]

package/tests/router.test.ts

@@ -4,10 +4,14 @@ import { AggregatorClient } from "~/client"
 import {
   M_CETUS,
   M_HASUI,
+  M_MICHI,
   M_NAVI,
   M_SSWP,
   M_SUI,
   M_USDC,
+  T_DBUSDC,
+  T_DBUSDT,
+  T_DEEP,
 } from "./test_data.test"
 import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519"
 import { printTransaction } from "~/utils/transaction"
@@ -44,37 +48,25 @@ describe("router module", () => {
 
     // console.log("wallet", wallet, "\n", wallet.toString())
 
+    // const wallet =
+      // "0x2a6174f94a2c1d648de290297be27867527a6aaa263a4e0a567c9cd7656d3651"
     const wallet =
       "0xfba94aa36e93ccc7d84a6a57040fc51983223f1b522a8d0be3c3bf2c98977ebb"
     // const wallet =
-    //   "0xa459702162b73204eed77420d93d9453b7a7b893a0edea1e268607cf7fa76e03"
-    // const wallet =
     // "0xaabf2fedcb36146db164bec930b74a47969c4df98216e049342a3c49b6d11580"
     // const wallet = "0x410456cfc689666936b6bf80fbec958b69499b9f7183ecba07de577c17248a44"
     // const wallet = "0xca171941521153181ff729d53489eaae7e99c3f4692884afd7cca61154e4cec4"
     console.log("wallet: ", wallet)
 
-    const aggregatorPackage = {
-      packageName: "aggregator",
-      packageId:
-        "0x640d44dbdc0ede165c7cc417d7f57f1b09648083109de7132c6b3fb15861f5ee",
-      publishedAt:
-        "0x640d44dbdc0ede165c7cc417d7f57f1b09648083109de7132c6b3fb15861f5ee",
-    }
-
-    const integratePackage = {
-      packageName: "integrate",
-      packageId:
-        "0x996c4d9480708fb8b92aa7acf819fb0497b5ec8e65ba06601cae2fb6db3312c3",
-      publishedAt:
-        "0x8faab90228e4c4df91c41626bbaefa19fc25c514405ac64de54578dec9e6f5ee",
-    }
     const endpoint =
       "https://api-sui-cloudfront.cetus.zone/router_v2/find_routes"
+    // const endpoint =
+      // "https://api-sui.devcetus.com/router_v2/find_routes"
+
     const suiClient = new SuiClient({
-      url: "https://fullnode.mainnet.sui.io:443",
+      url: "https://cetus-mainnet-rpc.blockvision.org:443/2R8NDfQ1v3UAqVAY8PwWQdB4FIb",
     })
-    client = new AggregatorClient(endpoint, wallet, suiClient, Env.Mainnet)
+    client = new AggregatorClient(endpoint, wallet, suiClient, Env.Testnet)
   })
 
   test("Get all coins", () => {
@@ -84,19 +76,21 @@ describe("router module", () => {
   })
 
   test("Downgrade swap in route", async () => {
-    const amount = 100000
-    const byAmountIn = false
+    const amount = 100000000
+    const byAmountIn = true
 
     const res: any = await client.swapInPools({
-      from: M_USDC,
-      target: M_SUI,
+      from: "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",
+      target: "0xdba34672e30cb065b1f93e3ab55318768fd6fef66c15942c9f7cb846e2f900e7::usdc::USDC",
       amount: new BN(amount),
       byAmountIn,
       pools: [
-        "0xcf994611fd4c48e277ce3ffd4d4364c914af2c3cbb05f7bf6facd371de688630",
+        '0x51e883ba7c0b566a26cbc8a94cd33eb0abd418a77cc1e60ad22fd9b1f29cd2ab', '0x03d7739b33fe221a830ff101042fa81fd19188feca04a335f7dea4e37c0fca81', '0xb8d7d9e66a60c239e7a60110efcf8de6c705580ed924d0dde141f4a0e2c90105'
       ],
     })
 
+    console.log("res", res)
+
     if (res != null) {
       console.log(JSON.stringify(res, null, 2))
       const txb = new Transaction()
@@ -112,7 +106,7 @@ describe("router module", () => {
       let result = await client.devInspectTransactionBlock(txb)
       console.log("🚀 ~ file: router.test.ts:114 ~ test ~ result:", result)
     }
-  }, 10000)
+  }, 60000)
 
   test("Find router", async () => {
     const amount = "4239267610000000000"
@@ -135,15 +129,9 @@ describe("router module", () => {
 
   test("Build router tx", async () => {
     const byAmountIn = true
-    const amount = "1000000000"
-
-    const from = M_SUI
-    // const target =
-    //   "0xbde4ba4c2e274a60ce15c1cfff9e5c42e41654ac8b6d906a57efa4bd3c29f47d::hasui::HASUI"
-    // const target =
-    //   "0xf325ce1300e8dac124071d3152c5c5ee6174914f8bc2161e88329cf579246efc::afsui::AFSUI"
-
-    const target = M_USDC
+    const amount = "32"
+    const target = M_SUI
+    const from = M_MICHI
 
     const res = await client.findRouters({
       from,
@@ -152,14 +140,14 @@ describe("router module", () => {
       byAmountIn,
       depth: 3,
       providers: [
-        // "CETUS",
+        "CETUS",
+        // "DEEPBOOKV3",
         // "DEEPBOOK",
         // "AFTERMATH",
         // "FLOWX",
         // "KRIYA",
         // "KRIYAV3",
         // "TURBOS",
-        "BLUEMOVE",
       ],
     })
 
@@ -181,6 +169,7 @@ describe("router module", () => {
         slippage: 0.01,
         isMergeTragetCoin: false,
         refreshAllCoins: true,
+        payDeepFeeAmount: 0,
       })
 
       printTransaction(txb)
@@ -188,13 +177,13 @@ describe("router module", () => {
       let result = await client.devInspectTransactionBlock(txb)
       console.log("🚀 ~ file: router.test.ts:180 ~ test ~ result:", result)
 
-      // if (result.effects.status.status === "success") {
-      //   console.log("Sim exec transaction success")
-      //   const result = await client.signAndExecuteTransaction(txb, keypair)
-      //   // console.log("result", result)
-      // } else {
-      //   console.log("result", result)
-      // }
+      if (result.effects.status.status === "success") {
+        // console.log("Sim exec transaction success")
+        const result = await client.signAndExecuteTransaction(txb, keypair)
+        console.log("result", result)
+      } else {
+        console.log("result", result)
+      }
     }
   }, 600000)
 
@@ -348,9 +337,6 @@ describe("router module", () => {
       console.log(JSON.stringify(res, null, 2))
     }
 
-    console.log("amount in", res?.amountIn.toString())
-    console.log("amount out", res?.amountOut.toString())
-
     const txb = new Transaction()
 
     if (res != null) {
@@ -378,4 +364,9 @@ describe("router module", () => {
       // }
     }
   }, 600000)
+
+  test("Get deepbook v3 config", async () => {
+    const config = await client.getDeepbookV3Config()
+    console.log("config", config)
+  }, 60000)
 })

package/tests/test_data.test.ts

@@ -1,5 +1,8 @@
 // Testnet
 export const T_USDC = ""
+export const T_DEEP = "0x36dbef866a1d62bf7328989a10fb2f07d769f4ee587c0de4a0a256e57e0a58a8::deep::DEEP"
+export const T_DBUSDC = "0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7::DBUSDC::DBUSDC"
+export const T_DBUSDT = "0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7::DBUSDT::DBUSDT"
 
 // Mainnet
 export const M_USDC =
@@ -17,3 +20,4 @@ export const M_HASUI =
   "0xbde4ba4c2e274a60ce15c1cfff9e5c42e41654ac8b6d906a57efa4bd3c29f47d::hasui::HASUI"
 export const M_SSWP =
   "0x361dd589b98e8fcda9a7ee53b85efabef3569d00416640d2faa516e3801d7ffc::TOKEN::TOKEN"
+export const M_MICHI = "0x50d796fde5709a97883e29e00bf511d66f2656de958ea0c2ce4c1147cdd20a23::MICHI::MICHI"