@mysten/deepbook-v3 2.0.0 → 2.1.3

package/src/contracts/deepbook_predict/lp_book.ts

@@ -0,0 +1,105 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * LP request book and share issuance for the pool vault.
+ *
+ * `LpBook` owns the PLP treasury cap plus the async supply/withdraw queues. `plp`
+ * owns the shared `PoolVault`, valuation, and pool cash accounting; it delegates
+ * request/cancel and frozen-mark queue drains here.
+ */
+
+import { MoveStruct } from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import { U64 } from '../../bcs/integers.js';
+import * as table from './deps/sui/table.js';
+import * as balance from './deps/sui/balance.js';
+import * as coin from './deps/sui/coin.js';
+const $moduleName = '@local-pkg/deepbook_predict::lp_book';
+export const RequestQueue = new MoveStruct({
+	name: `${$moduleName}::RequestQueue<phantom T>`,
+	fields: {
+		pages: table.Table,
+		head_page_id: bcs.option(U64),
+		tail_page_id: bcs.option(U64),
+		next_index: U64,
+		pending: U64,
+		escrow: balance.Balance,
+	},
+});
+export const LpBook = new MoveStruct({
+	name: `${$moduleName}::LpBook<phantom LP>`,
+	fields: {
+		treasury_cap: coin.TreasuryCap,
+		supply_queue: RequestQueue,
+		withdraw_queue: RequestQueue,
+		/**
+		 * Permanent minimum-liquidity shares minted once at genesis (`plp::lock_capital`).
+		 * Held here with no withdraw path, so `total_supply` stays > 0 for the life of the
+		 * pool and the supply==0 bootstrap branch is unreachable. Withdrawal-rounding dust
+		 * accrues to this position.
+		 */
+		locked_lp: balance.Balance,
+	},
+});
+export const RequestEntry = new MoveStruct({
+	name: `${$moduleName}::RequestEntry`,
+	fields: {
+		index: U64,
+		/**
+		 * Owning account, carried so a fill can attribute to the account directly rather
+		 * than only the derived `recipient` address (address is not invertible).
+		 */
+		account_id: bcs.Address,
+		recipient: bcs.Address,
+		amount: U64,
+		min_output: U64,
+		/**
+		 * Frozen marks this request has already missed. Only ever non-zero when the
+		 * protocol allows more than one attempt (`ProtocolConfig`), since at one attempt a
+		 * miss refunds immediately.
+		 */
+		missed_flushes: U64,
+	},
+});
+export const RequestPage = new MoveStruct({
+	name: `${$moduleName}::RequestPage`,
+	fields: {
+		prev: bcs.option(U64),
+		next: bcs.option(U64),
+		entries: bcs.vector(RequestEntry),
+	},
+});
+export const FlushMark = new MoveStruct({
+	name: `${$moduleName}::FlushMark`,
+	fields: {
+		pool_value: U64,
+		total_supply: U64,
+		executable: bcs.bool(),
+	},
+});
+export const FeeRates = new MoveStruct({
+	name: `${$moduleName}::FeeRates`,
+	fields: {
+		/** Supply-leg rate. Ships at zero: a deposit dilutes the pool's risk per dollar. */
+		supply: U64,
+		/** Withdraw-leg rate, frozen with it so one flush charges one pair. */
+		withdraw: U64,
+	},
+});
+export const FillQuote = new MoveStruct({
+	name: `${$moduleName}::FillQuote`,
+	fields: {
+		output: U64,
+		fee: U64,
+	},
+});
+export const DrainSummary = new MoveStruct({
+	name: `${$moduleName}::DrainSummary`,
+	fields: {
+		supplies_filled: U64,
+		withdrawals_filled: U64,
+		requests_processed: U64,
+	},
+});

package/src/contracts/deepbook_predict/market_lifecycle_cap.ts

