@hyperbridge/sdk 2.4.0 → 2.4.2

package/dist/browser/index.d.ts

@@ -993,6 +993,16 @@ declare class ChainConfigService {
     };
     getDaiAsset(chain: string): HexString;
     getAssetAddress(chain: string, symbol: ConfiguredAssetSymbol): HexString | undefined;
+    /**
+     * Resolves configured token metadata from an address on a specific chain.
+     * This is used by SDK helpers that accept token addresses rather than caller-
+     * supplied symbols or decimals.
+     */
+    getAssetMetadataByAddress(chain: string, address: HexString): {
+        symbol: ConfiguredAssetSymbol;
+        address: HexString;
+        decimals?: number;
+    } | undefined;
     getUsdtAsset(chain: string): HexString;
     getUsdcAsset(chain: string): HexString;
     getUsdcDecimals(chain: string): number;
@@ -3332,6 +3342,34 @@ interface OrderResponse {
         }>;
     };
 }
+interface PhantomOrderPriceSnapshot {
+    commitment: HexString;
+    tokenA: HexString;
+    tokenB: HexString;
+    standardAmount: bigint;
+    blockNumber: bigint;
+    medianPrice: bigint;
+    lowestPrice?: bigint;
+    highestPrice?: bigint;
+    bidCount: number;
+    snapshotTime: Date;
+}
+interface PhantomOrderPriceSnapshotsResponse {
+    phantomOrderPriceSnapshots: {
+        nodes: Array<{
+            commitment: string;
+            tokenA: string;
+            tokenB: string;
+            standardAmount: string;
+            blockNumber: string;
+            medianPrice: string | null;
+            lowestPrice: string | null;
+            highestPrice: string | null;
+            bidCount: number;
+            snapshotTime: string;
+        }>;
+    };
+}
 interface TokenPrice {
     symbol: string;
     address?: string;
@@ -4630,19 +4668,8 @@ interface IntentGatewayContext {
     swap: Swap;
 }
 
-type IntentQuoteStrategy = "uniswap_v4";
+type IntentQuoteStrategy = "uniswap_v4" | "phantom_snapshot";
 type IntentQuoteTradeType = "EXACT_INPUT" | "EXACT_OUTPUT";
-/**
- * Token metadata required by intent quote strategies.
- */
-interface IntentQuoteToken {
-    /** Token contract address on the user/source side. */
-    address: HexString;
-    /** Token decimals for raw amount formatting by the caller. */
-    decimals: number;
-    /** Optional token symbol used only to match SDK-configured destination pools. */
-    symbol?: string;
-}
 /**
  * Full Uniswap V4 PoolKey. V4 pools cannot be discovered from a token pair alone.
  */
@@ -4659,7 +4686,7 @@ interface UniswapV4IntentQuoteOptions {
         quoterAddress?: HexString;
         /**
          * Destination-side address of the input currency. Defaults to
-         * `tokenIn.address`, which only works for same-chain quotes; pass this
+         * `tokenIn`, which only works for same-chain quotes; pass this
          * explicitly when source and destination chains differ. Must equal
          * `currency0` or `currency1`.
          */
@@ -4670,13 +4697,17 @@ interface UniswapV4IntentQuoteOptions {
  * Parameters for `IntentGateway.quoteIntent`. The source and destination
  * chains come from the gateway instance itself.
  *
- * `strategy` defaults to `uniswap_v4`, which is currently the only supported
- * strategy. Provide exactly one of `amountIn` or `amountOut`.
+ * Quotes default to `phantom_snapshot`. Pass `strategy: "uniswap_v4"` only to
+ * explicitly request a Uniswap quote. `tokenIn` and `tokenOut` are token
+ * addresses; the SDK resolves configured token metadata internally. Provide
+ * exactly one of `amountIn` or `amountOut`.
  */
 interface QuoteIntentParams {
     strategy?: IntentQuoteStrategy;
-    tokenIn: IntentQuoteToken;
-    tokenOut: IntentQuoteToken;
+    /** Token address on the source chain. */
+    tokenIn: HexString;
+    /** Token address on the destination chain. */
+    tokenOut: HexString;
     amountIn?: bigint;
     amountOut?: bigint;
     uniswapV4?: UniswapV4IntentQuoteOptions;
@@ -4693,21 +4724,46 @@ interface UniswapV4IntentQuoteMetadata {
      */
     protocolFeeBps: bigint;
 }
+interface PhantomSnapshotIntentQuoteMetadata {
+    /** Canonical chain whose directional Phantom pair addresses identify the feed. */
+    quoteChain: string;
+    /** Phantom order whose bids produced this snapshot. */
+    commitment: HexString;
+    tokenA: HexString;
+    tokenB: HexString;
+    /** Benchmark input and liquidity-weighted median output, both in raw token units. */
+    standardAmount: bigint;
+    medianPrice: bigint;
+    lowestPrice?: bigint;
+    highestPrice?: bigint;
+    blockNumber: bigint;
+    snapshotTime: Date;
+    bidCount: number;
+    /** Source gateway protocol fee already reflected in the returned quote amounts. */
+    protocolFeeBps: bigint;
+}
 /**
  * Quote data partners need before constructing an IntentGateway V2 order.
  *
  * `amountIn` and `amountOut` already account for the IntentGateway protocol
  * fee that the gateway deducts from order inputs (see `quoteMetadata`). No
- * further fee adjustment is required before placing the order; apply only your
- * own slippage tolerance.
+ * further fee or slippage adjustment is required before placing the order.
  */
-interface QuoteIntentResult {
+interface UniswapV4QuoteIntentResult {
     strategy: "uniswap_v4";
     tradeType: IntentQuoteTradeType;
     amountIn: bigint;
     amountOut: bigint;
     quoteMetadata: UniswapV4IntentQuoteMetadata;
 }
+interface PhantomSnapshotQuoteIntentResult {
+    strategy: "phantom_snapshot";
+    tradeType: IntentQuoteTradeType;
+    amountIn: bigint;
+    amountOut: bigint;
+    quoteMetadata: PhantomSnapshotIntentQuoteMetadata;
+}
+type QuoteIntentResult = UniswapV4QuoteIntentResult | PhantomSnapshotQuoteIntentResult;
 declare class UnsupportedIntentQuoteStrategyError extends Error {
     constructor(strategy: string);
 }
@@ -4715,18 +4771,25 @@ declare class UnsupportedIntentQuotePairError extends Error {
     constructor(params: {
         source: string;
         destination: string;
-        tokenIn: IntentQuoteToken;
-        tokenOut: IntentQuoteToken;
+        tokenIn: HexString;
+        tokenOut: HexString;
+        quoteSource?: string;
     });
 }
+declare class PhantomSnapshotUnavailableError extends Error {
+    constructor(tokenA: HexString, tokenB: HexString);
+}
+declare class InvalidPhantomSnapshotError extends Error {
+    constructor(commitment: HexString, reason: string);
+}
 
 /**
  * High-level facade for the IntentGatewayV2 protocol.
  *
  * `IntentGateway` orchestrates the complete lifecycle of an intent-based
  * cross-chain swap:
- * - **Quoting** — prices the order's input/output amounts via the configured
- *   quote strategies (currently Uniswap V4) before order construction.
+ * - **Quoting** — prices the order's input/output amounts via Phantom order
+ *   snapshots by default, with Uniswap V4 available as an explicit strategy.
  * - **Order placement** — encodes and yields `placeOrder` calldata; caller
  *   signs and submits the transaction.
  * - **Order execution** — polls the Hyperbridge coprocessor for solver bids,
@@ -4807,19 +4870,21 @@ declare class IntentGateway {
     /**
      * Quotes an intent between this gateway's source and destination chains.
      *
-     * `strategy` defaults to `uniswap_v4`, currently the only supported
-     * strategy. Provide exactly one of `amountIn` or `amountOut`.
+     * Uses the latest directional Phantom order price snapshot from the attached
+     * indexer by default. Pass `strategy: "uniswap_v4"` only when explicitly
+     * requesting a Uniswap quote. Provide exactly one of `amountIn` or `amountOut`.
      *
-     * The Uniswap quote strategy always prices against the configured Base
-     * pool, regardless of this gateway's destination chain. Returned
+     * Both built-in strategies resolve their canonical market on Base,
+     * regardless of this gateway's destination chain. Returned
      * `amountIn`/`amountOut` already account for the gateway's protocol fee
      * (`quoteMetadata.protocolFeeBps`), which the gateway deducts from order
-     * inputs; apply only your own slippage tolerance before placing the order.
+     * inputs; use the returned amounts directly when placing the order.
      *
      * @param params - Token pair, amount, and optional strategy/pool overrides.
      * @returns The quoted amounts plus strategy-specific metadata.
      * @throws {UnsupportedIntentQuoteStrategyError} For unknown strategies.
-     * @throws {UnsupportedIntentQuotePairError} When no pool is configured for the pair.
+     * @throws {UnsupportedIntentQuotePairError} When the selected strategy does not support the pair.
+     * @throws {PhantomSnapshotUnavailableError} When an eligible cNGN pair has no snapshot.
      */
     quoteIntent(params: QuoteIntentParams): Promise<QuoteIntentResult>;
     /**
@@ -4827,8 +4892,10 @@ declare class IntentGateway {
      * placement, fee estimation, bid collection, and execution.
      *
      * **Yield/receive protocol:**
-     * 1. If `order.fees` is unset or zero, estimates gas and sets `order.fees`
-     *    with a 1% buffer and the wei cost with a 2% buffer for the `value` field.
+     * 1. If `order.fees` is unset or zero, estimates gas and sets same-chain
+     *    `order.fees` to twice the estimate. Cross-chain orders retain a 1% buffer
+     *    and include an additional 600k-gas fee uplift, while the wei cost used for
+     *    the `value` field receives a 2% buffer.
      * 2. Yields `AWAITING_PLACE_ORDER` with `{ to, data, value, sessionPrivateKey }`.
      *    The caller must sign the transaction and pass it back via `gen.next(signedTx)`.
      * 3. Yields `ORDER_PLACED` with the finalised order and transaction hash once
@@ -10322,4 +10389,4 @@ declare function teleport(teleport_param: {
     extrinsics?: Array<SubmittableExtrinsic<"promise", ISubmittableResult>>;
 }): Promise<ReadableStream<HyperbridgeTxEvents>>;
 
-export { ADDRESS_ZERO, type AllStatusKey, type AssetTeleported, type AssetTeleportedResponse, type Bid, type BidStorageEntry, type BidSubmissionResult, type BlockMetadata, type BridgeParams, type BridgeStep, type BundlerGasEstimate, BundlerMethod, type BytesLikeHex, type CancelEvent, type CancelOptions, type CancelOrderOptions, type CancelQuote, type ChainConfig, type ChainConfigData, ChainConfigService, Chains, type ClientConfig, type ConfiguredAssetSymbol, CryptoUtils, DEFAULT_ADDRESS, DEFAULT_GRAFFITI, DOMAIN_TYPEHASH, DUMMY_PRIVATE_KEY, type DecodedOrderPlacedLog, type DecodedPostRequestEvent, type DecodedPostResponseEvent, type Deployment, type DispatchGet, type DispatchInfo, type DispatchPost, ERC20Method, type ERC7821Call, ERC7821_BATCH_MODE, type EstimateFillOrderParams, type EstimateGasCallData, EvmChain, type EvmChainParams, ABI as EvmHostABI, EvmLanguage, type ExecuteIntentOrderOptions, type ExecutionResult, type FillOptions, type FillOrderEstimate, type FillerBid, type FillerConfig, type GetRequestResponse, type GetRequestWithStatus, type GetResponseByRequestIdResponse, type GetResponseStorageValues, type HexString, type HostParams, HyperClientStatus, HyperFungibleToken, HyperFungibleTokenABI, 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, type IPharosConfig, type IPolkadotHubConfig, type IPostRequest, type IPostResponse, type IProof, type IRequestMessage, type ISubstrateConfig, type ITimeoutPostRequestMessage, type IndexerQueryClient, IntentGateway, ABI$1 as IntentGatewayABI, type IntentGatewayContext, type IntentGatewayParams, IntentOrderStatus, type IntentOrderStatusKey, type IntentOrderStatusUpdate, type IntentQuoteStrategy, type IntentQuoteToken, type IntentQuoteTradeType, IntentsCoprocessor, IsmpClient, type IsmpRequest, MOCK_ADDRESS, ORDER_V2_PARAM_TYPE, type Order, type OrderResponse, OrderStatus, OrderStatusChecker, type OrderStatusMetadata, type OrderWithStatus, PACKED_USEROP_TYPEHASH, PLACE_ORDER_SELECTOR, type PackedUserOperation, type Params, type PaymentInfo, type PhantomOrderEvent, PharosChain, type PharosChainParams, PolkadotHubChain, type PolkadotHubChainParams, type PostRequestStatus, type PostRequestTimeoutStatus, type PostRequestWithStatus, 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 RequestBody, type RequestCommitment, RequestKind, type RequestResponse, RequestStatus, type RequestStatusKey, type RequestStatusWithMetadata, type ResponseCommitmentWithValues, type ResumeIntentOrderOptions, type RetryConfig, SELECT_SOLVER_TYPEHASH, STATE_COMMITMENTS_SLOT, 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, type UniswapV4IntentQuoteMetadata, type UniswapV4IntentQuoteOptions, type UniswapV4PoolConfigData, type UniswapV4PoolKey, UnsupportedIntentQuotePairError, UnsupportedIntentQuoteStrategyError, WrappedHyperFungibleTokenABI, type XcmGatewayParams, __test, adjustDecimals, bytes20ToBytes32, bytes32ToBytes20, calculateAllowanceMappingLocation, calculateBalanceMappingLocation, chainConfigs, constructRedeemEscrowRequestBody, constructRefundEscrowRequestBody, convertCodecToIGetRequest, convertCodecToIProof, convertIGetRequestToCodec, convertIProofToCodec, convertStateIdToStateMachineId, convertStateMachineEnumToString, convertStateMachineIdToEnum, createEvmChain, createQueryClient, decodeERC7821ExecuteBatch, decodeUserOpScale, encodeERC7821ExecuteBatch, encodeISMPMessage, encodeStateMachineId, encodeUserOpScale, encodeWithdrawalRequest, estimateGasForPost, fetchPrice, fetchSourceProof, generateRootWithProof, getChainId, getConfigByStateMachineId, getContractCallInput, getContractCallInputs, getGasPriceFromEtherscan, getOrFetchStorageSlot, getOrderPlacedFromTx, getPostRequestEventFromTx, getPostResponseEventFromTx, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, getStorageSlot, getViemChain, hexToString, hyperbridgeAddress, maxBigInt, normalizeAddressForEvmBytes32, normalizeAddressForStateMachine, normalizeEvmChainId, normalizeStateMachineId, orderCommitment, parseStateMachineId, pharosAtlantic, pharosMainnet, polkadotAssetHubPaseo, polkadotHubMainnet, postRequestCommitment, queryAssetTeleported, queryGetRequest, queryPostRequest, quoteUniswap, requestCommitmentKey, responseCommitmentKey, retryPromise, teleport, teleportDot, transformOrderForContract, tronChainIds, tronNile };
+export { ADDRESS_ZERO, type AllStatusKey, type AssetTeleported, type AssetTeleportedResponse, type Bid, type BidStorageEntry, type BidSubmissionResult, type BlockMetadata, type BridgeParams, type BridgeStep, type BundlerGasEstimate, BundlerMethod, type BytesLikeHex, type CancelEvent, type CancelOptions, type CancelOrderOptions, type CancelQuote, type ChainConfig, type ChainConfigData, ChainConfigService, Chains, type ClientConfig, type ConfiguredAssetSymbol, CryptoUtils, DEFAULT_ADDRESS, DEFAULT_GRAFFITI, DOMAIN_TYPEHASH, DUMMY_PRIVATE_KEY, type DecodedOrderPlacedLog, type DecodedPostRequestEvent, type DecodedPostResponseEvent, type Deployment, type DispatchGet, type DispatchInfo, type DispatchPost, ERC20Method, type ERC7821Call, ERC7821_BATCH_MODE, type EstimateFillOrderParams, type EstimateGasCallData, EvmChain, type EvmChainParams, ABI as EvmHostABI, EvmLanguage, type ExecuteIntentOrderOptions, type ExecutionResult, type FillOptions, type FillOrderEstimate, type FillerBid, type FillerConfig, type GetRequestResponse, type GetRequestWithStatus, type GetResponseByRequestIdResponse, type GetResponseStorageValues, type HexString, type HostParams, HyperClientStatus, HyperFungibleToken, HyperFungibleTokenABI, 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, type IPharosConfig, type IPolkadotHubConfig, type IPostRequest, type IPostResponse, type IProof, type IRequestMessage, type ISubstrateConfig, type ITimeoutPostRequestMessage, type IndexerQueryClient, IntentGateway, ABI$1 as IntentGatewayABI, type IntentGatewayContext, type IntentGatewayParams, IntentOrderStatus, type IntentOrderStatusKey, type IntentOrderStatusUpdate, type IntentQuoteStrategy, type IntentQuoteTradeType, IntentsCoprocessor, InvalidPhantomSnapshotError, IsmpClient, type IsmpRequest, MOCK_ADDRESS, ORDER_V2_PARAM_TYPE, type Order, type OrderResponse, OrderStatus, OrderStatusChecker, type OrderStatusMetadata, type OrderWithStatus, PACKED_USEROP_TYPEHASH, PLACE_ORDER_SELECTOR, type PackedUserOperation, type Params, type PaymentInfo, type PhantomOrderEvent, type PhantomOrderPriceSnapshot, type PhantomOrderPriceSnapshotsResponse, type PhantomSnapshotIntentQuoteMetadata, type PhantomSnapshotQuoteIntentResult, PhantomSnapshotUnavailableError, PharosChain, type PharosChainParams, PolkadotHubChain, type PolkadotHubChainParams, type PostRequestStatus, type PostRequestTimeoutStatus, type PostRequestWithStatus, 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 RequestBody, type RequestCommitment, RequestKind, type RequestResponse, RequestStatus, type RequestStatusKey, type RequestStatusWithMetadata, type ResponseCommitmentWithValues, type ResumeIntentOrderOptions, type RetryConfig, SELECT_SOLVER_TYPEHASH, STATE_COMMITMENTS_SLOT, 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, type UniswapV4IntentQuoteMetadata, type UniswapV4IntentQuoteOptions, type UniswapV4PoolConfigData, type UniswapV4PoolKey, type UniswapV4QuoteIntentResult, UnsupportedIntentQuotePairError, UnsupportedIntentQuoteStrategyError, WrappedHyperFungibleTokenABI, type XcmGatewayParams, __test, adjustDecimals, bytes20ToBytes32, bytes32ToBytes20, calculateAllowanceMappingLocation, calculateBalanceMappingLocation, chainConfigs, constructRedeemEscrowRequestBody, constructRefundEscrowRequestBody, convertCodecToIGetRequest, convertCodecToIProof, convertIGetRequestToCodec, convertIProofToCodec, convertStateIdToStateMachineId, convertStateMachineEnumToString, convertStateMachineIdToEnum, createEvmChain, createQueryClient, decodeERC7821ExecuteBatch, decodeUserOpScale, encodeERC7821ExecuteBatch, encodeISMPMessage, encodeStateMachineId, encodeUserOpScale, encodeWithdrawalRequest, estimateGasForPost, fetchPrice, fetchSourceProof, generateRootWithProof, getChainId, getConfigByStateMachineId, getContractCallInput, getContractCallInputs, getGasPriceFromEtherscan, getOrFetchStorageSlot, getOrderPlacedFromTx, getPostRequestEventFromTx, getPostResponseEventFromTx, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, getStorageSlot, getViemChain, hexToString, hyperbridgeAddress, maxBigInt, normalizeAddressForEvmBytes32, normalizeAddressForStateMachine, normalizeEvmChainId, normalizeStateMachineId, orderCommitment, parseStateMachineId, pharosAtlantic, pharosMainnet, polkadotAssetHubPaseo, polkadotHubMainnet, postRequestCommitment, queryAssetTeleported, queryGetRequest, queryPostRequest, quoteUniswap, requestCommitmentKey, responseCommitmentKey, retryPromise, teleport, teleportDot, transformOrderForContract, tronChainIds, tronNile };