@liberfi.io/ui-predict 1.0.6 → 1.0.8

package/dist/index.d.mts

@@ -13,7 +13,7 @@ declare global {
         };
     }
 }
-declare const _default: "1.0.6";
+declare const _default: "1.0.8";
 
 /**
  * A single category entry in the static navigation model.
@@ -271,8 +271,13 @@ interface EventDetailPageProps {
      * Wallet / deposit flow.
      */
     onInsufficientBalance?: (source: ProviderSource) => void;
+    /**
+     * Maximum tolerated slippage for market orders, in basis points
+     * (100 = 1%). Forwarded to both buy and sell forms. Defaults to 100 bps.
+     */
+    slippageBps?: number;
 }
-declare function EventDetailPage({ eventSlug, source, chain, walletAddress, onSimilarEventClick, onSimilarEventHover, onBack, renderActivitySection, onInsufficientBalance, }: EventDetailPageProps): react_jsx_runtime.JSX.Element;
+declare function EventDetailPage({ eventSlug, source, chain, walletAddress, onSimilarEventClick, onSimilarEventHover, onBack, renderActivitySection, onInsufficientBalance, slippageBps, }: EventDetailPageProps): react_jsx_runtime.JSX.Element;
 
 type TradeOutcome = "yes" | "no";
 type TradeSide = "buy" | "sell";
