@orderly.network/hooks 2.0.1-preview.4 → 2.0.2-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -7,12 +7,13 @@ import * as swr__internal from 'swr/_internal';
7
7
  import * as _orderly_network_core from '@orderly.network/core';
8
8
  import { AccountState, Account, EventEmitter, ConfigStore, ConfigKey, SimpleDI, OrderlyKeyStore, WalletAdapter, IContract, DefaultConfigStore } from '@orderly.network/core';
9
9
  export { WalletAdapter } from '@orderly.network/core';
10
+ import * as _orderly_network_types from '@orderly.network/types';
11
+ import { NetworkId, API, Chain as Chain$1, ChainNamespace, WSMessage, OrderStatus, OrderSide, AlgoOrderRootType, OrderEntity, AlgoOrderEntity, OrderlyOrder, AlgoOrderType, RequireKeys, OrderType } from '@orderly.network/types';
10
12
  export { default as useConstant } from 'use-constant';
11
13
  import { WS } from '@orderly.network/net';
12
14
  import * as react from 'react';
13
15
  import { PropsWithChildren, FC } from 'react';
14
- import * as _orderly_network_types from '@orderly.network/types';
15
- import { API, NetworkId, Chain as Chain$1, ChainNamespace, WSMessage, OrderStatus, OrderSide, AlgoOrderRootType, OrderEntity, AlgoOrderEntity, OrderlyOrder, AlgoOrderType, RequireKeys, OrderType } from '@orderly.network/types';
16
+ import * as react_jsx_runtime from 'react/jsx-runtime';
16
17
  import { EIP1193Provider } from '@web3-onboard/common';
17
18
  import * as swr_subscription from 'swr/subscription';
18
19
  import * as _orderly_network_utils from '@orderly.network/utils';
@@ -27,7 +28,7 @@ declare global {
27
28
  };
28
29
  }
29
30
  }
30
- declare const _default: "2.0.1-preview.4";
31
+ declare const _default: "2.0.2-alpha.0";
31
32
 
