@cetusprotocol/aggregator-sdk 1.1.2 → 1.1.4

package/.claude/settings.local.json

@@ -0,0 +1,41 @@
+{
+  "permissions": {
+    "allow": [
+      "mcp__ide__executeCode",
+      "Bash(node:*)",
+      "Bash(rm:*)",
+      "Bash(npm install:*)",
+      "Bash(npm run:*)",
+      "Bash(grep:*)",
+      "Bash(git add:*)",
+      "Bash(bun test:*)",
+      "Bash(bun run:*)",
+      "Bash(find:*)",
+      "Bash(mkdir:*)",
+      "Bash(mv:*)",
+      "Bash(git commit:*)",
+      "Bash(ls:*)",
+      "Bash(NODE_ENV=development bun test tests/aggregatorv3/router/sort.test.ts --verbose)",
+      "Bash(npx tsc:*)",
+      "mcp__ide__getDiagnostics",
+      "Bash(for:*)",
+      "Bash(do)",
+      "Bash(if grep -q \"import.*ENV\" \"$file\")",
+      "Bash(then)",
+      "Bash(sed:*)",
+      "Bash(echo \"Updated: $file\")",
+      "Bash(fi)",
+      "Bash(done)",
+      "Bash(if grep -q \"import.*Env\" \"$file\")",
+      "Bash(git reset:*)",
+      "Bash(cp:*)",
+      "WebFetch(domain:docs.blockvision.org)",
+      "Bash(git restore:*)",
+      "Bash(bun tsc:*)",
+      "Bash(git checkout:*)",
+      "Bash(do echo \"=== $file ===\")",
+      "Bash(true)"
+    ],
+    "deny": []
+  }
+}

package/dist/index.d.mts

