@cetusprotocol/aggregator-sdk 0.11.1 → 0.12.0

package/README.md

@@ -29,7 +29,9 @@ Multi-Platform Support: Currently, we have integrated multiple mainstream DEXs o
 
 By using our aggregator, you can trade more efficiently and securely on the Sui blockchain, fully leveraging the various opportunities brought by decentralized finance (DeFi).
 
-# Install
+# Aggregator SDK
+
+## Install
 
 The SDK is published to npm registry. To use the SDK in your project, you can
 
@@ -37,33 +39,15 @@ 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
+## Usage
 
-1. Fast init:
-  ```typescript
-    const client = new AggregatorClient({})
-  ```
+### 1. Init client with rpc and package config
 
-2. Full init:
-> Note: overlayFeeRate and overlayFeeReceiver are used for additional fee logic beyond protocol fees, allowing project parties to collect extra fees.
-
-  ```typescript
-    const client = new AggregatorClient({
-      // endpoint, // If you do not have a exclusive aggregator api domain，just use cetus default aggregator endpoints.
-      signer: wallet,
-      client: suiClient,
-      env: Env.Mainnet,
-      pythUrls: ["YOUR_PYTH_URL", "ANOTHER_PYTH_URL"],
-      partner: "YOUR_PARTNER_ID", // Partner ID for fee sharing. Set once during initialization instead of per swap.
-      overlayFeeRate: 0.01, // Overlay fee rate (0.01 represents 1%). The denominator is 1000000, so 0.01% = 100
-      overlayFeeReceiver: "0x..", // Address to receive the overlay fees
-    })
-  ```
-**Notes**: Some providers, such as HaedalHMM and Metastable, rely on Pyth oracle prices when build transactions. Currently, we have a default configuration that connects to Pyth's publicly available node. However, if you frequently build transactions, we recommend setting up a private Pyth node interface as an additional backup. This will ensure uninterrupted access to HaedalHMM and Metastable, even if the public node experiences occasional downtime.
+```typescript
+const client = new AggregatorClient({})
+```
 
-## 2. Get best router swap result from aggregator service
+### 2. Get best router swap result from aggregator service
 
 ```typescript
 const amount = new BN(1000000)
@@ -79,72 +63,97 @@ const routers = await client.findRouters({
 })
 ```
 
-## 3. Confirm and do fast swap
+### 3. Confirm and do fast swap
+
 ```typescript
-const routerTx = new Transaction()
+const txb = new Transaction()
 
 if (routerRes != null) {
   await client.fastRouterSwap({
     routers,
-    txb: routerTx,
+    txb,
     slippage: 0.01,
-    isMergeTragetCoin: true,
-    refreshAllCoins: true
   })
 
-  let result = await client.devInspectTransactionBlock(routerTx, keypair)
+  const result = await client.devInspectTransactionBlock(txb, keypair)
 
   if (result.effects.status.status === "success") {
-    console.log("[Cetus] Transaction simulation successful")
-    const result = await client.signAndExecuteTransaction(routerTx, keypair)
-    console.log("[Cetus] Transaction executed successfully:", {
-      digest: result.digest,
-      status: result.effects?.status,
-      gasUsed: result.effects?.gasUsed
-    })
-  } else {
-    console.error("[Cetus] Transaction simulation failed:", result.effects?.status)
+    console.log("Sim exec transaction success")
+    const result = await client.signAndExecuteTransaction(txb, keypair)
   }
+  console.log("result", result)
 }
 ```
 
-## 4. Build PTB and return target coin
+### 4. Build PTB and return target coin
 
 ```typescript
-const routerTx = new Transaction()
-const byAmountIn = true;
+const txb = new Transaction()
+const byAmountIn = true
 
 if (routerRes != null) {
   const targetCoin = await client.routerSwap({
     routers,
-    txb: routerTx,
+    txb,
     inputCoin,
     slippage: 0.01,
   })
 
   // you can use this target coin object argument to build your ptb.
-  client.transferOrDestroyCoin(
-      txb,
-      targetCoin,
-      targetCoinType
-  )
+  client.transferOrDestoryCoin(txb, targetCoin, targetCoinType)
 
-  let result = await client.devInspectTransactionBlock(routerTx, keypair)
+  const result = await client.devInspectTransactionBlock(txb, keypair)
 
   if (result.effects.status.status === "success") {
-    console.log("[Cetus] Transaction simulation successful")
-    const result = await client.signAndExecuteTransaction(routerTx, keypair)
-    console.log("[Cetus] Transaction executed successfully:", {
-      digest: result.digest,
-      status: result.effects?.status,
-      gasUsed: result.effects?.gasUsed
-    })
-  } else {
-    console.error("[Cetus] Transaction simulation failed:", result.effects?.status)
+    console.log("Sim exec transaction success")
+    const result = await client.signAndExecuteTransaction(txb, keypair)
   }
+  console.log("result", result)
 }
 ```
 
