@mysten/deepbook-v3 2.6.4 → 2.8.0

package/dist/contracts/deepbook_predict_orders/desk.d.mts

@@ -0,0 +1,187 @@
+import { ConfigValue, MoveStruct, RawTransactionArgument } from "../utils/index.mjs";
+import * as _mysten_sui_bcs458 from "@mysten/sui/bcs";
+import * as _mysten_sui_transactions253 from "@mysten/sui/transactions";
+import { Transaction } from "@mysten/sui/transactions";
+
+//#region src/contracts/deepbook_predict_orders/desk.d.ts
+declare namespace desk_d_exports {
+  export { BumpVersionWatermarkArguments, BumpVersionWatermarkOptions, IdArguments, IdOptions, OrderDesk, PolicyArguments, PolicyOptions, QueueRegistry, RegistryIdArguments, RegistryIdOptions, SetLimitsArguments, SetLimitsOptions, SetOrderFeeArguments, SetOrderFeeOptions, SetTimingArguments, SetTimingOptions, VersionWatermarkArguments, VersionWatermarkOptions, bumpVersionWatermark, id, policy, registryId, setLimits, setOrderFee, setTiming, versionWatermark };
+}
+declare const OrderDesk: MoveStruct<{
+  id: _mysten_sui_bcs458.BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+  policy: MoveStruct<{
+    delay_ms: _mysten_sui_bcs458.BcsType<bigint, string | number | bigint, "u64">;
+    stall_timeout_ms: _mysten_sui_bcs458.BcsType<bigint, string | number | bigint, "u64">;
+    stuck_threshold_ms: _mysten_sui_bcs458.BcsType<bigint, string | number | bigint, "u64">;
+    gap_wait_ms: _mysten_sui_bcs458.BcsType<bigint, string | number | bigint, "u64">;
+    pyth_price_buffer_ms: _mysten_sui_bcs458.BcsType<bigint, string | number | bigint, "u64">;
+    pyth_channel: _mysten_sui_bcs458.BcsType<number, number, "u8">;
+    svi_max_age_ms: _mysten_sui_bcs458.BcsType<bigint, string | number | bigint, "u64">;
+    mint_capacity: _mysten_sui_bcs458.BcsType<bigint, string | number | bigint, "u64">;
+    sell_capacity: _mysten_sui_bcs458.BcsType<bigint, string | number | bigint, "u64">;
+    per_account_cap: _mysten_sui_bcs458.BcsType<bigint, string | number | bigint, "u64">;
+    order_fee: _mysten_sui_bcs458.BcsType<bigint, string | number | bigint, "u64">;
+    min_sell_quantity: _mysten_sui_bcs458.BcsType<bigint, string | number | bigint, "u64">;
+    settle_refund_batch: _mysten_sui_bcs458.BcsType<bigint, string | number | bigint, "u64">;
+    settle_payout_batch: _mysten_sui_bcs458.BcsType<bigint, string | number | bigint, "u64">;
+  }, "@local-pkg/deepbook_predict_orders::delayed_execution_config::DelayedExecutionPolicy">;
+  /**
+   * Minimum companion version permitted to run. Monotonic; `bump_version_watermark`
+   * advances it to the running `current_version!()`, retiring older companion code.
+   */
+  version_watermark: _mysten_sui_bcs458.BcsType<bigint, string | number | bigint, "u64">;
+}, "@local-pkg/deepbook_predict_orders::desk::OrderDesk">;
+declare const QueueRegistry: MoveStruct<{
+  id: _mysten_sui_bcs458.BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+  desk_id: _mysten_sui_bcs458.BcsType<string, string | Uint8Array<ArrayBufferLike>, "bytes[32]">;
+}, "@local-pkg/deepbook_predict_orders::desk::QueueRegistry">;
+interface IdArguments {
+  desk?: RawTransactionArgument<string>;
+}
+interface IdOptions {
+  package?: string;
+  arguments?: IdArguments;
+  config?: {
+    orderDesk: ConfigValue;
+    predictOrdersPackageId?: string;
+  };
+}
+/** Return the desk object ID for external discovery and PTB construction. */
+declare function id(options: IdOptions): (tx: Transaction) => _mysten_sui_transactions253.TransactionResult;
+interface PolicyArguments {
+  desk?: RawTransactionArgument<string>;
+}
+interface PolicyOptions {
+  package?: string;
+  arguments?: PolicyArguments;
+  config?: {
+    orderDesk: ConfigValue;
+    predictOrdersPackageId?: string;
+  };
+}
+/** Return the policy, for SDK and devInspect reads. */
+declare function policy(options: PolicyOptions): (tx: Transaction) => _mysten_sui_transactions253.TransactionResult;
+interface VersionWatermarkArguments {
+  desk?: RawTransactionArgument<string>;
+}
+interface VersionWatermarkOptions {
+  package?: string;
+  arguments?: VersionWatermarkArguments;
+  config?: {
+    orderDesk: ConfigValue;
+    predictOrdersPackageId?: string;
+  };
+}
+/** Return the desk's version floor, for SDK and devInspect reads. */
+declare function versionWatermark(options: VersionWatermarkOptions): (tx: Transaction) => _mysten_sui_transactions253.TransactionResult;
+interface RegistryIdArguments {
+  registry?: RawTransactionArgument<string>;
+}
+interface RegistryIdOptions {
+  package?: string;
+  arguments?: RegistryIdArguments;
+  config?: {
+    queueRegistry: ConfigValue;
+    predictOrdersPackageId?: string;
+  };
+}
+/**
+ * Return the queue registry's object ID, for discovery and for deriving each
+ * market's queue ID (`queue::queue_id`) in PTB construction.
+ */
+declare function registryId(options: RegistryIdOptions): (tx: Transaction) => _mysten_sui_transactions253.TransactionResult;
+interface SetTimingArguments {
+  desk?: RawTransactionArgument<string>;
+  AdminCap: RawTransactionArgument<string>;
+  config?: RawTransactionArgument<string>;
+  delayMs: RawTransactionArgument<number | bigint>;
+  stallTimeoutMs: RawTransactionArgument<number | bigint>;
+  stuckThresholdMs: RawTransactionArgument<number | bigint>;
+  gapWaitMs: RawTransactionArgument<number | bigint>;
+  pythPriceBufferMs: RawTransactionArgument<number | bigint>;
+  pythChannel: RawTransactionArgument<number>;
+  sviMaxAgeMs: RawTransactionArgument<number | bigint>;
+}
+interface SetTimingOptions {
+  package?: string;
+  arguments: SetTimingArguments;
+  config?: {
+    orderDesk: ConfigValue;
+    protocolConfig: ConfigValue;
+    predictOrdersPackageId?: string;
+  };
+}
+/**
+ * Set every timing field and the Pyth channel in one call, so the relational rules
+ * hold on the final state (`delayed_execution_config::set_timing`). Waiting orders
+ * keep the τ, deadline, and channel they were placed with, so a new delay, stall
+ * timeout, or channel reaches only new orders. Commit reads the buffer and gap
+ * wait when it runs, so those also apply to waiting cohorts.
+ */
+declare function setTiming(options: SetTimingOptions): (tx: Transaction) => _mysten_sui_transactions253.TransactionResult;
+interface SetLimitsArguments {
+  desk?: RawTransactionArgument<string>;
+  AdminCap: RawTransactionArgument<string>;
+  config?: RawTransactionArgument<string>;
+  mintCapacity: RawTransactionArgument<number | bigint>;
+  sellCapacity: RawTransactionArgument<number | bigint>;
+  perAccountCap: RawTransactionArgument<number | bigint>;
+  minSellQuantity: RawTransactionArgument<number | bigint>;
+  settleRefundBatch: RawTransactionArgument<number | bigint>;
+  settlePayoutBatch: RawTransactionArgument<number | bigint>;
+}
+interface SetLimitsOptions {
+  package?: string;
+  arguments: SetLimitsArguments;
+  config?: {
+    orderDesk: ConfigValue;
+    protocolConfig: ConfigValue;
+    predictOrdersPackageId?: string;
+  };
+}
+/**
+ * Set the queue capacities, the per-account cap, the minimum early sell, and the
+ * two `settle_step` batch sizes. Lowering a capacity below the current pending
+ * count only blocks new orders.
+ */
+declare function setLimits(options: SetLimitsOptions): (tx: Transaction) => _mysten_sui_transactions253.TransactionResult;
+interface SetOrderFeeArguments {
+  desk?: RawTransactionArgument<string>;
+  AdminCap: RawTransactionArgument<string>;
+  config?: RawTransactionArgument<string>;
+  orderFee: RawTransactionArgument<number | bigint>;
+}
+interface SetOrderFeeOptions {
+  package?: string;
+  arguments: SetOrderFeeArguments;
+  config?: {
+    orderDesk: ConfigValue;
+    protocolConfig: ConfigValue;
+    predictOrdersPackageId?: string;
+  };
+}
+/**
+ * Set the flat fee charged per queued order, in USDC base units. Applies to orders
+ * placed after the call; waiting orders keep the fee they paid.
+ */
+declare function setOrderFee(options: SetOrderFeeOptions): (tx: Transaction) => _mysten_sui_transactions253.TransactionResult;
+interface BumpVersionWatermarkArguments {
+  desk?: RawTransactionArgument<string>;
+  AdminCap: RawTransactionArgument<string>;
+}
+interface BumpVersionWatermarkOptions {
+  package?: string;
+  arguments: BumpVersionWatermarkArguments;
+  config?: {
+    orderDesk: ConfigValue;
+    predictOrdersPackageId?: string;
+  };
+}
+/**
+ * Advance the desk floor to this package's compiled `current_version!()`, retiring
+ * older companion code. Aborts unless the executing version is above the floor.
+ */
+declare function bumpVersionWatermark(options: BumpVersionWatermarkOptions): (tx: Transaction) => _mysten_sui_transactions253.TransactionResult;
+//#endregion
+export { desk_d_exports };
+//# sourceMappingURL=desk.d.mts.map

