@mysten/deepbook-v3 2.8.2 → 2.9.0

package/dist/transactions/poolProxy.d.mts

@@ -1,6 +1,6 @@
 import { MarginProposalParams, PlaceMarginLimitOrderParams, PlaceMarginMarketOrderParams } from "../types/index.mjs";
 import { DeepBookConfig } from "../utils/config.mjs";
-import * as _mysten_sui_transactions335 from "@mysten/sui/transactions";
+import * as _mysten_sui_transactions343 from "@mysten/sui/transactions";
 import { Transaction } from "@mysten/sui/transactions";
 
 //#region src/transactions/poolProxy.d.ts
@@ -20,7 +20,7 @@ declare class PoolProxyContract {
    * @param {PlaceMarginLimitOrderParams} params Parameters for placing a limit order
    * @returns A function that takes a Transaction object
    */
-  placeLimitOrder: (params: PlaceMarginLimitOrderParams) => (tx: Transaction) => _mysten_sui_transactions335.TransactionResult;
+  placeLimitOrder: (params: PlaceMarginLimitOrderParams) => (tx: Transaction) => _mysten_sui_transactions343.TransactionResult;
   /**
    * @description Place a market order. Enforces a post-trade `risk_ratio >=
    * min_borrow_risk_ratio` invariant on the manager (skipped when the manager
@@ -28,7 +28,7 @@ declare class PoolProxyContract {
    * @param {PlaceMarginMarketOrderParams} params Parameters for placing a market order
    * @returns A function that takes a Transaction object
    */
-  placeMarketOrder: (params: PlaceMarginMarketOrderParams) => (tx: Transaction) => _mysten_sui_transactions335.TransactionResult;
+  placeMarketOrder: (params: PlaceMarginMarketOrderParams) => (tx: Transaction) => _mysten_sui_transactions343.TransactionResult;
   /**
    * @description Place a reduce only limit order. Requires the manager to have
    * debt on the relevant side; enforces a monotonic `risk_ratio_after >=
@@ -37,7 +37,7 @@ declare class PoolProxyContract {
    * @param {PlaceMarginLimitOrderParams} params Parameters for placing a reduce only limit order
    * @returns A function that takes a Transaction object
    */
-  placeReduceOnlyLimitOrder: (params: PlaceMarginLimitOrderParams) => (tx: Transaction) => _mysten_sui_transactions335.TransactionResult;
+  placeReduceOnlyLimitOrder: (params: PlaceMarginLimitOrderParams) => (tx: Transaction) => _mysten_sui_transactions343.TransactionResult;
   /**
    * @description Place a reduce only market order. Requires the manager to
    * have debt on the relevant side; enforces a monotonic `risk_ratio_after >=
@@ -46,7 +46,7 @@ declare class PoolProxyContract {
    * @param {PlaceMarginMarketOrderParams} params Parameters for placing a reduce only market order
    * @returns A function that takes a Transaction object
    */
-  placeReduceOnlyMarketOrder: (params: PlaceMarginMarketOrderParams) => (tx: Transaction) => _mysten_sui_transactions335.TransactionResult;
+  placeReduceOnlyMarketOrder: (params: PlaceMarginMarketOrderParams) => (tx: Transaction) => _mysten_sui_transactions343.TransactionResult;
   /**
    * @description Place a market order and repay the loan from the fill proceeds.
    * The taker fill settles into the manager's balance, so the proceeds (plus any
@@ -58,7 +58,7 @@ declare class PoolProxyContract {
    * @param {PlaceMarginMarketOrderParams} params Parameters for placing a market order
    * @returns A function that takes a Transaction object
    */
-  placeMarketOrderAndRepayLoan: (params: PlaceMarginMarketOrderParams) => (tx: Transaction) => _mysten_sui_transactions335.TransactionResult;
+  placeMarketOrderAndRepayLoan: (params: PlaceMarginMarketOrderParams) => (tx: Transaction) => _mysten_sui_transactions343.TransactionResult;
   /**
    * @description Place a reduce only limit order and repay the loan from the
    * fill proceeds. Requires debt on the relevant side (a bid needs base debt; an
@@ -68,7 +68,7 @@ declare class PoolProxyContract {
    * @param {PlaceMarginLimitOrderParams} params Parameters for placing a reduce only limit order
    * @returns A function that takes a Transaction object
    */
-  placeReduceOnlyLimitOrderAndRepayLoan: (params: PlaceMarginLimitOrderParams) => (tx: Transaction) => _mysten_sui_transactions335.TransactionResult;
+  placeReduceOnlyLimitOrderAndRepayLoan: (params: PlaceMarginLimitOrderParams) => (tx: Transaction) => _mysten_sui_transactions343.TransactionResult;
   /**
    * @description Place a reduce only market order and repay the loan from the
    * fill proceeds. Same reduce-only direction guard as
@@ -78,7 +78,7 @@ declare class PoolProxyContract {
    * @param {PlaceMarginMarketOrderParams} params Parameters for placing a reduce only market order
    * @returns A function that takes a Transaction object
    */
-  placeReduceOnlyMarketOrderAndRepayLoan: (params: PlaceMarginMarketOrderParams) => (tx: Transaction) => _mysten_sui_transactions335.TransactionResult;
+  placeReduceOnlyMarketOrderAndRepayLoan: (params: PlaceMarginMarketOrderParams) => (tx: Transaction) => _mysten_sui_transactions343.TransactionResult;
   /**
    * @description Modify an existing order
    * @param {string} marginManagerKey The key to identify the MarginManager

package/package.json

@@ -2,7 +2,7 @@
   "name": "@mysten/deepbook-v3",
   "author": "Mysten Labs <build@mystenlabs.com>",
   "description": "Sui Deepbook SDK",
-  "version": "2.8.2",
+  "version": "2.9.0",
   "license": "Apache-2.0",
   "type": "module",
   "sideEffects": false,

package/src/contracts/deepbook_predict/config_events.ts

@@ -153,6 +153,14 @@ export const CadenceConfigUpdated = new MoveStruct({
 		window_size: U64,
 	},
 });
+export const CadenceAdded = new MoveStruct({
+	name: `${$moduleName}::CadenceAdded`,
+	fields: {
+		registry_id: bcs.Address,
+		cadence_id: bcs.u8(),
+		period_ms: U64,
+	},
+});
 export const ExpiryMarketMintPausedUpdated = new MoveStruct({
 	name: `${$moduleName}::ExpiryMarketMintPausedUpdated`,
 	fields: {

package/src/contracts/deepbook_predict/market_manager.ts

@@ -5,9 +5,11 @@
 /**
  * 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.
+ * `Registry` owns this state and delegates market admission to it. Cadence periods
+ * live in the registry's admin-extended cadence table and are passed in, indexed
+ * by cadence ID; underlying rows, cadence deployment terms, and per-underlying
+ * watermarks are stored here. When two enabled cadences can create the same
+ * expiry, the one with the longer period owns it.
  */
 
 import { MoveStruct, normalizeMoveArguments } from '../utils/index.js';
@@ -66,9 +68,13 @@ export const DeployableMarket = new MoveStruct({
 export const UnderlyingMarketConfig = new MoveStruct({
 	name: `${$moduleName}::UnderlyingMarketConfig`,
 	fields: {
-		/** Deployment config indexed by cadence ID. */
+		/**
+		 * Deployment config indexed by cadence ID. Rows past its length are disabled; the
+		 * vector grows past the six built-ins only when an added cadence is set or
+		 * created, because package versions before the cadence table abort on longer rows.
+		 */
 		cadences: bcs.vector(CadenceConfig),
-		/** Highest deployed expiry timestamp indexed by cadence ID. */
+		/** Highest deployed expiry timestamp indexed by cadence ID; missing rows are 0. */
 		last_deployed_expiries: bcs.vector(U64),
 	},
 });

package/src/contracts/deepbook_predict/registry.ts

@@ -14,6 +14,7 @@
 
 import {
 	MoveStruct,
+	MoveTuple,
 	normalizeMoveArguments,
 	type RawTransactionArgument,
 	type ConfigValue,
@@ -49,6 +50,10 @@ export const Registry = new MoveStruct({
 		allowed_pool_valuation_caps: vec_set.VecSet(bcs.Address),
 	},
 });
+export const CadencePeriodsKey = new MoveTuple({
+	name: `${$moduleName}::CadencePeriodsKey`,
+	fields: [bcs.bool()],
+});
 export interface IdArguments {
 	registry?: RawTransactionArgument<string>;
 }
@@ -165,9 +170,9 @@ export interface CadenceConfigsOptions {
  * Return one underlying's complete deployment policy as a single coherent
  * snapshot, for off-chain consumers (SDK and devInspect cadence discovery by the
  * keeper, price updater, and dashboard) that would otherwise need one read per
- * cadence. The vector holds one entry per supported cadence, indexed by cadence
- * ID; disabled cadences are present as their all-zero configuration. Aborts if the
- * underlying is not registered.
+ * cadence. The vector holds one entry per cadence in `cadence_periods`, indexed by
+ * cadence ID; disabled cadences are present as their all-zero configuration.
+ * Aborts if the underlying is not registered.
  */
 export function cadenceConfigs(options: CadenceConfigsOptions) {
 	const packageAddress =
@@ -189,6 +194,43 @@ export function cadenceConfigs(options: CadenceConfigsOptions) {
 			),
 		});
 }
+export interface CadencePeriodsArguments {
+	registry?: RawTransactionArgument<string>;
+}
+export interface CadencePeriodsOptions {
+	package?: string;
+	arguments?: CadencePeriodsArguments;
+	config?: {
+		registry: ConfigValue;
+		predictPackageId?: string;
+	};
+}
+/**
+ * Return every cadence's period in milliseconds, indexed by cadence ID, for
+ * devInspect cadence discovery by the keeper, price collector, and dashboard. The
+ * table starts with the six built-in cadences and grows through `add_cadence`;
+ * read it in the same transaction as `cadence_configs` for a consistent pair.
+ */
+export function cadencePeriods(options: CadencePeriodsOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['registry'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'registry',
+			function: 'cadence_periods',
+			arguments: normalizeMoveArguments(
+				{
+					...options.arguments,
+					registry: options.arguments?.registry ?? options.config?.registry,
+				},
+				argumentsTypes,
+				parameterNames,
+			),
+		});
+}
 export interface MintPauseCapArguments {
 	registry?: RawTransactionArgument<string>;
 	AdminCap: RawTransactionArgument<string>;
@@ -592,6 +634,49 @@ export function registerUnderlying(options: RegisterUnderlyingOptions) {
 			),
 		});
 }
