@hyperbridge/sdk 1.4.10 → 1.5.0

package/dist/node/index.d.ts

@@ -590,6 +590,7 @@ declare class ChainConfigService {
     constructor(env?: NodeJS.ProcessEnv);
     getChainConfig(chain: string): ChainConfig;
     getIntentGatewayAddress(chain: string): `0x${string}`;
+    getTokenGatewayAddress(chain: string): `0x${string}`;
     getHostAddress(chain: string): `0x${string}`;
     getWrappedNativeAssetWithDecimals(chain: string): {
         asset: HexString;
@@ -3179,6 +3180,124 @@ type CancelEvent = {
     };
 }[keyof CancelEventMap];
 
+/**
+ * Result of the quoteNative fee estimation
+ */
+interface QuoteNativeResult {
+    /** Total native token cost including relayer fee and protocol fee with 1% buffer */
+    totalNativeCost: bigint;
+    /** Relayer fee converted to source chain fee token */
+    relayerFeeInSourceFeeToken: bigint;
+}
+/**
+ * Parameters for token gateway teleport operations
+ */
+interface TeleportParams {
+    /** Amount to be sent */
+    amount: bigint;
+    /** The token identifier to send */
+    assetId: HexString;
+    /** Redeem ERC20 on the destination? */
+    redeem: boolean;
+    /** Recipient address */
+    to: HexString;
+    /** Recipient state machine */
+    dest: string | Uint8Array;
+    /** Request timeout in seconds */
+    timeout: bigint;
+    /** Destination contract call data */
+    data?: HexString | Uint8Array;
+}
+/**
+ * TokenGateway class for managing cross-chain token transfers via Hyperbridge
+ *
+ * This class provides methods to interact with the TokenGateway contract, including
+ * estimating fees for cross-chain token teleports.
+ *
+ * Supports both EVM and Substrate chains as destination.
+ *
+ * @example
+ * ```typescript
+ * const tokenGateway = new TokenGateway({
+ *   source: sourceChain,
+ *   dest: destChain // Can be EvmChain or SubstrateChain
+ * })
+ *
+ * const teleportParams: TeleportParams = {
+ *   amount: parseEther("1.0"),
+ *   assetId: keccak256(toHex("USDC")),
+ *   redeem: true,
+ *   to: pad("0xRecipientAddress", { size: 32 }),
+ *   dest: "EVM-1",
+ *   timeout: 3600n,
+ * }
+ *
+ * // Estimate native cost (relayer fee + protocol fee with 1% buffer)
+ * const { totalNativeCost, relayerFeeInSourceFeeToken } = await tokenGateway.quoteNative(teleportParams)
+ * console.log(`Total native cost: ${formatEther(totalNativeCost)} ETH`)
+ * console.log(`Relayer fee in fee token: ${relayerFeeInSourceFeeToken}`)
+ * ```
+ */
+declare class TokenGateway {
+    private readonly source;
+    private readonly dest;
+    constructor(params: {
+        source: EvmChain;
+        dest: EvmChain | SubstrateChain;
+    });
+    /**
+     * Get the TokenGateway contract address for a given chain
+     *
+     * @param chain - The chain identifier (e.g., "EVM-1", "EVM-56")
+     * @returns The TokenGateway contract address
+     */
+    private getTokenGatewayAddress;
+    /**
+     * Estimate the native token cost for a token gateway teleport operation.
+     * This includes both relayer fees and protocol fees for cross-chain delivery.
+     *
+     * The relayer fee is automatically estimated for EVM destination chains by:
+     * 1. Creating a dummy post request with 191 bytes of random data in the body
+     * 2. Estimating gas for delivery on the destination chain
+     * 3. Converting the gas estimate to native tokens
+     * 4. Adding a 1% buffer to the relayer fee for safety margin
+     *
+     * For non-EVM destination chains, the relayer fee is set to zero.
+     *
+     * The function then constructs a proper post request and calls quoteNative on the
+     * source chain to get protocol fees (with 1% buffer), converts the relayer fee to
+     * source chain fee token using Uniswap V2's getAmountsOut, and returns both values.
+     *
+     * @param params - The teleport parameters
+     * @returns Object containing totalNativeCost (with 1% buffer) and relayerFeeInSourceFeeToken
+     *
+     * @throws Will throw an error if the contract call fails
+     *
+     * @example
+     * ```typescript
+     * const params: TeleportParams = {
+     *   amount: parseEther("1.0"),
+     *   assetId: keccak256(toHex("USDC")),
+     *   redeem: true,
+     *   to: pad("0xRecipientAddress", { size: 32 }),
+     *   dest: "EVM-1",
+     *   timeout: 3600n,
+     *   data: "0x"
+     * }
+     *
+     * const { totalNativeCost, relayerFeeInSourceFeeToken } = await tokenGateway.quoteNative(params)
+     * console.log(`Total native cost: ${formatEther(totalNativeCost)} ETH`)
+     * console.log(`Relayer fee in fee token: ${relayerFeeInSourceFeeToken}`)
+     * ```
+     */
+    quoteNative(params: TeleportParams): Promise<QuoteNativeResult>;
+    /**
+     * Convert native token amount to fee token amount using Uniswap V2 router
+     * @private
+     */
+    private convertNativeToFeeToken;
+}
+
 /**
  * Extracts the IntentGateway OrderPlaced event from a transaction hash.
  * @param client - A viem PublicClient-compatible instance
@@ -3511,4 +3630,4 @@ declare const popularTokens: {
     "EVM-130": string[];
 };
 
-export { ADDRESS_ZERO, type AllStatusKey, type AssetTeleported, type AssetTeleportedResponse, type BlockMetadata, type CancelOptions, type ChainConfig, ChainConfigService, type ChainId, Chains, type ClientConfig, DEFAULT_ADDRESS, DEFAULT_GRAFFITI, DUMMY_PRIVATE_KEY, type DecodedOrderPlacedLog, type DecodedPostRequestEvent, type DecodedPostResponseEvent, type DispatchGet, type DispatchPost, ERC20Method, type EstimateGasCallData, EvmChain, type EvmChainParams, type ExecutionResult, type FillOptions, type FillerConfig, type GetRequestResponse, type GetRequestWithStatus, type GetResponseByRequestIdResponse, type GetResponseStorageValues, type HexString, type HostParams, HyperClientStatus, type HyperbridgeTxEvents, type IChain, type IConfig, type IEvmConfig, type IGetRequest, type IGetRequestMessage, type IGetResponse, type IGetResponseMessage, type IHyperbridgeConfig, type IIsmpMessage, type IMessage, type IPostRequest, type IPostResponse, type IProof, type IRequestMessage, type ISubstrateConfig, type ITimeoutPostRequestMessage, IndexerClient, type IndexerQueryClient, IntentGateway, type IntentGatewayParams, type IsmpRequest, type NewDeployment, type Order, type OrderResponse, OrderStatus, type OrderStatusMetadata, type OrderWithStatus, type Params, type PaymentInfo, type PostRequestStatus, type PostRequestTimeoutStatus, type PostRequestWithStatus, 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 RetryConfig, STATE_COMMITMENTS_SLOT, type StateMachineHeight, type StateMachineIdParams, type StateMachineResponse, type StateMachineUpdate, type StorageFacade, SubstrateChain, TESTNET_CHAINS, TeleportStatus, TimeoutStatus, type TimeoutStatusKey, type TokenGatewayAssetTeleportedResponse, type TokenGatewayAssetTeleportedWithStatus, type TokenInfo, type TokenPrice, type TokenPricesResponse, type TokenRegistry, type TokenRegistryResponse, type Transaction, USE_ETHERSCAN_CHAINS, WrappedNativeDecimals, type XcmGatewayParams, __test, addresses, adjustFeeDecimals, assets, bytes20ToBytes32, bytes32ToBytes20, chainIds, coingeckoIds, consensusStateIds, constructRedeemEscrowRequestBody, convertCodecToIGetRequest, convertCodecToIProof, convertIGetRequestToCodec, convertIProofToCodec, convertStateIdToStateMachineId, convertStateMachineEnumToString, convertStateMachineIdToEnum, createChain, createEvmChain, createIndexerClient, createQueryClient, createRpcUrls, encodeISMPMessage, estimateGasForPost, fetchPrice, generateRootWithProof, getChain, getGasPriceFromEtherscan, getOrderPlacedFromTx, getPostRequestEventFromTx, getPostResponseEventFromTx, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, getStorageSlot, hexToString, maxBigInt, orderCommitment, popularTokens, postRequestCommitment, queryAssetTeleported, queryGetRequest, queryPostRequest, requestCommitmentKey, retryPromise, teleport, teleportDot, viemChains };
+export { ADDRESS_ZERO, type AllStatusKey, type AssetTeleported, type AssetTeleportedResponse, type BlockMetadata, type CancelOptions, type ChainConfig, ChainConfigService, type ChainId, Chains, type ClientConfig, DEFAULT_ADDRESS, DEFAULT_GRAFFITI, DUMMY_PRIVATE_KEY, type DecodedOrderPlacedLog, type DecodedPostRequestEvent, type DecodedPostResponseEvent, type DispatchGet, type DispatchPost, ERC20Method, type EstimateGasCallData, EvmChain, type EvmChainParams, type ExecutionResult, type FillOptions, type FillerConfig, type GetRequestResponse, type GetRequestWithStatus, type GetResponseByRequestIdResponse, type GetResponseStorageValues, type HexString, type HostParams, HyperClientStatus, type HyperbridgeTxEvents, type IChain, type IConfig, type IEvmConfig, type IGetRequest, type IGetRequestMessage, type IGetResponse, type IGetResponseMessage, type IHyperbridgeConfig, type IIsmpMessage, type IMessage, type IPostRequest, type IPostResponse, type IProof, type IRequestMessage, type ISubstrateConfig, type ITimeoutPostRequestMessage, IndexerClient, type IndexerQueryClient, IntentGateway, type IntentGatewayParams, type IsmpRequest, type NewDeployment, type Order, type OrderResponse, OrderStatus, type OrderStatusMetadata, type OrderWithStatus, type Params, type PaymentInfo, type PostRequestStatus, type PostRequestTimeoutStatus, type PostRequestWithStatus, type QuoteNativeResult, 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 RetryConfig, STATE_COMMITMENTS_SLOT, type StateMachineHeight, type StateMachineIdParams, type StateMachineResponse, type StateMachineUpdate, type StorageFacade, SubstrateChain, TESTNET_CHAINS, type TeleportParams, TeleportStatus, TimeoutStatus, type TimeoutStatusKey, TokenGateway, type TokenGatewayAssetTeleportedResponse, type TokenGatewayAssetTeleportedWithStatus, type TokenInfo, type TokenPrice, type TokenPricesResponse, type TokenRegistry, type TokenRegistryResponse, type Transaction, USE_ETHERSCAN_CHAINS, WrappedNativeDecimals, type XcmGatewayParams, __test, addresses, adjustFeeDecimals, assets, bytes20ToBytes32, bytes32ToBytes20, chainIds, coingeckoIds, consensusStateIds, constructRedeemEscrowRequestBody, convertCodecToIGetRequest, convertCodecToIProof, convertIGetRequestToCodec, convertIProofToCodec, convertStateIdToStateMachineId, convertStateMachineEnumToString, convertStateMachineIdToEnum, createChain, createEvmChain, createIndexerClient, createQueryClient, createRpcUrls, encodeISMPMessage, estimateGasForPost, fetchPrice, generateRootWithProof, getChain, getGasPriceFromEtherscan, getOrderPlacedFromTx, getPostRequestEventFromTx, getPostResponseEventFromTx, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, getStorageSlot, hexToString, maxBigInt, orderCommitment, popularTokens, postRequestCommitment, queryAssetTeleported, queryGetRequest, queryPostRequest, requestCommitmentKey, retryPromise, teleport, teleportDot, viemChains };

package/dist/node/index.js

@@ -3421,6 +3421,17 @@ var addresses = {
     ["EVM-137" /* POLYGON_MAINNET */]: "0x1a4ee689a004b10210a1df9f24a387ea13359acf",
     ["EVM-130" /* UNICHAIN_MAINNET */]: "0x1a4ee689a004b10210a1df9f24a387ea13359acf"
   },
