@orderly.network/hooks 0.0.94 → 1.0.0

package/dist/index.d.ts

@@ -2,14 +2,15 @@ import useSWR, { SWRConfiguration, SWRResponse } from 'swr';
 export { SWRConfig, SWRConfiguration, default as useSWR } from 'swr';
 import { SWRMutationConfiguration, SWRMutationResponse } from 'swr/mutation';
 import * as _orderly_network_core from '@orderly.network/core';
-import { Account, AccountState, ConfigStore, OrderlyKeyStore, getWalletAdapterFunc, IContract, EventEmitter } from '@orderly.network/core';
-import * as react from 'react';
-import react__default, { FC, PropsWithChildren } from 'react';
-import { NetworkId, OrderSide, OrderEntity, API, WSMessage, OrderStatus, WS_WalletStatusEnum } from '@orderly.network/types';
+import { AccountState, Account, EventEmitter, ConfigKey, ConfigStore, OrderlyKeyStore, getWalletAdapterFunc } from '@orderly.network/core';
 export { default as useConstant } from 'use-constant';
 import { WS } from '@orderly.network/net';
+import * as react from 'react';
+import { FC, PropsWithChildren } from 'react';
+import { NetworkId, OrderSide, OrderEntity, API, WSMessage, OrderStatus, WS_WalletStatusEnum } from '@orderly.network/types';
 import * as swr__internal from 'swr/_internal';
 import * as swr_subscription from 'swr/subscription';
+import { Decimal } from '@orderly.network/utils';
 export * from 'use-debounce';
 
 type useQueryOptions<T> = SWRConfiguration & {
@@ -36,7 +37,12 @@ declare const useLazyQuery: <T, R = any>(query: Parameters<typeof useSWR>["0"],
 }) | undefined) => SWRMutationResponse;
 
 type HTTP_METHOD = "POST" | "PUT" | "DELETE";
