@mysten/deepbook-v3 2.0.0 → 2.1.3

package/src/contracts/deepbook_predict/pool_accounting.ts

@@ -0,0 +1,79 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * Pool-owned expiry registration and cash-flow accounting.
+ *
+ * This module owns pool idle DUSDC custody, the durable set of expiries registered
+ * to a pool, the active expiry index used for valuation, DUSDC sent from the main
+ * pool into each expiry, DUSDC received back from each expiry, snapshotted
+ * lifetime fee-incentive caps and allocations, terminal cash watermarks, and
+ * per-expiry cap checks. It does not classify expiry-local liabilities or apply
+ * PLP reserve policy; PoolVault uses the aggregate profit basis to price PLP and
+ * decide protocol reserve transfers.
+ */
+
+import { MoveStruct } from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import { U64 } from '../../bcs/integers.js';
+import * as balance from './deps/sui/balance.js';
+import * as table from './deps/sui/table.js';
+const $moduleName = '@local-pkg/deepbook_predict::pool_accounting';
+export const ActiveExpiry = new MoveStruct({
+	name: `${$moduleName}::ActiveExpiry`,
+	fields: {
+		expiry_market_id: bcs.Address,
+		expiry_ms: U64,
+	},
+});
+export const Ledger = new MoveStruct({
+	name: `${$moduleName}::Ledger`,
+	fields: {
+		/** Idle LP-owned DUSDC available for withdrawals and expiry funding. */
+		idle_balance: balance.Balance,
+		/** Expiry markets that still contribute active pool valuation/risk. */
+		active_expiry_markets: bcs.vector(ActiveExpiry),
+		/**
+		 * Permanent per-expiry accounting rows. Presence means the expiry belongs to this
+		 * pool.
+		 */
+		registered_expiries: table.Table,
+		/** Pricing debit basis: DUSDC sent to expiries plus materialized terminal profit. */
+		profit_basis_debits: U64,
+		/** Pricing credit basis: all DUSDC received back from expiries. */
+		profit_basis_credits: U64,
+		/**
+		 * Aggregate terminal losses that later terminal profits must recover first; losses
+		 * do not claw back profit that was already materialized.
+		 */
+		net_losses_to_fill: U64,
+		/**
+		 * Protocol profit already materialized into the debit basis but not yet physically
+		 * moved to the reserve because idle was deployed in other active markets at
+		 * materialization. Excluded from LP value until drained.
+		 */
+		pending_protocol_profit: U64,
+	},
+});
+export const RegisteredExpiry = new MoveStruct({
+	name: `${$moduleName}::RegisteredExpiry`,
+	fields: {
+		/** DUSDC pool allocation cap snapshotted when this expiry was created. */
+		max_expiry_allocation: U64,
+		/** Minimum DUSDC cash target snapshotted when this expiry was created. */
+		initial_expiry_cash: U64,
+		/** DUSDC sent from the main pool into this expiry. */
+		sent_to_expiry: U64,
+		/** DUSDC returned from this expiry to the main pool. */
+		received_from_expiry: U64,
+		/** Absolute lifetime fee-incentive cap snapshotted when this expiry was registered. */
+		fee_incentive_lifetime_cap: U64,
+		/** Lifetime sponsor-funded fee incentives allocated to this expiry. */
+		fee_incentives_allocated: U64,
+		/** True once this expiry has started terminal profit/loss accounting. */
+		terminal_accounting_started: bcs.bool(),
+		/** Received amount already consumed by terminal accounting. */
+		terminal_received_watermark: U64,
+	},
+});

package/src/contracts/deepbook_predict/predict_account.ts

