@mysten/deepbook-v3 2.0.1 → 2.1.3

package/src/contracts/deepbook_predict/builder_code.ts

@@ -0,0 +1,155 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * Owns deterministic builder referral codes and the DUSDC fees delivered to their
+ * object addresses through the funds accumulator. Codes are derived per owner and
+ * index, and only the immutable owner may withdraw accumulated fees.
+ */
+
+import {
+	MoveTuple,
+	MoveStruct,
+	normalizeMoveArguments,
+	type RawTransactionArgument,
+} from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import { U64 } from '../../bcs/integers.js';
+import { type Transaction } from '@mysten/sui/transactions';
+const $moduleName = '@local-pkg/deepbook_predict::builder_code';
+export const BuilderCodeKey = new MoveTuple({
+	name: `${$moduleName}::BuilderCodeKey`,
+	fields: [bcs.Address, U64],
+});
+export const BuilderCode = new MoveStruct({
+	name: `${$moduleName}::BuilderCode`,
+	fields: {
+		id: bcs.Address,
+		owner: bcs.Address,
+		index: U64,
+	},
+});
+export interface IdArguments {
+	code: RawTransactionArgument<string>;
+}
+export interface IdOptions {
+	package?: string;
+	arguments: IdArguments | [code: RawTransactionArgument<string>];
+	config?: {
+		predictPackageId?: string;
+	};
+}
+/** Returns the code identity for trade construction and external discovery. */
+export function id(options: IdOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['code'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'builder_code',
+			function: 'id',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface OwnerArguments {
+	code: RawTransactionArgument<string>;
+}
+export interface OwnerOptions {
+	package?: string;
+	arguments: OwnerArguments | [code: RawTransactionArgument<string>];
+	config?: {
+		predictPackageId?: string;
+	};
+}
+/** Returns the immutable owner authorized to claim fees. */
+export function owner(options: OwnerOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['code'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'builder_code',
+			function: 'owner',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface IndexArguments {
+	code: RawTransactionArgument<string>;
+}
+export interface IndexOptions {
+	package?: string;
+	arguments: IndexArguments | [code: RawTransactionArgument<string>];
+	config?: {
+		predictPackageId?: string;
+	};
+}
+/** Returns the owner-selected derivation index for external discovery. */
+export function index(options: IndexOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['code'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'builder_code',
+			function: 'index',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface ClaimableBuilderFeesArguments {
+	code: RawTransactionArgument<string>;
+}
+export interface ClaimableBuilderFeesOptions {
+	package?: string;
+	arguments: ClaimableBuilderFeesArguments | [code: RawTransactionArgument<string>];
+	config?: {
+		predictPackageId?: string;
+	};
+}
+/** Return visible DUSDC builder fees for SDK and devInspect reads. */
+export function claimableBuilderFees(options: ClaimableBuilderFeesOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = ['0x2::accumulator::AccumulatorRoot', null] satisfies (string | null)[];
+	const parameterNames = ['code'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'builder_code',
+			function: 'claimable_builder_fees',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}
+export interface ClaimAllBuilderFeesArguments {
+	code: RawTransactionArgument<string>;
+}
+export interface ClaimAllBuilderFeesOptions {
+	package?: string;
+	arguments: ClaimAllBuilderFeesArguments | [code: RawTransactionArgument<string>];
+	config?: {
+		predictPackageId?: string;
+	};
+}
+/**
+ * Claims all settled DUSDC builder fees for the immutable owner; an empty
+ * accumulator returns a zero coin.
+ */
+export function claimAllBuilderFees(options: ClaimAllBuilderFeesOptions) {
+	const packageAddress =
+		options.package ?? options.config?.predictPackageId ?? '@local-pkg/deepbook_predict';
+	const argumentsTypes = [null, '0x2::accumulator::AccumulatorRoot'] satisfies (string | null)[];
+	const parameterNames = ['code'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'builder_code',
+			function: 'claim_all_builder_fees',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+		});
+}

package/src/contracts/deepbook_predict/builder_code_events.ts

@@ -0,0 +1,34 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/** Builder-code lifecycle and attribution events for Predict. */
+
+import { MoveStruct } from '../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import { U64 } from '../../bcs/integers.js';
+const $moduleName = '@local-pkg/deepbook_predict::builder_code_events';
+export const BuilderCodeCreated = new MoveStruct({
+	name: `${$moduleName}::BuilderCodeCreated`,
+	fields: {
+		builder_code_id: bcs.Address,
+		owner: bcs.Address,
+		builder_code_index: U64,
+	},
+});
+export const BuilderCodeSet = new MoveStruct({
+	name: `${$moduleName}::BuilderCodeSet`,
+	fields: {
+		account_id: bcs.Address,
+		owner: bcs.Address,
+		builder_code_id: bcs.option(bcs.Address),
+	},
+});
+export const BuilderFeesClaimed = new MoveStruct({
+	name: `${$moduleName}::BuilderFeesClaimed`,
+	fields: {
+		builder_code_id: bcs.Address,
+		owner: bcs.Address,
+		amount: U64,
+	},
+});

package/src/contracts/deepbook_predict/config-arguments.ts

@@ -0,0 +1,11 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+import { type ConfigValue } from '../utils/index.js';
+export interface DeepbookPredictConfig {
+	predictPackageId?: string;
+	protocolConfig: ConfigValue;
+	poolVault: ConfigValue;
+	registry: ConfigValue;
+	oracleRegistry: ConfigValue;
+}

package/src/contracts/deepbook_predict/config_events.ts

@@ -0,0 +1,140 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/** Admin and configuration events for Predict. */
+
+import { MoveStruct } from '../utils/index.js';
+import { U64 } from '../../bcs/integers.js';
+import { bcs } from '@mysten/sui/bcs';
+const $moduleName = '@local-pkg/deepbook_predict::config_events';
+export const StrikeExposureTemplateConfigUpdated = new MoveStruct({
+	name: `${$moduleName}::StrikeExposureTemplateConfigUpdated`,
+	fields: {
+		backing_buffer_lambda: U64,
+		base_fee: U64,
+		min_fee: U64,
+		min_entry_probability: U64,
+		max_entry_probability: U64,
+		expiry_fee_window_ms: U64,
+		expiry_fee_max_multiplier: U64,
+		inventory_impact_max_rate: U64,
+		onchain_timestamp_ms: U64,
+	},
+});
+export const PricingConfigUpdated = new MoveStruct({
+	name: `${$moduleName}::PricingConfigUpdated`,
+	fields: {
+		use_pyth_spot_for_forward: bcs.bool(),
+		pyth_spot_freshness_ms: U64,
+		block_scholes_price_freshness_ms: U64,
+		block_scholes_svi_freshness_ms: U64,
+		onchain_timestamp_ms: U64,
+	},
+});
+export const EwmaConfigUpdated = new MoveStruct({
+	name: `${$moduleName}::EwmaConfigUpdated`,
+	fields: {
+		alpha: U64,
+		z_score_threshold: U64,
+		penalty_rate: U64,
+		enabled: bcs.bool(),
+		onchain_timestamp_ms: U64,
+	},
+});
+export const PlpFeeRatesUpdated = new MoveStruct({
+	name: `${$moduleName}::PlpFeeRatesUpdated`,
+	fields: {
+		plp_supply_fee_rate: U64,
+		plp_withdraw_fee_rate: U64,
+		onchain_timestamp_ms: U64,
+	},
+});
+export const TradingPausedUpdated = new MoveStruct({
+	name: `${$moduleName}::TradingPausedUpdated`,
+	fields: {
+		protocol_config_id: bcs.Address,
+		paused: bcs.bool(),
+	},
+});
+export const ProtocolFrozenUpdated = new MoveStruct({
+	name: `${$moduleName}::ProtocolFrozenUpdated`,
+	fields: {
+		protocol_config_id: bcs.Address,
+		frozen: bcs.bool(),
+	},
+});
+export const MarketCreated = new MoveStruct({
+	name: `${$moduleName}::MarketCreated`,
+	fields: {
+		expiry_market_id: bcs.Address,
+		pool_vault_id: bcs.Address,
+		/** Propbook underlying this market resolves current oracle bindings through. */
+		propbook_underlying_id: bcs.u32(),
+		expiry: U64,
+		/**
+		 * Raw-price-per-tick factor; indexers/SDKs derive raw strikes as
+		 * `tick * tick_size`.
+		 */
+		tick_size: U64,
+		/** Coarser raw-price step that new finite mint boundaries must align to. */
+		admission_tick_size: U64,
+		/** DUSDC pool allocation cap snapshotted for this expiry. */
+		max_expiry_allocation: U64,
+		/** Minimum DUSDC cash target snapshotted for this expiry. */
+		initial_expiry_cash: U64,
+		backing_buffer_lambda: U64,
+		base_fee: U64,
+		min_fee: U64,
+		min_entry_probability: U64,
+		max_entry_probability: U64,
+		expiry_fee_window_ms: U64,
+		expiry_fee_max_multiplier: U64,
+		/** Maximum marginal inventory-impact rate snapshotted by this market. */
+		inventory_impact_max_rate: U64,
+	},
+});
+export const CadenceConfigUpdated = new MoveStruct({
+	name: `${$moduleName}::CadenceConfigUpdated`,
+	fields: {
+		registry_id: bcs.Address,
+		propbook_underlying_id: bcs.u32(),
+		cadence_id: bcs.u8(),
+		tick_size: U64,
+		admission_tick_size: U64,
+		max_expiry_allocation: U64,
+		initial_expiry_cash: U64,
+		window_size: U64,
+	},
+});
+export const ExpiryMarketMintPausedUpdated = new MoveStruct({
+	name: `${$moduleName}::ExpiryMarketMintPausedUpdated`,
+	fields: {
+		expiry_market_id: bcs.Address,
+		paused: bcs.bool(),
+	},
+});
+export const ReferenceTickSet = new MoveStruct({
+	name: `${$moduleName}::ReferenceTickSet`,
+	fields: {
+		expiry_market_id: bcs.Address,
+		propbook_underlying_id: bcs.u32(),
+		source_timestamp_ms: U64,
+		spot: U64,
+		tick: U64,
+		onchain_timestamp_ms: U64,
+	},
+});
+export const MarketSettled = new MoveStruct({
+	name: `${$moduleName}::MarketSettled`,
+	fields: {
+		expiry_market_id: bcs.Address,
+		propbook_underlying_id: bcs.u32(),
+		expiry: U64,
+		settlement_price: U64,
+		/** `0` = Pyth and `1` = Block Scholes. */
+		settlement_source: bcs.u8(),
+		/** On-chain landing time of the settlement, `clock.timestamp_ms()`. */
+		onchain_timestamp_ms: U64,
+	},
+});

package/src/contracts/deepbook_predict/deps/fixed_math/i64.ts

@@ -0,0 +1,21 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * Signed integers represented by a `u64` magnitude and a canonical nonnegative
+ * zero. Scaled multiplication and division use 1e9 fixed point and truncate the
+ * result's magnitude toward zero.
+ */
+
+import { MoveStruct } from '../../../utils/index.js';
+import { U64 } from '../../../../bcs/integers.js';
+import { bcs } from '@mysten/sui/bcs';
+const $moduleName = 'fixed_math::i64';
+export const I64 = new MoveStruct({
+	name: `${$moduleName}::I64`,
+	fields: {
+		magnitude: U64,
+		is_negative: bcs.bool(),
+	},
+});

package/src/contracts/deepbook_predict/deps/sui/balance.ts

@@ -0,0 +1,25 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * A storable handler for Balances in general. Is used in the `Coin` module to
+ * allow balance operations and can be used to implement custom coins with `Supply`
+ * and `Balance`s.
+ */
+
+import { MoveStruct } from '../../../utils/index.js';
+import { U64 } from '../../../../bcs/integers.js';
+const $moduleName = '0x2::balance';
+export const Balance = new MoveStruct({
+	name: `${$moduleName}::Balance<phantom T>`,
+	fields: {
+		value: U64,
+	},
+});
+export const Supply = new MoveStruct({
+	name: `${$moduleName}::Supply<phantom T>`,
+	fields: {
+		value: U64,
+	},
+});

package/src/contracts/deepbook_predict/deps/sui/coin.ts

@@ -0,0 +1,20 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * Defines the `Coin` type - platform wide representation of fungible tokens and
+ * coins. `Coin` can be described as a secure wrapper around `Balance` type.
+ */
+
+import { MoveStruct } from '../../../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import * as balance from './balance.js';
+const $moduleName = '0x2::coin';
+export const TreasuryCap = new MoveStruct({
+	name: `${$moduleName}::TreasuryCap<phantom T>`,
+	fields: {
+		id: bcs.Address,
+		total_supply: balance.Supply,
+	},
+});

package/src/contracts/deepbook_predict/deps/sui/table.ts

@@ -0,0 +1,37 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * A table is a map-like collection. But unlike a traditional collection, it's keys
+ * and values are not stored within the `Table` value, but instead are stored using
+ * Sui's object system. The `Table` struct acts only as a handle into the object
+ * system to retrieve those keys and values. Note that this means that `Table`
+ * values with exactly the same key-value mapping will not be equal, with `==`, at
+ * runtime. For example
+ *
+ * ```
+ * let table1 = table::new<u64, bool>();
+ * let table2 = table::new<u64, bool>();
+ * table::add(&mut table1, 0, false);
+ * table::add(&mut table1, 1, true);
+ * table::add(&mut table2, 0, false);
+ * table::add(&mut table2, 1, true);
+ * // table1 does not equal table2, despite having the same entries
+ * assert!(&table1 != &table2);
+ * ```
+ */
+
+import { MoveStruct } from '../../../utils/index.js';
+import { bcs } from '@mysten/sui/bcs';
+import { U64 } from '../../../../bcs/integers.js';
+const $moduleName = '0x2::table';
+export const Table = new MoveStruct({
+	name: `${$moduleName}::Table<phantom K, phantom V>`,
+	fields: {
+		/** the ID of this table */
+		id: bcs.Address,
+		/** the number of key-value pairs in the table */
+		size: U64,
+	},
+});

package/src/contracts/deepbook_predict/deps/sui/vec_set.ts

@@ -0,0 +1,22 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+import { type BcsType, bcs } from '@mysten/sui/bcs';
+import { MoveStruct } from '../../../utils/index.js';
+const $moduleName = '0x2::vec_set';
+/**
+ * A set data structure backed by a vector. The set is guaranteed not to contain
+ * duplicate keys. All operations are O(N) in the size of the set
+ *
+ * - the intention of this data structure is only to provide the convenience of
+ *   programming against a set API. Sets that need sorted iteration rather than
+ *   insertion order iteration should be handwritten.
+ */
+export function VecSet<K extends BcsType<any>>(...typeParameters: [K]) {
+	return new MoveStruct({
+		name: `${$moduleName}::VecSet<${typeParameters[0].name as K['name']}>`,
+		fields: {
+			contents: bcs.vector(typeParameters[0]),
+		},
+	});
+}

package/src/contracts/deepbook_predict/ewma.ts

@@ -0,0 +1,26 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * Per-market exponentially weighted gas-price statistics used to surcharge trades
+ * placed during abnormal network congestion.
+ *
+ * This module owns only the evolving `(mean, variance)` estimate and the gas-price
+ * observation and penalty math. The tunable knobs (`alpha`, `z_score_threshold`,
+ * `penalty_rate`, `enabled`) live in `EwmaConfig`; `ExpiryMarket` owns the stored
+ * state and decides when to fold observations in.
+ */
+
+import { MoveStruct } from '../utils/index.js';
+import { U64 } from '../../bcs/integers.js';
+const $moduleName = '@local-pkg/deepbook_predict::ewma';
+export const EwmaState = new MoveStruct({
+	name: `${$moduleName}::EwmaState`,
+	fields: {
+		mean: U64,
+		variance: U64,
+		/** On-chain time of the last fold; guards against more than one update per ms. */
+		last_updated_timestamp_ms: U64,
+	},
+});

package/src/contracts/deepbook_predict/ewma_config.ts

@@ -0,0 +1,28 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * Stored parameters for the gas-price EWMA trade penalty.
+ *
+ * `ExpiryMarket` holds the evolving `EwmaState`; this config holds the
+ * admin-tunable knobs shared by every market. The penalty is disabled by default.
+ */
+
+import { MoveStruct } from '../utils/index.js';
+import { U64 } from '../../bcs/integers.js';
+import { bcs } from '@mysten/sui/bcs';
+const $moduleName = '@local-pkg/deepbook_predict::ewma_config';
+export const EwmaConfig = new MoveStruct({
+	name: `${$moduleName}::EwmaConfig`,
+	fields: {
+		/** Smoothing factor for the gas-price mean and variance; higher reacts faster. */
+		alpha: U64,
+		/** Standard deviations above the smoothed mean required before a penalty applies. */
+		z_score_threshold: U64,
+		/** Per-unit fee added to a penalized trade's trading fee. */
+		penalty_rate: U64,
+		/** Master switch; no penalty applies while false. */
+		enabled: bcs.bool(),
+	},
+});

package/src/contracts/deepbook_predict/expiry_cash.ts

@@ -0,0 +1,24 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+
+/**
+ * Expiry-local DUSDC custody and isolated reserve accounting.
+ *
+ * This leaf owns cash balance arithmetic and the inventory-impact escrow used only
+ * for live-close rebates. It does not decide payment eligibility, pool allocation,
+ * or market phase sequencing; `ExpiryMarket` owns those policies.
+ */
+
+import { MoveStruct } from '../utils/index.js';
+import { U64 } from '../../bcs/integers.js';
+import * as balance from './deps/sui/balance.js';
+const $moduleName = '@local-pkg/deepbook_predict::expiry_cash';
+export const ExpiryCash = new MoveStruct({
+	name: `${$moduleName}::ExpiryCash`,
+	fields: {
+		cash_balance: balance.Balance,
+		/** Collected inventory-impact charges still reserved for live-close rebates. */
+		inventory_impact_reserve: U64,
+	},
+});