@mysten/deepbook-v3 0.24.0 → 0.26.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @mysten/deepbook-v3
 
+## 0.26.0
+
+### Minor Changes
+
+- ef523b8: Take Profit Stop Loss support
+
+### Patch Changes
+
+- 396fb3f: Bump margin package for testing
+
+## 0.25.0
+
+### Minor Changes
+
+- 74b9509: Liquidation Logic
+
 ## 0.24.0
 
 ### Minor Changes

package/dist/cjs/client.d.ts

@@ -12,7 +12,9 @@ import { MarginMaintainerContract } from './transactions/marginMaintainer.js';
 import { MarginPoolContract } from './transactions/marginPool.js';
 import { MarginManagerContract } from './transactions/marginManager.js';
 import { MarginRegistryContract } from './transactions/marginRegistry.js';
+import { MarginLiquidationsContract } from './transactions/marginLiquidations.js';
 import { PoolProxyContract } from './transactions/poolProxy.js';
+import { MarginTPSLContract } from './transactions/marginTPSL.js';
 /**
  * DeepBookClient class for managing DeepBook operations.
  */
@@ -29,7 +31,9 @@ export declare class DeepBookClient {
     marginPool: MarginPoolContract;
     marginManager: MarginManagerContract;
     marginRegistry: MarginRegistryContract;
+    marginLiquidations: MarginLiquidationsContract;
     poolProxy: PoolProxyContract;
+    marginTPSL: MarginTPSLContract;
     /**
      * @param {SuiClient} client SuiClient instance
      * @param {string} address Address of the client
@@ -601,6 +605,26 @@ export declare class DeepBookClient {
      * @returns {Promise<string>} The DEEP token balance
      */
     getMarginManagerDeepBalance(marginManagerKey: string, decimals?: number): Promise<string>;
+    /**
+     * @description Get all conditional order IDs for a margin manager
+     * @param {string} marginManagerKey The key to identify the margin manager
+     * @returns {Promise<string[]>} Array of conditional order IDs
+     */
+    getConditionalOrderIds(marginManagerKey: string): Promise<string[]>;
+    /**
+     * @description Get the lowest trigger price for trigger_above orders
+     * Returns MAX_U64 if there are no trigger_above orders
+     * @param {string} marginManagerKey The key to identify the margin manager
+     * @returns {Promise<bigint>} The lowest trigger above price
+     */
+    getLowestTriggerAbovePrice(marginManagerKey: string): Promise<bigint>;
+    /**
+     * @description Get the highest trigger price for trigger_below orders
+     * Returns 0 if there are no trigger_below orders
+     * @param {string} marginManagerKey The key to identify the margin manager
+     * @returns {Promise<bigint>} The highest trigger below price
+     */
+    getHighestTriggerBelowPrice(marginManagerKey: string): Promise<bigint>;
     /**
      * @description Check if a deepbook pool is enabled for margin trading
      * @param {string} poolKey The key to identify the pool

package/dist/cjs/client.js

@@ -44,9 +44,11 @@ var import_marginMaintainer = require("./transactions/marginMaintainer.js");
 var import_marginPool = require("./transactions/marginPool.js");
 var import_marginManager = require("./transactions/marginManager.js");
 var import_marginRegistry = require("./transactions/marginRegistry.js");
+var import_marginLiquidations = require("./transactions/marginLiquidations.js");
 var import_pyth = require("./pyth/pyth.js");
 var import_pyth2 = require("./pyth/pyth.js");
 var import_poolProxy = require("./transactions/poolProxy.js");
+var import_marginTPSL = require("./transactions/marginTPSL.js");
 var _config, _address, _DeepBookClient_instances, formatTokenAmount_fn;
 class DeepBookClient {
   /**
@@ -99,7 +101,9 @@ class DeepBookClient {
     this.marginPool = new import_marginPool.MarginPoolContract(__privateGet(this, _config));
     this.marginManager = new import_marginManager.MarginManagerContract(__privateGet(this, _config));
     this.marginRegistry = new import_marginRegistry.MarginRegistryContract(__privateGet(this, _config));
+    this.marginLiquidations = new import_marginLiquidations.MarginLiquidationsContract(__privateGet(this, _config));
     this.poolProxy = new import_poolProxy.PoolProxyContract(__privateGet(this, _config));
+    this.marginTPSL = new import_marginTPSL.MarginTPSLContract(__privateGet(this, _config));
   }
   /**
    * @description Check the balance of a balance manager for a specific coin
@@ -1350,6 +1354,73 @@ class DeepBookClient {
     const deepCoin = __privateGet(this, _config).getCoin("DEEP");
     return __privateMethod(this, _DeepBookClient_instances, formatTokenAmount_fn).call(this, BigInt(import_bcs.bcs.U64.parse(new Uint8Array(bytes))), deepCoin.scalar, decimals);
   }
+  // === Margin TPSL (Take Profit / Stop Loss) Read-Only Functions ===
+  /**
+   * @description Get all conditional order IDs for a margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @returns {Promise<string[]>} Array of conditional order IDs
+   */
+  async getConditionalOrderIds(marginManagerKey) {
+    const manager = __privateGet(this, _config).getMarginManager(marginManagerKey);
+    const tx = new import_transactions.Transaction();
+    tx.add(this.marginTPSL.conditionalOrderIds(manager.poolKey, manager.address));
+    const res = await this.client.devInspectTransactionBlock({
+      sender: (0, import_utils.normalizeSuiAddress)(__privateGet(this, _address)),
+      transactionBlock: tx
+    });
+    if (!res.results || !res.results[0] || !res.results[0].returnValues) {
+      throw new Error(
+        `Failed to get conditional order IDs: ${res.effects?.status?.error || "Unknown error"}`
+      );
+    }
+    const bytes = res.results[0].returnValues[0][0];
+    const orderIds = import_bcs.bcs.vector(import_bcs.bcs.u64()).parse(new Uint8Array(bytes));
+    return orderIds.map((id) => id.toString());
+  }
+  /**
+   * @description Get the lowest trigger price for trigger_above orders
+   * Returns MAX_U64 if there are no trigger_above orders
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @returns {Promise<bigint>} The lowest trigger above price
+   */
+  async getLowestTriggerAbovePrice(marginManagerKey) {
+    const manager = __privateGet(this, _config).getMarginManager(marginManagerKey);
+    const tx = new import_transactions.Transaction();
+    tx.add(this.marginTPSL.lowestTriggerAbovePrice(manager.poolKey, manager.address));
+    const res = await this.client.devInspectTransactionBlock({
+      sender: (0, import_utils.normalizeSuiAddress)(__privateGet(this, _address)),
+      transactionBlock: tx
+    });
+    if (!res.results || !res.results[0] || !res.results[0].returnValues) {
+      throw new Error(
+        `Failed to get lowest trigger above price: ${res.effects?.status?.error || "Unknown error"}`
+      );
+    }
+    const bytes = res.results[0].returnValues[0][0];
+    return BigInt(import_bcs.bcs.U64.parse(new Uint8Array(bytes)));
+  }
+  /**
+   * @description Get the highest trigger price for trigger_below orders
+   * Returns 0 if there are no trigger_below orders
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @returns {Promise<bigint>} The highest trigger below price
+   */
+  async getHighestTriggerBelowPrice(marginManagerKey) {
+    const manager = __privateGet(this, _config).getMarginManager(marginManagerKey);
+    const tx = new import_transactions.Transaction();
+    tx.add(this.marginTPSL.highestTriggerBelowPrice(manager.poolKey, manager.address));
+    const res = await this.client.devInspectTransactionBlock({
+      sender: (0, import_utils.normalizeSuiAddress)(__privateGet(this, _address)),
+      transactionBlock: tx
+    });
+    if (!res.results || !res.results[0] || !res.results[0].returnValues) {
+      throw new Error(
+        `Failed to get highest trigger below price: ${res.effects?.status?.error || "Unknown error"}`
+      );
+    }
+    const bytes = res.results[0].returnValues[0][0];
+    return BigInt(import_bcs.bcs.U64.parse(new Uint8Array(bytes)));
+  }
   // === Margin Registry Functions ===
   /**
    * @description Check if a deepbook pool is enabled for margin trading