+# Aggregator Contract Interface
+
+## Tags corresponding to different networks
+
+| Contract                  | Tag of Repo | Latest published at address                                        |
+| ------------------------- | ----------- | ------------------------------------------------------------------ |
+| CetusAggregatorV2         | mainnet     | 0x3864c7c59a4889fec05d1aae4bc9dba5a0e0940594b424fbed44cb3f6ac4c032 |
+| CetusAggregatorV2ExtendV1 | mainnet     | 0x39402d188b7231036e52266ebafad14413b4bf3daea4ac17115989444e6cd516 |
+| CetusAggregatorV2ExtendV2 | mainnet     | 0x368d13376443a8051b22b42a9125f6a3bc836422bb2d9c4a53984b8d6624c326 |
+
+## Example
+
+```
+CetusAggregatorV2 = { git = "https://github.com/CetusProtocol/aggregator.git", subdir = "packages/cetus-aggregator-v2/mainnet", rev = "mainnet", override = true }
+
+CetusAggregatorV2ExtendV1 = { git = "https://github.com/CetusProtocol/aggregator.git", subdir = "packages/cetus-aggregator-v2-extend-v1", rev = "mainnet", override = true }
+
+CetusAggregatorV2ExtendV2 = { git = "https://github.com/CetusProtocol/aggregator.git", subdir = "packages/cetus-aggregator-v2-extend-v2", rev = "mainnet", override = true }
+```
+
+# Simple Aggregator Contract Interface(include cetus, flowxv3, turbos, bluefin)
+
+## Tags corresponding to different networks
+
+| Contract              | Tag of Repo | Latest published at address                                        |
+| --------------------- | ----------- | ------------------------------------------------------------------ |
+| CetusAggregatorSimple | mainnet     | 0x594d67abc0778023ac852800578271dd7e18698ad06e6298034858c77612333d |
+
+## Example
+
+```
+CetusAggregatorSimple = { git = "https://github.com/CetusProtocol/aggregator.git", subdir = "packages/cetus-aggregator-v2/simple-mainnet", rev = "mainnet-v1.49.1", override = true }
+```
+
+## Usage
+
+Cetus clmm interface is not complete(just have function definition), so it will fails when sui client check the code version. However, this does not affect its actual functionality. Therefore, we need to add a --dependencies-are-root during the build.
+
+```
+sui move build --dependencies-are-root && sui client publish --dependencies-are-root
+```
+
 # More About Cetus
 
 Use the following links to learn more about Cetus:

package/dist/index.js