@@ -0,0 +1,75 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * Defines revocable authority for market creation and coordinated pool valuation
+ * without granting oracle-write or root-admin power. `Registry` owns the allowlist
+ * and converts a valid capability into the ability-less proof consumed by
+ * cross-module lifecycle flows.
+ */
+
+import { MoveStruct, normalizeMoveArguments, type RawTransactionArgument } from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import { type Transaction } from '@mysten/sui/transactions';
+const $moduleName = '@local-pkg/deepbook_predict::market_lifecycle_cap';
+export const MarketLifecycleCap = new MoveStruct({
+	name: `${$moduleName}::MarketLifecycleCap`,
+	fields: {
+		id: bcs.Address,
+	},
+});
+export const MarketLifecycleProof = new MoveStruct({
+	name: `${$moduleName}::MarketLifecycleProof`,
+	fields: {
+		dummy_field: bcs.bool(),
+	},
+});
+export interface IdArguments {
+	cap: RawTransactionArgument<string>;
+}
+export interface IdOptions {
+	package?: string;
+	arguments: IdArguments | [cap: RawTransactionArgument<string>];
+	config?: {
+		predictPackageId?: string;
+	};
+}
+/** Returns the capability identity used by the registry allowlist. */
+export function id(options: IdOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['cap'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'market_lifecycle_cap',
+			function: 'id',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface DestroyArguments {
+	cap: RawTransactionArgument<string>;
+}
+export interface DestroyOptions {
+	package?: string;
+	arguments: DestroyArguments | [cap: RawTransactionArgument<string>];
+	config?: {
+		predictPackageId?: string;
+	};
+}
+/** Destroy a `MarketLifecycleCap` the holder no longer needs. */
+export function destroy(options: DestroyOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['cap'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'market_lifecycle_cap',
+			function: 'destroy',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}

package/src/contracts/deepbook_predict/market_manager.ts

@@ -0,0 +1,218 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * Market identity and deployment cadence manager for Predict.
+ *
+ * `Registry` owns this state and delegates market admission to it. Fixed cadence
+ * IDs, periods, and rank order are upgrade-required. Underlying rows, cadence
+ * deployment terms, and per-underlying watermarks are stored here.
+ */
+
+import { MoveStruct, normalizeMoveArguments } from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import { U64 } from '../../bcs/integers.js';
+import { type Transaction, type TransactionArgument } from '@mysten/sui/transactions';
+import * as table from './deps/sui/table.js';
+const $moduleName = '@local-pkg/deepbook_predict::market_manager';
+export const MarketKey = new MoveStruct({
+	name: `${$moduleName}::MarketKey`,
+	fields: {
+		propbook_underlying_id: bcs.u32(),
+		expiry: U64,
+	},
+});
+export const MarketManager = new MoveStruct({
+	name: `${$moduleName}::MarketManager`,
+	fields: {
+		/** Propbook underlying ID -> deployment watermarks. */
+		underlying_configs: table.Table,
+		/** Created markets keyed by `(propbook_underlying_id, expiry)`. */
+		market_ids: table.Table,
+	},
+});
+export const CadenceConfig = new MoveStruct({
+	name: `${$moduleName}::CadenceConfig`,
+	fields: {
+		/** Raw-price-per-tick factor snapshotted into each created market. */
+		tick_size: U64,
+		/** Coarser raw-price step that new finite mint boundaries must align to. */
+		admission_tick_size: U64,
+		/**
+		 * DUSDC pool allocation cap snapshotted into pool accounting for each created
+		 * expiry.
+		 */
+		max_expiry_allocation: U64,
+		/**
+		 * Minimum DUSDC cash target snapshotted into pool accounting for each created
+		 * expiry.
+		 */
+		initial_expiry_cash: U64,
+		/**
+		 * Number of cadence periods in the rolling future deployment horizon. Zero
+		 * disables this cadence.
+		 */
+		window_size: U64,
+	},
+});
+export const DeployableMarket = new MoveStruct({
+	name: `${$moduleName}::DeployableMarket`,
+	fields: {
+		expiry: U64,
+		cadence: CadenceConfig,
+	},
+});
+export const UnderlyingMarketConfig = new MoveStruct({
+	name: `${$moduleName}::UnderlyingMarketConfig`,
+	fields: {
+		/** Deployment config indexed by cadence ID. */
+		cadences: bcs.vector(CadenceConfig),
+		/** Highest deployed expiry timestamp indexed by cadence ID. */
+		last_deployed_expiries: bcs.vector(U64),
+	},
+});
+export interface CadenceTickSizeArguments {
+	config: TransactionArgument;
+}
+export interface CadenceTickSizeOptions {
+	package?: string;
+	arguments: CadenceTickSizeArguments | [config: TransactionArgument];
+	config?: {
+		predictPackageId?: string;
+	};
+}
+/** Return the raw-price-per-tick factor for SDK and devInspect cadence reads. */
+export function cadenceTickSize(options: CadenceTickSizeOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['config'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'market_manager',
+			function: 'cadence_tick_size',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface CadenceAdmissionTickSizeArguments {
+	config: TransactionArgument;
+}
+export interface CadenceAdmissionTickSizeOptions {
+	package?: string;
+	arguments: CadenceAdmissionTickSizeArguments | [config: TransactionArgument];
+	config?: {
+		predictPackageId?: string;
+	};
+}
+/** Return the admission-grid step for SDK and devInspect cadence reads. */
+export function cadenceAdmissionTickSize(options: CadenceAdmissionTickSizeOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['config'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'market_manager',
+			function: 'cadence_admission_tick_size',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface CadenceMaxExpiryAllocationArguments {
+	config: TransactionArgument;
+}
+export interface CadenceMaxExpiryAllocationOptions {
+	package?: string;
+	arguments: CadenceMaxExpiryAllocationArguments | [config: TransactionArgument];
+	config?: {
+		predictPackageId?: string;
+	};
+}
+/** Return the expiry allocation cap for SDK and devInspect cadence reads. */
+export function cadenceMaxExpiryAllocation(options: CadenceMaxExpiryAllocationOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['config'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'market_manager',
+			function: 'cadence_max_expiry_allocation',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface CadenceInitialExpiryCashArguments {
+	config: TransactionArgument;
+}
+export interface CadenceInitialExpiryCashOptions {
+	package?: string;
+	arguments: CadenceInitialExpiryCashArguments | [config: TransactionArgument];
+	config?: {
+		predictPackageId?: string;
+	};
+}
+/** Return the initial expiry cash target for SDK and devInspect cadence reads. */
+export function cadenceInitialExpiryCash(options: CadenceInitialExpiryCashOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['config'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'market_manager',
+			function: 'cadence_initial_expiry_cash',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface CadenceWindowSizeArguments {
+	config: TransactionArgument;
+}
+export interface CadenceWindowSizeOptions {
+	package?: string;
+	arguments: CadenceWindowSizeArguments | [config: TransactionArgument];
+	config?: {
+		predictPackageId?: string;
+	};
+}
+/** Return the rolling deployment horizon for SDK and devInspect cadence reads. */
+export function cadenceWindowSize(options: CadenceWindowSizeOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['config'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'market_manager',
+			function: 'cadence_window_size',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface CadenceEnabledArguments {
+	config: TransactionArgument;
+}
+export interface CadenceEnabledOptions {
+	package?: string;
+	arguments: CadenceEnabledArguments | [config: TransactionArgument];
+	config?: {
+		predictPackageId?: string;
+	};
+}
+/** Return whether this cadence is enabled for SDK and devInspect discovery. */
+export function cadenceEnabled(options: CadenceEnabledOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['config'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'market_manager',
+			function: 'cadence_enabled',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}

package/src/contracts/deepbook_predict/order.ts

@@ -0,0 +1,24 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * Immutable contract terms encoded in a Predict order ID.
+ *
+ * An `Order` represents the durable contract terms needed after mint: the lower
+ * and higher strike ticks, quantity, and the expiry-local sequence. Mint-only
+ * inputs such as entry probability, premium, and fee policy intentionally live
+ * outside this module. The packed ID is the single source of truth at protocol
+ * boundaries; raw strike conversion (through the owning market's `tick_size`) is
+ * interpreted by `StrikeExposure`.
+ */
+
+import { MoveStruct } from '../utils/index.js';
+import { U256 } from '../../bcs/integers.js';
+const $moduleName = '@local-pkg/deepbook_predict::order';
+export const Order = new MoveStruct({
+	name: `${$moduleName}::Order`,
+	fields: {
+		id: U256,
+	},
+});

package/src/contracts/deepbook_predict/order_events.ts

@@ -0,0 +1,129 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * Order-lifecycle events for Predict.
+ *
+ * Events carry transition identities and deltas rather than account or market
+ * balances. Partial closes link an old order ID to its replacement; the position
+ * root remains constant across that chain.
+ */
+
+import { MoveStruct } from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import { U256, U64 } from '../../bcs/integers.js';
+const $moduleName = '@local-pkg/deepbook_predict::order_events';
+export const OrderMinted = new MoveStruct({
+	name: `${$moduleName}::OrderMinted`,
+	fields: {
+		expiry_market_id: bcs.Address,
+		account_id: bcs.Address,
+		order_id: U256,
+		/**
+		 * Stable economic-position handle: the original mint's `order_id`, carried forward
+		 * unchanged across partial-close replacements. Equals `order_id` here.
+		 */
+		position_root_id: U256,
+		owner: bcs.Address,
+		/**
+		 * Canonical strike range as absolute ticks: `lower_tick` (`0` = `-inf`) and
+		 * `higher_tick` (`pos_inf_tick` = `+inf`). Raw strikes are the derived display
+		 * form, `tick * tick_size` with the `tick_size` from `MarketCreated`.
+		 */
+		lower_tick: U64,
+		higher_tick: U64,
+		/** 1e9-scaled range probability quoted at entry. */
+		entry_probability: U64,
+		quantity: U64,
+		/** Premium the user paid into LP backing, in DUSDC base units. */
+		premium: U64,
+		/** Full trading fee assessed for the mint, including any sponsor-paid subsidy. */
+		trading_fee: U64,
+		/** Portion of `trading_fee` paid from expiry-local fee incentives. */
+		fee_incentive_subsidy: U64,
+		builder_fee: U64,
+		/** EWMA gas-price congestion surcharge assessed for the mint, in DUSDC base units. */
+		penalty_fee: U64,
+		/**
+		 * Portion of the trader-paid trading fee and congestion surcharge delivered to the
+		 * referrer.
+		 */
+		referral_fee: U64,
+		/** Separate inventory-impact charge escrowed for live-close rebates. */
+		inventory_impact_charge: U64,
+		/**
+		 * Builder credited for `builder_fee`; `none` when no builder fee was paid
+		 * (attribution follows the fee — applied once, in the emit helper).
+		 */
+		builder_code_id: bcs.option(bcs.Address),
+		/** Referrer recorded on the minting account, independent of the fee paid. */
+		referrer_account_id: bcs.option(bcs.Address),
+		onchain_timestamp_ms: U64,
+		/**
+		 * Oracle source timestamps present when this mint was priced: Pyth's canonical
+		 * source time and the Block Scholes batch-envelope times used for freshness. The
+		 * SVI one is also the roll-down anchor. Pyth is `0` only when unusable.
+		 */
+		pyth_spot_source_timestamp_ms: U64,
+		block_scholes_spot_source_timestamp_ms: U64,
+		block_scholes_forward_source_timestamp_ms: U64,
+		block_scholes_svi_source_timestamp_ms: U64,
+	},
+});
+export const LiveOrderRedeemed = new MoveStruct({
+	name: `${$moduleName}::LiveOrderRedeemed`,
+	fields: {
+		expiry_market_id: bcs.Address,
+		account_id: bcs.Address,
+		order_id: U256,
+		/**
+		 * Stable economic-position handle, constant across the replacement chain. On a
+		 * partial close the replacement inherits this same root.
+		 */
+		position_root_id: U256,
+		owner: bcs.Address,
+		quantity_closed: U64,
+		/** `0` means the position was fully closed. */
+		remaining_quantity: U64,
+		/** New order ID minted to carry the remainder on a partial live close. */
+		replacement_order_id: bcs.option(U256),
+		/** Redeem value before fees. */
+		redeem_amount: U64,
+		trading_fee: U64,
+		builder_fee: U64,
+		/** EWMA gas-price congestion surcharge retained by the pool, in DUSDC base units. */
+		penalty_fee: U64,
+		/** Separate inventory-impact rebate paid from its isolated escrow. */
+		inventory_impact_rebate: U64,
+		/**
+		 * Builder credited for `builder_fee`; `none` when no builder fee was paid
+		 * (attribution follows the fee — applied once, in the emit helper).
+		 */
+		builder_code_id: bcs.option(bcs.Address),
+		onchain_timestamp_ms: U64,
+		/**
+		 * Oracle source timestamps present when this redemption was priced: Pyth's
+		 * canonical source time and the Block Scholes batch-envelope times used for
+		 * freshness. The SVI one is also the roll-down anchor. Pyth is `0` only when
+		 * unusable.
+		 */
+		pyth_spot_source_timestamp_ms: U64,
+		block_scholes_spot_source_timestamp_ms: U64,
+		block_scholes_forward_source_timestamp_ms: U64,
+		block_scholes_svi_source_timestamp_ms: U64,
+	},
+});
+export const SettledOrderRedeemed = new MoveStruct({
+	name: `${$moduleName}::SettledOrderRedeemed`,
+	fields: {
+		expiry_market_id: bcs.Address,
+		account_id: bcs.Address,
+		order_id: U256,
+		/** Stable economic-position handle, constant across the replacement chain. */
+		position_root_id: U256,
+		owner: bcs.Address,
+		payout_amount: U64,
+		onchain_timestamp_ms: U64,
+	},
+});

package/src/contracts/deepbook_predict/pause_cap.ts

@@ -0,0 +1,68 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * Defines revocable emergency authority that can engage global trading or
+ * per-market mint pauses but cannot unpause. `Registry` owns the allowlist and all
+ * state transitions authorized by this capability.
+ */
+
+import { MoveStruct, normalizeMoveArguments, type RawTransactionArgument } from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import { type Transaction } from '@mysten/sui/transactions';
+const $moduleName = '@local-pkg/deepbook_predict::pause_cap';
+export const PauseCap = new MoveStruct({
+	name: `${$moduleName}::PauseCap`,
+	fields: {
+		id: bcs.Address,
+	},
+});
+export interface IdArguments {
+	cap: RawTransactionArgument<string>;
+}
+export interface IdOptions {
+	package?: string;
+	arguments: IdArguments | [cap: RawTransactionArgument<string>];
+	config?: {
+		predictPackageId?: string;
+	};
+}
+/** Returns the capability identity used by the registry allowlist. */
+export function id(options: IdOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['cap'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'pause_cap',
+			function: 'id',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface DestroyArguments {
+	cap: RawTransactionArgument<string>;
+}
+export interface DestroyOptions {
+	package?: string;
+	arguments: DestroyArguments | [cap: RawTransactionArgument<string>];
+	config?: {
+		predictPackageId?: string;
+	};
+}
+/** Destroy a `PauseCap` the holder no longer needs. */
+export function destroy(options: DestroyOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['cap'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'pause_cap',
+			function: 'destroy',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}