@orderly.network/hooks 2.1.3 → 2.2.0

package/dist/index.d.mts

@@ -14,8 +14,8 @@ export { default as useConstant } from 'use-constant';
 import { WS } from '@orderly.network/net';
 import * as react from 'react';
 import { PropsWithChildren, FC, ReactNode } from 'react';
-import { SolanaWalletProvider } from '@orderly.network/default-solana-adapter';
 import { EIP1193Provider } from '@web3-onboard/common';
+import { SolanaWalletProvider } from '@orderly.network/default-solana-adapter';
 import * as swr_subscription from 'swr/subscription';
 import * as _orderly_network_utils from '@orderly.network/utils';
 export * from 'use-debounce';
@@ -29,7 +29,7 @@ declare global {
         };
     }
 }
-declare const _default: "2.1.3";
+declare const _default: "2.2.0";
 
 type useQueryOptions<T> = SWRConfiguration & {
     formatter?: (data: any) => T;
@@ -58,7 +58,23 @@ type HTTP_METHOD = "POST" | "PUT" | "DELETE" | "GET";
 /**
  * This hook is used to execute API requests for data mutation, such as POST, DELETE, PUT, etc.
  */
-declare const useMutation: <T, E>(url: string, method?: HTTP_METHOD, options?: SWRMutationConfiguration<T, E>) => readonly [(data: Record<string, any> | null, params?: Record<string, any>, options?: SWRMutationConfiguration<T, E>) => Promise<any>, {
+declare const useMutation: <T, E>(
+/**
+ * The URL to send the request to. If the URL does not start with "http",
+ * it will be prefixed with the API base URL.
+ */
+url: string, 
+/**
+ * The HTTP method to use for the request. Defaults to "POST".
+ */
+method?: HTTP_METHOD, 
+/**
+ * The configuration object for the mutation.
+ * @see [useSWRMutation](https://swr.vercel.app/docs/mutation#api)
+ *
+ * @link https://swr.vercel.app/docs/mutation#api
+ */
+options?: SWRMutationConfiguration<T, E>) => readonly [(data: Record<string, any> | null, params?: Record<string, any>, options?: SWRMutationConfiguration<T, E>) => Promise<any>, {
     readonly data: any;
     readonly error: E | undefined;
     readonly reset: () => void;
@@ -263,6 +279,7 @@ interface WalletState {
     accounts: WalletAccount[];
     chains: ConnectedChain[];
     instance?: unknown;
+    additionalInfo?: Record<string, any>;
 }
 interface WalletConnectorContextState {
     connect: (options?: any) => Promise<WalletState[]>;
@@ -489,7 +506,17 @@ declare const useMarkPrice: (symbol: string) => {
 
 declare const useIndexPrice: (symbol: string) => swr_subscription.SWRSubscriptionResponse<any, any>;
 
-declare const useLeverage: () => any;
+declare const useLeverage: () => {
+    readonly update: (data: {
+        leverage: number;
+    }) => Promise<{
+        max_leverage: string | number;
+    } | undefined>;
+    readonly isLoading: boolean;
+    readonly leverageLevers: number[];
+    readonly curLeverage: number;
+    readonly maxLeverage: number;
+};
 
 declare const useTickerStream: (symbol: string) => API.MarketInfo & {
     change?: number;
@@ -521,7 +548,11 @@ declare const useFundingRateHistory: () => {
 };
 
 type PriceMode = "markPrice" | "lastPrice";
-declare const usePositionStream: (symbol?: string, options?: SWRConfiguration & {
+declare const usePositionStream: (
+/**
+ * If symbol is passed, only the position of that symbol will be returned.
+ */
+symbol?: string, options?: SWRConfiguration & {
     calcMode?: PriceMode;
     /**
      * If true, the pending order will be included in the result.
@@ -563,7 +594,11 @@ declare const usePositionStream: (symbol?: string, options?: SWRConfiguration &
 }];
 
 type CombineOrderType = AlgoOrderRootType | "ALL";
-declare const useOrderStream: (params: {
+declare const useOrderStream: (
+/**
+ * Orders query params
+ */
+params: {
     symbol?: string;
     status?: OrderStatus;
     page?: number;
@@ -838,7 +873,11 @@ ComputedAlgoOrder, {
     isUpdateMutating: boolean;
 }];
 
-declare const useTPSLOrder: (position: Partial<API.PositionTPSLExt> & Pick<API.PositionTPSLExt, "symbol" | "average_open_price" | "position_qty">, options?: {
+declare const useTPSLOrder: (
+/**
+ * Position that needs to set take profit and stop loss
+ */
+position: Partial<API.PositionTPSLExt> & Pick<API.PositionTPSLExt, "symbol" | "average_open_price" | "position_qty">, options?: {
     /**
      * You can set the default value for the take profit and stop loss order,
      * it is usually used when editing order
@@ -1133,7 +1172,11 @@ type DrawOptions = {
  * });
  * ```
  */
-declare const usePoster: (data: DrawOptions, options?: {
+declare const usePoster: (
+/**
+ * The options to draw the poster
+ */
+data: DrawOptions, options?: {
     /**
      * The ratio of the poster
      */

package/dist/index.d.ts

@@ -14,8 +14,8 @@ export { default as useConstant } from 'use-constant';
 import { WS } from '@orderly.network/net';
 import * as react from 'react';
 import { PropsWithChildren, FC, ReactNode } from 'react';
-import { SolanaWalletProvider } from '@orderly.network/default-solana-adapter';
 import { EIP1193Provider } from '@web3-onboard/common';
+import { SolanaWalletProvider } from '@orderly.network/default-solana-adapter';
 import * as swr_subscription from 'swr/subscription';
 import * as _orderly_network_utils from '@orderly.network/utils';
 export * from 'use-debounce';
@@ -29,7 +29,7 @@ declare global {
         };
     }
 }
-declare const _default: "2.1.3";
+declare const _default: "2.2.0";
 
 type useQueryOptions<T> = SWRConfiguration & {
     formatter?: (data: any) => T;
@@ -58,7 +58,23 @@ type HTTP_METHOD = "POST" | "PUT" | "DELETE" | "GET";
 /**
  * This hook is used to execute API requests for data mutation, such as POST, DELETE, PUT, etc.
  */
-declare const useMutation: <T, E>(url: string, method?: HTTP_METHOD, options?: SWRMutationConfiguration<T, E>) => readonly [(data: Record<string, any> | null, params?: Record<string, any>, options?: SWRMutationConfiguration<T, E>) => Promise<any>, {
+declare const useMutation: <T, E>(
+/**
+ * The URL to send the request to. If the URL does not start with "http",
+ * it will be prefixed with the API base URL.
+ */
+url: string, 
+/**
+ * The HTTP method to use for the request. Defaults to "POST".
+ */
+method?: HTTP_METHOD, 
+/**
+ * The configuration object for the mutation.
+ * @see [useSWRMutation](https://swr.vercel.app/docs/mutation#api)
+ *
+ * @link https://swr.vercel.app/docs/mutation#api
+ */
+options?: SWRMutationConfiguration<T, E>) => readonly [(data: Record<string, any> | null, params?: Record<string, any>, options?: SWRMutationConfiguration<T, E>) => Promise<any>, {
     readonly data: any;
     readonly error: E | undefined;
     readonly reset: () => void;
@@ -263,6 +279,7 @@ interface WalletState {
     accounts: WalletAccount[];
     chains: ConnectedChain[];
     instance?: unknown;
+    additionalInfo?: Record<string, any>;
 }
 interface WalletConnectorContextState {
     connect: (options?: any) => Promise<WalletState[]>;
@@ -489,7 +506,17 @@ declare const useMarkPrice: (symbol: string) => {
 
 declare const useIndexPrice: (symbol: string) => swr_subscription.SWRSubscriptionResponse<any, any>;
 
-declare const useLeverage: () => any;
+declare const useLeverage: () => {
+    readonly update: (data: {
+        leverage: number;
+    }) => Promise<{
+        max_leverage: string | number;
+    } | undefined>;
+    readonly isLoading: boolean;
+    readonly leverageLevers: number[];
+    readonly curLeverage: number;
+    readonly maxLeverage: number;
+};
 
 declare const useTickerStream: (symbol: string) => API.MarketInfo & {
     change?: number;
@@ -521,7 +548,11 @@ declare const useFundingRateHistory: () => {
 };
 
 type PriceMode = "markPrice" | "lastPrice";
-declare const usePositionStream: (symbol?: string, options?: SWRConfiguration & {
+declare const usePositionStream: (
+/**
+ * If symbol is passed, only the position of that symbol will be returned.
+ */
+symbol?: string, options?: SWRConfiguration & {
     calcMode?: PriceMode;
     /**
      * If true, the pending order will be included in the result.
@@ -563,7 +594,11 @@ declare const usePositionStream: (symbol?: string, options?: SWRConfiguration &
 }];
 
 type CombineOrderType = AlgoOrderRootType | "ALL";
-declare const useOrderStream: (params: {
+declare const useOrderStream: (
+/**
+ * Orders query params
+ */
+params: {
     symbol?: string;
     status?: OrderStatus;
     page?: number;
@@ -838,7 +873,11 @@ ComputedAlgoOrder, {
     isUpdateMutating: boolean;
 }];
 
-declare const useTPSLOrder: (position: Partial<API.PositionTPSLExt> & Pick<API.PositionTPSLExt, "symbol" | "average_open_price" | "position_qty">, options?: {
+declare const useTPSLOrder: (
+/**
+ * Position that needs to set take profit and stop loss
+ */
+position: Partial<API.PositionTPSLExt> & Pick<API.PositionTPSLExt, "symbol" | "average_open_price" | "position_qty">, options?: {
     /**
      * You can set the default value for the take profit and stop loss order,
      * it is usually used when editing order
@@ -1133,7 +1172,11 @@ type DrawOptions = {
  * });
  * ```
  */
-declare const usePoster: (data: DrawOptions, options?: {
+declare const usePoster: (
+/**
+ * The options to draw the poster
+ */
+data: DrawOptions, options?: {
     /**
      * The ratio of the poster
      */

package/dist/index.js

@@ -61,9 +61,9 @@ var __export = (target, all) => {
 // src/version.ts
 if (typeof window !== "undefined") {
   window.__ORDERLY_VERSION__ = window.__ORDERLY_VERSION__ || {};
-  window.__ORDERLY_VERSION__["@orderly.network/hooks"] = "2.1.3";
+  window.__ORDERLY_VERSION__["@orderly.network/hooks"] = "2.2.0";
 }
-var version_default = "2.1.3";
+var version_default = "2.2.0";
 var fetcher = (url, init2 = {}, queryOptions) => net.get(url, init2, queryOptions?.formatter);
 var OrderlyContext = React.createContext({
   // configStore: new MemoryConfigStore(),
@@ -3144,30 +3144,59 @@ var useMarkPricesStream = () => {
   const data = useMarkPriceStore((state) => state.markPrices);
   return { data };
 };
+var generateLeverageLevers = (max3) => {
+  const min3 = 1;
+  const parts = 5;
+  const step = (max3 - min3) / (parts - 1);
+  const result = [];
+  for (let i = 0; i < parts; i++) {
+    result.push(Math.floor(min3 + step * i));
+  }
+  return result;
+};
 var useLeverage = () => {
-  const { data, mutate: mutate3 } = usePrivateQuery("/v1/client/info");
+  const { data, mutate: mutate3 } = usePrivateQuery(
+    "/v1/client/info"
+  );
   const [update, { isMutating }] = useMutation("/v1/client/leverage");
-  const { data: config } = useQuery("/v1/public/config", {
-    revalidateOnFocus: false
+  const { data: leverageConfig, isLoading } = useQuery("/v1/public/leverage", {
+    revalidateOnFocus: false,
+    errorRetryCount: 3
+    // formatter: (data) => data,
   });
-  const updateLeverage = React.useCallback((data2) => {
-    return update(data2).then((res) => {
+  const updateLeverage = React.useCallback(
+    async (data2) => {
+      const res = await update(data2);
       if (res.success) {
         return mutate3();
       } else {
         throw new Error(res.message);
       }
-    });
-  }, []);
-  return [
-    ramda.prop("max_leverage", data),
-    {
-      update: updateLeverage,
-      isMutating,
-      // config: [1, 2, 3, 4, 5, 10, 15, 20],
-      config: config ? config?.available_futures_leverage?.split(",").map((item) => parseInt(item)) : []
-    }
-  ];
+    },
+    [update, mutate3]
+  );
+  const memoizedCurLeverage = React.useMemo(() => {
+    if (data?.max_leverage !== void 0) {
+      return Number(data.max_leverage);
+    }
+    return 1;
+  }, [data?.max_leverage]);
+  const memoizedMaxLeverage = React.useMemo(() => {
+    if (leverageConfig?.max_futures_leverage !== void 0) {
+      return Number(leverageConfig.max_futures_leverage);
+    }
+    return 1;
+  }, [leverageConfig?.max_futures_leverage]);
+  const memoizedLeverageLevers = React.useMemo(() => {
+    return generateLeverageLevers(memoizedMaxLeverage);
+  }, [memoizedMaxLeverage]);
+  return {
+    update: updateLeverage,
+    isLoading: isLoading || isMutating,
+    leverageLevers: memoizedLeverageLevers,
+    curLeverage: memoizedCurLeverage,
+    maxLeverage: memoizedMaxLeverage
+  };
 };
 var useFundingRate = (symbol) => {
   if (!symbol) {
@@ -3893,15 +3922,17 @@ var useMarginRatio = () => {
   }, [rows, notional]);
   return { marginRatio, currentLeverage, mmr };
 };
-var TestNetWhiteList = [421614, 901901901, types.MONAD_TESTNET_CHAINID];
+var TestNetWhiteList = [
+  types.ARBITRUM_TESTNET_CHAINID,
+  types.SOLANA_TESTNET_CHAINID,
+  types.MONAD_TESTNET_CHAINID,
+  types.ABSTRACT_TESTNET_CHAINID
+];
 var testnetTokenFallback = types.TesntTokenFallback([
   types.ArbitrumSepoliaTokenInfo,
   types.SolanaDevnetTokenInfo
 ]);
-var testnetChainFallback = [
-  types.ArbitrumSepoliaChainInfo,
-  types.SolanaDevnetChainInfo
-];
+var testnetChainFallback = [types.ArbitrumSepoliaChainInfo, types.SolanaDevnetChainInfo];
 function useChains(networkId, options = {}) {
   const { pick: pickField, ...swrOptions } = options;
   const {
@@ -4049,7 +4080,7 @@ function _checkChainSupport(chainId, chains) {
   });
 }
 function fillChainsInfo(chains, filter, chainInfos) {
-  let _chains = [];
+  const _chains = [];
   chains?.forEach((item) => {
     item.chain_details.forEach((chain) => {
       const chainId = Number(chain.chain_id);
@@ -4085,7 +4116,7 @@ function fillChainsInfo(chains, filter, chainInfos) {
 function filterAndUpdateChains(chains, chainInfos, filter, isTestNet) {
   const filterChains = [];
   chains.forEach((chain) => {
-    let _chain = { ...chain };
+    const _chain = { ...chain };
     const networkInfo = chainInfos?.find(
       (item) => item.chain_id == chain.network_infos.chain_id
     );
@@ -4473,6 +4504,7 @@ var useDeposit = (options) => {
       }).then((res) => {
         return updateAllowanceWhenTxSuccess(res.hash);
       }).catch((e) => {
+        throw e;
       });
     },
     [account5, getAllowance, options?.address, dst]