@orderly.network/hooks 0.0.19 → 0.0.20

package/dist/index.d.mts

@@ -1,10 +1,10 @@
 import useSWR, { SWRConfiguration, SWRResponse } from 'swr';
 export { SWRConfiguration, default as useSWR } from 'swr';
 import { SWRMutationConfiguration } from 'swr/mutation';
-import { Account, AccountState, EventEmitter, ConfigStore, OrderlyKeyStore, WalletAdapter, WSMessage } from '@orderly.network/core';
-export { default as useConstant } from 'use-constant';
+import { Account, AccountState, ConfigStore, OrderlyKeyStore, WalletAdapter, EventEmitter, WSMessage } from '@orderly.network/core';
 import * as react from 'react';
-import { FC, PropsWithChildren } from 'react';
+import react__default, { FC, PropsWithChildren } from 'react';
+export { default as useConstant } from 'use-constant';
 import { WS } from '@orderly.network/net';
 import { OrderSide, OrderEntity, API } from '@orderly.network/types';
 import * as swr__internal from 'swr/_internal';
@@ -51,20 +51,20 @@ declare const useAccount: () => {
     createAccount: () => Promise<string>;
     disconnect: () => Promise<void>;
     connect: () => Promise<any>;
+    setChain: (chainId: number) => Promise<any>;
 };
 
-declare const useAppState: () => {};
-
-declare const useEventEmitter: (channel?: string) => EventEmitter<string | symbol, any>;
-
-declare const DataSourceProvider: FC<PropsWithChildren>;
-
-declare const useWS: () => WS;
+declare const useAccountInstance: () => Account;
 
 interface OrderlyAppConfig {
     logoUrl: string;
     theme: any;
 }
