Integrate suilend and fix package config bug

Author: cetliquidity

README.md

@@ -31,45 +31,19 @@ By using our aggregator, you can trade more efficiently and securely on the Sui
 
 # Install
 
-The SDK is published to npm registry. To use the SDK in your project, you can run `npm install @cetusprotocol/aggregator-sdk`
+The SDK is published to npm registry. To use the SDK in your project, you can
+
+```
+npm install @cetusprotocol/aggregator-sdk
+```
 
 # Usage
 
 ## 1. Init client with rpc and package config
 
-1. Create aggregator client default.
-
-   ```typescript
-   const client = new AggregatorClient()
-   ```
-
-2. Customer create aggregator client by your self rpc node.
-
-   ```typescript
-   // used to do simulate swap and swap
-   // https://fullnode.mainnet.sui.io:443
-   const fullNodeURL = process.env.SUI_RPC!
-
-   const suiClient = new SuiClient({
-     url: fullNodeURL,
-   })
-
-   // provider by cetus
-   const aggregatorURL = "https://api-sui.cetus.zone/router_v2/find_routes"
-
-   // set your wallet address, used to do simulate
-   const wallet = "0x..."
-
-   // import { Env } from "@cetusprotocol/aggregator-sdk"
-   // Currently, we provide full support for Mainnet,
-   // while Testnet is only supported for Cetus and DeepBook providers.
-   const client = new AggregatorClient(
-     aggregatorURL,
-     wallet,
-     suiClient,
-     Env.Mainnet
-   )
-   ```
+```typescript
+const client = new AggregatorClient()
+```
 
 ## 2. Get best router swap result from aggregator service
 
@@ -92,35 +66,56 @@ const routerRes = await client.findRouters({
 ```typescript
 const routerTx = new Transaction()
 
-await client.fastRouterSwap({
-  routers: routerRes.routes,
-  byAmountIn,
-  txb: routerTx,
-  slippage: 0.01,
-  isMergeTragetCoin: true,
-  refreshAllCoins: true,
-})
+if (routerRes != null) {
+  await client.fastRouterSwap({
+    routers: routerRes.routes,
+    byAmountIn,
+    txb: routerTx,
+    slippage: 0.01,
+    isMergeTragetCoin: true,
+    refreshAllCoins: true,
+  })
+
+  let result = await client.devInspectTransactionBlock(routerTx, keypair)
+
+  if (result.effects.status.status === "success") {
+    console.log("Sim exec transaction success")
+    const result = await client.signAndExecuteTransaction(routerTx, keypair)
+  }
+  console.log("result", result)
+}
 ```
 
 ## 4. Build PTB and return target coin
 
 ```typescript
 const routerTx = new Transaction()
-
-const targetCoin = await client.routerSwap({
-  routers: routerRes.routes,
-  byAmountIn: true,
-  txb: routerTx,
-  inputCoin,
-  slippage: 0.01,
-})
-
-// you can use this target coin object argument to build your ptb.
-const client.transferOrDestoryCoin(
-    txb,
-    targetCoinRes.targetCoin,
-    targetCoinType
-)
+const byAmountIn = true;
+
+if (routerRes != null) {
+  const targetCoin = await client.routerSwap({
+    routers: routerRes.routes,
+    byAmountIn,
+    txb: routerTx,
+    inputCoin,
+    slippage: 0.01,
+  })
+
+  // you can use this target coin object argument to build your ptb.
+  const client.transferOrDestoryCoin(
+      txb,
+      targetCoin,
+      targetCoinType
+  )
+
+  let result = await client.devInspectTransactionBlock(routerTx, keypair)
+
+  if (result.effects.status.status === "success") {
+    console.log("Sim exec transaction success")
+    const result = await client.signAndExecuteTransaction(routerTx, keypair)
+  }
+  console.log("result", result)
+}
 ```
 
 # More About Cetus

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@cetusprotocol/aggregator-sdk",
-  "version": "0.3.6",
+  "version": "0.3.9",
   "sideEffects": false,
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -38,4 +38,4 @@
     "ts-jest": "^29.1.3",
     "typescript": "^5.4.5"
   }
-}
+}

package.json

@@ -168,7 +168,7 @@ async function getRouter(endpoint: string, params: FindRouterParams) {
     }
 
     // set newest sdk version
-    url += "&v=1000307"
+    url += "&v=1000309"
 
     const response = await fetch(url)
     return response

src/api.ts

@@ -37,6 +37,8 @@ import { CoinAsset } from "./types/sui"
 import { buildInputCoin } from "./utils/coin"
 import { DeepbookV3 } from "./transaction/deepbook_v3"
 import { Scallop } from "./transaction/scallop"
