@haneullabs/deepbook-v3 0.1.0

package/src/transactions/marginPool.ts

@@ -0,0 +1,339 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+import { coinWithBalance } from '@haneullabs/haneul/transactions';
+import type { Transaction, TransactionObjectArgument } from '@haneullabs/haneul/transactions';
+
+import type { DeepBookConfig } from '../utils/config.js';
+
+/**
+ * MarginPoolContract class for managing MarginPool operations.
+ */
+export class MarginPoolContract {
+	#config: DeepBookConfig;
+
+	/**
+	 * @param {DeepBookConfig} config Configuration for MarginPoolContract
+	 */
+	constructor(config: DeepBookConfig) {
+		this.#config = config;
+	}
+
+	/**
+	 * @description Mint a supplier cap for margin pool
+	 * @returns A function that takes a Transaction object
+	 */
+	mintSupplierCap = () => (tx: Transaction) => {
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_pool::mint_supplier_cap`,
+			arguments: [tx.object(this.#config.MARGIN_REGISTRY_ID), tx.object.clock()],
+		});
+	};
+
+	/**
+	 * @description Supply to a margin pool
+	 * @param {string} coinKey The key to identify the pool
+	 * @param {TransactionObjectArgument} supplierCap The supplier cap object
+	 * @param {number} amountToDeposit The amount to deposit
+	 * @param {string} referralId The ID of the referral
+	 * @returns A function that takes a Transaction object
+	 */
+	supplyToMarginPool =
+		(
+			coinKey: string,
+			supplierCap: TransactionObjectArgument,
+			amountToDeposit: number,
+			referralId?: string,
+		) =>
+		(tx: Transaction) => {
+			tx.setSenderIfNotSet(this.#config.address);
+			const marginPool = this.#config.getMarginPool(coinKey);
+			const coin = this.#config.getCoin(coinKey);
+			const depositInput = Math.round(amountToDeposit * coin.scalar);
+			const supply = coinWithBalance({
+				type: coin.type,
+				balance: depositInput,
+			});
+
+			tx.moveCall({
+				target: `${this.#config.MARGIN_PACKAGE_ID}::margin_pool::supply`,
+				arguments: [
+					tx.object(marginPool.address),
+					tx.object(this.#config.MARGIN_REGISTRY_ID),
+					supplierCap,
+					supply,
+					tx.object.option({
+						type: '0x2::object::ID',
+						value: referralId ? tx.pure.id(referralId) : null,
+					}),
+					tx.object.clock(),
+				],
+				typeArguments: [marginPool.type],
+			});
+		};
+
+	/**
+	 * @description Withdraw from a margin pool
+	 * @param {string} coinKey The key to identify the pool
+	 * @param {TransactionObjectArgument} supplierCap The supplier cap object
+	 * @param {number} amountToWithdraw The amount to withdraw
+	 * @returns A function that takes a Transaction object
+	 */
+	withdrawFromMarginPool =
+		(coinKey: string, supplierCap: TransactionObjectArgument, amountToWithdraw?: number) =>
+		(tx: Transaction) => {
+			const marginPool = this.#config.getMarginPool(coinKey);
+			const coin = this.#config.getCoin(coinKey);
+			const withdrawInput = amountToWithdraw
+				? tx.pure.u64(Math.round(amountToWithdraw * coin.scalar))
+				: null;
+			return tx.moveCall({
+				target: `${this.#config.MARGIN_PACKAGE_ID}::margin_pool::withdraw`,
+				arguments: [
+					tx.object(marginPool.address),
+					tx.object(this.#config.MARGIN_REGISTRY_ID),
+					supplierCap,
+					tx.object.option({ type: 'u64', value: withdrawInput }),
+					tx.object.clock(),
+				],
+				typeArguments: [marginPool.type],
+			});
+		};
+
+	/**
+	 * @description Mint a referral for a margin pool
+	 * @param {string} coinKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	mintSupplyReferral = (coinKey: string) => (tx: Transaction) => {
+		const marginPool = this.#config.getMarginPool(coinKey);
+		tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_pool::mint_supply_referral`,
+			arguments: [
+				tx.object(marginPool.address),
+				tx.object(this.#config.MARGIN_REGISTRY_ID),
+				tx.object.clock(),
+			],
+			typeArguments: [marginPool.type],
+		});
+	};
+
+	/**
+	 * @description Withdraw referral fees from a margin pool
+	 * @param {string} coinKey The key to identify the pool
+	 * @param {string} referralId The ID of the referral
+	 * @returns A function that takes a Transaction object
+	 */
+	withdrawReferralFees = (coinKey: string, referralId: string) => (tx: Transaction) => {
+		const marginPool = this.#config.getMarginPool(coinKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_pool::withdraw_referral_fees`,
+			arguments: [
+				tx.object(marginPool.address),
+				tx.object(this.#config.MARGIN_REGISTRY_ID),
+				tx.object(referralId),
+			],
+			typeArguments: [marginPool.type],
+		});
+	};
+
+	// === Read-only/View Functions ===
+
+	/**
+	 * @description Get the margin pool ID
+	 * @param {string} coinKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	getId = (coinKey: string) => (tx: Transaction) => {
+		const marginPool = this.#config.getMarginPool(coinKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_pool::id`,
+			arguments: [tx.object(marginPool.address)],
+			typeArguments: [marginPool.type],
+		});
+	};
+
+	/**
+	 * @description Check if a deepbook pool is allowed for borrowing
+	 * @param {string} coinKey The key to identify the margin pool
+	 * @param {string} deepbookPoolId The ID of the deepbook pool
+	 * @returns A function that takes a Transaction object
+	 */
+	deepbookPoolAllowed = (coinKey: string, deepbookPoolId: string) => (tx: Transaction) => {
+		const marginPool = this.#config.getMarginPool(coinKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_pool::deepbook_pool_allowed`,
+			arguments: [tx.object(marginPool.address), tx.pure.id(deepbookPoolId)],
+			typeArguments: [marginPool.type],
+		});
+	};
+
+	/**
+	 * @description Get the total supply amount
+	 * @param {string} coinKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	totalSupply = (coinKey: string) => (tx: Transaction) => {
+		const marginPool = this.#config.getMarginPool(coinKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_pool::total_supply`,
+			arguments: [tx.object(marginPool.address)],
+			typeArguments: [marginPool.type],
+		});
+	};
+
+	/**
+	 * @description Get the total supply shares
+	 * @param {string} coinKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	supplyShares = (coinKey: string) => (tx: Transaction) => {
+		const marginPool = this.#config.getMarginPool(coinKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_pool::supply_shares`,
+			arguments: [tx.object(marginPool.address)],
+			typeArguments: [marginPool.type],
+		});
+	};
+
+	/**
+	 * @description Get the total borrow amount
+	 * @param {string} coinKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	totalBorrow = (coinKey: string) => (tx: Transaction) => {
+		const marginPool = this.#config.getMarginPool(coinKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_pool::total_borrow`,
+			arguments: [tx.object(marginPool.address)],
+			typeArguments: [marginPool.type],
+		});
+	};
+
+	/**
+	 * @description Get the total borrow shares
+	 * @param {string} coinKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	borrowShares = (coinKey: string) => (tx: Transaction) => {
+		const marginPool = this.#config.getMarginPool(coinKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_pool::borrow_shares`,
+			arguments: [tx.object(marginPool.address)],
+			typeArguments: [marginPool.type],
+		});
+	};
+
+	/**
+	 * @description Get the last update timestamp
+	 * @param {string} coinKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	lastUpdateTimestamp = (coinKey: string) => (tx: Transaction) => {
+		const marginPool = this.#config.getMarginPool(coinKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_pool::last_update_timestamp`,
+			arguments: [tx.object(marginPool.address)],
+			typeArguments: [marginPool.type],
+		});
+	};
+
+	/**
+	 * @description Get the supply cap
+	 * @param {string} coinKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	supplyCap = (coinKey: string) => (tx: Transaction) => {
+		const marginPool = this.#config.getMarginPool(coinKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_pool::supply_cap`,
+			arguments: [tx.object(marginPool.address)],
+			typeArguments: [marginPool.type],
+		});
+	};
+
+	/**
+	 * @description Get the max utilization rate
+	 * @param {string} coinKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	maxUtilizationRate = (coinKey: string) => (tx: Transaction) => {
+		const marginPool = this.#config.getMarginPool(coinKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_pool::max_utilization_rate`,
+			arguments: [tx.object(marginPool.address)],
+			typeArguments: [marginPool.type],
+		});
+	};
+
+	/**
+	 * @description Get the protocol spread
+	 * @param {string} coinKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	protocolSpread = (coinKey: string) => (tx: Transaction) => {
+		const marginPool = this.#config.getMarginPool(coinKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_pool::protocol_spread`,
+			arguments: [tx.object(marginPool.address)],
+			typeArguments: [marginPool.type],
+		});
+	};
+
+	/**
+	 * @description Get the minimum borrow amount
+	 * @param {string} coinKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	minBorrow = (coinKey: string) => (tx: Transaction) => {
+		const marginPool = this.#config.getMarginPool(coinKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_pool::min_borrow`,
+			arguments: [tx.object(marginPool.address)],
+			typeArguments: [marginPool.type],
+		});
+	};
+
+	/**
+	 * @description Get the current interest rate
+	 * @param {string} coinKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	interestRate = (coinKey: string) => (tx: Transaction) => {
+		const marginPool = this.#config.getMarginPool(coinKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_pool::interest_rate`,
+			arguments: [tx.object(marginPool.address)],
+			typeArguments: [marginPool.type],
+		});
+	};
+
+	/**
+	 * @description Get user supply shares for a supplier cap
+	 * @param {string} coinKey The key to identify the pool
+	 * @param {string} supplierCapId The ID of the supplier cap
+	 * @returns A function that takes a Transaction object
+	 */
+	userSupplyShares = (coinKey: string, supplierCapId: string) => (tx: Transaction) => {
+		const marginPool = this.#config.getMarginPool(coinKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_pool::user_supply_shares`,
+			arguments: [tx.object(marginPool.address), tx.pure.id(supplierCapId)],
+			typeArguments: [marginPool.type],
+		});
+	};
+
+	/**
+	 * @description Get user supply amount for a supplier cap
+	 * @param {string} coinKey The key to identify the pool
+	 * @param {string} supplierCapId The ID of the supplier cap
+	 * @returns A function that takes a Transaction object
+	 */
+	userSupplyAmount = (coinKey: string, supplierCapId: string) => (tx: Transaction) => {
+		const marginPool = this.#config.getMarginPool(coinKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_pool::user_supply_amount`,
+			arguments: [tx.object(marginPool.address), tx.pure.id(supplierCapId), tx.object.clock()],
+			typeArguments: [marginPool.type],
+		});
+	};
+}