@@ -5805,7 +5805,7 @@ function swapInPools(client, params, sender, env) {
     const targetCoin = completionCoin(target);
     const tx = new transactions.Transaction();
     const direction = compareCoins(fromCoin, targetCoin);
-    const integratePublishedAt = env === 0 /* Mainnet */ ? "0x2d8c2e0fc6dd25b0214b3fa747e0fd27fd54608142cd2e4f64c1cd350cc4add4" : "0x4f920e1ef6318cfba77e20a0538a419a5a504c14230169438b99aba485db40a6";
+    const integratePublishedAt = env === 0 /* Mainnet */ ? "0xb2db7142fa83210a7d78d9c12ac49c043b3cbbd482224fea6e3da00aa5a5ae2d" : "0x4f920e1ef6318cfba77e20a0538a419a5a504c14230169438b99aba485db40a6";
     const coinA = direction ? fromCoin : targetCoin;
     const coinB = direction ? targetCoin : fromCoin;
     const typeArguments = [coinA, coinB];
@@ -7344,7 +7344,7 @@ var _AggregatorClient = class _AggregatorClient {
   // Include cetus、deepbookv2、flowxv2 & v3、kriyav2 & v3、turbos、aftermath、haedal、afsui、volo、bluemove
   publishedAtV2() {
     if (this.env === 0 /* Mainnet */) {
-      return "0x51966dc1d9d3e6d85aed55aa87eb9e78e928b4e74b4844a15ef7e3dfb5af3bae";
+      return "0x47a7b90756fba96fe649c2aaa10ec60dec6b8cb8545573d621310072721133aa";
     } else {
       return "0x52eae33adeb44de55cfb3f281d4cc9e02d976181c0952f5323648b5717b33934";
     }
@@ -7352,14 +7352,14 @@ var _AggregatorClient = class _AggregatorClient {
   // Include deepbookv3, scallop, bluefin
   publishedAtV2Extend() {
     if (this.env === 0 /* Mainnet */) {
-      return "0x7cdd26c4aa40c990d5ca780e0919b2de796be9bb41fba461d133bfacb0f677bc";
+      return "0x8093d002bba575f1378b0da206a8df1fc55c4b5b3718752304f1b67a505d2be4";
     } else {
       return "0xabb6a81c8a216828e317719e06125de5bb2cb0fe8f9916ff8c023ca5be224c78";
     }
   }
   publishedAtV2Extend2() {
     if (this.env === 0 /* Mainnet */) {
-      return "0x186d6d71cedd341ad744e40873cc1513ac539ffac860d0c3ebd27ec5da63d9ba";
+      return "0x96356d1cfc7a4dec5bc0171f085ddaf1f650b1c6c412f209518d496c8ffed212";
     } else {
       return "0x0";
     }
@@ -7760,7 +7760,7 @@ function processEndpoint(endpoint) {
 
 // src/api.ts
 var import_bn7 = __toESM(require_bn());
-var SDK_VERSION = 1001101;
+var SDK_VERSION = 1001200;
 function getRouterResult(endpoint, apiKey, params, overlayFee, overlayFeeReceiver) {
   return __async(this, null, function* () {
     let response;

package/dist/index.mjs

@@ -5803,7 +5803,7 @@ function swapInPools(client, params, sender, env) {
     const targetCoin = completionCoin(target);
     const tx = new Transaction();
     const direction = compareCoins(fromCoin, targetCoin);
-    const integratePublishedAt = env === 0 /* Mainnet */ ? "0x2d8c2e0fc6dd25b0214b3fa747e0fd27fd54608142cd2e4f64c1cd350cc4add4" : "0x4f920e1ef6318cfba77e20a0538a419a5a504c14230169438b99aba485db40a6";
+    const integratePublishedAt = env === 0 /* Mainnet */ ? "0xb2db7142fa83210a7d78d9c12ac49c043b3cbbd482224fea6e3da00aa5a5ae2d" : "0x4f920e1ef6318cfba77e20a0538a419a5a504c14230169438b99aba485db40a6";
     const coinA = direction ? fromCoin : targetCoin;
     const coinB = direction ? targetCoin : fromCoin;
     const typeArguments = [coinA, coinB];
@@ -7342,7 +7342,7 @@ var _AggregatorClient = class _AggregatorClient {
   // Include cetus、deepbookv2、flowxv2 & v3、kriyav2 & v3、turbos、aftermath、haedal、afsui、volo、bluemove
   publishedAtV2() {
     if (this.env === 0 /* Mainnet */) {
-      return "0x51966dc1d9d3e6d85aed55aa87eb9e78e928b4e74b4844a15ef7e3dfb5af3bae";
+      return "0x47a7b90756fba96fe649c2aaa10ec60dec6b8cb8545573d621310072721133aa";
     } else {
       return "0x52eae33adeb44de55cfb3f281d4cc9e02d976181c0952f5323648b5717b33934";
     }
@@ -7350,14 +7350,14 @@ var _AggregatorClient = class _AggregatorClient {
   // Include deepbookv3, scallop, bluefin
   publishedAtV2Extend() {
     if (this.env === 0 /* Mainnet */) {
-      return "0x7cdd26c4aa40c990d5ca780e0919b2de796be9bb41fba461d133bfacb0f677bc";
+      return "0x8093d002bba575f1378b0da206a8df1fc55c4b5b3718752304f1b67a505d2be4";
     } else {
       return "0xabb6a81c8a216828e317719e06125de5bb2cb0fe8f9916ff8c023ca5be224c78";
     }
   }
   publishedAtV2Extend2() {
     if (this.env === 0 /* Mainnet */) {
-      return "0x186d6d71cedd341ad744e40873cc1513ac539ffac860d0c3ebd27ec5da63d9ba";
+      return "0x96356d1cfc7a4dec5bc0171f085ddaf1f650b1c6c412f209518d496c8ffed212";
     } else {
       return "0x0";
     }
@@ -7758,7 +7758,7 @@ function processEndpoint(endpoint) {
 
 // src/api.ts
 var import_bn7 = __toESM(require_bn());
-var SDK_VERSION = 1001101;
+var SDK_VERSION = 1001200;
 function getRouterResult(endpoint, apiKey, params, overlayFee, overlayFeeReceiver) {
   return __async(this, null, function* () {
     let response;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cetusprotocol/aggregator-sdk",
-  "version": "0.11.1",
+  "version": "0.12.0",
   "sideEffects": false,
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/script/copy-to-sui-aggregator.sh

@@ -0,0 +1,85 @@
+#!/bin/bash
+
+# 复制 aggregator-sdk 文件到 sui/aggregator 目录的脚本
+# 作者: Auto Generated Script
+# 日期: $(date)
+
+set -e  # 遇到错误时退出
+
+# 定义源目录和目标目录
+SOURCE_DIR="/home/ccbond/github/cetus/aggregator-sdk"
+TARGET_DIR="/home/ccbond/github/sui/aggregator"
+
+# 颜色定义
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+NC='\033[0m' # No Color
+
+# 打印带颜色的消息
+print_message() {
+    local color=$1
+    local message=$2
+    echo -e "${color}${message}${NC}"
+}
+
+# 检查源目录是否存在
+if [ ! -d "$SOURCE_DIR" ]; then
+    print_message $RED "错误: 源目录 $SOURCE_DIR 不存在!"
+    exit 1
+fi
+
+# 创建目标目录（如果不存在）
+if [ ! -d "$TARGET_DIR" ]; then
+    print_message $YELLOW "目标目录 $TARGET_DIR 不存在，正在创建..."
+    mkdir -p "$TARGET_DIR"
+fi
+
+print_message $GREEN "开始复制文件..."
+print_message $YELLOW "源目录: $SOURCE_DIR"
+print_message $YELLOW "目标目录: $TARGET_DIR"
+echo
+
+# 复制 src 目录
+if [ -d "$SOURCE_DIR/src" ]; then
+    print_message $GREEN "复制 src 目录..."
+    cp -r "$SOURCE_DIR/src" "$TARGET_DIR/"
+else
+    print_message $RED "警告: src 目录不存在于源路径中"
+fi
+
+# 复制 package.json
+if [ -f "$SOURCE_DIR/package.json" ]; then
+    print_message $GREEN "复制 package.json..."
+    cp "$SOURCE_DIR/package.json" "$TARGET_DIR/"
+else
+    print_message $RED "警告: package.json 不存在于源路径中"
+fi
+
+# 复制 README.md (假设是 README.md)
+if [ -f "$SOURCE_DIR/README.md" ]; then
+    print_message $GREEN "复制 README.md..."
+    cp "$SOURCE_DIR/README.md" "$TARGET_DIR/"
+elif [ -f "$SOURCE_DIR/README" ]; then
+    print_message $GREEN "复制 README..."
+    cp "$SOURCE_DIR/README" "$TARGET_DIR/"
+else
+    print_message $RED "警告: README 或 README.md 不存在于源路径中"
+fi
+
+# 复制 tests 目录
+if [ -d "$SOURCE_DIR/tests" ]; then
+    print_message $GREEN "复制 tests 目录..."
+    cp -r "$SOURCE_DIR/tests" "$TARGET_DIR/"
+else
+    print_message $RED "警告: tests 目录不存在于源路径中"
+fi
+
+echo
+print_message $GREEN "复制完成!"
+print_message $YELLOW "复制的文件和目录位于: $TARGET_DIR"
+
+# 显示目标目录内容
+echo
+print_message $YELLOW "目标目录内容:"
+ls -la "$TARGET_DIR"