@@ -314,6 +319,12 @@ interface UseTradeFormParams {
     market: PredictMarket;
     chain?: string;
     initialOutcome?: TradeOutcome;
+    /**
+     * Maximum tolerated slippage between best-of-book and the worst price
+     * walked into when filling a market order, in basis points (100 = 1%).
+     * Defaults to 100 bps. Use `0` to disable the check (not recommended).
+     */
+    slippageBps?: number;
     /**
      * Callback fired when the user attempts to submit a buy with an amount
      * larger than the available USDC balance for the market's source. The
@@ -332,6 +343,11 @@ interface UseTradeFormResult {
     estimatedCost: number;
     potentialPayout: number;
     potentialProfit: number;
+    /**
+     * Live best-ask price for the selected outcome (per-share, 0–1). Sourced
+     * from the WS/REST orderbook with a fallback to the static event payload.
+     */
+    pricePerShare: number;
     usdcBalance: number | null;
     isBalanceLoading: boolean;
     isMarketDataLoading: boolean;
@@ -364,7 +380,7 @@ interface UseTradeFormResult {
      */
     notifyInsufficientBalance: () => void;
 }
-declare function useTradeForm({ market, initialOutcome, onInsufficientBalance, }: UseTradeFormParams): UseTradeFormResult;
+declare function useTradeForm({ market, initialOutcome, slippageBps, onInsufficientBalance, }: UseTradeFormParams): UseTradeFormResult;
 
 interface EventDetailUIProps {
     event: PredictEvent;
@@ -486,6 +502,8 @@ type PredictTradeModalParams = {
     market: PredictMarket;
     initialOutcome?: TradeOutcome;
     chain?: string;
+    /** Forwarded slippage tolerance (basis points). */
+    slippageBps?: number;
     /**
      * Called when the user presses Buy with insufficient USDC balance for the
      * market's source. Allows the consumer to open a Fund Wallet flow.
@@ -563,6 +581,11 @@ interface TradeFormWidgetProps {
     variant?: "bordered" | "flat";
     initialOutcome?: TradeOutcome;
     chain?: string;
+    /**
+     * Maximum tolerated slippage (basis points) when filling a market buy.
+     * Defaults to 100 bps (1%). Forwarded to {@link useTradeForm}.
+     */
+    slippageBps?: number;
     /**
      * Called when the user presses Buy with an amount larger than the available
      * USDC balance for the market's source. Use this to show a top-up flow
@@ -570,13 +593,15 @@ interface TradeFormWidgetProps {
      */
     onInsufficientBalance?: (source: ProviderSource) => void;
 }
-declare function TradeFormWidget({ event, market, variant, initialOutcome, chain, onInsufficientBalance, }: TradeFormWidgetProps): react_jsx_runtime.JSX.Element;
+declare function TradeFormWidget({ event, market, variant, initialOutcome, chain, slippageBps, onInsufficientBalance, }: TradeFormWidgetProps): react_jsx_runtime.JSX.Element;
 
 type PredictSellModalParams = {
     event: PredictEvent;
     market: PredictMarket;
     initialOutcome?: TradeOutcome;
     chain?: string;
+    /** Forwarded slippage tolerance (basis points). */
+    slippageBps?: number;
 };
 type PredictSellModalResult = void;
 declare const PREDICT_SELL_MODAL_ID = "predict-sell";
@@ -589,6 +614,12 @@ interface UseSellFormParams {
     chain?: string;
     /** Fixed outcome — the sell form doesn't offer a YES/NO toggle. */
     initialOutcome?: TradeOutcome;
+    /**
+     * Maximum tolerated slippage between best-of-book and the worst price
+     * walked into when filling a market sell, in basis points (100 = 1%).
+     * Defaults to 100 bps. Use `0` to disable the check (not recommended).
+     */
+    slippageBps?: number;
 }
 interface UseSellFormResult {
     outcome: TradeOutcome;
@@ -597,6 +628,11 @@ interface UseSellFormResult {
     limitPrice: number;
     shares: number;
     estimatedReturn: number;
+    /**
+     * Live best-bid price for the selected outcome (per-share, 0–1). Sourced
+     * from the WS/REST orderbook with a fallback to the static event payload.
+     */
+    pricePerShare: number;
     isMarketDataLoading: boolean;
     isSubmitting: boolean;
     validation: TradeFormValidation;
@@ -625,7 +661,7 @@ interface UseSellFormResult {
     setCustomDurationUnit: (u: DurationUnit) => void;
     submit: () => void;
 }
-declare function useSellForm({ market, initialOutcome, }: UseSellFormParams): UseSellFormResult;
+declare function useSellForm({ market, initialOutcome, slippageBps, }: UseSellFormParams): UseSellFormResult;
 
 interface SellFormUIProps {
     event?: StandardEvent;
@@ -672,8 +708,13 @@ interface SellFormWidgetProps {
     variant?: "bordered" | "flat";
     initialOutcome?: TradeOutcome;
     chain?: string;
+    /**
+     * Maximum tolerated slippage (basis points) when filling a market sell.
+     * Defaults to 100 bps (1%). Forwarded to {@link useSellForm}.
+     */
+    slippageBps?: number;
 }
-declare function SellFormWidget({ event, market, variant, initialOutcome, chain, }: SellFormWidgetProps): react_jsx_runtime.JSX.Element;
+declare function SellFormWidget({ event, market, variant, initialOutcome, chain, slippageBps, }: SellFormWidgetProps): react_jsx_runtime.JSX.Element;
 
 type PredictRedeemModalParams = {
     event: PredictEvent;

package/dist/index.d.ts

@@ -13,7 +13,7 @@ declare global {
         };
     }
 }
-declare const _default: "1.0.6";
+declare const _default: "1.0.8";
 
 /**
  * A single category entry in the static navigation model.
@@ -271,8 +271,13 @@ interface EventDetailPageProps {
      * Wallet / deposit flow.
      */
     onInsufficientBalance?: (source: ProviderSource) => void;
+    /**
+     * Maximum tolerated slippage for market orders, in basis points
+     * (100 = 1%). Forwarded to both buy and sell forms. Defaults to 100 bps.
+     */
+    slippageBps?: number;
 }
-declare function EventDetailPage({ eventSlug, source, chain, walletAddress, onSimilarEventClick, onSimilarEventHover, onBack, renderActivitySection, onInsufficientBalance, }: EventDetailPageProps): react_jsx_runtime.JSX.Element;
+declare function EventDetailPage({ eventSlug, source, chain, walletAddress, onSimilarEventClick, onSimilarEventHover, onBack, renderActivitySection, onInsufficientBalance, slippageBps, }: EventDetailPageProps): react_jsx_runtime.JSX.Element;
 
 type TradeOutcome = "yes" | "no";
 type TradeSide = "buy" | "sell";
@@ -314,6 +319,12 @@ interface UseTradeFormParams {
     market: PredictMarket;
     chain?: string;
     initialOutcome?: TradeOutcome;
+    /**
+     * Maximum tolerated slippage between best-of-book and the worst price
+     * walked into when filling a market order, in basis points (100 = 1%).
+     * Defaults to 100 bps. Use `0` to disable the check (not recommended).
+     */
+    slippageBps?: number;
     /**
      * Callback fired when the user attempts to submit a buy with an amount
      * larger than the available USDC balance for the market's source. The
@@ -332,6 +343,11 @@ interface UseTradeFormResult {
     estimatedCost: number;
     potentialPayout: number;
     potentialProfit: number;
+    /**
+     * Live best-ask price for the selected outcome (per-share, 0–1). Sourced
+     * from the WS/REST orderbook with a fallback to the static event payload.
+     */
+    pricePerShare: number;
     usdcBalance: number | null;
     isBalanceLoading: boolean;
     isMarketDataLoading: boolean;
@@ -364,7 +380,7 @@ interface UseTradeFormResult {
      */
     notifyInsufficientBalance: () => void;
 }
-declare function useTradeForm({ market, initialOutcome, onInsufficientBalance, }: UseTradeFormParams): UseTradeFormResult;
+declare function useTradeForm({ market, initialOutcome, slippageBps, onInsufficientBalance, }: UseTradeFormParams): UseTradeFormResult;
 
 interface EventDetailUIProps {
     event: PredictEvent;
@@ -486,6 +502,8 @@ type PredictTradeModalParams = {
     market: PredictMarket;
     initialOutcome?: TradeOutcome;
     chain?: string;
+    /** Forwarded slippage tolerance (basis points). */
+    slippageBps?: number;
     /**
      * Called when the user presses Buy with insufficient USDC balance for the
      * market's source. Allows the consumer to open a Fund Wallet flow.
@@ -563,6 +581,11 @@ interface TradeFormWidgetProps {
     variant?: "bordered" | "flat";
     initialOutcome?: TradeOutcome;
     chain?: string;
+    /**
+     * Maximum tolerated slippage (basis points) when filling a market buy.
+     * Defaults to 100 bps (1%). Forwarded to {@link useTradeForm}.
+     */
+    slippageBps?: number;
     /**
      * Called when the user presses Buy with an amount larger than the available
      * USDC balance for the market's source. Use this to show a top-up flow
@@ -570,13 +593,15 @@ interface TradeFormWidgetProps {
      */
     onInsufficientBalance?: (source: ProviderSource) => void;
 }
-declare function TradeFormWidget({ event, market, variant, initialOutcome, chain, onInsufficientBalance, }: TradeFormWidgetProps): react_jsx_runtime.JSX.Element;
+declare function TradeFormWidget({ event, market, variant, initialOutcome, chain, slippageBps, onInsufficientBalance, }: TradeFormWidgetProps): react_jsx_runtime.JSX.Element;
 
 type PredictSellModalParams = {
     event: PredictEvent;
     market: PredictMarket;
     initialOutcome?: TradeOutcome;
     chain?: string;
+    /** Forwarded slippage tolerance (basis points). */
+    slippageBps?: number;
 };
 type PredictSellModalResult = void;
 declare const PREDICT_SELL_MODAL_ID = "predict-sell";
@@ -589,6 +614,12 @@ interface UseSellFormParams {
     chain?: string;
     /** Fixed outcome — the sell form doesn't offer a YES/NO toggle. */
     initialOutcome?: TradeOutcome;
+    /**
+     * Maximum tolerated slippage between best-of-book and the worst price
+     * walked into when filling a market sell, in basis points (100 = 1%).
+     * Defaults to 100 bps. Use `0` to disable the check (not recommended).
+     */
+    slippageBps?: number;
 }
 interface UseSellFormResult {
     outcome: TradeOutcome;
@@ -597,6 +628,11 @@ interface UseSellFormResult {
     limitPrice: number;
     shares: number;
     estimatedReturn: number;
+    /**
+     * Live best-bid price for the selected outcome (per-share, 0–1). Sourced
+     * from the WS/REST orderbook with a fallback to the static event payload.
+     */
+    pricePerShare: number;
     isMarketDataLoading: boolean;
     isSubmitting: boolean;
     validation: TradeFormValidation;
@@ -625,7 +661,7 @@ interface UseSellFormResult {
     setCustomDurationUnit: (u: DurationUnit) => void;
     submit: () => void;
 }
-declare function useSellForm({ market, initialOutcome, }: UseSellFormParams): UseSellFormResult;
+declare function useSellForm({ market, initialOutcome, slippageBps, }: UseSellFormParams): UseSellFormResult;
 
 interface SellFormUIProps {
     event?: StandardEvent;
@@ -672,8 +708,13 @@ interface SellFormWidgetProps {
     variant?: "bordered" | "flat";
     initialOutcome?: TradeOutcome;
     chain?: string;
+    /**
+     * Maximum tolerated slippage (basis points) when filling a market sell.
+     * Defaults to 100 bps (1%). Forwarded to {@link useSellForm}.
+     */
+    slippageBps?: number;
 }
-declare function SellFormWidget({ event, market, variant, initialOutcome, chain, }: SellFormWidgetProps): react_jsx_runtime.JSX.Element;
+declare function SellFormWidget({ event, market, variant, initialOutcome, chain, slippageBps, }: SellFormWidgetProps): react_jsx_runtime.JSX.Element;
 
 type PredictRedeemModalParams = {
     event: PredictEvent;