+type AppStateErrors = {
+    ChainNetworkNotSupport: boolean;
+    IpNotSupport: boolean;
+    NetworkError: boolean;
+};
 interface OrderlyContextState extends OrderlyAppConfig {
     fetcher?: (url: string, init: RequestInit) => Promise<any>;
     apiBaseUrl: string;
@@ -77,11 +77,35 @@ interface OrderlyContextState extends OrderlyAppConfig {
     networkId: string;
     onWalletConnect?: () => Promise<any>;
     onWalletDisconnect?: () => Promise<any>;
+    onSetChain?: (chainId: number) => Promise<any>;
     ready: boolean;
+    onAppTestChange?: (name: string) => void;
+    errors: AppStateErrors;
 }
 declare const OrderlyContext: react.Context<OrderlyContextState>;
 declare const OrderlyProvider: react.Provider<OrderlyContextState>;
 
+declare const useAppState: () => {
+    errors: AppStateErrors;
+    ready: boolean;
+};
+
+declare const usePreLoadData: (onSuccess: (name: string) => void) => void;
+
+declare const useEventEmitter: (channel?: string) => EventEmitter<string | symbol, any>;
+
+declare function useSessionStorage<T>(key: string, initialValue: T): [T, (data: any) => void];
+
+type useRunOnceProps = {
+    fn: () => any;
+    sessionKey?: string;
+};
+declare const useRunOnce: react__default.FC<useRunOnceProps>;
+
+declare const DataSourceProvider: FC<PropsWithChildren>;
+
+declare const useWS: () => WS;
+
 type OrderBookItem = number[];
 type OrderbookData = {
     asks: OrderBookItem[];
@@ -164,10 +188,10 @@ declare const useLeverage: () => ({
 
 declare const useTickerStream: (symbol: string) => any;
 
-declare const useFundingRate$1: (symbol: string) => {
+declare const useFundingRate: (symbol: string) => {
+    est_funding_rate: string;
     countDown: string;
     symbol?: string | undefined;
-    est_funding_rate?: number | undefined;
     est_funding_rate_timestamp?: number | undefined;
     last_funding_rate?: number | undefined;
     last_funding_rate_timestamp?: number | undefined;
@@ -184,17 +208,22 @@ declare enum OrderStatus {
     NEW = "NEW",
     COMPLETED = "COMPLETED"
 }
-declare const useOrderStream: ({ status, symbol, }?: {
+declare const useOrderStream: ({ status, symbol, side, size, }?: {
     symbol?: string | undefined;
     status?: OrderStatus | undefined;
+    size?: number | undefined;
+    side?: OrderSide | undefined;
 }) => (any[] | {
     cancelAllOrders: () => void;
     updateOrder: (orderId: string, order: OrderEntity) => any;
     cancelOrder: (orderId: string, symbol?: string) => any;
 } | null)[];
 
-declare const useMarketTradeStream: (symbol: string) => {
-    data: API.Trade[] | undefined;
+interface MarketTradeStreamOptions {
+    level?: number;
+}
+declare const useMarketTradeStream: (symbol: string, options?: MarketTradeStreamOptions) => {
+    trades: API.Trade[];
     isLoading: boolean;
 };
 
@@ -204,6 +233,7 @@ type CollateralOutputs = {
     totalCollateral: number;
     freeCollateral: number;
     totalValue: number;
+    availableBalance: number;
 };
 /**
  * 用户保证金
@@ -216,13 +246,19 @@ declare const useCollateral: (options?: Options) => CollateralOutputs;
 
 declare const useMaxQty: (symbol: string, side: OrderSide, reduceOnly?: boolean) => number;
 
-declare const useMarginRatio: () => 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[];
+declare const useChains: (networkId?: "testnet" | "mainnet", options?: inputOptions & SWRConfiguration) => any[];
+
+declare const useHolding: () => {
+    data: API.Holding[] | undefined;
+    usdc: API.Holding | undefined;
+    isLoading: boolean;
+};
 
 declare const useBalance: () => any;
 
@@ -276,23 +312,15 @@ interface FundingRate {
  */
 declare const useFundingRateBySymbol: (symbol: string) => swr__internal.SWRResponse<FundingRate, any, any>;
 
-/**
- * FundingRate
- * @param symbol
- */
-declare const useFundingRate: (symbol?: string) => swr__internal.SWRResponse<FundingRate, any, any>;
-
-declare const index_useFundingRate: typeof useFundingRate;
 declare const index_useFundingRateBySymbol: typeof useFundingRateBySymbol;
 declare const index_useInfo: typeof useInfo;
 declare const index_useToken: typeof useToken;
 declare namespace index {
   export {
-    index_useFundingRate as useFundingRate,
     index_useFundingRateBySymbol as useFundingRateBySymbol,
     index_useInfo as useInfo,
     index_useToken as useToken,
   };
 }
 
-export { DataSourceProvider, OrderStatus, OrderlyAppConfig, OrderlyContext, OrderlyContextState, OrderlyProvider, index as apis, useAccount, useAccountInfo, useAppState, useBalance, useChains, useCollateral, useEventEmitter, useExecutionReport, useFetures, useFundingRate$1 as useFundingRate, useLeverage, useMarginRatio, useMarkPrice, useMarkPricesStream, useMarketTradeStream, useMarketsStream, useMaxQty, useMutation, useOrderEntry, useOrderStream, useOrderbookStream, usePositionStream, usePrivateDataObserver, usePrivateObserve, usePrivateQuery, useQuery, useSymbolsInfo, useTickerStream, useTokenInfo, useTopicObserve, useTradeStream, useTradingView, useWS };
+export { AppStateErrors, DataSourceProvider, OrderStatus, OrderlyAppConfig, OrderlyContext, OrderlyContextState, OrderlyProvider, index as apis, useAccount, useAccountInfo, useAccountInstance, useAppState, useBalance, useChains, useCollateral, useEventEmitter, useExecutionReport, useFetures, useFundingRate, useHolding, useLeverage, useMarginRatio, useMarkPrice, useMarkPricesStream, useMarketTradeStream, useMarketsStream, useMaxQty, useMutation, useOrderEntry, useOrderStream, useOrderbookStream, usePositionStream, usePreLoadData, usePrivateDataObserver, usePrivateObserve, usePrivateQuery, useQuery, useRunOnce, useSessionStorage, useSymbolsInfo, useTickerStream, useTokenInfo, useTopicObserve, useTradeStream, useTradingView, useWS };

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 import useSWR, { SWRConfiguration, SWRResponse } from 'swr';
 export { SWRConfiguration, default as useSWR } from 'swr';
 import { SWRMutationConfiguration } from 'swr/mutation';
-import { Account, AccountState, EventEmitter, ConfigStore, OrderlyKeyStore, WalletAdapter, WSMessage } from '@orderly.network/core';
-export { default as useConstant } from 'use-constant';
+import { Account, AccountState, ConfigStore, OrderlyKeyStore, WalletAdapter, EventEmitter, WSMessage } from '@orderly.network/core';
 import * as react from 'react';
-import { FC, PropsWithChildren } from 'react';
+import react__default, { FC, PropsWithChildren } from 'react';
+export { default as useConstant } from 'use-constant';
 import { WS } from '@orderly.network/net';
 import { OrderSide, OrderEntity, API } from '@orderly.network/types';
 import * as swr__internal from 'swr/_internal';
@@ -51,20 +51,20 @@ declare const useAccount: () => {
     createAccount: () => Promise<string>;
     disconnect: () => Promise<void>;
     connect: () => Promise<any>;
+    setChain: (chainId: number) => Promise<any>;
 };
 
-declare const useAppState: () => {};
-
-declare const useEventEmitter: (channel?: string) => EventEmitter<string | symbol, any>;
-
-declare const DataSourceProvider: FC<PropsWithChildren>;
-
-declare const useWS: () => WS;
+declare const useAccountInstance: () => Account;
 
 interface OrderlyAppConfig {
     logoUrl: string;
     theme: any;
 }
+type AppStateErrors = {
+    ChainNetworkNotSupport: boolean;
+    IpNotSupport: boolean;
+    NetworkError: boolean;
+};
 interface OrderlyContextState extends OrderlyAppConfig {
     fetcher?: (url: string, init: RequestInit) => Promise<any>;
     apiBaseUrl: string;
@@ -77,11 +77,35 @@ interface OrderlyContextState extends OrderlyAppConfig {
     networkId: string;
     onWalletConnect?: () => Promise<any>;
     onWalletDisconnect?: () => Promise<any>;
+    onSetChain?: (chainId: number) => Promise<any>;
     ready: boolean;
+    onAppTestChange?: (name: string) => void;
+    errors: AppStateErrors;
 }
 declare const OrderlyContext: react.Context<OrderlyContextState>;
 declare const OrderlyProvider: react.Provider<OrderlyContextState>;
 
+declare const useAppState: () => {
+    errors: AppStateErrors;
+    ready: boolean;
+};
+
+declare const usePreLoadData: (onSuccess: (name: string) => void) => void;
+
+declare const useEventEmitter: (channel?: string) => EventEmitter<string | symbol, any>;
+
+declare function useSessionStorage<T>(key: string, initialValue: T): [T, (data: any) => void];
+
+type useRunOnceProps = {
+    fn: () => any;
+    sessionKey?: string;
+};
+declare const useRunOnce: react__default.FC<useRunOnceProps>;
+
+declare const DataSourceProvider: FC<PropsWithChildren>;
+
+declare const useWS: () => WS;
+
 type OrderBookItem = number[];
 type OrderbookData = {
     asks: OrderBookItem[];
@@ -164,10 +188,10 @@ declare const useLeverage: () => ({
 
 declare const useTickerStream: (symbol: string) => any;
 
-declare const useFundingRate$1: (symbol: string) => {
+declare const useFundingRate: (symbol: string) => {
+    est_funding_rate: string;
     countDown: string;
     symbol?: string | undefined;
-    est_funding_rate?: number | undefined;
     est_funding_rate_timestamp?: number | undefined;
     last_funding_rate?: number | undefined;
     last_funding_rate_timestamp?: number | undefined;
@@ -184,17 +208,22 @@ declare enum OrderStatus {
     NEW = "NEW",
     COMPLETED = "COMPLETED"
 }
-declare const useOrderStream: ({ status, symbol, }?: {
+declare const useOrderStream: ({ status, symbol, side, size, }?: {
     symbol?: string | undefined;
     status?: OrderStatus | undefined;
+    size?: number | undefined;
+    side?: OrderSide | undefined;
 }) => (any[] | {
     cancelAllOrders: () => void;
     updateOrder: (orderId: string, order: OrderEntity) => any;
     cancelOrder: (orderId: string, symbol?: string) => any;
 } | null)[];
 
-declare const useMarketTradeStream: (symbol: string) => {
-    data: API.Trade[] | undefined;
+interface MarketTradeStreamOptions {
+    level?: number;
+}
+declare const useMarketTradeStream: (symbol: string, options?: MarketTradeStreamOptions) => {
+    trades: API.Trade[];
     isLoading: boolean;
 };
 
@@ -204,6 +233,7 @@ type CollateralOutputs = {
     totalCollateral: number;
     freeCollateral: number;
     totalValue: number;
+    availableBalance: number;
 };
 /**
  * 用户保证金
@@ -216,13 +246,19 @@ declare const useCollateral: (options?: Options) => CollateralOutputs;
 
 declare const useMaxQty: (symbol: string, side: OrderSide, reduceOnly?: boolean) => number;
 
-declare const useMarginRatio: () => 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[];
+declare const useChains: (networkId?: "testnet" | "mainnet", options?: inputOptions & SWRConfiguration) => any[];
+
+declare const useHolding: () => {
+    data: API.Holding[] | undefined;
+    usdc: API.Holding | undefined;
+    isLoading: boolean;
+};
 
 declare const useBalance: () => any;
 
@@ -276,23 +312,15 @@ interface FundingRate {
  */
 declare const useFundingRateBySymbol: (symbol: string) => swr__internal.SWRResponse<FundingRate, any, any>;
 
-/**
- * FundingRate
- * @param symbol
- */
-declare const useFundingRate: (symbol?: string) => swr__internal.SWRResponse<FundingRate, any, any>;
-
-declare const index_useFundingRate: typeof useFundingRate;
 declare const index_useFundingRateBySymbol: typeof useFundingRateBySymbol;
 declare const index_useInfo: typeof useInfo;
 declare const index_useToken: typeof useToken;
 declare namespace index {
   export {
-    index_useFundingRate as useFundingRate,
     index_useFundingRateBySymbol as useFundingRateBySymbol,
     index_useInfo as useInfo,
     index_useToken as useToken,
   };
 }
 
-export { DataSourceProvider, OrderStatus, OrderlyAppConfig, OrderlyContext, OrderlyContextState, OrderlyProvider, index as apis, useAccount, useAccountInfo, useAppState, useBalance, useChains, useCollateral, useEventEmitter, useExecutionReport, useFetures, useFundingRate$1 as useFundingRate, useLeverage, useMarginRatio, useMarkPrice, useMarkPricesStream, useMarketTradeStream, useMarketsStream, useMaxQty, useMutation, useOrderEntry, useOrderStream, useOrderbookStream, usePositionStream, usePrivateDataObserver, usePrivateObserve, usePrivateQuery, useQuery, useSymbolsInfo, useTickerStream, useTokenInfo, useTopicObserve, useTradeStream, useTradingView, useWS };
+export { AppStateErrors, DataSourceProvider, OrderStatus, OrderlyAppConfig, OrderlyContext, OrderlyContextState, OrderlyProvider, index as apis, useAccount, useAccountInfo, useAccountInstance, useAppState, useBalance, useChains, useCollateral, useEventEmitter, useExecutionReport, useFetures, useFundingRate, useHolding, useLeverage, useMarginRatio, useMarkPrice, useMarkPricesStream, useMarketTradeStream, useMarketsStream, useMaxQty, useMutation, useOrderEntry, useOrderStream, useOrderbookStream, usePositionStream, usePreLoadData, usePrivateDataObserver, usePrivateObserve, usePrivateQuery, useQuery, useRunOnce, useSessionStorage, useSymbolsInfo, useTickerStream, useTokenInfo, useTopicObserve, useTradeStream, useTradingView, useWS };