32
33
  type useQueryOptions<T> = SWRConfiguration & {
33
34
  formatter?: (data: any) => T;
@@ -101,6 +102,12 @@ declare function useSessionStorage<T>(key: string, initialValue: T): [T, (data:
101
102
 
102
103
  declare function useLocalStorage<T>(key: string, initialValue: T): [any, (value: T) => void];
103
104
 
105
+ type CurrentChain = {
106
+ id: number;
107
+ info?: Chain;
108
+ };
109
+ declare const useNetworkInfo: (networkId: NetworkId) => (chainId: number) => CurrentChain;
110
+
104
111
  declare function parseJSON<T>(value: string | null): T | undefined;
105
112
 
106
113
  declare const useWS: () => WS;
@@ -189,7 +196,7 @@ type BaseConfigProviderProps = {
189
196
  chainFilter?: filteredChains | filterChainsFunc;
190
197
  customChains?: Chains<undefined, undefined>;
191
198
  };
192
- type ConfigProviderExclusionProps = {
199
+ type ExclusiveConfigProviderProps = {
193
200
  brokerId: string;
194
201
  brokerName?: string;
195
202
  networkId: NetworkId;
@@ -200,9 +207,11 @@ type ConfigProviderExclusionProps = {
200
207
  networkId?: never;
201
208
  configStore: ConfigStore;
202
209
  };
203
- type ConfigProviderProps = BaseConfigProviderProps & ConfigProviderExclusionProps;
210
+ type ConfigProviderProps = BaseConfigProviderProps & ExclusiveConfigProviderProps;
204
211
  declare const OrderlyConfigProvider: FC<PropsWithChildren<ConfigProviderProps>>;
205
212
 
213
+ declare const OrderlyTrackerProvider: ({ children }: PropsWithChildren) => react_jsx_runtime.JSX.Element;
214
+
206
215
  declare class ExtendedConfigStore extends DefaultConfigStore {
207
216
  constructor(init: Partial<Record<ConfigKey, any>>);
208
217
  get<T>(key: ConfigKey): T;
@@ -298,7 +307,8 @@ declare const useMarketsStream: () => {
298
307
  declare enum MarketsType$1 {
299
308
  FAVORITES = 0,
300
309
  RECENT = 1,
301
- ALL = 2
310
+ ALL = 2,
311
+ NEW_LISTING = 3
302
312
  }
303
313
  interface FavoriteTab$1 {
304
314
  name: string;
@@ -341,7 +351,8 @@ declare const useMarket: (type: MarketsType$1) => readonly [any[], {
341
351
  declare enum MarketsType {
342
352
  FAVORITES = 0,
343
353
  RECENT = 1,
344
- ALL = 2
354
+ ALL = 2,
355
+ NEW_LISTING = 3
345
356
  }
346
357
  interface FavoriteTab {
347
358
  name: string;
@@ -354,6 +365,9 @@ interface Favorite {
354
365
  interface Recent {
355
366
  name: string;
356
367
  }
368
+ interface NewListing {
369
+ name: string;
370
+ }
357
371
  type TabSort = Record<string, {
358
372
  sortKey: string;
359
373
  sortOrder: string;
@@ -390,6 +404,7 @@ declare const useMarketsStore: () => {
390
404
  name: string;
391
405
  }[];
392
406
  recent: Recent[];
407
+ newListing: NewListing[];
393
408
  tabSort: TabSort;
394
409
  selectedFavoriteTab: FavoriteTab;
395
410
  updateFavorites: react.Dispatch<react.SetStateAction<{
@@ -414,6 +429,7 @@ declare const useMarkets: (type?: MarketsType) => readonly [MarketsItem[], {
414
429
  name: string;
415
430
  }[];
416
431
  recent: Recent[];
432
+ newListing: NewListing[];
417
433
  tabSort: TabSort;
418
434
  selectedFavoriteTab: FavoriteTab;
419
435
  updateFavorites: react.Dispatch<react.SetStateAction<{
@@ -466,6 +482,13 @@ declare const useFundingRates: () => {
466
482
  isNil: boolean;
467
483
  };
468
484
 
485
+ type PeriodKey = "1d" | "3d" | "7d" | "14d" | "30d" | "90d";
486
+ declare const useFundingRateHistory: () => {
487
+ data: API.FundingHistory[];
488
+ isLoading: boolean;
489
+ getPositiveRates: (data: API.FundingHistory[], period: PeriodKey) => Record<string, number>;
490
+ };
491
+
469
492
  type PriceMode = "markPrice" | "lastPrice";
470
493
  declare const usePositionStream: (symbol?: string, options?: SWRConfiguration & {
471
494
  calcMode?: PriceMode;
@@ -1111,20 +1134,20 @@ declare namespace RefferalAPI {
1111
1134
  referee_info: Referee;
1112
1135
  }
1113
1136
  type ReferralCode = {
1114
- "code": string;
1115
- "max_rebate_rate": number;
1116
- "referee_rebate_rate": number;
1117
- "referrer_rebate_rate": number;
1118
- "total_invites": number;
1119
- "total_traded": number;
1137
+ code: string;
1138
+ max_rebate_rate: number;
1139
+ referee_rebate_rate: number;
1140
+ referrer_rebate_rate: number;
1141
+ total_invites: number;
1142
+ total_traded: number;
1120
1143
  };
1121
1144
  type Referrer = {
1122
- "total_invites": number;
1123
- "total_traded": number;
1124
- "total_referee_volume": number;
1125
- "total_referee_fee": number;
1126
- "referral_codes": ReferralCode[];
1127
- "total_referrer_rebate": number;
1145
+ total_invites: number;
1146
+ total_traded: number;
1147
+ total_referee_volume: number;
1148
+ total_referee_fee: number;
1149
+ referral_codes: ReferralCode[];
1150
+ total_referrer_rebate: number;
1128
1151
  "1d_invites": number;
1129
1152
  "7d_invites": number;
1130
1153
  "30d_invites": number;
@@ -1142,49 +1165,50 @@ declare namespace RefferalAPI {
1142
1165
  "30d_referrer_rebate": number;
1143
1166
  };
1144
1167
  type Referee = {
1145
- "referer_code"?: string;
1146
- "referee_rebate_rate"?: number;
1168
+ referer_code?: string;
1169
+ referee_rebate_rate?: number;
1147
1170
  "1d_referee_rebate": number;
1148
1171
  "7d_referee_rebate": number;
1149
1172
  "30d_referee_rebate": number;
1150
- "total_referee_rebate": number;
1173
+ total_referee_rebate: number;
1151
1174
  };
1152
1175
  type RefereeInfoItem = {
1153
- "account_id": string;
1154
- "code_binding_time": number;
1155
- "fee": number;
1156
- "referral_code": string;
1157
- "referral_rebate": number;
1158
- "register_time": number;
1159
- "trade_status": string;
1160
- "user_address": string;
1161
- "volume": number;
1176
+ account_id: string;
1177
+ code_binding_time: number;
1178
+ fee: number;
1179
+ referral_code: string;
1180
+ referral_rebate: number;
1181
+ register_time: number;
1182
+ trade_status: string;
1183
+ user_address: string;
1184
+ volume: number;
1162
1185
  };
1163
1186
  type UserVolStats = {
1164
- "perp_volume_last_30_days": number;
1165
- "perp_volume_last_7_days": number;
1166
- "perp_volume_ltd": number;
1167
- "perp_volume_ytd": number;
1187
+ perp_volume_last_30_days: number;
1188
+ perp_volume_last_7_days: number;
1189
+ perp_volume_ltd: number;
1190
+ perp_volume_ytd: number;
1168
1191
  };
1169
1192
  type Distribution = {
1170
- "amount": number;
1171
- "created_time": number;
1172
- "id": number;
1173
- "status": string;
1174
- "token": string;
1175
- "type": string;
1176
- "updated_time": number;
1193
+ amount: number;
1194
+ created_time: number;
1195
+ id: number;
1196
+ status: string;
1197
+ token: string;
1198
+ type: string;
1199
+ updated_time: number;
1177
1200
  };
1178
1201
  type ReferralRebateSummary = {
1179
- "referral_rebate": number;
1180
- "volume": number;
1181
- "fee": number;
1182
- "date": string;
1202
+ daily_traded_referral: number;
1203
+ referral_rebate: number;
1204
+ volume: number;
1205
+ fee: number;
1206
+ date: string;
1183
1207
  };
1184
1208
  type RefereeRebateSummary = {
1185
- "referee_rebate": number;
1186
- "fee": number;
1187
- "date": string;
1209
+ referee_rebate: number;
1210
+ fee: number;
1211
+ date: string;
1188
1212
  };
1189
1213
  type DayliVolume = {
1190
1214
  date: string;
@@ -1650,4 +1674,24 @@ declare const useOrderEntity: (order: {
1650
1674
  };
1651
1675
  };
1652
1676
 
1653
- export { type APIKeyItem, type AccountRewardsHistory, type AccountRewardsHistoryRow, AssetHistoryStatusEnum, type Brokers, type Chain, type Chains, type CheckReferralCodeReturns, type CollateralOutputs, type ComputedAlgoOrder, type ConfigProviderExclusionProps, type ConfigProviderProps, type ConnectedChain, type CurrentEpochEstimate, DefaultLayoutConfig, DistributionId, type DrawOptions, ENVType, type EpochInfoItem, type EpochInfoType, ExtendedConfigStore, type Favorite, type FavoriteTab, MarketsStorageKey, MarketsType, type OrderBookItem, type OrderParams, type OrderbookData, type OrderbookOptions, type OrderlyConfigContextState, OrderlyConfigProvider, OrderlyContext, OrderlyProvider, type PosterLayoutConfig, type PriceMode, type Recent, RefferalAPI, ScopeType, StatusContext, type StatusContextState, StatusProvider, type SymbolInfo, TWType, type UseChainsOptions, type UseChainsReturnObject, type UseOrderEntryMetaState, WalletConnectorContext, type WalletRewards, type WalletRewardsHistoryReturns, type WalletRewardsItem, type WalletState, WsNetworkStatus, type chainFilter, type chainFilterFunc, checkNotional, cleanStringStyle, type filteredChains$1 as filteredChains, parseJSON, useAccount, useAccountInfo, useAccountInstance, useAccountRewardsHistory, useAllBrokers, useApiKeyManager, useAssetsHistory, useBoolean, useChain, useChains, useCheckReferralCode, useCollateral, useCommission, useConfig, useCurEpochEstimate, useDaily, useDeposit, useDistribution, useDistributionHistory, useEpochInfo, useEventEmitter, useFundingFeeHistory, useFundingRate, useFundingRates, useGetClaimed, useGetEnv, useGetReferralCode, useHoldingStream, useIndexPrice, useKeyStore, useLazyQuery, useLeverage, useLocalStorage, useMaintenanceStatus, useMarginRatio, useMarkPrice, useMarkPriceBySymbol, useMarkPricesStream, useMarket, useMarketTradeStream, useMarkets, useMarketsStore, useMarketsStream, useMaxQty, useMediaQuery, useMutation, useOrderEntity, useOrderEntry, useOrderEntry$1 as useOrderEntry_deprecated, useOrderStore, useOrderStream, useOrderbookStream, usePositionActions, usePositionStream, usePoster, usePreLoadData, usePrivateDataObserver, usePrivateInfiniteQuery, usePrivateQuery, useQuery, useRefereeHistory, useRefereeInfo, useRefereeRebateSummary, useReferralInfo, useReferralRebateSummary, useSessionStorage, useSettleSubscription, useSimpleDI, useStatisticsDaily, useSymbolLeverage, useSymbolPriceRange, useSymbolsInfo, useTPSLOrder, useTickerStream, useWS, useWalletConnector, useWalletRewardsHistory, useWalletSubscription, useWithdraw, useWsStatus, index as utils, _default as version };
1677
+ type RestrictedAreasReturns = {
1678
+ ip?: string;
1679
+ invalidRegions?: string[];
1680
+ restrictedAreasOpen?: boolean;
1681
+ contact?: {
1682
+ url?: string;
1683
+ text?: string;
1684
+ };
1685
+ };
1686
+ interface IRestrictedAreasParams {
1687
+ enableDefault?: boolean;
1688
+ customRestrictedIps?: string[];
1689
+ customRestrictedRegions?: string[];
1690
+ contact?: {
1691
+ url?: string;
1692
+ text?: string;
1693
+ };
1694
+ }
1695
+ declare const useRestrictedAreas: (params: IRestrictedAreasParams) => RestrictedAreasReturns;
1696
+
1697
+ export { type APIKeyItem, type AccountRewardsHistory, type AccountRewardsHistoryRow, AssetHistoryStatusEnum, type Brokers, type Chain, type Chains, type CheckReferralCodeReturns, type CollateralOutputs, type ComputedAlgoOrder, type ConfigProviderProps, type ConnectedChain, type CurrentEpochEstimate, DefaultLayoutConfig, DistributionId, type DrawOptions, ENVType, type EpochInfoItem, type EpochInfoType, type ExclusiveConfigProviderProps, ExtendedConfigStore, type Favorite, type FavoriteTab, type IRestrictedAreasParams, MarketsStorageKey, MarketsType, type NewListing, type OrderBookItem, type OrderParams, type OrderbookData, type OrderbookOptions, type OrderlyConfigContextState, OrderlyConfigProvider, OrderlyContext, OrderlyProvider, OrderlyTrackerProvider, type PosterLayoutConfig, type PriceMode, type Recent, RefferalAPI, type RestrictedAreasReturns, ScopeType, StatusContext, type StatusContextState, StatusProvider, type SymbolInfo, TWType, type UseChainsOptions, type UseChainsReturnObject, type UseOrderEntryMetaState, WalletConnectorContext, type WalletRewards, type WalletRewardsHistoryReturns, type WalletRewardsItem, type WalletState, WsNetworkStatus, type chainFilter, type chainFilterFunc, checkNotional, cleanStringStyle, type filteredChains$1 as filteredChains, parseJSON, useAccount, useAccountInfo, useAccountInstance, useAccountRewardsHistory, useAllBrokers, useApiKeyManager, useAssetsHistory, useBoolean, useChain, useChains, useCheckReferralCode, useCollateral, useCommission, useConfig, useCurEpochEstimate, useDaily, useDeposit, useDistribution, useDistributionHistory, useEpochInfo, useEventEmitter, useFundingFeeHistory, useFundingRate, useFundingRateHistory, useFundingRates, useGetClaimed, useGetEnv, useGetReferralCode, useHoldingStream, useIndexPrice, useKeyStore, useLazyQuery, useLeverage, useLocalStorage, useMaintenanceStatus, useMarginRatio, useMarkPrice, useMarkPriceBySymbol, useMarkPricesStream, useMarket, useMarketTradeStream, useMarkets, useMarketsStore, useMarketsStream, useMaxQty, useMediaQuery, useMutation, useNetworkInfo, useOrderEntity, useOrderEntry, useOrderEntry$1 as useOrderEntry_deprecated, useOrderStore, useOrderStream, useOrderbookStream, usePositionActions, usePositionStream, usePoster, usePreLoadData, usePrivateDataObserver, usePrivateInfiniteQuery, usePrivateQuery, useQuery, useRefereeHistory, useRefereeInfo, useRefereeRebateSummary, useReferralInfo, useReferralRebateSummary, useRestrictedAreas, useSessionStorage, useSettleSubscription, useSimpleDI, useStatisticsDaily, useSymbolLeverage, useSymbolPriceRange, useSymbolsInfo, useTPSLOrder, useTickerStream, useWS, useWalletConnector, useWalletRewardsHistory, useWalletSubscription, useWithdraw, useWsStatus, index as utils, _default as version };
package/dist/index.d.ts CHANGED
@@ -7,12 +7,13 @@ import * as swr__internal from 'swr/_internal';
7
7
  import * as _orderly_network_core from '@orderly.network/core';
8
8
  import { AccountState, Account, EventEmitter, ConfigStore, ConfigKey, SimpleDI, OrderlyKeyStore, WalletAdapter, IContract, DefaultConfigStore } from '@orderly.network/core';
9
9
  export { WalletAdapter } from '@orderly.network/core';
10
+ import * as _orderly_network_types from '@orderly.network/types';
11
+ import { NetworkId, API, Chain as Chain$1, ChainNamespace, WSMessage, OrderStatus, OrderSide, AlgoOrderRootType, OrderEntity, AlgoOrderEntity, OrderlyOrder, AlgoOrderType, RequireKeys, OrderType } from '@orderly.network/types';
10
12
  export { default as useConstant } from 'use-constant';
11
13
  import { WS } from '@orderly.network/net';
12
14
  import * as react from 'react';
13
15
  import { PropsWithChildren, FC } from 'react';
14
- import * as _orderly_network_types from '@orderly.network/types';
15
- import { API, NetworkId, Chain as Chain$1, ChainNamespace, WSMessage, OrderStatus, OrderSide, AlgoOrderRootType, OrderEntity, AlgoOrderEntity, OrderlyOrder, AlgoOrderType, RequireKeys, OrderType } from '@orderly.network/types';
16
+ import * as react_jsx_runtime from 'react/jsx-runtime';
16
17
  import { EIP1193Provider } from '@web3-onboard/common';
17
18
  import * as swr_subscription from 'swr/subscription';
18
19
  import * as _orderly_network_utils from '@orderly.network/utils';
@@ -27,7 +28,7 @@ declare global {
27
28
  };
28
29
  }
29
30
  }
30
- declare const _default: "2.0.1-preview.4";
31
+ declare const _default: "2.0.2-alpha.0";
31
32
 
32
33
  type useQueryOptions<T> = SWRConfiguration & {
33
34
  formatter?: (data: any) => T;
@@ -101,6 +102,12 @@ declare function useSessionStorage<T>(key: string, initialValue: T): [T, (data:
101
102
 
102
103
  declare function useLocalStorage<T>(key: string, initialValue: T): [any, (value: T) => void];
103
104
 
105
+ type CurrentChain = {
106
+ id: number;
107
+ info?: Chain;
108
+ };
109
+ declare const useNetworkInfo: (networkId: NetworkId) => (chainId: number) => CurrentChain;
110
+
104
111
  declare function parseJSON<T>(value: string | null): T | undefined;
105
112
 
106
113
  declare const useWS: () => WS;
@@ -189,7 +196,7 @@ type BaseConfigProviderProps = {
189
196
  chainFilter?: filteredChains | filterChainsFunc;
190
197
  customChains?: Chains<undefined, undefined>;
191
198
  };
192
- type ConfigProviderExclusionProps = {
199
+ type ExclusiveConfigProviderProps = {
193
200
  brokerId: string;
194
201
  brokerName?: string;
195
202
  networkId: NetworkId;
@@ -200,9 +207,11 @@ type ConfigProviderExclusionProps = {
200
207
  networkId?: never;
201
208
  configStore: ConfigStore;
202
209
  };
203
- type ConfigProviderProps = BaseConfigProviderProps & ConfigProviderExclusionProps;
210
+ type ConfigProviderProps = BaseConfigProviderProps & ExclusiveConfigProviderProps;
204
211
  declare const OrderlyConfigProvider: FC<PropsWithChildren<ConfigProviderProps>>;
205
212
 
213
+ declare const OrderlyTrackerProvider: ({ children }: PropsWithChildren) => react_jsx_runtime.JSX.Element;
214
+
206
215
  declare class ExtendedConfigStore extends DefaultConfigStore {
207
216
  constructor(init: Partial<Record<ConfigKey, any>>);
208
217
  get<T>(key: ConfigKey): T;
@@ -298,7 +307,8 @@ declare const useMarketsStream: () => {
298
307
  declare enum MarketsType$1 {
299
308
  FAVORITES = 0,
300
309
  RECENT = 1,
301
- ALL = 2
310
+ ALL = 2,
311
+ NEW_LISTING = 3
302
312
  }
303
313
  interface FavoriteTab$1 {
304
314
  name: string;
@@ -341,7 +351,8 @@ declare const useMarket: (type: MarketsType$1) => readonly [any[], {
341
351
  declare enum MarketsType {
342
352
  FAVORITES = 0,
343
353
  RECENT = 1,
344
- ALL = 2
354
+ ALL = 2,
355
+ NEW_LISTING = 3
345
356
  }
346
357
  interface FavoriteTab {
347
358
  name: string;
@@ -354,6 +365,9 @@ interface Favorite {
354
365
  interface Recent {
355
366
  name: string;
356
367
  }
368
+ interface NewListing {
369
+ name: string;
370
+ }
357
371
  type TabSort = Record<string, {
358
372
  sortKey: string;
359
373
  sortOrder: string;
@@ -390,6 +404,7 @@ declare const useMarketsStore: () => {
390
404
  name: string;
391
405
  }[];
392
406
  recent: Recent[];
407
+ newListing: NewListing[];
393
408
  tabSort: TabSort;
394
409
  selectedFavoriteTab: FavoriteTab;
395
410
  updateFavorites: react.Dispatch<react.SetStateAction<{
@@ -414,6 +429,7 @@ declare const useMarkets: (type?: MarketsType) => readonly [MarketsItem[], {
414
429
  name: string;
415
430
  }[];
416
431
  recent: Recent[];
432
+ newListing: NewListing[];
417
433
  tabSort: TabSort;
418
434
  selectedFavoriteTab: FavoriteTab;
419
435
  updateFavorites: react.Dispatch<react.SetStateAction<{
@@ -466,6 +482,13 @@ declare const useFundingRates: () => {
466
482
  isNil: boolean;
467
483
  };
468
484
 
485
+ type PeriodKey = "1d" | "3d" | "7d" | "14d" | "30d" | "90d";
486
+ declare const useFundingRateHistory: () => {
487
+ data: API.FundingHistory[];
488
+ isLoading: boolean;
489
+ getPositiveRates: (data: API.FundingHistory[], period: PeriodKey) => Record<string, number>;
490
+ };
491
+
469
492
  type PriceMode = "markPrice" | "lastPrice";
470
493
  declare const usePositionStream: (symbol?: string, options?: SWRConfiguration & {
471
494
  calcMode?: PriceMode;
@@ -1111,20 +1134,20 @@ declare namespace RefferalAPI {
1111
1134
  referee_info: Referee;
1112
1135
  }
1113
1136
  type ReferralCode = {
1114
- "code": string;
1115
- "max_rebate_rate": number;
1116
- "referee_rebate_rate": number;
1117
- "referrer_rebate_rate": number;
1118
- "total_invites": number;
1119
- "total_traded": number;
1137
+ code: string;
1138
+ max_rebate_rate: number;
1139
+ referee_rebate_rate: number;
1140
+ referrer_rebate_rate: number;
1141
+ total_invites: number;
1142
+ total_traded: number;
1120
1143
  };
1121
1144
  type Referrer = {
1122
- "total_invites": number;
1123
- "total_traded": number;
1124
- "total_referee_volume": number;
1125
- "total_referee_fee": number;
1126
- "referral_codes": ReferralCode[];
1127
- "total_referrer_rebate": number;
1145
+ total_invites: number;
1146
+ total_traded: number;
1147
+ total_referee_volume: number;
1148
+ total_referee_fee: number;
1149
+ referral_codes: ReferralCode[];
1150
+ total_referrer_rebate: number;
1128
1151
  "1d_invites": number;
1129
1152
  "7d_invites": number;
1130
1153
  "30d_invites": number;
@@ -1142,49 +1165,50 @@ declare namespace RefferalAPI {
1142
1165
  "30d_referrer_rebate": number;
1143
1166
  };
1144
1167
  type Referee = {
1145
- "referer_code"?: string;
1146
- "referee_rebate_rate"?: number;
1168
+ referer_code?: string;
1169
+ referee_rebate_rate?: number;
1147
1170
  "1d_referee_rebate": number;
1148
1171
  "7d_referee_rebate": number;
1149
1172
  "30d_referee_rebate": number;
1150
- "total_referee_rebate": number;
1173
+ total_referee_rebate: number;
1151
1174
  };
1152
1175
  type RefereeInfoItem = {
1153
- "account_id": string;
1154
- "code_binding_time": number;
1155
- "fee": number;
1156
- "referral_code": string;
1157
- "referral_rebate": number;
1158
- "register_time": number;
1159
- "trade_status": string;
1160
- "user_address": string;
1161
- "volume": number;
1176
+ account_id: string;
1177
+ code_binding_time: number;
1178
+ fee: number;
1179
+ referral_code: string;
1180
+ referral_rebate: number;
1181
+ register_time: number;
1182
+ trade_status: string;
1183
+ user_address: string;
1184
+ volume: number;
1162
1185
  };
1163
1186
  type UserVolStats = {
1164
- "perp_volume_last_30_days": number;
1165
- "perp_volume_last_7_days": number;
1166
- "perp_volume_ltd": number;
1167
- "perp_volume_ytd": number;
1187
+ perp_volume_last_30_days: number;
1188
+ perp_volume_last_7_days: number;
1189
+ perp_volume_ltd: number;
1190
+ perp_volume_ytd: number;
1168
1191
  };
1169
1192
  type Distribution = {
1170
- "amount": number;
1171
- "created_time": number;
1172
- "id": number;
1173
- "status": string;
1174
- "token": string;
1175
- "type": string;
1176
- "updated_time": number;
1193
+ amount: number;
1194
+ created_time: number;
1195
+ id: number;
1196
+ status: string;
1197
+ token: string;
1198
+ type: string;
1199
+ updated_time: number;
1177
1200
  };
1178
1201
  type ReferralRebateSummary = {
1179
- "referral_rebate": number;
1180
- "volume": number;
1181
- "fee": number;
1182
- "date": string;
1202
+ daily_traded_referral: number;
1203
+ referral_rebate: number;
1204
+ volume: number;
1205
+ fee: number;
1206
+ date: string;
1183
1207
  };
1184
1208
  type RefereeRebateSummary = {
1185
- "referee_rebate": number;
1186
- "fee": number;
1187
- "date": string;
1209
+ referee_rebate: number;
1210
+ fee: number;
1211
+ date: string;
1188
1212
  };
1189
1213
  type DayliVolume = {
1190
1214
  date: string;
@@ -1650,4 +1674,24 @@ declare const useOrderEntity: (order: {
1650
1674
  };
1651
1675
  };
1652
1676
 
1653
- export { type APIKeyItem, type AccountRewardsHistory, type AccountRewardsHistoryRow, AssetHistoryStatusEnum, type Brokers, type Chain, type Chains, type CheckReferralCodeReturns, type CollateralOutputs, type ComputedAlgoOrder, type ConfigProviderExclusionProps, type ConfigProviderProps, type ConnectedChain, type CurrentEpochEstimate, DefaultLayoutConfig, DistributionId, type DrawOptions, ENVType, type EpochInfoItem, type EpochInfoType, ExtendedConfigStore, type Favorite, type FavoriteTab, MarketsStorageKey, MarketsType, type OrderBookItem, type OrderParams, type OrderbookData, type OrderbookOptions, type OrderlyConfigContextState, OrderlyConfigProvider, OrderlyContext, OrderlyProvider, type PosterLayoutConfig, type PriceMode, type Recent, RefferalAPI, ScopeType, StatusContext, type StatusContextState, StatusProvider, type SymbolInfo, TWType, type UseChainsOptions, type UseChainsReturnObject, type UseOrderEntryMetaState, WalletConnectorContext, type WalletRewards, type WalletRewardsHistoryReturns, type WalletRewardsItem, type WalletState, WsNetworkStatus, type chainFilter, type chainFilterFunc, checkNotional, cleanStringStyle, type filteredChains$1 as filteredChains, parseJSON, useAccount, useAccountInfo, useAccountInstance, useAccountRewardsHistory, useAllBrokers, useApiKeyManager, useAssetsHistory, useBoolean, useChain, useChains, useCheckReferralCode, useCollateral, useCommission, useConfig, useCurEpochEstimate, useDaily, useDeposit, useDistribution, useDistributionHistory, useEpochInfo, useEventEmitter, useFundingFeeHistory, useFundingRate, useFundingRates, useGetClaimed, useGetEnv, useGetReferralCode, useHoldingStream, useIndexPrice, useKeyStore, useLazyQuery, useLeverage, useLocalStorage, useMaintenanceStatus, useMarginRatio, useMarkPrice, useMarkPriceBySymbol, useMarkPricesStream, useMarket, useMarketTradeStream, useMarkets, useMarketsStore, useMarketsStream, useMaxQty, useMediaQuery, useMutation, useOrderEntity, useOrderEntry, useOrderEntry$1 as useOrderEntry_deprecated, useOrderStore, useOrderStream, useOrderbookStream, usePositionActions, usePositionStream, usePoster, usePreLoadData, usePrivateDataObserver, usePrivateInfiniteQuery, usePrivateQuery, useQuery, useRefereeHistory, useRefereeInfo, useRefereeRebateSummary, useReferralInfo, useReferralRebateSummary, useSessionStorage, useSettleSubscription, useSimpleDI, useStatisticsDaily, useSymbolLeverage, useSymbolPriceRange, useSymbolsInfo, useTPSLOrder, useTickerStream, useWS, useWalletConnector, useWalletRewardsHistory, useWalletSubscription, useWithdraw, useWsStatus, index as utils, _default as version };
1677
+ type RestrictedAreasReturns = {
1678
+ ip?: string;
1679
+ invalidRegions?: string[];
1680
+ restrictedAreasOpen?: boolean;
1681
+ contact?: {
1682
+ url?: string;
1683
+ text?: string;
1684
+ };
1685
+ };
1686
+ interface IRestrictedAreasParams {
1687
+ enableDefault?: boolean;
1688
+ customRestrictedIps?: string[];
1689
+ customRestrictedRegions?: string[];
1690
+ contact?: {
1691
+ url?: string;
1692
+ text?: string;
1693
+ };
1694
+ }
1695
+ declare const useRestrictedAreas: (params: IRestrictedAreasParams) => RestrictedAreasReturns;
1696
+
1697
+ export { type APIKeyItem, type AccountRewardsHistory, type AccountRewardsHistoryRow, AssetHistoryStatusEnum, type Brokers, type Chain, type Chains, type CheckReferralCodeReturns, type CollateralOutputs, type ComputedAlgoOrder, type ConfigProviderProps, type ConnectedChain, type CurrentEpochEstimate, DefaultLayoutConfig, DistributionId, type DrawOptions, ENVType, type EpochInfoItem, type EpochInfoType, type ExclusiveConfigProviderProps, ExtendedConfigStore, type Favorite, type FavoriteTab, type IRestrictedAreasParams, MarketsStorageKey, MarketsType, type NewListing, type OrderBookItem, type OrderParams, type OrderbookData, type OrderbookOptions, type OrderlyConfigContextState, OrderlyConfigProvider, OrderlyContext, OrderlyProvider, OrderlyTrackerProvider, type PosterLayoutConfig, type PriceMode, type Recent, RefferalAPI, type RestrictedAreasReturns, ScopeType, StatusContext, type StatusContextState, StatusProvider, type SymbolInfo, TWType, type UseChainsOptions, type UseChainsReturnObject, type UseOrderEntryMetaState, WalletConnectorContext, type WalletRewards, type WalletRewardsHistoryReturns, type WalletRewardsItem, type WalletState, WsNetworkStatus, type chainFilter, type chainFilterFunc, checkNotional, cleanStringStyle, type filteredChains$1 as filteredChains, parseJSON, useAccount, useAccountInfo, useAccountInstance, useAccountRewardsHistory, useAllBrokers, useApiKeyManager, useAssetsHistory, useBoolean, useChain, useChains, useCheckReferralCode, useCollateral, useCommission, useConfig, useCurEpochEstimate, useDaily, useDeposit, useDistribution, useDistributionHistory, useEpochInfo, useEventEmitter, useFundingFeeHistory, useFundingRate, useFundingRateHistory, useFundingRates, useGetClaimed, useGetEnv, useGetReferralCode, useHoldingStream, useIndexPrice, useKeyStore, useLazyQuery, useLeverage, useLocalStorage, useMaintenanceStatus, useMarginRatio, useMarkPrice, useMarkPriceBySymbol, useMarkPricesStream, useMarket, useMarketTradeStream, useMarkets, useMarketsStore, useMarketsStream, useMaxQty, useMediaQuery, useMutation, useNetworkInfo, useOrderEntity, useOrderEntry, useOrderEntry$1 as useOrderEntry_deprecated, useOrderStore, useOrderStream, useOrderbookStream, usePositionActions, usePositionStream, usePoster, usePreLoadData, usePrivateDataObserver, usePrivateInfiniteQuery, usePrivateQuery, useQuery, useRefereeHistory, useRefereeInfo, useRefereeRebateSummary, useReferralInfo, useReferralRebateSummary, useRestrictedAreas, useSessionStorage, useSettleSubscription, useSimpleDI, useStatisticsDaily, useSymbolLeverage, useSymbolPriceRange, useSymbolsInfo, useTPSLOrder, useTickerStream, useWS, useWalletConnector, useWalletRewardsHistory, useWalletSubscription, useWithdraw, useWsStatus, index as utils, _default as version };