-declare const useMutation: <T, E>(url: string, method?: HTTP_METHOD, options?: SWRMutationConfiguration<T, E> | undefined) => [any, any];
+declare const useMutation: <T, E>(url: string, method?: HTTP_METHOD, options?: SWRMutationConfiguration<T, E> | undefined) => readonly [(data: any, params?: any) => Promise<any>, {
+    readonly data: any;
+    readonly error: E | undefined;
+    readonly reset: () => void;
+    readonly isMutating: boolean;
+}];
 
 /**
  * usePrivateQuery
@@ -52,78 +58,52 @@ declare const useBoolean: (initialValue?: boolean) => [boolean, {
     toggle: () => void;
 }];
 
-declare const useTradingView: () => {};
-
-declare const useTopicObserve: <T>(topic: string) => {
-    data: T | undefined;
-};
-
 declare const useAccount: () => {
-    account: Account;
+    account: _orderly_network_core.Account;
     state: AccountState;
-    createOrderlyKey: (remember: boolean) => Promise<string>;
-    createAccount: () => Promise<string>;
-    disconnect: () => Promise<void>;
-    connect: () => Promise<any>;
-    setChain: (chainId: number) => Promise<any>;
+    createOrderlyKey: (remember: boolean) => Promise<any>;
+    createAccount: () => Promise<any>;
 };
 
 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;
-    klineDataUrl: string;
-    configStore: ConfigStore;
-    keyStore: OrderlyKeyStore;
-    getWalletAdapter: getWalletAdapterFunc;
-    contractManager: IContract;
-    networkId: NetworkId;
-    brokerId: string;
-    onWalletConnect?: () => Promise<any>;
-    onWalletDisconnect?: () => Promise<any>;
-    onSetChain?: (chainId: number) => Promise<any>;
-    errors: AppStateErrors;
-    onlyTestnet: boolean;
-}
-declare const OrderlyContext: react.Context<OrderlyContextState>;
-declare const OrderlyProvider: react.Provider<OrderlyContextState>;
-
-declare const useAppState: () => {
-    errors: AppStateErrors;
-};
-
 declare const usePreLoadData: () => {
     error: any;
     done: boolean;
 };
 
-declare const useEventEmitter: (channel?: string) => EventEmitter<string | symbol, any>;
+declare const useEventEmitter: () => EventEmitter<string | symbol, any>;
 
 declare function useSessionStorage<T>(key: string, initialValue: T): [T, (data: any) => void];
 
-declare function useLocalStorage<T>(key: string, initialValue: T): [T, any];
-
-type useRunOnceProps = {
-    fn: () => any;
-    sessionKey?: string;
-};
-declare const useRunOnce: react__default.FC<useRunOnceProps>;
-
-declare const DataSourceProvider: FC<PropsWithChildren>;
+declare function useLocalStorage<T>(key: string, initialValue: T): [any, (value: T) => void];
 
 declare const useWS: () => WS;
 
-declare const useConfig: () => _orderly_network_core.ConfigStore;
+declare const useConfig: <T>(key?: ConfigKey, defaultValue?: T | undefined) => ConfigStore | T;
+
+interface OrderlyConfigContextState {
+    fetcher?: (url: string, init: RequestInit) => Promise<any>;
+    configStore: ConfigStore;
+    keyStore: OrderlyKeyStore;
+    getWalletAdapter: getWalletAdapterFunc;
+    networkId: NetworkId;
+    onlyTestnet?: boolean;
+}
+declare const OrderlyContext: react.Context<OrderlyConfigContextState>;
+declare const OrderlyProvider: react.Provider<OrderlyConfigContextState>;
+
+type RequireAtLeastOne<T, R extends keyof T = keyof T> = Omit<T, R> & {
+    [K in R]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<R, K>>>;
+}[R];
+interface ConfigProviderProps {
+    configStore?: ConfigStore;
+    keyStore?: OrderlyKeyStore;
+    getWalletAdapter?: getWalletAdapterFunc;
+    brokerId: string;
+    networkId: NetworkId;
+}
+declare const OrderlyConfigProvider: FC<PropsWithChildren<RequireAtLeastOne<ConfigProviderProps, "brokerId" | "configStore">>>;
 
 type OrderBookItem = number[];
 type OrderbookData = {
@@ -141,7 +121,7 @@ declare const useOrderbookStream: (symbol: string, initial?: OrderbookData, opti
     asks: OrderBookItem[];
     bids: OrderBookItem[];
     markPrice: any;
-    middlePrice: any[];
+    middlePrice: number[];
     onDepthChange?: undefined;
     depth?: undefined;
     allDepths?: undefined;
@@ -159,17 +139,6 @@ declare const useOrderbookStream: (symbol: string, initial?: OrderbookData, opti
     middlePrice?: undefined;
 })[];
 
-interface OrderEntryReturn {
-    onSubmit: (values: OrderEntity) => Promise<any>;
-    maxQty: number;
-    freeCollateral: number;
-    markPrice: number;
-    symbolConfig: API.SymbolExt;
-    helper: {
-        calculate: (values: any, field: string, value: any) => any;
-        validator: (values: any) => any;
-    };
-}
 type UseOrderEntryOptions = {
     commify?: boolean;
     validate?: (data: OrderEntity) => {
@@ -177,28 +146,26 @@ type UseOrderEntryOptions = {
     } | null | undefined;
 };
 /**
- * 创建订单
+ * Create Order
  * @param symbol
  * @returns
  */
