@liberfi.io/ui-tokens 3.0.23 → 3.0.25

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ReactNode, ComponentType } from 'react';
 import * as _liberfi_io_types from '@liberfi.io/types';
-import { Token, GetTokenListOptions, TokenProtocol, Chain, WalletTag, TokenSocialMedias, TokenHoldersSortBy, TokenHolder, ActivitiesSortBy, Activity, TokenStats, TokenSecurity as TokenSecurity$1, TokenLiquidity, PortfolioPnl, LimitOrderState, LimitOrder, TokenFieldOption } from '@liberfi.io/types';
+import { Token, GetTokenListOptions, TokenProtocol, Chain, WalletTag, TokenSocialMedias, TokenHoldersSortBy, TokenHolder, ActivitiesSortBy, Activity, TokenStats, TokenSecurity as TokenSecurity$1, TokenLiquidity, PortfolioPnl, LimitOrderState, LimitOrder, TokenTopTrader, TokenTopTradersSortBy, TokenFieldOption } from '@liberfi.io/types';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { PopoverProps } from '@liberfi.io/ui';
 export { formatAmount } from '@liberfi.io/utils';
@@ -749,7 +749,7 @@ type TokenActivitiesListCurrency = "usd" | "native";
 interface TokenActivitiesListProps {
     activities: Array<Activity>;
     isLoading?: boolean;
-    sortBy: TokenActivitiesListSortBy;
+    sortBy?: TokenActivitiesListSortBy;
     onSortByChange: (sortBy: TokenActivitiesListSortBy) => void;
     /** filter by activity type; "all" shows everything including liquidity / red packets */
     typeFilter?: "all" | "buy" | "sell";
@@ -788,7 +788,7 @@ interface UseTokenActivitiesListScriptParams {
 interface UseTokenActivitiesListScriptResult {
     activities: Array<Activity>;
     isLoading: boolean;
-    sortBy: TokenActivitiesListSortBy;
+    sortBy: TokenActivitiesListSortBy | undefined;
     setSortBy: (s: TokenActivitiesListSortBy) => void;
     typeFilter: "all" | "buy" | "sell";
     setTypeFilter: (t: "all" | "buy" | "sell") => void;
@@ -803,9 +803,10 @@ interface UseTokenActivitiesListScriptResult {
  * and semantic filters change the result set.
  *
  * Realtime: {@link useTokenActivitiesSubscription} prepends new activities to
- * the first page while we're on the default `timestamp` sort + `all` filter
- * (and no cursor has been pushed). In other states, live pushes are ignored
- * to avoid confusing the sorted / filtered window.
+ * the first page while we're on the server default ordering (or explicit
+ * `timestamp`) + `all` filter (and no cursor has been pushed). In other
+ * states, live pushes are ignored to avoid confusing the sorted / filtered
+ * window.
  */
 declare function useTokenActivitiesListScript({ chain, address, limit, initialSortBy, initialTypeFilter, }: UseTokenActivitiesListScriptParams): UseTokenActivitiesListScriptResult;
 
@@ -1335,7 +1336,7 @@ interface TokenOrdersListWidgetProps {
 declare function TokenOrdersListWidget({ chain, wallet, tokenAddress, tokenSymbol, limit, initialStateFilter, initialCurrency, nativeSymbol, onCancelAll, renderActions, className, }: TokenOrdersListWidgetProps): react_jsx_runtime.JSX.Element;
 
 interface TokenTopTradersListProps {
-    traders: Array<TokenHolder>;
+    traders: Array<TokenTopTrader>;
     isLoading?: boolean;
     hasMore?: boolean;
     onLoadMore?: () => void;
@@ -1350,10 +1351,7 @@ interface TokenTopTradersListProps {
  * Presentational Top Traders list — visually parallel to
  * {@link TokenHoldersList} but with its own header + filters.
  *
- * The server currently returns the same row shape as holders, ranked by
- * realised PnL; the Realized PnL column stays blank (`—`) until the API
- * adds per-holder PnL fields. When that lands, extend
- * `TokenHolder` with the new fields and wire them into the cells here.
+ * Uses the token top-traders endpoint and its trader-specific PnL fields.
  */
 declare function TokenTopTradersList({ traders, isLoading, hasMore, onLoadMore, onlyTracked, onOnlyTrackedChange, now, renderAddress, className, }: TokenTopTradersListProps): react_jsx_runtime.JSX.Element;
 
@@ -1361,11 +1359,15 @@ interface UseTokenTopTradersListScriptParams {
     chain: Chain;
     address: string;
     limit?: number;
+    /** initial sortBy; undefined means the first request uses server default ordering. */
+    initialSortBy?: TokenTopTradersSortBy;
     initialOnlyTracked?: boolean;
 }
 interface UseTokenTopTradersListScriptResult {
-    traders: Array<TokenHolder>;
+    traders: Array<TokenTopTrader>;
     isLoading: boolean;
+    sortBy: TokenTopTradersSortBy | undefined;
+    setSortBy: (s: TokenTopTradersSortBy) => void;
     hasMore: boolean;
     loadMore: () => void;
     onlyTracked: boolean;
@@ -1374,13 +1376,12 @@ interface UseTokenTopTradersListScriptResult {
 /**
  * Script for the top-traders list widget.
  *
- * Builds on {@link useTokenTopTradersQuery} (bridge over the holders
- * endpoint with `sortBy=realizedPnl`). `onlyTracked` is a client-side
+ * Builds on {@link useTokenTopTradersQuery}. `onlyTracked` is a client-side
  * filter retained for UI parity with Axiom — until the server flags
  * tracked wallets, the toggle narrows visible rows to those whose `tags`
  * list is non-empty (a reasonable proxy for "tracked by someone").
  */
-declare function useTokenTopTradersListScript({ chain, address, limit, initialOnlyTracked, }: UseTokenTopTradersListScriptParams): UseTokenTopTradersListScriptResult;
+declare function useTokenTopTradersListScript({ chain, address, limit, initialSortBy, initialOnlyTracked, }: UseTokenTopTradersListScriptParams): UseTokenTopTradersListScriptResult;
 
 interface TokenTopTradersListWidgetProps {
     chain: Chain;

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ReactNode, ComponentType } from 'react';
 import * as _liberfi_io_types from '@liberfi.io/types';
-import { Token, GetTokenListOptions, TokenProtocol, Chain, WalletTag, TokenSocialMedias, TokenHoldersSortBy, TokenHolder, ActivitiesSortBy, Activity, TokenStats, TokenSecurity as TokenSecurity$1, TokenLiquidity, PortfolioPnl, LimitOrderState, LimitOrder, TokenFieldOption } from '@liberfi.io/types';
+import { Token, GetTokenListOptions, TokenProtocol, Chain, WalletTag, TokenSocialMedias, TokenHoldersSortBy, TokenHolder, ActivitiesSortBy, Activity, TokenStats, TokenSecurity as TokenSecurity$1, TokenLiquidity, PortfolioPnl, LimitOrderState, LimitOrder, TokenTopTrader, TokenTopTradersSortBy, TokenFieldOption } from '@liberfi.io/types';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { PopoverProps } from '@liberfi.io/ui';
 export { formatAmount } from '@liberfi.io/utils';
@@ -749,7 +749,7 @@ type TokenActivitiesListCurrency = "usd" | "native";
 interface TokenActivitiesListProps {
     activities: Array<Activity>;
     isLoading?: boolean;
-    sortBy: TokenActivitiesListSortBy;
+    sortBy?: TokenActivitiesListSortBy;
     onSortByChange: (sortBy: TokenActivitiesListSortBy) => void;
     /** filter by activity type; "all" shows everything including liquidity / red packets */
     typeFilter?: "all" | "buy" | "sell";
@@ -788,7 +788,7 @@ interface UseTokenActivitiesListScriptParams {
 interface UseTokenActivitiesListScriptResult {
     activities: Array<Activity>;
     isLoading: boolean;
-    sortBy: TokenActivitiesListSortBy;
+    sortBy: TokenActivitiesListSortBy | undefined;
     setSortBy: (s: TokenActivitiesListSortBy) => void;
     typeFilter: "all" | "buy" | "sell";
     setTypeFilter: (t: "all" | "buy" | "sell") => void;
@@ -803,9 +803,10 @@ interface UseTokenActivitiesListScriptResult {
  * and semantic filters change the result set.
  *
  * Realtime: {@link useTokenActivitiesSubscription} prepends new activities to
- * the first page while we're on the default `timestamp` sort + `all` filter
- * (and no cursor has been pushed). In other states, live pushes are ignored
- * to avoid confusing the sorted / filtered window.
+ * the first page while we're on the server default ordering (or explicit
+ * `timestamp`) + `all` filter (and no cursor has been pushed). In other
+ * states, live pushes are ignored to avoid confusing the sorted / filtered
+ * window.
  */
 declare function useTokenActivitiesListScript({ chain, address, limit, initialSortBy, initialTypeFilter, }: UseTokenActivitiesListScriptParams): UseTokenActivitiesListScriptResult;
 
@@ -1335,7 +1336,7 @@ interface TokenOrdersListWidgetProps {
 declare function TokenOrdersListWidget({ chain, wallet, tokenAddress, tokenSymbol, limit, initialStateFilter, initialCurrency, nativeSymbol, onCancelAll, renderActions, className, }: TokenOrdersListWidgetProps): react_jsx_runtime.JSX.Element;
 
 interface TokenTopTradersListProps {
-    traders: Array<TokenHolder>;
+    traders: Array<TokenTopTrader>;
     isLoading?: boolean;
     hasMore?: boolean;
     onLoadMore?: () => void;
@@ -1350,10 +1351,7 @@ interface TokenTopTradersListProps {
  * Presentational Top Traders list — visually parallel to
  * {@link TokenHoldersList} but with its own header + filters.
  *
- * The server currently returns the same row shape as holders, ranked by
- * realised PnL; the Realized PnL column stays blank (`—`) until the API
- * adds per-holder PnL fields. When that lands, extend
- * `TokenHolder` with the new fields and wire them into the cells here.
+ * Uses the token top-traders endpoint and its trader-specific PnL fields.
  */
 declare function TokenTopTradersList({ traders, isLoading, hasMore, onLoadMore, onlyTracked, onOnlyTrackedChange, now, renderAddress, className, }: TokenTopTradersListProps): react_jsx_runtime.JSX.Element;
 
@@ -1361,11 +1359,15 @@ interface UseTokenTopTradersListScriptParams {
     chain: Chain;
     address: string;
     limit?: number;
+    /** initial sortBy; undefined means the first request uses server default ordering. */
+    initialSortBy?: TokenTopTradersSortBy;
     initialOnlyTracked?: boolean;
 }
 interface UseTokenTopTradersListScriptResult {
-    traders: Array<TokenHolder>;
+    traders: Array<TokenTopTrader>;
     isLoading: boolean;
+    sortBy: TokenTopTradersSortBy | undefined;
+    setSortBy: (s: TokenTopTradersSortBy) => void;
     hasMore: boolean;
     loadMore: () => void;
     onlyTracked: boolean;
@@ -1374,13 +1376,12 @@ interface UseTokenTopTradersListScriptResult {
 /**
  * Script for the top-traders list widget.
  *
- * Builds on {@link useTokenTopTradersQuery} (bridge over the holders
- * endpoint with `sortBy=realizedPnl`). `onlyTracked` is a client-side
+ * Builds on {@link useTokenTopTradersQuery}. `onlyTracked` is a client-side
  * filter retained for UI parity with Axiom — until the server flags
  * tracked wallets, the toggle narrows visible rows to those whose `tags`
  * list is non-empty (a reasonable proxy for "tracked by someone").
  */
-declare function useTokenTopTradersListScript({ chain, address, limit, initialOnlyTracked, }: UseTokenTopTradersListScriptParams): UseTokenTopTradersListScriptResult;
+declare function useTokenTopTradersListScript({ chain, address, limit, initialSortBy, initialOnlyTracked, }: UseTokenTopTradersListScriptParams): UseTokenTopTradersListScriptResult;
 
 interface TokenTopTradersListWidgetProps {
     chain: Chain;