@hyperbridge/sdk 2.8.16 → 2.8.17

package/dist/browser/index.d.ts

@@ -5012,8 +5012,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;
@@ -5024,27 +5026,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 {
@@ -5061,8 +5092,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.
@@ -5087,12 +5119,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
@@ -5106,35 +5146,70 @@ interface QuoteIntentParams {
     tokenOut: HexString$1;
     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
@@ -5329,20 +5404,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
@@ -11481,4 +11567,4 @@ declare function teleport(teleport_param: {
     extrinsics?: Array<SubmittableExtrinsic<"promise", ISubmittableResult>>;
 }): Promise<ReadableStream<HyperbridgeTxEvents>>;
 
-export { ADDRESS_ZERO, type AllStatusKey, type AssetTeleported, type AssetTeleportedResponse, type AvailableLiquidity, type Bid, type BidStorageEntry, type BidSubmissionResult, type BlockMetadata, type BridgeParams, type BridgeStep, type BundlerGasEstimate, BundlerMethod, type BuyAndSellRates, type BytesLikeHex, CONTRACT_VERSION_ABI, type CancelEvent, type CancelOptions, type CancelOrderOptions, type CancelQuote, type ChainConfig, type ChainConfigData, ChainConfigService, Chains, type ClientConfig, type ConfiguredAssetSymbol, type ConfiguredAssetSymbolInput, CryptoUtils, DEFAULT_ADDRESS, DEFAULT_GRAFFITI, DOMAIN_TYPEHASH, DUMMY_PRIVATE_KEY, type DecodedFillOrder, type DecodedOrderPlacedLog, type DecodedPostRequestEvent, type DecodedPostResponseEvent, type Deployment, type DispatchGet, type DispatchInfo, type DispatchPost, ERC20Method, type ERC7821Call, ERC7821_BATCH_MODE, type Erc4626VaultConfigData, type EstimateFillOrderParams, type EstimateGasCallData, EvmChain, type EvmChainParams, ABI as EvmHostABI, EvmLanguage, type ExecuteIntentOrderOptions, type ExecutionResult, FILL_ORDER_SELECTOR, type FillOptions, type FillOrderEstimate, type FillerBid, type FillerConfig, type GetRequestResponse, type GetRequestWithStatus, type GetResponseByRequestIdResponse, type GetResponseStorageValues, type HexString$1 as HexString, type HostParams, HyperClientStatus, HyperFungibleToken, HyperFungibleTokenABI, HyperFxOrderbook, type HyperbridgeTxEvents, type IBatchConsensusAndGetResponseMessage, type IBatchConsensusAndPostRequestMessage, type IChain, type IConfig, type IConsensusMessage, type IEvmChain, type IEvmConfig, type IGetRequest, type IGetRequestMessage, type IGetResponse, type IGetResponseMessage, type IHyperbridgeConfig, type IIsmpMessage, type IMessage, INCLUSION_TIMEOUT_MS, type IPharosConfig, type IPolkadotHubConfig, type IPostRequest, type IPostResponse, type IProof, type IRequestMessage, type ISubstrateConfig, type ITimeoutPostRequestMessage, type IndexerQueryClient, InsufficientOrderbookLiquidityError, IntentGateway, ABI$1 as IntentGatewayABI, type IntentGatewayContext, type IntentGatewayParams, IntentOrderStatus, type IntentOrderStatusKey, type IntentOrderStatusUpdate, type IntentQuoteMetadata, type IntentQuoteTradeType, IntentsCoprocessor, IsmpClient, type IsmpRequest, MAX_DECLARED_ENTRIES, MOCK_ADDRESS, ORDERBOOK_DECIMALS, ORDERBOOK_QUERIES, ORDERBOOK_URLS, ORDER_V2_PARAM_TYPE, type Order, type OrderFeesQuote, type OrderResponse, OrderStatus, OrderStatusChecker, type OrderStatusMetadata, type OrderWithStatus, type OrderbookBook, OrderbookQuoteNotConvergedError, type OrderbookRate, OrderbookRequestError, type OrderbookRoute, type OrderbookRouteKind, type OrderbookRouteLiquidity, type OrderbookSide, type OrderbookSwapQuote, type OrderbookTopOfBook, PACKED_USEROP_TYPEHASH, PERMIT2_SPONSORSHIP_BYTES, PLACE_ORDER_SELECTOR, type PackedUserOperation, type Params, type PaymentInfo, type PhantomBidDeclaration, type PhantomBidPaymasterAndData, type PhantomBidSponsorship, PharosChain, type PharosChainParams, PolkadotHubChain, type PolkadotHubChainParams, type PostRequestStatus, type PostRequestTimeoutStatus, type PostRequestWithStatus, type 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, type RequestBody, type RequestCommitment, RequestKind, type RequestResponse, RequestStatus, type RequestStatusKey, type RequestStatusWithMetadata, type ResponseCommitmentWithValues, type ResumeIntentOrderOptions, type RetryConfig, type RpcBidInfo, SELECT_SOLVER_TYPEHASH, STATE_COMMITMENTS_SLOT, SUPPORTED_INTENTS_VERSION, type SelectBidResult, type SelectOptions, type SigningAccount, type StateMachineHeight, type StateMachineId, type StateMachineIdParams, type StateMachineResponse, type StateMachineUpdate, type StorageFacade, type SubmitBidOptions, SubstrateChain, Swap, TESTNET_CHAINS, type TeleportParams, TeleportStatus, TimeoutStatus, type TimeoutStatusKey, TokenGateway, type TokenGatewayAssetTeleportedResponse, type TokenGatewayAssetTeleportedWithStatus, type TokenInfo, type TokenPrice, type TokenPricesResponse, type 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, chainConfigs, constructRedeemEscrowRequestBody, constructRefundEscrowRequestBody, convertCodecToIGetRequest, convertCodecToIProof, convertIGetRequestToCodec, convertIProofToCodec, convertStateIdToStateMachineId, convertStateMachineEnumToString, convertStateMachineIdToEnum, createEvmChain, createQueryClient, decodeAcceptedSourceChains, decodeERC7821ExecuteBatch, decodeFillOrder, decodePhantomBidDeclaration, decodePhantomBidPaymasterAndData, decodeUserOpScale, deriveHttpUrl, encodeAcceptedSourceChains, encodeERC7821ExecuteBatch, encodeFillOrder, encodeISMPMessage, encodePhantomBidDeclaration, encodePhantomBidPaymasterAndData, encodeStateMachineId, encodeUserOpScale, encodeWithdrawalRequest, estimateGasForPost, fetchPrice, fetchSourceProof, generateRootWithProof, getChainId, getConfigByStateMachineId, getContractCallInput, getContractCallInputs, getGasPriceFromEtherscan, getOrFetchStorageSlot, getOrderPlacedFromTx, getPostRequestEventFromTx, getPostResponseEventFromTx, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, getStorageSlot, getViemChain, hexToString, hyperbridgeAddress, isCanonicalEvmToken, maxBigInt, normalizeAddressForEvmBytes32, normalizeAddressForStateMachine, normalizeEvmAddress, normalizeEvmChainId, normalizeStateMachineId, orderCommitment, orderbookUrlFor, parseStateMachineId, pharosAtlantic, pharosMainnet, polkadotAssetHubPaseo, polkadotHubMainnet, poolSlug, postRequestCommitment, previewRateFill, queryAssetTeleported, queryGetRequest, queryPostRequest, quoteUniswap, readLegEscrow, readLegPartialFill, requestCommitmentKey, responseCommitmentKey, retryPromise, sortPoolSymbols, supportsRateFills, teleport, teleportDot, transformOrderForContract, tronChainIds, tronNile };
+export { ADDRESS_ZERO, type AllStatusKey, type AssetTeleported, type AssetTeleportedResponse, type AvailableLiquidity, type Bid, type BidStorageEntry, type BidSubmissionResult, type BlockMetadata, type BridgeParams, type BridgeStep, type BundlerGasEstimate, BundlerMethod, type BuyAndSellRates, type BytesLikeHex, CONTRACT_VERSION_ABI, type CancelEvent, type CancelOptions, type CancelOrderOptions, type CancelQuote, type ChainConfig, type ChainConfigData, ChainConfigService, Chains, type ClientConfig, type ConfiguredAssetSymbol, type ConfiguredAssetSymbolInput, CryptoUtils, DEFAULT_ADDRESS, DEFAULT_GRAFFITI, DOMAIN_TYPEHASH, DUMMY_PRIVATE_KEY, type DecodedFillOrder, type DecodedOrderPlacedLog, type DecodedPostRequestEvent, type DecodedPostResponseEvent, type Deployment, type DispatchGet, type DispatchInfo, type DispatchPost, ERC20Method, type ERC7821Call, ERC7821_BATCH_MODE, type Erc4626VaultConfigData, type EstimateFillOrderParams, type EstimateGasCallData, EvmChain, type EvmChainParams, ABI as EvmHostABI, EvmLanguage, type ExecuteIntentOrderOptions, type ExecutionResult, FILL_ORDER_SELECTOR, type FillOptions, type FillOrderEstimate, type FillerBid, type FillerConfig, type GetRequestResponse, type GetRequestWithStatus, type GetResponseByRequestIdResponse, type GetResponseStorageValues, type HexString$1 as HexString, type HostParams, HyperClientStatus, HyperFungibleToken, HyperFungibleTokenABI, HyperFxOrderbook, type HyperbridgeTxEvents, type IBatchConsensusAndGetResponseMessage, type IBatchConsensusAndPostRequestMessage, type IChain, type IConfig, type IConsensusMessage, type IEvmChain, type IEvmConfig, type IGetRequest, type IGetRequestMessage, type IGetResponse, type IGetResponseMessage, type IHyperbridgeConfig, type IIsmpMessage, type IMessage, INCLUSION_TIMEOUT_MS, type IPharosConfig, type IPolkadotHubConfig, type IPostRequest, type IPostResponse, type IProof, type IRequestMessage, type ISubstrateConfig, type ITimeoutPostRequestMessage, type IndexerQueryClient, InsufficientOrderbookLiquidityError, IntentGateway, ABI$1 as IntentGatewayABI, type IntentGatewayContext, type IntentGatewayParams, IntentOrderStatus, type IntentOrderStatusKey, type IntentOrderStatusUpdate, type IntentQuoteLeg, IntentsCoprocessor, IsmpClient, type IsmpRequest, MAX_DECLARED_ENTRIES, MOCK_ADDRESS, ORDERBOOK_DECIMALS, ORDERBOOK_QUERIES, ORDERBOOK_URLS, ORDER_V2_PARAM_TYPE, type Order, type OrderFeesQuote, type OrderResponse, OrderStatus, OrderStatusChecker, type OrderStatusMetadata, type 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, PERMIT2_SPONSORSHIP_BYTES, PLACE_ORDER_SELECTOR, type PackedUserOperation, type Params, type PaymentInfo, type PessimisticQuoteIntentResult, type PhantomBidDeclaration, type PhantomBidPaymasterAndData, type PhantomBidSponsorship, PharosChain, type PharosChainParams, PolkadotHubChain, type PolkadotHubChainParams, type PostRequestStatus, type PostRequestTimeoutStatus, type PostRequestWithStatus, type 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, type RequestBody, type RequestCommitment, RequestKind, type RequestResponse, RequestStatus, type RequestStatusKey, type RequestStatusWithMetadata, type ResponseCommitmentWithValues, type ResumeIntentOrderOptions, type RetryConfig, type RpcBidInfo, SELECT_SOLVER_TYPEHASH, STATE_COMMITMENTS_SLOT, SUPPORTED_INTENTS_VERSION, type SelectBidResult, type SelectOptions, type SigningAccount, type StateMachineHeight, type StateMachineId, type StateMachineIdParams, type StateMachineResponse, type StateMachineUpdate, type StorageFacade, type SubmitBidOptions, SubstrateChain, Swap, TESTNET_CHAINS, type TeleportParams, TeleportStatus, TimeoutStatus, type TimeoutStatusKey, TokenGateway, type TokenGatewayAssetTeleportedResponse, type TokenGatewayAssetTeleportedWithStatus, type TokenInfo, type TokenPrice, type TokenPricesResponse, type 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, chainConfigs, constructRedeemEscrowRequestBody, constructRefundEscrowRequestBody, convertCodecToIGetRequest, convertCodecToIProof, convertIGetRequestToCodec, convertIProofToCodec, convertStateIdToStateMachineId, convertStateMachineEnumToString, convertStateMachineIdToEnum, createEvmChain, createQueryClient, decodeAcceptedSourceChains, decodeERC7821ExecuteBatch, decodeFillOrder, decodePhantomBidDeclaration, decodePhantomBidPaymasterAndData, decodeUserOpScale, deriveHttpUrl, encodeAcceptedSourceChains, encodeERC7821ExecuteBatch, encodeFillOrder, encodeISMPMessage, encodePhantomBidDeclaration, encodePhantomBidPaymasterAndData, encodeStateMachineId, encodeUserOpScale, encodeWithdrawalRequest, estimateGasForPost, fetchPrice, fetchSourceProof, generateRootWithProof, getChainId, getConfigByStateMachineId, getContractCallInput, getContractCallInputs, getGasPriceFromEtherscan, getOrFetchStorageSlot, getOrderPlacedFromTx, getPostRequestEventFromTx, getPostResponseEventFromTx, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, getStorageSlot, getViemChain, hexToString, hyperbridgeAddress, isCanonicalEvmToken, maxBigInt, normalizeAddressForEvmBytes32, normalizeAddressForStateMachine, normalizeEvmAddress, normalizeEvmChainId, normalizeStateMachineId, orderCommitment, orderbookUrlFor, parseStateMachineId, pharosAtlantic, pharosMainnet, polkadotAssetHubPaseo, polkadotHubMainnet, poolSlug, postRequestCommitment, previewRateFill, queryAssetTeleported, queryGetRequest, queryPostRequest, quoteUniswap, readLegEscrow, readLegPartialFill, requestCommitmentKey, responseCommitmentKey, retryPromise, sortPoolSymbols, supportsRateFills, teleport, teleportDot, transformOrderForContract, tronChainIds, tronNile };

package/dist/browser/index.js

@@ -18837,20 +18837,27 @@ var ROUTE_LIQUIDITY_QUERY = `
 query RouteLiquidity($route: RouteInput!) {
   books { id base quote }
   routeLiquidity(route: $route) {
-    route bestRate depthIn depthOut availableLiquidity maxFillableIn orderCount solverCount
+    route bestRate slippageBps depthIn depthOut availableLiquidity maxFillableIn orderCount solverCount
   }
 }`;
 var QUOTE_QUERY = `
 query Quote($route: RouteInput!, $amountIn: BigInt!) {
   quote(route: $route, amountIn: $amountIn) {
-    route side amountIn amountOut rate fillable depth maxFillableIn
-    fills { orderRate amountOut advertisedSize }
+    route side amountIn slippageBps fillable maxFillableIn
+    fills { advertisedSize orderRate amountIn amountOut }
+  }
+}`;
+var QUOTE_PESSIMISTIC_QUERY = `
+query QuotePessimistic($route: RouteInput!, $amountIn: BigInt!) {
+  quotePessimistic(route: $route, amountIn: $amountIn) {
+    route side amountIn amountOut rate priceBucket slippageBps fillable maxFillableIn
   }
 }`;
 var ORDERBOOK_QUERIES = {
   topOfBook: TOP_OF_BOOK_QUERY,
   routeLiquidity: ROUTE_LIQUIDITY_QUERY,
-  quote: QUOTE_QUERY
+  quote: QUOTE_QUERY,
+  quotePessimistic: QUOTE_PESSIMISTIC_QUERY
 };
 var HyperFxOrderbook = class {
   client;
@@ -18879,8 +18886,9 @@ var HyperFxOrderbook = class {
     return {
       route: raw.route,
       book,
-      side: book.base === route.tokenIn ? "BID" : "ASK",
-      bestRate: raw.bestRate === null ? null : BigInt(raw.bestRate),
+      side: sameSymbol(book.base, route.tokenIn) ? "BID" : "ASK",
+      bestRate: optionalBigInt(raw.bestRate),
+      slippageBps: raw.slippageBps,
       depthIn: BigInt(raw.depthIn),
       depthOut: BigInt(raw.depthOut),
       availableLiquidity: BigInt(raw.availableLiquidity),
@@ -18889,7 +18897,10 @@ var HyperFxOrderbook = class {
       solverCount: raw.solverCount
     };
   }
-  /** 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.
+   */
   async quote(route, amountIn) {
     const { quote: raw } = await this.request(QUOTE_QUERY, {
       route,
@@ -18899,18 +18910,39 @@ var HyperFxOrderbook = class {
       route: raw.route,
       side: raw.side,
       amountIn: BigInt(raw.amountIn),
-      amountOut: BigInt(raw.amountOut),
-      rate: raw.rate === null ? null : BigInt(raw.rate),
+      slippageBps: raw.slippageBps,
       fillable: raw.fillable,
-      depth: BigInt(raw.depth),
       maxFillableIn: BigInt(raw.maxFillableIn),
       fills: raw.fills.map((fill) => ({
+        advertisedSize: BigInt(fill.advertisedSize),
         orderRate: BigInt(fill.orderRate),
-        amountOut: BigInt(fill.amountOut),
-        advertisedSize: BigInt(fill.advertisedSize)
+        amountIn: BigInt(fill.amountIn),
+        amountOut: BigInt(fill.amountOut)
       }))
     };
   }
+  /**
+   * 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.
+   */
+  async quotePessimistic(route, amountIn) {
+    const { quotePessimistic: raw } = await this.request(
+      QUOTE_PESSIMISTIC_QUERY,
+      { route, amountIn: amountIn.toString() }
+    );
+    return {
+      route: raw.route,
+      side: raw.side,
+      amountIn: BigInt(raw.amountIn),
+      amountOut: BigInt(raw.amountOut),
+      rate: optionalBigInt(raw.rate),
+      priceBucket: optionalBigInt(raw.priceBucket),
+      slippageBps: raw.slippageBps,
+      fillable: raw.fillable,
+      maxFillableIn: BigInt(raw.maxFillableIn)
+    };
+  }
   async request(query, variables) {
     try {
       return await this.client.request(query, variables);
@@ -18924,13 +18956,19 @@ function describeError(error) {
   if (graphqlErrors?.length) return graphqlErrors.map((e) => e.message).join("; ");
   return error instanceof Error ? error.message : String(error);
 }
+function sameSymbol(a, b) {
+  return a.toLowerCase() === b.toLowerCase();
+}
 function findBook(books, tokenA, tokenB) {
   const book = books.find(
-    (b) => b.base === tokenA && b.quote === tokenB || b.base === tokenB && b.quote === tokenA
+    (b) => sameSymbol(b.base, tokenA) && sameSymbol(b.quote, tokenB) || sameSymbol(b.base, tokenB) && sameSymbol(b.quote, tokenA)
   );
   if (!book) throw new OrderbookRequestError(`no book trades ${tokenA} for ${tokenB}`);
   return book;
 }
+function optionalBigInt(value) {
+  return value === null ? null : BigInt(value);
+}
 function parseRate(raw) {
   return {
     side: raw.side,
@@ -18995,26 +19033,69 @@ var OrderbookMarket = class {
   configService;
   orderbook;
   async quoteIntent(params, sourceChain, destinationChain) {
+    const orderbook = this.orderbook();
+    if (!params.optimistic) {
+      const { quote: quote2, tokenIn: tokenIn2, tokenOut: tokenOut2 } = await this.priceIntent(
+        params,
+        sourceChain,
+        destinationChain,
+        (route, amountIn) => orderbook.quotePessimistic(route, amountIn),
+        levelQuoteTotals
+      );
+      return {
+        route: quote2.route,
+        side: quote2.side,
+        amountIn: fromOrderbookAmount(quote2.amountIn, tokenIn2.decimals),
+        amountOut: fromOrderbookAmount(quote2.amountOut, tokenOut2.decimals),
+        rate: quote2.rate,
+        priceBucket: quote2.priceBucket,
+        slippageBps: quote2.slippageBps,
+        fillable: quote2.fillable,
+        maxFillableIn: fromOrderbookAmount(quote2.maxFillableIn, tokenIn2.decimals)
+      };
+    }
+    const { quote, tokenIn, tokenOut } = await this.priceIntent(
+      params,
+      sourceChain,
+      destinationChain,
+      (route, amountIn) => orderbook.quote(route, amountIn),
+      swapQuoteTotals
+    );
+    return {
+      route: quote.route,
+      side: quote.side,
+      amountIn: fromOrderbookAmount(quote.amountIn, tokenIn.decimals),
+      slippageBps: quote.slippageBps,
+      fillable: quote.fillable,
+      maxFillableIn: fromOrderbookAmount(quote.maxFillableIn, tokenIn.decimals),
+      legs: quote.fills.map((fill) => ({
+        advertisedSize: fromOrderbookAmount(fill.advertisedSize, tokenOut.decimals),
+        orderRate: fill.orderRate,
+        amountIn: fromOrderbookAmount(fill.amountIn, tokenIn.decimals),
+        amountOut: fromOrderbookAmount(fill.amountOut, tokenOut.decimals)
+      }))
+    };
+  }
+  /**
+   * The fillable quote for an exact input, or for the input found to deliver an
+   * exact output, with the assets it trades.
+   */
+  async priceIntent(params, sourceChain, destinationChain, price, totals) {
     validateQuoteParams(params);
     const tokenIn = this.assetByAddress(sourceChain, params.tokenIn);
     const tokenOut = this.assetByAddress(destinationChain, params.tokenOut);
     const route = toRoute(tokenIn, tokenOut);
     if (params.amountIn !== void 0) {
-      const quote2 = await this.orderbook().quote(route, toOrderbookAmount(params.amountIn, tokenIn.decimals));
-      const amountOut2 = quote2.fillable ? fromOrderbookAmount(quote2.amountOut, tokenOut.decimals) : 0n;
-      if (amountOut2 === 0n) throw this.insufficient(route, quote2.maxFillableIn, tokenIn);
-      return buildQuote("EXACT_INPUT", params.amountIn, amountOut2, quote2, tokenIn, tokenOut);
+      const quote2 = await price(route, toOrderbookAmount(params.amountIn, tokenIn.decimals));
+      const { fillable, amountOut, maxFillableIn } = totals(quote2);
+      if (!fillable || fromOrderbookAmount(amountOut, tokenOut.decimals) === 0n) {
+        throw this.insufficient(route, maxFillableIn, tokenIn);
+      }
+      return { quote: quote2, tokenIn, tokenOut };
     }
-    const amountOut = params.amountOut;
-    const quote = await this.quoteExactOutput(route, toOrderbookAmount(amountOut, tokenOut.decimals), tokenIn);
-    return buildQuote(
-      "EXACT_OUTPUT",
-      fromOrderbookAmount(quote.amountIn, tokenIn.decimals),
-      amountOut,
-      quote,
-      tokenIn,
-      tokenOut
-    );
+    const targetOut = toOrderbookAmount(params.amountOut, tokenOut.decimals);
+    const quote = await this.quoteExactOutput(route, targetOut, tokenIn, price, totals);
+    return { quote, tokenIn, tokenOut };
   }
   async availableLiquidity(params, sourceChain, destinationChain) {
     const tokenIn = this.assetByAddress(sourceChain, params.tokenIn);
@@ -19067,22 +19148,26 @@ var OrderbookMarket = class {
   }
   /**
    * The orderbook only quotes an input amount, so an output is priced by
-   * guessing the input from the best rate and raising it at each clearing
-   * price until the quote delivers `targetOut`.
+   * guessing the input from the best rate, then keeping the part of each quote
+   * filled better than its worst rate and re-pricing the rest of `targetOut` at
+   * the input-to-output ratio that part filled at, until a quote delivers it.
+   * That ratio is the orderbook's own, with the protocol fee already taken off.
    */
-  async quoteExactOutput(route, targetOut, tokenIn) {
-    const orderbook = this.orderbook();
-    const liquidity = await orderbook.routeLiquidity(route);
+  async quoteExactOutput(route, targetOut, tokenIn, price, totals) {
+    const liquidity = await this.orderbook().routeLiquidity(route);
     if (liquidity.bestRate === null) throw this.insufficient(route, 0n, tokenIn);
     const inputUnit = toOrderbookAmount(1n, tokenIn.decimals);
     let amountIn = roundUpTo(requiredInput(liquidity.side, targetOut, liquidity.bestRate), inputUnit);
     let lastAmountIn = amountIn;
     for (let round = 0; round < MAX_EXACT_OUTPUT_ROUNDS; round++) {
       if (amountIn > liquidity.maxFillableIn) throw this.insufficient(route, liquidity.maxFillableIn, tokenIn);
-      const quote = await orderbook.quote(route, amountIn);
-      if (quote.fillable && quote.amountOut >= targetOut) return quote;
+      const served = await price(route, amountIn);
+      const quote = totals(served);
+      if (quote.fillable && quote.amountOut >= targetOut) return served;
       lastAmountIn = amountIn;
-      const next = quote.rate === null ? amountIn : roundUpTo(requiredInput(quote.side, targetOut, quote.rate), inputUnit);
+      const betterIn = quote.amountIn - quote.worstIn;
+      const betterOut = quote.amountOut - quote.worstOut;
+      const next = quote.fillable && quote.worstOut > 0n ? betterIn + roundUpTo(divCeil((targetOut - betterOut) * quote.worstIn, quote.worstOut), inputUnit) : amountIn;
       amountIn = next > amountIn ? next : amountIn + inputUnit;
     }
     throw new OrderbookQuoteNotConvergedError(
@@ -19138,24 +19223,32 @@ function toRoute(tokenIn, tokenOut) {
 function requiredInput(side, amountOut, rate) {
   return side === "BID" ? divCeil(amountOut * ORDERBOOK_SCALE, rate) : divCeil(amountOut * rate, ORDERBOOK_SCALE);
 }
-function buildQuote(tradeType, amountIn, amountOut, quote, tokenIn, tokenOut) {
-  if (quote.rate === null) throw new OrderbookRequestError("the orderbook served a fillable quote with no rate");
-  const [base3, quoteToken] = quote.side === "BID" ? [tokenIn, tokenOut] : [tokenOut, tokenIn];
+function swapQuoteTotals(quote) {
+  const worstFill = quote.fills.at(-1);
+  if (quote.fillable && !worstFill)
+    throw new OrderbookRequestError("the orderbook served a fillable quote with no fills");
   return {
-    tradeType,
-    amountIn,
-    amountOut,
-    quoteMetadata: {
-      sourceChain: tokenIn.chain,
-      destinationChain: tokenOut.chain,
-      route: quote.route,
-      side: quote.side,
-      baseTokenSymbol: base3.symbol,
-      quoteTokenSymbol: quoteToken.symbol,
-      rate: format(quote.rate),
-      maxFillableIn: fromOrderbookAmount(quote.maxFillableIn, tokenIn.decimals),
-      orderCount: quote.fills.length
-    }
+    side: quote.side,
+    amountIn: quote.amountIn,
+    amountOut: quote.fills.reduce((total, fill) => total + fill.amountOut, 0n),
+    fillable: quote.fillable,
+    maxFillableIn: quote.maxFillableIn,
+    worstIn: worstFill?.amountIn ?? 0n,
+    worstOut: worstFill?.amountOut ?? 0n
+  };
+}
+function levelQuoteTotals(quote) {
+  if (quote.fillable && quote.rate === null) {
+    throw new OrderbookRequestError("the orderbook served a fillable quote with no rate");
+  }
+  return {
+    side: quote.side,
+    amountIn: quote.amountIn,
+    amountOut: quote.amountOut,
+    fillable: quote.fillable,
+    maxFillableIn: quote.maxFillableIn,
+    worstIn: quote.amountIn,
+    worstOut: quote.amountOut
   };
 }
 function toOrderbookAmount(amount, decimals) {
@@ -19319,22 +19412,6 @@ var IntentGateway = class _IntentGateway {
     this.orderbook = typeof orderbook === "string" ? new HyperFxOrderbook(orderbook) : orderbook;
     return this;
   }
-  /**
-   * 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.
-   *
-   * 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.
-   *
-   * 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.
-   *
-   * @throws {InsufficientOrderbookLiquidityError} When the route cannot fill the amount.
-   * @throws {OrderbookRequestError} When the orderbook is unreachable or trades no book for the pair.
-   */
   async quoteIntent(params) {
     return this.market.quoteIntent(params, this.source.config.stateMachineId, this.dest.config.stateMachineId);
   }