@agg-build/hooks 2.0.0 → 2.1.1

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.ts CHANGED
@@ -5,7 +5,7 @@ import * as _agg_build_sdk from '@agg-build/sdk';
5
5
  import { CandleBuilder, AggAuthStartBody, AggAuthStartResult, AggClientSessionInput, AggClient, RampQuote, RampQuoteRequest, RampWidgetSession, RampSessionRequest, QuoteManagedResponse, QuoteManagedParams, ExecuteManagedResponse, ExecuteManagedParams, GetPositionsParams, WsOrderSubmitted, WsBalanceUpdate, RedeemResponse, RedeemRequest, WsRedeemEvent, AggWebSocket, WsOrderEvent, WsWithdrawalLifecycleEvent, WsCandleInterval, WsTrade, AggregatedOrderbookResponse, AggLinkAccountBody, AggLinkAccountResult, AggLinkAccountConfirmResult, Category, UserActivityQuery, UserActivityItem, PaginatedResponse, CandleInterval, OrderbookState, OrderbookQuoteResponse, OrderListQuery, TradeExecutorOrder, SmartRouteSide, ExecutionMode, SmartRouteResponse, RecurrenceFilter, MidpointRow, BatchMidpointsResponse, AppClientConfigResponse } from '@agg-build/sdk';
6
6
  export { TurnstileChallengeError } from '@agg-build/sdk';
7
7
  import React, { ReactNode } from 'react';
8
- export { UseManagedBalancesOptions, UseWithdrawEstimateParams, UseWithdrawFlowOptions, UseWithdrawFlowResult, UseWithdrawManagedOptions, UseWithdrawalLifecycleResult, WithdrawFeeEstimate, WithdrawalLifecycleState, useManagedBalances, useWithdrawEstimate, useWithdrawFlow, useWithdrawManaged, useWithdrawalLifecycle } from './withdraw.js';
8
+ export { UseManagedBalancesOptions, UseWithdrawEstimateParams, UseWithdrawFlowOptions, UseWithdrawFlowResult, UseWithdrawManagedOptions, UseWithdrawPreviewParams, UseWithdrawalLifecycleResult, WithdrawFeeEstimate, WithdrawalLifecycleState, useManagedBalances, useWithdrawEstimate, useWithdrawFlow, useWithdrawManaged, useWithdrawPreview, useWithdrawalLifecycle } from './withdraw.js';
9
9
  export { U as UseDepositAddressesOptions, g as getDepositAddress, u as useDepositAddresses } from './use-deposit-addresses-B9ICS-3U.js';
10
10
  export { U as UseSyncBalancesOptions, u as useSyncBalances } from './use-sync-balances-CeD8qZWP.js';
11
11
 
@@ -313,6 +313,8 @@ type VenueEvent = {
313
313
  displayName: string | null;
314
314
  parentId: string | null;
315
315
  eventCount: number;
316
+ volume24hr: number;
317
+ volume: number;
316
318
  };
317
319
  }[];
318
320
  status?: MarketStatus | undefined;
