@orderly.network/hooks 0.0.9 → 0.0.11

package/dist/index.d.mts

@@ -0,0 +1,288 @@
+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, 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 * as swr__internal from 'swr/_internal';
+import * as swr_subscription from 'swr/subscription';
+
+type useQueryOptions<T> = SWRConfiguration & {
+    formatter?: (data: any) => T;
+};
+
+/**
+ * useQuery
+ * @description for public api
+ * @param query
+ * @param options
+ */
+declare const useQuery: <T>(query: Parameters<typeof useSWR>["0"], options?: useQueryOptions<T> | undefined) => SWRResponse<T, any, any>;
+
+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
+ * @description for private api
+ * @param query
+ * @param options
+ */
+declare const usePrivateQuery: <T>(query: string, options?: useQueryOptions<T> | undefined) => SWRResponse<T, any, any>;
+
+declare const useTradingView: () => {};
+
+declare const usePrivateObserve: <T>() => {
+    data: T | undefined;
+};
+
+declare const useTopicObserve: <T>(topic: string) => {
+    data: T | undefined;
+};
+
+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: () => {
+    systemState: SystemStateEnum;
+    exchangeState: ExchangeStatusEnum;
+};
+
+declare const useWebSocketClient: () => WebSocketClient;
+
+declare const DataSourceProvider: FC<PropsWithChildren>;
+
+declare const useWS: () => WS;
+
+interface OrderlyAppConfig {
+    logoUrl: string;
+    theme: any;
+}
+interface OrderlyContextState extends OrderlyAppConfig {
+    fetcher?: (url: string, init: RequestInit) => Promise<any>;
+    apiBaseUrl: string;
+    klineDataUrl: string;
+    configStore: ConfigStore;
+    keyStore: OrderlyKeyStore;
+    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>;
+
+type OrderBookItem = number[];
+type OrderbookData = {
+    asks: OrderBookItem[];
+    bids: OrderBookItem[];
+};
+type OrderbookOptions = {
+    level?: number;
+};
+/**
+ * @name useOrderbookStream
+ * @description React hook that returns the current orderbook for a given market
+ */
+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;
+})[];
+
+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) => {
+        [P in keyof OrderEntity]?: string;
+    } | null | undefined;
+};
+/**
+ * 创建订单
+ * @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 useSymbolsInfo: () => any;
+
+declare const useAccountInfo: () => swr__internal.SWRResponse<API.AccountInfo, any, any>;
+
+declare const useTokenInfo: () => any;
+
+declare const useMarketsStream: () => {
+    data: WSMessage.Ticker[] | null;
+};
+
+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) => {
+    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;
+    next_funding_time?: number | undefined;
+    sum_unitary_funding?: number | undefined;
+};
+
+declare const usePositionStream: (symbol?: string, options?: SWRConfiguration) => any[];
+
+declare enum OrderStatus {
+    FILLED = "FILLED",
+    PARTIAL_FILLED = "PARTIAL_FILLED",
+    CANCELED = "CANCELED",
+    NEW = "NEW",
+    COMPLETED = "COMPLETED"
+}
+declare const useOrderStream: ({ status, symbol, }?: {
+    symbol?: string | undefined;
+    status?: OrderStatus | undefined;
+}) => (any[] | {
+    cancelAllOrders: () => void;
+    updateOrder: (id: string, data: any) => void;
+    cancelOrder: (id: string) => void;
+} | null)[];
+
+declare const useTradeStream: (symbol: string) => {
+    data: API.Trade[] | undefined;
+    isLoading: boolean;
+};
+
+type CollateralOutputs = {
+    totalCollateral: number;
+    freeCollateral: number;
+    totalValue: number;
+};
+/**
+ * 用户保证金
+ * @returns
+ */
+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;
+    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>;
+
+/**
+ * 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, 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

@@ -0,0 +1,288 @@
+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, 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 * as swr__internal from 'swr/_internal';
+import * as swr_subscription from 'swr/subscription';
+
+type useQueryOptions<T> = SWRConfiguration & {
+    formatter?: (data: any) => T;
+};
+
+/**
+ * useQuery
+ * @description for public api
+ * @param query
+ * @param options
+ */
+declare const useQuery: <T>(query: Parameters<typeof useSWR>["0"], options?: useQueryOptions<T> | undefined) => SWRResponse<T, any, any>;
+
+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
+ * @description for private api
+ * @param query
+ * @param options
+ */
+declare const usePrivateQuery: <T>(query: string, options?: useQueryOptions<T> | undefined) => SWRResponse<T, any, any>;
+
+declare const useTradingView: () => {};
+
+declare const usePrivateObserve: <T>() => {
+    data: T | undefined;
+};
+
+declare const useTopicObserve: <T>(topic: string) => {
+    data: T | undefined;
+};
+
+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: () => {
+    systemState: SystemStateEnum;
+    exchangeState: ExchangeStatusEnum;
+};
+
+declare const useWebSocketClient: () => WebSocketClient;
+
+declare const DataSourceProvider: FC<PropsWithChildren>;
+
+declare const useWS: () => WS;
+
+interface OrderlyAppConfig {
+    logoUrl: string;
+    theme: any;
+}
+interface OrderlyContextState extends OrderlyAppConfig {
+    fetcher?: (url: string, init: RequestInit) => Promise<any>;
+    apiBaseUrl: string;
+    klineDataUrl: string;
+    configStore: ConfigStore;
+    keyStore: OrderlyKeyStore;
+    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>;
+
+type OrderBookItem = number[];
+type OrderbookData = {
+    asks: OrderBookItem[];
+    bids: OrderBookItem[];
+};
+type OrderbookOptions = {
+    level?: number;
+};
+/**
+ * @name useOrderbookStream
+ * @description React hook that returns the current orderbook for a given market
+ */
+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;
+})[];
+
+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) => {
+        [P in keyof OrderEntity]?: string;
+    } | null | undefined;
+};
+/**
+ * 创建订单
+ * @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 useSymbolsInfo: () => any;
+
+declare const useAccountInfo: () => swr__internal.SWRResponse<API.AccountInfo, any, any>;
+
+declare const useTokenInfo: () => any;
+
+declare const useMarketsStream: () => {
+    data: WSMessage.Ticker[] | null;
+};
+
+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) => {
+    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;
+    next_funding_time?: number | undefined;
+    sum_unitary_funding?: number | undefined;
+};
+
+declare const usePositionStream: (symbol?: string, options?: SWRConfiguration) => any[];
+
+declare enum OrderStatus {
+    FILLED = "FILLED",
+    PARTIAL_FILLED = "PARTIAL_FILLED",
+    CANCELED = "CANCELED",
+    NEW = "NEW",
+    COMPLETED = "COMPLETED"
+}
+declare const useOrderStream: ({ status, symbol, }?: {
+    symbol?: string | undefined;
+    status?: OrderStatus | undefined;
+}) => (any[] | {
+    cancelAllOrders: () => void;
+    updateOrder: (id: string, data: any) => void;
+    cancelOrder: (id: string) => void;
+} | null)[];
+
+declare const useTradeStream: (symbol: string) => {
+    data: API.Trade[] | undefined;
+    isLoading: boolean;
+};
+
+type CollateralOutputs = {
+    totalCollateral: number;
+    freeCollateral: number;
+    totalValue: number;
+};
+/**
+ * 用户保证金
+ * @returns
+ */
+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;
+    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>;
+
+/**
+ * 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, 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 };