@orderly.network/hooks 0.0.8 → 0.0.10

package/dist/index.d.mts

@@ -2,13 +2,12 @@ import useSWR, { SWRConfiguration, SWRResponse } from 'swr';
 export { SWRConfiguration, default as useSWR } from 'swr';
 import { SWRMutationConfiguration } from 'swr/mutation';
 import { Account, AccountState, ConfigStore, OrderlyKeyStore, WalletAdapter, WSMessage } from '@orderly.network/core';
-import { SystemStateEnum, ExchangeStatusEnum, OrderEntity, API, OrderSide } from '@orderly.network/types';
+import { SystemStateEnum, ExchangeStatusEnum, OrderSide, OrderEntity, API } from '@orderly.network/types';
 import { WebSocketClient, WS } from '@orderly.network/net';
 export { useEventCallback, useObservable } from 'rxjs-hooks';
 export { default as useConstant } from 'use-constant';
 import * as react from 'react';
 import { FC, PropsWithChildren } from 'react';
-import { FormikErrors, FormikState } from 'formik';
 import * as swr__internal from 'swr/_internal';
 import * as swr_subscription from 'swr/subscription';
 
@@ -24,13 +23,8 @@ type useQueryOptions<T> = SWRConfiguration & {
  */
 declare const useQuery: <T>(query: Parameters<typeof useSWR>["0"], options?: useQueryOptions<T> | undefined) => SWRResponse<T, any, any>;
 
-declare const useMutation: <T, E>(url: string, options?: SWRMutationConfiguration<T, E> | undefined) => {
-    mutation: (data: any) => Promise<any>;
-    data: any;
-    error: E | undefined;
-    reset: () => void;
-    isMutating: boolean;
-};
+type HTTP_METHOD = "POST" | "PUT" | "DELETE" | "GET";
+declare const useMutation: <T, E>(url: string, options?: SWRMutationConfiguration<T, E> | undefined, method?: HTTP_METHOD) => [any, any];
 
 /**
  * usePrivateQuery
@@ -54,6 +48,10 @@ declare const useAccount: () => {
     account: Account;
     state: AccountState;
     login: (address: string) => void;
+    createOrderlyKey: (remember: boolean) => Promise<string>;
+    createAccount: () => Promise<string>;
+    disconnect: () => Promise<void>;
+    connect: () => Promise<any>;
 };
 
 declare const useAppState: () => {
@@ -74,10 +72,16 @@ interface OrderlyAppConfig {
 interface OrderlyContextState extends OrderlyAppConfig {
     fetcher?: (url: string, init: RequestInit) => Promise<any>;
     apiBaseUrl: string;
+    klineDataUrl: string;
     configStore: ConfigStore;
     keyStore: OrderlyKeyStore;
-    walletAdapter: WalletAdapter;
+    walletAdapter: {
+        new (options: any): WalletAdapter;
+    };
     networkId: string;
+    onWalletConnect?: () => Promise<any>;
+    onWalletDisconnect?: () => Promise<any>;
+    ready: boolean;
 }
 declare const OrderlyContext: react.Context<OrderlyContextState>;
 declare const OrderlyProvider: react.Provider<OrderlyContextState>;
@@ -91,38 +95,33 @@ type OrderbookOptions = {
     level?: number;
 };
 /**
- * @name useOrderbook
+ * @name useOrderbookStream
  * @description React hook that returns the current orderbook for a given market
  */
-declare const useOrderbook: (symbol: string, initial?: OrderbookData, options?: OrderbookOptions) => ({
-    markPrice: number;
+declare const useOrderbookStream: (symbol: string, initial?: OrderbookData, options?: OrderbookOptions) => ({
+    markPrice: any;
     middlePrice: any;
     asks: OrderBookItem[];
     bids: OrderBookItem[];
     onDepthChange?: undefined;
     depth?: undefined;
+    isLoading?: undefined;
 } | {
     onDepthChange: (depth: number) => void;
     depth: number;
+    isLoading: boolean;
 })[];
 
-type OrderEntityKey = keyof OrderEntity & string;
-
 interface OrderEntryReturn {
-    onSubmit: (values?: OrderEntity) => Promise<any>;
-    validateForm: (values?: any) => Promise<FormikErrors<OrderEntity>>;
-    resetForm: (nextState?: Partial<FormikState<OrderEntity>>) => void;
-    setValue: (field: OrderEntityKey, value: any) => void;
+    onSubmit: (values: OrderEntity) => Promise<any>;
     maxQty: number;
     freeCollateral: number;
-    values: OrderEntity;
     markPrice: number;
-    errors: Partial<Record<keyof OrderEntity, string>>;
     symbolConfig: API.SymbolExt;
-    submitCount: number;
-    isSubmitting: boolean;
-    onFocus?: (field: keyof OrderEntity) => void;
-    onBlur?: (field: keyof OrderEntity) => void;
+    helper: {
+        calculate: (values: any, field: string, value: any) => any;
+        validator: (values: any) => any;
+    };
 }
 type UseOrderEntryOptions = {
     commify?: boolean;
@@ -135,7 +134,7 @@ type UseOrderEntryOptions = {
  * @param symbol
  * @returns
  */
-declare const useOrderEntry: (symbol: string, initialValue?: Partial<OrderEntity>, options?: UseOrderEntryOptions) => OrderEntryReturn;
+declare const useOrderEntry: (symbol: string, side: OrderSide, reduceOnly?: boolean, options?: UseOrderEntryOptions) => OrderEntryReturn;
 
 interface MarketInfo {
 }
@@ -159,6 +158,8 @@ declare const useMarketsStream: () => {
 
 declare const useMarkPricesStream: () => swr_subscription.SWRSubscriptionResponse<any, any>;
 
+declare const useMarkPrice: (symbol: string) => swr_subscription.SWRSubscriptionResponse<any, any>;
+
 declare const useTickerStream: (symbol: string) => any;
 
 declare const useFundingRate$1: (symbol: string) => {
@@ -190,6 +191,11 @@ declare const useOrderStream: ({ status, symbol, }?: {
     cancelOrder: (id: string) => void;
 } | null)[];
 
+declare const useTradeStream: (symbol: string) => {
+    data: API.Trade[] | undefined;
+    isLoading: boolean;
+};
+
 type CollateralOutputs = {
     totalCollateral: number;
     freeCollateral: number;
@@ -199,10 +205,21 @@ type CollateralOutputs = {
  * 用户保证金
  * @returns
  */
-declare const useCollateral: (dp?: number) => CollateralOutputs;
+type Options = {
+    dp: number;
+};
+declare const useCollateral: (options?: Options) => CollateralOutputs;
 
 declare const useMaxQty: (symbol: string, side: OrderSide, reduceOnly?: boolean) => number;
 
+declare const useMarginRatio: () => number;
+
+type inputOptions = {
+    filter?: (item: API.Chain) => boolean;
+    pick?: "dexs" | "network_infos" | "token_infos";
+};
+declare const useChains: (networkId?: "testnet" | "mainnet", options?: inputOptions) => any[];
+
 interface Info {
     symbol: string;
     quote_min: number;
@@ -268,4 +285,4 @@ declare namespace index {
   };
 }
 
-export { DataSourceProvider, OrderStatus, OrderlyAppConfig, OrderlyContext, OrderlyContextState, OrderlyProvider, index as apis, useAccount, useAccountInfo, useAppState, useCollateral, useFetures, useFundingRate$1 as useFundingRate, useMarkPricesStream, useMarketsStream, useMaxQty, useMutation, useOrderEntry, useOrderStream, useOrderbook, usePositionStream, usePrivateObserve, usePrivateQuery, useQuery, useSymbolsInfo, useTickerStream, useTokenInfo, useTopicObserve, useTradingView, useWS, useWebSocketClient };
+export { DataSourceProvider, OrderStatus, OrderlyAppConfig, OrderlyContext, OrderlyContextState, OrderlyProvider, index as apis, useAccount, useAccountInfo, useAppState, useChains, useCollateral, useFetures, useFundingRate$1 as useFundingRate, useMarginRatio, useMarkPrice, useMarkPricesStream, useMarketsStream, useMaxQty, useMutation, useOrderEntry, useOrderStream, useOrderbookStream, usePositionStream, usePrivateObserve, usePrivateQuery, useQuery, useSymbolsInfo, useTickerStream, useTokenInfo, useTopicObserve, useTradeStream, useTradingView, useWS, useWebSocketClient };

package/dist/index.d.ts

@@ -2,13 +2,12 @@ import useSWR, { SWRConfiguration, SWRResponse } from 'swr';
 export { SWRConfiguration, default as useSWR } from 'swr';
 import { SWRMutationConfiguration } from 'swr/mutation';
 import { Account, AccountState, ConfigStore, OrderlyKeyStore, WalletAdapter, WSMessage } from '@orderly.network/core';
-import { SystemStateEnum, ExchangeStatusEnum, OrderEntity, API, OrderSide } from '@orderly.network/types';
+import { SystemStateEnum, ExchangeStatusEnum, OrderSide, OrderEntity, API } from '@orderly.network/types';
 import { WebSocketClient, WS } from '@orderly.network/net';
 export { useEventCallback, useObservable } from 'rxjs-hooks';
 export { default as useConstant } from 'use-constant';
 import * as react from 'react';
 import { FC, PropsWithChildren } from 'react';
-import { FormikErrors, FormikState } from 'formik';
 import * as swr__internal from 'swr/_internal';
 import * as swr_subscription from 'swr/subscription';
 
@@ -24,13 +23,8 @@ type useQueryOptions<T> = SWRConfiguration & {
  */
 declare const useQuery: <T>(query: Parameters<typeof useSWR>["0"], options?: useQueryOptions<T> | undefined) => SWRResponse<T, any, any>;
 
-declare const useMutation: <T, E>(url: string, options?: SWRMutationConfiguration<T, E> | undefined) => {
-    mutation: (data: any) => Promise<any>;
-    data: any;
-    error: E | undefined;
-    reset: () => void;
-    isMutating: boolean;
-};
+type HTTP_METHOD = "POST" | "PUT" | "DELETE" | "GET";
+declare const useMutation: <T, E>(url: string, options?: SWRMutationConfiguration<T, E> | undefined, method?: HTTP_METHOD) => [any, any];
 
 /**
  * usePrivateQuery
@@ -54,6 +48,10 @@ declare const useAccount: () => {
     account: Account;
     state: AccountState;
     login: (address: string) => void;
+    createOrderlyKey: (remember: boolean) => Promise<string>;
+    createAccount: () => Promise<string>;
+    disconnect: () => Promise<void>;
+    connect: () => Promise<any>;
 };
 
 declare const useAppState: () => {
@@ -74,10 +72,16 @@ interface OrderlyAppConfig {
 interface OrderlyContextState extends OrderlyAppConfig {
     fetcher?: (url: string, init: RequestInit) => Promise<any>;
     apiBaseUrl: string;
+    klineDataUrl: string;
     configStore: ConfigStore;
     keyStore: OrderlyKeyStore;
-    walletAdapter: WalletAdapter;
+    walletAdapter: {
+        new (options: any): WalletAdapter;
+    };
     networkId: string;
+    onWalletConnect?: () => Promise<any>;
+    onWalletDisconnect?: () => Promise<any>;
+    ready: boolean;
 }
 declare const OrderlyContext: react.Context<OrderlyContextState>;
 declare const OrderlyProvider: react.Provider<OrderlyContextState>;
@@ -91,38 +95,33 @@ type OrderbookOptions = {
     level?: number;
 };
 /**
- * @name useOrderbook
+ * @name useOrderbookStream
  * @description React hook that returns the current orderbook for a given market
  */
-declare const useOrderbook: (symbol: string, initial?: OrderbookData, options?: OrderbookOptions) => ({
-    markPrice: number;
+declare const useOrderbookStream: (symbol: string, initial?: OrderbookData, options?: OrderbookOptions) => ({
+    markPrice: any;
     middlePrice: any;
     asks: OrderBookItem[];
     bids: OrderBookItem[];
     onDepthChange?: undefined;
     depth?: undefined;
+    isLoading?: undefined;
 } | {
     onDepthChange: (depth: number) => void;
     depth: number;
+    isLoading: boolean;
 })[];
 
-type OrderEntityKey = keyof OrderEntity & string;
-
 interface OrderEntryReturn {
-    onSubmit: (values?: OrderEntity) => Promise<any>;
-    validateForm: (values?: any) => Promise<FormikErrors<OrderEntity>>;
-    resetForm: (nextState?: Partial<FormikState<OrderEntity>>) => void;
-    setValue: (field: OrderEntityKey, value: any) => void;
+    onSubmit: (values: OrderEntity) => Promise<any>;
     maxQty: number;
     freeCollateral: number;
-    values: OrderEntity;
     markPrice: number;
-    errors: Partial<Record<keyof OrderEntity, string>>;
     symbolConfig: API.SymbolExt;
-    submitCount: number;
-    isSubmitting: boolean;
-    onFocus?: (field: keyof OrderEntity) => void;
-    onBlur?: (field: keyof OrderEntity) => void;
+    helper: {
+        calculate: (values: any, field: string, value: any) => any;
+        validator: (values: any) => any;
+    };
 }
 type UseOrderEntryOptions = {
     commify?: boolean;
@@ -135,7 +134,7 @@ type UseOrderEntryOptions = {
  * @param symbol
  * @returns
  */
-declare const useOrderEntry: (symbol: string, initialValue?: Partial<OrderEntity>, options?: UseOrderEntryOptions) => OrderEntryReturn;
+declare const useOrderEntry: (symbol: string, side: OrderSide, reduceOnly?: boolean, options?: UseOrderEntryOptions) => OrderEntryReturn;
 
 interface MarketInfo {
 }
@@ -159,6 +158,8 @@ declare const useMarketsStream: () => {
 
 declare const useMarkPricesStream: () => swr_subscription.SWRSubscriptionResponse<any, any>;
 
+declare const useMarkPrice: (symbol: string) => swr_subscription.SWRSubscriptionResponse<any, any>;
+
 declare const useTickerStream: (symbol: string) => any;
 
 declare const useFundingRate$1: (symbol: string) => {
@@ -190,6 +191,11 @@ declare const useOrderStream: ({ status, symbol, }?: {
     cancelOrder: (id: string) => void;
 } | null)[];
 
+declare const useTradeStream: (symbol: string) => {
+    data: API.Trade[] | undefined;
+    isLoading: boolean;
+};
+
 type CollateralOutputs = {
     totalCollateral: number;
     freeCollateral: number;
@@ -199,10 +205,21 @@ type CollateralOutputs = {
  * 用户保证金
  * @returns
  */
-declare const useCollateral: (dp?: number) => CollateralOutputs;
+type Options = {
+    dp: number;
+};
+declare const useCollateral: (options?: Options) => CollateralOutputs;
 
 declare const useMaxQty: (symbol: string, side: OrderSide, reduceOnly?: boolean) => number;
 
+declare const useMarginRatio: () => number;
+
+type inputOptions = {
+    filter?: (item: API.Chain) => boolean;
+    pick?: "dexs" | "network_infos" | "token_infos";
+};
+declare const useChains: (networkId?: "testnet" | "mainnet", options?: inputOptions) => any[];
+
 interface Info {
     symbol: string;
     quote_min: number;
@@ -268,4 +285,4 @@ declare namespace index {
   };
 }
 
-export { DataSourceProvider, OrderStatus, OrderlyAppConfig, OrderlyContext, OrderlyContextState, OrderlyProvider, index as apis, useAccount, useAccountInfo, useAppState, useCollateral, useFetures, useFundingRate$1 as useFundingRate, useMarkPricesStream, useMarketsStream, useMaxQty, useMutation, useOrderEntry, useOrderStream, useOrderbook, usePositionStream, usePrivateObserve, usePrivateQuery, useQuery, useSymbolsInfo, useTickerStream, useTokenInfo, useTopicObserve, useTradingView, useWS, useWebSocketClient };
+export { DataSourceProvider, OrderStatus, OrderlyAppConfig, OrderlyContext, OrderlyContextState, OrderlyProvider, index as apis, useAccount, useAccountInfo, useAppState, useChains, useCollateral, useFetures, useFundingRate$1 as useFundingRate, useMarginRatio, useMarkPrice, useMarkPricesStream, useMarketsStream, useMaxQty, useMutation, useOrderEntry, useOrderStream, useOrderbookStream, usePositionStream, usePrivateObserve, usePrivateQuery, useQuery, useSymbolsInfo, useTickerStream, useTokenInfo, useTopicObserve, useTradeStream, useTradingView, useWS, useWebSocketClient };