@hyperbridge/sdk 1.3.4 → 1.3.6

package/dist/node/index.d.ts

@@ -941,6 +941,7 @@ interface GetRequestWithStatus extends GenericRequestWithStatuses {
     height: bigint;
     keys: HexString[];
     context: HexString;
+    commitment: HexString;
 }
 interface GetResponseByRequestIdResponse {
     getResponses: {
@@ -2023,7 +2024,7 @@ declare function encodeISMPMessage(message: IIsmpMessage): Uint8Array;
 /**
  * Type representing an ISMP message.
  */
-type IIsmpMessage = IRequestMessage | ITimeoutPostRequestMessage | IGetResponseMessage;
+type IIsmpMessage = IRequestMessage | ITimeoutPostRequestMessage | IGetResponseMessage | IGetRequestMessage;
 interface IRequestMessage {
     /**
      * The kind of message.
@@ -2052,9 +2053,13 @@ interface IGetRequestMessage {
      */
     requests: IGetRequest[];
     /**
-     * The proof of the requests.
+     * The proof of the requests from the source chain.
      */
-    proof: IProof;
+    source: IProof;
+    /**
+     * The proof of the response from the target chain
+     */
+    response: IProof;
     /**
      * The signer of the message.
      */
@@ -2262,14 +2267,14 @@ declare class IndexerClient {
      * @param commitment_hash - Can be commitment
      * @returns Latest status and block metadata of the request
      */
-    queryPostRequest(commitment_hash: string): Promise<PostRequestWithStatus | undefined>;
+    queryPostRequest(commitment_hash: HexString): Promise<PostRequestWithStatus | undefined>;
     /**
      * Queries a request by any of its associated hashes and returns it alongside its statuses
      * Statuses will be one of SOURCE, HYPERBRIDGE_DELIVERED and DESTINATION
      * @param hash - Can be commitment, hyperbridge tx hash, source tx hash, destination tx hash, or timeout tx hash
      * @returns Latest status and block metadata of the request
      */
-    queryGetRequest(hash: string): Promise<GetRequestWithStatus | undefined>;
+    queryGetRequest(hash: HexString): Promise<GetRequestWithStatus | undefined>;
     /**
      * Queries the response associated with a specific request ID and returns its commitment
      * @param requestId - The ID of the request to find the associated response for
@@ -2316,7 +2321,31 @@ declare class IndexerClient {
      * @returns Full request data with all inferred status events, including SOURCE_FINALIZED and HYPERBRIDGE_FINALIZED
      * @remarks Unlike queryRequest(), this method adds derived finalization status events by querying state machine updates
      */
-    queryRequestWithStatus(hash: string): Promise<PostRequestWithStatus | undefined>;
+    queryRequestWithStatus(hash: HexString): Promise<PostRequestWithStatus | undefined>;
+    /**
+     * Queries a GET request and returns it alongside its statuses,
+     * including any finalization events.
+     * @param hash - Can be commitment, hyperbridge tx hash, source tx hash, destination tx hash, or timeout tx hash
+     * @returns Full GET request data with all inferred status events, including SOURCE_FINALIZED and HYPERBRIDGE_FINALIZED
+     * @remarks Unlike queryGetRequest(), this method adds derived finalization status events by querying state machine updates
+     */
+    queryGetRequestWithStatus(hash: HexString): Promise<GetRequestWithStatus | undefined>;
+    /**
+     * Enhances a GET request with finality events by querying state machine updates.
+     *
+     * This method augments a GET request object with additional inferred status events
+     * that represent chain finality confirmations. It adds:
+     * - SOURCE_FINALIZED: When the source chain has finalized the request
+     * - HYPERBRIDGE_FINALIZED: When Hyperbridge has finalized the delivery confirmation and response is ready
+     *
+     * The method also generates appropriate calldata for submitting cross-chain proofs
+     * when applicable.
+     *
+     * @param request - The GET request to enhance with finality events
+     * @returns The request with finality events added
+     * @private
+     */
+    private addGetRequestFinalityEvents;
     /**
      * Create a Stream of status updates for a post request.
      * Stream ends when either the request reaches the destination or times out.
@@ -2568,8 +2597,7 @@ declare class IntentGateway {
      * Uses USD pricing to convert between fee token amounts and native token costs.
      *
      * @param feeTokenAmount - The amount in fee token (DAI)
-     * @param publicClient - The client for the chain to get native token info
-     * @param feeTokenDecimals - The decimal places of the fee token
+     * @param getQuoteIn - Whether to use "source" or "dest" chain for the conversion
      * @returns The fee token amount converted to native token amount
      * @private
      */
@@ -2579,24 +2607,30 @@ declare class IntentGateway {
      * Uses USD pricing to convert between native token gas costs and fee token amounts.
      *
      * @param gasEstimate - The estimated gas units
-     * @param publicClient - The client for the chain to get gas prices
-     * @param targetDecimals - The decimal places of the target fee token
+     * @param gasEstimateIn - Whether to use "source" or "dest" chain for the conversion
      * @returns The gas cost converted to fee token amount
      * @private
      */
     private convertGasToFeeToken;
+    /**
+     * Gets a quote for the native token cost of dispatching a post request.
+     *
+     * @param postRequest - The post request to quote
+     * @param fee - The fee amount in fee token
+     * @returns The native token amount required
+     */
     quoteNative(postRequest: IPostRequest, fee: bigint): Promise<bigint>;
     /**
      * Finds the best Uniswap protocol (V2, V3, or V4) for swapping tokens given a desired output amount.
      * Compares liquidity and pricing across different protocols and fee tiers.
      *
-     * @param chain - The chain identifier where the swap will occur
+     * @param getQuoteIn - Whether to use "source" or "dest" chain for the swap
      * @param tokenIn - The address of the input token
      * @param tokenOut - The address of the output token
      * @param amountOut - The desired output amount
      * @returns Object containing the best protocol, required input amount, and fee tier (for V3/V4)
      */
-    findBestProtocolWithAmountOut(chain: string, tokenIn: HexString, tokenOut: HexString, amountOut: bigint): Promise<{
+    findBestProtocolWithAmountOut(getQuoteIn: "source" | "dest", tokenIn: HexString, tokenOut: HexString, amountOut: bigint): Promise<{
         protocol: "v2" | "v3" | "v4" | null;
         amountIn: bigint;
         fee?: number;
@@ -2605,13 +2639,14 @@ declare class IntentGateway {
      * Finds the best Uniswap protocol (V2, V3, or V4) for swapping tokens given an input amount.
      * Compares liquidity and pricing across different protocols and fee tiers.
      *
-     * @param chain - The chain identifier where the swap will occur
+     * @param getQuoteIn - Whether to use "source" or "dest" chain for the swap
      * @param tokenIn - The address of the input token
      * @param tokenOut - The address of the output token
      * @param amountIn - The input amount to swap
+     * @param selectedProtocol - Optional specific protocol to use ("v2", "v3", or "v4")
      * @returns Object containing the best protocol, expected output amount, and fee tier (for V3/V4)
      */
-    findBestProtocolWithAmountIn(chain: string, tokenIn: HexString, tokenOut: HexString, amountIn: bigint): Promise<{
+    findBestProtocolWithAmountIn(getQuoteIn: "source" | "dest", tokenIn: HexString, tokenOut: HexString, amountIn: bigint, selectedProtocol?: "v2" | "v3" | "v4"): Promise<{
         protocol: "v2" | "v3" | "v4" | null;
         amountOut: bigint;
         fee?: number;