package/dist/contracts/deepbook_predict_orders/desk.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"desk.d.mts","names":[],"sources":["../../../src/contracts/deepbook_predict_orders/desk.ts"],"mappings":";;;;;;;;;cAsCa,SAAA,EAAS,UAAA;;;;;;;;;;;;;;;;;;;;;;;;cAYT,aAAA,EAAa,UAAA;;;;UAOT,WAAA;EAChB,IAAA,GAAO,sBAAA;AAAA;AAAA,UAES,SAAA;EAChB,OAAA;EACA,SAAA,GAAY,WAAA;EACZ,MAAA;IACC,SAAA,EAAW,WAAA;IACX,sBAAA;EAAA;AAAA;;iBAIc,EAAA,CAAG,OAAA,EAAS,SAAA,IAOnB,EAAA,EAAI,WAAA,KAAW,2BAAA,CAAA,iBAAA;AAAA,UAeP,eAAA;EAChB,IAAA,GAAO,sBAAA;AAAA;AAAA,UAES,aAAA;EAChB,OAAA;EACA,SAAA,GAAY,eAAA;EACZ,MAAA;IACC,SAAA,EAAW,WAAA;IACX,sBAAA;EAAA;AAAA;;iBAIc,MAAA,CAAO,OAAA,EAAS,aAAA,IAOvB,EAAA,EAAI,WAAA,KAAW,2BAAA,CAAA,iBAAA;AAAA,UAeP,yBAAA;EAChB,IAAA,GAAO,sBAAA;AAAA;AAAA,UAES,uBAAA;EAChB,OAAA;EACA,SAAA,GAAY,yBAAA;EACZ,MAAA;IACC,SAAA,EAAW,WAAA;IACX,sBAAA;EAAA;AAAA;;iBAIc,gBAAA,CAAiB,OAAA,EAAS,uBAAA,IAOjC,EAAA,EAAI,WAAA,KAAW,2BAAA,CAAA,iBAAA;AAAA,UAeP,mBAAA;EAChB,QAAA,GAAW,sBAAA;AAAA;AAAA,UAEK,iBAAA;EAChB,OAAA;EACA,SAAA,GAAY,mBAAA;EACZ,MAAA;IACC,aAAA,EAAe,WAAA;IACf,sBAAA;EAAA;AAAA;;;;;iBAOc,UAAA,CAAW,OAAA,EAAS,iBAAA,IAO3B,EAAA,EAAI,WAAA,KAAW,2BAAA,CAAA,iBAAA;AAAA,UAeP,kBAAA;EAChB,IAAA,GAAO,sBAAA;EACP,QAAA,EAAU,sBAAA;EACV,MAAA,GAAS,sBAAA;EACT,OAAA,EAAS,sBAAA;EACT,cAAA,EAAgB,sBAAA;EAChB,gBAAA,EAAkB,sBAAA;EAClB,SAAA,EAAW,sBAAA;EACX,iBAAA,EAAmB,sBAAA;EACnB,WAAA,EAAa,sBAAA;EACb,WAAA,EAAa,sBAAA;AAAA;AAAA,UAEG,gBAAA;EAChB,OAAA;EACA,SAAA,EAAW,kBAAA;EACX,MAAA;IACC,SAAA,EAAW,WAAA;IACX,cAAA,EAAgB,WAAA;IAChB,sBAAA;EAAA;AAAA;;;;;;;;iBAUc,SAAA,CAAU,OAAA,EAAS,gBAAA,IA8B1B,EAAA,EAAI,WAAA,KAAW,2BAAA,CAAA,iBAAA;AAAA,UAgBP,kBAAA;EAChB,IAAA,GAAO,sBAAA;EACP,QAAA,EAAU,sBAAA;EACV,MAAA,GAAS,sBAAA;EACT,YAAA,EAAc,sBAAA;EACd,YAAA,EAAc,sBAAA;EACd,aAAA,EAAe,sBAAA;EACf,eAAA,EAAiB,sBAAA;EACjB,iBAAA,EAAmB,sBAAA;EACnB,iBAAA,EAAmB,sBAAA;AAAA;AAAA,UAEH,gBAAA;EAChB,OAAA;EACA,SAAA,EAAW,kBAAA;EACX,MAAA;IACC,SAAA,EAAW,WAAA;IACX,cAAA,EAAgB,WAAA;IAChB,sBAAA;EAAA;AAAA;;AAjMF;;;;iBAyMgB,SAAA,CAAU,OAAA,EAAS,gBAAA,IA4B1B,EAAA,EAAI,WAAA,KAAW,2BAAA,CAAA,iBAAA;AAAA,UAgBP,oBAAA;EAChB,IAAA,GAAO,sBAAA;EACP,QAAA,EAAU,sBAAA;EACV,MAAA,GAAS,sBAAA;EACT,QAAA,EAAU,sBAAA;AAAA;AAAA,UAEM,kBAAA;EAChB,OAAA;EACA,SAAA,EAAW,oBAAA;EACX,MAAA;IACC,SAAA,EAAW,WAAA;IACX,cAAA,EAAgB,WAAA;IAChB,sBAAA;EAAA;AAAA;;;;;iBAOc,WAAA,CAAY,OAAA,EAAS,kBAAA,IAO5B,EAAA,EAAI,WAAA,KAAW,2BAAA,CAAA,iBAAA;AAAA,UAgBP,6BAAA;EAChB,IAAA,GAAO,sBAAA;EACP,QAAA,EAAU,sBAAA;AAAA;AAAA,UAEM,2BAAA;EAChB,OAAA;EACA,SAAA,EAAW,6BAAA;EACX,MAAA;IACC,SAAA,EAAW,WAAA;IACX,sBAAA;EAAA;AAAA;;;;;iBAOc,oBAAA,CAAqB,OAAA,EAAS,2BAAA,IAOrC,EAAA,EAAI,WAAA,KAAW,2BAAA,CAAA,iBAAA"}

