@mysten/deepbook-v3 1.6.7 → 2.0.1

package/package.json

@@ -2,7 +2,7 @@
   "name": "@mysten/deepbook-v3",
   "author": "Mysten Labs <build@mystenlabs.com>",
   "description": "Sui Deepbook SDK",
-  "version": "1.6.7",
+  "version": "2.0.1",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.mjs",
@@ -30,25 +30,25 @@
     "url": "https://github.com/MystenLabs/ts-sdks/issues/new"
   },
   "dependencies": {
-    "@noble/hashes": "^2.2.0",
-    "axios": "^1.18.1",
+    "@noble/hashes": "^2.3.0",
+    "axios": "^1.19.0",
     "axios-retry": "^4.5.0",
-    "@mysten/bcs": "^2.1.0"
+    "@mysten/bcs": "^2.1.1"
   },
   "devDependencies": {
     "@iarna/toml": "^2.2.5",
-    "@types/node": "^25.9.3",
+    "@types/node": "^26.2.0",
     "dotenv": "^17.4.2",
     "tmp": "^0.2.7",
     "ts-node": "^10.9.2",
     "ts-retry-promise": "^0.8.1",
-    "typescript": "^6.0.3",
-    "vite": "^8.0.16",
-    "vitest": "^4.1.8",
-    "wait-on": "^9.0.10"
+    "typescript": "^7.0.2",
+    "vite": "^8.2.1",
+    "vitest": "^4.1.10",
+    "wait-on": "^9.1.0"
   },
   "peerDependencies": {
-    "@mysten/sui": "^2.26.1"
+    "@mysten/sui": "^2.26.2"
   },
   "scripts": {
     "clean": "rm -rf tsconfig.tsbuildinfo ./dist",

package/src/client.ts

@@ -51,6 +51,7 @@ import type {
 	PoolBookParams,
 	PoolDeepPrice,
 	PoolTradeParams,
+	PythConfig,
 	QuantityOut,
 	QuoteQuantityIn,
 	QuoteQuantityOut,
@@ -73,7 +74,12 @@ export interface DeepBookOptions<Name = 'deepbook'> {
 	marginAdminCap?: string;
 	marginMaintainerCap?: string;
 	packageIds?: DeepbookPackageIds;
-	pyth?: { pythStateId: string; wormholeStateId: string };
+	pyth?: PythConfig;
+	/**
+	 * Bearer token for the Hermes serving Pyth's upgraded Core. Matches the option of the
+	 * same name in `@mysten/suins`, which takes the same credential.
+	 */
+	pythAccessToken?: string;
 	name?: Name;
 }
 
@@ -144,6 +150,7 @@ export class DeepBookClient {
 		marginMaintainerCap,
 		packageIds,
 		pyth,
+		pythAccessToken,
 	}: DeepBookClientOptions) {
 		const normalizedAddress = normalizeSuiAddress(address);
 		const config = new DeepBookConfig({
@@ -158,6 +165,7 @@ export class DeepBookClient {
 			marginMaintainerCap,
 			packageIds,
 			pyth,
+			pythAccessToken,
 		});
 
 		this.balanceManager = new BalanceManagerContract(config);

package/src/contracts/deepbook/balance_manager.ts

@@ -239,8 +239,7 @@ export function newWithCustomOwnerCapsV2<App extends BcsType<any>>(
 ) {
 	const packageAddress = options.package ?? '@deepbook/core';
 	const argumentsTypes = [`${options.typeArguments[0]}`, null, 'address'] satisfies (
-		| string
-		| null
+		string | null
 	)[];
 	const parameterNames = ['Witness', 'deepbookRegistry', 'owner'];
 	return (tx: Transaction) =>

package/src/contracts/deepbook/pool.ts

@@ -573,8 +573,7 @@ export interface SwapExactQuantityOptions {
 export function swapExactQuantity(options: SwapExactQuantityOptions) {
 	const packageAddress = options.package ?? '@deepbook/core';
 	const argumentsTypes = [null, null, null, null, 'u64', '0x2::clock::Clock'] satisfies (
-		| string
-		| null
+		string | null
 	)[];
 	const parameterNames = ['self', 'baseIn', 'quoteIn', 'deepIn', 'minOut'];
 	return (tx: Transaction) =>
@@ -676,8 +675,7 @@ export interface ModifyOrderOptions {
 export function modifyOrder(options: ModifyOrderOptions) {
 	const packageAddress = options.package ?? '@deepbook/core';
 	const argumentsTypes = [null, null, null, 'u128', 'u64', '0x2::clock::Clock'] satisfies (
-		| string
-		| null
+		string | null
 	)[];
 	const parameterNames = ['self', 'balanceManager', 'tradeProof', 'orderId', 'newQuantity'];
 	return (tx: Transaction) =>
@@ -716,8 +714,7 @@ export interface CancelOrderOptions {
 export function cancelOrder(options: CancelOrderOptions) {
 	const packageAddress = options.package ?? '@deepbook/core';
 	const argumentsTypes = [null, null, null, 'u128', '0x2::clock::Clock'] satisfies (
-		| string
-		| null
+		string | null
 	)[];
 	const parameterNames = ['self', 'balanceManager', 'tradeProof', 'orderId'];
 	return (tx: Transaction) =>
@@ -756,8 +753,7 @@ export interface CancelOrdersOptions {
 export function cancelOrders(options: CancelOrdersOptions) {
 	const packageAddress = options.package ?? '@deepbook/core';
 	const argumentsTypes = [null, null, null, 'vector<u128>', '0x2::clock::Clock'] satisfies (
-		| string
-		| null
+		string | null
 	)[];
 	const parameterNames = ['self', 'balanceManager', 'tradeProof', 'orderIds'];
 	return (tx: Transaction) =>
@@ -797,8 +793,7 @@ export interface CancelLiveOrderOptions {
 export function cancelLiveOrder(options: CancelLiveOrderOptions) {
 	const packageAddress = options.package ?? '@deepbook/core';
 	const argumentsTypes = [null, null, null, 'u128', '0x2::clock::Clock'] satisfies (
-		| string
-		| null
+		string | null
 	)[];
 	const parameterNames = ['self', 'balanceManager', 'tradeProof', 'orderId'];
 	return (tx: Transaction) =>
@@ -839,8 +834,7 @@ export interface CancelLiveOrdersOptions {
 export function cancelLiveOrders(options: CancelLiveOrdersOptions) {
 	const packageAddress = options.package ?? '@deepbook/core';
 	const argumentsTypes = [null, null, null, 'vector<u128>', '0x2::clock::Clock'] satisfies (
-		| string
-		| null
+		string | null
 	)[];
 	const parameterNames = ['self', 'balanceManager', 'tradeProof', 'orderIds'];
 	return (tx: Transaction) =>
@@ -1495,8 +1489,7 @@ export interface CreatePoolAdminOptions {
 export function createPoolAdmin(options: CreatePoolAdminOptions) {
 	const packageAddress = options.package ?? '@deepbook/core';
 	const argumentsTypes = [null, 'u64', 'u64', 'u64', 'bool', 'bool', null] satisfies (
-		| string
-		| null
+		string | null
 	)[];
 	const parameterNames = [
 		'registry',
@@ -1663,8 +1656,7 @@ export interface AdjustMinLotSizeAdminOptions {
 export function adjustMinLotSizeAdmin(options: AdjustMinLotSizeAdminOptions) {
 	const packageAddress = options.package ?? '@deepbook/core';
 	const argumentsTypes = [null, 'u64', 'u64', null, '0x2::clock::Clock'] satisfies (
-		| string
-		| null
+		string | null
 	)[];
 	const parameterNames = ['self', 'newLotSize', 'newMinSize', 'Cap'];
 	return (tx: Transaction) =>
@@ -1733,8 +1725,7 @@ export interface SetEwmaParamsOptions {
 export function setEwmaParams(options: SetEwmaParamsOptions) {
 	const packageAddress = options.package ?? '@deepbook/core';
 	const argumentsTypes = [null, null, 'u64', 'u64', 'u64', '0x2::clock::Clock'] satisfies (
-		| string
-		| null
+		string | null
 	)[];
 	const parameterNames = ['self', 'Cap', 'alpha', 'zScoreThreshold', 'additionalTakerFee'];
 	return (tx: Transaction) =>
@@ -2194,8 +2185,7 @@ export interface GetLevel2RangeOptions {
 export function getLevel2Range(options: GetLevel2RangeOptions) {
 	const packageAddress = options.package ?? '@deepbook/core';
 	const argumentsTypes = [null, 'u64', 'u64', 'bool', '0x2::clock::Clock'] satisfies (
-		| string
-		| null
+		string | null
 	)[];
 	const parameterNames = ['self', 'priceLow', 'priceHigh', 'isBid'];
 	return (tx: Transaction) =>
@@ -2532,8 +2522,7 @@ export interface CanPlaceMarketOrderOptions {
 export function canPlaceMarketOrder(options: CanPlaceMarketOrderOptions) {
 	const packageAddress = options.package ?? '@deepbook/core';
 	const argumentsTypes = [null, null, 'u64', 'bool', 'bool', '0x2::clock::Clock'] satisfies (
-		| string
-		| null
+		string | null
 	)[];
 	const parameterNames = ['self', 'balanceManager', 'quantity', 'isBid', 'payWithDeep'];
 	return (tx: Transaction) =>
@@ -2598,8 +2587,7 @@ export interface CheckLimitOrderParamsOptions {
 export function checkLimitOrderParams(options: CheckLimitOrderParamsOptions) {
 	const packageAddress = options.package ?? '@deepbook/core';
 	const argumentsTypes = [null, 'u64', 'u64', 'u64', '0x2::clock::Clock'] satisfies (
-		| string
-		| null
+		string | null
 	)[];
 	const parameterNames = ['self', 'price', 'quantity', 'expireTimestamp'];
 	return (tx: Transaction) =>

package/src/contracts/deepbook/registry.ts

@@ -470,8 +470,7 @@ export interface IsStablecoinArguments {
 export interface IsStablecoinOptions {
 	package?: string;
 	arguments:
-		| IsStablecoinArguments
-		| [self: RawTransactionArgument<string>, stableType: TransactionArgument];
+		IsStablecoinArguments | [self: RawTransactionArgument<string>, stableType: TransactionArgument];
 }
 /** Returns whether the given coin is whitelisted */
 export function isStablecoin(options: IsStablecoinOptions) {

package/src/contracts/deepbook_margin/margin_manager.ts

@@ -155,7 +155,8 @@ export interface AddConditionalOrderOptions {
  * _limit_ pending order is intentionally transient — when it triggers, the resting
  * order it places is clamped to `max_order_ttl_ms` (default 3 days) by
  * `clamp_expire_timestamp`, the same stale-price guard as any margin limit order.
- * For a permanent stop, use a market pending order.
+ * For a permanent stop, use a market pending order. Twin:
+ * `margin_manager_upgraded::add_conditional_order`. Edit both.
  */
 export function addConditionalOrder(options: AddConditionalOrderOptions) {
 	const packageAddress = options.package ?? '@deepbook/margin';
@@ -273,8 +274,7 @@ export interface ExecuteConditionalOrdersOptions {
 export function executeConditionalOrders(options: ExecuteConditionalOrdersOptions) {
 	const packageAddress = options.package ?? '@deepbook/margin';
 	const argumentsTypes = [null, null, null, null, null, 'u64', '0x2::clock::Clock'] satisfies (
-		| string
-		| null
+		string | null
 	)[];
 	const parameterNames = [
 		'Self',
@@ -326,7 +326,8 @@ export interface ExecuteConditionalOrdersV2Options {
  * v2 adds `base_margin_pool` + `quote_margin_pool` parameters and enforces a
  * post-fill `risk_ratio >= min_borrow_risk_ratio` invariant inside the inner loop.
  * If any single triggered fill would breach that floor, the entire txn aborts — no
- * partial-state landing.
+ * partial-state landing. Twin:
+ * `margin_manager_upgraded::execute_conditional_orders_v2`. Edit both.
  */
 export function executeConditionalOrdersV2(options: ExecuteConditionalOrdersV2Options) {
 	const packageAddress = options.package ?? '@deepbook/margin';
@@ -396,7 +397,8 @@ export interface ExecuteConditionalOrdersV3Options {
  * This is what lets a stop-loss fire in the `liquidation..min_borrow` danger band:
  * a swap alone only lowers the oracle-valued ratio (so the v2 borrow-floor gate
  * rejects it), while repaying actually improves it. If a single triggered fill
- * would worsen net solvency the whole txn aborts — no partial-state landing.
+ * would worsen net solvency the whole txn aborts — no partial-state landing. Twin:
+ * `margin_manager_upgraded::execute_conditional_orders_v3`. Edit both.
  */
 export function executeConditionalOrdersV3(options: ExecuteConditionalOrdersV3Options) {
 	const packageAddress = options.package ?? '@deepbook/margin';
@@ -500,8 +502,7 @@ export interface ShareArguments {
 export interface ShareOptions {
 	package?: string;
 	arguments:
-		| ShareArguments
-		| [manager: RawTransactionArgument<string>, initializer: TransactionArgument];
+		ShareArguments | [manager: RawTransactionArgument<string>, initializer: TransactionArgument];
 	typeArguments: [string, string];
 }
 /** Shares the margin manager. The initializer is dropped in the process. */
@@ -618,6 +619,60 @@ export function unsetMarginManagerReferral(options: UnsetMarginManagerReferralOp
 			typeArguments: options.typeArguments,
 		});
 }
+export interface SetReferralArguments {
+	Self: RawTransactionArgument<string>;
+	ReferralCap: RawTransactionArgument<string>;
+}
+export interface SetReferralOptions {
+	package?: string;
+	arguments:
+		| SetReferralArguments
+		| [Self: RawTransactionArgument<string>, ReferralCap: RawTransactionArgument<string>];
+	typeArguments: [string, string];
+}
+/**
+ * Superseded by `set_margin_manager_referral`, which takes a pool-scoped
+ * `DeepBookPoolReferral`. Retained as an aborting stub because it is public in the
+ * deployed package: a `compatible` upgrade cannot drop a public function.
+ */
+export function setReferral(options: SetReferralOptions) {
+	const packageAddress = options.package ?? '@deepbook/margin';
+	const argumentsTypes = [null, null] satisfies (string | null)[];
+	const parameterNames = ['Self', 'ReferralCap'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'margin_manager',
+			function: 'set_referral',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+			typeArguments: options.typeArguments,
+		});
+}
+export interface UnsetReferralArguments {
+	Self: RawTransactionArgument<string>;
+}
+export interface UnsetReferralOptions {
+	package?: string;
+	arguments: UnsetReferralArguments | [Self: RawTransactionArgument<string>];
+	typeArguments: [string, string];
+}
+/**
+ * Superseded by `unset_margin_manager_referral`, which is pool-scoped. Retained as
+ * an aborting stub for the same reason as `set_referral`.
+ */
+export function unsetReferral(options: UnsetReferralOptions) {
+	const packageAddress = options.package ?? '@deepbook/margin';
+	const argumentsTypes = [null] satisfies (string | null)[];
+	const parameterNames = ['Self'];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'margin_manager',
+			function: 'unset_referral',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+			typeArguments: options.typeArguments,
+		});
+}
 export interface DepositArguments {
 	self: RawTransactionArgument<string>;
 	registry: RawTransactionArgument<string>;
@@ -640,13 +695,13 @@ export interface DepositOptions {
 }
 /**
  * Deposit a coin into the margin manager. The coin must be of the same type as
- * either the base, quote, or DEEP.
+ * either the base, quote, or DEEP. Twin: `margin_manager_upgraded::deposit`. Edit
+ * both.
  */
 export function deposit(options: DepositOptions) {
 	const packageAddress = options.package ?? '@deepbook/margin';
 	const argumentsTypes = [null, null, null, null, null, '0x2::clock::Clock'] satisfies (
-		| string
-		| null
+		string | null
 	)[];
 	const parameterNames = ['self', 'registry', 'baseOracle', 'quoteOracle', 'coin'];
 	return (tx: Transaction) =>
@@ -687,7 +742,8 @@ export interface WithdrawOptions {
 /**
  * Withdraw a specified amount of an asset from the margin manager. The asset must
  * be of the same type as either the base, quote, or DEEP. The withdrawal is
- * subject to the risk ratio limit.
+ * subject to the risk ratio limit. Twin: `margin_manager_upgraded::withdraw`. Edit
+ * both.
  */
 export function withdraw(options: WithdrawOptions) {
 	const packageAddress = options.package ?? '@deepbook/margin';
@@ -745,7 +801,10 @@ export interface BorrowBaseOptions {
 		  ];
 	typeArguments: [string, string];
 }
-/** Borrow the base asset using the margin manager. */
+/**
+ * Borrow the base asset using the margin manager. Twin:
+ * `margin_manager_upgraded::borrow_base`. Edit both.
+ */
 export function borrowBase(options: BorrowBaseOptions) {
 	const packageAddress = options.package ?? '@deepbook/margin';
 	const argumentsTypes = [
@@ -800,7 +859,10 @@ export interface BorrowQuoteOptions {
 		  ];
 	typeArguments: [string, string];
 }
-/** Borrow the quote asset using the margin manager. */
+/**
+ * Borrow the quote asset using the margin manager. Twin:
+ * `margin_manager_upgraded::borrow_quote`. Edit both.
+ */
 export function borrowQuote(options: BorrowQuoteOptions) {
 	const packageAddress = options.package ?? '@deepbook/margin';
 	const argumentsTypes = [
@@ -937,11 +999,11 @@ export interface LiquidateOptions {
 		  ];
 	typeArguments: [string, string, string];
 }
+/** Twin: `margin_manager_upgraded::liquidate`. Edit both. */
 export function liquidate(options: LiquidateOptions) {
 	const packageAddress = options.package ?? '@deepbook/margin';
 	const argumentsTypes = [null, null, null, null, null, null, null, '0x2::clock::Clock'] satisfies (
-		| string
-		| null
+		string | null
 	)[];
 	const parameterNames = [
 		'self',
@@ -985,11 +1047,11 @@ export interface RiskRatioOptions {
 		  ];
 	typeArguments: [string, string];
 }
+/** Twin: `margin_manager_upgraded::risk_ratio`. Edit both. */
 export function riskRatio(options: RiskRatioOptions) {
 	const packageAddress = options.package ?? '@deepbook/margin';
 	const argumentsTypes = [null, null, null, null, null, null, null, '0x2::clock::Clock'] satisfies (
-		| string
-		| null
+		string | null
 	)[];
 	const parameterNames = [
 		'self',
@@ -1034,14 +1096,15 @@ export interface RiskRatioUnsafeOptions {
 	typeArguments: [string, string];
 }
 /**
- * Returns the risk ratio without validating oracle price staleness or confidence.
- * Use for read-only queries where stale prices are acceptable.
+ * Returns the risk ratio without validating staleness, EWMA divergence or
+ * confidence - only the feed id is checked. Use for read-only queries where stale
+ * prices are acceptable. Twin: `margin_manager_upgraded::risk_ratio_unsafe`. Edit
+ * both.
  */
 export function riskRatioUnsafe(options: RiskRatioUnsafeOptions) {
 	const packageAddress = options.package ?? '@deepbook/margin';
 	const argumentsTypes = [null, null, null, null, null, null, null, '0x2::clock::Clock'] satisfies (
-		| string
-		| null
+		string | null
 	)[];
 	const parameterNames = [
 		'self',
@@ -1223,13 +1286,13 @@ export interface ManagerStateOptions {
  * (manager_id, deepbook_pool_id, risk_ratio, base_asset, quote_asset, base_debt,
  * quote_debt, base_pyth_price, base_pyth_decimals, quote_pyth_price,
  * quote_pyth_decimals, current_price, lowest_trigger_above_price,
- * highest_trigger_below_price)
+ * highest_trigger_below_price) Twin: `margin_manager_upgraded::manager_state`.
+ * Edit both.
  */
 export function managerState(options: ManagerStateOptions) {
 	const packageAddress = options.package ?? '@deepbook/margin';
 	const argumentsTypes = [null, null, null, null, null, null, null, '0x2::clock::Clock'] satisfies (
-		| string
-		| null
+		string | null
 	)[];
 	const parameterNames = [
 		'self',
@@ -1249,6 +1312,66 @@ export function managerState(options: ManagerStateOptions) {
 			typeArguments: options.typeArguments,
 		});
 }
+export interface ManagerStatesArguments {
+	marginManagers: TransactionArgument;
+	registry: RawTransactionArgument<string>;
+	baseOracle: RawTransactionArgument<string>;
+	quoteOracle: RawTransactionArgument<string>;
+	pool: RawTransactionArgument<string>;
+	baseMarginPool: RawTransactionArgument<string>;
+	quoteMarginPool: RawTransactionArgument<string>;
+}
+export interface ManagerStatesOptions {
+	package?: string;
+	arguments:
+		| ManagerStatesArguments
+		| [
+				marginManagers: TransactionArgument,
+				registry: RawTransactionArgument<string>,
+				baseOracle: RawTransactionArgument<string>,
+				quoteOracle: RawTransactionArgument<string>,
+				pool: RawTransactionArgument<string>,
+				baseMarginPool: RawTransactionArgument<string>,
+				quoteMarginPool: RawTransactionArgument<string>,
+		  ];
+	typeArguments: [string, string];
+}
+/**
+ * Returns comprehensive state information for multiple margin managers. Same as
+ * manager_state but takes a vector and returns vectors of all values. All managers
+ * must be of the same type. Twin: `margin_manager_upgraded::manager_states`. Edit
+ * both.
+ */
+export function managerStates(options: ManagerStatesOptions) {
+	const packageAddress = options.package ?? '@deepbook/margin';
+	const argumentsTypes = [
+		'vector<null>',
+		null,
+		null,
+		null,
+		null,
+		null,
+		null,
+		'0x2::clock::Clock',
+	] satisfies (string | null)[];
+	const parameterNames = [
+		'marginManagers',
+		'registry',
+		'baseOracle',
+		'quoteOracle',
+		'pool',
+		'baseMarginPool',
+		'quoteMarginPool',
+	];
+	return (tx: Transaction) =>
+		tx.moveCall({
+			package: packageAddress,
+			module: 'margin_manager',
+			function: 'manager_states',
+			arguments: normalizeMoveArguments(options.arguments, argumentsTypes, parameterNames),
+			typeArguments: options.typeArguments,
+		});
+}
 export interface IdArguments {
 	self: RawTransactionArgument<string>;
 }
@@ -1663,8 +1786,7 @@ export interface AccountArguments {
 export interface AccountOptions {
 	package?: string;
 	arguments:
-		| AccountArguments
-		| [self: RawTransactionArgument<string>, pool: RawTransactionArgument<string>];
+		AccountArguments | [self: RawTransactionArgument<string>, pool: RawTransactionArgument<string>];
 	typeArguments: [string, string];
 }
 export function account(options: AccountOptions) {
@@ -1757,8 +1879,7 @@ export interface CanPlaceMarketOrderOptions {
 export function canPlaceMarketOrder(options: CanPlaceMarketOrderOptions) {
 	const packageAddress = options.package ?? '@deepbook/margin';
 	const argumentsTypes = [null, null, 'u64', 'bool', 'bool', '0x2::clock::Clock'] satisfies (
-		| string
-		| null
+		string | null
 	)[];
 	const parameterNames = ['self', 'pool', 'quantity', 'isBid', 'payWithDeep'];
 	return (tx: Transaction) =>