+export interface AddCadenceArguments {
+	registry?: RawTransactionArgument<string>;
+	config?: RawTransactionArgument<string>;
+	AdminCap: RawTransactionArgument<string>;
+	periodMs: RawTransactionArgument<number | bigint>;
+}
+export interface AddCadenceOptions {
+	package?: string;
+	arguments: AddCadenceArguments;
+	config?: {
+		registry: ConfigValue;
+		protocolConfig: ConfigValue;
+		predictPackageId?: string;
+	};
+}
+/**
+ * Append a cadence with period `period_ms` to the cadence table and return its ID.
+ * The period is a whole number of minutes, at most one year, and not already in
+ * the table, which holds at most 16 cadences. A new cadence is disabled on every
+ * underlying until `set_template_cadence_config` sets its terms; periods never
+ * change, so retire a cadence by disabling it.
+ */
+export function addCadence(options: AddCadenceOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null, null, null, 'u64'] satisfies (string | null)[];
+	const parameterNames = ['registry', 'config', 'AdminCap', 'periodMs'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'registry',
+			function: 'add_cadence',
+			arguments: normalizeMoveArguments(
+				{
+					...options.arguments,
+					registry: options.arguments?.registry ?? options.config?.registry,
+					config: options.arguments?.config ?? options.config?.protocolConfig,
+				},
+				argumentsTypes,
+				parameterNames,
+			),
+		});
+}
 export interface SetTemplateCadenceConfigArguments {
 	registry?: RawTransactionArgument<string>;
 	config?: RawTransactionArgument<string>;
@@ -616,6 +701,8 @@ export interface SetTemplateCadenceConfigOptions {
 /**
  * Set all deployment terms for one underlying's cadence. Passing zero for all five
  * values disables the cadence; otherwise all values must be nonzero and valid.
+ * Aborts if the underlying's enabled windows would sum past the pool's live-market
+ * cap.
  */
 export function setTemplateCadenceConfig(options: SetTemplateCadenceConfigOptions) {
 	const packageAddress =
@@ -686,9 +773,10 @@ export interface CreateAndShareExpiryMarketOptions {
  *
  * Requires an allowlisted lifecycle capability, a registered underlying with all
  * canonical feed objects bound, and an enabled cadence with a deployable slot.
- * Higher-rank cadence overlaps and existing markets are skipped. The market
- * snapshots cadence and expiry policy, starts with zero cash, and cannot mint
- * until pool rebalancing funds it. Live pricing reads current Propbook bindings.
+ * Slots owned by a longer enabled cadence and existing markets are skipped. The
+ * market snapshots cadence and expiry policy, starts with zero cash, and cannot
+ * mint until pool rebalancing funds it. Live pricing reads current Propbook
+ * bindings.
  */
 export function createAndShareExpiryMarket(options: CreateAndShareExpiryMarketOptions) {
 	const packageAddress =
@@ -730,6 +818,74 @@ export function createAndShareExpiryMarket(options: CreateAndShareExpiryMarketOp
 			),
 		});
 }
+export interface CreateAndShareExpiryMarketAtArguments {
+	registry?: RawTransactionArgument<string>;
+	poolVault?: RawTransactionArgument<string>;
+	config?: RawTransactionArgument<string>;
+	propbookRegistry?: RawTransactionArgument<string>;
+	lifecycleCap: RawTransactionArgument<string>;
+	propbookUnderlyingId: RawTransactionArgument<number>;
+	cadenceId: RawTransactionArgument<number>;
+	expectedExpiry: RawTransactionArgument<number | bigint>;
+}
+export interface CreateAndShareExpiryMarketAtOptions {
+	package?: string;
+	arguments: CreateAndShareExpiryMarketAtArguments;
+	config?: {
+		registry: ConfigValue;
+		poolVault: ConfigValue;
+		protocolConfig: ConfigValue;
+		oracleRegistry: ConfigValue;
+		predictPackageId?: string;
+	};
+}
+/**
+ * `create_and_share_expiry_market`, aborting unless the deployable expiry is
+ * `expected_expiry`. A keeper that planned the expiry off chain uses this so that
+ * a stale view of the cadence table fails instead of creating an unplanned market.
+ */
+export function createAndShareExpiryMarketAt(options: CreateAndShareExpiryMarketAtOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [
+		null,
+		null,
+		null,
+		null,
+		null,
+		'u32',
+		'u8',
+		'u64',
+		'0x2::clock::Clock',
+	] satisfies (string | null)[];
+	const parameterNames = [
+		'registry',
+		'poolVault',
+		'config',
+		'propbookRegistry',
+		'lifecycleCap',
+		'propbookUnderlyingId',
+		'cadenceId',
+		'expectedExpiry',
+	];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'registry',
+			function: 'create_and_share_expiry_market_at',
+			arguments: normalizeMoveArguments(
+				{
+					...options.arguments,
+					registry: options.arguments?.registry ?? options.config?.registry,
+					poolVault: options.arguments?.poolVault ?? options.config?.poolVault,
+					config: options.arguments?.config ?? options.config?.protocolConfig,
+					propbookRegistry: options.arguments?.propbookRegistry ?? options.config?.oracleRegistry,
+				},
+				argumentsTypes,
+				parameterNames,
+			),
+		});
+}
 export interface CreateAndShareBuilderCodeArguments {
 	registry?: RawTransactionArgument<string>;
 	config?: RawTransactionArgument<string>;

package/src/contracts/propbook/block_scholes_store.ts

@@ -13,11 +13,18 @@
  * so an unusable observation cannot claim a permanent key. Value and SVI
  * observations use separate stores because the verifier exposes distinct batch and
  * value types. The registry creates and binds both stores atomically from one
- * base-asset input.
+ * base-asset input. An SVI store also derives its series ids from an admin-set
+ * provider model, so the admin chooses which of the provider's SVI surfaces the
+ * store accepts and serves.
  */
 
 import { type BcsType, bcs } from '@mysten/sui/bcs';
-import { MoveStruct, normalizeMoveArguments, type RawTransactionArgument } from '../utils/index.js';
+import {
+	MoveStruct,
+	MoveTuple,
+	normalizeMoveArguments,
+	type RawTransactionArgument,
+} from '../utils/index.js';
 import { U64, U128, U256 } from '../../bcs/integers.js';
 import { type Transaction, type TransactionArgument } from '@mysten/sui/transactions';
 import * as table from './deps/sui/table.js';
@@ -86,6 +93,10 @@ export const BlockScholesSVIStore = new MoveStruct({
 		svis: table.Table,
 	},
 });
