@mysten/deepbook-v3 1.1.5 → 1.2.0

package/src/types/index.ts

@@ -55,8 +55,8 @@ export interface PlaceLimitOrderParams {
 	poolKey: string;
 	balanceManagerKey: string;
 	clientOrderId: string;
-	price: number;
-	quantity: number;
+	price: number | bigint;
+	quantity: number | bigint;
 	isBid: boolean;
 	expiration?: number | bigint;
 	orderType?: OrderType;
@@ -68,7 +68,7 @@ export interface PlaceMarketOrderParams {
 	poolKey: string;
 	balanceManagerKey: string;
 	clientOrderId: string;
-	quantity: number;
+	quantity: number | bigint;
 	isBid: boolean;
 	selfMatchingOption?: SelfMatchingOptions;
 	payWithDeep?: boolean;
@@ -77,8 +77,8 @@ export interface PlaceMarketOrderParams {
 export interface CanPlaceLimitOrderParams {
 	poolKey: string;
 	balanceManagerKey: string;
-	price: number;
-	quantity: number;
+	price: number | bigint;
+	quantity: number | bigint;
 	isBid: boolean;
 	payWithDeep: boolean;
 	expireTimestamp: number;
@@ -87,7 +87,7 @@ export interface CanPlaceLimitOrderParams {
 export interface CanPlaceMarketOrderParams {
 	poolKey: string;
 	balanceManagerKey: string;
-	quantity: number;
+	quantity: number | bigint;
 	isBid: boolean;
 	payWithDeep: boolean;
 }
@@ -96,8 +96,8 @@ export interface PlaceMarginLimitOrderParams {
 	poolKey: string;
 	marginManagerKey: string;
 	clientOrderId: string;
-	price: number;
-	quantity: number;
+	price: number | bigint;
+	quantity: number | bigint;
 	isBid: boolean;
 	expiration?: number | bigint;
 	orderType?: OrderType;
@@ -109,7 +109,7 @@ export interface PlaceMarginMarketOrderParams {
 	poolKey: string;
 	marginManagerKey: string;
 	clientOrderId: string;
-	quantity: number;
+	quantity: number | bigint;
 	isBid: boolean;
 	selfMatchingOption?: SelfMatchingOptions;
 	payWithDeep?: boolean;
@@ -119,8 +119,8 @@ export interface PendingLimitOrderParams {
 	clientOrderId: string;
 	orderType?: OrderType;
 	selfMatchingOption?: SelfMatchingOptions;
-	price: number;
-	quantity: number;
+	price: number | bigint;
+	quantity: number | bigint;
 	isBid: boolean;
 	payWithDeep?: boolean;
 	expireTimestamp?: number | bigint;
@@ -129,7 +129,7 @@ export interface PendingLimitOrderParams {
 export interface PendingMarketOrderParams {
 	clientOrderId: string;
 	selfMatchingOption?: SelfMatchingOptions;
-	quantity: number;
+	quantity: number | bigint;
 	isBid: boolean;
 	payWithDeep?: boolean;
 }
@@ -138,29 +138,29 @@ export interface AddConditionalOrderParams {
 	marginManagerKey: string;
 	conditionalOrderId: string;
 	triggerBelowPrice: boolean;
-	triggerPrice: number;
+	triggerPrice: number | bigint;
 	pendingOrder: PendingLimitOrderParams | PendingMarketOrderParams;
 }
 
 export interface ProposalParams {
 	poolKey: string;
 	balanceManagerKey: string;
-	takerFee: number;
-	makerFee: number;
-	stakeRequired: number;
+	takerFee: number | bigint;
+	makerFee: number | bigint;
+	stakeRequired: number | bigint;
 }
 
 export interface MarginProposalParams {
-	takerFee: number;
-	makerFee: number;
-	stakeRequired: number;
+	takerFee: number | bigint;
+	makerFee: number | bigint;
+	stakeRequired: number | bigint;
 }
 
 export interface SwapParams {
 	poolKey: string;
-	amount: number;
-	deepAmount: number;
-	minOut: number;
+	amount: number | bigint;
+	deepAmount: number | bigint;
+	minOut: number | bigint;
 	deepCoin?: TransactionObjectArgument;
 	baseCoin?: TransactionObjectArgument;
 	quoteCoin?: TransactionObjectArgument;
@@ -172,8 +172,8 @@ export interface SwapWithManagerParams {
 	tradeCap: string;
 	depositCap: string;
 	withdrawCap: string;
-	amount: number;
-	minOut: number;
+	amount: number | bigint;
+	minOut: number | bigint;
 	baseCoin?: TransactionObjectArgument;
 	quoteCoin?: TransactionObjectArgument;
 }
@@ -181,7 +181,7 @@ export interface SwapWithManagerParams {
 export interface StakeParams {
 	poolKey: string;
 	balanceManagerKey: string;
-	amount: number;
+	amount: number | bigint;
 }
 
 export interface VoteParams {
@@ -192,15 +192,15 @@ export interface VoteParams {
 
 export interface FlashLoanParams {
 	poolKey: string;
-	amount: number;
+	amount: number | bigint;
 }
 
 export interface CreatePoolAdminParams {
 	baseCoinKey: string;
 	quoteCoinKey: string;
-	tickSize: number;
-	lotSize: number;
-	minSize: number;
+	tickSize: number | bigint;
+	lotSize: number | bigint;
+	minSize: number | bigint;
 	whitelisted: boolean;
 	stablePool: boolean;
 }
@@ -208,42 +208,42 @@ export interface CreatePoolAdminParams {
 export interface CreatePermissionlessPoolParams {
 	baseCoinKey: string;
 	quoteCoinKey: string;
-	tickSize: number;
-	lotSize: number;
-	minSize: number;
+	tickSize: number | bigint;
+	lotSize: number | bigint;
+	minSize: number | bigint;
 	deepCoin?: TransactionObjectArgument;
 }
 
 export interface SetEwmaParams {
-	alpha: number;
-	zScoreThreshold: number;
-	additionalTakerFee: number;
+	alpha: number | bigint;
+	zScoreThreshold: number | bigint;
+	additionalTakerFee: number | bigint;
 }
 
 export interface PoolConfigParams {
-	minWithdrawRiskRatio: number;
-	minBorrowRiskRatio: number;
-	liquidationRiskRatio: number;
-	targetLiquidationRiskRatio: number;
-	userLiquidationReward: number;
-	poolLiquidationReward: number;
+	minWithdrawRiskRatio: number | bigint;
+	minBorrowRiskRatio: number | bigint;
+	liquidationRiskRatio: number | bigint;
+	targetLiquidationRiskRatio: number | bigint;
+	userLiquidationReward: number | bigint;
+	poolLiquidationReward: number | bigint;
 }
 
 export interface MarginPoolConfigParams {
-	supplyCap: number;
-	maxUtilizationRate: number;
-	referralSpread: number;
-	minBorrow: number;
-	rateLimitCapacity?: number;
-	rateLimitRefillRatePerMs?: number;
+	supplyCap: number | bigint;
+	maxUtilizationRate: number | bigint;
+	referralSpread: number | bigint;
+	minBorrow: number | bigint;
+	rateLimitCapacity?: number | bigint;
+	rateLimitRefillRatePerMs?: number | bigint;
 	rateLimitEnabled?: boolean;
 }
 
 export interface InterestConfigParams {
-	baseRate: number;
-	baseSlope: number;
-	optimalUtilization: number;
-	excessSlope: number;
+	baseRate: number | bigint;
+	baseSlope: number | bigint;
+	optimalUtilization: number | bigint;
+	excessSlope: number | bigint;
 }
 
 export interface Config {
@@ -252,13 +252,160 @@ export interface Config {
 	DEEP_TREASURY_ID: string;
 }
 
+// === Named Return Types ===
+
+// Balance
+export interface ManagerBalance {
+	coinType: string;
+	balance: number;
+}
+export interface VaultBalances {
+	base: number;
+	quote: number;
+	deep: number;
+}
+export interface LockedBalances {
+	base: number;
+	quote: number;
+	deep: number;
+}
+export interface ReferralBalances {
+	base: number;
+	quote: number;
+	deep: number;
+}
+
+// Pool
+export interface PoolTradeParams {
+	takerFee: number;
+	makerFee: number;
+	stakeRequired: number;
+}
+export interface PoolBookParams {
+	tickSize: number;
+	lotSize: number;
+	minSize: number;
+}
+export type PoolDeepPrice =
+	| { asset_is_base: true; deep_per_base: number }
+	| { asset_is_base: false; deep_per_quote: number };
+
+// Quantity calculations
+export interface QuoteQuantityOut {
+	baseQuantity: number;
+	baseOut: number;
+	quoteOut: number;
+	deepRequired: number;
+}
+export interface BaseQuantityOut {
+	quoteQuantity: number;
+	baseOut: number;
+	quoteOut: number;
+	deepRequired: number;
+}
+export interface QuantityOut {
+	baseQuantity: number;
+	quoteQuantity: number;
+	baseOut: number;
+	quoteOut: number;
+	deepRequired: number;
+}
+export interface BaseQuantityIn {
+	baseIn: number;
+	quoteOut: number;
+	deepRequired: number;
+}
+export interface QuoteQuantityIn {
+	baseOut: number;
+	quoteIn: number;
+	deepRequired: number;
+}
+export interface OrderDeepRequiredResult {
+	deepRequiredTaker: number;
+	deepRequiredMaker: number;
+}
+
+// Order book
+export interface Level2Range {
+	prices: number[];
+	quantities: number[];
+}
+export interface Level2TicksFromMid {
+	bid_prices: number[];
+	bid_quantities: number[];
+	ask_prices: number[];
+	ask_quantities: number[];
+}
+
+// Account
+export interface AccountBalances {
+	base: number;
+	quote: number;
+	deep: number;
+}
+export interface AccountInfo {
+	epoch: string;
+	open_orders: { contents: string[] };
+	taker_volume: number;
+	maker_volume: number;
+	active_stake: number;
+	inactive_stake: number;
+	created_proposal: boolean;
+	voted_proposal: string | null;
+	unclaimed_rebates: AccountBalances;
+	settled_balances: AccountBalances;
+	owed_balances: AccountBalances;
+}
+
+// Order
+export interface DecodedOrderId {
+	isBid: boolean;
+	price: number;
+	orderId: number;
+}
+
+// Margin
+export interface MarginManagerState {
+	managerId: string;
+	deepbookPoolId: string;
+	riskRatio: number;
+	baseAsset: string;
+	quoteAsset: string;
+	baseDebt: string;
+	quoteDebt: string;
+	basePythPrice: string;
+	basePythDecimals: number;
+	quotePythPrice: string;
+	quotePythDecimals: number;
+	currentPrice: bigint;
+	lowestTriggerAbovePrice: bigint;
+	highestTriggerBelowPrice: bigint;
+}
+export interface MarginManagerAssets {
+	baseAsset: string;
+	quoteAsset: string;
+}
+export interface MarginManagerDebts {
+	baseDebt: string;
+	quoteDebt: string;
+}
+export interface MarginManagerBalancesResult {
+	base: string;
+	quote: string;
+	deep: string;
+}
+export interface BorrowedShares {
+	baseShares: string;
+	quoteShares: string;
+}
+
 /**
  * Parameters for depositing into a margin manager.
  * Either `amount` (number) or `coin` (TransactionArgument) must be provided, but not both.
  */
 export type DepositParams = {
 	managerKey: string;
-} & ({ amount: number; coin?: never } | { amount?: never; coin: TransactionArgument });
+} & ({ amount: number | bigint; coin?: never } | { amount?: never; coin: TransactionArgument });
 
 /**
  * Parameters for depositing during margin manager initialization.
@@ -269,4 +416,4 @@ export type DepositDuringInitParams = {
 	manager: TransactionArgument;
 	poolKey: string;
 	coinType: string;
-} & ({ amount: number; coin?: never } | { amount?: never; coin: TransactionArgument });
+} & ({ amount: number | bigint; coin?: never } | { amount?: never; coin: TransactionArgument });

package/src/utils/conversion.ts

@@ -0,0 +1,33 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * Convert a quantity value (amount, deposit, etc.) to on-chain u64.
+ * If bigint: use as raw on-chain value. If number: scale with Math.round.
+ */
+export function convertQuantity(value: number | bigint, scalar: number): bigint {
+	return typeof value === 'bigint' ? value : BigInt(Math.round(value * scalar));
+}
+
+/**
+ * Convert a price value to on-chain u64.
+ * If bigint: use as raw on-chain value. If number: scale with cross-scalar formula.
+ */
+export function convertPrice(
+	value: number | bigint,
+	floatScalar: number,
+	quoteScalar: number,
+	baseScalar: number,
+): bigint {
+	return typeof value === 'bigint'
+		? value
+		: BigInt(Math.round((value * floatScalar * quoteScalar) / baseScalar));
+}
+
+/**
+ * Convert a rate/fee value to on-chain u64.
+ * If bigint: use as raw on-chain value. If number: scale with FLOAT_SCALAR.
+ */
+export function convertRate(value: number | bigint, floatScalar: number): bigint {
+	return typeof value === 'bigint' ? value : BigInt(Math.round(value * floatScalar));
+}