package/src/transactions/marginRegistry.ts

@@ -0,0 +1,212 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+import type { Transaction } from '@haneullabs/haneul/transactions';
+
+import type { DeepBookConfig } from '../utils/config.js';
+
+/**
+ * MarginRegistryContract class for managing MarginRegistry read-only operations.
+ */
+export class MarginRegistryContract {
+	#config: DeepBookConfig;
+
+	/**
+	 * @param {DeepBookConfig} config Configuration for MarginRegistryContract
+	 */
+	constructor(config: DeepBookConfig) {
+		this.#config = config;
+	}
+
+	/**
+	 * @description Check if a deepbook pool is enabled for margin trading
+	 * @param {string} poolKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	poolEnabled = (poolKey: string) => (tx: Transaction) => {
+		const pool = this.#config.getPool(poolKey);
+		const baseCoin = this.#config.getCoin(pool.baseCoin);
+		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_registry::pool_enabled`,
+			arguments: [tx.object(this.#config.MARGIN_REGISTRY_ID), tx.object(pool.address)],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
+	/**
+	 * @description Get the margin pool ID for a given asset
+	 * @param {string} coinKey The key to identify the coin
+	 * @returns A function that takes a Transaction object
+	 */
+	getMarginPoolId = (coinKey: string) => (tx: Transaction) => {
+		const coin = this.#config.getCoin(coinKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_registry::get_margin_pool_id`,
+			arguments: [tx.object(this.#config.MARGIN_REGISTRY_ID)],
+			typeArguments: [coin.type],
+		});
+	};
+
+	/**
+	 * @description Get the margin pool IDs (base and quote) for a deepbook pool
+	 * @param {string} poolKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	getDeepbookPoolMarginPoolIds = (poolKey: string) => (tx: Transaction) => {
+		const pool = this.#config.getPool(poolKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_registry::get_deepbook_pool_margin_pool_ids`,
+			arguments: [tx.object(this.#config.MARGIN_REGISTRY_ID), tx.pure.id(pool.address)],
+			typeArguments: [],
+		});
+	};
+
+	/**
+	 * @description Get the margin manager IDs for a given owner
+	 * @param {string} owner The owner address
+	 * @returns A function that takes a Transaction object
+	 */
+	getMarginManagerIds = (owner: string) => (tx: Transaction) => {
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_registry::get_margin_manager_ids`,
+			arguments: [tx.object(this.#config.MARGIN_REGISTRY_ID), tx.pure.address(owner)],
+			typeArguments: [],
+		});
+	};
+
+	/**
+	 * @description Get the base margin pool ID for a deepbook pool
+	 * @param {string} poolKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	baseMarginPoolId = (poolKey: string) => (tx: Transaction) => {
+		const pool = this.#config.getPool(poolKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_registry::base_margin_pool_id`,
+			arguments: [tx.object(this.#config.MARGIN_REGISTRY_ID), tx.pure.id(pool.address)],
+			typeArguments: [],
+		});
+	};
+
+	/**
+	 * @description Get the quote margin pool ID for a deepbook pool
+	 * @param {string} poolKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	quoteMarginPoolId = (poolKey: string) => (tx: Transaction) => {
+		const pool = this.#config.getPool(poolKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_registry::quote_margin_pool_id`,
+			arguments: [tx.object(this.#config.MARGIN_REGISTRY_ID), tx.pure.id(pool.address)],
+			typeArguments: [],
+		});
+	};
+
+	/**
+	 * @description Get the minimum withdraw risk ratio for a deepbook pool
+	 * @param {string} poolKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	minWithdrawRiskRatio = (poolKey: string) => (tx: Transaction) => {
+		const pool = this.#config.getPool(poolKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_registry::min_withdraw_risk_ratio`,
+			arguments: [tx.object(this.#config.MARGIN_REGISTRY_ID), tx.pure.id(pool.address)],
+			typeArguments: [],
+		});
+	};
+
+	/**
+	 * @description Get the minimum borrow risk ratio for a deepbook pool
+	 * @param {string} poolKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	minBorrowRiskRatio = (poolKey: string) => (tx: Transaction) => {
+		const pool = this.#config.getPool(poolKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_registry::min_borrow_risk_ratio`,
+			arguments: [tx.object(this.#config.MARGIN_REGISTRY_ID), tx.pure.id(pool.address)],
+			typeArguments: [],
+		});
+	};
+
+	/**
+	 * @description Get the liquidation risk ratio for a deepbook pool
+	 * @param {string} poolKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	liquidationRiskRatio = (poolKey: string) => (tx: Transaction) => {
+		const pool = this.#config.getPool(poolKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_registry::liquidation_risk_ratio`,
+			arguments: [tx.object(this.#config.MARGIN_REGISTRY_ID), tx.pure.id(pool.address)],
+			typeArguments: [],
+		});
+	};
+
+	/**
+	 * @description Get the target liquidation risk ratio for a deepbook pool
+	 * @param {string} poolKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	targetLiquidationRiskRatio = (poolKey: string) => (tx: Transaction) => {
+		const pool = this.#config.getPool(poolKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_registry::target_liquidation_risk_ratio`,
+			arguments: [tx.object(this.#config.MARGIN_REGISTRY_ID), tx.pure.id(pool.address)],
+			typeArguments: [],
+		});
+	};
+
+	/**
+	 * @description Get the user liquidation reward for a deepbook pool
+	 * @param {string} poolKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	userLiquidationReward = (poolKey: string) => (tx: Transaction) => {
+		const pool = this.#config.getPool(poolKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_registry::user_liquidation_reward`,
+			arguments: [tx.object(this.#config.MARGIN_REGISTRY_ID), tx.pure.id(pool.address)],
+			typeArguments: [],
+		});
+	};
+
+	/**
+	 * @description Get the pool liquidation reward for a deepbook pool
+	 * @param {string} poolKey The key to identify the pool
+	 * @returns A function that takes a Transaction object
+	 */
+	poolLiquidationReward = (poolKey: string) => (tx: Transaction) => {
+		const pool = this.#config.getPool(poolKey);
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_registry::pool_liquidation_reward`,
+			arguments: [tx.object(this.#config.MARGIN_REGISTRY_ID), tx.pure.id(pool.address)],
+			typeArguments: [],
+		});
+	};
+
+	/**
+	 * @description Get all allowed maintainer cap IDs
+	 * @returns A function that takes a Transaction object
+	 */
+	allowedMaintainers = () => (tx: Transaction) => {
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_registry::allowed_maintainers`,
+			arguments: [tx.object(this.#config.MARGIN_REGISTRY_ID)],
+			typeArguments: [],
+		});
+	};
+
+	/**
+	 * @description Get all allowed pause cap IDs
+	 * @returns A function that takes a Transaction object
+	 */
+	allowedPauseCaps = () => (tx: Transaction) => {
+		return tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_registry::allowed_pause_caps`,
+			arguments: [tx.object(this.#config.MARGIN_REGISTRY_ID)],
+			typeArguments: [],
+		});
+	};
+}