-declare const useOrderEntry: (symbol: string, side: OrderSide, reduceOnly?: boolean, options?: UseOrderEntryOptions) => OrderEntryReturn;
-
-interface MarketInfo {
-}
-declare const useFetures: () => {
-    data: MarketInfo[] | undefined;
-    sortBy: (key: string) => void;
-    filterBy: (key: string) => void;
-    isLoading: boolean;
-    error: any;
+declare const useOrderEntry: (symbol: string, side: OrderSide, reduceOnly?: boolean, options?: UseOrderEntryOptions) => {
+    maxQty: number;
+    freeCollateral: number;
+    markPrice: any;
+    onSubmit: (values: OrderEntity) => Promise<any>;
+    helper: {
+        calculate: (values: any, field: string, value: any) => unknown;
+        validator: (values: any) => any;
+    };
+    symbolConfig: any;
 };
 
-declare const useSymbolsInfo: () => any;
+declare const useSymbolsInfo: () => Record<string, any>;
 
 declare const useAccountInfo: () => swr__internal.SWRResponse<API.AccountInfo, any, any>;
 
-declare const useTokenInfo: () => any;
-
 declare const useMarketsStream: () => {
     data: WSMessage.Ticker[] | null;
 };
@@ -209,14 +176,12 @@ declare const useMarkPrice: (symbol: string) => swr_subscription.SWRSubscription
 
 declare const useIndexPrice: (symbol: string) => swr_subscription.SWRSubscriptionResponse<any, any>;
 
-declare const useOpenInterest: (symbol: string) => swr_subscription.SWRSubscriptionResponse<any, any>;
-
-declare const useLeverage: () => ({
-    update: (data: any) => any;
-    config: any;
-} | undefined)[];
+declare const useLeverage: () => [number | undefined, {
+    update: (data: any) => Promise<unknown>;
+    config: number[];
+}];
 
-declare const useTickerStream: (symbol: string) => any;
+declare const useTickerStream: (symbol: string) => API.MarketInfo;
 
 declare const useFundingRate: (symbol: string) => {
     est_funding_rate: string;
@@ -229,14 +194,33 @@ declare const useFundingRate: (symbol: string) => {
     sum_unitary_funding?: number | undefined;
 };
 
-declare const usePositionStream: (symbol?: string, options?: SWRConfiguration) => any[];
+declare const usePositionStream: (symbol?: string, options?: SWRConfiguration) => readonly [{
+    readonly rows: API.PositionExt[] | null;
+    readonly aggregated: any;
+    readonly totalCollateral: Decimal;
+    readonly totalValue: Decimal;
+    readonly totalUnrealizedROI: number;
+}, any, {
+    readonly loading: false;
+    readonly error: any;
+    readonly loadMore: () => void;
+    readonly refresh: () => void;
+}];
 
-declare const useOrderStream: ({ status, symbol, side, size, }?: {
-    symbol?: string | undefined;
-    status?: OrderStatus | undefined;
-    size?: number | undefined;
-    side?: OrderSide | undefined;
-}) => any;
+type Params = {
+    symbol?: string;
+    status?: OrderStatus;
+    size?: number;
+    side?: OrderSide;
+};
+declare const useOrderStream: (params: Params) => readonly [any[] | null, {
+    readonly total: any;
+    readonly isLoading: boolean;
+    readonly loadMore: () => void;
+    readonly cancelAllOrders: () => void;
+    readonly updateOrder: (orderId: string, order: OrderEntity) => Promise<any>;
+    readonly cancelOrder: (orderId: string, symbol?: string) => Promise<void>;
+}];
 
 interface MarketTradeStreamOptions {
     limit?: number;
@@ -253,10 +237,6 @@ type CollateralOutputs = {
     availableBalance: number;
     unsettledPnL: number;
 };
-/**
- * 用户保证金
- * @returns
- */
 type Options = {
     dp: number;
 };
@@ -273,28 +253,35 @@ type inputOptions = {
     filter?: (item: API.Chain) => boolean;
     pick?: "dexs" | "network_infos" | "token_infos";
     crossEnabled?: boolean;
+    /** if true, use wooSwap api, else use orderly api only  */
     wooSwapEnabled?: boolean;
 };
-declare const useChains: (networkId?: NetworkId, options?: inputOptions & SWRConfiguration) => any[];
+declare const useChains: (networkId?: NetworkId, options?: inputOptions & SWRConfiguration) => readonly [API.Chain[] | {
+    testnet: API.Chain[];
+    mainnet: API.Chain[];
+}, {
+    readonly findByChainId: (chainId: number, field?: string) => (API.Chain & {
+        nativeToken?: API.TokenInfo | undefined;
+    }) | undefined;
+    readonly error: any;
+}];
 
 declare const useChain: (token: string) => {
     chains: API.Chain | null;
     isLoading: boolean;
 };
 
-type WithdrawInputs = {
-    chainId: number;
-    token: string;
-    amount: number;
-};
-interface WithdrawReturns {
+declare const useWithdraw: () => {
+    withdraw: (inputs: {
+        chainId: number;
+        token: string;
+        amount: number;
+    }) => Promise<any>;
+    isLoading: boolean;
     maxAmount: number;
     availableBalance: number;
     unsettledPnL: number;
-    isLoading: boolean;
-    withdraw: (inputs: WithdrawInputs) => Promise<any>;
-}
-declare const useWithdraw: () => WithdrawReturns;
+};
 
 type useDepositOptions = {
     address?: string;
@@ -338,67 +325,8 @@ declare const useSettleSubscription: (options?: {
     onMessage?: ((data: any) => void) | undefined;
 } | undefined) => swr_subscription.SWRSubscriptionResponse<any, any>;
 
-declare const useBalance: () => any;
-
 declare const usePrivateDataObserver: () => void;
 
-interface Info {
-    symbol: string;
-    quote_min: number;
-    quote_max: number;
-    quote_tick: number;
-    base_min: number;
-    base_max: number;
-    base_tick: number;
-    min_notional: number;
-    price_range: number;
-    created_time: number;
-    updated_time: number;
-}
-/**
- * useInfo
- * @returns
- */
-declare const useInfo: () => swr__internal.SWRResponse<Info[], any, any>;
-
-interface Token {
-    token: string;
-    token_account_id: string;
-    decimals: number;
-    minimum_increment: number;
-}
-/**
- * useToken
- * @description get token info
- */
-declare const useToken: () => swr__internal.SWRResponse<Token[], any, any>;
-
-interface FundingRate {
-    symbol: string;
-    est_funding_rate: number;
-    est_funding_rate_timestamp: number;
-    last_funding_rate: number;
-    last_funding_rate_timestamp: number;
-    next_funding_time: number;
-    sum_unitary_funding: number;
-}
-/**
- * FundingRate
- * @param symbol
- */
-declare const useFundingRateBySymbol: (symbol: string) => swr__internal.SWRResponse<FundingRate, any, any>;
-
-declare const index_useFundingRateBySymbol: typeof useFundingRateBySymbol;
-declare const index_useInfo: typeof useInfo;
-declare const index_useToken: typeof useToken;
-declare namespace index {
-  export {
-    index_useFundingRateBySymbol as useFundingRateBySymbol,
-    index_useInfo as useInfo,
-    index_useToken as useToken,
-  };
-}
-
 declare const useWooSwapQuery: () => {
     query: (inputs: any) => Promise<any> | undefined;
     loading: boolean;
@@ -471,4 +399,4 @@ declare const useSwap: () => {
     status: WS_WalletStatusEnum;
 };
 
-export { AppStateErrors, DataSourceProvider, OrderlyAppConfig, OrderlyContext, OrderlyContextState, OrderlyProvider, index as apis, useAccount, useAccountInfo, useAccountInstance, useAppState, useBalance, useBoolean, useChain, useChains, useCollateral, useConfig, useCrossSwap, useDeposit, useEventEmitter, useFetures, useFundingRate, useHoldingStream, useIndexPrice, useLazyQuery, useLeverage, useLocalStorage, useMarginRatio, useMarkPrice, useMarkPricesStream, useMarketTradeStream, useMarketsStream, useMaxQty, useMutation, useOpenInterest, useOrderEntry, useOrderStream, useOrderbookStream, usePositionStream, usePreLoadData, usePrivateDataObserver, usePrivateQuery, useQuery, useRunOnce, useSessionStorage, useSettleSubscription, useSwap, useSymbolsInfo, useTickerStream, useTokenInfo, useTopicObserve, useTradingView, useWS, useWalletSubscription, useWithdraw, useWooCrossSwapQuery, useWooSwapQuery };
+export { ConfigProviderProps, OrderlyConfigContextState, OrderlyConfigProvider, OrderlyContext, OrderlyProvider, useAccount, useAccountInfo, useAccountInstance, useBoolean, useChain, useChains, useCollateral, useConfig, useCrossSwap, useDeposit, useEventEmitter, useFundingRate, useHoldingStream, useIndexPrice, useLazyQuery, useLeverage, useLocalStorage, useMarginRatio, useMarkPrice, useMarkPricesStream, useMarketTradeStream, useMarketsStream, useMaxQty, useMutation, useOrderEntry, useOrderStream, useOrderbookStream, usePositionStream, usePreLoadData, usePrivateDataObserver, usePrivateQuery, useQuery, useSessionStorage, useSettleSubscription, useSwap, useSymbolsInfo, useTickerStream, useWS, useWalletSubscription, useWithdraw, useWooCrossSwapQuery, useWooSwapQuery };