package/dist/contracts/deepbook_predict_orders/desk.mjs

@@ -0,0 +1,261 @@
+import { __exportAll } from "../../_virtual/rolldown_runtime.mjs";
+import { MoveStruct, normalizeMoveArguments } from "../utils/index.mjs";
+import { U64 } from "../../bcs/integers.mjs";
+import { DelayedExecutionPolicy } from "./delayed_execution_config.mjs";
+import { bcs } from "@mysten/sui/bcs";
+
+//#region src/contracts/deepbook_predict_orders/desk.ts
+/**************************************************************
+* THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+**************************************************************/
+/**
+* The order-flow companion's shared `OrderDesk`: the delayed-execution policy
+* every market queue runs under, and the companion's version floor. Also the
+* desk's `QueueRegistry`, the parent every market's queue ID derives from.
+*
+* One desk and one registry per deployment: `init` creates and shares both when
+* the package is published, and nothing else builds one. Each market's
+* `MarketQueue` sits at an ID derived from the registry and the market
+* (`queue::create_and_share`), so a deployment gives each market exactly one
+* queue, and with it one per-account cap, stuck gate, policy, and version floor.
+* The desk exists before Predict allowlists this package's witness; until
+* `protocol_config::set_order_flow` does, Predict's admission, commit, and fill
+* primitives refuse the companion.
+*
+* Predict's `AdminCap` administers the desk. Its setters check the desk floor and
+* refuse while Predict is frozen, through the public `protocol_config::frozen`;
+* the policy cannot move funds, and every Predict invariant holds inside Predict's
+* primitives whatever it says. Every trading call reads the desk, and only those
+* admin setters write it. Queue creation, which anyone may call, writes the
+* registry instead, which no trading call reads, so creation cannot contend with
+* trading.
+*/
+var desk_exports = /* @__PURE__ */ __exportAll({
+	OrderDesk: () => OrderDesk,
+	QueueRegistry: () => QueueRegistry,
+	bumpVersionWatermark: () => bumpVersionWatermark,
+	id: () => id,
+	policy: () => policy,
+	registryId: () => registryId,
+	setLimits: () => setLimits,
+	setOrderFee: () => setOrderFee,
+	setTiming: () => setTiming,
+	versionWatermark: () => versionWatermark
+});
+const $moduleName = "@local-pkg/deepbook_predict_orders::desk";
+const OrderDesk = new MoveStruct({
+	name: `${$moduleName}::OrderDesk`,
+	fields: {
+		id: bcs.Address,
+		policy: DelayedExecutionPolicy,
+		version_watermark: U64
+	}
+});
+const QueueRegistry = new MoveStruct({
+	name: `${$moduleName}::QueueRegistry`,
+	fields: {
+		id: bcs.Address,
+		desk_id: bcs.Address
+	}
+});
+/** Return the desk object ID for external discovery and PTB construction. */
+function id(options) {
+	const packageAddress = options.package ?? options.config?.predictOrdersPackageId ?? "@local-pkg/deepbook_predict_orders";
+	const argumentsTypes = [null];
+	const parameterNames = ["desk"];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "desk",
+		function: "id",
+		arguments: normalizeMoveArguments({
+			...options.arguments,
+			desk: options.arguments?.desk ?? options.config?.orderDesk
+		}, argumentsTypes, parameterNames)
+	});
+}
+/** Return the policy, for SDK and devInspect reads. */
+function policy(options) {
+	const packageAddress = options.package ?? options.config?.predictOrdersPackageId ?? "@local-pkg/deepbook_predict_orders";
+	const argumentsTypes = [null];
+	const parameterNames = ["desk"];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "desk",
+		function: "policy",
+		arguments: normalizeMoveArguments({
+			...options.arguments,
+			desk: options.arguments?.desk ?? options.config?.orderDesk
+		}, argumentsTypes, parameterNames)
+	});
+}
+/** Return the desk's version floor, for SDK and devInspect reads. */
+function versionWatermark(options) {
+	const packageAddress = options.package ?? options.config?.predictOrdersPackageId ?? "@local-pkg/deepbook_predict_orders";
+	const argumentsTypes = [null];
+	const parameterNames = ["desk"];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "desk",
+		function: "version_watermark",
+		arguments: normalizeMoveArguments({
+			...options.arguments,
+			desk: options.arguments?.desk ?? options.config?.orderDesk
+		}, argumentsTypes, parameterNames)
+	});
+}
+/**
+* Return the queue registry's object ID, for discovery and for deriving each
+* market's queue ID (`queue::queue_id`) in PTB construction.
+*/
+function registryId(options) {
+	const packageAddress = options.package ?? options.config?.predictOrdersPackageId ?? "@local-pkg/deepbook_predict_orders";
+	const argumentsTypes = [null];
+	const parameterNames = ["registry"];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "desk",
+		function: "registry_id",
+		arguments: normalizeMoveArguments({
+			...options.arguments,
+			registry: options.arguments?.registry ?? options.config?.queueRegistry
+		}, argumentsTypes, parameterNames)
+	});
+}
+/**
+* Set every timing field and the Pyth channel in one call, so the relational rules
+* hold on the final state (`delayed_execution_config::set_timing`). Waiting orders
+* keep the τ, deadline, and channel they were placed with, so a new delay, stall
+* timeout, or channel reaches only new orders. Commit reads the buffer and gap
+* wait when it runs, so those also apply to waiting cohorts.
+*/
+function setTiming(options) {
+	const packageAddress = options.package ?? options.config?.predictOrdersPackageId ?? "@local-pkg/deepbook_predict_orders";
+	const argumentsTypes = [
+		null,
+		null,
+		null,
+		"u64",
+		"u64",
+		"u64",
+		"u64",
+		"u64",
+		"u8",
+		"u64",
+		"0x2::clock::Clock"
+	];
+	const parameterNames = [
+		"desk",
+		"AdminCap",
+		"config",
+		"delayMs",
+		"stallTimeoutMs",
+		"stuckThresholdMs",
+		"gapWaitMs",
+		"pythPriceBufferMs",
+		"pythChannel",
+		"sviMaxAgeMs"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "desk",
+		function: "set_timing",
+		arguments: normalizeMoveArguments({
+			...options.arguments,
+			desk: options.arguments?.desk ?? options.config?.orderDesk,
+			config: options.arguments?.config ?? options.config?.protocolConfig
+		}, argumentsTypes, parameterNames)
+	});
+}
+/**
+* Set the queue capacities, the per-account cap, the minimum early sell, and the
+* two `settle_step` batch sizes. Lowering a capacity below the current pending
+* count only blocks new orders.
+*/
+function setLimits(options) {
+	const packageAddress = options.package ?? options.config?.predictOrdersPackageId ?? "@local-pkg/deepbook_predict_orders";
+	const argumentsTypes = [
+		null,
+		null,
+		null,
+		"u64",
+		"u64",
+		"u64",
+		"u64",
+		"u64",
+		"u64",
+		"0x2::clock::Clock"
+	];
+	const parameterNames = [
+		"desk",
+		"AdminCap",
+		"config",
+		"mintCapacity",
+		"sellCapacity",
+		"perAccountCap",
+		"minSellQuantity",
+		"settleRefundBatch",
+		"settlePayoutBatch"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "desk",
+		function: "set_limits",
+		arguments: normalizeMoveArguments({
+			...options.arguments,
+			desk: options.arguments?.desk ?? options.config?.orderDesk,
+			config: options.arguments?.config ?? options.config?.protocolConfig
+		}, argumentsTypes, parameterNames)
+	});
+}
+/**
+* Set the flat fee charged per queued order, in USDC base units. Applies to orders
+* placed after the call; waiting orders keep the fee they paid.
+*/
+function setOrderFee(options) {
+	const packageAddress = options.package ?? options.config?.predictOrdersPackageId ?? "@local-pkg/deepbook_predict_orders";
+	const argumentsTypes = [
+		null,
+		null,
+		null,
+		"u64",
+		"0x2::clock::Clock"
+	];
+	const parameterNames = [
+		"desk",
+		"AdminCap",
+		"config",
+		"orderFee"
+	];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "desk",
+		function: "set_order_fee",
+		arguments: normalizeMoveArguments({
+			...options.arguments,
+			desk: options.arguments?.desk ?? options.config?.orderDesk,
+			config: options.arguments?.config ?? options.config?.protocolConfig
+		}, argumentsTypes, parameterNames)
+	});
+}
+/**
+* Advance the desk floor to this package's compiled `current_version!()`, retiring
+* older companion code. Aborts unless the executing version is above the floor.
+*/
+function bumpVersionWatermark(options) {
+	const packageAddress = options.package ?? options.config?.predictOrdersPackageId ?? "@local-pkg/deepbook_predict_orders";
+	const argumentsTypes = [null, null];
+	const parameterNames = ["desk", "AdminCap"];
+	return (tx) => tx.moveCall({
+		package: packageAddress,
+		module: "desk",
+		function: "bump_version_watermark",
+		arguments: normalizeMoveArguments({
+			...options.arguments,
+			desk: options.arguments?.desk ?? options.config?.orderDesk
+		}, argumentsTypes, parameterNames)
+	});
+}
+
+//#endregion
+export { desk_exports, policy, versionWatermark };
+//# sourceMappingURL=desk.mjs.map

