@hyperbridge/sdk 2.8.16 → 2.8.17

package/dist/node/index.d.cts

@@ -1729,8 +1729,10 @@ interface OrderbookRouteLiquidity {
     book: OrderbookBook;
     /** `BID` when tokenIn is the book's base, `ASK` when it is the quote. */
     side: OrderbookSide;
-    /** Quote per 1 base; null when no order serves the route. */
+    /** Quote per 1 base, before the protocol fee; null when no order serves the route. */
     bestRate: bigint | null;
+    /** The destination chain's protocol fee in basis points, which the gateway takes out of what the orders deliver. */
+    slippageBps: number;
     /** Virtual depth: the serving orders' sizes summed, in tokenIn and tokenOut. */
     depthIn: bigint;
     depthOut: bigint;
@@ -1741,27 +1743,56 @@ interface OrderbookRouteLiquidity {
     orderCount: number;
     solverCount: number;
 }
-/** A quote for an input amount on a route. Amounts and rates at 1e18. */
+/** One order an optimistic quote takes, at the order's own price. Amounts and rates at 1e18. */
+interface OrderbookQuoteFill {
+    /** The order's full advertised size, not just the part this fill takes. */
+    advertisedSize: bigint;
+    /** The order's own price, quote per 1 base, before the protocol fee: what this fill settles at. */
+    orderRate: bigint;
+    /** The tokenIn this fill takes, in whole raw units on the source chain. */
+    amountIn: bigint;
+    /** The tokenOut this fill delivers, after the protocol fee, floored to a whole raw unit on the destination chain. */
+    amountOut: bigint;
+}
+/**
+ * An optimistic quote for an input amount on a route: the trade split across the route's orders,
+ * best price first, each at its own price. There is no one rate and no total output; the fills are
+ * the quote. Amounts and rates at 1e18.
+ */
 interface OrderbookSwapQuote {
     route: OrderbookRouteKind;
     side: OrderbookSide;
     /** The tokenIn priced, floored to a whole raw unit on the source chain. */
     amountIn: bigint;
-    /** The tokenOut delivered, floored to a whole raw unit on the destination chain; 0 when not fillable. */
+    /** The destination chain's protocol fee in basis points, already taken off every fill's `amountOut`. */
+    slippageBps: number;
+    fillable: boolean;
+    /** The largest tokenIn amount the route's orders could take together, each at its own price. */
+    maxFillableIn: bigint;
+    /** The orders used, best price first; empty when not fillable. */
+    fills: OrderbookQuoteFill[];
+}
+/**
+ * A pessimistic quote for an input amount on a route: one price, from the first level, best first,
+ * deep enough to fill the whole trade by itself, or else the route's worst price when its levels
+ * together can. Amounts and rates at 1e18.
+ */
+interface OrderbookLevelQuote {
+    route: OrderbookRouteKind;
+    side: OrderbookSide;
+    /** The tokenIn priced, floored to a whole raw unit on the source chain. */
+    amountIn: bigint;
+    /** The tokenOut delivered at `rate`, after the protocol fee, floored to a whole raw unit on the destination chain; 0 when not fillable. */
     amountOut: bigint;
-    /** The clearing price, quote per 1 base; null when the route cannot fill the amount. */
+    /** The worst single-order price in the level that fills it, quote per 1 base, before the protocol fee; null when not fillable. */
     rate: bigint | null;
+    /** The price bucket of that level; null when not fillable. */
+    priceBucket: bigint | null;
+    /** The destination chain's protocol fee in basis points, already taken off `amountOut`. */
+    slippageBps: number;
     fillable: boolean;
-    /** The tokenIn the route can absorb at `rate` or better. */
-    depth: bigint;
-    /** The largest tokenIn amount the route could fill. */
+    /** The largest tokenIn amount this quote could fill: any one level at its worst price, or the whole route at its worst. */
     maxFillableIn: bigint;
-    /** The orders used, best first. */
-    fills: {
-        orderRate: bigint;
-        amountOut: bigint;
-        advertisedSize: bigint;
-    }[];
 }
 /** The best bid and ask a route can reach, with the book that orients them. */
 interface OrderbookTopOfBook {
@@ -1778,8 +1809,9 @@ declare class OrderbookRequestError extends Error {
 /** Every document the client sends, so they can be checked against the orderbook's published schema. */
 declare const ORDERBOOK_QUERIES: {
     readonly topOfBook: "\nquery TopOfBook($tokenA: String!, $tokenB: String!, $fillChain: String!, $sourceChain: String!) {\n  books { id base quote }\n  aToB: bestRate(tokenIn: $tokenA, tokenOut: $tokenB, fillChain: $fillChain, sourceChain: $sourceChain) { side fillChain rate depthIn depthOut backingLiquidity sourceChains orderCount solverCount }\n  bToA: bestRate(tokenIn: $tokenB, tokenOut: $tokenA, fillChain: $fillChain, sourceChain: $sourceChain) { side fillChain rate depthIn depthOut backingLiquidity sourceChains orderCount solverCount }\n}";
-    readonly routeLiquidity: "\nquery RouteLiquidity($route: RouteInput!) {\n  books { id base quote }\n  routeLiquidity(route: $route) {\n    route bestRate depthIn depthOut availableLiquidity maxFillableIn orderCount solverCount\n  }\n}";
-    readonly quote: "\nquery Quote($route: RouteInput!, $amountIn: BigInt!) {\n  quote(route: $route, amountIn: $amountIn) {\n    route side amountIn amountOut rate fillable depth maxFillableIn\n    fills { orderRate amountOut advertisedSize }\n  }\n}";
+    readonly routeLiquidity: "\nquery RouteLiquidity($route: RouteInput!) {\n  books { id base quote }\n  routeLiquidity(route: $route) {\n    route bestRate slippageBps depthIn depthOut availableLiquidity maxFillableIn orderCount solverCount\n  }\n}";
+    readonly quote: "\nquery Quote($route: RouteInput!, $amountIn: BigInt!) {\n  quote(route: $route, amountIn: $amountIn) {\n    route side amountIn slippageBps fillable maxFillableIn\n    fills { advertisedSize orderRate amountIn amountOut }\n  }\n}";
+    readonly quotePessimistic: "\nquery QuotePessimistic($route: RouteInput!, $amountIn: BigInt!) {\n  quotePessimistic(route: $route, amountIn: $amountIn) {\n    route side amountIn amountOut rate priceBucket slippageBps fillable maxFillableIn\n  }\n}";
 };
 /**
  * Read-only client for the HyperFX orderbook's GraphQL API.
@@ -1804,12 +1836,20 @@ declare class HyperFxOrderbook {
     }): Promise<OrderbookTopOfBook>;
     /** Total liquidity on a route, no amount required. */
     routeLiquidity(route: OrderbookRoute): Promise<OrderbookRouteLiquidity>;
-    /** The clearing price for `amountIn` (1e18 tokenIn) on a route, which may combine several solvers' orders. */
+    /**
+     * The optimistic quote for `amountIn` (1e18 tokenIn) on a route: the route's orders, best price
+     * first, each taking what it can at its own price. The fills' `amountOut`s sum to the output.
+     */
     quote(route: OrderbookRoute, amountIn: bigint): Promise<OrderbookSwapQuote>;
+    /**
+     * The pessimistic quote for `amountIn` (1e18 tokenIn) on a route: one price, from the first level
+     * deep enough to fill the whole trade by itself, at which every order in it fills; the route's
+     * worst price when no one level can but its levels together can.
+     */
+    quotePessimistic(route: OrderbookRoute, amountIn: bigint): Promise<OrderbookLevelQuote>;
     private request;
 }
 
-type IntentQuoteTradeType = "EXACT_INPUT" | "EXACT_OUTPUT";
 /**
  * Parameters for `IntentGateway.quoteIntent`. The source and destination chains
  * come from the gateway instance itself. `tokenIn` and `tokenOut` are token
@@ -1823,35 +1863,70 @@ interface QuoteIntentParams {
     tokenOut: HexString;
     amountIn?: bigint;
     amountOut?: bigint;
+    /**
+     * Return the orderbook's optimistic quote (`QuoteIntentResult`): one leg per
+     * order, each at its own price. Defaults to the pessimistic quote
+     * (`PessimisticQuoteIntentResult`): the whole trade at one price.
+     */
+    optimistic?: boolean;
 }
-interface IntentQuoteMetadata {
-    sourceChain: Chains;
-    destinationChain: Chains;
+/**
+ * One order an optimistic intent quote takes, at the order's own price. Amounts
+ * are raw token units; the rate stays at 1e18.
+ */
+interface IntentQuoteLeg {
+    /** The order's full advertised size in `tokenOut`, not just the part this leg takes. */
+    advertisedSize: bigint;
+    /** The order's own price, quote per 1 base at 1e18, before the protocol fee: what this leg settles at. */
+    orderRate: bigint;
+    /** The `tokenIn` this leg takes. The legs' inputs sum to the quote's `amountIn`. */
+    amountIn: bigint;
+    /** The `tokenOut` this leg delivers, with the destination's protocol fee already taken off. */
+    amountOut: bigint;
+}
+/**
+ * `quoteIntent`'s result with `optimistic: true`, the orderbook's optimistic `quote`: the trade split across the
+ * route's orders, best price first, each at its own price. There is no single
+ * rate or total output; the legs are the quote, and their `amountOut`s sum to
+ * what the order should require. Amounts are raw token units.
+ */
+interface QuoteIntentResult {
     /** `SAME_CHAIN`, or `CROSS_CHAIN` when only orders accepting the source chain can fill it. */
     route: OrderbookRouteKind;
     /** `BID` when the order sells the book's base token, `ASK` when it buys it. */
     side: OrderbookSide;
-    baseTokenSymbol: ConfiguredAssetSymbol;
-    quoteTokenSymbol: ConfiguredAssetSymbol;
-    /** The clearing price the order was quoted at, in quote-token units per one base token. */
-    rate: string;
-    /** The largest `amountIn` the route can fill right now, in the source token's raw units. */
+    /** The `tokenIn` priced: the requested input, or the input found to deliver the requested output. */
+    amountIn: bigint;
+    /** The destination's protocol fee in basis points, already taken off every leg's `amountOut`. */
+    slippageBps: number;
+    fillable: boolean;
+    /** The largest `amountIn` the route's orders could take together, each at its own price. */
     maxFillableIn: bigint;
-    /** How many orders the quote combines. */
-    orderCount: number;
+    /** The orders used, best price first. */
+    legs: IntentQuoteLeg[];
 }
 /**
- * A quote priced from the HyperFX orderbook.
- *
- * `amountIn` and `amountOut` are raw token units and can be used directly as
- * the order's `inputs` and `output.assets`. The orderbook's rates already carry
- * the IntentGateway protocol fee, so no further fee adjustment is needed.
+ * `quoteIntent`'s default result, the orderbook's `quotePessimistic`: the whole trade at one
+ * price, the worst single-order price of the first level, best first, deep
+ * enough to fill it by itself, or the route's worst price when no one level
+ * can. Amounts are raw token units; rates stay at 1e18.
  */
-interface QuoteIntentResult {
-    tradeType: IntentQuoteTradeType;
+interface PessimisticQuoteIntentResult {
+    route: OrderbookRouteKind;
+    side: OrderbookSide;
+    /** The `tokenIn` priced: the requested input, or the input found to deliver the requested output. */
     amountIn: bigint;
+    /** The `tokenOut` delivered at `rate`, with the destination's protocol fee already taken off. */
     amountOut: bigint;
-    quoteMetadata: IntentQuoteMetadata;
+    /** Quote per 1 base, before the protocol fee: every order in the level fills at it. */
+    rate: bigint | null;
+    /** The price bucket of that level. */
+    priceBucket: bigint | null;
+    /** The destination's protocol fee in basis points, already taken off `amountOut`. */
+    slippageBps: number;
+    fillable: boolean;
+    /** The largest `amountIn` this quote could fill: any one level at its worst price, or the whole route at its worst. */
+    maxFillableIn: bigint;
 }
 /**
  * What the orderbook holds for one route, with no amount given. Amounts are
@@ -2046,20 +2121,31 @@ declare class IntentGateway {
     /**
      * Quotes an intent between this gateway's source and destination chains from
      * the HyperFX orderbook. Provide exactly one of `amountIn` or `amountOut`, in
-     * raw token units.
+     * raw token units. The result has the orderbook's shape, in raw token units.
      *
-     * An exact-input quote is the orderbook's clearing price for `amountIn`,
-     * which may combine several solvers' orders. An exact-output quote finds the
-     * smallest input whose clearing price delivers `amountOut`. A cross-chain
-     * route only counts orders whose solvers accept the source chain.
+     * By default the quote is pessimistic (`PessimisticQuoteIntentResult`): the
+     * whole trade at one price, the worst single-order price of the first level,
+     * best first, deep enough to fill it by itself, or the route's worst price
+     * when no one level can. With `optimistic: true` it is the orderbook's
+     * optimistic quote (`QuoteIntentResult`): the route's orders, best price
+     * first, each filling what it can of the trade at its own price, one leg per
+     * order. There is no total output; the legs' `amountOut`s sum to it.
      *
-     * The orderbook's rates already carry the gateway protocol fee, so the
-     * returned amounts can be placed as the order's inputs and outputs directly.
+     * Every `amountOut` already has the destination's protocol fee taken off. For
+     * an exact output, the quote is for an input that delivers `amountOut`. A
+     * cross-chain route only counts orders whose solvers accept the source chain.
      *
      * @throws {InsufficientOrderbookLiquidityError} When the route cannot fill the amount.
+     * @throws {OrderbookQuoteNotConvergedError} When an exact-output quote does not settle on an input.
      * @throws {OrderbookRequestError} When the orderbook is unreachable or trades no book for the pair.
      */
-    quoteIntent(params: QuoteIntentParams): Promise<QuoteIntentResult>;
+    quoteIntent(params: QuoteIntentParams & {
+        optimistic: true;
+    }): Promise<QuoteIntentResult>;
+    quoteIntent(params: QuoteIntentParams & {
+        optimistic?: false;
+    }): Promise<PessimisticQuoteIntentResult>;
+    quoteIntent(params: QuoteIntentParams): Promise<QuoteIntentResult | PessimisticQuoteIntentResult>;
     /**
      * Returns the orderbook liquidity serving a swap of `tokenIn` on the source
      * chain for `tokenOut` on the destination chain: the best rate, true and
@@ -6370,4 +6456,4 @@ declare function teleport(teleport_param: {
     extrinsics?: Array<SubmittableExtrinsic<"promise", ISubmittableResult>>;
 }): Promise<ReadableStream<HyperbridgeTxEvents>>;
 
-export { ADDRESS_ZERO, AssetTeleported, type AvailableLiquidity, Bid, type BridgeParams, type BridgeStep, type BundlerGasEstimate, BundlerMethod, type BuyAndSellRates, CONTRACT_VERSION_ABI, type CancelEvent, CancelOrderOptions, CancelQuote, ChainConfigService, Chains, ClientConfig, ConfiguredAssetSymbol, CryptoUtils, DEFAULT_ADDRESS, DEFAULT_GRAFFITI, DOMAIN_TYPEHASH, DUMMY_PRIVATE_KEY, type DecodedFillOrder, DecodedOrderPlacedLog, DecodedPostRequestEvent, DecodedPostResponseEvent, ERC20Method, ERC7821Call, ERC7821_BATCH_MODE, EstimateFillOrderParams, EstimateGasCallData, EvmChain, type EvmChainParams, ABI as EvmHostABI, EvmLanguage, FILL_ORDER_SELECTOR, FillOptions, FillOrderEstimate, FillerBid, GetRequestWithStatus, HexString, HyperFungibleToken, HyperFungibleTokenABI, HyperFxOrderbook, type HyperbridgeTxEvents, IChain, IEvmChain, IEvmConfig, IGetRequest, IIsmpMessage, IMessage, IPharosConfig, IPolkadotHubConfig, IPostRequest, IProof, IndexerQueryClient, InsufficientOrderbookLiquidityError, IntentGateway, type IntentGatewayContext, IntentOrderStatusUpdate, type IntentQuoteMetadata, type IntentQuoteTradeType, IntentsCoprocessor, IsmpClient, MOCK_ADDRESS, ORDERBOOK_DECIMALS, ORDERBOOK_QUERIES, ORDERBOOK_URLS, ORDER_V2_PARAM_TYPE, Order, OrderFeesQuote, OrderStatus, OrderStatusChecker, OrderWithStatus, type OrderbookBook, OrderbookQuoteNotConvergedError, type OrderbookRate, OrderbookRequestError, type OrderbookRoute, type OrderbookRouteKind, type OrderbookRouteLiquidity, type OrderbookSide, type OrderbookSwapQuote, type OrderbookTopOfBook, PACKED_USEROP_TYPEHASH, PLACE_ORDER_SELECTOR, PackedUserOperation, type Params, PharosChain, type PharosChainParams, PolkadotHubChain, type PolkadotHubChainParams, PostRequestTimeoutStatus, PostRequestWithStatus, QueryBuyAndSellRatesParams, type QuoteIntentParams, type QuoteIntentResult, type QuoteNativeResult, type QuoteResult, type QuoteUniswapParams, type QuoteUniswapResult, REQUEST_COMMITMENTS_SLOT, REQUEST_RECEIPTS_SLOT, RESPONSE_COMMITMENTS_SLOT, RESPONSE_RECEIPTS_SLOT, type RateFillPreview, RequestStatusWithMetadata, ResponseCommitmentWithValues, ResumeIntentOrderOptions, RetryConfig, SELECT_SOLVER_TYPEHASH, STATE_COMMITMENTS_SLOT, SUPPORTED_INTENTS_VERSION, SelectBidResult, StateMachineHeight, StateMachineIdParams, StateMachineUpdate, SubmitBidOptions, SubstrateChain, Swap, TESTNET_CHAINS, type TeleportParams, TeleportStatus, TokenGateway, TokenGatewayAssetTeleportedWithStatus, TokenInfo, Transaction, TronChain, type TronChainParams, USE_ETHERSCAN_CHAINS, type UniswapProtocol, type UniswapQuote, type UniswapQuoteToken, type UniswapTradeType, UnsupportedLiquidityAssetError, UnsupportedLiquidityChainError, WrappedHyperFungibleTokenABI, type XcmGatewayParams, __test, adjustDecimals, assertGatewayRelease, bytes20ToBytes32, bytes32ToBytes20, calculateAllowanceMappingLocation, calculateBalanceMappingLocation, constructRedeemEscrowRequestBody, constructRefundEscrowRequestBody, createEvmChain, createQueryClient, decodeFillOrder, encodeFillOrder, encodeStateMachineId, encodeWithdrawalRequest, estimateGasForPost, fetchPrice, fetchSourceProof, generateRootWithProof, getContractCallInput, getContractCallInputs, getGasPriceFromEtherscan, getOrFetchStorageSlot, getOrderPlacedFromTx, getPostRequestEventFromTx, getPostResponseEventFromTx, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, getStorageSlot, hexToString, isCanonicalEvmToken, maxBigInt, normalizeAddressForEvmBytes32, normalizeAddressForStateMachine, normalizeEvmAddress, normalizeEvmChainId, normalizeStateMachineId, orderCommitment, orderbookUrlFor, parseStateMachineId, postRequestCommitment, previewRateFill, queryAssetTeleported, queryGetRequest, queryPostRequest, quoteUniswap, readLegEscrow, readLegPartialFill, requestCommitmentKey, responseCommitmentKey, retryPromise, supportsRateFills, teleport, teleportDot, transformOrderForContract };
+export { ADDRESS_ZERO, AssetTeleported, type AvailableLiquidity, Bid, type BridgeParams, type BridgeStep, type BundlerGasEstimate, BundlerMethod, type BuyAndSellRates, CONTRACT_VERSION_ABI, type CancelEvent, CancelOrderOptions, CancelQuote, ChainConfigService, Chains, ClientConfig, ConfiguredAssetSymbol, CryptoUtils, DEFAULT_ADDRESS, DEFAULT_GRAFFITI, DOMAIN_TYPEHASH, DUMMY_PRIVATE_KEY, type DecodedFillOrder, DecodedOrderPlacedLog, DecodedPostRequestEvent, DecodedPostResponseEvent, ERC20Method, ERC7821Call, ERC7821_BATCH_MODE, EstimateFillOrderParams, EstimateGasCallData, EvmChain, type EvmChainParams, ABI as EvmHostABI, EvmLanguage, FILL_ORDER_SELECTOR, FillOptions, FillOrderEstimate, FillerBid, GetRequestWithStatus, HexString, HyperFungibleToken, HyperFungibleTokenABI, HyperFxOrderbook, type HyperbridgeTxEvents, IChain, IEvmChain, IEvmConfig, IGetRequest, IIsmpMessage, IMessage, IPharosConfig, IPolkadotHubConfig, IPostRequest, IProof, IndexerQueryClient, InsufficientOrderbookLiquidityError, IntentGateway, type IntentGatewayContext, IntentOrderStatusUpdate, type IntentQuoteLeg, IntentsCoprocessor, IsmpClient, MOCK_ADDRESS, ORDERBOOK_DECIMALS, ORDERBOOK_QUERIES, ORDERBOOK_URLS, ORDER_V2_PARAM_TYPE, Order, OrderFeesQuote, OrderStatus, OrderStatusChecker, OrderWithStatus, type OrderbookBook, type OrderbookLevelQuote, type OrderbookQuoteFill, OrderbookQuoteNotConvergedError, type OrderbookRate, OrderbookRequestError, type OrderbookRoute, type OrderbookRouteKind, type OrderbookRouteLiquidity, type OrderbookSide, type OrderbookSwapQuote, type OrderbookTopOfBook, PACKED_USEROP_TYPEHASH, PLACE_ORDER_SELECTOR, PackedUserOperation, type Params, type PessimisticQuoteIntentResult, PharosChain, type PharosChainParams, PolkadotHubChain, type PolkadotHubChainParams, PostRequestTimeoutStatus, PostRequestWithStatus, QueryBuyAndSellRatesParams, type QuoteIntentParams, type QuoteIntentResult, type QuoteNativeResult, type QuoteResult, type QuoteUniswapParams, type QuoteUniswapResult, REQUEST_COMMITMENTS_SLOT, REQUEST_RECEIPTS_SLOT, RESPONSE_COMMITMENTS_SLOT, RESPONSE_RECEIPTS_SLOT, type RateFillPreview, RequestStatusWithMetadata, ResponseCommitmentWithValues, ResumeIntentOrderOptions, RetryConfig, SELECT_SOLVER_TYPEHASH, STATE_COMMITMENTS_SLOT, SUPPORTED_INTENTS_VERSION, SelectBidResult, StateMachineHeight, StateMachineIdParams, StateMachineUpdate, SubmitBidOptions, SubstrateChain, Swap, TESTNET_CHAINS, type TeleportParams, TeleportStatus, TokenGateway, TokenGatewayAssetTeleportedWithStatus, TokenInfo, Transaction, TronChain, type TronChainParams, USE_ETHERSCAN_CHAINS, type UniswapProtocol, type UniswapQuote, type UniswapQuoteToken, type UniswapTradeType, UnsupportedLiquidityAssetError, UnsupportedLiquidityChainError, WrappedHyperFungibleTokenABI, type XcmGatewayParams, __test, adjustDecimals, assertGatewayRelease, bytes20ToBytes32, bytes32ToBytes20, calculateAllowanceMappingLocation, calculateBalanceMappingLocation, constructRedeemEscrowRequestBody, constructRefundEscrowRequestBody, createEvmChain, createQueryClient, decodeFillOrder, encodeFillOrder, encodeStateMachineId, encodeWithdrawalRequest, estimateGasForPost, fetchPrice, fetchSourceProof, generateRootWithProof, getContractCallInput, getContractCallInputs, getGasPriceFromEtherscan, getOrFetchStorageSlot, getOrderPlacedFromTx, getPostRequestEventFromTx, getPostResponseEventFromTx, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, getStorageSlot, hexToString, isCanonicalEvmToken, maxBigInt, normalizeAddressForEvmBytes32, normalizeAddressForStateMachine, normalizeEvmAddress, normalizeEvmChainId, normalizeStateMachineId, orderCommitment, orderbookUrlFor, parseStateMachineId, postRequestCommitment, previewRateFill, queryAssetTeleported, queryGetRequest, queryPostRequest, quoteUniswap, readLegEscrow, readLegPartialFill, requestCommitmentKey, responseCommitmentKey, retryPromise, supportsRateFills, teleport, teleportDot, transformOrderForContract };

package/dist/node/index.d.ts

@@ -1729,8 +1729,10 @@ interface OrderbookRouteLiquidity {
     book: OrderbookBook;
     /** `BID` when tokenIn is the book's base, `ASK` when it is the quote. */
     side: OrderbookSide;
-    /** Quote per 1 base; null when no order serves the route. */
+    /** Quote per 1 base, before the protocol fee; null when no order serves the route. */
     bestRate: bigint | null;
+    /** The destination chain's protocol fee in basis points, which the gateway takes out of what the orders deliver. */
+    slippageBps: number;
     /** Virtual depth: the serving orders' sizes summed, in tokenIn and tokenOut. */
     depthIn: bigint;
     depthOut: bigint;
@@ -1741,27 +1743,56 @@ interface OrderbookRouteLiquidity {
     orderCount: number;
     solverCount: number;
 }
-/** A quote for an input amount on a route. Amounts and rates at 1e18. */
+/** One order an optimistic quote takes, at the order's own price. Amounts and rates at 1e18. */
+interface OrderbookQuoteFill {
+    /** The order's full advertised size, not just the part this fill takes. */
+    advertisedSize: bigint;
+    /** The order's own price, quote per 1 base, before the protocol fee: what this fill settles at. */
+    orderRate: bigint;
+    /** The tokenIn this fill takes, in whole raw units on the source chain. */
+    amountIn: bigint;
+    /** The tokenOut this fill delivers, after the protocol fee, floored to a whole raw unit on the destination chain. */
+    amountOut: bigint;
+}
+/**
+ * An optimistic quote for an input amount on a route: the trade split across the route's orders,
+ * best price first, each at its own price. There is no one rate and no total output; the fills are
+ * the quote. Amounts and rates at 1e18.
+ */
 interface OrderbookSwapQuote {
     route: OrderbookRouteKind;
     side: OrderbookSide;
     /** The tokenIn priced, floored to a whole raw unit on the source chain. */
     amountIn: bigint;
-    /** The tokenOut delivered, floored to a whole raw unit on the destination chain; 0 when not fillable. */
+    /** The destination chain's protocol fee in basis points, already taken off every fill's `amountOut`. */
+    slippageBps: number;
+    fillable: boolean;
+    /** The largest tokenIn amount the route's orders could take together, each at its own price. */
+    maxFillableIn: bigint;
+    /** The orders used, best price first; empty when not fillable. */
+    fills: OrderbookQuoteFill[];
+}
+/**
+ * A pessimistic quote for an input amount on a route: one price, from the first level, best first,
+ * deep enough to fill the whole trade by itself, or else the route's worst price when its levels
+ * together can. Amounts and rates at 1e18.
+ */
+interface OrderbookLevelQuote {
+    route: OrderbookRouteKind;
+    side: OrderbookSide;
+    /** The tokenIn priced, floored to a whole raw unit on the source chain. */
+    amountIn: bigint;
+    /** The tokenOut delivered at `rate`, after the protocol fee, floored to a whole raw unit on the destination chain; 0 when not fillable. */
     amountOut: bigint;
-    /** The clearing price, quote per 1 base; null when the route cannot fill the amount. */
+    /** The worst single-order price in the level that fills it, quote per 1 base, before the protocol fee; null when not fillable. */
     rate: bigint | null;
+    /** The price bucket of that level; null when not fillable. */
+    priceBucket: bigint | null;
+    /** The destination chain's protocol fee in basis points, already taken off `amountOut`. */
+    slippageBps: number;
     fillable: boolean;
-    /** The tokenIn the route can absorb at `rate` or better. */
-    depth: bigint;
-    /** The largest tokenIn amount the route could fill. */
+    /** The largest tokenIn amount this quote could fill: any one level at its worst price, or the whole route at its worst. */
     maxFillableIn: bigint;
-    /** The orders used, best first. */
-    fills: {
-        orderRate: bigint;
-        amountOut: bigint;
-        advertisedSize: bigint;
-    }[];
 }
 /** The best bid and ask a route can reach, with the book that orients them. */
 interface OrderbookTopOfBook {
@@ -1778,8 +1809,9 @@ declare class OrderbookRequestError extends Error {
 /** Every document the client sends, so they can be checked against the orderbook's published schema. */
 declare const ORDERBOOK_QUERIES: {
     readonly topOfBook: "\nquery TopOfBook($tokenA: String!, $tokenB: String!, $fillChain: String!, $sourceChain: String!) {\n  books { id base quote }\n  aToB: bestRate(tokenIn: $tokenA, tokenOut: $tokenB, fillChain: $fillChain, sourceChain: $sourceChain) { side fillChain rate depthIn depthOut backingLiquidity sourceChains orderCount solverCount }\n  bToA: bestRate(tokenIn: $tokenB, tokenOut: $tokenA, fillChain: $fillChain, sourceChain: $sourceChain) { side fillChain rate depthIn depthOut backingLiquidity sourceChains orderCount solverCount }\n}";
-    readonly routeLiquidity: "\nquery RouteLiquidity($route: RouteInput!) {\n  books { id base quote }\n  routeLiquidity(route: $route) {\n    route bestRate depthIn depthOut availableLiquidity maxFillableIn orderCount solverCount\n  }\n}";
-    readonly quote: "\nquery Quote($route: RouteInput!, $amountIn: BigInt!) {\n  quote(route: $route, amountIn: $amountIn) {\n    route side amountIn amountOut rate fillable depth maxFillableIn\n    fills { orderRate amountOut advertisedSize }\n  }\n}";
+    readonly routeLiquidity: "\nquery RouteLiquidity($route: RouteInput!) {\n  books { id base quote }\n  routeLiquidity(route: $route) {\n    route bestRate slippageBps depthIn depthOut availableLiquidity maxFillableIn orderCount solverCount\n  }\n}";
+    readonly quote: "\nquery Quote($route: RouteInput!, $amountIn: BigInt!) {\n  quote(route: $route, amountIn: $amountIn) {\n    route side amountIn slippageBps fillable maxFillableIn\n    fills { advertisedSize orderRate amountIn amountOut }\n  }\n}";
+    readonly quotePessimistic: "\nquery QuotePessimistic($route: RouteInput!, $amountIn: BigInt!) {\n  quotePessimistic(route: $route, amountIn: $amountIn) {\n    route side amountIn amountOut rate priceBucket slippageBps fillable maxFillableIn\n  }\n}";
 };
 /**
  * Read-only client for the HyperFX orderbook's GraphQL API.
@@ -1804,12 +1836,20 @@ declare class HyperFxOrderbook {
     }): Promise<OrderbookTopOfBook>;
     /** Total liquidity on a route, no amount required. */
     routeLiquidity(route: OrderbookRoute): Promise<OrderbookRouteLiquidity>;
-    /** The clearing price for `amountIn` (1e18 tokenIn) on a route, which may combine several solvers' orders. */
+    /**
+     * The optimistic quote for `amountIn` (1e18 tokenIn) on a route: the route's orders, best price
+     * first, each taking what it can at its own price. The fills' `amountOut`s sum to the output.
+     */
     quote(route: OrderbookRoute, amountIn: bigint): Promise<OrderbookSwapQuote>;
+    /**
+     * The pessimistic quote for `amountIn` (1e18 tokenIn) on a route: one price, from the first level
+     * deep enough to fill the whole trade by itself, at which every order in it fills; the route's
+     * worst price when no one level can but its levels together can.
+     */
+    quotePessimistic(route: OrderbookRoute, amountIn: bigint): Promise<OrderbookLevelQuote>;
     private request;
 }
 
-type IntentQuoteTradeType = "EXACT_INPUT" | "EXACT_OUTPUT";
 /**
  * Parameters for `IntentGateway.quoteIntent`. The source and destination chains
  * come from the gateway instance itself. `tokenIn` and `tokenOut` are token
@@ -1823,35 +1863,70 @@ interface QuoteIntentParams {
     tokenOut: HexString;
     amountIn?: bigint;
     amountOut?: bigint;
+    /**
+     * Return the orderbook's optimistic quote (`QuoteIntentResult`): one leg per
+     * order, each at its own price. Defaults to the pessimistic quote
+     * (`PessimisticQuoteIntentResult`): the whole trade at one price.
+     */
+    optimistic?: boolean;
 }
-interface IntentQuoteMetadata {
-    sourceChain: Chains;
-    destinationChain: Chains;
+/**
+ * One order an optimistic intent quote takes, at the order's own price. Amounts
+ * are raw token units; the rate stays at 1e18.
+ */
+interface IntentQuoteLeg {
+    /** The order's full advertised size in `tokenOut`, not just the part this leg takes. */
+    advertisedSize: bigint;
+    /** The order's own price, quote per 1 base at 1e18, before the protocol fee: what this leg settles at. */
+    orderRate: bigint;
+    /** The `tokenIn` this leg takes. The legs' inputs sum to the quote's `amountIn`. */
+    amountIn: bigint;
+    /** The `tokenOut` this leg delivers, with the destination's protocol fee already taken off. */
+    amountOut: bigint;
+}
+/**
+ * `quoteIntent`'s result with `optimistic: true`, the orderbook's optimistic `quote`: the trade split across the
+ * route's orders, best price first, each at its own price. There is no single
+ * rate or total output; the legs are the quote, and their `amountOut`s sum to
+ * what the order should require. Amounts are raw token units.
+ */
+interface QuoteIntentResult {
     /** `SAME_CHAIN`, or `CROSS_CHAIN` when only orders accepting the source chain can fill it. */
     route: OrderbookRouteKind;
     /** `BID` when the order sells the book's base token, `ASK` when it buys it. */
     side: OrderbookSide;
-    baseTokenSymbol: ConfiguredAssetSymbol;
-    quoteTokenSymbol: ConfiguredAssetSymbol;
-    /** The clearing price the order was quoted at, in quote-token units per one base token. */
-    rate: string;
-    /** The largest `amountIn` the route can fill right now, in the source token's raw units. */
+    /** The `tokenIn` priced: the requested input, or the input found to deliver the requested output. */
+    amountIn: bigint;
+    /** The destination's protocol fee in basis points, already taken off every leg's `amountOut`. */
+    slippageBps: number;
+    fillable: boolean;
+    /** The largest `amountIn` the route's orders could take together, each at its own price. */
     maxFillableIn: bigint;
-    /** How many orders the quote combines. */
-    orderCount: number;
+    /** The orders used, best price first. */
+    legs: IntentQuoteLeg[];
 }
 /**
- * A quote priced from the HyperFX orderbook.
- *
- * `amountIn` and `amountOut` are raw token units and can be used directly as
- * the order's `inputs` and `output.assets`. The orderbook's rates already carry
- * the IntentGateway protocol fee, so no further fee adjustment is needed.
+ * `quoteIntent`'s default result, the orderbook's `quotePessimistic`: the whole trade at one
+ * price, the worst single-order price of the first level, best first, deep
+ * enough to fill it by itself, or the route's worst price when no one level
+ * can. Amounts are raw token units; rates stay at 1e18.
  */
-interface QuoteIntentResult {
-    tradeType: IntentQuoteTradeType;
+interface PessimisticQuoteIntentResult {
+    route: OrderbookRouteKind;
+    side: OrderbookSide;
+    /** The `tokenIn` priced: the requested input, or the input found to deliver the requested output. */
     amountIn: bigint;
+    /** The `tokenOut` delivered at `rate`, with the destination's protocol fee already taken off. */
     amountOut: bigint;
-    quoteMetadata: IntentQuoteMetadata;
+    /** Quote per 1 base, before the protocol fee: every order in the level fills at it. */
+    rate: bigint | null;
+    /** The price bucket of that level. */
+    priceBucket: bigint | null;
+    /** The destination's protocol fee in basis points, already taken off `amountOut`. */
+    slippageBps: number;
+    fillable: boolean;
+    /** The largest `amountIn` this quote could fill: any one level at its worst price, or the whole route at its worst. */
+    maxFillableIn: bigint;
 }
 /**
  * What the orderbook holds for one route, with no amount given. Amounts are
@@ -2046,20 +2121,31 @@ declare class IntentGateway {
     /**
      * Quotes an intent between this gateway's source and destination chains from
      * the HyperFX orderbook. Provide exactly one of `amountIn` or `amountOut`, in
-     * raw token units.
+     * raw token units. The result has the orderbook's shape, in raw token units.
      *
-     * An exact-input quote is the orderbook's clearing price for `amountIn`,
-     * which may combine several solvers' orders. An exact-output quote finds the
-     * smallest input whose clearing price delivers `amountOut`. A cross-chain
-     * route only counts orders whose solvers accept the source chain.
+     * By default the quote is pessimistic (`PessimisticQuoteIntentResult`): the
+     * whole trade at one price, the worst single-order price of the first level,
+     * best first, deep enough to fill it by itself, or the route's worst price
+     * when no one level can. With `optimistic: true` it is the orderbook's
+     * optimistic quote (`QuoteIntentResult`): the route's orders, best price
+     * first, each filling what it can of the trade at its own price, one leg per
+     * order. There is no total output; the legs' `amountOut`s sum to it.
      *
-     * The orderbook's rates already carry the gateway protocol fee, so the
-     * returned amounts can be placed as the order's inputs and outputs directly.
+     * Every `amountOut` already has the destination's protocol fee taken off. For
+     * an exact output, the quote is for an input that delivers `amountOut`. A
+     * cross-chain route only counts orders whose solvers accept the source chain.
      *
      * @throws {InsufficientOrderbookLiquidityError} When the route cannot fill the amount.
+     * @throws {OrderbookQuoteNotConvergedError} When an exact-output quote does not settle on an input.
      * @throws {OrderbookRequestError} When the orderbook is unreachable or trades no book for the pair.
      */
-    quoteIntent(params: QuoteIntentParams): Promise<QuoteIntentResult>;
+    quoteIntent(params: QuoteIntentParams & {
+        optimistic: true;
+    }): Promise<QuoteIntentResult>;
+    quoteIntent(params: QuoteIntentParams & {
+        optimistic?: false;
+    }): Promise<PessimisticQuoteIntentResult>;
+    quoteIntent(params: QuoteIntentParams): Promise<QuoteIntentResult | PessimisticQuoteIntentResult>;
     /**
      * Returns the orderbook liquidity serving a swap of `tokenIn` on the source
      * chain for `tokenOut` on the destination chain: the best rate, true and
@@ -6370,4 +6456,4 @@ declare function teleport(teleport_param: {
     extrinsics?: Array<SubmittableExtrinsic<"promise", ISubmittableResult>>;
 }): Promise<ReadableStream<HyperbridgeTxEvents>>;
 
-export { ADDRESS_ZERO, AssetTeleported, type AvailableLiquidity, Bid, type BridgeParams, type BridgeStep, type BundlerGasEstimate, BundlerMethod, type BuyAndSellRates, CONTRACT_VERSION_ABI, type CancelEvent, CancelOrderOptions, CancelQuote, ChainConfigService, Chains, ClientConfig, ConfiguredAssetSymbol, CryptoUtils, DEFAULT_ADDRESS, DEFAULT_GRAFFITI, DOMAIN_TYPEHASH, DUMMY_PRIVATE_KEY, type DecodedFillOrder, DecodedOrderPlacedLog, DecodedPostRequestEvent, DecodedPostResponseEvent, ERC20Method, ERC7821Call, ERC7821_BATCH_MODE, EstimateFillOrderParams, EstimateGasCallData, EvmChain, type EvmChainParams, ABI as EvmHostABI, EvmLanguage, FILL_ORDER_SELECTOR, FillOptions, FillOrderEstimate, FillerBid, GetRequestWithStatus, HexString, HyperFungibleToken, HyperFungibleTokenABI, HyperFxOrderbook, type HyperbridgeTxEvents, IChain, IEvmChain, IEvmConfig, IGetRequest, IIsmpMessage, IMessage, IPharosConfig, IPolkadotHubConfig, IPostRequest, IProof, IndexerQueryClient, InsufficientOrderbookLiquidityError, IntentGateway, type IntentGatewayContext, IntentOrderStatusUpdate, type IntentQuoteMetadata, type IntentQuoteTradeType, IntentsCoprocessor, IsmpClient, MOCK_ADDRESS, ORDERBOOK_DECIMALS, ORDERBOOK_QUERIES, ORDERBOOK_URLS, ORDER_V2_PARAM_TYPE, Order, OrderFeesQuote, OrderStatus, OrderStatusChecker, OrderWithStatus, type OrderbookBook, OrderbookQuoteNotConvergedError, type OrderbookRate, OrderbookRequestError, type OrderbookRoute, type OrderbookRouteKind, type OrderbookRouteLiquidity, type OrderbookSide, type OrderbookSwapQuote, type OrderbookTopOfBook, PACKED_USEROP_TYPEHASH, PLACE_ORDER_SELECTOR, PackedUserOperation, type Params, PharosChain, type PharosChainParams, PolkadotHubChain, type PolkadotHubChainParams, PostRequestTimeoutStatus, PostRequestWithStatus, QueryBuyAndSellRatesParams, type QuoteIntentParams, type QuoteIntentResult, type QuoteNativeResult, type QuoteResult, type QuoteUniswapParams, type QuoteUniswapResult, REQUEST_COMMITMENTS_SLOT, REQUEST_RECEIPTS_SLOT, RESPONSE_COMMITMENTS_SLOT, RESPONSE_RECEIPTS_SLOT, type RateFillPreview, RequestStatusWithMetadata, ResponseCommitmentWithValues, ResumeIntentOrderOptions, RetryConfig, SELECT_SOLVER_TYPEHASH, STATE_COMMITMENTS_SLOT, SUPPORTED_INTENTS_VERSION, SelectBidResult, StateMachineHeight, StateMachineIdParams, StateMachineUpdate, SubmitBidOptions, SubstrateChain, Swap, TESTNET_CHAINS, type TeleportParams, TeleportStatus, TokenGateway, TokenGatewayAssetTeleportedWithStatus, TokenInfo, Transaction, TronChain, type TronChainParams, USE_ETHERSCAN_CHAINS, type UniswapProtocol, type UniswapQuote, type UniswapQuoteToken, type UniswapTradeType, UnsupportedLiquidityAssetError, UnsupportedLiquidityChainError, WrappedHyperFungibleTokenABI, type XcmGatewayParams, __test, adjustDecimals, assertGatewayRelease, bytes20ToBytes32, bytes32ToBytes20, calculateAllowanceMappingLocation, calculateBalanceMappingLocation, constructRedeemEscrowRequestBody, constructRefundEscrowRequestBody, createEvmChain, createQueryClient, decodeFillOrder, encodeFillOrder, encodeStateMachineId, encodeWithdrawalRequest, estimateGasForPost, fetchPrice, fetchSourceProof, generateRootWithProof, getContractCallInput, getContractCallInputs, getGasPriceFromEtherscan, getOrFetchStorageSlot, getOrderPlacedFromTx, getPostRequestEventFromTx, getPostResponseEventFromTx, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, getStorageSlot, hexToString, isCanonicalEvmToken, maxBigInt, normalizeAddressForEvmBytes32, normalizeAddressForStateMachine, normalizeEvmAddress, normalizeEvmChainId, normalizeStateMachineId, orderCommitment, orderbookUrlFor, parseStateMachineId, postRequestCommitment, previewRateFill, queryAssetTeleported, queryGetRequest, queryPostRequest, quoteUniswap, readLegEscrow, readLegPartialFill, requestCommitmentKey, responseCommitmentKey, retryPromise, supportsRateFills, teleport, teleportDot, transformOrderForContract };
+export { ADDRESS_ZERO, AssetTeleported, type AvailableLiquidity, Bid, type BridgeParams, type BridgeStep, type BundlerGasEstimate, BundlerMethod, type BuyAndSellRates, CONTRACT_VERSION_ABI, type CancelEvent, CancelOrderOptions, CancelQuote, ChainConfigService, Chains, ClientConfig, ConfiguredAssetSymbol, CryptoUtils, DEFAULT_ADDRESS, DEFAULT_GRAFFITI, DOMAIN_TYPEHASH, DUMMY_PRIVATE_KEY, type DecodedFillOrder, DecodedOrderPlacedLog, DecodedPostRequestEvent, DecodedPostResponseEvent, ERC20Method, ERC7821Call, ERC7821_BATCH_MODE, EstimateFillOrderParams, EstimateGasCallData, EvmChain, type EvmChainParams, ABI as EvmHostABI, EvmLanguage, FILL_ORDER_SELECTOR, FillOptions, FillOrderEstimate, FillerBid, GetRequestWithStatus, HexString, HyperFungibleToken, HyperFungibleTokenABI, HyperFxOrderbook, type HyperbridgeTxEvents, IChain, IEvmChain, IEvmConfig, IGetRequest, IIsmpMessage, IMessage, IPharosConfig, IPolkadotHubConfig, IPostRequest, IProof, IndexerQueryClient, InsufficientOrderbookLiquidityError, IntentGateway, type IntentGatewayContext, IntentOrderStatusUpdate, type IntentQuoteLeg, IntentsCoprocessor, IsmpClient, MOCK_ADDRESS, ORDERBOOK_DECIMALS, ORDERBOOK_QUERIES, ORDERBOOK_URLS, ORDER_V2_PARAM_TYPE, Order, OrderFeesQuote, OrderStatus, OrderStatusChecker, OrderWithStatus, type OrderbookBook, type OrderbookLevelQuote, type OrderbookQuoteFill, OrderbookQuoteNotConvergedError, type OrderbookRate, OrderbookRequestError, type OrderbookRoute, type OrderbookRouteKind, type OrderbookRouteLiquidity, type OrderbookSide, type OrderbookSwapQuote, type OrderbookTopOfBook, PACKED_USEROP_TYPEHASH, PLACE_ORDER_SELECTOR, PackedUserOperation, type Params, type PessimisticQuoteIntentResult, PharosChain, type PharosChainParams, PolkadotHubChain, type PolkadotHubChainParams, PostRequestTimeoutStatus, PostRequestWithStatus, QueryBuyAndSellRatesParams, type QuoteIntentParams, type QuoteIntentResult, type QuoteNativeResult, type QuoteResult, type QuoteUniswapParams, type QuoteUniswapResult, REQUEST_COMMITMENTS_SLOT, REQUEST_RECEIPTS_SLOT, RESPONSE_COMMITMENTS_SLOT, RESPONSE_RECEIPTS_SLOT, type RateFillPreview, RequestStatusWithMetadata, ResponseCommitmentWithValues, ResumeIntentOrderOptions, RetryConfig, SELECT_SOLVER_TYPEHASH, STATE_COMMITMENTS_SLOT, SUPPORTED_INTENTS_VERSION, SelectBidResult, StateMachineHeight, StateMachineIdParams, StateMachineUpdate, SubmitBidOptions, SubstrateChain, Swap, TESTNET_CHAINS, type TeleportParams, TeleportStatus, TokenGateway, TokenGatewayAssetTeleportedWithStatus, TokenInfo, Transaction, TronChain, type TronChainParams, USE_ETHERSCAN_CHAINS, type UniswapProtocol, type UniswapQuote, type UniswapQuoteToken, type UniswapTradeType, UnsupportedLiquidityAssetError, UnsupportedLiquidityChainError, WrappedHyperFungibleTokenABI, type XcmGatewayParams, __test, adjustDecimals, assertGatewayRelease, bytes20ToBytes32, bytes32ToBytes20, calculateAllowanceMappingLocation, calculateBalanceMappingLocation, constructRedeemEscrowRequestBody, constructRefundEscrowRequestBody, createEvmChain, createQueryClient, decodeFillOrder, encodeFillOrder, encodeStateMachineId, encodeWithdrawalRequest, estimateGasForPost, fetchPrice, fetchSourceProof, generateRootWithProof, getContractCallInput, getContractCallInputs, getGasPriceFromEtherscan, getOrFetchStorageSlot, getOrderPlacedFromTx, getPostRequestEventFromTx, getPostResponseEventFromTx, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, getStorageSlot, hexToString, isCanonicalEvmToken, maxBigInt, normalizeAddressForEvmBytes32, normalizeAddressForStateMachine, normalizeEvmAddress, normalizeEvmChainId, normalizeStateMachineId, orderCommitment, orderbookUrlFor, parseStateMachineId, postRequestCommitment, previewRateFill, queryAssetTeleported, queryGetRequest, queryPostRequest, quoteUniswap, readLegEscrow, readLegPartialFill, requestCommitmentKey, responseCommitmentKey, retryPromise, supportsRateFills, teleport, teleportDot, transformOrderForContract };