+import { Suilend } from "./transaction/suilend"
+
 export const CETUS = "CETUS"
 export const DEEPBOOKV2 = "DEEPBOOK"
 export const KRIYA = "KRIYA"
@@ -51,7 +53,7 @@ export const AFSUI = "AFSUI"
 export const BLUEMOVE = "BLUEMOVE"
 export const DEEPBOOKV3 = "DEEPBOOKV3"
 export const SCALLOP = "SCALLOP"
-
+export const SUILEND = "SUILEND"
 export const DEFAULT_ENDPOINT = "https://api-sui.cetus.zone/router_v2"
 
 export type BuildRouterSwapParams = {
@@ -410,7 +412,8 @@ export class AggregatorClient {
   publishedAtV2(): string {
     if (this.env === Env.Mainnet) {
       // return "0x43811be4677f5a5de7bf2dac740c10abddfaa524aee6b18e910eeadda8a2f6ae" // version 1, deepbookv3
-      return "0x6d70ffa7aa3f924c3f0b573d27d29895a0ee666aaff821073f75cb14af7fd01a" // version 3, deepbookv3 & scallop
+      // return "0x6d70ffa7aa3f924c3f0b573d27d29895a0ee666aaff821073f75cb14af7fd01a" // version 3, deepbookv3 & scallop
+      return "0x16d9418726c26d8cb4ce8c9dd75917fa9b1c7bf47d38d7a1a22603135f0f2a56" // version 4 add suilend
     } else {
       return "0xfd8a73ef0a4b928da9c27fc287dc37c1ca64df71da8e8eac7ca9ece55eb5f448"
     }
@@ -491,6 +494,8 @@ export class AggregatorClient {
         return new Bluemove(this.env)
       case SCALLOP:
         return new Scallop(this.env)
+      case SUILEND:
+        return new Suilend(this.env)
       default:
         throw new Error(`Unsupported dex ${provider}`)
     }

src/client.ts

@@ -0,0 +1,53 @@
+import {
+  Transaction,
+  TransactionObjectArgument,
+} from "@mysten/sui/transactions"
+import { AggregatorClient, Dex, Env, Path } from ".."
+
+export class Suilend implements Dex {
+  private liquid_staking_pool: string
+  private sui_system_state: string
+
+  constructor(env: Env) {
+    if (env !== Env.Mainnet) {
+      throw new Error("Suilend only supported on mainnet")
+    }
+
+    this.liquid_staking_pool =
+      env === Env.Mainnet
+        ? "0x15eda7330c8f99c30e430b4d82fd7ab2af3ead4ae17046fcb224aa9bad394f6b"
+        : "0x0"
+
+    this.sui_system_state =
+      env === Env.Mainnet
+        ? "0x0000000000000000000000000000000000000000000000000000000000000005"
+        : "0x0"
+  }
+
+  async swap(
+    client: AggregatorClient,
+    txb: Transaction,
+    path: Path,
+    inputCoin: TransactionObjectArgument
+  ): Promise<TransactionObjectArgument> {
+    const { direction, from, target } = path
+
+    const [func, springCoinType] = direction
+      ? ["swap_a2b", target]
+      : ["swap_b2a", from]
+
+    const args = [
+      txb.object(this.liquid_staking_pool),
+      txb.object(this.sui_system_state),
+      inputCoin,
+    ]
+
+    const res = txb.moveCall({
+      target: `${client.publishedAtV2()}::suilend::${func}`,
+      typeArguments: [springCoinType],
+      arguments: args,
+    }) as TransactionObjectArgument
+
+    return res
+  }
+}

src/transaction/suilend.ts

@@ -113,8 +113,8 @@ describe("router module", () => {
   test("Build router tx", async () => {
     const byAmountIn = true
     const amount = "320000"
-    const target = "0x2::sui::SUI"
-    const from = "0x26b3bc67befc214058ca78ea9a2690298d731a2d4309485ec3d40198063c4abc::eth::ETH"
+    const from = "0x2::sui::SUI"
+    const target = "0x83556891f4a0f233ce7b05cfe7f957d4020492a34f5405b2cb9377d060bef4bf::spring_sui::SPRING_SUI"
 
     const res = await client.findRouters({
       from,
@@ -123,8 +123,8 @@ describe("router module", () => {
       byAmountIn,
       depth: 3,
       providers: [
-        "SCALLOP",
-        "CETUS",
+        "SUILEND",
+        // "CETUS",
         // "DEEPBOOKV3",
         // "DEEPBOOK",
         // "AFTERMATH",