package/dist/contracts/deepbook_predict_orders/desk.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"desk.mjs","names":["delayed_execution_config.DelayedExecutionPolicy"],"sources":["../../../src/contracts/deepbook_predict_orders/desk.ts"],"sourcesContent":["/**************************************************************\n * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *\n **************************************************************/\n\n/**\n * The order-flow companion's shared `OrderDesk`: the delayed-execution policy\n * every market queue runs under, and the companion's version floor. Also the\n * desk's `QueueRegistry`, the parent every market's queue ID derives from.\n *\n * One desk and one registry per deployment: `init` creates and shares both when\n * the package is published, and nothing else builds one. Each market's\n * `MarketQueue` sits at an ID derived from the registry and the market\n * (`queue::create_and_share`), so a deployment gives each market exactly one\n * queue, and with it one per-account cap, stuck gate, policy, and version floor.\n * The desk exists before Predict allowlists this package's witness; until\n * `protocol_config::set_order_flow` does, Predict's admission, commit, and fill\n * primitives refuse the companion.\n *\n * Predict's `AdminCap` administers the desk. Its setters check the desk floor and\n * refuse while Predict is frozen, through the public `protocol_config::frozen`;\n * the policy cannot move funds, and every Predict invariant holds inside Predict's\n * primitives whatever it says. Every trading call reads the desk, and only those\n * admin setters write it. Queue creation, which anyone may call, writes the\n * registry instead, which no trading call reads, so creation cannot contend with\n * trading.\n */\n\nimport {\n\tMoveStruct,\n\tnormalizeMoveArguments,\n\ttype RawTransactionArgument,\n\ttype ConfigValue,\n} from '../utils/index.js';\nimport { bcs } from '@mysten/sui/bcs';\nimport { U64 } from '../../bcs/integers.js';\nimport { type Transaction } from '@mysten/sui/transactions';\nimport * as delayed_execution_config from './delayed_execution_config.js';\nconst $moduleName = '@local-pkg/deepbook_predict_orders::desk';\nexport const OrderDesk = new MoveStruct({\n\tname: `${$moduleName}::OrderDesk`,\n\tfields: {\n\t\tid: bcs.Address,\n\t\tpolicy: delayed_execution_config.DelayedExecutionPolicy,\n\t\t/**\n\t\t * Minimum companion version permitted to run. Monotonic; `bump_version_watermark`\n\t\t * advances it to the running `current_version!()`, retiring older companion code.\n\t\t */\n\t\tversion_watermark: U64,\n\t},\n});\nexport const QueueRegistry = new MoveStruct({\n\tname: `${$moduleName}::QueueRegistry`,\n\tfields: {\n\t\tid: bcs.Address,\n\t\tdesk_id: bcs.Address,\n\t},\n});\nexport interface IdArguments {\n\tdesk?: RawTransactionArgument<string>;\n}\nexport interface IdOptions {\n\tpackage?: string;\n\targuments?: IdArguments;\n\tconfig?: {\n\t\torderDesk: ConfigValue;\n\t\tpredictOrdersPackageId?: string;\n\t};\n}\n/** Return the desk object ID for external discovery and PTB construction. */\nexport function id(options: IdOptions) {\n\tconst packageAddress =\n\t\toptions.package ??\n\t\toptions.config?.predictOrdersPackageId ??\n\t\t'@local-pkg/deepbook_predict_orders';\n\tconst argumentsTypes = [null] satisfies (string | null)[];\n\tconst parameterNames = ['desk'];\n\treturn (tx: Transaction) =>\n\t\ttx.moveCall({\n\t\t\tpackage: packageAddress,\n\t\t\tmodule: 'desk',\n\t\t\tfunction: 'id',\n\t\t\targuments: normalizeMoveArguments(\n\t\t\t\t{\n\t\t\t\t\t...options.arguments,\n\t\t\t\t\tdesk: options.arguments?.desk ?? options.config?.orderDesk,\n\t\t\t\t},\n\t\t\t\targumentsTypes,\n\t\t\t\tparameterNames,\n\t\t\t),\n\t\t});\n}\nexport interface PolicyArguments {\n\tdesk?: RawTransactionArgument<string>;\n}\nexport interface PolicyOptions {\n\tpackage?: string;\n\targuments?: PolicyArguments;\n\tconfig?: {\n\t\torderDesk: ConfigValue;\n\t\tpredictOrdersPackageId?: string;\n\t};\n}\n/** Return the policy, for SDK and devInspect reads. */\nexport function policy(options: PolicyOptions) {\n\tconst packageAddress =\n\t\toptions.package ??\n\t\toptions.config?.predictOrdersPackageId ??\n\t\t'@local-pkg/deepbook_predict_orders';\n\tconst argumentsTypes = [null] satisfies (string | null)[];\n\tconst parameterNames = ['desk'];\n\treturn (tx: Transaction) =>\n\t\ttx.moveCall({\n\t\t\tpackage: packageAddress,\n\t\t\tmodule: 'desk',\n\t\t\tfunction: 'policy',\n\t\t\targuments: normalizeMoveArguments(\n\t\t\t\t{\n\t\t\t\t\t...options.arguments,\n\t\t\t\t\tdesk: options.arguments?.desk ?? options.config?.orderDesk,\n\t\t\t\t},\n\t\t\t\targumentsTypes,\n\t\t\t\tparameterNames,\n\t\t\t),\n\t\t});\n}\nexport interface VersionWatermarkArguments {\n\tdesk?: RawTransactionArgument<string>;\n}\nexport interface VersionWatermarkOptions {\n\tpackage?: string;\n\targuments?: VersionWatermarkArguments;\n\tconfig?: {\n\t\torderDesk: ConfigValue;\n\t\tpredictOrdersPackageId?: string;\n\t};\n}\n/** Return the desk's version floor, for SDK and devInspect reads. */\nexport function versionWatermark(options: VersionWatermarkOptions) {\n\tconst packageAddress =\n\t\toptions.package ??\n\t\toptions.config?.predictOrdersPackageId ??\n\t\t'@local-pkg/deepbook_predict_orders';\n\tconst argumentsTypes = [null] satisfies (string | null)[];\n\tconst parameterNames = ['desk'];\n\treturn (tx: Transaction) =>\n\t\ttx.moveCall({\n\t\t\tpackage: packageAddress,\n\t\t\tmodule: 'desk',\n\t\t\tfunction: 'version_watermark',\n\t\t\targuments: normalizeMoveArguments(\n\t\t\t\t{\n\t\t\t\t\t...options.arguments,\n\t\t\t\t\tdesk: options.arguments?.desk ?? options.config?.orderDesk,\n\t\t\t\t},\n\t\t\t\targumentsTypes,\n\t\t\t\tparameterNames,\n\t\t\t),\n\t\t});\n}\nexport interface RegistryIdArguments {\n\tregistry?: RawTransactionArgument<string>;\n}\nexport interface RegistryIdOptions {\n\tpackage?: string;\n\targuments?: RegistryIdArguments;\n\tconfig?: {\n\t\tqueueRegistry: ConfigValue;\n\t\tpredictOrdersPackageId?: string;\n\t};\n}\n/**\n * Return the queue registry's object ID, for discovery and for deriving each\n * market's queue ID (`queue::queue_id`) in PTB construction.\n */\nexport function registryId(options: RegistryIdOptions) {\n\tconst packageAddress =\n\t\toptions.package ??\n\t\toptions.config?.predictOrdersPackageId ??\n\t\t'@local-pkg/deepbook_predict_orders';\n\tconst argumentsTypes = [null] satisfies (string | null)[];\n\tconst parameterNames = ['registry'];\n\treturn (tx: Transaction) =>\n\t\ttx.moveCall({\n\t\t\tpackage: packageAddress,\n\t\t\tmodule: 'desk',\n\t\t\tfunction: 'registry_id',\n\t\t\targuments: normalizeMoveArguments(\n\t\t\t\t{\n\t\t\t\t\t...options.arguments,\n\t\t\t\t\tregistry: options.arguments?.registry ?? options.config?.queueRegistry,\n\t\t\t\t},\n\t\t\t\targumentsTypes,\n\t\t\t\tparameterNames,\n\t\t\t),\n\t\t});\n}\nexport interface SetTimingArguments {\n\tdesk?: RawTransactionArgument<string>;\n\tAdminCap: RawTransactionArgument<string>;\n\tconfig?: RawTransactionArgument<string>;\n\tdelayMs: RawTransactionArgument<number | bigint>;\n\tstallTimeoutMs: RawTransactionArgument<number | bigint>;\n\tstuckThresholdMs: RawTransactionArgument<number | bigint>;\n\tgapWaitMs: RawTransactionArgument<number | bigint>;\n\tpythPriceBufferMs: RawTransactionArgument<number | bigint>;\n\tpythChannel: RawTransactionArgument<number>;\n\tsviMaxAgeMs: RawTransactionArgument<number | bigint>;\n}\nexport interface SetTimingOptions {\n\tpackage?: string;\n\targuments: SetTimingArguments;\n\tconfig?: {\n\t\torderDesk: ConfigValue;\n\t\tprotocolConfig: ConfigValue;\n\t\tpredictOrdersPackageId?: string;\n\t};\n}\n/**\n * Set every timing field and the Pyth channel in one call, so the relational rules\n * hold on the final state (`delayed_execution_config::set_timing`). Waiting orders\n * keep the τ, deadline, and channel they were placed with, so a new delay, stall\n * timeout, or channel reaches only new orders. Commit reads the buffer and gap\n * wait when it runs, so those also apply to waiting cohorts.\n */\nexport function setTiming(options: SetTimingOptions) {\n\tconst packageAddress =\n\t\toptions.package ??\n\t\toptions.config?.predictOrdersPackageId ??\n\t\t'@local-pkg/deepbook_predict_orders';\n\tconst argumentsTypes = [\n\t\tnull,\n\t\tnull,\n\t\tnull,\n\t\t'u64',\n\t\t'u64',\n\t\t'u64',\n\t\t'u64',\n\t\t'u64',\n\t\t'u8',\n\t\t'u64',\n\t\t'0x2::clock::Clock',\n\t] satisfies (string | null)[];\n\tconst parameterNames = [\n\t\t'desk',\n\t\t'AdminCap',\n\t\t'config',\n\t\t'delayMs',\n\t\t'stallTimeoutMs',\n\t\t'stuckThresholdMs',\n\t\t'gapWaitMs',\n\t\t'pythPriceBufferMs',\n\t\t'pythChannel',\n\t\t'sviMaxAgeMs',\n\t];\n\treturn (tx: Transaction) =>\n\t\ttx.moveCall({\n\t\t\tpackage: packageAddress,\n\t\t\tmodule: 'desk',\n\t\t\tfunction: 'set_timing',\n\t\t\targuments: normalizeMoveArguments(\n\t\t\t\t{\n\t\t\t\t\t...options.arguments,\n\t\t\t\t\tdesk: options.arguments?.desk ?? options.config?.orderDesk,\n\t\t\t\t\tconfig: options.arguments?.config ?? options.config?.protocolConfig,\n\t\t\t\t},\n\t\t\t\targumentsTypes,\n\t\t\t\tparameterNames,\n\t\t\t),\n\t\t});\n}\nexport interface SetLimitsArguments {\n\tdesk?: RawTransactionArgument<string>;\n\tAdminCap: RawTransactionArgument<string>;\n\tconfig?: RawTransactionArgument<string>;\n\tmintCapacity: RawTransactionArgument<number | bigint>;\n\tsellCapacity: RawTransactionArgument<number | bigint>;\n\tperAccountCap: RawTransactionArgument<number | bigint>;\n\tminSellQuantity: RawTransactionArgument<number | bigint>;\n\tsettleRefundBatch: RawTransactionArgument<number | bigint>;\n\tsettlePayoutBatch: RawTransactionArgument<number | bigint>;\n}\nexport interface SetLimitsOptions {\n\tpackage?: string;\n\targuments: SetLimitsArguments;\n\tconfig?: {\n\t\torderDesk: ConfigValue;\n\t\tprotocolConfig: ConfigValue;\n\t\tpredictOrdersPackageId?: string;\n\t};\n}\n/**\n * Set the queue capacities, the per-account cap, the minimum early sell, and the\n * two `settle_step` batch sizes. Lowering a capacity below the current pending\n * count only blocks new orders.\n */\nexport function setLimits(options: SetLimitsOptions) {\n\tconst packageAddress =\n\t\toptions.package ??\n\t\toptions.config?.predictOrdersPackageId ??\n\t\t'@local-pkg/deepbook_predict_orders';\n\tconst argumentsTypes = [\n\t\tnull,\n\t\tnull,\n\t\tnull,\n\t\t'u64',\n\t\t'u64',\n\t\t'u64',\n\t\t'u64',\n\t\t'u64',\n\t\t'u64',\n\t\t'0x2::clock::Clock',\n\t] satisfies (string | null)[];\n\tconst parameterNames = [\n\t\t'desk',\n\t\t'AdminCap',\n\t\t'config',\n\t\t'mintCapacity',\n\t\t'sellCapacity',\n\t\t'perAccountCap',\n\t\t'minSellQuantity',\n\t\t'settleRefundBatch',\n\t\t'settlePayoutBatch',\n\t];\n\treturn (tx: Transaction) =>\n\t\ttx.moveCall({\n\t\t\tpackage: packageAddress,\n\t\t\tmodule: 'desk',\n\t\t\tfunction: 'set_limits',\n\t\t\targuments: normalizeMoveArguments(\n\t\t\t\t{\n\t\t\t\t\t...options.arguments,\n\t\t\t\t\tdesk: options.arguments?.desk ?? options.config?.orderDesk,\n\t\t\t\t\tconfig: options.arguments?.config ?? options.config?.protocolConfig,\n\t\t\t\t},\n\t\t\t\targumentsTypes,\n\t\t\t\tparameterNames,\n\t\t\t),\n\t\t});\n}\nexport interface SetOrderFeeArguments {\n\tdesk?: RawTransactionArgument<string>;\n\tAdminCap: RawTransactionArgument<string>;\n\tconfig?: RawTransactionArgument<string>;\n\torderFee: RawTransactionArgument<number | bigint>;\n}\nexport interface SetOrderFeeOptions {\n\tpackage?: string;\n\targuments: SetOrderFeeArguments;\n\tconfig?: {\n\t\torderDesk: ConfigValue;\n\t\tprotocolConfig: ConfigValue;\n\t\tpredictOrdersPackageId?: string;\n\t};\n}\n/**\n * Set the flat fee charged per queued order, in USDC base units. Applies to orders\n * placed after the call; waiting orders keep the fee they paid.\n */\nexport function setOrderFee(options: SetOrderFeeOptions) {\n\tconst packageAddress =\n\t\toptions.package ??\n\t\toptions.config?.predictOrdersPackageId ??\n\t\t'@local-pkg/deepbook_predict_orders';\n\tconst argumentsTypes = [null, null, null, 'u64', '0x2::clock::Clock'] satisfies (string | null)[];\n\tconst parameterNames = ['desk', 'AdminCap', 'config', 'orderFee'];\n\treturn (tx: Transaction) =>\n\t\ttx.moveCall({\n\t\t\tpackage: packageAddress,\n\t\t\tmodule: 'desk',\n\t\t\tfunction: 'set_order_fee',\n\t\t\targuments: normalizeMoveArguments(\n\t\t\t\t{\n\t\t\t\t\t...options.arguments,\n\t\t\t\t\tdesk: options.arguments?.desk ?? options.config?.orderDesk,\n\t\t\t\t\tconfig: options.arguments?.config ?? options.config?.protocolConfig,\n\t\t\t\t},\n\t\t\t\targumentsTypes,\n\t\t\t\tparameterNames,\n\t\t\t),\n\t\t});\n}\nexport interface BumpVersionWatermarkArguments {\n\tdesk?: RawTransactionArgument<string>;\n\tAdminCap: RawTransactionArgument<string>;\n}\nexport interface BumpVersionWatermarkOptions {\n\tpackage?: string;\n\targuments: BumpVersionWatermarkArguments;\n\tconfig?: {\n\t\torderDesk: ConfigValue;\n\t\tpredictOrdersPackageId?: string;\n\t};\n}\n/**\n * Advance the desk floor to this package's compiled `current_version!()`, retiring\n * older companion code. Aborts unless the executing version is above the floor.\n */\nexport function bumpVersionWatermark(options: BumpVersionWatermarkOptions) {\n\tconst packageAddress =\n\t\toptions.package ??\n\t\toptions.config?.predictOrdersPackageId ??\n\t\t'@local-pkg/deepbook_predict_orders';\n\tconst argumentsTypes = [null, null] satisfies (string | null)[];\n\tconst parameterNames = ['desk', 'AdminCap'];\n\treturn (tx: Transaction) =>\n\t\ttx.moveCall({\n\t\t\tpackage: packageAddress,\n\t\t\tmodule: 'desk',\n\t\t\tfunction: 'bump_version_watermark',\n\t\t\targuments: normalizeMoveArguments(\n\t\t\t\t{\n\t\t\t\t\t...options.arguments,\n\t\t\t\t\tdesk: options.arguments?.desk ?? options.config?.orderDesk,\n\t\t\t\t},\n\t\t\t\targumentsTypes,\n\t\t\t\tparameterNames,\n\t\t\t),\n\t\t});\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCA,MAAM,cAAc;AACpB,MAAa,YAAY,IAAI,WAAW;CACvC,MAAM,GAAG,YAAY;CACrB,QAAQ;EACP,IAAI,IAAI;EACR,QAAQA;EAKR,mBAAmB;EACnB;CACD,CAAC;AACF,MAAa,gBAAgB,IAAI,WAAW;CAC3C,MAAM,GAAG,YAAY;CACrB,QAAQ;EACP,IAAI,IAAI;EACR,SAAS,IAAI;EACb;CACD,CAAC;;AAaF,SAAgB,GAAG,SAAoB;CACtC,MAAM,iBACL,QAAQ,WACR,QAAQ,QAAQ,0BAChB;CACD,MAAM,iBAAiB,CAAC,KAAK;CAC7B,MAAM,iBAAiB,CAAC,OAAO;AAC/B,SAAQ,OACP,GAAG,SAAS;EACX,SAAS;EACT,QAAQ;EACR,UAAU;EACV,WAAW,uBACV;GACC,GAAG,QAAQ;GACX,MAAM,QAAQ,WAAW,QAAQ,QAAQ,QAAQ;GACjD,EACD,gBACA,eACA;EACD,CAAC;;;AAcJ,SAAgB,OAAO,SAAwB;CAC9C,MAAM,iBACL,QAAQ,WACR,QAAQ,QAAQ,0BAChB;CACD,MAAM,iBAAiB,CAAC,KAAK;CAC7B,MAAM,iBAAiB,CAAC,OAAO;AAC/B,SAAQ,OACP,GAAG,SAAS;EACX,SAAS;EACT,QAAQ;EACR,UAAU;EACV,WAAW,uBACV;GACC,GAAG,QAAQ;GACX,MAAM,QAAQ,WAAW,QAAQ,QAAQ,QAAQ;GACjD,EACD,gBACA,eACA;EACD,CAAC;;;AAcJ,SAAgB,iBAAiB,SAAkC;CAClE,MAAM,iBACL,QAAQ,WACR,QAAQ,QAAQ,0BAChB;CACD,MAAM,iBAAiB,CAAC,KAAK;CAC7B,MAAM,iBAAiB,CAAC,OAAO;AAC/B,SAAQ,OACP,GAAG,SAAS;EACX,SAAS;EACT,QAAQ;EACR,UAAU;EACV,WAAW,uBACV;GACC,GAAG,QAAQ;GACX,MAAM,QAAQ,WAAW,QAAQ,QAAQ,QAAQ;GACjD,EACD,gBACA,eACA;EACD,CAAC;;;;;;AAiBJ,SAAgB,WAAW,SAA4B;CACtD,MAAM,iBACL,QAAQ,WACR,QAAQ,QAAQ,0BAChB;CACD,MAAM,iBAAiB,CAAC,KAAK;CAC7B,MAAM,iBAAiB,CAAC,WAAW;AACnC,SAAQ,OACP,GAAG,SAAS;EACX,SAAS;EACT,QAAQ;EACR,UAAU;EACV,WAAW,uBACV;GACC,GAAG,QAAQ;GACX,UAAU,QAAQ,WAAW,YAAY,QAAQ,QAAQ;GACzD,EACD,gBACA,eACA;EACD,CAAC;;;;;;;;;AA8BJ,SAAgB,UAAU,SAA2B;CACpD,MAAM,iBACL,QAAQ,WACR,QAAQ,QAAQ,0BAChB;CACD,MAAM,iBAAiB;EACtB;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;CACD,MAAM,iBAAiB;EACtB;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;AACD,SAAQ,OACP,GAAG,SAAS;EACX,SAAS;EACT,QAAQ;EACR,UAAU;EACV,WAAW,uBACV;GACC,GAAG,QAAQ;GACX,MAAM,QAAQ,WAAW,QAAQ,QAAQ,QAAQ;GACjD,QAAQ,QAAQ,WAAW,UAAU,QAAQ,QAAQ;GACrD,EACD,gBACA,eACA;EACD,CAAC;;;;;;;AA2BJ,SAAgB,UAAU,SAA2B;CACpD,MAAM,iBACL,QAAQ,WACR,QAAQ,QAAQ,0BAChB;CACD,MAAM,iBAAiB;EACtB;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;CACD,MAAM,iBAAiB;EACtB;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;AACD,SAAQ,OACP,GAAG,SAAS;EACX,SAAS;EACT,QAAQ;EACR,UAAU;EACV,WAAW,uBACV;GACC,GAAG,QAAQ;GACX,MAAM,QAAQ,WAAW,QAAQ,QAAQ,QAAQ;GACjD,QAAQ,QAAQ,WAAW,UAAU,QAAQ,QAAQ;GACrD,EACD,gBACA,eACA;EACD,CAAC;;;;;;AAqBJ,SAAgB,YAAY,SAA6B;CACxD,MAAM,iBACL,QAAQ,WACR,QAAQ,QAAQ,0BAChB;CACD,MAAM,iBAAiB;EAAC;EAAM;EAAM;EAAM;EAAO;EAAoB;CACrE,MAAM,iBAAiB;EAAC;EAAQ;EAAY;EAAU;EAAW;AACjE,SAAQ,OACP,GAAG,SAAS;EACX,SAAS;EACT,QAAQ;EACR,UAAU;EACV,WAAW,uBACV;GACC,GAAG,QAAQ;GACX,MAAM,QAAQ,WAAW,QAAQ,QAAQ,QAAQ;GACjD,QAAQ,QAAQ,WAAW,UAAU,QAAQ,QAAQ;GACrD,EACD,gBACA,eACA;EACD,CAAC;;;;;;AAkBJ,SAAgB,qBAAqB,SAAsC;CAC1E,MAAM,iBACL,QAAQ,WACR,QAAQ,QAAQ,0BAChB;CACD,MAAM,iBAAiB,CAAC,MAAM,KAAK;CACnC,MAAM,iBAAiB,CAAC,QAAQ,WAAW;AAC3C,SAAQ,OACP,GAAG,SAAS;EACX,SAAS;EACT,QAAQ;EACR,UAAU;EACV,WAAW,uBACV;GACC,GAAG,QAAQ;GACX,MAAM,QAAQ,WAAW,QAAQ,QAAQ,QAAQ;GACjD,EACD,gBACA,eACA;EACD,CAAC"}