@cetusprotocol/aggregator-sdk 0.0.8 → 0.1.0

package/src/utils/coin.ts

@@ -1,24 +1,27 @@
+import { SuiZeroCoinFn } from "../const"
+import { CoinAsset } from "../types/sui"
+import { CoinUtils } from "../types/CoinAssist"
+import { TransactionErrorCode } from "../errors"
+import {
+  Transaction,
+  TransactionObjectArgument,
+} from "@mysten/sui/transactions"
+
 export function completionCoin(s: string): string {
   const index = s.indexOf("::")
   if (index === -1) {
     return s
   }
-
   const prefix = s.substring(0, index)
   const rest = s.substring(index)
-
   if (!prefix.startsWith("0x")) {
     return s
   }
-
   const hexStr = prefix.substring(2)
-
   if (hexStr.length > 64) {
     return s
   }
-
   const paddedHexStr = hexStr.padStart(64, "0")
-
   return `0x${paddedHexStr}${rest}`
 }
 
@@ -38,3 +41,85 @@ export function compareCoins(coinA: string, coinB: string): boolean {
   // If both strings are the same length and all characters are equal
   return true // or coinB, they are equal
 }
+
+export function mintZeroCoin(
+  txb: Transaction,
+  coinType: string
+): TransactionObjectArgument {
+  return txb.moveCall({
+    target: SuiZeroCoinFn,
+    typeArguments: [coinType],
+  })
+}
+
+export type BuildCoinResult = {
+  targetCoin: TransactionObjectArgument
+  isMintZeroCoin: boolean
+  targetCoinAmount: number
+}
+
+export function buildInputCoin(
+  txb: Transaction,
+  allCoins: CoinAsset[],
+  amount: bigint,
+  coinType: string
+): BuildCoinResult {
+  const usedCoinAsests = CoinUtils.getCoinAssets(coinType, allCoins)
+  if (amount === BigInt(0) && usedCoinAsests.length === 0) {
+    const zeroCoin = mintZeroCoin(txb, coinType)
+    return {
+      targetCoin: zeroCoin,
+      isMintZeroCoin: true,
+      targetCoinAmount: 0,
+    }
+  }
+
+  let totalCoinBalance = CoinUtils.calculateTotalBalance(usedCoinAsests)
+  if (totalCoinBalance < amount) {
+    throw new AggregateError(
+      "Insufficient balance when build merge coin",
+      TransactionErrorCode.InsufficientBalance
+    )
+  }
+
+  if (CoinUtils.isSuiCoin(coinType)) {
+    const resultCoin = txb.splitCoins(txb.gas, [
+      txb.pure.u64(amount.toString()),
+    ])
+    return {
+      targetCoin: resultCoin,
+      isMintZeroCoin: true,
+      targetCoinAmount: Number(amount.toString()),
+    }
+  }
+
+  // sort used coin by amount, asc
+  let sortCoinAssets = CoinUtils.sortByBalance(usedCoinAsests)
+
+  // find first three coin if greater than amount
+  let totalThreeCoinBalance = sortCoinAssets
+    .slice(0, 3)
+    .reduce((acc, coin) => acc + coin.balance, BigInt(0))
+  if (totalThreeCoinBalance < BigInt(amount)) {
+    sortCoinAssets = CoinUtils.sortByBalanceDes(usedCoinAsests)
+  }
+
+  let selectedCoinResult = CoinUtils.selectCoinObjectIdGreaterThanOrEqual(
+    sortCoinAssets,
+    amount
+  )
+  const [masterCoin, ...mergedCoin] = selectedCoinResult.objectArray
+
+  if (mergedCoin.length > 0) {
+    txb.mergeCoins(
+      masterCoin,
+      mergedCoin.map((coin) => txb.object(coin))
+    )
+  }
+
+  return {
+    targetCoin: txb.object(masterCoin),
+    isMintZeroCoin: false,
+    targetCoinAmount: Number(amount.toString()),
+  }
+}

package/src/utils/transaction.ts

