@hyperbridge/sdk 1.3.21 → 1.3.25

package/dist/browser/index.d.ts

@@ -1564,6 +1564,23 @@ interface TokenRegistryResponse {
         }>;
     };
 }
+/**
+ * Represents a complete transaction structure for swap operations
+ */
+interface Transaction {
+    /**
+     * The address to send the transaction to (typically the Universal Router address)
+     */
+    to: HexString;
+    /**
+     * The value to send with the transaction (in wei)
+     */
+    value: bigint;
+    /**
+     * The calldata for the transaction
+     */
+    data: HexString;
+}
 
 declare class ChainConfigService {
     private rpcUrls;
@@ -1584,14 +1601,12 @@ declare class ChainConfigService {
     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;
-    getUniswapV4PoolManagerAddress(chain: string): HexString;
     getUniswapV4QuoterAddress(chain: string): HexString;
+    getPermit2Address(chain: string): HexString;
     getCoingeckoId(chain: string): string | undefined;
+    getEtherscanApiKey(): string | undefined;
 }
 
 /**
@@ -1840,6 +1855,16 @@ declare function orderCommitment(order: Order): HexString;
 declare function bytes32ToBytes20(bytes32Address: string): HexString;
 declare function bytes20ToBytes32(bytes20Address: string): HexString;
 declare function hexToString(hex: string): string;
+/**
+ * Retries a promise-returning operation with exponential backoff.
+ * This function will attempt to execute the operation up to maxRetries times,
+ * with an exponential backoff delay between attempts.
+ *
+ * @param operation The async operation to retry
+ * @param retryConfig Configuration object containing retry parameters
+ * @returns Promise that resolves with the operation result or rejects with the last error
+ */
+declare function retryPromise<T>(operation: () => Promise<T>, retryConfig: RetryConfig): Promise<T>;
 /**
  * Calculates the commitment hash for a get request.
  * @param get The get request to calculate the commitment hash for.
@@ -1867,6 +1892,11 @@ declare function estimateGasForPost(params: {
  */
 declare function constructRedeemEscrowRequestBody(order: Order, beneficiary: HexString): HexString;
 declare function fetchPrice(identifier: string, chainId?: number, apiKey?: string): Promise<number>;
+/**
+ * Fetches the current network gas price from an Etherscan-family explorer API.
+ * Returns the ProposeGasPrice (in gwei) converted to wei as bigint.
+ */
+declare function getGasPriceFromEtherscan(chainId: string, apiKey?: string): Promise<bigint>;
 /**
  * ERC20 method signatures used for storage slot detection
  */
@@ -1924,6 +1954,14 @@ declare function getStorageSlot(client: PublicClient, contractAddress: HexString
  * @returns The adjusted fee amount with the target decimal precision
  */
 declare function adjustFeeDecimals(feeInFeeToken: bigint, fromDecimals: number, toDecimals: number): bigint;
+/**
+ * Chains that should prefer the Etherscan API for gas price lookup
+ */
+declare const USE_ETHERSCAN_CHAINS: Set<string>;
+/**
+ * Testnet chains
+ */
+declare const TESTNET_CHAINS: Set<string>;
 
 interface SubstrateChainParams {
     ws: string;
@@ -2286,6 +2324,16 @@ declare class IndexerClient {
         commitmentTimestamp: bigint;
         chain: string;
     }): Promise<StateMachineUpdate | undefined>;
+    /**
+     * Query for the latest state machine update height
+     * @params statemachineId - ID of the state machine
+     * @params chain - The identifier for the chain where the state machine update should be queried (corresponds to a stateMachineId)
+     * @returns Latest height or undefined if no updates found
+     */
+    queryLatestStateMachineHeight({ statemachineId, chain, }: {
+        statemachineId: string;
+        chain: string;
+    }): Promise<bigint | undefined>;
     /**
      * Queries a request by CommitmentHash
      *
@@ -2648,6 +2696,66 @@ declare class IntentGateway {
      * @returns The native token amount required
      */
     quoteNative(postRequest: IPostRequest, fee: bigint): Promise<bigint>;
+    /**
+     * Gets V2 quote for exact output swap.
+     */
+    getV2QuoteWithAmountOut(getQuoteIn: "source" | "dest", tokenIn: HexString, tokenOut: HexString, amountOut: bigint, evmChainID: string): Promise<bigint>;
+    /**
+     * Gets V2 quote for exact input swap.
+     */
+    getV2QuoteWithAmountIn(getQuoteIn: "source" | "dest", tokenIn: HexString, tokenOut: HexString, amountIn: bigint, evmChainID: string): Promise<bigint>;
+    /**
+     * Gets V3 quote for exact output swap.
+     */
+    getV3QuoteWithAmountOut(getQuoteIn: "source" | "dest", tokenIn: HexString, tokenOut: HexString, amountOut: bigint, evmChainID: string): Promise<{
+        amountIn: bigint;
+        fee: number;
+    }>;
+    /**
+     * Gets V3 quote for exact input swap.
+     */
+    getV3QuoteWithAmountIn(getQuoteIn: "source" | "dest", tokenIn: HexString, tokenOut: HexString, amountIn: bigint, evmChainID: string): Promise<{
+        amountOut: bigint;
+        fee: number;
+    }>;
+    /**
+     * Gets V4 quote for exact output swap.
+     */
+    getV4QuoteWithAmountOut(getQuoteIn: "source" | "dest", tokenIn: HexString, tokenOut: HexString, amountOut: bigint, evmChainID: string): Promise<{
+        amountIn: bigint;
+        fee: number;
+    }>;
+    /**
+     * Gets V4 quote for exact input swap.
+     */
+    getV4QuoteWithAmountIn(getQuoteIn: "source" | "dest", tokenIn: HexString, tokenOut: HexString, amountIn: bigint, evmChainID: string): Promise<{
+        amountOut: bigint;
+        fee: number;
+    }>;
+    /**
+     * Creates transaction structure for V2 exact input swap, including ERC20 transfer if needed.
+     */
+    createV2SwapCalldataExactIn(sourceTokenAddress: HexString, targetTokenAddress: HexString, amountIn: bigint, amountOutMinimum: bigint, recipient: HexString, evmChainID: string, getQuoteIn: "source" | "dest"): Transaction[];
+    /**
+     * Creates transaction structure for V2 exact output swap, including ERC20 transfer if needed.
+     */
+    createV2SwapCalldataExactOut(sourceTokenAddress: HexString, targetTokenAddress: HexString, amountOut: bigint, amountInMax: bigint, recipient: HexString, evmChainID: string, getQuoteIn: "source" | "dest"): Transaction[];
+    /**
+     * Creates transaction structure for V3 exact input swap, including ERC20 transfer if needed.
+     */
+    createV3SwapCalldataExactIn(sourceTokenAddress: HexString, targetTokenAddress: HexString, amountIn: bigint, amountOutMinimum: bigint, fee: number, recipient: HexString, evmChainID: string, getQuoteIn: "source" | "dest"): Transaction[];
+    /**
+     * Creates transaction structure for V3 exact output swap, including ERC20 transfer if needed.
+     */
+    createV3SwapCalldataExactOut(sourceTokenAddress: HexString, targetTokenAddress: HexString, amountOut: bigint, amountInMax: bigint, fee: number, recipient: HexString, evmChainID: string, getQuoteIn: "source" | "dest"): Transaction[];
+    /**
+     * Creates transaction structure for V4 exact input swap, including Permit2 approvals for ERC20 tokens.
+     */
+    createV4SwapCalldataExactIn(sourceTokenAddress: HexString, targetTokenAddress: HexString, amountIn: bigint, amountOutMinimum: bigint, fee: number, evmChainID: string, getQuoteIn: "source" | "dest"): Transaction[];
+    /**
+     * Creates transaction structure for V4 exact output swap, including Permit2 approvals for ERC20 tokens.
+     */
+    createV4SwapCalldataExactOut(sourceTokenAddress: HexString, targetTokenAddress: HexString, amountOut: bigint, amountInMax: bigint, fee: number, evmChainID: string, getQuoteIn: "source" | "dest"): Transaction[];
     /**
      * 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.
@@ -2656,12 +2764,17 @@ declare class IntentGateway {
      * @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)
+     * @returns Object containing the best protocol, required input amount, fee tier (for V3/V4), and transaction structure
      */
-    findBestProtocolWithAmountOut(getQuoteIn: "source" | "dest", tokenIn: HexString, tokenOut: HexString, amountOut: bigint, evmChainID: string, selectedProtocol?: "v2" | "v3" | "v4"): Promise<{
+    findBestProtocolWithAmountOut(getQuoteIn: "source" | "dest", tokenIn: HexString, tokenOut: HexString, amountOut: bigint, evmChainID: string, options?: {
+        selectedProtocol?: "v2" | "v3" | "v4";
+        generateCalldata?: boolean;
+        recipient?: HexString;
+    }): Promise<{
         protocol: "v2" | "v3" | "v4" | null;
         amountIn: bigint;
         fee?: number;
+        transactions?: Transaction[];
     }>;
     /**
      * Finds the best Uniswap protocol (V2, V3, or V4) for swapping tokens given an input amount.
@@ -2673,12 +2786,17 @@ declare class IntentGateway {
      * @param amountIn - The input amount to swap
      * @param evmChainID - The EVM chain ID in format "EVM-{id}"
      * @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)
+     * @returns Object containing the best protocol, expected output amount, fee tier (for V3/V4), and transaction structure
      */
-    findBestProtocolWithAmountIn(getQuoteIn: "source" | "dest", tokenIn: HexString, tokenOut: HexString, amountIn: bigint, evmChainID: string, selectedProtocol?: "v2" | "v3" | "v4"): Promise<{
+    findBestProtocolWithAmountIn(getQuoteIn: "source" | "dest", tokenIn: HexString, tokenOut: HexString, amountIn: bigint, evmChainID: string, options?: {
+        selectedProtocol?: "v2" | "v3" | "v4";
+        generateCalldata?: boolean;
+        recipient?: HexString;
+    }): Promise<{
         protocol: "v2" | "v3" | "v4" | null;
         amountOut: bigint;
         fee?: number;
+        transactions?: Transaction[];
     }>;
     /**
      * Checks if an order has been filled by verifying the commitment status on-chain.
@@ -2817,6 +2935,11 @@ declare class IntentGateway {
      * @returns True if candidate is within threshold of reference
      */
     private isWithinThreshold;
+    /**
+     * Encodes multiple command bytes into packed format
+     * @private
+     */
+    private encodeCommands;
 }
 interface StoredCancellationData {
     destIProof?: IProof;
@@ -3106,4 +3229,4 @@ declare const coingeckoIds: {
     "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 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, SubstrateChain, type SubstrateChainParams, TeleportStatus, TimeoutStatus, type TimeoutStatusKey, type TokenGatewayAssetTeleportedResponse, type TokenGatewayAssetTeleportedWithStatus, type TokenInfo, type TokenPrice, type TokenPricesResponse, type TokenRegistry, type TokenRegistryResponse, WrappedNativeDecimals, type XcmGatewayParams, __test, addresses, adjustFeeDecimals, assets, bytes20ToBytes32, bytes32ToBytes20, chainIds, coingeckoIds, consensusStateIds, constructRedeemEscrowRequestBody, convertStateIdToStateMachineId, convertStateMachineIdToEnum, createQueryClient, createRpcUrls, encodeISMPMessage, estimateGasForPost, fetchPrice, generateRootWithProof, getChain, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, getStorageSlot, hexToString, maxBigInt, orderCommitment, postRequestCommitment, queryAssetTeleported, queryGetRequest, queryPostRequest, requestCommitmentKey, 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 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, SubstrateChain, type SubstrateChainParams, 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, convertStateIdToStateMachineId, convertStateMachineIdToEnum, createQueryClient, createRpcUrls, encodeISMPMessage, estimateGasForPost, fetchPrice, generateRootWithProof, getChain, getGasPriceFromEtherscan, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, getStorageSlot, hexToString, maxBigInt, orderCommitment, postRequestCommitment, queryAssetTeleported, queryGetRequest, queryPostRequest, requestCommitmentKey, retryPromise, teleport, teleportDot, viemChains };