@mysten/deepbook-v3 0.20.2 → 0.20.4

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @mysten/deepbook-v3
 
+## 0.20.4
+
+### Patch Changes
+
+- bf5773f: Improve read only functions and add manager state function
+- d8355d7: Admin withdraw referral fees
+
+## 0.20.3
+
+### Patch Changes
+
+- a2f84a3: Update margin withdraw referral function
+- e0490df: Fix deepbook admin function
+- Updated dependencies [88bdbac]
+  - @mysten/sui@1.45.0
+
 ## 0.20.2
 
 ### Patch Changes

package/dist/cjs/client.d.ts

@@ -455,71 +455,62 @@ export declare class DeepBookClient {
     getUserSupplyAmount(coinKey: string, supplierCapId: string, decimals?: number): Promise<string>;
     /**
      * @description Get the owner address of a margin manager
-     * @param {string} poolKey The key to identify the pool
-     * @param {string} marginManagerId The ID of the margin manager
+     * @param {string} marginManagerKey The key to identify the margin manager
      * @returns {Promise<string>} The owner address
      */
-    getMarginManagerOwner(poolKey: string, marginManagerId: string): Promise<string>;
+    getMarginManagerOwner(marginManagerKey: string): Promise<string>;
     /**
      * @description Get the DeepBook pool ID associated with a margin manager
-     * @param {string} poolKey The key to identify the pool
-     * @param {string} marginManagerId The ID of the margin manager
+     * @param {string} marginManagerKey The key to identify the margin manager
      * @returns {Promise<string>} The DeepBook pool ID
      */
-    getMarginManagerDeepbookPool(poolKey: string, marginManagerId: string): Promise<string>;
+    getMarginManagerDeepbookPool(marginManagerKey: string): Promise<string>;
     /**
      * @description Get the margin pool ID (if any) associated with a margin manager
-     * @param {string} poolKey The key to identify the pool
-     * @param {string} marginManagerId The ID of the margin manager
+     * @param {string} marginManagerKey The key to identify the margin manager
      * @returns {Promise<string | null>} The margin pool ID or null if no active loan
      */
-    getMarginManagerMarginPoolId(poolKey: string, marginManagerId: string): Promise<string | null>;
+    getMarginManagerMarginPoolId(marginManagerKey: string): Promise<string | null>;
     /**
      * @description Get borrowed shares for both base and quote assets
-     * @param {string} poolKey The key to identify the pool
-     * @param {string} marginManagerId The ID of the margin manager
+     * @param {string} marginManagerKey The key to identify the margin manager
      * @returns {Promise<{baseShares: string, quoteShares: string}>} The borrowed shares
      */
-    getMarginManagerBorrowedShares(poolKey: string, marginManagerId: string): Promise<{
+    getMarginManagerBorrowedShares(marginManagerKey: string): Promise<{
         baseShares: string;
         quoteShares: string;
     }>;
     /**
      * @description Get borrowed base shares
-     * @param {string} poolKey The key to identify the pool
-     * @param {string} marginManagerId The ID of the margin manager
+     * @param {string} marginManagerKey The key to identify the margin manager
      * @returns {Promise<string>} The borrowed base shares
      */
-    getMarginManagerBorrowedBaseShares(poolKey: string, marginManagerId: string): Promise<string>;
+    getMarginManagerBorrowedBaseShares(marginManagerKey: string): Promise<string>;
     /**
      * @description Get borrowed quote shares
-     * @param {string} poolKey The key to identify the pool
-     * @param {string} marginManagerId The ID of the margin manager
+     * @param {string} marginManagerKey The key to identify the margin manager
      * @returns {Promise<string>} The borrowed quote shares
      */
-    getMarginManagerBorrowedQuoteShares(poolKey: string, marginManagerId: string): Promise<string>;
+    getMarginManagerBorrowedQuoteShares(marginManagerKey: string): Promise<string>;
     /**
      * @description Check if margin manager has base asset debt
-     * @param {string} poolKey The key to identify the pool
-     * @param {string} marginManagerId The ID of the margin manager
+     * @param {string} marginManagerKey The key to identify the margin manager
      * @returns {Promise<boolean>} True if has base debt, false otherwise
      */
-    getMarginManagerHasBaseDebt(poolKey: string, marginManagerId: string): Promise<boolean>;
+    getMarginManagerHasBaseDebt(marginManagerKey: string): Promise<boolean>;
     /**
      * @description Get the balance manager ID for a margin manager
-     * @param {string} poolKey The key to identify the pool
-     * @param {string} marginManagerId The ID of the margin manager
+     * @param {string} marginManagerKey The key to identify the margin manager
      * @returns {Promise<string>} The balance manager ID
      */
-    getMarginManagerBalanceManagerId(poolKey: string, marginManagerId: string): Promise<string>;
+    getMarginManagerBalanceManagerId(marginManagerKey: string): Promise<string>;
     /**
      * @description Calculate assets (base and quote) for a margin manager
-     * @param {string} poolKey The key to identify the pool
-     * @param {string} marginManagerId The ID of the margin manager
+     * @param {string} marginManagerKey The key to identify the margin manager
      * @param {number} decimals Number of decimal places to show (default: 6)
      * @returns {Promise<{baseAsset: string, quoteAsset: string}>} The base and quote assets
      */
-    getMarginManagerAssets(poolKey: string, marginManagerId: string, decimals?: number): Promise<{
+    getMarginManagerAssets(marginManagerKey: string, decimals?: number): Promise<{
         baseAsset: string;
         quoteAsset: string;
     }>;
@@ -527,14 +518,44 @@ export declare class DeepBookClient {
      * @description Calculate debts (base and quote) for a margin manager
      * NOTE: This function automatically determines whether to use base or quote margin pool
      * based on hasBaseDebt. You don't need to specify the debt coin type.
-     * @param {string} poolKey The key to identify the pool
-     * @param {string} marginManagerId The ID of the margin manager
+     * @param {string} marginManagerKey The key to identify the margin manager
      * @param {number} decimals Number of decimal places to show (default: 6)
      * @returns {Promise<{baseDebt: string, quoteDebt: string}>} The base and quote debts
      */
-    getMarginManagerDebts(poolKey: string, marginManagerId: string, decimals?: number): Promise<{
+    getMarginManagerDebts(marginManagerKey: string, decimals?: number): Promise<{
+        baseDebt: string;
+        quoteDebt: string;
+    }>;
+    /**
+     * @description Get comprehensive state information for a margin manager
+     * @param {string} marginManagerKey The key to identify the margin manager
+     * @param {number} decimals Number of decimal places to show (default: 6)
+     * @returns {Promise<{
+     *   managerId: string,
+     *   deepbookPoolId: string,
+     *   riskRatio: number,
+     *   baseAsset: string,
+     *   quoteAsset: string,
+     *   baseDebt: string,
+     *   quoteDebt: string,
+     *   basePythPrice: string,
+     *   basePythDecimals: number,
+     *   quotePythPrice: string,
+     *   quotePythDecimals: number
+     * }>} Comprehensive margin manager state
+     */
+    getMarginManagerState(marginManagerKey: string, decimals?: number): Promise<{
+        managerId: string;
+        deepbookPoolId: string;
+        riskRatio: number;
+        baseAsset: string;
+        quoteAsset: string;
         baseDebt: string;
         quoteDebt: string;
+        basePythPrice: string;
+        basePythDecimals: number;
+        quotePythPrice: string;
+        quotePythDecimals: number;
     }>;
     /**
      * @description Check if a deepbook pool is enabled for margin trading

package/dist/cjs/client.js

@@ -958,13 +958,13 @@ class DeepBookClient {
   // === Margin Manager Read-Only Functions ===
   /**
    * @description Get the owner address of a margin manager
-   * @param {string} poolKey The key to identify the pool
-   * @param {string} marginManagerId The ID of the margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
    * @returns {Promise<string>} The owner address
    */
-  async getMarginManagerOwner(poolKey, marginManagerId) {
+  async getMarginManagerOwner(marginManagerKey) {
+    const manager = __privateGet(this, _config).getMarginManager(marginManagerKey);
     const tx = new import_transactions.Transaction();
-    tx.add(this.marginManager.ownerByPoolKey(poolKey, marginManagerId));
+    tx.add(this.marginManager.ownerByPoolKey(manager.poolKey, manager.address));
     const res = await this.client.devInspectTransactionBlock({
       sender: (0, import_utils.normalizeSuiAddress)(__privateGet(this, _address)),
       transactionBlock: tx
@@ -974,13 +974,13 @@ class DeepBookClient {
   }
   /**
    * @description Get the DeepBook pool ID associated with a margin manager
-   * @param {string} poolKey The key to identify the pool
-   * @param {string} marginManagerId The ID of the margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
    * @returns {Promise<string>} The DeepBook pool ID
    */
-  async getMarginManagerDeepbookPool(poolKey, marginManagerId) {
+  async getMarginManagerDeepbookPool(marginManagerKey) {
+    const manager = __privateGet(this, _config).getMarginManager(marginManagerKey);
     const tx = new import_transactions.Transaction();
-    tx.add(this.marginManager.deepbookPool(poolKey, marginManagerId));
+    tx.add(this.marginManager.deepbookPool(manager.poolKey, manager.address));
     const res = await this.client.devInspectTransactionBlock({
       sender: (0, import_utils.normalizeSuiAddress)(__privateGet(this, _address)),
       transactionBlock: tx
@@ -990,13 +990,13 @@ class DeepBookClient {
   }
   /**
    * @description Get the margin pool ID (if any) associated with a margin manager
-   * @param {string} poolKey The key to identify the pool
-   * @param {string} marginManagerId The ID of the margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
    * @returns {Promise<string | null>} The margin pool ID or null if no active loan
    */
-  async getMarginManagerMarginPoolId(poolKey, marginManagerId) {
+  async getMarginManagerMarginPoolId(marginManagerKey) {
+    const manager = __privateGet(this, _config).getMarginManager(marginManagerKey);
     const tx = new import_transactions.Transaction();
-    tx.add(this.marginManager.marginPoolId(poolKey, marginManagerId));
+    tx.add(this.marginManager.marginPoolId(manager.poolKey, manager.address));
     const res = await this.client.devInspectTransactionBlock({
       sender: (0, import_utils.normalizeSuiAddress)(__privateGet(this, _address)),
       transactionBlock: tx
@@ -1007,13 +1007,13 @@ class DeepBookClient {
   }
   /**
    * @description Get borrowed shares for both base and quote assets
-   * @param {string} poolKey The key to identify the pool
-   * @param {string} marginManagerId The ID of the margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
    * @returns {Promise<{baseShares: string, quoteShares: string}>} The borrowed shares
    */
-  async getMarginManagerBorrowedShares(poolKey, marginManagerId) {
+  async getMarginManagerBorrowedShares(marginManagerKey) {
+    const manager = __privateGet(this, _config).getMarginManager(marginManagerKey);
     const tx = new import_transactions.Transaction();
-    tx.add(this.marginManager.borrowedShares(poolKey, marginManagerId));
+    tx.add(this.marginManager.borrowedShares(manager.poolKey, manager.address));
     const res = await this.client.devInspectTransactionBlock({
       sender: (0, import_utils.normalizeSuiAddress)(__privateGet(this, _address)),
       transactionBlock: tx
@@ -1026,13 +1026,13 @@ class DeepBookClient {
   }
   /**
    * @description Get borrowed base shares
-   * @param {string} poolKey The key to identify the pool
-   * @param {string} marginManagerId The ID of the margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
    * @returns {Promise<string>} The borrowed base shares
    */
-  async getMarginManagerBorrowedBaseShares(poolKey, marginManagerId) {
+  async getMarginManagerBorrowedBaseShares(marginManagerKey) {
+    const manager = __privateGet(this, _config).getMarginManager(marginManagerKey);
     const tx = new import_transactions.Transaction();
-    tx.add(this.marginManager.borrowedBaseShares(poolKey, marginManagerId));
+    tx.add(this.marginManager.borrowedBaseShares(manager.poolKey, manager.address));
     const res = await this.client.devInspectTransactionBlock({
       sender: (0, import_utils.normalizeSuiAddress)(__privateGet(this, _address)),
       transactionBlock: tx
@@ -1042,13 +1042,13 @@ class DeepBookClient {
   }
   /**
    * @description Get borrowed quote shares
-   * @param {string} poolKey The key to identify the pool
-   * @param {string} marginManagerId The ID of the margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
    * @returns {Promise<string>} The borrowed quote shares
    */
-  async getMarginManagerBorrowedQuoteShares(poolKey, marginManagerId) {
+  async getMarginManagerBorrowedQuoteShares(marginManagerKey) {
+    const manager = __privateGet(this, _config).getMarginManager(marginManagerKey);
     const tx = new import_transactions.Transaction();
-    tx.add(this.marginManager.borrowedQuoteShares(poolKey, marginManagerId));
+    tx.add(this.marginManager.borrowedQuoteShares(manager.poolKey, manager.address));
     const res = await this.client.devInspectTransactionBlock({
       sender: (0, import_utils.normalizeSuiAddress)(__privateGet(this, _address)),
       transactionBlock: tx
@@ -1058,13 +1058,13 @@ class DeepBookClient {
   }
   /**
    * @description Check if margin manager has base asset debt
-   * @param {string} poolKey The key to identify the pool
-   * @param {string} marginManagerId The ID of the margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
    * @returns {Promise<boolean>} True if has base debt, false otherwise
    */
-  async getMarginManagerHasBaseDebt(poolKey, marginManagerId) {
+  async getMarginManagerHasBaseDebt(marginManagerKey) {
+    const manager = __privateGet(this, _config).getMarginManager(marginManagerKey);
     const tx = new import_transactions.Transaction();
-    tx.add(this.marginManager.hasBaseDebt(poolKey, marginManagerId));
+    tx.add(this.marginManager.hasBaseDebt(manager.poolKey, manager.address));
     const res = await this.client.devInspectTransactionBlock({
       sender: (0, import_utils.normalizeSuiAddress)(__privateGet(this, _address)),
       transactionBlock: tx
@@ -1074,13 +1074,13 @@ class DeepBookClient {
   }
   /**
    * @description Get the balance manager ID for a margin manager
-   * @param {string} poolKey The key to identify the pool
-   * @param {string} marginManagerId The ID of the margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
    * @returns {Promise<string>} The balance manager ID
    */
-  async getMarginManagerBalanceManagerId(poolKey, marginManagerId) {
+  async getMarginManagerBalanceManagerId(marginManagerKey) {
+    const manager = __privateGet(this, _config).getMarginManager(marginManagerKey);
     const tx = new import_transactions.Transaction();
-    tx.add(this.marginManager.balanceManager(poolKey, marginManagerId));
+    tx.add(this.marginManager.balanceManager(manager.poolKey, manager.address));
     const res = await this.client.devInspectTransactionBlock({
       sender: (0, import_utils.normalizeSuiAddress)(__privateGet(this, _address)),
       transactionBlock: tx
@@ -1090,21 +1090,21 @@ class DeepBookClient {
   }
   /**
    * @description Calculate assets (base and quote) for a margin manager
-   * @param {string} poolKey The key to identify the pool
-   * @param {string} marginManagerId The ID of the margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
    * @param {number} decimals Number of decimal places to show (default: 6)
    * @returns {Promise<{baseAsset: string, quoteAsset: string}>} The base and quote assets
    */
-  async getMarginManagerAssets(poolKey, marginManagerId, decimals = 6) {
+  async getMarginManagerAssets(marginManagerKey, decimals = 6) {
+    const manager = __privateGet(this, _config).getMarginManager(marginManagerKey);
     const tx = new import_transactions.Transaction();
-    tx.add(this.marginManager.calculateAssets(poolKey, marginManagerId));
+    tx.add(this.marginManager.calculateAssets(manager.poolKey, manager.address));
     const res = await this.client.devInspectTransactionBlock({
       sender: (0, import_utils.normalizeSuiAddress)(__privateGet(this, _address)),
       transactionBlock: tx
     });
     const baseBytes = res.results[0].returnValues[0][0];
     const quoteBytes = res.results[0].returnValues[1][0];
-    const pool = __privateGet(this, _config).getPool(poolKey);
+    const pool = __privateGet(this, _config).getPool(manager.poolKey);
     const baseCoin = __privateGet(this, _config).getCoin(pool.baseCoin);
     const quoteCoin = __privateGet(this, _config).getCoin(pool.quoteCoin);
     const baseAsset = __privateMethod(this, _DeepBookClient_instances, formatTokenAmount_fn).call(this, BigInt(import_bcs.bcs.U64.parse(new Uint8Array(baseBytes))), baseCoin.scalar, decimals);
@@ -1115,17 +1115,17 @@ class DeepBookClient {
    * @description Calculate debts (base and quote) for a margin manager
    * NOTE: This function automatically determines whether to use base or quote margin pool
    * based on hasBaseDebt. You don't need to specify the debt coin type.
-   * @param {string} poolKey The key to identify the pool
-   * @param {string} marginManagerId The ID of the margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
    * @param {number} decimals Number of decimal places to show (default: 6)
    * @returns {Promise<{baseDebt: string, quoteDebt: string}>} The base and quote debts
    */
-  async getMarginManagerDebts(poolKey, marginManagerId, decimals = 6) {
-    const hasBaseDebt = await this.getMarginManagerHasBaseDebt(poolKey, marginManagerId);
-    const pool = __privateGet(this, _config).getPool(poolKey);
+  async getMarginManagerDebts(marginManagerKey, decimals = 6) {
+    const hasBaseDebt = await this.getMarginManagerHasBaseDebt(marginManagerKey);
+    const manager = __privateGet(this, _config).getMarginManager(marginManagerKey);
+    const pool = __privateGet(this, _config).getPool(manager.poolKey);
     const debtCoinKey = hasBaseDebt ? pool.baseCoin : pool.quoteCoin;
     const tx = new import_transactions.Transaction();
-    tx.add(this.marginManager.calculateDebts(poolKey, debtCoinKey, marginManagerId));
+    tx.add(this.marginManager.calculateDebts(manager.poolKey, debtCoinKey, manager.address));
     const res = await this.client.devInspectTransactionBlock({
       sender: (0, import_utils.normalizeSuiAddress)(__privateGet(this, _address)),
       transactionBlock: tx
@@ -1142,6 +1142,73 @@ class DeepBookClient {
     const quoteDebt = __privateMethod(this, _DeepBookClient_instances, formatTokenAmount_fn).call(this, BigInt(import_bcs.bcs.U64.parse(new Uint8Array(quoteBytes))), debtCoin.scalar, decimals);
     return { baseDebt, quoteDebt };
   }
+  /**
+   * @description Get comprehensive state information for a margin manager
+   * @param {string} marginManagerKey The key to identify the margin manager
+   * @param {number} decimals Number of decimal places to show (default: 6)
+   * @returns {Promise<{
+   *   managerId: string,
+   *   deepbookPoolId: string,
+   *   riskRatio: number,
+   *   baseAsset: string,
+   *   quoteAsset: string,
+   *   baseDebt: string,
+   *   quoteDebt: string,
+   *   basePythPrice: string,
+   *   basePythDecimals: number,
+   *   quotePythPrice: string,
+   *   quotePythDecimals: number
+   * }>} Comprehensive margin manager state
+   */
+  async getMarginManagerState(marginManagerKey, decimals = 6) {
+    const manager = __privateGet(this, _config).getMarginManager(marginManagerKey);
+    const tx = new import_transactions.Transaction();
+    tx.add(this.marginManager.managerState(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 margin manager state: ${res.effects?.status?.error || "Unknown error"}`
+      );
+    }
+    const pool = __privateGet(this, _config).getPool(manager.poolKey);
+    const baseCoin = __privateGet(this, _config).getCoin(pool.baseCoin);
+    const quoteCoin = __privateGet(this, _config).getCoin(pool.quoteCoin);
+    const managerId = (0, import_utils.normalizeSuiAddress)(
+      import_bcs.bcs.Address.parse(new Uint8Array(res.results[0].returnValues[0][0]))
+    );
+    const deepbookPoolId = (0, import_utils.normalizeSuiAddress)(
+      import_bcs.bcs.Address.parse(new Uint8Array(res.results[0].returnValues[1][0]))
+    );
+    const riskRatio = Number(import_bcs.bcs.U64.parse(new Uint8Array(res.results[0].returnValues[2][0]))) / import_config.FLOAT_SCALAR;
+    const baseAsset = __privateMethod(this, _DeepBookClient_instances, formatTokenAmount_fn).call(this, BigInt(import_bcs.bcs.U64.parse(new Uint8Array(res.results[0].returnValues[3][0]))), baseCoin.scalar, decimals);
+    const quoteAsset = __privateMethod(this, _DeepBookClient_instances, formatTokenAmount_fn).call(this, BigInt(import_bcs.bcs.U64.parse(new Uint8Array(res.results[0].returnValues[4][0]))), quoteCoin.scalar, decimals);
+    const baseDebt = __privateMethod(this, _DeepBookClient_instances, formatTokenAmount_fn).call(this, BigInt(import_bcs.bcs.U64.parse(new Uint8Array(res.results[0].returnValues[5][0]))), baseCoin.scalar, decimals);
+    const quoteDebt = __privateMethod(this, _DeepBookClient_instances, formatTokenAmount_fn).call(this, BigInt(import_bcs.bcs.U64.parse(new Uint8Array(res.results[0].returnValues[6][0]))), quoteCoin.scalar, decimals);
+    const basePythPrice = import_bcs.bcs.U64.parse(new Uint8Array(res.results[0].returnValues[7][0]));
+    const basePythDecimals = Number(
+      import_bcs.bcs.u8().parse(new Uint8Array(res.results[0].returnValues[8][0]))
+    );
+    const quotePythPrice = import_bcs.bcs.U64.parse(new Uint8Array(res.results[0].returnValues[9][0]));
+    const quotePythDecimals = Number(
+      import_bcs.bcs.u8().parse(new Uint8Array(res.results[0].returnValues[10][0]))
+    );
+    return {
+      managerId,
+      deepbookPoolId,
+      riskRatio,
+      baseAsset,
+      quoteAsset,
+      baseDebt,
+      quoteDebt,
+      basePythPrice: basePythPrice.toString(),
+      basePythDecimals,
+      quotePythPrice: quotePythPrice.toString(),
+      quotePythDecimals
+    };
+  }
   // === Margin Registry Functions ===
   /**
    * @description Check if a deepbook pool is enabled for margin trading