@hyperbridge/sdk 2.6.0 → 2.7.2

package/dist/browser/index.d.ts

@@ -898,6 +898,14 @@ interface UniswapV4PoolConfigData {
     tickSpacing: number;
     hooks?: `0x${string}`;
 }
+/** A known ERC-4626 vault fillers can use as a stablecoin treasury. */
+interface Erc4626VaultConfigData {
+    /** Display label, e.g. "Aave stataUSDC" */
+    label: string;
+    address: `0x${string}`;
+    /** Underlying asset symbol; the on-chain vault resolves the address. */
+    asset: ConfiguredAssetSymbol;
+}
 interface ChainConfigData {
     chainId: number;
     stateMachineId: Chains;
@@ -914,6 +922,7 @@ interface ChainConfigData {
         EURC?: string;
         XSGD?: string;
         TRYB?: string;
+        USDR?: string;
     };
     tokenDecimals?: {
         USDC: number;
@@ -976,6 +985,8 @@ interface ChainConfigData {
     coingeckoId: string;
     popularTokens?: string[];
     uniswapV4Pools?: UniswapV4PoolConfigData[];
+    /** Known ERC-4626 treasury vaults on this chain */
+    erc4626Vaults?: Erc4626VaultConfigData[];
     /** LayerZero Endpoint ID for cross-chain messaging */
     layerZeroEid?: number;
 }
@@ -1024,6 +1035,14 @@ declare class ChainConfigService {
     getCNgnDecimals(chain: string): number | undefined;
     getExtAsset(chain: string): HexString | undefined;
     getExtDecimals(chain: string): number | undefined;
+    /** Configured exotic (non-USD) tokens on a chain, for selection UIs. EXT is a test asset and is not offered. */
+    getKnownExoticTokens(chain: string): Array<{
+        symbol: string;
+        address: HexString;
+        decimals?: number;
+    }>;
+    /** Known ERC-4626 treasury vaults on a chain, for selection UIs. */
+    getKnownVaults(chain: string): Erc4626VaultConfigData[];
     getChainId(chain: string): number;
     getConsensusStateId(chain: string): string;
     getHyperbridgeChainId(): number;
@@ -1736,7 +1755,10 @@ declare class SubstrateChain implements IChain {
      */
     latestStateMachineHeight(stateMachineId: StateMachineIdParams): Promise<bigint>;
     /**
-     * Get the state machine update time for a given state machine height.
+     * Get the state machine update time for a given state machine height. Reads the
+     * `BoundedStateMachineUpdateTime` map in pallet-ismp directly, so the height is either
+     * still retained on-chain or it has been evicted — there's no intermediate RPC to
+     * reinterpret the absence.
      * @param {StateMachineHeight} stateMachineHeight - The state machine height.
      * @returns {Promise<bigint>} The statemachine update time in seconds.
      */
@@ -3607,6 +3629,33 @@ interface FillOrderEstimate {
      */
     relayerFeeInSourceFeeToken: bigint;
 }
+/**
+ * Solver-fee quote for an order, priced with the same policy `execute()` /
+ * `executeBest()` apply when `order.fees` is `0n`.
+ */
+interface OrderFeesQuote {
+    /**
+     * The amount to set as `Order.fees`, denominated in the source-chain fee
+     * token. Same-chain fills carry a 2x margin over the estimated fill gas without
+     * a gas-price bump. Cross-chain gas is priced with 10% SDK-only headroom before
+     * adding the settlement relayer fee and a further 5% buffer over the whole sum.
+     */
+    fees: bigint;
+    /**
+     * The native value attached to the placement transaction when the fee is
+     * paid in the native token: the estimated fill gas cost in source-chain
+     * wei plus a 2% buffer. The gateway swaps it for the fee token and refunds
+     * any unused amount.
+     */
+    nativeValue: bigint;
+    /**
+     * The source-chain fee token `fees` is denominated in — check the user's
+     * balance and allowance against this address when paying the fee directly.
+     */
+    feeToken: HexString;
+    /** The underlying gas estimate the quote was derived from. */
+    estimate: FillOrderEstimate;
+}
 /**
  * Result of submitting a bid to Hyperbridge
  */
@@ -3730,8 +3779,24 @@ type IntentOrderStatusUpdate = {
     status: "AWAITING_PLACE_ORDER";
     to: HexString;
     data: HexString;
-    value?: bigint;
+    /**
+     * The order's native-token input amounts. Native inputs cannot be
+     * pulled via allowance, so this must be part of the placement
+     * transaction's `msg.value`. Does not include the solver fee.
+     */
+    value: bigint;
+    /**
+     * The native amount that funds `order.fees`: what the gateway swaps
+     * into the fee token at placement. Add it to `value` when paying the
+     * fee in native token. `0n` when `order.fees` was set by the caller
+     * (fee-token rail).
+     */
+    nativeFee: bigint;
     sessionPrivateKey: HexString;
+    /** Exact source-chain fee-token amount encoded in `data`. */
+    feeTokenAmount: bigint;
+    /** Source-chain ERC-20 token charged for `feeTokenAmount`. */
+    feeTokenAddress: HexString;
 } | {
     status: "ORDER_PLACED";
     order: Order;
@@ -4985,14 +5050,22 @@ declare class IntentGateway {
      * placement, fee estimation, bid collection, and execution.
      *
      * **Yield/receive protocol:**
-     * 1. If `order.fees` is unset or zero, estimates gas on an internal copy and
-     *    sets same-chain fees to twice the estimate. Cross-chain orders attach
-     *    (fill gas + a settlement-message uplift of `RELAYER_MESSAGE_GAS`, the
-     *    same gas budget the solver's relayer fee uses) with a 5% buffer over
-     *    the whole sum — strictly above the solver's unpadded requirement. 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)`.
+     * 1. If `order.fees` is unset or zero, prices the fee on an internal copy
+     *    via {@link quoteOrderFees}: same-chain fees are twice the fill-gas
+     *    estimate without a gas-price bump; cross-chain gas is priced 10% above
+     *    the live price before attaching (fill gas + the settlement relayer fee)
+     *    with a further 5% buffer over the whole sum — strictly above the solver's
+     *    unpadded requirement. Direct solver estimates remain unbumped. The wei
+     *    cost used for the `value` field receives a 2% buffer.
+     * 2. Yields `AWAITING_PLACE_ORDER` with `{ to, data, value, nativeFee,
+     *    feeTokenAmount, feeTokenAddress, sessionPrivateKey }`. `value` carries
+     *    only the order's native-token input amounts; `nativeFee` is the native
+     *    amount that funds `order.fees` (`0n` when the caller set `order.fees`);
+     *    `feeTokenAmount`/`feeTokenAddress` are the exact fee encoded in `data`
+     *    and the source-chain token it is charged in. To pay the fee in native
+     *    token, sign the transaction with `value + nativeFee`; with a fee-token
+     *    allowance, `value` alone. Pass the signed transaction back via
+     *    `gen.next(signedTx)`.
      * 3. Yields `ORDER_PLACED` with the finalised order and transaction hash once
      *    the `OrderPlaced` event is confirmed.
      * 4. Delegates to {@link OrderExecutor.executeOrder} and forwards all
@@ -5205,6 +5278,30 @@ declare class IntentGateway {
      * @returns A {@link FillOrderEstimate} with all gas components.
      */
     estimateFillOrder(params: EstimateFillOrderParams): Promise<FillOrderEstimate>;
+    /**
+     * Quotes the solver fee for an order using the same policy {@link execute} /
+     * {@link executeBest} apply when `order.fees` is `0n`.
+     *
+     * Use this before placing to display the fee, or to check what the user can
+     * afford: pay `fees` in the source-chain fee token (check balance and
+     * allowance, then set `order.fees` and submit with `value: 0`), or leave
+     * `order.fees` at `0n` and let the SDK attach `nativeValue` to the placement
+     * transaction (check the native balance).
+     *
+     * @param order - The order to quote. `order.fees` is ignored and not mutated.
+     * Gas prices used to derive cross-chain `fees` receive 10% SDK-only headroom.
+     * Same-chain quotes and direct calls to {@link estimateFillOrder}, including
+     * Simplex solver estimates, remain unbumped.
+     *
+     * @param options - Optional transaction gas-price bump percentages, as in {@link execute}.
+     * @returns An {@link OrderFeesQuote} with the fee-token amount, the native
+     *   value for the native rail, and the underlying estimate.
+     * @throws If gas estimation returns zero.
+     */
+    quoteOrderFees(order: Order, options?: {
+        maxPriorityFeePerGasBumpPercent?: number;
+        maxFeePerGasBumpPercent?: number;
+    }): Promise<OrderFeesQuote>;
     /**
      * Encodes a list of calls into ERC-7821 `execute` calldata using
      * single-batch mode.
@@ -10484,4 +10581,4 @@ declare function teleport(teleport_param: {
     extrinsics?: Array<SubmittableExtrinsic<"promise", ISubmittableResult>>;
 }): Promise<ReadableStream<HyperbridgeTxEvents>>;
 
-export { ADDRESS_ZERO, type AllStatusKey, type AssetTeleported, type AssetTeleportedResponse, type AvailableLiquidityByChain, type AvailableLiquiditySnapshot, 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 PollPhantomOrdersOptions, 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, normalizeEvmAddress, 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 AvailableLiquidityByChain, type AvailableLiquiditySnapshot, 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 Erc4626VaultConfigData, 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 OrderFeesQuote, 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 PollPhantomOrdersOptions, 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, normalizeEvmAddress, normalizeEvmChainId, normalizeStateMachineId, orderCommitment, parseStateMachineId, pharosAtlantic, pharosMainnet, polkadotAssetHubPaseo, polkadotHubMainnet, postRequestCommitment, queryAssetTeleported, queryGetRequest, queryPostRequest, quoteUniswap, requestCommitmentKey, responseCommitmentKey, retryPromise, teleport, teleportDot, transformOrderForContract, tronChainIds, tronNile };