+  TokenGateway: {
+    ["EVM-97" /* BSC_CHAPEL */]: "0xFcDa26cA021d5535C3059547390E6cCd8De7acA6",
+    ["EVM-10200" /* GNOSIS_CHIADO */]: "0xFcDa26cA021d5535C3059547390E6cCd8De7acA6",
+    ["EVM-11155111" /* SEPOLIA */]: "0xFcDa26cA021d5535C3059547390E6cCd8De7acA6",
+    ["EVM-1" /* MAINNET */]: "0xFd413e3AFe560182C4471F4d143A96d3e259B6dE",
+    ["EVM-56" /* BSC_MAINNET */]: "0xFd413e3AFe560182C4471F4d143A96d3e259B6dE",
+    ["EVM-42161" /* ARBITRUM_MAINNET */]: "0xFd413e3AFe560182C4471F4d143A96d3e259B6dE",
+    ["EVM-8453" /* BASE_MAINNET */]: "0xFd413e3AFe560182C4471F4d143A96d3e259B6dE",
+    ["EVM-137" /* POLYGON_MAINNET */]: "0x8b536105b6Fae2aE9199f5146D3C57Dfe53b614E",
+    ["EVM-130" /* UNICHAIN_MAINNET */]: "0x8b536105b6Fae2aE9199f5146D3C57Dfe53b614E"
+  },
   Host: {
     ["EVM-97" /* BSC_CHAPEL */]: "0x8Aa0Dea6D675d785A882967Bf38183f6117C09b7",
     ["EVM-10200" /* GNOSIS_CHIADO */]: "0x58a41b89f4871725e5d898d98ef4bf917601c5eb",
@@ -3612,6 +3623,9 @@ var ChainConfigService = class {
   getIntentGatewayAddress(chain) {
     return addresses.IntentGateway[chain];
   }
+  getTokenGatewayAddress(chain) {
+    return addresses.TokenGateway[chain];
+  }
   getHostAddress(chain) {
     return addresses.Host[chain];
   }
@@ -13137,6 +13151,140 @@ async function fetchSourceProof(commitment, source, sourceStateMachine, sourceCo
     proof: proofHex
   };
 }
+var TokenGateway = class {
+  source;
+  dest;
+  constructor(params) {
+    this.source = params.source;
+    this.dest = params.dest;
+  }
+  /**
+   * Get the TokenGateway contract address for a given chain
+   *
+   * @param chain - The chain identifier (e.g., "EVM-1", "EVM-56")
+   * @returns The TokenGateway contract address
+   */
+  getTokenGatewayAddress(chain) {
+    const chainStr = typeof chain === "string" ? chain : new TextDecoder().decode(chain);
+    return this.source.configService.getTokenGatewayAddress(chainStr);
+  }
+  /**
+   * Estimate the native token cost for a token gateway teleport operation.
+   * This includes both relayer fees and protocol fees for cross-chain delivery.
+   *
+   * The relayer fee is automatically estimated for EVM destination chains by:
+   * 1. Creating a dummy post request with 191 bytes of random data in the body
+   * 2. Estimating gas for delivery on the destination chain
+   * 3. Converting the gas estimate to native tokens
+   * 4. Adding a 1% buffer to the relayer fee for safety margin
+   *
+   * For non-EVM destination chains, the relayer fee is set to zero.
+   *
+   * The function then constructs a proper post request and calls quoteNative on the
+   * source chain to get protocol fees (with 1% buffer), converts the relayer fee to
+   * source chain fee token using Uniswap V2's getAmountsOut, and returns both values.
+   *
+   * @param params - The teleport parameters
+   * @returns Object containing totalNativeCost (with 1% buffer) and relayerFeeInSourceFeeToken
+   *
+   * @throws Will throw an error if the contract call fails
+   *
+   * @example
+   * ```typescript
+   * const params: TeleportParams = {
+   *   amount: parseEther("1.0"),
+   *   assetId: keccak256(toHex("USDC")),
+   *   redeem: true,
+   *   to: pad("0xRecipientAddress", { size: 32 }),
+   *   dest: "EVM-1",
+   *   timeout: 3600n,
+   *   data: "0x"
+   * }
+   *
+   * const { totalNativeCost, relayerFeeInSourceFeeToken } = await tokenGateway.quoteNative(params)
+   * console.log(`Total native cost: ${formatEther(totalNativeCost)} ETH`)
+   * console.log(`Relayer fee in fee token: ${relayerFeeInSourceFeeToken}`)
+   * ```
+   */
+  async quoteNative(params) {
+    const dataHex = params.data ? typeof params.data === "string" ? params.data : toHex(params.data) : "0x";
+    const sourceTokenGatewayAddress = this.getTokenGatewayAddress(this.source.config.stateMachineId);
+    const destTokenGatewayAddress = this.getTokenGatewayAddress(params.dest);
+    let relayerFee = 0n;
+    const destChainId = typeof params.dest === "string" ? params.dest : new TextDecoder().decode(params.dest);
+    const isEvmDest = destChainId.startsWith("EVM-") && this.dest instanceof EvmChain;
+    if (isEvmDest) {
+      const randomHex = "0x" + Array.from({ length: 191 * 2 }, () => Math.floor(Math.random() * 16).toString(16)).join("");
+      const randomBody = randomHex;
+      const dummyPostRequest = {
+        source: this.source.config.stateMachineId,
+        dest: destChainId,
+        from: sourceTokenGatewayAddress,
+        to: destTokenGatewayAddress,
+        nonce: 0n,
+        body: randomBody,
+        timeoutTimestamp: params.timeout
+      };
+      const { gas } = await this.dest.estimateGas(dummyPostRequest);
+      const gasPrice = await this.dest.client.getGasPrice();
+      const gasCostInNative = gas * gasPrice;
+      relayerFee = gasCostInNative * 101n / 100n;
+    }
+    const teleportBody = encodeAbiParameters(
+      parseAbiParameters("uint256, uint256, bytes32, bool, bytes32, bytes"),
+      [
+        params.amount,
+        relayerFee,
+        // Use the calculated relayer fee (0 for non-EVM destinations)
+        params.assetId,
+        params.redeem,
+        params.to,
+        dataHex
+      ]
+    );
+    const postRequest = {
+      source: this.source.config.stateMachineId,
+      dest: destChainId,
+      from: sourceTokenGatewayAddress,
+      to: destTokenGatewayAddress,
+      nonce: 0n,
+      body: teleportBody,
+      timeoutTimestamp: params.timeout
+    };
+    const protocolFeeInNative = await this.source.quoteNative(postRequest, relayerFee);
+    const protocolFeeWithBuffer = protocolFeeInNative * 101n / 100n;
+    let relayerFeeInSourceFeeToken = 0n;
+    if (relayerFee > 0n) {
+      const feeToken = await this.source.getFeeTokenWithDecimals();
+      relayerFeeInSourceFeeToken = await this.convertNativeToFeeToken(
+        relayerFee,
+        feeToken.address,
+        this.source.config.stateMachineId
+      );
+    }
+    return {
+      totalNativeCost: protocolFeeWithBuffer,
+      relayerFeeInSourceFeeToken
+    };
+  }
+  /**
+   * Convert native token amount to fee token amount using Uniswap V2 router
+   * @private
+   */
+  async convertNativeToFeeToken(nativeAmount, feeTokenAddress, chain) {
+    const v2Router = this.source.configService.getUniswapRouterV2Address(chain);
+    const WETH = this.source.configService.getWrappedNativeAssetWithDecimals(chain).asset;
+    const v2AmountOut = await this.source.client.simulateContract({
+      address: v2Router,
+      abi: uniswapRouterV2_default.ABI,
+      // @ts-ignore
+      functionName: "getAmountsOut",
+      // @ts-ignore
+      args: [nativeAmount, [WETH, feeTokenAddress]]
+    });
+    return v2AmountOut.result[1];
+  }
+};
 async function getOrderPlacedFromTx(client, txHash) {
   const receipt = await client.getTransactionReceipt({ hash: txHash });
   const events = parseEventLogs({
@@ -13452,6 +13600,6 @@ async function teleportDot(param_) {
   return stream;
 }
 
-export { ADDRESS_ZERO, ChainConfigService, Chains, DEFAULT_ADDRESS, DEFAULT_GRAFFITI, DUMMY_PRIVATE_KEY, ERC20Method, EvmChain, HyperClientStatus, IndexerClient, IntentGateway, OrderStatus, REQUEST_COMMITMENTS_SLOT, REQUEST_RECEIPTS_SLOT, RESPONSE_COMMITMENTS_SLOT, RESPONSE_RECEIPTS_SLOT, RequestKind, RequestStatus, STATE_COMMITMENTS_SLOT, SubstrateChain, TESTNET_CHAINS, TeleportStatus, TimeoutStatus, USE_ETHERSCAN_CHAINS, WrappedNativeDecimals, __test, addresses, adjustFeeDecimals, assets, bytes20ToBytes32, bytes32ToBytes20, chainIds, coingeckoIds, consensusStateIds, constructRedeemEscrowRequestBody, convertCodecToIGetRequest, convertCodecToIProof, convertIGetRequestToCodec, convertIProofToCodec, convertStateIdToStateMachineId, convertStateMachineEnumToString, convertStateMachineIdToEnum, createChain, createEvmChain, createIndexerClient, createQueryClient, createRpcUrls, encodeISMPMessage, estimateGasForPost, fetchPrice, generateRootWithProof, getChain, getGasPriceFromEtherscan, getOrderPlacedFromTx, getPostRequestEventFromTx, getPostResponseEventFromTx, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, getStorageSlot, hexToString, maxBigInt, orderCommitment, popularTokens, postRequestCommitment, queryAssetTeleported, queryGetRequest, queryPostRequest, requestCommitmentKey, retryPromise, teleport, teleportDot, viemChains };
+export { ADDRESS_ZERO, ChainConfigService, Chains, DEFAULT_ADDRESS, DEFAULT_GRAFFITI, DUMMY_PRIVATE_KEY, ERC20Method, EvmChain, HyperClientStatus, IndexerClient, IntentGateway, OrderStatus, REQUEST_COMMITMENTS_SLOT, REQUEST_RECEIPTS_SLOT, RESPONSE_COMMITMENTS_SLOT, RESPONSE_RECEIPTS_SLOT, RequestKind, RequestStatus, STATE_COMMITMENTS_SLOT, SubstrateChain, TESTNET_CHAINS, TeleportStatus, TimeoutStatus, TokenGateway, USE_ETHERSCAN_CHAINS, WrappedNativeDecimals, __test, addresses, adjustFeeDecimals, assets, bytes20ToBytes32, bytes32ToBytes20, chainIds, coingeckoIds, consensusStateIds, constructRedeemEscrowRequestBody, convertCodecToIGetRequest, convertCodecToIProof, convertIGetRequestToCodec, convertIProofToCodec, convertStateIdToStateMachineId, convertStateMachineEnumToString, convertStateMachineIdToEnum, createChain, createEvmChain, createIndexerClient, createQueryClient, createRpcUrls, encodeISMPMessage, estimateGasForPost, fetchPrice, generateRootWithProof, getChain, getGasPriceFromEtherscan, getOrderPlacedFromTx, getPostRequestEventFromTx, getPostResponseEventFromTx, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, getStorageSlot, hexToString, maxBigInt, orderCommitment, popularTokens, postRequestCommitment, queryAssetTeleported, queryGetRequest, queryPostRequest, requestCommitmentKey, retryPromise, teleport, teleportDot, viemChains };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map