@haneullabs/deepbook-v3 0.1.0

package/dist/cjs/transactions/marginManager.d.ts

@@ -0,0 +1,236 @@
+import type { Transaction, TransactionArgument } from '@haneullabs/haneul/transactions';
+import type { DeepBookConfig } from '../utils/config.js';
+/**
+ * MarginManagerContract class for managing MarginManager operations.
+ */
+export declare class MarginManagerContract {
+    #private;
+    /**
+     * @param {DeepBookConfig} config Configuration for MarginManagerContract
+     */
+    constructor(config: DeepBookConfig);
+    /**
+     * @description Create a new margin manager
+     * @param {string} poolKey The key to identify the pool
+     * @returns A function that takes a Transaction object
+     */
+    newMarginManager: (poolKey: string) => (tx: Transaction) => void;
+    /**
+     * @description Create a new margin manager with an initializer
+     * @param {string} poolKey The key to identify the pool
+     * @returns A function that takes a Transaction object
+     */
+    newMarginManagerWithInitializer: (poolKey: string) => (tx: Transaction) => {
+        manager: {
+            $kind: "NestedResult";
+            NestedResult: [number, number];
+        };
+        initializer: {
+            $kind: "NestedResult";
+            NestedResult: [number, number];
+        };
+    };
+    /**
+     * @description Share a margin manager
+     * @param {string} poolKey The key to identify the pool
+     * @param {TransactionArgument} manager The margin manager to share
+     * @param {TransactionArgument} initializer The initializer for the manager
+     * @returns A function that takes a Transaction object
+     */
+    shareMarginManager: (poolKey: string, manager: TransactionArgument, initializer: TransactionArgument) => (tx: Transaction) => void;
+    /**
+     * @description Deposit base into a margin manager
+     * @param {string} managerKey The key to identify the manager
+     * @param {number} amount The amount to deposit
+     * @returns A function that takes a Transaction object
+     */
+    depositBase: (managerKey: string, amount: number) => (tx: Transaction) => void;
+    /**
+     * @description Deposit quote into a margin manager
+     * @param {string} managerKey The key to identify the manager
+     * @param {number} amount The amount to deposit
+     * @returns A function that takes a Transaction object
+     */
+    depositQuote: (managerKey: string, amount: number) => (tx: Transaction) => void;
+    /**
+     * @description Deposit deep into a margin manager
+     * @param {string} managerKey The key to identify the manager
+     * @param {number} amount The amount to deposit
+     * @returns A function that takes a Transaction object
+     */
+    depositDeep: (managerKey: string, amount: number) => (tx: Transaction) => void;
+    /**
+     * @description Withdraw base from a margin manager
+     * @param {string} managerKey The key to identify the manager
+     * @param {number} amount The amount to withdraw
+     * @returns A function that takes a Transaction object
+     */
+    withdrawBase: (managerKey: string, amount: number) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+    /**
+     * @description Withdraw quote from a margin manager
+     * @param {string} managerKey The key to identify the manager
+     * @param {number} amount The amount to withdraw
+     * @returns A function that takes a Transaction object
+     */
+    withdrawQuote: (managerKey: string, amount: number) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+    /**
+     * @description Withdraw deep from a margin manager
+     * @param {string} managerKey The key to identify the manager
+     * @param {number} amount The amount to withdraw
+     * @returns A function that takes a Transaction object
+     */
+    withdrawDeep: (managerKey: string, amount: number) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+    /**
+     * @description Borrow base from a margin manager
+     * @param {string} managerKey The key to identify the manager
+     * @param {number} amount The amount to borrow
+     * @returns A function that takes a Transaction object
+     */
+    borrowBase: (managerKey: string, amount: number) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+    /**
+     * @description Borrow quote from a margin manager
+     * @param {string} managerKey The key to identify the manager
+     * @param {number} amount The amount to borrow
+     * @returns A function that takes a Transaction object
+     */
+    borrowQuote: (managerKey: string, amount: number) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+    /**
+     * @description Repay base from a margin manager
+     * @param {string} managerKey The key to identify the manager
+     * @param {number} amount The amount to repay
+     * @returns A function that takes a Transaction object
+     */
+    repayBase: (managerKey: string, amount?: number) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+    /**
+     * @description Repay quote from a margin manager
+     * @param {string} managerKey The key to identify the manager
+     * @param {number} amount The amount to repay
+     * @returns A function that takes a Transaction object
+     */
+    repayQuote: (managerKey: string, amount?: number) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+    /**
+     * @description Liquidate a margin manager
+     * @param {string} managerAddress The address of the manager to liquidate
+     * @param {string} poolKey The key to identify the pool
+     * @param {boolean} debtIsBase Whether the debt is in base
+     * @param {TransactionArgument} repayCoin The coin to repay
+     * @returns A function that takes a Transaction object
+     */
+    liquidate: (managerAddress: string, poolKey: string, debtIsBase: boolean, repayCoin: TransactionArgument) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+    /**
+     * @description Set the referral for a margin manager (DeepBookPoolReferral)
+     * @param {string} managerKey The key to identify the margin manager
+     * @param {string} referral The referral (DeepBookPoolReferral) to set
+     * @returns A function that takes a Transaction object
+     */
+    setMarginManagerReferral: (managerKey: string, referral: string) => (tx: Transaction) => void;
+    /**
+     * @description Unset the referral for a margin manager
+     * @param {string} managerKey The key to identify the margin manager
+     * @param {string} poolKey The key of the pool to unset the referral for
+     * @returns A function that takes a Transaction object
+     */
+    unsetMarginManagerReferral: (managerKey: string, poolKey: string) => (tx: Transaction) => void;
+    /**
+     * @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
+     * @returns A function that takes a Transaction object
+     */
+    ownerByPoolKey: (poolKey: string, marginManagerId: string) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+    /**
+     * @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
+     * @returns A function that takes a Transaction object
+     */
+    deepbookPool: (poolKey: string, marginManagerId: string) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+    /**
+     * @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
+     * @returns A function that takes a Transaction object
+     */
+    marginPoolId: (poolKey: string, marginManagerId: string) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+    /**
+     * @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
+     * @returns A function that takes a Transaction object
+     */
+    borrowedShares: (poolKey: string, marginManagerId: string) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+    /**
+     * @description Get borrowed base shares
+     * @param {string} poolKey The key to identify the pool
+     * @param {string} marginManagerId The ID of the margin manager
+     * @returns A function that takes a Transaction object
+     */
+    borrowedBaseShares: (poolKey: string, marginManagerId: string) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+    /**
+     * @description Get borrowed quote shares
+     * @param {string} poolKey The key to identify the pool
+     * @param {string} marginManagerId The ID of the margin manager
+     * @returns A function that takes a Transaction object
+     */
+    borrowedQuoteShares: (poolKey: string, marginManagerId: string) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+    /**
+     * @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
+     * @returns A function that takes a Transaction object
+     */
+    hasBaseDebt: (poolKey: string, marginManagerId: string) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+    /**
+     * @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
+     * @returns A function that takes a Transaction object
+     */
+    balanceManager: (poolKey: string, marginManagerId: string) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+    /**
+     * @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
+     * @returns A function that takes a Transaction object
+     */
+    calculateAssets: (poolKey: string, marginManagerId: string) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+    /**
+     * @description Calculate debts (base and quote) for a margin manager
+     * @param {string} poolKey The key to identify the pool
+     * @param {string} coinKey The key to identify the debt coin (base or quote)
+     * @param {string} marginManagerId The ID of the margin manager
+     * @returns A function that takes a Transaction object
+     */
+    calculateDebts: (poolKey: string, coinKey: string, marginManagerId: string) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+    /**
+     * @description Get comprehensive state information for a margin manager
+     * @param {string} poolKey The key to identify the pool
+     * @param {string} marginManagerId The ID of the margin manager
+     * @returns A function that takes a Transaction object
+     * @returns Returns (manager_id, deepbook_pool_id, risk_ratio, base_asset, quote_asset,
+     *                   base_debt, quote_debt, base_pyth_price, base_pyth_decimals,
+     *                   quote_pyth_price, quote_pyth_decimals)
+     */
+    managerState: (poolKey: string, marginManagerId: string) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+    /**
+     * @description Get the base asset balance of a margin manager
+     * @param {string} poolKey The key to identify the pool
+     * @param {string} marginManagerId The ID of the margin manager
+     * @returns A function that takes a Transaction object
+     */
+    baseBalance: (poolKey: string, marginManagerId: string) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+    /**
+     * @description Get the quote asset balance of a margin manager
+     * @param {string} poolKey The key to identify the pool
+     * @param {string} marginManagerId The ID of the margin manager
+     * @returns A function that takes a Transaction object
+     */
+    quoteBalance: (poolKey: string, marginManagerId: string) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+    /**
+     * @description Get the DEEP token balance of a margin manager
+     * @param {string} poolKey The key to identify the pool
+     * @param {string} marginManagerId The ID of the margin manager
+     * @returns A function that takes a Transaction object
+     */
+    deepBalance: (poolKey: string, marginManagerId: string) => (tx: Transaction) => import("@haneullabs/haneul/transactions").TransactionResult;
+}