@@ -433,6 +435,8 @@ interface AggUiLabels {
433
435
  errorPrefix: string;
434
436
  tabsAria: string;
435
437
  hiddenTabsAria: string;
438
+ scrollTabsLeft: string;
439
+ scrollTabsRight: string;
436
440
  selectAria: string;
437
441
  lineChartAria: string;
438
442
  candlestickChartAria: string;
@@ -586,6 +590,7 @@ interface AggUiLabels {
586
590
  networkReserveTooltipLineTwo: string;
587
591
  youReceive: string;
588
592
  confirm: string;
593
+ calculatingFees: string;
589
594
  successTitle: string;
590
595
  successDescription: (tokenSymbol: string) => string;
591
596
  successTitleCompleted: string;
@@ -671,6 +676,13 @@ interface AggUiLabels {
671
676
  categoryTabsAria: string;
672
677
  };
673
678
  userProfile: {
679
+ balance: {
680
+ availableBalance: string;
681
+ balanceByNetwork: string;
682
+ paperModeNetwork: string;
683
+ paperModeWarning: string;
684
+ networkTooltipDescription: string;
685
+ };
674
686
  activity: {
675
687
  depositType: string;
676
688
  redeemType: string;
@@ -1041,6 +1053,9 @@ interface AggUiLabels {
1041
1053
  buyingOutcome: (label: string) => string;
1042
1054
  sellingOutcome: (label: string) => string;
1043
1055
  findingBestRoute: string;
1056
+ findingBestOdds: string;
1057
+ updatingRoute: string;
1058
+ refreshingQuotes: string;
1044
1059
  checkingBalance: string;
1045
1060
  submittingOrderProgress: string;
1046
1061
  orderSubmittedProgress: (orderId: string) => string;
@@ -1282,6 +1297,7 @@ declare const resolveAggUiLabels: (locale: string) => AggUiLabels;
1282
1297
 
1283
1298
  type ThemeMode = "light" | "dark";
1284
1299
  type ChartTimeRange = "1H" | "6H" | "1D" | "1W" | "1M" | "ALL";
1300
+ type AggUiTradingExecutionMode = "live" | "paper";
1285
1301
  interface AggUiGeneralConfig {
1286
1302
  /** Locale for number and date formatting */
1287
1303
  locale: string;
@@ -1321,6 +1337,11 @@ type AggUiFeatureFlagsConfigInput = Partial<AggUiFeatureFlagsConfig>;
1321
1337
  interface AggUiMarketConfig {
1322
1338
  /** Arbitrage threshold for the UI */
1323
1339
  arbitrageThreshold: number;
1340
+ /**
1341
+ * Maximum venue market IDs sent in each REST `/midpoints` request.
1342
+ * Lower this when proxy/CDN URL limits are stricter than AGG's backend cap.
1343
+ */
1344
+ maxMidpointIdsPerRequest: number;
1324
1345
  }
1325
1346
  type AggUiMarketConfigInput = Partial<AggUiMarketConfig>;
1326
1347
  interface AggUiChartConfig {
@@ -1363,6 +1384,11 @@ interface AggUiSearchConfig {
1363
1384
  isShowingAllResults: boolean;
1364
1385
  }
1365
1386
  type AggUiSearchConfigInput = Partial<AggUiSearchConfig>;
1387
+ interface AggUiTradingConfig {
1388
+ /** Default execution mode used by trading surfaces unless a component prop overrides it. */
1389
+ executionMode: AggUiTradingExecutionMode;
1390
+ }
1391
+ type AggUiTradingConfigInput = Partial<AggUiTradingConfig>;
1366
1392
  interface AggUiConfig {
1367
1393
  /** Enable AGG development logs */
1368
1394
  enableLogs: boolean;
@@ -1386,6 +1412,8 @@ interface AggUiConfig {
1386
1412
  formatting: AggUiFormattingConfig;
1387
1413
  /** Search configuration */
1388
1414
  search: AggUiSearchConfig;
1415
+ /** Trading configuration */
1416
+ trading: AggUiTradingConfig;
1389
1417
  /**
1390
1418
  * Optional wallet action implementations.
1391
1419
  * When walletActions.sendToken is provided, DepositModal uses it for the
@@ -1419,6 +1447,8 @@ interface AggUiConfigInput {
1419
1447
  formatting?: AggUiFormattingConfigInput;
1420
1448
  /** Search config overrides */
1421
1449
  search?: AggUiSearchConfigInput;
1450
+ /** Trading config overrides */
1451
+ trading?: AggUiTradingConfigInput;
1422
1452
  /**
1423
1453
  * Optional wallet action implementations for deposit flows.
1424
1454
  * Provide this once at the provider level for plug-and-play deposit UX.
@@ -3359,6 +3389,9 @@ declare function mergeBestPricesPreferringLive(rest: ReadonlyMap<string, {
3359
3389
  */
3360
3390
  declare function useLiveTrades(canonicalMarketId: string | null): WsTrade[];
3361
3391
 
3392
+ interface UseMidpointsOptions {
3393
+ maxMidpointIdsPerRequest?: number;
3394
+ }
3362
3395
  interface UseMidpointsResult {
3363
3396
  /** Map of outcomeId → price. Empty while loading. */
3364
3397
  prices: Map<string, number>;
@@ -3419,7 +3452,7 @@ interface UseMidpointsResult {
3419
3452
  * sides because MVMO links same-side counterparts regardless of label
3420
3453
  * inversion. No label heuristics; no `1 - midpoint` flips.
3421
3454
  */
3422
- declare function useMidpoints(venueMarkets: VenueMarket[] | null | undefined): UseMidpointsResult;
3455
+ declare function useMidpoints(venueMarkets: VenueMarket[] | null | undefined, options?: UseMidpointsOptions): UseMidpointsResult;
3423
3456
 
3424
3457
  interface UseTradableVenuesResult {
3425
3458
  /**
@@ -4056,12 +4089,21 @@ interface UseSmartRouteOptions {
4056
4089
  /** Cache freshness and polling interval in milliseconds. Defaults to SMART_ROUTE_STALE_TIME_MS. */
4057
4090
  staleTimeMs?: number;
4058
4091
  }
4092
+ /**
4093
+ * Why the smart route query is currently loading.
4094
+ * - `"finding-best-odds"` — first fetch, no prior data in cache
4095
+ * - `"updating-route"` — query key changed (e.g. amount changed), placeholder data shown
4096
+ * - `"refreshing-quotes"` — background poll/revalidation with existing data
4097
+ */
4098
+ type SmartRouteLoadingReason = "finding-best-odds" | "updating-route" | "refreshing-quotes";
4059
4099
  interface UseSmartRouteResult {
4060
4100
  data: SmartRouteResponse | null;
4061
4101
  isLoading: boolean;
4062
4102
  isFetching: boolean;
4063
4103
  error: Error | null;
4064
4104
  refetch: () => Promise<unknown>;
4105
+ /** Null when not loading. See {@link SmartRouteLoadingReason}. */
4106
+ loadingReason: SmartRouteLoadingReason | null;
4065
4107
  }
4066
4108
  /**
4067
4109
  * Compute optimal order routing across venues via the MILP solver.
@@ -5176,6 +5218,7 @@ declare function useVenueMarkets(options?: UseVenueMarketsOptions): {
5176
5218
  interface UseVenueMarketMidpointsOptions {
5177
5219
  venueMarketIds: string[];
5178
5220
  enabled?: boolean;
5221
+ maxMidpointIdsPerRequest?: number;
5179
5222
  }
5180
5223
  declare function useVenueMarketMidpoints(options: UseVenueMarketMidpointsOptions): {
5181
5224
  midpointRows: (MidpointRow & {
@@ -5405,7 +5448,10 @@ declare const computePriceGaps: ({ markets, midpointsByVenueMarketId, }: Compute
5405
5448
  * outcome — semantically correct for both Yes and No sides because MVMO
5406
5449
  * links same-side counterparts regardless of label inversion.
5407
5450
  */
5408
- declare function useViewportMidpoints(visibleMarkets: VenueMarket[]): {
5451
+ interface UseViewportMidpointsOptions {
5452
+ maxMidpointIdsPerRequest?: number;
5453
+ }
5454
+ declare function useViewportMidpoints(visibleMarkets: VenueMarket[], options?: UseViewportMidpointsOptions): {
5409
5455
  prices: Map<string, number>;
5410
5456
  /**
5411
5457
  * Map of outcomeId → venue name that provided the price in `prices`.
@@ -5458,4 +5504,4 @@ declare function useAppConfig(): UseAppConfigResult;
5458
5504
  */
5459
5505
  declare function useCachedAppConfig(): UseAppConfigResult;
5460
5506
 
5461
- export { AUTH_CHOOSER_OPEN_EVENT, type AggAuthContextValue, type AggAuthSignInOptions, type AggBalanceContextValue, AggBalanceProvider, AggProvider, type AggProviderProps, AggProvider as AggSdkProvider, type AggProviderProps as AggSdkProviderProps, type AggUiConfig, type AggUiConfigInput, type AggUiLabels, type AggUiLabelsInput, AggUiProvider, CHART_TIME_RANGES, CONFIRMED_MATCH_STATUSES, type ChartTimeRange, type ClosedPositionTotals, type ComputePriceGapsOptions, DEFAULT_AGG_ROOT_CLASS_NAME, type DagStepProgress, type EventListStateContextValue, EventListStateProvider, type EventListStateSnapshot, type EventTradingContextValue, type EventTradingState, type ExecutionProgressPhase, type ExecutionTerminalOrderEvent, type GeoBlockState, type GetOrdersQuery, type GetPositionsQuery, type InvalidateUserActivityOptions, type InvalidateUserMoneyStateOptions, type LiveBestPrices, type LiveCandle, MAX_PRICE_GAP_PCT, MIN_PRICE_GAP_PCT, type MarketChartCandle, type MarketChartData, type MarketChartVenueData, type MarketOrderbookData, type MarketOrderbookIntegrity, MarketStatus, type MarketTradingState, MatchStatus, MatchType, type OrderEligibility, type OrderEligibilityReason, type OrderListItem, type OrderbookResult, type PositionGroup, type PriceGapValue, type RedeemEvent, type RedeemLegLifecycle, type RedeemLifecycleState, RedeemRejectedError, type RollingChartWindow, type ScaledCandlePoint, type SdkUiConfig, type SdkUiConfigInput, type SdkUiProviderProps, type ThemeMode, TradeSide, type TradingAction, type TradingState, type TradingStateBase, type TradingStateKind, type UseAggAuthOptions, type UseAggAuthReturn, type UseAppConfigResult, type UseArbFeedResult, type UseCategoriesOptions, type UseCategoryChildrenOptions, type UseEnrichedVenueEventOptions, type UseExecuteManagedOptions, type UseExecutionOrdersOptions, type UseExecutionPositionsOptions, type UseExecutionProgressOptions, type UseExecutionProgressResult, type UseExternalIdOptions, type UseExternalIdReturn, type UseLinkAccountReturn, type UseLiveCandleOverlayOptions, type UseLiveCandleOverlayResult, type UseLiveCandlesOptions, type UseLiveCandlesResult, type UseLiveMarketResult, type UseMarketArbResult, type UseMarketChartOptions, type UseMarketChartResult, type UseMarketOrderbookOptions, type UseMarketOrderbookResult, type UseMarketOrderbookVenueOutcome, type UseMarketSearchOptions, type UseMidpointsResult, type UseOrderBookOptions, type UseOrderbookQuoteOptions, type UseOrderbookQuoteResult, type UseOrdersOptions, type UsePositionsOptions, type UseQuoteManagedOptions, type UseRedeemLifecycleInput, type UseRollingChartWindowOptions, type UseSearchOptions, type UseSmartRouteOptions, type UseSmartRouteResult, type UseTradableVenuesResult, type UseUserActivityOptions, type UseUserHoldingsOptions, type UseVenueEventOptions, type UseVenueEventsOptions, type UseVenueMarketMidpointsOptions, type UseVenueMarketsOptions, type UseVisibleIdsOptions, type UseVisibleIdsResult, type UserActivityInvalidationStrategy, Venue, type VenueAvailabilityState, type VenueEvent, type VenueEventWithMarkets, type VenueMarket, type VenueMarketOutcome, type WalletActionSendTokenParams, type WalletActions, computeClosedPositionTotals, computePriceGaps, defaultAggUiConfig, defaultAggUiConfig as defaultSdkUiConfig, executionKeys, findLivePriceById, getBuilder, getOrCreateBuilder, getVenueAvailabilityState, getVisibleVenueIdsByConfig, getVisibleVenuesByConfig, getWalletAddressFromUserProfile, invalidateBalanceQueries, invalidatePositionQueries, invalidateUserActivityQueries, invalidateUserClaimState, invalidateUserMoneyState, isVenueDisabledByConfig, mergeBestPricesPreferringLive, normalizeVenueId, optimizedImageUrl, parseEmail, parseEmailStrict, rangeToSeconds, requestAggAuthChooserOpen, resolveAggUiLabels, resolveDefaultMarket as resolveDefaultTradingMarket, resolveEventTradingState, resolveMarketTradingState, resolveMarketWinningOutcome, resolveOrderEligibility, resolveRollingWindow, resolveTradingStateKind, sortVenues, timeRangeToInterval, tradingReducer, useAggAuth, useAggAuthContext, useAggAuthState, useAggBalance, useAggBalanceContext, useAggBalanceState, useAggClient, useAggLabels, useAggUiConfig, useAggWebSocket, useAppConfig, useArbFeed, useCachedAppConfig, useCategories, useCategoryChildren, useDebouncedValue, useEnrichedVenueEvent, useEventListState, useEventOrderbookData, useEventTradingContext, useExecuteManaged, useExecutionOrders, useExecutionPositions, useExecutionProgress, useExternalId, useGeoBlock, useLabels, useLinkAccount, useLiveBestPrices, useLiveCandleOverlay, useLiveCandles, useLiveMarket, useLiveMarketStores, useLiveOutcomePrices, useLiveTrades, useMarketArb, useMarketChart, useMarketOrderbook, useMarketSearch, useMidpoints, useOnBalanceUpdate, useOnOrderEvent, useOnOrderSubmitted, useOnRedeemEvent, useOnWithdrawalLifecycle, useOptionalAggClient, useOrderBook, useOrderbookQuote, useOrders, usePositions, useQuoteManaged, useRampQuotes, useRampSession, useRedeem, useRedeemEligibleCount, useRedeemLifecycle, useRedeemLifecycles, useRollingChartWindow, useSdkLabels, useSdkUiConfig, useSearch, useSmartRoute, useTradableVenues, useUserActivity, useUserHoldings, useVenueEvent, useVenueEvents, useVenueMarketMidpoints, useVenueMarkets, useViewportMidpoints, useVisibleIds, userActivityQueryKeys };
5507
+ export { AUTH_CHOOSER_OPEN_EVENT, type AggAuthContextValue, type AggAuthSignInOptions, type AggBalanceContextValue, AggBalanceProvider, AggProvider, type AggProviderProps, AggProvider as AggSdkProvider, type AggProviderProps as AggSdkProviderProps, type AggUiConfig, type AggUiConfigInput, type AggUiLabels, type AggUiLabelsInput, AggUiProvider, type AggUiTradingExecutionMode, CHART_TIME_RANGES, CONFIRMED_MATCH_STATUSES, type ChartTimeRange, type ClosedPositionTotals, type ComputePriceGapsOptions, DEFAULT_AGG_ROOT_CLASS_NAME, type DagStepProgress, type EventListStateContextValue, EventListStateProvider, type EventListStateSnapshot, type EventTradingContextValue, type EventTradingState, type ExecutionProgressPhase, type ExecutionTerminalOrderEvent, type GeoBlockState, type GetOrdersQuery, type GetPositionsQuery, type InvalidateUserActivityOptions, type InvalidateUserMoneyStateOptions, type LiveBestPrices, type LiveCandle, MAX_PRICE_GAP_PCT, MIN_PRICE_GAP_PCT, type MarketChartCandle, type MarketChartData, type MarketChartVenueData, type MarketOrderbookData, type MarketOrderbookIntegrity, MarketStatus, type MarketTradingState, MatchStatus, MatchType, type OrderEligibility, type OrderEligibilityReason, type OrderListItem, type OrderbookResult, type PositionGroup, type PriceGapValue, type RedeemEvent, type RedeemLegLifecycle, type RedeemLifecycleState, RedeemRejectedError, type RollingChartWindow, type ScaledCandlePoint, type SdkUiConfig, type SdkUiConfigInput, type SdkUiProviderProps, type SmartRouteLoadingReason, type ThemeMode, TradeSide, type TradingAction, type TradingState, type TradingStateBase, type TradingStateKind, type UseAggAuthOptions, type UseAggAuthReturn, type UseAppConfigResult, type UseArbFeedResult, type UseCategoriesOptions, type UseCategoryChildrenOptions, type UseEnrichedVenueEventOptions, type UseExecuteManagedOptions, type UseExecutionOrdersOptions, type UseExecutionPositionsOptions, type UseExecutionProgressOptions, type UseExecutionProgressResult, type UseExternalIdOptions, type UseExternalIdReturn, type UseLinkAccountReturn, type UseLiveCandleOverlayOptions, type UseLiveCandleOverlayResult, type UseLiveCandlesOptions, type UseLiveCandlesResult, type UseLiveMarketResult, type UseMarketArbResult, type UseMarketChartOptions, type UseMarketChartResult, type UseMarketOrderbookOptions, type UseMarketOrderbookResult, type UseMarketOrderbookVenueOutcome, type UseMarketSearchOptions, type UseMidpointsOptions, type UseMidpointsResult, type UseOrderBookOptions, type UseOrderbookQuoteOptions, type UseOrderbookQuoteResult, type UseOrdersOptions, type UsePositionsOptions, type UseQuoteManagedOptions, type UseRedeemLifecycleInput, type UseRollingChartWindowOptions, type UseSearchOptions, type UseSmartRouteOptions, type UseSmartRouteResult, type UseTradableVenuesResult, type UseUserActivityOptions, type UseUserHoldingsOptions, type UseVenueEventOptions, type UseVenueEventsOptions, type UseVenueMarketMidpointsOptions, type UseVenueMarketsOptions, type UseViewportMidpointsOptions, type UseVisibleIdsOptions, type UseVisibleIdsResult, type UserActivityInvalidationStrategy, Venue, type VenueAvailabilityState, type VenueEvent, type VenueEventWithMarkets, type VenueMarket, type VenueMarketOutcome, type WalletActionSendTokenParams, type WalletActions, computeClosedPositionTotals, computePriceGaps, defaultAggUiConfig, defaultAggUiConfig as defaultSdkUiConfig, executionKeys, findLivePriceById, getBuilder, getOrCreateBuilder, getVenueAvailabilityState, getVisibleVenueIdsByConfig, getVisibleVenuesByConfig, getWalletAddressFromUserProfile, invalidateBalanceQueries, invalidatePositionQueries, invalidateUserActivityQueries, invalidateUserClaimState, invalidateUserMoneyState, isVenueDisabledByConfig, mergeBestPricesPreferringLive, normalizeVenueId, optimizedImageUrl, parseEmail, parseEmailStrict, rangeToSeconds, requestAggAuthChooserOpen, resolveAggUiLabels, resolveDefaultMarket as resolveDefaultTradingMarket, resolveEventTradingState, resolveMarketTradingState, resolveMarketWinningOutcome, resolveOrderEligibility, resolveRollingWindow, resolveTradingStateKind, sortVenues, timeRangeToInterval, tradingReducer, useAggAuth, useAggAuthContext, useAggAuthState, useAggBalance, useAggBalanceContext, useAggBalanceState, useAggClient, useAggLabels, useAggUiConfig, useAggWebSocket, useAppConfig, useArbFeed, useCachedAppConfig, useCategories, useCategoryChildren, useDebouncedValue, useEnrichedVenueEvent, useEventListState, useEventOrderbookData, useEventTradingContext, useExecuteManaged, useExecutionOrders, useExecutionPositions, useExecutionProgress, useExternalId, useGeoBlock, useLabels, useLinkAccount, useLiveBestPrices, useLiveCandleOverlay, useLiveCandles, useLiveMarket, useLiveMarketStores, useLiveOutcomePrices, useLiveTrades, useMarketArb, useMarketChart, useMarketOrderbook, useMarketSearch, useMidpoints, useOnBalanceUpdate, useOnOrderEvent, useOnOrderSubmitted, useOnRedeemEvent, useOnWithdrawalLifecycle, useOptionalAggClient, useOrderBook, useOrderbookQuote, useOrders, usePositions, useQuoteManaged, useRampQuotes, useRampSession, useRedeem, useRedeemEligibleCount, useRedeemLifecycle, useRedeemLifecycles, useRollingChartWindow, useSdkLabels, useSdkUiConfig, useSearch, useSmartRoute, useTradableVenues, useUserActivity, useUserHoldings, useVenueEvent, useVenueEvents, useVenueMarketMidpoints, useVenueMarkets, useViewportMidpoints, useVisibleIds, userActivityQueryKeys };