@hyperbridge/sdk 1.3.5 → 1.3.6

package/dist/browser/index.d.ts

@@ -2024,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.
@@ -2053,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.
      */
@@ -2593,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
      */
@@ -2604,18 +2607,24 @@ 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
@@ -2630,10 +2639,11 @@ 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(getQuoteIn: "source" | "dest", tokenIn: HexString, tokenOut: HexString, amountIn: bigint, selectedProtocol?: "v2" | "v3" | "v4"): Promise<{

package/dist/browser/index.js

@@ -1,6 +1,6 @@
 import { createConsola, LogLevels } from 'consola';
 import { flatten, zip, capitalize, maxBy, isNil } from 'lodash-es';
-import { toHex, hexToBytes, encodePacked, keccak256, encodeAbiParameters, bytesToHex, concatHex, createPublicClient, http, encodeFunctionData, erc20Abi, bytesToBigInt, pad, toBytes, maxUint256, parseUnits } from 'viem';
+import { toHex, hexToBytes, encodePacked, keccak256, encodeAbiParameters, bytesToHex, concatHex, createPublicClient, http, encodeFunctionData, erc20Abi, bytesToBigInt, pad, toBytes, maxUint256, formatUnits, parseUnits } from 'viem';
 import mergeRace from '@async-generator/merge-race';
 import { gnosisChiado, gnosis, bscTestnet, bsc, soneium, baseSepolia, base, optimismSepolia, optimism, arbitrumSepolia, arbitrum, mainnet, sepolia } from 'viem/chains';
 import { hasWindow, isNode, env } from 'std-env';
@@ -10,6 +10,7 @@ import { WsProvider, ApiPromise } from '@polkadot/api';
 import { RpcWebSocketClient } from 'rpc-websocket-client';
 import { keccakAsU8a, decodeAddress, xxhashAsU8a } from '@polkadot/util-crypto';
 import { GraphQLClient } from 'graphql-request';
+import { Decimal } from 'decimal.js';
 import { u8aToHex } from '@polkadot/util';
 
 var __defProp = Object.defineProperty;
@@ -3982,6 +3983,10 @@ var GetRequest = Struct({
    * Substrate Keys
    */
   keys: Vector(Vector(u8)),
+  /*
+   * The height of the state machine
+   */
+  height: u64,
   /*
    * Some application-specific metadata relating to this request
    */
@@ -4108,6 +4113,24 @@ var TimeoutMessage = Enum({
     requests: Vector(Request2)
   })
 });
+var GetRequestsWithProof = Struct({
+  /*
+   * Requests to be fetched
+   */
+  requests: Vector(GetRequest),
+  /*
+   * Membership batch proof for these requests
+   */
+  source: Proof,
+  /*
+   * Storage proof for these responses
+   */
+  response: Proof,
+  /*
+   * Signer information. Ideally should be their account identifier
+   */
+  signer: Vector(u8)
+});
 var Message = Enum({
   /*
    * A consensus update message
@@ -4856,6 +4879,8 @@ var EvmChain = class {
         ]
       });
       return encoded2;
+    }).with({ kind: "GetRequest" }, (message2) => {
+      throw new Error("GetResponse is not yet supported on Substrate chains");
     }).exhaustive();
     return encoded;
   }
@@ -5171,8 +5196,13 @@ var SubstrateChain = class {
   async submitUnsigned(message) {
     if (!this.api) throw new Error("API not initialized");
     const { api } = this;
-    const args = hexToBytes(this.encode(message)).slice(2);
-    const tx = api.tx.ismp.handleUnsigned(args);
+    const args = encodeISMPMessage(message);
+    let tx;
+    if (message.kind === "GetRequest") {
+      tx = api.tx.stateCoprocessor.handleUnsigned(args);
+    } else {
+      tx = api.tx.ismp.handleUnsigned(args);
+    }
     return new Promise((resolve, reject) => {
       let unsub = () => {
       };
@@ -5315,6 +5345,18 @@ function convertIPostRequestToCodec(request) {
     }
   };
 }
+function convertIGetRequestToCodec(request) {
+  return {
+    source: convertStateMachineIdToEnum(request.source),
+    dest: convertStateMachineIdToEnum(request.dest),
+    from: Array.from(hexToBytes(request.from)),
+    nonce: request.nonce,
+    keys: request.keys.map((key) => Array.from(hexToBytes(key))),
+    context: Array.from(hexToBytes(request.context)),
+    timeoutTimestamp: request.timeoutTimestamp,
+    height: request.height
+  };
+}
 function encodeISMPMessage(message) {
   try {
     return match(message).with({ kind: "PostRequest" }, (message2) => {
@@ -5341,6 +5383,31 @@ function encodeISMPMessage(message) {
       ]);
     }).with({ kind: "GetResponse" }, (message2) => {
       throw new Error("GetResponse is not yet supported on Substrate chains");
+    }).with({ kind: "GetRequest" }, (message2) => {
+      return GetRequestsWithProof.enc({
+        requests: message2.requests.map((request) => convertIGetRequestToCodec(request)),
+        source: {
+          height: {
+            height: message2.source.height,
+            id: {
+              consensusStateId: Array.from(toBytes(message2.source.consensusStateId)),
+              id: convertStateMachineIdToEnum(message2.source.stateMachine)
+            }
+          },
+          proof: Array.from(hexToBytes(message2.source.proof))
+        },
+        response: {
+          height: {
+            height: message2.response.height,
+            id: {
+              consensusStateId: Array.from(toBytes(message2.response.consensusStateId)),
+              id: convertStateMachineIdToEnum(message2.response.stateMachine)
+            }
+          },
+          proof: Array.from(hexToBytes(message2.response.proof))
+        },
+        signer: Array.from(hexToBytes(message2.signer))
+      });
     }).with({ kind: "TimeoutPostRequest" }, (message2) => {
       return Vector(Message).enc([
         {
@@ -11537,8 +11604,6 @@ var UNISWAP_V4_QUOTER_ABI = [
     inputs: [{ name: "revertData", type: "bytes", internalType: "bytes" }]
   }
 ];
-
-// src/protocols/intents.ts
 var IntentGateway = class {
   /**
    * Creates a new IntentGateway instance for cross-chain operations.
@@ -11624,6 +11689,7 @@ var IntentGateway = class {
       }))
     ];
     let destChainFillGas = 0n;
+    let filledWithNativeToken = false;
     try {
       let protocolFeeInNativeToken = await this.quoteNative(postRequest, relayerFeeInDestFeeToken);
       protocolFeeInNativeToken = protocolFeeInNativeToken + protocolFeeInNativeToken * 50n / 10000n;
@@ -11636,6 +11702,7 @@ var IntentGateway = class {
         value: totalEthValue + protocolFeeInNativeToken,
         stateOverride: stateOverrides
       });
+      filledWithNativeToken = true;
     } catch {
       console.warn(
         `Could not estimate gas for fill order with native token as fees for chain ${order.destChain}, now trying with fee token as fees`
@@ -11677,18 +11744,18 @@ var IntentGateway = class {
       sourceChainFeeTokenDecimals
     );
     const protocolFeeInSourceFeeToken = adjustFeeDecimals(
-      // Following baseIsmpModule.sol, the protocol fee is added to the relayer fee
-      await this.dest.quote(postRequest) + relayerFeeInDestFeeToken,
+      await this.dest.quote(postRequest),
       destChainFeeTokenDecimals,
       sourceChainFeeTokenDecimals
     );
-    const totalEstimate = fillGasInSourceFeeToken + protocolFeeInSourceFeeToken + relayerFeeInSourceFeeToken;
-    const SWAP_OPERATIONS_BPS = 3500n;
-    const swapOperationsInFeeToken = totalEstimate * SWAP_OPERATIONS_BPS / 10000n;
-    const totalFeeTokenAmount = totalEstimate + swapOperationsInFeeToken;
-    const totalNativeTokenAmount = await this.convertFeeTokenToNative(totalFeeTokenAmount, "source");
+    let totalEstimateInSourceFeeToken = fillGasInSourceFeeToken + protocolFeeInSourceFeeToken + relayerFeeInSourceFeeToken;
+    if (!filledWithNativeToken) {
+      totalEstimateInSourceFeeToken = totalEstimateInSourceFeeToken + totalEstimateInSourceFeeToken * 200n / 10000n;
+    }
+    let totalNativeTokenAmount = await this.convertFeeTokenToNative(totalEstimateInSourceFeeToken, "source");
+    totalNativeTokenAmount = totalNativeTokenAmount + totalNativeTokenAmount * 200n / 10000n;
     return {
-      feeTokenAmount: totalFeeTokenAmount,
+      feeTokenAmount: totalEstimateInSourceFeeToken,
       nativeTokenAmount: totalNativeTokenAmount,
       postRequestCalldata
     };
@@ -11698,8 +11765,7 @@ var IntentGateway = class {
    * 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
    */
@@ -11708,22 +11774,33 @@ var IntentGateway = class {
     const evmChainID = `EVM-${client.chain?.id}`;
     const wethAsset = this[getQuoteIn].config.getWrappedNativeAssetWithDecimals(evmChainID).asset;
     const feeToken = await this[getQuoteIn].getFeeTokenWithDecimals();
-    const { amountOut } = await this.findBestProtocolWithAmountIn(
-      getQuoteIn,
-      feeToken.address,
-      wethAsset,
-      feeTokenAmount,
-      "v2"
-    );
-    return amountOut;
+    try {
+      const { amountOut } = await this.findBestProtocolWithAmountIn(
+        getQuoteIn,
+        feeToken.address,
+        wethAsset,
+        feeTokenAmount,
+        "v2"
+      );
+      if (amountOut === 0n) {
+        throw new Error();
+      }
+      return amountOut;
+    } catch {
+      const nativeCurrency = client.chain?.nativeCurrency;
+      const chainId = client.chain?.id;
+      const feeTokenAmountDecimal = new Decimal(formatUnits(feeTokenAmount, feeToken.decimals));
+      const nativeTokenPriceUsd = new Decimal(await fetchPrice(nativeCurrency?.symbol, chainId));
+      const totalCostInNativeToken = feeTokenAmountDecimal.dividedBy(nativeTokenPriceUsd);
+      return parseUnits(totalCostInNativeToken.toFixed(nativeCurrency?.decimals), nativeCurrency?.decimals);
+    }
   }
   /**
    * Converts gas costs to the equivalent amount in the fee token (DAI).
    * 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
    */
@@ -11734,15 +11811,36 @@ var IntentGateway = class {
     const evmChainID = `EVM-${client.chain?.id}`;
     const wethAddr = this[gasEstimateIn].config.getWrappedNativeAssetWithDecimals(evmChainID).asset;
     const feeToken = await this[gasEstimateIn].getFeeTokenWithDecimals();
-    const { amountOut } = await this.findBestProtocolWithAmountIn(
-      gasEstimateIn,
-      wethAddr,
-      feeToken.address,
-      gasCostInWei,
-      "v2"
-    );
-    return amountOut;
+    try {
+      const { amountOut } = await this.findBestProtocolWithAmountIn(
+        gasEstimateIn,
+        wethAddr,
+        feeToken.address,
+        gasCostInWei,
+        "v2"
+      );
+      if (amountOut === 0n) {
+        throw new Error();
+      }
+      return amountOut;
+    } catch {
+      const nativeCurrency = client.chain?.nativeCurrency;
+      const chainId = client.chain?.id;
+      const gasCostInToken = new Decimal(formatUnits(gasCostInWei, nativeCurrency?.decimals));
+      const tokenPriceUsd = await fetchPrice(nativeCurrency?.symbol, chainId);
+      const gasCostUsd = gasCostInToken.times(tokenPriceUsd);
+      const feeTokenPriceUsd = new Decimal(1);
+      const gasCostInFeeToken = gasCostUsd.dividedBy(feeTokenPriceUsd);
+      return parseUnits(gasCostInFeeToken.toFixed(feeToken.decimals), feeToken.decimals);
+    }
   }
+  /**
+   * 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
+   */
   async quoteNative(postRequest, fee) {
     const dispatchPost = {
       dest: toHex(postRequest.dest),
@@ -11764,7 +11862,7 @@ var IntentGateway = class {
    * 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
@@ -11929,10 +12027,11 @@ var IntentGateway = class {
    * 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)
    */
   async findBestProtocolWithAmountIn(getQuoteIn, tokenIn, tokenOut, amountIn, selectedProtocol) {