@mysten/deepbook-v3 1.5.9 → 1.6.2

package/dist/contracts/deepbook_margin/pool_proxy.mjs

@@ -0,0 +1,644 @@
+import { normalizeMoveArguments } from "../utils/index.mjs";
+
+//#region src/contracts/deepbook_margin/pool_proxy.ts
+/**
+* Updates the current price for a pool using safe oracle price calculation. Anyone
+* can call this to update the price oracle used for order validation.
+*/
+function updateCurrentPrice(options) {
+	const packageAddress = options.package ?? "@deepbook/margin";
+	const argumentsTypes = [
+		null,
+		null,
+		null,
+		null,
+		"0x2::clock::Clock"
+	];
+	const parameterNames = [
+		"registry",
+		"pool",
+		"basePriceInfoObject",
+		"quotePriceInfoObject"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "pool_proxy",
+		function: "update_current_price",
+		arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		typeArguments: options.typeArguments
+	});
+}
+/** Places a limit order in the pool. */
+function placeLimitOrderV2(options) {
+	const packageAddress = options.package ?? "@deepbook/margin";
+	const argumentsTypes = [
+		null,
+		null,
+		null,
+		null,
+		null,
+		null,
+		null,
+		"u64",
+		"u8",
+		"u8",
+		"u64",
+		"u64",
+		"bool",
+		"bool",
+		"u64",
+		"0x2::clock::Clock"
+	];
+	const parameterNames = [
+		"registry",
+		"marginManager",
+		"pool",
+		"baseMarginPool",
+		"quoteMarginPool",
+		"baseOracle",
+		"quoteOracle",
+		"clientOrderId",
+		"orderType",
+		"selfMatchingOption",
+		"price",
+		"quantity",
+		"isBid",
+		"payWithDeep",
+		"expireTimestamp"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "pool_proxy",
+		function: "place_limit_order_v2",
+		arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		typeArguments: options.typeArguments
+	});
+}
+/** Places a market order in the pool. */
+function placeMarketOrderV2(options) {
+	const packageAddress = options.package ?? "@deepbook/margin";
+	const argumentsTypes = [
+		null,
+		null,
+		null,
+		null,
+		null,
+		null,
+		null,
+		"u64",
+		"u8",
+		"u64",
+		"bool",
+		"bool",
+		"0x2::clock::Clock"
+	];
+	const parameterNames = [
+		"registry",
+		"marginManager",
+		"pool",
+		"baseMarginPool",
+		"quoteMarginPool",
+		"baseOracle",
+		"quoteOracle",
+		"clientOrderId",
+		"selfMatchingOption",
+		"quantity",
+		"isBid",
+		"payWithDeep"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "pool_proxy",
+		function: "place_market_order_v2",
+		arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		typeArguments: options.typeArguments
+	});
+}
+/** Places a reduce-only order in the pool. Used when margin trading is disabled. */
+function placeReduceOnlyLimitOrderV2(options) {
+	const packageAddress = options.package ?? "@deepbook/margin";
+	const argumentsTypes = [
+		null,
+		null,
+		null,
+		null,
+		null,
+		null,
+		null,
+		"u64",
+		"u8",
+		"u8",
+		"u64",
+		"u64",
+		"bool",
+		"bool",
+		"u64",
+		"0x2::clock::Clock"
+	];
+	const parameterNames = [
+		"registry",
+		"marginManager",
+		"pool",
+		"baseMarginPool",
+		"quoteMarginPool",
+		"baseOracle",
+		"quoteOracle",
+		"clientOrderId",
+		"orderType",
+		"selfMatchingOption",
+		"price",
+		"quantity",
+		"isBid",
+		"payWithDeep",
+		"expireTimestamp"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "pool_proxy",
+		function: "place_reduce_only_limit_order_v2",
+		arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		typeArguments: options.typeArguments
+	});
+}
+/**
+* Places a reduce-only market order in the pool. Used when margin trading is
+* disabled.
+*
+* Superseded by `place_reduce_only_market_order_and_repay_loan`. A market (taker)
+* fill always pays the spread, which lowers the oracle-valued `risk_ratio` while
+* the debt is unchanged, so the swap-only monotonic check here rejects essentially
+* every taker fill. The `_and_repay` variant deleverages with the proceeds so the
+* net-state ratio actually improves. Kept callable for existing integrators; its
+* reduce-only _direction_ guard matches the other entries — a bid needs base
+* (short-side) debt, the ask needs quote (long-side) debt and sells up to gross
+* base held — with no size cap.
+*/
+function placeReduceOnlyMarketOrderV2(options) {
+	const packageAddress = options.package ?? "@deepbook/margin";
+	const argumentsTypes = [
+		null,
+		null,
+		null,
+		null,
+		null,
+		null,
+		null,
+		"u64",
+		"u8",
+		"u64",
+		"bool",
+		"bool",
+		"0x2::clock::Clock"
+	];
+	const parameterNames = [
+		"registry",
+		"marginManager",
+		"pool",
+		"baseMarginPool",
+		"quoteMarginPool",
+		"baseOracle",
+		"quoteOracle",
+		"clientOrderId",
+		"selfMatchingOption",
+		"quantity",
+		"isBid",
+		"payWithDeep"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "pool_proxy",
+		function: "place_reduce_only_market_order_v2",
+		arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		typeArguments: options.typeArguments
+	});
+}
+/**
+* Atomically winds down a leveraged position: places a reduce-only market order,
+* repays the loan with the proceeds, then requires the net (post-repay) risk ratio
+* to be at least the pre-trade ratio.
+*
+* The post-repay check is the point. A market close pays the spread, which alone
+* lowers the oracle-valued ratio (debt is unchanged until repay) and would abort
+* the plain reduce-only path. Repaying first deleverages and absorbs the slippage
+* (still bounded by the `assert_price` band), and lets a manager in the
+* `liquidation..min_borrow` band climb out — it cannot reach the borrow floor in a
+* single swap.
+*/
+function placeReduceOnlyMarketOrderAndRepayLoan(options) {
+	const packageAddress = options.package ?? "@deepbook/margin";
+	const argumentsTypes = [
+		null,
+		null,
+		null,
+		null,
+		null,
+		null,
+		null,
+		"u64",
+		"u8",
+		"u64",
+		"bool",
+		"bool",
+		"0x2::clock::Clock"
+	];
+	const parameterNames = [
+		"registry",
+		"marginManager",
+		"pool",
+		"baseMarginPool",
+		"quoteMarginPool",
+		"baseOracle",
+		"quoteOracle",
+		"clientOrderId",
+		"selfMatchingOption",
+		"quantity",
+		"isBid",
+		"payWithDeep"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "pool_proxy",
+		function: "place_reduce_only_market_order_and_repay_loan",
+		arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		typeArguments: options.typeArguments
+	});
+}
+/**
+* Reduce-only **limit** order that atomically repays the loan with the taker
+* fills. It is the limit/maker behaviour of `place_reduce_only_limit_order_v2`
+* plus the repay-then-net-monotonic gate of
+* `place_reduce_only_market_order_and_repay_loan`: the portion that crosses the
+* book fills immediately and settles, the rest rests as a maker, then the settled
+* (taker) proceeds repay the debt before the monotonic check on the net
+* (post-repay) state.
+*
+* This is the danger-band tool for a _price-bounded_ reduce: a crossing
+* reduce-only limit pays the spread on its taker fills, which alone would abort
+* `place_reduce_only_limit_order_v2`'s swap-only monotonic check; repaying first
+* deleverages so the net ratio holds. The resting remainder only locks balance
+* (counted in assets), so it doesn't move the ratio. Unfilled-and-resting behaves
+* exactly like `place_reduce_only_limit_order_v2` (nothing to repay).
+*/
+function placeReduceOnlyLimitOrderAndRepayLoan(options) {
+	const packageAddress = options.package ?? "@deepbook/margin";
+	const argumentsTypes = [
+		null,
+		null,
+		null,
+		null,
+		null,
+		null,
+		null,
+		"u64",
+		"u8",
+		"u8",
+		"u64",
+		"u64",
+		"bool",
+		"bool",
+		"u64",
+		"0x2::clock::Clock"
+	];
+	const parameterNames = [
+		"registry",
+		"marginManager",
+		"pool",
+		"baseMarginPool",
+		"quoteMarginPool",
+		"baseOracle",
+		"quoteOracle",
+		"clientOrderId",
+		"orderType",
+		"selfMatchingOption",
+		"price",
+		"quantity",
+		"isBid",
+		"payWithDeep",
+		"expireTimestamp"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "pool_proxy",
+		function: "place_reduce_only_limit_order_and_repay_loan",
+		arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		typeArguments: options.typeArguments
+	});
+}
+/**
+* Atomically places a market order and repays the loan with the proceeds, gating
+* on a **monotonic** net-state check: if any debt remains after the repay, the
+* post-repay `risk_ratio` must be at least the pre-trade ratio (improve-or-hold).
+* A full close drives debt to 0 (`risk_ratio` MAX), which always passes.
+*
+* This is the everyday close / deleverage tool. The monotonic gate — rather than
+* the `min_open` opening floor used by `place_market_order_v2` — lets a position
+* in the `liquidation..min_borrow` danger band wind down _partially_: a small
+* close that lifts the ratio from, say, 1.12 to 1.15 is allowed even though 1.15
+* is still below `min_open`, which the opening floor would reject.
+*
+* Not reduce-only and uncapped, but the monotonic check makes a quantity cap
+* unnecessary: a market (taker) fill settles immediately, so any genuinely
+* exposure-_increasing_ trade lowers the ratio and aborts here, while any
+* deleveraging trade is allowed at any size — an overshoot past the debt is fine
+* (surplus is the manager's own holding) and `assert_price` still bounds slippage.
+* Requires margin trading enabled; in reduce-only mode use
+* `place_reduce_only_market_order_and_repay_loan`.
+*/
+function placeMarketOrderAndRepayLoan(options) {
+	const packageAddress = options.package ?? "@deepbook/margin";
+	const argumentsTypes = [
+		null,
+		null,
+		null,
+		null,
+		null,
+		null,
+		null,
+		"u64",
+		"u8",
+		"u64",
+		"bool",
+		"bool",
+		"0x2::clock::Clock"
+	];
+	const parameterNames = [
+		"registry",
+		"marginManager",
+		"pool",
+		"baseMarginPool",
+		"quoteMarginPool",
+		"baseOracle",
+		"quoteOracle",
+		"clientOrderId",
+		"selfMatchingOption",
+		"quantity",
+		"isBid",
+		"payWithDeep"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "pool_proxy",
+		function: "place_market_order_and_repay_loan",
+		arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		typeArguments: options.typeArguments
+	});
+}
+/** Modifies an order */
+function modifyOrder(options) {
+	const packageAddress = options.package ?? "@deepbook/margin";
+	const argumentsTypes = [
+		null,
+		null,
+		null,
+		"u128",
+		"u64",
+		"0x2::clock::Clock"
+	];
+	const parameterNames = [
+		"registry",
+		"marginManager",
+		"pool",
+		"orderId",
+		"newQuantity"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "pool_proxy",
+		function: "modify_order",
+		arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		typeArguments: options.typeArguments
+	});
+}
+/** Cancels an order */
+function cancelOrder(options) {
+	const packageAddress = options.package ?? "@deepbook/margin";
+	const argumentsTypes = [
+		null,
+		null,
+		null,
+		"u128",
+		"0x2::clock::Clock"
+	];
+	const parameterNames = [
+		"registry",
+		"marginManager",
+		"pool",
+		"orderId"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "pool_proxy",
+		function: "cancel_order",
+		arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		typeArguments: options.typeArguments
+	});
+}
+/** Cancel multiple orders within a vector. */
+function cancelOrders(options) {
+	const packageAddress = options.package ?? "@deepbook/margin";
+	const argumentsTypes = [
+		null,
+		null,
+		null,
+		"vector<u128>",
+		"0x2::clock::Clock"
+	];
+	const parameterNames = [
+		"registry",
+		"marginManager",
+		"pool",
+		"orderIds"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "pool_proxy",
+		function: "cancel_orders",
+		arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		typeArguments: options.typeArguments
+	});
+}
+/** Cancels all orders for the given account. */
+function cancelAllOrders(options) {
+	const packageAddress = options.package ?? "@deepbook/margin";
+	const argumentsTypes = [
+		null,
+		null,
+		null,
+		"0x2::clock::Clock"
+	];
+	const parameterNames = [
+		"registry",
+		"marginManager",
+		"pool"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "pool_proxy",
+		function: "cancel_all_orders",
+		arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		typeArguments: options.typeArguments
+	});
+}
+/** Withdraw settled amounts to balance_manager. */
+function withdrawSettledAmounts(options) {
+	const packageAddress = options.package ?? "@deepbook/margin";
+	const argumentsTypes = [
+		null,
+		null,
+		null
+	];
+	const parameterNames = [
+		"registry",
+		"marginManager",
+		"pool"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "pool_proxy",
+		function: "withdraw_settled_amounts",
+		arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		typeArguments: options.typeArguments
+	});
+}
+/**
+* Withdraw settled amounts to balance_manager permissionlessly. Anyone can call
+* this function to settle balances for a margin manager.
+*/
+function withdrawSettledAmountsPermissionless(options) {
+	const packageAddress = options.package ?? "@deepbook/margin";
+	const argumentsTypes = [
+		null,
+		null,
+		null
+	];
+	const parameterNames = [
+		"registry",
+		"marginManager",
+		"pool"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "pool_proxy",
+		function: "withdraw_settled_amounts_permissionless",
+		arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		typeArguments: options.typeArguments
+	});
+}
+/** Stake DEEP tokens to the pool. */
+function stake(options) {
+	const packageAddress = options.package ?? "@deepbook/margin";
+	const argumentsTypes = [
+		null,
+		null,
+		null,
+		"u64"
+	];
+	const parameterNames = [
+		"registry",
+		"marginManager",
+		"pool",
+		"amount"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "pool_proxy",
+		function: "stake",
+		arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		typeArguments: options.typeArguments
+	});
+}
+/** Unstake DEEP tokens from the pool. */
+function unstake(options) {
+	const packageAddress = options.package ?? "@deepbook/margin";
+	const argumentsTypes = [
+		null,
+		null,
+		null
+	];
+	const parameterNames = [
+		"registry",
+		"marginManager",
+		"pool"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "pool_proxy",
+		function: "unstake",
+		arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		typeArguments: options.typeArguments
+	});
+}
+/** Submit proposal using the margin manager. */
+function submitProposal(options) {
+	const packageAddress = options.package ?? "@deepbook/margin";
+	const argumentsTypes = [
+		null,
+		null,
+		null,
+		"u64",
+		"u64",
+		"u64"
+	];
+	const parameterNames = [
+		"registry",
+		"marginManager",
+		"pool",
+		"takerFee",
+		"makerFee",
+		"stakeRequired"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "pool_proxy",
+		function: "submit_proposal",
+		arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		typeArguments: options.typeArguments
+	});
+}
+/** Vote on a proposal using the margin manager. */
+function vote(options) {
+	const packageAddress = options.package ?? "@deepbook/margin";
+	const argumentsTypes = [
+		null,
+		null,
+		null,
+		"0x2::object::ID"
+	];
+	const parameterNames = [
+		"registry",
+		"marginManager",
+		"pool",
+		"proposalId"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "pool_proxy",
+		function: "vote",
+		arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		typeArguments: options.typeArguments
+	});
+}
+function claimRebates(options) {
+	const packageAddress = options.package ?? "@deepbook/margin";
+	const argumentsTypes = [
+		null,
+		null,
+		null
+	];
+	const parameterNames = [
+		"registry",
+		"marginManager",
+		"pool"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "pool_proxy",
+		function: "claim_rebates",
+		arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		typeArguments: options.typeArguments
+	});
+}
+
+//#endregion
+export { cancelAllOrders, cancelOrder, cancelOrders, claimRebates, modifyOrder, placeLimitOrderV2, placeMarketOrderAndRepayLoan, placeMarketOrderV2, placeReduceOnlyLimitOrderAndRepayLoan, placeReduceOnlyLimitOrderV2, placeReduceOnlyMarketOrderAndRepayLoan, placeReduceOnlyMarketOrderV2, stake, submitProposal, unstake, updateCurrentPrice, vote, withdrawSettledAmounts, withdrawSettledAmountsPermissionless };
+//# sourceMappingURL=pool_proxy.mjs.map