@@ -0,0 +1,180 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * Predict's per-account state, stored as an app-data slot on a shared `Account`
+ * (the `account` package).
+ *
+ * This is Predict's account-local state: open positions and sticky builder-code
+ * attribution. DUSDC/PLP custody lives in `Account`. The `PredictApp` witness
+ * namespaces this slot, so only Predict writes it.
+ *
+ * Position mutations are package-internal. Builder-code configuration accepts an
+ * account `Auth`; the account package decides which owner or authorized
+ * application may obtain that mutable borrow.
+ */
+
+import {
+	MoveTuple,
+	MoveStruct,
+	normalizeMoveArguments,
+	type RawTransactionArgument,
+} from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import { U256, 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::predict_account';
+export const PredictApp = new MoveTuple({
+	name: `${$moduleName}::PredictApp`,
+	fields: [bcs.bool()],
+});
+export const PositionKey = new MoveStruct({
+	name: `${$moduleName}::PositionKey`,
+	fields: {
+		expiry_market_id: bcs.Address,
+		order_id: U256,
+	},
+});
+export const Position = new MoveStruct({
+	name: `${$moduleName}::Position`,
+	fields: {
+		/** Root order ID, carried forward unchanged across partial-close replacements. */
+		root_id: U256,
+		/**
+		 * On-chain time (`clock.timestamp_ms()`) the position was opened, carried forward
+		 * unchanged across partial-close replacements. A live redeem in the same timestamp
+		 * is rejected, blocking an atomic mint -> oracle-update -> redeem in one
+		 * transaction.
+		 */
+		opened_at_ms: U64,
+	},
+});
+export const PredictData = new MoveStruct({
+	name: `${$moduleName}::PredictData`,
+	fields: {
+		/** Open positions scoped by expiry market. */
+		positions: table.Table,
+		/** Sticky builder-code attribution for future trades, if set. */
+		builder_code_id: bcs.option(bcs.Address),
+	},
+});
+export interface HasPositionArguments {
+	account: TransactionArgument;
+	expiryMarketId: RawTransactionArgument<string>;
+	orderId: RawTransactionArgument<number | bigint>;
+}
+export interface HasPositionOptions {
+	package?: string;
+	arguments:
+		| HasPositionArguments
+		| [
+				account: TransactionArgument,
+				expiryMarketId: RawTransactionArgument<string>,
+				orderId: RawTransactionArgument<number | bigint>,
+		  ];
+	config?: {
+		predictPackageId?: string;
+	};
+}
+/** Return whether an account holds a position for SDK and devInspect state reads. */
+export function hasPosition(options: HasPositionOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null, '0x2::object::ID', 'u256'] satisfies (string | null)[];
+	const parameterNames = ['account', 'expiryMarketId', 'orderId'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'predict_account',
+			function: 'has_position',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface BuilderCodeIdArguments {
+	account: TransactionArgument;
+}
+export interface BuilderCodeIdOptions {
+	package?: string;
+	arguments: BuilderCodeIdArguments | [account: TransactionArgument];
+	config?: {
+		predictPackageId?: string;
+	};
+}
+/** Return the sticky builder-code ID, if set. */
+export function builderCodeId(options: BuilderCodeIdOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['account'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'predict_account',
+			function: 'builder_code_id',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface SetBuilderCodeArguments {
+	wrapper: RawTransactionArgument<string>;
+	auth: TransactionArgument;
+	code: RawTransactionArgument<string>;
+}
+export interface SetBuilderCodeOptions {
+	package?: string;
+	arguments:
+		| SetBuilderCodeArguments
+		| [
+				wrapper: RawTransactionArgument<string>,
+				auth: TransactionArgument,
+				code: RawTransactionArgument<string>,
+		  ];
+	config?: {
+		predictPackageId?: string;
+	};
+}
+/**
+ * Set sticky builder-code attribution for future trades using valid account auth.
+ * Owner auth and authorized-app auth both satisfy the account borrow boundary.
+ */
+export function setBuilderCode(options: SetBuilderCodeOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null, null, null] satisfies (string | null)[];
+	const parameterNames = ['wrapper', 'auth', 'code'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'predict_account',
+			function: 'set_builder_code',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface UnsetBuilderCodeArguments {
+	wrapper: RawTransactionArgument<string>;
+	auth: TransactionArgument;
+}
+export interface UnsetBuilderCodeOptions {
+	package?: string;
+	arguments:
+		| UnsetBuilderCodeArguments
+		| [wrapper: RawTransactionArgument<string>, auth: TransactionArgument];
+	config?: {
+		predictPackageId?: string;
+	};
+}
+/** Clear sticky builder-code attribution using valid owner or authorized-app auth. */
+export function unsetBuilderCode(options: UnsetBuilderCodeOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null, null] satisfies (string | null)[];
+	const parameterNames = ['wrapper', 'auth'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'predict_account',
+			function: 'unset_builder_code',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}

package/src/contracts/deepbook_predict/pricing.ts

@@ -0,0 +1,124 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * Pricing for Predict markets.
+ *
+ * This module reads canonical Propbook Pyth and Block Scholes feeds and computes
+ * SVI-adjusted digital probabilities. Live reads require fresh, pricing-safe Block
+ * Scholes spot, forward, and SVI observations. The live forward comes from one of
+ * two admin-selected sources (`PricingConfig.use_pyth_spot_for_forward`): a fresh
+ * positive Pyth spot carrying the Block Scholes basis, or the Block Scholes
+ * forward directly. Exact-history reads do not apply live freshness policy.
+ */
+
+import { MoveStruct, normalizeMoveArguments } from '../utils/index.js';
+import { U128, U64 } from '../../bcs/integers.js';
+import { bcs } from '@mysten/sui/bcs';
+import { type Transaction, type TransactionArgument } from '@mysten/sui/transactions';
+import * as i64 from './deps/fixed_math/i64.js';
+const $moduleName = '@local-pkg/deepbook_predict::pricing';
+export const PricingSVI = new MoveStruct({
+	name: `${$moduleName}::PricingSVI`,
+	fields: {
+		/** Rolled-down SVI `a`, magnitude at 1e18, sign in `a_is_negative`. */
+		a_magnitude: U128,
+		a_is_negative: bcs.bool(),
+		/** Rolled-down SVI `b`, at 1e18. */
+		b: U128,
+		rho: i64.I64,
+		m: i64.I64,
+		sigma: U64,
+	},
+});
+export const Pricer = new MoveStruct({
+	name: `${$moduleName}::Pricer`,
+	fields: {
+		/** Expiry market this snapshot was loaded for. */
+		expiry_market_id: bcs.Address,
+		forward: U64,
+		svi: PricingSVI,
+		/**
+		 * Timestamps of the oracle observations this snapshot validated, as trade events
+		 * report them — each observation's own economic clock. Pyth carries its source
+		 * timestamp (`0` only when no usable normalized observation exists); the Block
+		 * Scholes reads carry their batch envelope time (`source_timestamp_ms`), the clock
+		 * freshness gated and the SVI roll-down anchored on. The provider's calibration
+		 * (model) times stay on the stored observations and their ingestion events.
+		 */
+		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 RawSVI = new MoveStruct({
+	name: `${$moduleName}::RawSVI`,
+	fields: {
+		a: i64.I64,
+		b: U64,
+		rho: i64.I64,
+		m: i64.I64,
+		sigma: U64,
+	},
+});
+export interface UpPriceArguments {
+	pricer: TransactionArgument;
+	strike: TransactionArgument;
+}
+export interface UpPriceOptions {
+	package?: string;
+	arguments: UpPriceArguments | [pricer: TransactionArgument, strike: TransactionArgument];
+	config?: {
+		predictPackageId?: string;
+	};
+}
+/**
+ * Return the current UP digital probability for a typed strike. Public PTB and
+ * devInspect reads can compose it with a transaction-local `Pricer`.
+ */
+export function upPrice(options: UpPriceOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null, null] satisfies (string | null)[];
+	const parameterNames = ['pricer', 'strike'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'pricing',
+			function: 'up_price',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface RangePriceArguments {
+	pricer: TransactionArgument;
+	lower: TransactionArgument;
+	higher: TransactionArgument;
+}
+export interface RangePriceOptions {
+	package?: string;
+	arguments:
+		| RangePriceArguments
+		| [pricer: TransactionArgument, lower: TransactionArgument, higher: TransactionArgument];
+	config?: {
+		predictPackageId?: string;
+	};
+}
+/**
+ * Return the current probability for `(lower, higher]`, floored at zero if the two
+ * approximated boundary probabilities invert.
+ */
+export function rangePrice(options: RangePriceOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null, null, null] satisfies (string | null)[];
+	const parameterNames = ['pricer', 'lower', 'higher'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'pricing',
+			function: 'range_price',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}

package/src/contracts/deepbook_predict/pricing_config.ts

@@ -0,0 +1,41 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * Stored oracle source-selection and freshness config for Predict quotes.
+ *
+ * ProtocolConfig owns this mutable policy. Pricing reads it when resolving live
+ * probabilities for mint and redeem flows.
+ */
+
+import { MoveStruct } from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import { U64 } from '../../bcs/integers.js';
+const $moduleName = '@local-pkg/deepbook_predict::pricing_config';
+export const PricingConfig = new MoveStruct({
+	name: `${$moduleName}::PricingConfig`,
+	fields: {
+		/**
+		 * Selects which live-forward formula pricing uses. True carries the Block Scholes
+		 * basis on a fresh Pyth spot (`pyth_spot * bs_forward / bs_spot`); false uses the
+		 * Block Scholes forward directly and no Pyth spot, fresh or not, moves a quote.
+		 */
+		use_pyth_spot_for_forward: bcs.bool(),
+		/**
+		 * Fixed wall-clock maximum age for Pyth spot; it does not vary with time to
+		 * expiry.
+		 */
+		pyth_spot_freshness_ms: U64,
+		/**
+		 * Fixed wall-clock maximum age for Block Scholes spot and forward; it does not
+		 * vary with time to expiry.
+		 */
+		block_scholes_price_freshness_ms: U64,
+		/**
+		 * Fixed wall-clock maximum age for Block Scholes SVI parameters; it does not vary
+		 * with time to expiry.
+		 */
+		block_scholes_svi_freshness_ms: U64,
+	},
+});