@orderly.network/hooks 0.0.4 → 0.0.6

package/dist/index.d.mts

@@ -0,0 +1,249 @@
+import useSWR, { SWRConfiguration, SWRResponse } from 'swr';
+export { SWRConfiguration, default as useSWR } from 'swr';
+import { SWRMutationConfiguration } from 'swr/mutation';
+import { AccountState, ConfigStore, WSMessage } from '@orderly.network/core';
+import { API, OrderEntity, OrderSide } from '@orderly.network/types';
+import { WebSocketClient } from '@orderly.network/net';
+export { useEventCallback, useObservable } from 'rxjs-hooks';
+export { default as useConstant } from 'use-constant';
+import * as react from 'react';
+import { FormikErrors, FormikState } from 'formik';
+import * as swr__internal from 'swr/_internal';
+
+type useQueryOptions<T> = SWRConfiguration & {
+    formatter?: (data: any) => T;
+};
+
+/**
+ * useQuery
+ * @description for public api
+ * @param query
+ * @param options
+ */
+declare const useQuery: <T>(query: string, 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;
+};
+
+/**
+ * usePrivateQuery
+ * @description for private api
+ * @param query
+ * @param options
+ */
+declare const usePrivateQuery: <T>(query: Parameters<typeof useSWR>["0"], 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: AccountState;
+    login: (address: string) => void;
+    info: API.AccountInfo | undefined;
+};
+
+declare const useWebSocketClient: () => WebSocketClient;
+
+interface OrderlyContextState {
+    fetcher?: (url: string, init: RequestInit) => Promise<any>;
+    apiBaseUrl: string;
+    configStore: ConfigStore;
+}
+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 useOrderbook
+ * @description React hook that returns the current orderbook for a given market
+ */
+declare const useOrderbook: (symbol: string, initial?: OrderbookData, options?: OrderbookOptions) => ({
+    markPrice: number;
+    middlePrice: any;
+    asks: OrderBookItem[];
+    bids: OrderBookItem[];
+    onDepthChange?: undefined;
+    depth?: undefined;
+} | {
+    onDepthChange: (depth: number) => void;
+    depth: number;
+})[];
+
+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;
+    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;
+}
+type UseOrderEntryOptions = {
+    commify?: boolean;
+    validate?: (data: OrderEntity) => {
+        [P in keyof OrderEntity]?: string;
+    } | null | undefined;
+};
+/**
+ * 创建订单
+ * @param symbol
+ * @returns
+ */
+declare const useOrderEntry: (symbol: string, initialValue?: Partial<OrderEntity>, 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 useTokenInfo: () => any;
+
+declare const useMarketsStream: () => {
+    data: WSMessage.Ticker[] | null;
+};
+
+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;
+}) => (API.OrderExt[] | {
+    cancelAllOrders: () => void;
+    updateOrder: (id: string, data: any) => void;
+    cancelOrder: (id: string) => void;
+} | null)[];
+
+type CollateralOutputs = {
+    totalCollateral: number;
+    freeCollateral: number;
+    totalValue: number;
+};
+/**
+ * 用户保证金
+ * @returns
+ */
+declare const useCollateral: (dp?: number) => CollateralOutputs;
+
+declare const useMaxQty: (symbol: string, side: OrderSide, reduceOnly?: boolean) => number;
+
+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 { OrderStatus, OrderlyContext, OrderlyContextState, OrderlyProvider, index as apis, useAccount, useCollateral, useFetures, useFundingRate$1 as useFundingRate, useMarketsStream, useMaxQty, useMutation, useOrderEntry, useOrderStream, useOrderbook, usePositionStream, usePrivateObserve, usePrivateQuery, useQuery, useSymbolsInfo, useTickerStream, useTokenInfo, useTopicObserve, useTradingView, useWebSocketClient };

package/dist/index.d.ts

