@mysten/deepbook-v3 1.3.6 → 1.4.1

package/src/transactions/marginAdmin.ts

@@ -155,6 +155,85 @@ export class MarginAdminContract {
 		});
 	};
 
+	/**
+	 * @description Set the price deviation tolerance for a pool. `tolerance` is
+	 * in 9-decimal float scaling (1.0 = `FLOAT_SCALAR`); the SDK applies the
+	 * scaling, so callers pass a human-readable fraction (e.g. `0.1` for 10%).
+	 * Requires the pool's current price to have been initialized via
+	 * `PoolProxyContract.updateCurrentPrice` first.
+	 * @param {string} poolKey The key of the pool to update
+	 * @param {number | bigint} tolerance Tolerance as a fraction (e.g. 0.1 for 10%)
+	 * @returns A function that takes a Transaction object
+	 */
+	setPriceTolerance = (poolKey: string, tolerance: number | bigint) => (tx: Transaction) => {
+		const pool = this.#config.getPool(poolKey);
+		const baseCoin = this.#config.getCoin(pool.baseCoin);
+		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_registry::set_price_tolerance`,
+			arguments: [
+				tx.object(this.#config.MARGIN_REGISTRY_ID),
+				tx.object(this.#marginAdminCap()),
+				tx.object(pool.address),
+				tx.pure.u64(convertRate(tolerance, FLOAT_SCALAR)),
+				tx.object.clock(),
+			],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
+	/**
+	 * @description Set the maximum acceptable Pyth price age (in milliseconds)
+	 * for a pool. Requires the pool's current price to have been initialized
+	 * via `PoolProxyContract.updateCurrentPrice` first.
+	 * @param {string} poolKey The key of the pool to update
+	 * @param {number | bigint} maxAgeMs Max age in milliseconds (raw u64)
+	 * @returns A function that takes a Transaction object
+	 */
+	setMaxPriceAge = (poolKey: string, maxAgeMs: number | bigint) => (tx: Transaction) => {
+		const pool = this.#config.getPool(poolKey);
+		const baseCoin = this.#config.getCoin(pool.baseCoin);
+		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_registry::set_max_price_age`,
+			arguments: [
+				tx.object(this.#config.MARGIN_REGISTRY_ID),
+				tx.object(this.#marginAdminCap()),
+				tx.object(pool.address),
+				tx.pure.u64(maxAgeMs),
+				tx.object.clock(),
+			],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
+	/**
+	 * @description Set the maximum lifetime (in milliseconds) of margin limit
+	 * orders for a pool. `pool_proxy::place_limit_order_v2` and
+	 * `place_reduce_only_limit_order_v2` clamp the user-supplied
+	 * `expire_timestamp` to at most `now + max_order_ttl_ms`, bounding margin
+	 * orders' exposure to stale-price exploitation.
+	 * @param {string} poolKey The key of the pool to update
+	 * @param {number | bigint} maxOrderTtlMs Max order TTL in milliseconds (raw u64)
+	 * @returns A function that takes a Transaction object
+	 */
+	setMaxOrderTtl = (poolKey: string, maxOrderTtlMs: number | bigint) => (tx: Transaction) => {
+		const pool = this.#config.getPool(poolKey);
+		const baseCoin = this.#config.getCoin(pool.baseCoin);
+		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_registry::set_max_order_ttl`,
+			arguments: [
+				tx.object(this.#config.MARGIN_REGISTRY_ID),
+				tx.object(this.#marginAdminCap()),
+				tx.object(pool.address),
+				tx.pure.u64(maxOrderTtlMs),
+				tx.object.clock(),
+			],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
 	/**
 	 * @description Add the PythConfig to the margin registry
 	 * @param {Transaction} tx The transaction object

package/src/transactions/marginMaintainer.ts

@@ -99,13 +99,13 @@ export class MarginMaintainerContract {
 	newMarginPoolConfig =
 		(coinKey: string, marginPoolConfig: MarginPoolConfigParams) => (tx: Transaction) => {
 			const coin = this.#config.getCoin(coinKey);
-			const { supplyCap, maxUtilizationRate, referralSpread, minBorrow } = marginPoolConfig;
+			const { supplyCap, maxUtilizationRate, protocolSpread, minBorrow } = marginPoolConfig;
 			return tx.moveCall({
 				target: `${this.#config.MARGIN_PACKAGE_ID}::protocol_config::new_margin_pool_config`,
 				arguments: [
 					tx.pure.u64(convertQuantity(supplyCap, coin.scalar)),
 					tx.pure.u64(convertRate(maxUtilizationRate, FLOAT_SCALAR)),
-					tx.pure.u64(convertRate(referralSpread, FLOAT_SCALAR)),
+					tx.pure.u64(convertRate(protocolSpread, FLOAT_SCALAR)),
 					tx.pure.u64(convertQuantity(minBorrow, coin.scalar)),
 				],
 			});
@@ -133,7 +133,7 @@ export class MarginMaintainerContract {
 			const {
 				supplyCap,
 				maxUtilizationRate,
-				referralSpread,
+				protocolSpread,
 				minBorrow,
 				rateLimitCapacity,
 				rateLimitRefillRatePerMs,
@@ -144,7 +144,7 @@ export class MarginMaintainerContract {
 				arguments: [
 					tx.pure.u64(convertQuantity(supplyCap, coin.scalar)),
 					tx.pure.u64(convertRate(maxUtilizationRate, FLOAT_SCALAR)),
-					tx.pure.u64(convertRate(referralSpread, FLOAT_SCALAR)),
+					tx.pure.u64(convertRate(protocolSpread, FLOAT_SCALAR)),
 					tx.pure.u64(convertQuantity(minBorrow, coin.scalar)),
 					tx.pure.u64(convertQuantity(rateLimitCapacity, coin.scalar)),
 					tx.pure.u64(convertQuantity(rateLimitRefillRatePerMs, coin.scalar)),

package/src/transactions/marginManager.ts

@@ -5,7 +5,8 @@ import { coinWithBalance } from '@mysten/sui/transactions';
 
 import type { DeepBookConfig } from '../utils/config.js';
 import type { DepositParams, DepositDuringInitParams } from '../types/index.js';
-import { convertQuantity } from '../utils/conversion.js';
+import { FLOAT_SCALAR } from '../utils/config.js';
+import { convertPrice, convertQuantity } from '../utils/conversion.js';
 
 /**
  * MarginManagerContract class for managing MarginManager operations.
@@ -83,6 +84,43 @@ export class MarginManagerContract {
 			});
 		};
 
+	/**
+	 * @description Register a margin manager back to the margin registry. Lets
+	 * owners restore visibility of a manager that was unregistered by another
+	 * platform.
+	 * @param {string} managerKey The key to identify the margin manager
+	 * @returns A function that takes a Transaction object
+	 */
+	registerMarginManager = (managerKey: string) => (tx: Transaction) => {
+		const manager = this.#config.getMarginManager(managerKey);
+		const pool = this.#config.getPool(manager.poolKey);
+		const baseCoin = this.#config.getCoin(pool.baseCoin);
+		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_manager::register_margin_manager`,
+			arguments: [tx.object(manager.address), tx.object(this.#config.MARGIN_REGISTRY_ID)],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
+	/**
+	 * @description Unregister a margin manager from the margin registry. Aborts
+	 * if the manager holds any outstanding debt or base/quote/DEEP balance.
+	 * @param {string} managerKey The key to identify the margin manager
+	 * @returns A function that takes a Transaction object
+	 */
+	unregisterMarginManager = (managerKey: string) => (tx: Transaction) => {
+		const manager = this.#config.getMarginManager(managerKey);
+		const pool = this.#config.getPool(manager.poolKey);
+		const baseCoin = this.#config.getCoin(pool.baseCoin);
+		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		tx.moveCall({
+			target: `${this.#config.MARGIN_PACKAGE_ID}::margin_manager::unregister_margin_manager`,
+			arguments: [tx.object(manager.address), tx.object(this.#config.MARGIN_REGISTRY_ID)],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
 	/**
 	 * @description Deposit into a margin manager during initialization (before sharing).
 	 * Use this when you need to deposit funds into a newly created manager in the same transaction.
@@ -754,4 +792,209 @@ export class MarginManagerContract {
 			typeArguments: [baseCoin.type, quoteCoin.type],
 		});
 	};
+
+	/**
+	 * @description Get the underlying BalanceManager ID for a margin manager.
+	 * Returns an ID (not a `&BalanceManager`), so it composes in PTBs unlike
+	 * `balanceManager`.
+	 * @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
+	 */
+	balanceManagerId = (poolKey: string, marginManagerId: 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_manager::balance_manager_id`,
+			arguments: [tx.object(marginManagerId)],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
+	/**
+	 * @description Get the BalanceManager referral ID for a pool (Option<ID>).
+	 * @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
+	 */
+	getBalanceManagerReferralId = (poolKey: string, marginManagerId: 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_manager::get_balance_manager_referral_id`,
+			arguments: [tx.object(marginManagerId), tx.pure.id(pool.address)],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
+	/**
+	 * @description Check if the margin manager's account exists in the pool.
+	 * @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
+	 */
+	accountExists = (poolKey: string, marginManagerId: 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_manager::account_exists`,
+			arguments: [tx.object(marginManagerId), tx.object(pool.address)],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
+	/**
+	 * @description Get the pool account data for the 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
+	 */
+	account = (poolKey: string, marginManagerId: 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_manager::account`,
+			arguments: [tx.object(marginManagerId), tx.object(pool.address)],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
+	/**
+	 * @description Get the open order IDs for the margin manager's account in
+	 * the pool.
+	 * @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
+	 */
+	accountOpenOrders = (poolKey: string, marginManagerId: 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_manager::account_open_orders`,
+			arguments: [tx.object(marginManagerId), tx.object(pool.address)],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
+	/**
+	 * @description Get full order details for the margin manager's account in
+	 * the pool.
+	 * @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
+	 */
+	getAccountOrderDetails = (poolKey: string, marginManagerId: 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_manager::get_account_order_details`,
+			arguments: [tx.object(marginManagerId), tx.object(pool.address)],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
+	/**
+	 * @description Get locked balances (base, quote, deep) for the margin
+	 * manager's account in the pool.
+	 * @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
+	 */
+	lockedBalance = (poolKey: string, marginManagerId: 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_manager::locked_balance`,
+			arguments: [tx.object(marginManagerId), tx.object(pool.address)],
+			typeArguments: [baseCoin.type, quoteCoin.type],
+		});
+	};
+
+	/**
+	 * @description Check whether a limit order can be placed given the
+	 * manager's current state.
+	 * @param {string} poolKey The key to identify the pool
+	 * @param {string} marginManagerId The ID of the margin manager
+	 * @param {number | bigint} price Limit price
+	 * @param {number | bigint} quantity Order quantity (base units)
+	 * @param {boolean} isBid True for bid, false for ask
+	 * @param {boolean} payWithDeep Whether to pay fees in DEEP
+	 * @param {number | bigint} expireTimestamp Order expiration timestamp (ms)
+	 * @returns A function that takes a Transaction object
+	 */
+	canPlaceLimitOrder =
+		(
+			poolKey: string,
+			marginManagerId: string,
+			price: number | bigint,
+			quantity: number | bigint,
+			isBid: boolean,
+			payWithDeep: boolean,
+			expireTimestamp: number | bigint,
+		) =>
+		(tx: Transaction) => {
+			const pool = this.#config.getPool(poolKey);
+			const baseCoin = this.#config.getCoin(pool.baseCoin);
+			const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+			const inputPrice = convertPrice(price, FLOAT_SCALAR, quoteCoin.scalar, baseCoin.scalar);
+			const inputQuantity = convertQuantity(quantity, baseCoin.scalar);
+			return tx.moveCall({
+				target: `${this.#config.MARGIN_PACKAGE_ID}::margin_manager::can_place_limit_order`,
+				arguments: [
+					tx.object(marginManagerId),
+					tx.object(pool.address),
+					tx.pure.u64(inputPrice),
+					tx.pure.u64(inputQuantity),
+					tx.pure.bool(isBid),
+					tx.pure.bool(payWithDeep),
+					tx.pure.u64(expireTimestamp),
+					tx.object.clock(),
+				],
+				typeArguments: [baseCoin.type, quoteCoin.type],
+			});
+		};
+
+	/**
+	 * @description Check whether a market order can be placed given the
+	 * manager's current state.
+	 * @param {string} poolKey The key to identify the pool
+	 * @param {string} marginManagerId The ID of the margin manager
+	 * @param {number | bigint} quantity Order quantity (base units)
+	 * @param {boolean} isBid True for bid, false for ask
+	 * @param {boolean} payWithDeep Whether to pay fees in DEEP
+	 * @returns A function that takes a Transaction object
+	 */
+	canPlaceMarketOrder =
+		(
+			poolKey: string,
+			marginManagerId: string,
+			quantity: number | bigint,
+			isBid: boolean,
+			payWithDeep: boolean,
+		) =>
+		(tx: Transaction) => {
+			const pool = this.#config.getPool(poolKey);
+			const baseCoin = this.#config.getCoin(pool.baseCoin);
+			const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+			const inputQuantity = convertQuantity(quantity, baseCoin.scalar);
+			return tx.moveCall({
+				target: `${this.#config.MARGIN_PACKAGE_ID}::margin_manager::can_place_market_order`,
+				arguments: [
+					tx.object(marginManagerId),
+					tx.object(pool.address),
+					tx.pure.u64(inputQuantity),
+					tx.pure.bool(isBid),
+					tx.pure.bool(payWithDeep),
+					tx.object.clock(),
+				],
+				typeArguments: [baseCoin.type, quoteCoin.type],
+			});
+		};
 }

package/src/transactions/marginTPSL.ts

@@ -198,8 +198,11 @@ export class MarginTPSLContract {
 		};
 
 	/**
-	 * @description Execute conditional orders that have been triggered
-	 * This is a permissionless function that can be called by anyone
+	 * @description Execute conditional orders that have been triggered.
+	 * Permissionless — anyone can call this. After the inner fill loop, the
+	 * manager's post-trade `risk_ratio` is checked against
+	 * `min_borrow_risk_ratio`; if any triggered fill breaches that floor, the
+	 * whole txn aborts (no partial-state landing).
 	 * @param {string} managerAddress The address of the margin manager
 	 * @param {string} poolKey The key to identify the pool (e.g., 'SUI_USDC')
 	 * @param {number} maxOrdersToExecute Maximum number of orders to execute in this call
@@ -210,11 +213,15 @@ export class MarginTPSLContract {
 			const pool = this.#config.getPool(poolKey);
 			const baseCoin = this.#config.getCoin(pool.baseCoin);
 			const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+			const baseMarginPool = this.#config.getMarginPool(pool.baseCoin);
+			const quoteMarginPool = this.#config.getMarginPool(pool.quoteCoin);
 			return tx.moveCall({
-				target: `${this.#config.MARGIN_PACKAGE_ID}::margin_manager::execute_conditional_orders`,
+				target: `${this.#config.MARGIN_PACKAGE_ID}::margin_manager::execute_conditional_orders_v2`,
 				arguments: [
 					tx.object(managerAddress),
 					tx.object(pool.address),
+					tx.object(baseMarginPool.address),
+					tx.object(quoteMarginPool.address),
 					tx.object(baseCoin.priceInfoObjectId!),
 					tx.object(quoteCoin.priceInfoObjectId!),
 					tx.object(this.#config.MARGIN_REGISTRY_ID),

package/src/transactions/poolProxy.ts

@@ -26,7 +26,9 @@ export class PoolProxyContract {
 	}
 
 	/**
-	 * @description Place a limit order
+	 * @description Place a limit order. Enforces a post-trade `risk_ratio >=
+	 * min_borrow_risk_ratio` invariant on the manager (skipped when the manager
+	 * has no debt).
 	 * @param {PlaceMarginLimitOrderParams} params Parameters for placing a limit order
 	 * @returns A function that takes a Transaction object
 	 */
@@ -47,14 +49,20 @@ export class PoolProxyContract {
 		const manager = this.#config.getMarginManager(marginManagerKey);
 		const baseCoin = this.#config.getCoin(pool.baseCoin);
 		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		const baseMarginPool = this.#config.getMarginPool(pool.baseCoin);
+		const quoteMarginPool = this.#config.getMarginPool(pool.quoteCoin);
 		const inputPrice = convertPrice(price, FLOAT_SCALAR, quoteCoin.scalar, baseCoin.scalar);
 		const inputQuantity = convertQuantity(quantity, baseCoin.scalar);
 		return tx.moveCall({
-			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::place_limit_order`,
+			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::place_limit_order_v2`,
 			arguments: [
 				tx.object(this.#config.MARGIN_REGISTRY_ID),
 				tx.object(manager.address),
 				tx.object(pool.address),
+				tx.object(baseMarginPool.address),
+				tx.object(quoteMarginPool.address),
+				tx.object(baseCoin.priceInfoObjectId!),
+				tx.object(quoteCoin.priceInfoObjectId!),
 				tx.pure.u64(clientOrderId),
 				tx.pure.u8(orderType),
 				tx.pure.u8(selfMatchingOption),
@@ -70,7 +78,9 @@ export class PoolProxyContract {
 	};
 
 	/**
-	 * @description Place a market order
+	 * @description Place a market order. Enforces a post-trade `risk_ratio >=
+	 * min_borrow_risk_ratio` invariant on the manager (skipped when the manager
+	 * has no debt).
 	 * @param {PlaceMarginMarketOrderParams} params Parameters for placing a market order
 	 * @returns A function that takes a Transaction object
 	 */
@@ -88,13 +98,19 @@ export class PoolProxyContract {
 		const manager = this.#config.getMarginManager(marginManagerKey);
 		const baseCoin = this.#config.getCoin(pool.baseCoin);
 		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		const baseMarginPool = this.#config.getMarginPool(pool.baseCoin);
+		const quoteMarginPool = this.#config.getMarginPool(pool.quoteCoin);
 		const inputQuantity = convertQuantity(quantity, baseCoin.scalar);
 		return tx.moveCall({
-			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::place_market_order`,
+			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::place_market_order_v2`,
 			arguments: [
 				tx.object(this.#config.MARGIN_REGISTRY_ID),
 				tx.object(manager.address),
 				tx.object(pool.address),
+				tx.object(baseMarginPool.address),
+				tx.object(quoteMarginPool.address),
+				tx.object(baseCoin.priceInfoObjectId!),
+				tx.object(quoteCoin.priceInfoObjectId!),
 				tx.pure.u64(clientOrderId),
 				tx.pure.u8(selfMatchingOption),
 				tx.pure.u64(inputQuantity),
@@ -107,7 +123,10 @@ export class PoolProxyContract {
 	};
 
 	/**
-	 * @description Place a reduce only limit order
+	 * @description Place a reduce only limit order. Requires the manager to have
+	 * debt on the relevant side; enforces a monotonic `risk_ratio_after >=
+	 * risk_ratio_before` invariant so the fill cannot leak value to the
+	 * counterparty.
 	 * @param {PlaceMarginLimitOrderParams} params Parameters for placing a reduce only limit order
 	 * @returns A function that takes a Transaction object
 	 */
@@ -128,19 +147,20 @@ export class PoolProxyContract {
 		const manager = this.#config.getMarginManager(marginManagerKey);
 		const baseCoin = this.#config.getCoin(pool.baseCoin);
 		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		const baseMarginPool = this.#config.getMarginPool(pool.baseCoin);
+		const quoteMarginPool = this.#config.getMarginPool(pool.quoteCoin);
 		const inputPrice = convertPrice(price, FLOAT_SCALAR, quoteCoin.scalar, baseCoin.scalar);
 		const inputQuantity = convertQuantity(quantity, baseCoin.scalar);
-		const marginPool = isBid
-			? this.#config.getMarginPool(pool.baseCoin)
-			: this.#config.getMarginPool(pool.quoteCoin);
-		const debtType = isBid ? baseCoin.type : quoteCoin.type;
 		return tx.moveCall({
-			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::place_reduce_only_limit_order`,
+			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::place_reduce_only_limit_order_v2`,
 			arguments: [
 				tx.object(this.#config.MARGIN_REGISTRY_ID),
 				tx.object(manager.address),
 				tx.object(pool.address),
-				tx.object(marginPool.address),
+				tx.object(baseMarginPool.address),
+				tx.object(quoteMarginPool.address),
+				tx.object(baseCoin.priceInfoObjectId!),
+				tx.object(quoteCoin.priceInfoObjectId!),
 				tx.pure.u64(clientOrderId),
 				tx.pure.u8(orderType),
 				tx.pure.u8(selfMatchingOption),
@@ -151,12 +171,15 @@ export class PoolProxyContract {
 				tx.pure.u64(expiration),
 				tx.object.clock(),
 			],
-			typeArguments: [baseCoin.type, quoteCoin.type, debtType],
+			typeArguments: [baseCoin.type, quoteCoin.type],
 		});
 	};
 
 	/**
-	 * @description Place a reduce only market order
+	 * @description Place a reduce only market order. Requires the manager to
+	 * have debt on the relevant side; enforces a monotonic `risk_ratio_after >=
+	 * risk_ratio_before` invariant so the fill cannot leak value to the
+	 * counterparty.
 	 * @param {PlaceMarginMarketOrderParams} params Parameters for placing a reduce only market order
 	 * @returns A function that takes a Transaction object
 	 */
@@ -174,18 +197,19 @@ export class PoolProxyContract {
 		const manager = this.#config.getMarginManager(marginManagerKey);
 		const baseCoin = this.#config.getCoin(pool.baseCoin);
 		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
+		const baseMarginPool = this.#config.getMarginPool(pool.baseCoin);
+		const quoteMarginPool = this.#config.getMarginPool(pool.quoteCoin);
 		const inputQuantity = convertQuantity(quantity, baseCoin.scalar);
-		const marginPool = isBid
-			? this.#config.getMarginPool(pool.baseCoin)
-			: this.#config.getMarginPool(pool.quoteCoin);
-		const debtType = isBid ? baseCoin.type : quoteCoin.type;
 		return tx.moveCall({
-			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::place_reduce_only_market_order`,
+			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::place_reduce_only_market_order_v2`,
 			arguments: [
 				tx.object(this.#config.MARGIN_REGISTRY_ID),
 				tx.object(manager.address),
 				tx.object(pool.address),
-				tx.object(marginPool.address),
+				tx.object(baseMarginPool.address),
+				tx.object(quoteMarginPool.address),
+				tx.object(baseCoin.priceInfoObjectId!),
+				tx.object(quoteCoin.priceInfoObjectId!),
 				tx.pure.u64(clientOrderId),
 				tx.pure.u8(selfMatchingOption),
 				tx.pure.u64(inputQuantity),
@@ -193,7 +217,7 @@ export class PoolProxyContract {
 				tx.pure.bool(payWithDeep),
 				tx.object.clock(),
 			],
-			typeArguments: [baseCoin.type, quoteCoin.type, debtType],
+			typeArguments: [baseCoin.type, quoteCoin.type],
 		});
 	};
 
@@ -427,7 +451,7 @@ export class PoolProxyContract {
 		const baseCoin = this.#config.getCoin(pool.baseCoin);
 		const quoteCoin = this.#config.getCoin(pool.quoteCoin);
 		tx.moveCall({
-			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::claim_rebate`,
+			target: `${this.#config.MARGIN_PACKAGE_ID}::pool_proxy::claim_rebates`,
 			arguments: [
 				tx.object(this.#config.MARGIN_REGISTRY_ID),
 				tx.object(marginManager.address),

package/src/types/index.ts

@@ -232,7 +232,7 @@ export interface PoolConfigParams {
 export interface MarginPoolConfigParams {
 	supplyCap: number | bigint;
 	maxUtilizationRate: number | bigint;
-	referralSpread: number | bigint;
+	protocolSpread: number | bigint;
 	minBorrow: number | bigint;
 	rateLimitCapacity?: number | bigint;
 	rateLimitRefillRatePerMs?: number | bigint;

package/src/utils/config.ts

@@ -49,6 +49,7 @@ export class DeepBookConfig {
 	REGISTRY_ID: string;
 	DEEP_TREASURY_ID: string;
 	MARGIN_PACKAGE_ID: string;
+	MARGIN_V1: string;
 	MARGIN_REGISTRY_ID: string;
 	LIQUIDATION_PACKAGE_ID: string;
 	adminCap?: string;
@@ -97,6 +98,7 @@ export class DeepBookConfig {
 			this.REGISTRY_ID = packageIds.REGISTRY_ID || '';
 			this.DEEP_TREASURY_ID = packageIds.DEEP_TREASURY_ID || '';
 			this.MARGIN_PACKAGE_ID = packageIds.MARGIN_PACKAGE_ID || '';
+			this.MARGIN_V1 = packageIds.MARGIN_V1 || '';
 			this.MARGIN_REGISTRY_ID = packageIds.MARGIN_REGISTRY_ID || '';
 			this.LIQUIDATION_PACKAGE_ID = packageIds.LIQUIDATION_PACKAGE_ID || '';
 			this.#coins = coins || {};
@@ -111,6 +113,7 @@ export class DeepBookConfig {
 			this.REGISTRY_ID = mainnetPackageIds.REGISTRY_ID;
 			this.DEEP_TREASURY_ID = mainnetPackageIds.DEEP_TREASURY_ID;
 			this.MARGIN_PACKAGE_ID = mainnetPackageIds.MARGIN_PACKAGE_ID;
+			this.MARGIN_V1 = mainnetPackageIds.MARGIN_V1;
 			this.MARGIN_REGISTRY_ID = mainnetPackageIds.MARGIN_REGISTRY_ID;
 			this.LIQUIDATION_PACKAGE_ID = mainnetPackageIds.LIQUIDATION_PACKAGE_ID;
 			this.pyth = mainnetPythConfigs;
@@ -122,6 +125,7 @@ export class DeepBookConfig {
 			this.REGISTRY_ID = testnetPackageIds.REGISTRY_ID;
 			this.DEEP_TREASURY_ID = testnetPackageIds.DEEP_TREASURY_ID;
 			this.MARGIN_PACKAGE_ID = testnetPackageIds.MARGIN_PACKAGE_ID;
+			this.MARGIN_V1 = testnetPackageIds.MARGIN_V1;
 			this.MARGIN_REGISTRY_ID = testnetPackageIds.MARGIN_REGISTRY_ID;
 			this.LIQUIDATION_PACKAGE_ID = testnetPackageIds.LIQUIDATION_PACKAGE_ID;
 			this.pyth = testnetPythConfigs;

package/src/utils/constants.ts

@@ -11,6 +11,7 @@ export interface DeepbookPackageIds {
 	REGISTRY_ID?: string;
 	DEEP_TREASURY_ID?: string;
 	MARGIN_PACKAGE_ID?: string;
+	MARGIN_V1?: string;
 	MARGIN_REGISTRY_ID?: string;
 	LIQUIDATION_PACKAGE_ID?: string;
 }
@@ -20,17 +21,19 @@ export const testnetPackageIds = {
 	REGISTRY_ID: '0x7c256edbda983a2cd6f946655f4bf3f00a41043993781f8674a7046e8c0e11d1',
 	DEEP_TREASURY_ID: '0x69fffdae0075f8f71f4fa793549c11079266910e8905169845af1f5d00e09dcb',
 	MARGIN_PACKAGE_ID: '0xd6a42f4df4db73d68cbeb52be66698d2fe6a9464f45ad113ca52b0c6ebd918b6',
+	MARGIN_V1: '0xd6a42f4df4db73d68cbeb52be66698d2fe6a9464f45ad113ca52b0c6ebd918b6',
 	MARGIN_REGISTRY_ID: '0x48d7640dfae2c6e9ceeada197a7a1643984b5a24c55a0c6c023dac77e0339f75',
 	LIQUIDATION_PACKAGE_ID: '0x8d69c3ef3ef580e5bf87b933ce28de19a5d0323588d1a44b9c60b4001741aa24',
 } satisfies DeepbookPackageIds;
 
 export const mainnetPackageIds = {
-	DEEPBOOK_PACKAGE_ID: '0xf48222c4e057fa468baf136bff8e12504209d43850c5778f76159292a96f621e',
+	DEEPBOOK_PACKAGE_ID: '0x0e735f8c93a95722efd73521aca7a7652c0bb71ed1daf41b26dfd7d1ff71f748',
 	REGISTRY_ID: '0xaf16199a2dff736e9f07a845f23c5da6df6f756eddb631aed9d24a93efc4549d',
 	DEEP_TREASURY_ID: '0x032abf8948dda67a271bcc18e776dbbcfb0d58c8d288a700ff0d5521e57a1ffe',
-	MARGIN_PACKAGE_ID: '0xfbd322126f1452fd4c89aedbaeb9fd0c44df9b5cedbe70d76bf80dc086031377',
+	MARGIN_PACKAGE_ID: '0x124bb3d8105d6d301c0d40feaa54d65df6b301e4d8ddd5eb8475b0f8a18cff2e',
+	MARGIN_V1: '0x97d9473771b01f77b0940c589484184b49f6444627ec121314fae6a6d36fb86b',
 	MARGIN_REGISTRY_ID: '0x0e40998b359a9ccbab22a98ed21bd4346abf19158bc7980c8291908086b3a742',
-	LIQUIDATION_PACKAGE_ID: '0x55718c06706bee34c9f3c39f662f10be354a4dcc719699ad72091dc343b641b8',
+	LIQUIDATION_PACKAGE_ID: '0xf17bff1bf21e9587acc5708714e520aa967f82f256f626938a33c4109b08adb9',
 } satisfies DeepbookPackageIds;
 
 export const testnetCoins: CoinMap = {