@@ -5,7 +5,7 @@ export async function printTransaction(tx: Transaction, isPrint = true) {
   let i = 0
 
   tx.getData().commands.forEach((item, index) => {
-    if (isPrint && i < 15) {
+    if (isPrint) {
       console.log(`transaction ${index}: `, JSON.stringify(item, null, 2))
       i++
     }

package/tests/router.test.ts

@@ -1,14 +1,14 @@
-import { describe, expect, test } from "@jest/globals"
+import { describe, test } from "@jest/globals"
 import dotenv from "dotenv"
 import { AggregatorClient } from "~/client"
-import { AggregatorConfig, ENV } from "~/config"
-import { M_CETUS, M_HASUI, M_NAVI, M_SUI, M_USDC } from "../src/test_data.test"
+import { M_CETUS, M_NAVI, M_SSWP, M_SUI, M_USDC } from "./test_data.test"
 import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519"
 import { printTransaction } from "~/utils/transaction"
 import BN from "bn.js"
-import { fromHEX } from "@mysten/bcs"
 import { fromB64 } from "@mysten/sui/utils"
-import { getFullnodeUrl } from "@mysten/sui/dist/cjs/client"
+import { SuiClient } from "@mysten/sui/client"
+import { Env } from "~/index"
+import { Transaction } from "@mysten/sui/transactions"
 
 dotenv.config()
 
@@ -19,7 +19,6 @@ export function buildTestAccount(): Ed25519Keypair {
 }
 
 describe("router module", () => {
-  let config: AggregatorConfig
   let client: AggregatorClient
   let keypair: Ed25519Keypair
 
@@ -28,28 +27,25 @@ describe("router module", () => {
     const aggregatorURL = process.env.CETUS_AGGREGATOR!
     const secret = process.env.SUI_WALLET_SECRET!
 
-    // const byte = Buffer.from(secret, "hex")
-    // keypair = secret
-    //   ? Ed25519Keypair.fromSecretKey(u8Array.slice(1, 33))
-    //   : buildTestAccount()
-    const byte = Buffer.from(secret, "base64")
-    const u8Array = new Uint8Array(byte)
-    const secretKey = fromB64(secret)
-    console.log("secret key", secretKey.toString())
-
-    keypair = Ed25519Keypair.fromSecretKey(fromB64(secret).slice(1, 33))
+    if (secret) {
+      keypair = Ed25519Keypair.fromSecretKey(fromB64(secret).slice(1, 33))
+    } else {
+      keypair = buildTestAccount()
+    }
 
-    // const wallet = keypair.getPublicKey().toSuiAddress()
+    const wallet = keypair.getPublicKey().toSuiAddress()
 
     // console.log("wallet", wallet, "\n", wallet.toString())
 
     // const wallet =
     // "0xfba94aa36e93ccc7d84a6a57040fc51983223f1b522a8d0be3c3bf2c98977ebb"
-    const wallet =
-      "0xaabf2fedcb36146db164bec930b74a47969c4df98216e049342a3c49b6d11580"
+    // const wallet =
+    // "0xa459702162b73204eed77420d93d9453b7a7b893a0edea1e268607cf7fa76e03"
+    // const wallet =
+    // "0xaabf2fedcb36146db164bec930b74a47969c4df98216e049342a3c49b6d11580"
     // const wallet = "0x410456cfc689666936b6bf80fbec958b69499b9f7183ecba07de577c17248a44"
     // const wallet = "0xca171941521153181ff729d53489eaae7e99c3f4692884afd7cca61154e4cec4"
-    // console.log("wallet: ", wallet)
+    console.log("wallet: ", wallet)
 
     const aggregatorPackage = {
       packageName: "aggregator",
@@ -66,20 +62,12 @@ describe("router module", () => {
       publishedAt:
         "0x8faab90228e4c4df91c41626bbaefa19fc25c514405ac64de54578dec9e6f5ee",
     }
-
-    config = new AggregatorConfig(
-      aggregatorURL,
-      fullNodeURL,
-      wallet,
-      [aggregatorPackage, integratePackage],
-      ENV.MAINNET
-    )
-    client = new AggregatorClient(config)
-  })
-
-  test("Init aggregator client", () => {
-    expect(config.getAggregatorUrl().length > 0).toBe(true)
-    expect(config.getWallet().length > 0).toBe(true)
+    const endpoint =
+      "https://api-sui-cloudfront.cetus.zone/router_v2/find_routes"
+    const suiClient = new SuiClient({
+      url: "https://fullnode.mainnet.sui.io:443",
+    })
+    client = new AggregatorClient(endpoint, wallet, suiClient, Env.Mainnet)
   })
 
   test("Get all coins", () => {
@@ -90,12 +78,13 @@ describe("router module", () => {
 
   test("Downgrade swap in route", async () => {
     const amount = 1000000
+    const byAmountIn = false
 
-    const res = await client.swapInPools({
+    const res: any = await client.swapInPools({
       from: M_USDC,
       target: M_SUI,
       amount: new BN(amount),
-      byAmountIn: true,
+      byAmountIn,
       pools: [
         "0xcf994611fd4c48e277ce3ffd4d4364c914af2c3cbb05f7bf6facd371de688630",
       ],
@@ -103,49 +92,72 @@ describe("router module", () => {
 
     if (res != null) {
       console.log(JSON.stringify(res, null, 2))
+      const txb = new Transaction()
+      await client.fastRouterSwap({
+        routers: res.routeData.routes,
+        byAmountIn,
+        txb,
+        slippage: 0.01,
+        isMergeTragetCoin: false,
+        refreshAllCoins: true,
+      })
+
+      let result = await client.devInspectTransactionBlock(txb)
+      console.log("🚀 ~ file: router.test.ts:114 ~ test ~ result:", result)
     }
-  })
+  }, 10000)
 
   test("Find router", async () => {
-    const amount = "423926761000000000000000000000"
-
-    const res = await client.findRouter({
+    const amount = "4239267610000000000"
+    const res = await client.findRouters({
       from: M_SUI,
       target: M_USDC,
       amount: new BN(amount),
       byAmountIn: true,
       depth: 3,
-      splitAlgorithm: null,
-      splitFactor: null,
       splitCount: 1,
-      providers: ["CETUS"],
+      // providers: ["CETUS"],
     })
 
     if (res != null) {
       console.log(JSON.stringify(res, null, 2))
     }
-
     console.log("amount in", res?.amountIn.toString())
     console.log("amount out", res?.amountOut.toString())
   })
 
   test("Build router tx", async () => {
     const byAmountIn = true
-    const amount = "3000000000000"
+    const amount = "1000000000"
+
+    // const from = M_USDC
+    // const target = M_SUI
 
     const from = M_SUI
-    const target = M_USDC
+    // const target =
+    //   "0xbde4ba4c2e274a60ce15c1cfff9e5c42e41654ac8b6d906a57efa4bd3c29f47d::hasui::HASUI"
+    // const target =
+    //   "0xf325ce1300e8dac124071d3152c5c5ee6174914f8bc2161e88329cf579246efc::afsui::AFSUI"
+
+    const target =
+      "0x549e8b69270defbfafd4f94e17ec44cdbdd99820b33bda2278dea3b9a32d3f55::cert::CERT"
 
-    const res = await client.findRouter({
+    const res = await client.findRouters({
       from,
       target,
       amount: new BN(amount),
       byAmountIn,
       depth: 3,
-      splitAlgorithm: null,
-      splitFactor: null,
-      splitCount: null,
-      providers: ["CETUS", "DEEPBOOK", "AFTERMATH", "FLOWX", "KRIYA", "TURBOS"],
+      providers: [
+        // "CETUS",
+        // "DEEPBOOK",
+        // "AFTERMATH",
+        // "FLOWX",
+        // "KRIYA",
+        // "KRIYAV3",
+        // "TURBOS",
+        "VOLO",
+      ],
     })
 
     if (res != null) {
@@ -155,28 +167,72 @@ describe("router module", () => {
     console.log("amount in", res?.amountIn.toString())
     console.log("amount out", res?.amountOut.toString())
 
+    const txb = new Transaction()
+
     if (res != null) {
       console.log(JSON.stringify(res, null, 2))
-      const routerTx = await client.routerSwap({
+      await client.fastRouterSwap({
         routers: res.routes,
-        amountIn: res.amountIn,
-        amountOut: res.amountOut,
         byAmountIn,
+        txb,
         slippage: 0.01,
-        fromCoinType: from,
-        targetCoinType: target,
-        partner: undefined,
         isMergeTragetCoin: false,
         refreshAllCoins: true,
       })
 
-      printTransaction(routerTx)
+      printTransaction(txb)
+
+      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)
+      // }
+    }
+  }, 600000)
+
+  test("By amount out", async () => {
+    const byAmountIn = false
+    const amount = "10000000000"
+
+    const from = M_USDC
+    const target = M_SSWP
+
+    const res = await client.findRouters({
+      from,
+      target,
+      amount: new BN(amount),
+      byAmountIn,
+      depth: 3,
+      providers: ["CETUS"],
+    })
+
+    console.log("amount in", res?.amountIn.toString())
+    console.log("amount out", res?.amountOut.toString())
+
+    const txb = new Transaction()
+    if (res != null) {
+      console.log(JSON.stringify(res, null, 2))
+      await client.fastRouterSwap({
+        routers: res.routes,
+        byAmountIn,
+        txb,
+        slippage: 0.02,
+        isMergeTragetCoin: false,
+        refreshAllCoins: true,
+      })
+
+      printTransaction(txb)
 
-      let result = await client.devInspectTransactionBlock(routerTx)
+      let result = await client.devInspectTransactionBlock(txb)
 
       if (result.effects.status.status === "success") {
         console.log("Sim exec transaction success")
-        // const result = await client.signAndExecuteTransaction(routerTx, keypair)
+        // const result = await client.signAndExecuteTransaction(txb, keypair)
         // console.log("result", result)
       } else {
         console.log("result", result)
@@ -200,32 +256,26 @@ describe("router module", () => {
             amount,
             byAmountIn,
           })
-          const res = await client.findRouter({
+
+          const res = await client.findRouters({
             from,
             target,
             amount: new BN(amount),
             byAmountIn,
-            depth: null,
-            splitAlgorithm: null,
-            splitFactor: null,
-            splitCount: null,
-            providers: null,
           })
 
+          const txb = new Transaction()
+
           if (res != null) {
-            const routerTx = await client.routerSwap({
+            await client.fastRouterSwap({
               routers: res.routes,
-              amountIn: res.amountIn,
-              amountOut: res.amountOut,
               byAmountIn,
               slippage: 0.01,
-              fromCoinType: from,
-              targetCoinType: target,
-              partner: undefined,
+              txb,
               isMergeTragetCoin: false,
             })
 
-            let result = await client.devInspectTransactionBlock(routerTx)
+            let result = await client.devInspectTransactionBlock(txb)
             // console.log('result', result)
 
             if (result.effects.status.status === "success") {

package/{src → tests}/test_data.test.ts

@@ -15,3 +15,5 @@ export const M_VAPOR =
   "0xa1f2c11169f32165ad4efb4468ec5bdfc880cd66b22094024b32ab7b76d14d30::vapor::VAPOR"
 export const M_HASUI =
   "0xbde4ba4c2e274a60ce15c1cfff9e5c42e41654ac8b6d906a57efa4bd3c29f47d::hasui::HASUI"
+export const M_SSWP =
+  "0x361dd589b98e8fcda9a7ee53b85efabef3569d00416640d2faa516e3801d7ffc::TOKEN::TOKEN"

package/dist/src/config.d.ts

@@ -1,26 +0,0 @@
-export type Package = {
-    packageName: string;
-    packageId: string;
-    publishedAt: string;
-};
-export declare enum ENV {
-    MAINNET = 0,
-    TESTNET = 1
-}
-export declare class AggregatorConfig {
-    private aggregatorUrl;
-    private fullNodeUrl;
-    private wallet;
-    private packages;
-    private env;
-    constructor(aggregatorUrl: string, fullNodeUrl: string, wallet: string, packages: Package[], env: ENV);
-    getAggregatorUrl(): string;
-    getFullNodeUrl(): string;
-    getWallet(): string;
-    getENV(): ENV;
-    getPackages(): Package[];
-    getPackage(packageName: string): Package | undefined;
-    addPackage(newPackage: Package): void;
-    removePackageById(packageId: string): void;
-    findPackageById(packageId: string): Package | undefined;
-}

package/dist/src/transaction/common.d.ts

@@ -1,12 +0,0 @@
-import { CoinAsset } from "../types/sui";
-import { AggregatorConfig } from "../config";
-import { Transaction, TransactionArgument, TransactionObjectArgument } from "@mysten/sui/transactions";
-export declare function mintZeroCoin(txb: Transaction, coinType: string): TransactionObjectArgument;
-export type BuildCoinResult = {
-    targetCoin: TransactionObjectArgument;
-    isMintZeroCoin: boolean;
-    targetCoinAmount: number;
-};
-export declare function buildInputCoin(txb: Transaction, allCoins: CoinAsset[], amount: bigint, coinType: string): BuildCoinResult;
-export declare function transferOrDestoryCoin(txb: Transaction, coinObject: TransactionObjectArgument, coinType: string, config: AggregatorConfig): void;
-export declare function checkCoinThresholdAndMergeCoin(txb: Transaction, coins: TransactionObjectArgument[], coinType: string, amountLimit: number, config: AggregatorConfig): TransactionArgument;

package/dist/src/transaction/deepbook.d.ts

@@ -1,21 +0,0 @@
-import { TransactionArgument, Transaction, TransactionObjectArgument } from "@mysten/sui/transactions";
-import { AggregatorConfig } from "../config";
-import { SuiClient } from "@mysten/sui/client";
-export type DeepbookSwapParams = {
-    poolId: string;
-    a2b: boolean;
-    amount: TransactionArgument;
-    amountLimit: number;
-    coinA?: TransactionObjectArgument;
-    coinB?: TransactionObjectArgument;
-    useFullInputCoinAmount: boolean;
-    coinAType: string;
-    coinBType: string;
-};
-export type DeepbookSwapResult = {
-    targetCoin: TransactionObjectArgument;
-    amountIn: TransactionArgument;
-    amountOut: TransactionArgument;
-    txb: Transaction;
-};
-export declare function deepbookSwapMovecall(swapParams: DeepbookSwapParams, client: SuiClient, txb: Transaction, config: AggregatorConfig): Promise<DeepbookSwapResult>;

package/dist/src/transaction/flowx.d.ts

@@ -1,20 +0,0 @@
-import { TransactionArgument, Transaction, TransactionObjectArgument } from "@mysten/sui/transactions";
-import { AggregatorConfig } from "../config";
-export type FlowxSwapParams = {
-    amount: TransactionArgument;
-    amountLimit: number;
-    a2b: boolean;
-    byAmountIn: boolean;
-    coinA?: TransactionObjectArgument;
-    coinB?: TransactionObjectArgument;
-    useFullInputCoinAmount: boolean;
-    coinAType: string;
-    coinBType: string;
-};
-export type FlowxSwapResult = {
-    targetCoin: TransactionObjectArgument;
-    amountIn: TransactionArgument;
-    amountOut: TransactionArgument;
-    txb: Transaction;
-};
-export declare function flowxAmmSwapMovecall(swapParams: FlowxSwapParams, txb: Transaction, config: AggregatorConfig): Promise<FlowxSwapResult>;

package/dist/src/transaction/kriya.d.ts

@@ -1,21 +0,0 @@
-import { TransactionArgument, Transaction, TransactionObjectArgument } from "@mysten/sui/transactions";
-import { AggregatorConfig } from "../config";
-export type KriyaSwapParams = {
-    poolId: string;
-    amount: TransactionArgument;
-    amountLimit: number;
-    a2b: boolean;
-    byAmountIn: boolean;
-    coinA?: TransactionObjectArgument;
-    coinB?: TransactionObjectArgument;
-    useFullInputCoinAmount: boolean;
-    coinAType: string;
-    coinBType: string;
-};
-export type KriyaSwapResult = {
-    targetCoin: TransactionObjectArgument;
-    amountIn: TransactionArgument;
-    amountOut: TransactionArgument;
-    txb: Transaction;
-};
-export declare function kriyaSwapMovecall(swapParams: KriyaSwapParams, txb: Transaction, config: AggregatorConfig): Promise<KriyaSwapResult>;

package/dist/src/transaction/router.d.ts

@@ -1,6 +0,0 @@
-import { Transaction, TransactionObjectArgument } from "@mysten/sui/transactions";
-import type { BuildRouterSwapParams } from "../client";
-import { AggregatorConfig } from "../config";
-import { SuiClient } from "@mysten/sui/client";
-export declare function expectInputRouterSwap(client: SuiClient, params: BuildRouterSwapParams, txb: Transaction, fromCoin: TransactionObjectArgument, config: AggregatorConfig, partner?: string): Promise<TransactionObjectArgument[]>;
-export declare function expectOutputRouterSwap(params: BuildRouterSwapParams, txb: Transaction, fromCoin: TransactionObjectArgument, config: AggregatorConfig, partner?: string): Promise<TransactionObjectArgument[]>;

package/dist/src/utils/account_cap.d.ts

@@ -1,7 +0,0 @@
-import { SuiClient } from "@mysten/sui/client";
-import { Transaction, TransactionObjectArgument } from "@mysten/sui/transactions";
-export type GetOrCreateAccountCapResult = {
-    accountCap: TransactionObjectArgument;
-    isCreate: boolean;
-};
-export declare function getOrCreateAccountCap(txb: Transaction, client: SuiClient, owner: string): Promise<GetOrCreateAccountCapResult>;

package/src/config.ts

@@ -1,65 +0,0 @@
-export type Package = {
-  packageName: string
-  packageId: string
-  publishedAt: string
-}
-
-export enum ENV {
-  MAINNET,
-  TESTNET,
-}
-
-export class AggregatorConfig {
-  private aggregatorUrl: string;
-  private fullNodeUrl: string;
-  private wallet: string;
-  private packages: Package[];
-  private env: ENV;
-
-  constructor(aggregatorUrl: string, fullNodeUrl: string, wallet: string, packages: Package[], env: ENV) {
-    this.aggregatorUrl = aggregatorUrl;
-    this.fullNodeUrl = fullNodeUrl;
-    this.wallet = wallet;
-    this.packages = packages;
-    this.env = env;
-  }
-
-  getAggregatorUrl(): string {
-    return this.aggregatorUrl;
-  }
-
-  getFullNodeUrl(): string {
-    return this.fullNodeUrl;
-  }
-
-  getWallet(): string {
-    return this.wallet;
-  }
-
-  getENV(): ENV {
-    return this.env
-  }
-
-  getPackages(): Package[] {
-    return this.packages;
-  }
-
-  getPackage(packageName: string) {
-    return this.packages.find(pkg => pkg.packageName === packageName);
-  }
-
-  addPackage(newPackage: Package): void {
-    if (!newPackage.packageName || !newPackage.packageId || !newPackage.publishedAt) {
-      throw new Error("Invalid package data");
-    }
-    this.packages.push(newPackage);
-  }
-
-  removePackageById(packageId: string): void {
-    this.packages = this.packages.filter(pkg => pkg.packageId !== packageId);
-  }
-
-  findPackageById(packageId: string): Package | undefined {
-    return this.packages.find(pkg => pkg.packageId === packageId);
-  }
-}