@@ -0,0 +1,249 @@
+import useSWR, { SWRConfiguration, SWRResponse } from 'swr';
+export { SWRConfiguration, default as useSWR } from 'swr';
+import { SWRMutationConfiguration } from 'swr/mutation';
+import { AccountState, ConfigStore, WSMessage } from '@orderly.network/core';
+import { API, OrderEntity, OrderSide } from '@orderly.network/types';
+import { WebSocketClient } from '@orderly.network/net';
+export { useEventCallback, useObservable } from 'rxjs-hooks';
+export { default as useConstant } from 'use-constant';
+import * as react from 'react';
+import { FormikErrors, FormikState } from 'formik';
+import * as swr__internal from 'swr/_internal';
+
+type useQueryOptions<T> = SWRConfiguration & {
+    formatter?: (data: any) => T;
+};
+
+/**
+ * useQuery
+ * @description for public api
+ * @param query
+ * @param options
+ */
+declare const useQuery: <T>(query: string, 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;
+};
+
+/**
+ * usePrivateQuery
+ * @description for private api
+ * @param query
+ * @param options
+ */
+declare const usePrivateQuery: <T>(query: Parameters<typeof useSWR>["0"], 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: AccountState;
+    login: (address: string) => void;
+    info: API.AccountInfo | undefined;
+};
+
+declare const useWebSocketClient: () => WebSocketClient;
+
+interface OrderlyContextState {
+    fetcher?: (url: string, init: RequestInit) => Promise<any>;
+    apiBaseUrl: string;
+    configStore: ConfigStore;
+}
+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 useOrderbook
+ * @description React hook that returns the current orderbook for a given market
+ */
+declare const useOrderbook: (symbol: string, initial?: OrderbookData, options?: OrderbookOptions) => ({
+    markPrice: number;
+    middlePrice: any;
+    asks: OrderBookItem[];
+    bids: OrderBookItem[];
+    onDepthChange?: undefined;
+    depth?: undefined;
+} | {
+    onDepthChange: (depth: number) => void;
+    depth: number;
+})[];
+
+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;
+    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;
+}
+type UseOrderEntryOptions = {
+    commify?: boolean;
+    validate?: (data: OrderEntity) => {
+        [P in keyof OrderEntity]?: string;
+    } | null | undefined;
+};
+/**
+ * 创建订单
+ * @param symbol
+ * @returns
+ */
+declare const useOrderEntry: (symbol: string, initialValue?: Partial<OrderEntity>, 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 useTokenInfo: () => any;
+
+declare const useMarketsStream: () => {
+    data: WSMessage.Ticker[] | null;
+};
+
+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;
+}) => (API.OrderExt[] | {
+    cancelAllOrders: () => void;
+    updateOrder: (id: string, data: any) => void;
+    cancelOrder: (id: string) => void;
+} | null)[];
+
+type CollateralOutputs = {
+    totalCollateral: number;
+    freeCollateral: number;
+    totalValue: number;
+};
+/**
+ * 用户保证金
+ * @returns
+ */
+declare const useCollateral: (dp?: number) => CollateralOutputs;
+
+declare const useMaxQty: (symbol: string, side: OrderSide, reduceOnly?: boolean) => number;
+
+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 { OrderStatus, OrderlyContext, OrderlyContextState, OrderlyProvider, index as apis, useAccount, useCollateral, useFetures, useFundingRate$1 as useFundingRate, useMarketsStream, useMaxQty, useMutation, useOrderEntry, useOrderStream, useOrderbook, usePositionStream, usePrivateObserve, usePrivateQuery, useQuery, useSymbolsInfo, useTickerStream, useTokenInfo, useTopicObserve, useTradingView, useWebSocketClient };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orderly.network/hooks",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -21,7 +21,7 @@
     "rxjs": "^7.8.1",
     "tsup": "^7.1.0",
     "typescript": "^5.1.6",
-    "tsconfig": "0.0.1"
+    "tsconfig": "0.0.3"
   },
   "dependencies": {
     "formik": "^2.4.3",
@@ -29,11 +29,11 @@
     "rxjs-hooks": "0.8.0-alpha.0",
     "swr": "^2.2.0",
     "use-constant": "^1.1.1",
-    "@orderly.network/net": "1.0.1",
-    "@orderly.network/futures": "0.0.4",
-    "@orderly.network/utils": "0.0.2",
-    "@orderly.network/types": "0.0.3",
-    "@orderly.network/core": "0.0.3"
+    "@orderly.network/futures": "0.0.6",
+    "@orderly.network/core": "0.0.5",
+    "@orderly.network/net": "1.0.3",
+    "@orderly.network/types": "0.0.5",
+    "@orderly.network/utils": "0.0.2"
   },
   "peerDependencies": {
     "rxjs": "^7.8.1"