@@ -107,7 +107,7 @@ type RouterDataV3 = {
     byAmountIn: boolean;
     paths: Path[];
     insufficientLiquidity: boolean;
-    deviationRatio?: number;
+    deviationRatio: number;
     packages?: Map<string, string>;
     totalDeepFee?: number;
     error?: RouterError;
@@ -309,6 +309,7 @@ declare class AggregatorClient {
     constructor(params: AggregatorClientParams);
     newPythClients(pythUrls: string[]): SuiPriceServiceConnection[];
     deepbookv3DeepFeeType(): string;
+    getDeepbookV3Config(): Promise<DeepbookV3ConfigResponse | null>;
     getOneCoinUsedToMerge(coinType: string): Promise<string | null>;
     findRouters(params: FindRouterParams): Promise<RouterDataV3 | null>;
     executeFlexibleInputSwap(txb: Transaction, inputCoin: TransactionObjectArgument, routerData: RouterDataV3, expectedAmountOut: string, amountLimit: string, pythPriceIDs: Map<string, string>, partner?: string, deepbookv3DeepFee?: TransactionObjectArgument, packages?: Map<string, string>): Promise<void>;
@@ -678,8 +679,9 @@ declare const DEEPBOOK_V3_DEEP_FEE_TYPES: {
 declare const CLIENT_CONFIG: {
     readonly DEFAULT_PYTH_URL: "https://hermes.pyth.network";
     readonly PYTH_TIMEOUT: 3000;
-    readonly MAX_OVERLAY_FEE_RATE: 0.1;
+    readonly MAX_OVERLAY_FEE_RATE_PARAMS: 0.1;
     readonly FEE_RATE_MULTIPLIER: 1000000;
+    readonly MAX_FEE_RATE: 100000;
     readonly DEFAULT_OVERLAY_FEE_RECEIVER: "0x0";
     readonly ERRORS: {
         readonly SIGNER_REQUIRED: "Signer is required, but not provided.";
@@ -692,6 +694,7 @@ declare const CLIENT_CONFIG: {
         readonly QUOTE_ID_REQUIRED: "Quote ID is required";
         readonly AGGREGATOR_V3_PACKAGE_REQUIRED: "Aggregator V3 package is required";
         readonly PACKAGES_REQUIRED: "Packages are required";
+        readonly OVERLAY_FEE_RECEIVER_REQUIRED: "Overlay fee rate is set, but overlay fee receiver is not set";
     };
 };
 declare const AGGREGATOR_V3_CONFIG: {
@@ -791,7 +794,7 @@ declare const GAS_TYPE_ARG = "0x2::sui::SUI";
 declare const GAS_TYPE_ARG_LONG = "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI";
 declare const GAS_SYMBOL = "SUI";
 declare const DEFAULT_NFT_TRANSFER_GAS_FEE = 450;
-declare const SUI_SYSTEM_STATE_OBJECT_ID = "0x0000000000000000000000000000000000000005";
+declare const SUI_SYSTEM_STATE_OBJECT_ID = "0x0000000000000000000000000000000000000000000000000000000000000005";
 /**
  * This class provides helper methods for working with coins.
  */

package/dist/index.d.ts

@@ -107,7 +107,7 @@ type RouterDataV3 = {
     byAmountIn: boolean;
     paths: Path[];
     insufficientLiquidity: boolean;
-    deviationRatio?: number;
+    deviationRatio: number;
     packages?: Map<string, string>;
     totalDeepFee?: number;
     error?: RouterError;
@@ -309,6 +309,7 @@ declare class AggregatorClient {
     constructor(params: AggregatorClientParams);
     newPythClients(pythUrls: string[]): SuiPriceServiceConnection[];
     deepbookv3DeepFeeType(): string;
+    getDeepbookV3Config(): Promise<DeepbookV3ConfigResponse | null>;
     getOneCoinUsedToMerge(coinType: string): Promise<string | null>;
     findRouters(params: FindRouterParams): Promise<RouterDataV3 | null>;
     executeFlexibleInputSwap(txb: Transaction, inputCoin: TransactionObjectArgument, routerData: RouterDataV3, expectedAmountOut: string, amountLimit: string, pythPriceIDs: Map<string, string>, partner?: string, deepbookv3DeepFee?: TransactionObjectArgument, packages?: Map<string, string>): Promise<void>;
@@ -678,8 +679,9 @@ declare const DEEPBOOK_V3_DEEP_FEE_TYPES: {
 declare const CLIENT_CONFIG: {
     readonly DEFAULT_PYTH_URL: "https://hermes.pyth.network";
     readonly PYTH_TIMEOUT: 3000;
-    readonly MAX_OVERLAY_FEE_RATE: 0.1;
+    readonly MAX_OVERLAY_FEE_RATE_PARAMS: 0.1;
     readonly FEE_RATE_MULTIPLIER: 1000000;
+    readonly MAX_FEE_RATE: 100000;
     readonly DEFAULT_OVERLAY_FEE_RECEIVER: "0x0";
     readonly ERRORS: {
         readonly SIGNER_REQUIRED: "Signer is required, but not provided.";
@@ -692,6 +694,7 @@ declare const CLIENT_CONFIG: {
         readonly QUOTE_ID_REQUIRED: "Quote ID is required";
         readonly AGGREGATOR_V3_PACKAGE_REQUIRED: "Aggregator V3 package is required";
         readonly PACKAGES_REQUIRED: "Packages are required";
+        readonly OVERLAY_FEE_RECEIVER_REQUIRED: "Overlay fee rate is set, but overlay fee receiver is not set";
     };
 };
 declare const AGGREGATOR_V3_CONFIG: {
@@ -791,7 +794,7 @@ declare const GAS_TYPE_ARG = "0x2::sui::SUI";
 declare const GAS_TYPE_ARG_LONG = "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI";
 declare const GAS_SYMBOL = "SUI";
 declare const DEFAULT_NFT_TRANSFER_GAS_FEE = 450;
-declare const SUI_SYSTEM_STATE_OBJECT_ID = "0x0000000000000000000000000000000000000005";
+declare const SUI_SYSTEM_STATE_OBJECT_ID = "0x0000000000000000000000000000000000000000000000000000000000000005";
 /**
  * This class provides helper methods for working with coins.
  */

package/dist/index.js

@@ -2999,7 +2999,7 @@ var GAS_TYPE_ARG = "0x2::sui::SUI";
 var GAS_TYPE_ARG_LONG = "0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI";
 var GAS_SYMBOL = "SUI";
 var DEFAULT_NFT_TRANSFER_GAS_FEE = 450;
-var SUI_SYSTEM_STATE_OBJECT_ID = "0x0000000000000000000000000000000000000005";
+var SUI_SYSTEM_STATE_OBJECT_ID = "0x0000000000000000000000000000000000000000000000000000000000000005";
 var CoinUtils = class _CoinUtils {
   /**
    * Get the coin type argument from a SuiMoveObject.
@@ -3107,10 +3107,18 @@ var CoinUtils = class _CoinUtils {
    * @returns The CoinAsset objects that have a balance greater than or equal to the given amount.
    */
   static selectCoinObjectIdGreaterThanOrEqual(coins, amount, exclude = []) {
-    const selectedResult = _CoinUtils.selectCoinAssetGreaterThanOrEqual(coins, amount, exclude);
-    const objectArray = selectedResult.selectedCoins.map((item) => item.coinObjectId);
+    const selectedResult = _CoinUtils.selectCoinAssetGreaterThanOrEqual(
+      coins,
+      amount,
+      exclude
+    );
+    const objectArray = selectedResult.selectedCoins.map(
+      (item) => item.coinObjectId
+    );
     const remainCoins = selectedResult.remainingCoins;
-    const amountArray = selectedResult.selectedCoins.map((item) => item.balance.toString());
+    const amountArray = selectedResult.selectedCoins.map(
+      (item) => item.balance.toString()
+    );
     return { objectArray, remainCoins, amountArray };
   }
   /**
@@ -3122,7 +3130,9 @@ var CoinUtils = class _CoinUtils {
    * @returns The CoinAsset objects that have a balance greater than or equal to the given amount.
    */
   static selectCoinAssetGreaterThanOrEqual(coins, amount, exclude = []) {
-    const sortedCoins = _CoinUtils.sortByBalance(coins.filter((c) => !exclude.includes(c.coinObjectId)));
+    const sortedCoins = _CoinUtils.sortByBalance(
+      coins.filter((c) => !exclude.includes(c.coinObjectId))
+    );
     const total = _CoinUtils.calculateTotalBalance(sortedCoins);
     if (total < amount) {
       return { selectedCoins: [], remainingCoins: sortedCoins };
@@ -3135,9 +3145,13 @@ var CoinUtils = class _CoinUtils {
     const remainingCoins = [...sortedCoins];
     while (sum2 < total) {
       const target = amount - sum2;
-      const coinWithSmallestSufficientBalanceIndex = remainingCoins.findIndex((c) => c.balance >= target);
+      const coinWithSmallestSufficientBalanceIndex = remainingCoins.findIndex(
+        (c) => c.balance >= target
+      );
       if (coinWithSmallestSufficientBalanceIndex !== -1) {
-        selectedCoins.push(remainingCoins[coinWithSmallestSufficientBalanceIndex]);
+        selectedCoins.push(
+          remainingCoins[coinWithSmallestSufficientBalanceIndex]
+        );
         remainingCoins.splice(coinWithSmallestSufficientBalanceIndex, 1);
         break;
       }
@@ -3147,7 +3161,10 @@ var CoinUtils = class _CoinUtils {
         sum2 += coinWithLargestBalance.balance;
       }
     }
-    return { selectedCoins: _CoinUtils.sortByBalance(selectedCoins), remainingCoins: _CoinUtils.sortByBalance(remainingCoins) };
+    return {
+      selectedCoins: _CoinUtils.sortByBalance(selectedCoins),
+      remainingCoins: _CoinUtils.sortByBalance(remainingCoins)
+    };
   }
   /**
    * Sort the CoinAsset objects by their balance.
@@ -3156,10 +3173,14 @@ var CoinUtils = class _CoinUtils {
    * @returns The sorted CoinAsset objects.
    */
   static sortByBalance(coins) {
-    return coins.sort((a, b) => a.balance < b.balance ? -1 : a.balance > b.balance ? 1 : 0);
+    return coins.sort(
+      (a, b) => a.balance < b.balance ? -1 : a.balance > b.balance ? 1 : 0
+    );
   }
   static sortByBalanceDes(coins) {
-    return coins.sort((a, b) => a.balance > b.balance ? -1 : a.balance < b.balance ? 0 : 1);
+    return coins.sort(
+      (a, b) => a.balance > b.balance ? -1 : a.balance < b.balance ? 0 : 1
+    );
   }
   /**
    * Calculate the total balance of a list of CoinAsset objects.
@@ -3397,8 +3418,9 @@ var DEEPBOOK_V3_DEEP_FEE_TYPES = {
 var CLIENT_CONFIG = {
   DEFAULT_PYTH_URL: "https://hermes.pyth.network",
   PYTH_TIMEOUT: 3e3,
-  MAX_OVERLAY_FEE_RATE: 0.1,
+  MAX_OVERLAY_FEE_RATE_PARAMS: 0.1,
   FEE_RATE_MULTIPLIER: 1e6,
+  MAX_FEE_RATE: 1e5,
   DEFAULT_OVERLAY_FEE_RECEIVER: "0x0",
   // Error Messages
   ERRORS: {
@@ -3411,7 +3433,8 @@ var CLIENT_CONFIG = {
     PYTH_UNAVAILABLE: "All Pyth price nodes are unavailable. Cannot fetch price data. Please switch to or add new available Pyth nodes",
     QUOTE_ID_REQUIRED: "Quote ID is required",
     AGGREGATOR_V3_PACKAGE_REQUIRED: "Aggregator V3 package is required",
-    PACKAGES_REQUIRED: "Packages are required"
+    PACKAGES_REQUIRED: "Packages are required",
+    OVERLAY_FEE_RECEIVER_REQUIRED: "Overlay fee rate is set, but overlay fee receiver is not set"
   }
 };
 var AGGREGATOR_V3_CONFIG = {
@@ -3426,7 +3449,7 @@ var AGGREGATOR_V3_CONFIG = {
 };
 
 // src/api.ts
-var SDK_VERSION = 1010102;
+var SDK_VERSION = 1010104;
 function parseRouterResponse(data, byAmountIn) {
   let packages = /* @__PURE__ */ new Map();
   if (data.packages) {
@@ -3444,6 +3467,7 @@ function parseRouterResponse(data, byAmountIn) {
     amountOut: new import_bn2.default(data.amount_out.toString()),
     byAmountIn,
     insufficientLiquidity: false,
+    deviationRatio: data.deviation_ratio,
     packages,
     paths: data.paths.map((path) => ({
       id: path.id,
@@ -6695,7 +6719,7 @@ var SpringsuiRouter = class {
     const args = [
       swapContext,
       txb.object(swapData.poolId),
-      txb.object("0x5"),
+      txb.object(SUI_SYSTEM_STATE_OBJECT_ID),
       txb.pure.u64(swapData.amountIn),
       txb.pure.bool(swapData.direction)
     ];
@@ -7377,8 +7401,7 @@ var VoloRouter = class {
       swapContext,
       txb.object(this.stakePool),
       txb.object(this.metadata),
-      txb.object("0x5"),
-      // SuiSystemState
+      txb.object(SUI_SYSTEM_STATE_OBJECT_ID),
       txb.pure.bool(swapData.direction),
       txb.pure.u64(swapData.amountIn)
     ];
@@ -7429,8 +7452,7 @@ var AfsuiRouter = class {
       swapContext,
       txb.object(this.stakedSuiVault),
       txb.object(this.safe),
-      txb.object("0x5"),
-      // SuiSystemState
+      txb.object(SUI_SYSTEM_STATE_OBJECT_ID),
       txb.object(this.referVault),
       txb.object(this.validator),
       txb.pure.bool(swapData.direction),
@@ -7475,8 +7497,7 @@ var HaedalRouter = class {
     const args = [
       swapContext,
       txb.object(swapData.poolId),
-      txb.object("0x5"),
-      // SuiSystemState
+      txb.object(SUI_SYSTEM_STATE_OBJECT_ID),
       txb.pure.bool(swapData.direction),
       txb.pure.u64(swapData.amountIn)
     ];
@@ -8235,7 +8256,7 @@ var _AggregatorClient = class _AggregatorClient {
     this.apiKey = params.apiKey || "";
     this.partner = params.partner;
     if (params.overlayFeeRate) {
-      if (params.overlayFeeRate > 0 && params.overlayFeeRate <= CLIENT_CONFIG.MAX_OVERLAY_FEE_RATE) {
+      if (params.overlayFeeRate > 0 && params.overlayFeeRate <= CLIENT_CONFIG.MAX_OVERLAY_FEE_RATE_PARAMS) {
         this.overlayFeeRate = params.overlayFeeRate * AGGREGATOR_V3_CONFIG.FEE_DENOMINATOR;
         if (this.overlayFeeRate > AGGREGATOR_V3_CONFIG.MAX_FEE_RATE) {
           throw new Error(
@@ -8266,6 +8287,11 @@ var _AggregatorClient = class _AggregatorClient {
       return DEEPBOOK_V3_DEEP_FEE_TYPES.Testnet;
     }
   }
+  getDeepbookV3Config() {
+    return __async(this, null, function* () {
+      return yield getDeepbookV3Config(this.endpoint);
+    });
+  }
   getOneCoinUsedToMerge(coinType) {
     return __async(this, null, function* () {
       try {
@@ -8516,20 +8542,22 @@ var _AggregatorClient = class _AggregatorClient {
   }
   routerSwap(params) {
     return __async(this, null, function* () {
-      const { router, inputCoin, slippage, txb, fixable, partner } = params;
+      const { router, inputCoin, slippage, txb, partner } = params;
       if (slippage > 1 || slippage < 0) {
         throw new Error(CLIENT_CONFIG.ERRORS.INVALID_SLIPPAGE);
       }
+      if (!params.router.packages || !params.router.packages.get(PACKAGE_NAMES.AGGREGATOR_V3)) {
+        throw new Error(CLIENT_CONFIG.ERRORS.PACKAGES_REQUIRED);
+      }
       const byAmountIn = params.router.byAmountIn;
       const amountIn = router.amountIn;
       const amountOut = router.amountOut;
+      checkOverlayFeeConfig(this.overlayFeeRate, this.overlayFeeReceiver);
       let overlayFee = new import_bn6.default(0);
-      if (this.overlayFeeRate > 0 && this.overlayFeeReceiver !== "0x0") {
-        if (byAmountIn) {
-          overlayFee = amountOut.mul(new import_bn6.default(this.overlayFeeRate)).div(new import_bn6.default(1e6));
-        } else {
-          overlayFee = amountIn.mul(new import_bn6.default(this.overlayFeeRate)).div(new import_bn6.default(1e6));
-        }
+      if (byAmountIn) {
+        overlayFee = amountOut.mul(new import_bn6.default(this.overlayFeeRate)).div(new import_bn6.default(1e6));
+      } else {
+        overlayFee = amountIn.mul(new import_bn6.default(this.overlayFeeRate)).div(new import_bn6.default(1e6));
       }
       const expectedAmountOut = byAmountIn ? amountOut.sub(overlayFee) : amountOut;
       const expectedAmountIn = byAmountIn ? amountIn : amountIn.add(overlayFee);
@@ -8538,9 +8566,6 @@ var _AggregatorClient = class _AggregatorClient {
         byAmountIn,
         slippage
       );
-      if (!params.router.packages || !params.router.packages.get(PACKAGE_NAMES.AGGREGATOR_V3)) {
-        throw new Error(CLIENT_CONFIG.ERRORS.PACKAGES_REQUIRED);
-      }
       const priceIDs = findPythPriceIDs(router.paths);
       const priceInfoObjectIds = priceIDs.length > 0 ? yield this.updatePythPriceIDs(priceIDs, txb) : /* @__PURE__ */ new Map();
       if (byAmountIn) {
@@ -8573,17 +8598,16 @@ var _AggregatorClient = class _AggregatorClient {
       const fromCoinType = router.paths[0].from;
       const targetCoinType = router.paths[router.paths.length - 1].target;
       const byAmountIn = router.byAmountIn;
+      checkOverlayFeeConfig(this.overlayFeeRate, this.overlayFeeReceiver);
       let overlayFee = 0;
-      if (this.overlayFeeRate > 0 && this.overlayFeeReceiver !== "0x0") {
-        if (byAmountIn) {
-          overlayFee = Number(
-            router.amountOut.mul(new import_bn6.default(this.overlayFeeRate)).div(new import_bn6.default(1e6)).toString()
-          );
-        } else {
-          overlayFee = Number(
-            router.amountIn.mul(new import_bn6.default(this.overlayFeeRate)).div(new import_bn6.default(1e6)).toString()
-          );
-        }
+      if (byAmountIn) {
+        overlayFee = Number(
+          router.amountOut.mul(new import_bn6.default(this.overlayFeeRate)).div(new import_bn6.default(1e6)).toString()
+        );
+      } else {
+        overlayFee = Number(
+          router.amountIn.mul(new import_bn6.default(this.overlayFeeRate)).div(new import_bn6.default(1e6)).toString()
+        );
       }
       const expectedAmountOut = byAmountIn ? router.amountOut.sub(new import_bn6.default(overlayFee)) : router.amountOut;
       const expectedAmountIn = byAmountIn ? router.amountIn : router.amountIn.add(new import_bn6.default(overlayFee));
@@ -8635,18 +8659,17 @@ var _AggregatorClient = class _AggregatorClient {
   }
   fixableRouterSwapV3(params) {
     return __async(this, null, function* () {
-      const { router, inputCoin, slippage, txb, deepbookv3DeepFee, partner } = params;
+      const { router, inputCoin, slippage, txb, partner } = params;
+      checkOverlayFeeConfig(this.overlayFeeRate, this.overlayFeeReceiver);
       let overlayFee = 0;
-      if (this.overlayFeeRate > 0 && this.overlayFeeReceiver !== "0x0") {
-        if (router.byAmountIn) {
-          overlayFee = Number(
-            router.amountOut.mul(new import_bn6.default(this.overlayFeeRate)).div(new import_bn6.default(1e6)).toString()
-          );
-        } else {
-          overlayFee = Number(
-            router.amountIn.mul(new import_bn6.default(this.overlayFeeRate)).div(new import_bn6.default(1e6)).toString()
-          );
-        }
+      if (router.byAmountIn) {
+        overlayFee = Number(
+          router.amountOut.mul(new import_bn6.default(this.overlayFeeRate)).div(new import_bn6.default(1e6)).toString()
+        );
+      } else {
+        overlayFee = Number(
+          router.amountIn.mul(new import_bn6.default(this.overlayFeeRate)).div(new import_bn6.default(1e6)).toString()
+        );
       }
       const expectedAmountOut = router.byAmountIn ? router.amountOut.sub(new import_bn6.default(overlayFee)) : router.amountOut;
       const expectedAmountIn = router.byAmountIn ? router.amountIn : router.amountIn.add(new import_bn6.default(overlayFee));
@@ -8755,6 +8778,7 @@ var _AggregatorClient = class _AggregatorClient {
       const routeData = {
         amountIn,
         amountOut: new import_bn6.default((_d = event.amount_out) != null ? _d : 0),
+        deviationRatio: 0,
         paths: [
           {
             id: pools[tempIndex],
@@ -8872,6 +8896,16 @@ function recordFirstCoinIndex(paths) {
   }
   return newCoinRecord;
 }
+function checkOverlayFeeConfig(overlayFeeRate, overlayFeeReceiver) {
+  if (overlayFeeRate > CLIENT_CONFIG.MAX_FEE_RATE) {
+    throw new Error(CLIENT_CONFIG.ERRORS.INVALID_OVERLAY_FEE_RATE);
+  }
+  if (overlayFeeReceiver === "0x0" && overlayFeeRate > 0) {
+    throw new Error(
+      CLIENT_CONFIG.ERRORS.OVERLAY_FEE_RECEIVER_REQUIRED
+    );
+  }
+}
 
 // src/types/sui.ts
 var getDefaultSuiInputType = (value) => {