@hyperbridge/sdk 1.1.12 → 1.2.0

package/dist/browser/index.d.ts

@@ -3,6 +3,7 @@ import { GraphQLClient } from 'graphql-request';
 import { Hex, Log, PublicClient } from 'viem';
 import { ApiPromise } from '@polkadot/api';
 import { SignerOptions } from '@polkadot/api/types';
+import { Chain } from 'viem/chains';
 
 type HexString = `0x${string}`;
 interface IConfig {
@@ -859,10 +860,6 @@ interface HostParams {
      */
     hyperbridge: HexString;
 }
-declare enum EvmLanguage {
-    Solidity = 0,
-    Vyper = 1
-}
 interface OrderStatusMetadata {
     status: OrderStatus;
     chain: string;
@@ -947,6 +944,32 @@ declare class AbortSignalInternal extends Error {
     static isError(error: unknown): error is AbortSignalInternal;
 }
 
+declare class ChainConfigService {
+    private rpcUrls;
+    constructor(env?: NodeJS.ProcessEnv);
+    getChainConfig(chain: string): ChainConfig;
+    getIntentGatewayAddress(chain: string): `0x${string}`;
+    getHostAddress(chain: string): `0x${string}`;
+    getWrappedNativeAssetWithDecimals(chain: string): {
+        asset: HexString;
+        decimals: number;
+    };
+    getDaiAsset(chain: string): HexString;
+    getUsdtAsset(chain: string): HexString;
+    getUsdcAsset(chain: string): HexString;
+    getChainId(chain: string): number;
+    getConsensusStateId(chain: string): HexString;
+    getHyperbridgeChainId(): number;
+    getRpcUrl(chain: string): string;
+    getUniswapRouterV2Address(chain: string): HexString;
+    getUniswapV2FactoryAddress(chain: string): HexString;
+    getBatchExecutorAddress(chain: string): HexString;
+    getUniversalRouterAddress(chain: string): HexString;
+    getUniswapV3RouterAddress(chain: string): HexString;
+    getUniswapV3FactoryAddress(chain: string): HexString;
+    getUniswapV3QuoterAddress(chain: string): HexString;
+}
+
 /**
  * The default address used as fallback when no address is provided.
  * This represents the zero address in EVM chains.
@@ -975,7 +998,11 @@ interface EvmChainParams {
 declare class EvmChain implements IChain {
     private readonly params;
     private publicClient;
+    private chainConfigService;
     constructor(params: EvmChainParams);
+    get client(): PublicClient;
+    get host(): HexString;
+    get config(): ChainConfigService;
     /**
      * Derives the key for the request receipt.
      * @param {HexString} commitment - The commitment to derive the key from.
@@ -1016,7 +1043,7 @@ declare class EvmChain implements IChain {
     latestStateMachineHeight(stateMachineId: StateMachineIdParams): Promise<bigint>;
     /**
      * Get the state machine update time for a given state machine height.
-     * @param {StateMachineHeight} stateMachineheight - The state machine height.
+     * @param {StateMachineHeight} stateMachineHeight - The state machine height.
      * @returns {Promise<bigint>} The statemachine update time in seconds.
      */
     stateMachineUpdateTime(stateMachineHeight: StateMachineHeight): Promise<bigint>;
@@ -1032,6 +1059,43 @@ declare class EvmChain implements IChain {
      * @returns {HexString} The encoded calldata.
      */
     encode(message: IIsmpMessage): HexString;
+    /**
+     * Calculates the fee required to send a post request to the destination chain.
+     * The fee is calculated based on the per-byte fee for the destination chain
+     * multiplied by the size of the request body.
+     *
+     * @param request - The post request to calculate the fee for
+     * @returns The total fee in wei required to send the post request
+     */
+    quote(request: IPostRequest): Promise<bigint>;
+    /**
+     * Estimates the gas required for a post request execution on this chain.
+     * This function generates mock proofs for the post request, creates a state override
+     * with the necessary overlay root, and estimates the gas cost for executing the
+     * handlePostRequests transaction on the handler contract.
+     *
+     * @param request - The post request to estimate gas for
+     * @param paraId - The ID of the parachain (Hyperbridge) that will process the request
+     * @returns The estimated gas amount in gas units
+     */
+    estimateGas(request: IPostRequest): Promise<bigint>;
+    /**
+     * Gets the fee token address and decimals for the chain.
+     * This function gets the fee token address and decimals for the chain.
+     *
+     * @returns The fee token address and decimals
+     */
+    getFeeTokenWithDecimals(): Promise<{
+        address: HexString;
+        decimals: number;
+    }>;
+    /**
+     * Gets the nonce of the host.
+     * This function gets the nonce of the host.
+     *
+     * @returns The nonce of the host
+     */
+    getHostNonce(): Promise<bigint>;
 }
 /**
  * Slot for storing request commitments.
@@ -1158,15 +1222,50 @@ declare function estimateGasForPost(params: {
  */
 declare function constructRedeemEscrowRequestBody(order: Order, beneficiary: HexString): HexString;
 /**
- * Calculates the balance mapping location for a given slot and holder address.
- * This function handles the different encoding formats used by Solidity and Vyper.
+ * Fetches the USD price of a token from CoinGecko with Defillama fallback
+ * @param identifier - The ticker symbol of the token (e.g., "BTC", "ETH", "USDC") or contract address
+ * @note This function will be replaced by internal price indexer
+ * @returns The USD price of the token as a number (preserves decimals)
+ */
+declare function fetchTokenUsdPrice(identifier: string): Promise<number>;
+/**
+ * Retrieves the storage slot for a contract call using debug_traceCall
+ *
+ * This function uses the Ethereum debug API to trace contract execution and identify
+ * the storage slot accessed during the call. It's commonly used for ERC20 token state
+ * mappings like balanceOf and allowance, but can work with any contract call that
+ * performs SLOAD operations.
+ *
+ * @param client - The viem PublicClient instance connected to an RPC node with debug API enabled
+ * @param tokenAddress - The address of the contract to trace
+ * @param data - The full encoded function call data (method signature + encoded parameters)
+ * @returns The storage slot as a hex string
+ * @throws Error if the storage slot cannot be found or if debug API is not available
+ *
+ * @example
+ * ```ts
+ * import { ERC20Method, bytes20ToBytes32 } from '@hyperbridge/sdk'
  *
- * @param slot - The slot number to calculate the mapping location for.
- * @param holder - The address of the holder to calculate the mapping location for.
- * @param language - The language of the contract.
- * @returns The balance mapping location as a HexString.
+ * // Get balance storage slot for ERC20
+ * const balanceData = ERC20Method.BALANCE_OF + bytes20ToBytes32(userAddress).slice(2)
+ * const balanceSlot = await getStorageSlot(
+ *   client,
+ *   tokenAddress,
+ *   balanceData as HexString
+ * )
+ *
+ * // Get allowance storage slot for ERC20
+ * const allowanceData = ERC20Method.ALLOWANCE +
+ *   bytes20ToBytes32(ownerAddress).slice(2) +
+ *   bytes20ToBytes32(spenderAddress).slice(2)
+ * const allowanceSlot = await getStorageSlot(
+ *   client,
+ *   tokenAddress,
+ *   allowanceData as HexString
+ * )
+ * ```
  */
-declare function calculateBalanceMappingLocation(slot: bigint, holder: string, language: EvmLanguage): HexString;
+declare function getStorageSlot(client: PublicClient, contractAddress: HexString, data: HexString): Promise<string>;
 
 interface SubstrateChainParams {
     ws: string;
@@ -1794,6 +1893,91 @@ declare function queryGetRequest(params: {
     queryClient: IndexerQueryClient;
 }): Promise<GetRequestWithStatus | undefined>;
 
+/**
+ * IntentGateway handles cross-chain intent operations between EVM chains.
+ * It provides functionality for estimating fill orders, finding optimal swap protocols,
+ * and checking order statuses across different chains.
+ */
+declare class IntentGateway {
+    readonly source: EvmChain;
+    readonly dest: EvmChain;
+    /**
+     * Creates a new IntentGateway instance for cross-chain operations.
+     * @param source - The source EVM chain
+     * @param dest - The destination EVM chain
+     */
+    constructor(source: EvmChain, dest: EvmChain);
+    /**
+     * Estimates the total cost required to fill an order, including gas fees, relayer fees,
+     * protocol fees, and swap operations.
+     *
+     * @param order - The order to estimate fill costs for
+     * @returns The estimated total cost in the source chain's fee token
+     */
+    estimateFillOrder(order: Order): Promise<bigint>;
+    /**
+     * Finds the best Uniswap protocol (V2 or V3) 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 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, fee tier (for V3), and gas estimate
+     */
+    findBestProtocolWithAmountOut(chain: string, tokenIn: HexString, tokenOut: HexString, amountOut: bigint): Promise<{
+        protocol: "v2" | "v3" | null;
+        amountIn: bigint;
+        fee?: number;
+        gasEstimate?: bigint;
+    }>;
+    /**
+     * Finds the best Uniswap protocol (V2 or V3) 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 tokenIn - The address of the input token
+     * @param tokenOut - The address of the output token
+     * @param amountIn - The input amount to swap
+     * @returns Object containing the best protocol, expected output amount, fee tier (for V3), and gas estimate
+     */
+    findBestProtocolWithAmountIn(chain: string, tokenIn: HexString, tokenOut: HexString, amountIn: bigint): Promise<{
+        protocol: "v2" | "v3" | null;
+        amountOut: bigint;
+        fee?: number;
+        gasEstimate?: bigint;
+    }>;
+    /**
+     * 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
+     * @returns The gas cost converted to fee token amount
+     * @private
+     */
+    private convertGasToFeeToken;
+    /**
+     * Adjusts fee amounts between different decimal precisions.
+     * Handles scaling up or down based on the decimal difference.
+     *
+     * @param feeInFeeToken - The fee amount to adjust
+     * @param fromDecimals - The current decimal precision
+     * @param toDecimals - The target decimal precision
+     * @returns The adjusted fee amount with the target decimal precision
+     */
+    adjustFeeDecimals(feeInFeeToken: bigint, fromDecimals: number, toDecimals: number): bigint;
+    /**
+     * Checks if an order has been filled by verifying the commitment status on-chain.
+     * Reads the storage slot corresponding to the order's commitment hash.
+     *
+     * @param order - The order to check
+     * @returns True if the order has been filled, false otherwise
+     */
+    isOrderFilled(order: Order): Promise<boolean>;
+}
+
 type HyperbridgeTxEvents = {
     kind: "Ready";
     transaction_hash: HexString;
@@ -1949,4 +2133,58 @@ declare function teleport(teleport_param: {
     options: Partial<SignerOptions>;
 }): Promise<ReadableStream<HyperbridgeTxEvents>>;
 
-export { ADDRESS_ZERO, AbortSignalInternal, type AllStatusKey, type AssetTeleported, type AssetTeleportedResponse, type BlockMetadata, type CancelOptions, type ChainConfig, type ClientConfig, DEFAULT_ADDRESS, DUMMY_PRIVATE_KEY, type DecodedOrderPlacedLog, type DispatchGet, type DispatchPost, EvmChain, type EvmChainParams, EvmLanguage, 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, 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, SubstrateChain, type SubstrateChainParams, TeleportStatus, TimeoutStatus, type TimeoutStatusKey, type TokenGatewayAssetTeleportedResponse, type TokenGatewayAssetTeleportedWithStatus, type TokenInfo, type XcmGatewayParams, __test, bytes20ToBytes32, bytes32ToBytes20, calculateBalanceMappingLocation, constructRedeemEscrowRequestBody, convertStateMachineIdToEnum, createQueryClient, encodeISMPMessage, estimateGasForPost, generateRootWithProof, getChain, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, hexToString, orderCommitment, postRequestCommitment, queryGetRequest, queryPostRequest, teleport, teleportDot };
+declare enum Chains {
+    BSC_CHAPEL = "EVM-97",
+    GNOSIS_CHIADO = "EVM-10200",
+    HYPERBRIDGE_GARGANTUA = "KUSAMA-4009",
+    SEPOLIA = "EVM-11155111"
+}
+type AddressMap = {
+    [key: string]: {
+        [K in Chains]?: `0x${string}`;
+    };
+};
+type RpcMap = Record<Chains, string>;
+declare const chainIds: {
+    readonly "EVM-97": 97;
+    readonly "EVM-10200": 10200;
+    readonly "KUSAMA-4009": 4009;
+    readonly "EVM-11155111": 11155111;
+};
+type ChainId = typeof chainIds;
+declare const viemChains: Record<string, Chain>;
+declare const WrappedNativeDecimals: {
+    "EVM-97": number;
+    "EVM-10200": number;
+    "EVM-11155111": number;
+};
+declare const assets: {
+    "EVM-97": {
+        WETH: string;
+        DAI: string;
+        USDC: string;
+        USDT: string;
+    };
+    "EVM-10200": {
+        WETH: string;
+        DAI: string;
+        USDC: string;
+        USDT: string;
+    };
+    "EVM-11155111": {
+        WETH: string;
+        USDC: string;
+        USDT: string;
+        DAI: string;
+    };
+};
+declare const addresses: AddressMap;
+declare const createRpcUrls: (env: NodeJS.ProcessEnv) => RpcMap;
+declare const consensusStateIds: {
+    "EVM-97": string;
+    "EVM-10200": string;
+    "KUSAMA-4009": string;
+    "EVM-11155111": string;
+};
+
+export { ADDRESS_ZERO, AbortSignalInternal, type AllStatusKey, type AssetTeleported, type AssetTeleportedResponse, type BlockMetadata, type CancelOptions, type ChainConfig, ChainConfigService, type ChainId, Chains, type ClientConfig, DEFAULT_ADDRESS, DUMMY_PRIVATE_KEY, type DecodedOrderPlacedLog, type DispatchGet, type DispatchPost, 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, SubstrateChain, type SubstrateChainParams, TeleportStatus, TimeoutStatus, type TimeoutStatusKey, type TokenGatewayAssetTeleportedResponse, type TokenGatewayAssetTeleportedWithStatus, type TokenInfo, WrappedNativeDecimals, type XcmGatewayParams, __test, addresses, assets, bytes20ToBytes32, bytes32ToBytes20, chainIds, consensusStateIds, constructRedeemEscrowRequestBody, convertStateMachineIdToEnum, createQueryClient, createRpcUrls, encodeISMPMessage, estimateGasForPost, fetchTokenUsdPrice, generateRootWithProof, getChain, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, getStorageSlot, hexToString, orderCommitment, postRequestCommitment, queryGetRequest, queryPostRequest, teleport, teleportDot, viemChains };