@orderly.network/hooks 1.1.4-alpha.2 → 1.1.4-alpha.4

package/dist/index.d.mts

@@ -25,7 +25,7 @@ declare global {
         };
     }
 }
-declare const _default: "1.1.4-alpha.2";
+declare const _default: "1.1.4-alpha.4";
 
 type useQueryOptions<T> = SWRConfiguration & {
     formatter?: (data: any) => T;
@@ -244,21 +244,30 @@ type UseOrderEntryReturn = {
     metaState: UseOrderEntryMetaState;
     symbolConfig: API.SymbolExt;
 };
-type OrderParams = Required<Pick<OrderEntity, "side" | "order_type" | "symbol">> & Partial<Omit<OrderEntity, "side" | "symbol" | "order_type">> & {};
+type OrderParams = Required<Pick<OrderEntity, "side" | "order_type" | "symbol">> & Partial<Omit<OrderEntity, "side" | "symbol" | "order_type">>;
 /**
  * Create Order
  * @example
  * ```tsx
+ * import { useOrderEntry } from "@orderly.network/hooks";
+ * import {OrderSide, OrderType} from '@orderly.network/types';
+ *
  * const { formattedOrder, onSubmit, helper } = useOrderEntry({
  *  symbol: "PERP_ETH_USDC",
  *  side: OrderSide.BUY,
  *  order_type: OrderType.LIMIT,
  *  order_price: 10000,
  *  order_quantity: 1,
+ * },{
+ *  // **Note:** it's required
+ *  watchOrderbook: true,
  * });
  * ```
  */
 declare function useOrderEntry(order: OrderParams, options?: UseOrderEntryOptions): UseOrderEntryReturn;
+/**
+ * @deprecated
+ */
 declare function useOrderEntry(symbol: string, side: OrderSide, reduceOnly: boolean): UseOrderEntryReturn;
 
 declare const useSymbolsInfo: () => Record<string, any>;

package/dist/index.d.ts

@@ -25,7 +25,7 @@ declare global {
         };
     }
 }
-declare const _default: "1.1.4-alpha.2";
+declare const _default: "1.1.4-alpha.4";
 
 type useQueryOptions<T> = SWRConfiguration & {
     formatter?: (data: any) => T;
@@ -244,21 +244,30 @@ type UseOrderEntryReturn = {
     metaState: UseOrderEntryMetaState;
     symbolConfig: API.SymbolExt;
 };
-type OrderParams = Required<Pick<OrderEntity, "side" | "order_type" | "symbol">> & Partial<Omit<OrderEntity, "side" | "symbol" | "order_type">> & {};
+type OrderParams = Required<Pick<OrderEntity, "side" | "order_type" | "symbol">> & Partial<Omit<OrderEntity, "side" | "symbol" | "order_type">>;
 /**
  * Create Order
  * @example
  * ```tsx
+ * import { useOrderEntry } from "@orderly.network/hooks";
+ * import {OrderSide, OrderType} from '@orderly.network/types';
+ *
  * const { formattedOrder, onSubmit, helper } = useOrderEntry({
  *  symbol: "PERP_ETH_USDC",
  *  side: OrderSide.BUY,
  *  order_type: OrderType.LIMIT,
  *  order_price: 10000,
  *  order_quantity: 1,
+ * },{
+ *  // **Note:** it's required
+ *  watchOrderbook: true,
  * });
  * ```
  */
 declare function useOrderEntry(order: OrderParams, options?: UseOrderEntryOptions): UseOrderEntryReturn;
+/**
+ * @deprecated
+ */
 declare function useOrderEntry(symbol: string, side: OrderSide, reduceOnly: boolean): UseOrderEntryReturn;
 
 declare const useSymbolsInfo: () => Record<string, any>;

package/dist/index.js

@@ -28,9 +28,9 @@ var useSWRSubscription__default = /*#__PURE__*/_interopDefault(useSWRSubscriptio
 // src/version.ts
 if (typeof window !== "undefined") {
   window.__ORDERLY_VERSION__ = window.__ORDERLY_VERSION__ || {};
-  window.__ORDERLY_VERSION__["@orderly.network/hooks"] = "1.1.4-alpha.2";
+  window.__ORDERLY_VERSION__["@orderly.network/hooks"] = "1.1.4-alpha.4";
 }
-var version_default = "1.1.4-alpha.2";
+var version_default = "1.1.4-alpha.4";
 var fetcher = (url, init = {}, queryOptions) => net.get(url, init, queryOptions?.formatter);
 var OrderlyContext = React.createContext({
   // configStore: new MemoryConfigStore(),
@@ -446,6 +446,8 @@ var useWS = () => {
       account5.on("change:status", (nextState) => {
         if (nextState.status === types.AccountStatusEnum.EnableTrading && nextState.accountId) {
           websocketClient.openPrivate(nextState.accountId);
+        } else {
+          websocketClient.closePrivate();
         }
       });
       if (typeof window !== "undefined") {
@@ -2328,7 +2330,9 @@ var OrderFactory = class {
   }
 };
 function useOrderEntry(symbolOrOrder, sideOrOptions, reduceOnly, options) {
+  let isNewVersion = false;
   if (typeof symbolOrOrder === "object") {
+    isNewVersion = true;
     if (!symbolOrOrder.symbol) {
       throw new types.SDKError("symbol is required");
     }
@@ -2469,7 +2473,8 @@ function useOrderEntry(symbolOrOrder, sideOrOptions, reduceOnly, options) {
     needParse?.order_type_ext,
     needParse?.symbol,
     needParse?.reduce_only,
-    needParse?.side
+    needParse?.side,
+    needParse?.visible_quantity
   ]);
   const createOrder = (values) => {
     if (!values.symbol) {
@@ -2607,8 +2612,17 @@ function useOrderEntry(symbolOrOrder, sideOrOptions, reduceOnly, options) {
     markPrice
   ]);
   React.useEffect(() => {
-    if (!optionsValue?.watchOrderbook)
-      return;
+    if (isNewVersion) {
+      if (!optionsValue?.watchOrderbook) {
+        throw new types.SDKError(
+          "In order to calculate the estimated liquidation price, the `options.watchOrderbook` parameter must be set to true."
+        );
+      }
+    } else {
+      if (!optionsValue?.watchOrderbook) {
+        return;
+      }
+    }
     ee.on("orderbook:update", onOrderbookUpdate);
     return () => {
       ee.off("orderbook_update", onOrderbookUpdate);
@@ -2620,8 +2634,14 @@ function useOrderEntry(symbolOrOrder, sideOrOptions, reduceOnly, options) {
   const getPriceAndQty = (symbolOrOrder2) => {
     let quantity = Number(symbolOrOrder2.order_quantity);
     const orderPrice = Number(symbolOrOrder2.order_price);
-    if (isNaN(quantity) || quantity <= 0 || askAndBid.current.length === 0)
+    if (isNaN(quantity) || quantity <= 0) {
       return null;
+    }
+    if (!!options?.watchOrderbook && askAndBid.current.length === 0) {
+      throw new types.SDKError(
+        "Please check if you are using the `useOrderbookStream` hook or if the orderBook has data."
+      );
+    }
     if ((symbolOrOrder2.order_type === types.OrderType.LIMIT || symbolOrOrder2.order_type === types.OrderType.STOP_LIMIT) && isNaN(orderPrice))
       return null;
     let price;