+export const SviModelKey = new MoveTuple({
+	name: `${$moduleName}::SviModelKey`,
+	fields: [bcs.bool()],
+});
 /**
  * Emitted only for observations that were stored, so its presence means the series
  * advanced.
@@ -119,6 +130,14 @@ export function BlockScholesObservationInserted<Observation extends BcsType<any>
 		},
 	});
 }
+export const BlockScholesSVIModelSet = new MoveStruct({
+	name: `${$moduleName}::BlockScholesSVIModelSet`,
+	fields: {
+		propbook_underlying_id: bcs.u32(),
+		propbook_oracle_id: bcs.Address,
+		svi_model: bcs.string(),
+	},
+});
 export const BlockScholesBatchIngested = new MoveStruct({
 	name: `${$moduleName}::BlockScholesBatchIngested`,
 	fields: {
@@ -257,6 +276,29 @@ export function sviStoreVersion(options: SviStoreVersionOptions) {
 			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
 		});
 }
+export interface SviModelArguments {
+	store: RawTransactionArgument<string>;
+}
+export interface SviModelOptions {
+	package?: string;
+	arguments: SviModelArguments | [store: RawTransactionArgument<string>];
+}
+/**
+ * Returns the provider model this store's SVI series ids derive from, for relayer
+ * subscription construction through devInspect.
+ */
+export function sviModel(options: SviModelOptions) {
+	const packageAddress = options.package ?? '@local-pkg/propbook';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['store'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'block_scholes_store',
+			function: 'svi_model',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
 export interface SpotSidArguments {
 	store: RawTransactionArgument<string>;
 }
@@ -310,7 +352,10 @@ export interface SviSidOptions {
 		| SviSidArguments
 		| [store: RawTransactionArgument<string>, expiryMs: RawTransactionArgument<number | bigint>];
 }
-/** Returns one canonical SVI series id for external subscription construction. */
+/**
+ * Returns one canonical SVI series id, under the store's current model, for
+ * external subscription construction.
+ */
 export function sviSid(options: SviSidOptions) {
 	const packageAddress = options.package ?? '@local-pkg/propbook';
 	const argumentsTypes = [null, 'u64'] satisfies (string | null)[];

package/src/contracts/propbook/registry.ts

@@ -594,3 +594,48 @@ export function replacePythBindingForUnderlying(options: ReplacePythBindingForUn
 			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
 		});
 }
+export interface SetBlockScholesSviModelArguments {
+	sviStore: RawTransactionArgument<string>;
+	AdminCap: RawTransactionArgument<string>;
+	sviModel: RawTransactionArgument<string>;
+}
+export interface SetBlockScholesSviModelOptions {
+	package?: string;
+	arguments:
+		| SetBlockScholesSviModelArguments
+		| [
+				sviStore: RawTransactionArgument<string>,
+				AdminCap: RawTransactionArgument<string>,
+				sviModel: RawTransactionArgument<string>,
+		  ];
+}
+/**
+ * Admin-set the Block Scholes model `svi_store` derives its accepted and served
+ * SVI series ids from.
+ *
+ * The provider can publish more than one SVI surface for the same asset and
+ * expiry, each under its own model name, and the series id hashes that name.
+ * Setting the model therefore chooses which surface every consumer of this store
+ * prices from, for every expiry at once. A store whose model was never set uses
+ * `"SVI"`, and the store must be at the running package version. After a change, a
+ * batch signed under any other model aborts as a foreign series, so a relayer must
+ * resubscribe under the new model. A model never used on this store reads `none`
+ * until its first signed observation lands; a model set back serves its last
+ * stored rows again, which consumers accept for as long as those rows are within
+ * their freshness windows. Consumers linked to package version 1 keep reading the
+ * `"SVI"` rows under that version's hardcoded model until those rows age out.
+ * Confirm the provider publishes the model for every expiry the store serves
+ * before setting it.
+ */
+export function setBlockScholesSviModel(options: SetBlockScholesSviModelOptions) {
+	const packageAddress = options.package ?? '@local-pkg/propbook';
+	const argumentsTypes = [null, null, '0x1::string::String'] satisfies (string | null)[];
+	const parameterNames = ['sviStore', 'AdminCap', 'sviModel'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'registry',
+			function: 'set_block_scholes_svi_model',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}

package/src/deployments/testnet.ts

@@ -75,7 +75,7 @@ export const TESTNET_UNITS: DeploymentUnits = Object.freeze({
 export const TESTNET_PREDICT: PredictIds = Object.freeze({
 	network: 'testnet',
 	packages: Object.freeze({
-		predict: '0x340a77ce690e683138790592be6c6d02dc56a7e88e2555dc17f8a4967d003816',
+		predict: '0x0e6ce5fcfd8f647f2a1ba134d9f3bc919bc3ea767871d24f6c2799e3d7d47fc9',
 		predictV1: '0x59d71119e990573a738dd3ff9c4c7d28d6893af69c87c1a7f3a2e90e280ce2f4',
 		account: '0x1e57d6554b99e4ca68330322c3e5c409ba1b681642726b603bf1be92c1840ca9',
 		propbook: '0xa83f9d7651de09672a40cea371c387bf954e0f3092947670d71428d4fbc9edd9',