@hyperbridge/sdk 2.0.0 → 2.0.1

package/dist/node/index.d.ts

@@ -1055,6 +1055,14 @@ declare function postRequestCommitment(post: IPostRequest): {
 declare function bytes32ToBytes20(bytes32Address: string): HexString;
 declare function bytes20ToBytes32(bytes20Address: string): HexString;
 declare function hexToString(hex: string): string;
+declare function normalizeStateMachineId(stateMachineId: string): string;
+declare function normalizeEvmChainId(chainId: number | string): {
+    chainId: number;
+    stateMachineId: string;
+};
+declare function encodeStateMachineId(stateMachineId: string): HexString;
+declare function normalizeAddressForEvmBytes32(address: string): HexString;
+declare function normalizeAddressForStateMachine(address: string, stateMachineId: string): HexString;
 /**
  * Retries a promise-returning operation with exponential backoff.
  * This function will attempt to execute the operation up to maxRetries times,
@@ -1958,6 +1966,8 @@ interface IEvmChain extends IChain {
 
 type EstimateGasCallData = ContractFunctionArgs<typeof _default.ABI, "nonpayable" | "payable", "handlePostRequests">;
 type HexString = `0x${string}`;
+type StateMachineId = string;
+type BytesLikeHex = HexString;
 interface IConfig {
     source: IEvmConfig | ISubstrateConfig | IPolkadotHubConfig | IPharosConfig;
     dest: IEvmConfig | ISubstrateConfig | IPolkadotHubConfig | IPharosConfig;
@@ -2412,10 +2422,13 @@ interface ChainConfig {
  */
 interface TokenInfo {
     /**
-     * The address of the ERC20 token
-     * address(0) is used as a sentinel for the native token
+     * The token identifier as either:
+     * - a standard 20-byte EVM address (`0xabc...`)
+     * - an already padded 32-byte value (`0x000...abc...`)
+     *
+     * `address(0)` / `bytes32(0)` is used as a sentinel for the native token.
      */
-    token: HexString;
+    token: BytesLikeHex;
     /**
      * The amount of the token
      */
@@ -2934,7 +2947,8 @@ interface StorageFacade {
     delete(key: string): Promise<void>;
 }
 interface PaymentInfo {
-    beneficiary: HexString;
+    /** Accepts a standard 20-byte address; the SDK pads to bytes32 internally when needed. */
+    beneficiary: BytesLikeHex;
     assets: TokenInfo[];
     call: HexString;
 }
@@ -2945,8 +2959,10 @@ interface DispatchInfo {
 interface Order {
     id?: string;
     user: HexString;
-    source: HexString;
-    destination: HexString;
+    /** Accepts either `"EVM-1"` style IDs or their hex-encoded form. */
+    source: StateMachineId;
+    /** Accepts either `"EVM-42161"` style IDs or their hex-encoded form. */
+    destination: StateMachineId;
     deadline: bigint;
     nonce: bigint;
     fees: bigint;
@@ -2955,6 +2971,10 @@ interface Order {
     inputs: TokenInfo[];
     output: PaymentInfo;
 }
+interface CancelOrderOptions {
+    /** Where to initiate the cancel from. Defaults to `"source"`. */
+    from?: "source" | "destination";
+}
 interface FillOptions {
     relayerFee: bigint;
     nativeDispatchFee: bigint;
@@ -3598,9 +3618,89 @@ declare function queryGetRequest(params: {
     queryClient: IndexerQueryClient;
 }): Promise<GetRequestWithStatus | undefined>;
 
+type UniswapProtocol = "v2" | "v3" | "v4";
+type UniswapTradeType = "EXACT_INPUT" | "EXACT_OUTPUT";
+/**
+ * Token metadata required for Uniswap quoting.
+ */
+interface UniswapQuoteToken {
+    /** Token contract address. Use ADDRESS_ZERO for the native asset. */
+    address: HexString;
+    /** Token decimals used by the integrating app when formatting quote amounts. */
+    decimals: number;
+    /** Optional display symbol, returned unchanged in quote responses. */
+    symbol?: string;
+    /** EVM chain ID where this token exists. */
+    chainId: number;
+}
+/**
+ * Parameters for quoting a Uniswap swap through the SDK.
+ *
+ * Provide `amountIn` when `tradeType` is `EXACT_INPUT`, or `amountOut` when
+ * `tradeType` is `EXACT_OUTPUT`. RPC clients are derived from SDK chain config.
+ */
+interface QuoteUniswapParams {
+    /** Numeric EVM chain ID or state machine ID, for example `8453` or `EVM-8453`. */
+    chainId: number | string;
+    /** Token the user pays with. */
+    tokenIn: UniswapQuoteToken;
+    /** Token the user receives. */
+    tokenOut: UniswapQuoteToken;
+    /** Exact input amount, required for `EXACT_INPUT`. */
+    amountIn?: bigint;
+    /** Exact output amount, required for `EXACT_OUTPUT`. */
+    amountOut?: bigint;
+    /** Whether to quote by fixed input or fixed output. */
+    tradeType: UniswapTradeType;
+    /** Protocols to check. Defaults to all supported protocols: v2, v3, and v4. */
+    protocols?: UniswapProtocol[];
+    /** Slippage tolerance in basis points, only used when `recipient` is provided. */
+    slippageBps?: number;
+    /** Optional recipient. When set, executable transaction calldata is included. */
+    recipient?: HexString;
+}
+/**
+ * Normalized quote returned by every Uniswap protocol adapter.
+ */
+interface UniswapQuote {
+    /** Protocol that produced this quote. */
+    protocol: UniswapProtocol;
+    /** Quote direction used to calculate the amounts. */
+    tradeType: UniswapTradeType;
+    /** Numeric EVM chain ID. */
+    chainId: number;
+    /** Token the user pays with. */
+    tokenIn: UniswapQuoteToken;
+    /** Token the user receives. */
+    tokenOut: UniswapQuoteToken;
+    /** Input amount required for this quote. */
+    amountIn: bigint;
+    /** Output amount returned by this quote. */
+    amountOut: bigint;
+    /** Winning fee tier for concentrated-liquidity protocols. */
+    fee?: number;
+    /** Token path used by the quote. */
+    route: {
+        tokens: HexString[];
+    };
+    /** Executable transactions, included only when `recipient` is supplied. */
+    transactions?: Transaction[];
+}
+/**
+ * Quote result containing the best quote and all successful protocol candidates.
+ */
+interface QuoteUniswapResult {
+    /** Best quote by highest output for exact input, or lowest input for exact output. */
+    bestQuote: UniswapQuote | null;
+    /** All successful protocol quotes considered by the SDK. */
+    quotes: UniswapQuote[];
+}
+
 declare class Swap {
     private chainConfigService;
+    private uniswapQuoteEngine;
     constructor();
+    quoteUniswap(params: QuoteUniswapParams): Promise<QuoteUniswapResult>;
     /**
      * Gets V2 quote for exact output swap.
      */
@@ -3750,6 +3850,7 @@ declare class Swap {
      */
     private getTickSpacing;
 }
+declare function quoteUniswap(params: QuoteUniswapParams): Promise<QuoteUniswapResult>;
 
 type StorageDriverKey = "node" | "localstorage" | "indexeddb" | "memory";
 interface CancellationStorageOptions {
@@ -4195,11 +4296,13 @@ declare class IntentGateway {
      * Delegates to {@link OrderCanceller.quoteCancelOrder}.
      *
      * @param order - The order to quote cancellation for.
-     * @param fromDest - If `true`, quotes the destination-initiated cancellation fee.
+     * @param options - Choose the initiation side. Defaults to source-side cancellation.
      * @returns `{ nativeValue }` — native token amount (wei) to send as `value`;
      *   `{ relayerFee }` — relayer incentive denominated in the chain's fee token.
      */
-    quoteCancelOrder(order: Order, fromDest?: boolean): Promise<CancelQuote>;
+    quoteCancelOrder(order: Order, options?: CancelOrderOptions): Promise<CancelQuote>;
+    quoteCancelOrderFromSource(order: Order): Promise<CancelQuote>;
+    quoteCancelOrderFromDest(order: Order): Promise<CancelQuote>;
     /**
      * Async generator that cancels an order and streams status events until
      * cancellation is complete.
@@ -4208,11 +4311,12 @@ declare class IntentGateway {
      *
      * @param order - The order to cancel.
      * @param indexerClient - Indexer client used for ISMP request status streaming.
-     * @param fromDest - If `true`, initiates cancellation from the destination chain.
-     *   Defaults to `false` (source-side cancellation).
+     * @param options - Choose the initiation side. Defaults to source-side cancellation.
      * @yields {@link CancelEvent} objects describing each cancellation stage.
      */
-    cancelOrder(order: Order, indexerClient: IsmpClient, fromDest?: boolean): AsyncGenerator<CancelEvent>;
+    cancelOrder(order: Order, indexerClient: IsmpClient, options?: CancelOrderOptions): AsyncGenerator<CancelEvent>;
+    cancelOrderFromSource(order: Order, indexerClient: IsmpClient): AsyncGenerator<CancelEvent>;
+    cancelOrderFromDest(order: Order, indexerClient: IsmpClient): AsyncGenerator<CancelEvent>;
     /**
      * Constructs a signed `PackedUserOperation` for a solver to submit as a bid.
      *
@@ -4371,6 +4475,10 @@ declare class OrderStatusChecker {
     isOrderRefunded(order: Order): Promise<boolean>;
 }
 
+type ContractOrder = Omit<Order, "id" | "source" | "destination"> & {
+    source: HexString;
+    destination: HexString;
+};
 /**
  * Encodes a list of calls into ERC-7821 `execute` function calldata using
  * single-batch mode.
@@ -4409,8 +4517,8 @@ declare function fetchSourceProof(commitment: HexString, source: IEvmChain, sour
  * - `id` is removed (not part of the on-chain struct).
  * - `source` and `destination` are hex-encoded if currently plain string
  *   state-machine IDs.
- * - `inputs[i].token`, `output.beneficiary`, `output.assets[i].token`, and
- *   `predispatch.assets[i].token` are left-padded from 20-byte addresses to
+ * - `user`, `inputs[i].token`, `output.beneficiary`, `output.assets[i].token`,
+ *   and `predispatch.assets[i].token` are left-padded from 20-byte addresses to
  *   32-byte values (`0x000…addr`) via {@link bytes20ToBytes32}, matching the
  *   `bytes32(uint256(uint160(addr)))` encoding the contract uses when casting
  *   these fields back to `address`. Values already at 32 bytes are unchanged.
@@ -4418,7 +4526,7 @@ declare function fetchSourceProof(commitment: HexString, source: IEvmChain, sour
  * @param order - The SDK-level order to transform.
  * @returns A contract-compatible order struct without `id`.
  */
-declare function transformOrderForContract(order: Order): Omit<Order, "id">;
+declare function transformOrderForContract(order: Order): ContractOrder;
 /**
  * Calculates the commitment hash for an order by ABI-encoding the
  * contract-normalised form of the order and hashing it.
@@ -8027,7 +8135,7 @@ interface TeleportParams {
     assetId: HexString;
     /** Redeem ERC20 on the destination? */
     redeem: boolean;
-    /** Recipient address */
+    /** Recipient address. For EVM destinations, plain 20-byte addresses are accepted and padded internally. */
     to: HexString;
     /** Recipient state machine */
     dest: string | Uint8Array;
@@ -8668,4 +8776,4 @@ declare const getChainId: (stateMachineId: string) => number | undefined;
 declare const getViemChain: (chainId: number) => Chain | undefined;
 declare const hyperbridgeAddress = "";
 
-export { ADDRESS_ZERO, type AllStatusKey, type AssetTeleported, type AssetTeleportedResponse, type BidStorageEntry, type BidSubmissionResult, type BlockMetadata, type BundlerGasEstimate, BundlerMethod, type CancelEvent, type CancelOptions, type CancelQuote, type ChainConfig, type ChainConfigData, ChainConfigService, Chains, type ClientConfig, CryptoUtils, DEFAULT_ADDRESS, DEFAULT_GRAFFITI, DOMAIN_TYPEHASH, DUMMY_PRIVATE_KEY, type DecodedOrderPlacedLog, type DecodedPostRequestEvent, type DecodedPostResponseEvent, type DispatchGet, type DispatchInfo, type DispatchPost, ERC20Method, type ERC7821Call, ERC7821_BATCH_MODE, type EstimateFillOrderParams, type EstimateGasCallData, EvmChain, type EvmChainParams, ABI as EvmHostABI, EvmLanguage, type ExecuteIntentOrderOptions, type ExecutionResult, type FillOptions, type FillOrderEstimate, type FillerBid, type FillerConfig, type GetRequestResponse, type GetRequestWithStatus, type GetResponseByRequestIdResponse, type GetResponseStorageValues, type HexString, type HostParams, HyperClientStatus, type HyperbridgeTxEvents, type IBatchConsensusAndGetResponseMessage, type IBatchConsensusAndPostRequestMessage, type IChain, type IConfig, type IConsensusMessage, type IEvmChain, type IEvmConfig, type IGetRequest, type IGetRequestMessage, type IGetResponse, type IGetResponseMessage, type IHyperbridgeConfig, type IIsmpMessage, type IMessage, type IPharosConfig, type IPolkadotHubConfig, type IPostRequest, type IPostResponse, type IProof, type IRequestMessage, type ISubstrateConfig, type ITimeoutPostRequestMessage, type IndexerQueryClient, IntentGateway, type IntentGatewayContext, type IntentGatewayParams, ABI$1 as IntentGatewayV2ABI, IntentOrderStatus, type IntentOrderStatusKey, type IntentOrderStatusUpdate, IntentsCoprocessor, IsmpClient, type IsmpRequest, MOCK_ADDRESS, type NewDeployment, ORDER_V2_PARAM_TYPE, type Order, type OrderResponse, OrderStatus, OrderStatusChecker, type OrderStatusMetadata, type OrderWithStatus, PACKED_USEROP_TYPEHASH, PLACE_ORDER_SELECTOR, type PackedUserOperation, type Params, type PaymentInfo, PharosChain, type PharosChainParams, PolkadotHubChain, type PolkadotHubChainParams, 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 ResumeIntentOrderOptions, type RetryConfig, SELECT_SOLVER_TYPEHASH, STATE_COMMITMENTS_SLOT, type SelectBidResult, type SelectOptions, type SigningAccount, type StateMachineHeight, type StateMachineIdParams, type StateMachineResponse, type StateMachineUpdate, type StorageFacade, type SubmitBidOptions, SubstrateChain, Swap, TESTNET_CHAINS, type TeleportParams, TeleportStatus, TimeoutStatus, type TimeoutStatusKey, TokenGateway, type TokenGatewayAssetTeleportedResponse, type TokenGatewayAssetTeleportedWithStatus, type TokenInfo, type TokenPrice, type TokenPricesResponse, type Transaction, TronChain, type TronChainParams, USE_ETHERSCAN_CHAINS, type XcmGatewayParams, __test, adjustDecimals, bytes20ToBytes32, bytes32ToBytes20, calculateAllowanceMappingLocation, calculateBalanceMappingLocation, chainConfigs, constructRedeemEscrowRequestBody, constructRefundEscrowRequestBody, convertCodecToIGetRequest, convertCodecToIProof, convertIGetRequestToCodec, convertIProofToCodec, convertStateIdToStateMachineId, convertStateMachineEnumToString, convertStateMachineIdToEnum, createEvmChain, createQueryClient, decodeUserOpScale, encodeERC7821ExecuteBatch, encodeISMPMessage, encodeUserOpScale, encodeWithdrawalRequest, estimateGasForPost, fetchPrice, fetchSourceProof, generateRootWithProof, getChainId, getConfigByStateMachineId, getContractCallInput, getGasPriceFromEtherscan, getOrFetchStorageSlot, getOrderPlacedFromTx, getPostRequestEventFromTx, getPostResponseEventFromTx, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, getStorageSlot, getViemChain, hexToString, hyperbridgeAddress, maxBigInt, orderCommitment, parseStateMachineId, pharosAtlantic, pharosMainnet, polkadotAssetHubPaseo, postRequestCommitment, queryAssetTeleported, queryGetRequest, queryPostRequest, requestCommitmentKey, responseCommitmentKey, retryPromise, teleport, teleportDot, transformOrderForContract, tronChainIds, tronNile };
+export { ADDRESS_ZERO, type AllStatusKey, type AssetTeleported, type AssetTeleportedResponse, type BidStorageEntry, type BidSubmissionResult, type BlockMetadata, type BundlerGasEstimate, BundlerMethod, type BytesLikeHex, type CancelEvent, type CancelOptions, type CancelOrderOptions, type CancelQuote, type ChainConfig, type ChainConfigData, ChainConfigService, Chains, type ClientConfig, CryptoUtils, DEFAULT_ADDRESS, DEFAULT_GRAFFITI, DOMAIN_TYPEHASH, DUMMY_PRIVATE_KEY, type DecodedOrderPlacedLog, type DecodedPostRequestEvent, type DecodedPostResponseEvent, type DispatchGet, type DispatchInfo, type DispatchPost, ERC20Method, type ERC7821Call, ERC7821_BATCH_MODE, type EstimateFillOrderParams, type EstimateGasCallData, EvmChain, type EvmChainParams, ABI as EvmHostABI, EvmLanguage, type ExecuteIntentOrderOptions, type ExecutionResult, type FillOptions, type FillOrderEstimate, type FillerBid, type FillerConfig, type GetRequestResponse, type GetRequestWithStatus, type GetResponseByRequestIdResponse, type GetResponseStorageValues, type HexString, type HostParams, HyperClientStatus, type HyperbridgeTxEvents, type IBatchConsensusAndGetResponseMessage, type IBatchConsensusAndPostRequestMessage, type IChain, type IConfig, type IConsensusMessage, type IEvmChain, type IEvmConfig, type IGetRequest, type IGetRequestMessage, type IGetResponse, type IGetResponseMessage, type IHyperbridgeConfig, type IIsmpMessage, type IMessage, type IPharosConfig, type IPolkadotHubConfig, type IPostRequest, type IPostResponse, type IProof, type IRequestMessage, type ISubstrateConfig, type ITimeoutPostRequestMessage, type IndexerQueryClient, IntentGateway, type IntentGatewayContext, type IntentGatewayParams, ABI$1 as IntentGatewayV2ABI, IntentOrderStatus, type IntentOrderStatusKey, type IntentOrderStatusUpdate, IntentsCoprocessor, IsmpClient, type IsmpRequest, MOCK_ADDRESS, type NewDeployment, ORDER_V2_PARAM_TYPE, type Order, type OrderResponse, OrderStatus, OrderStatusChecker, type OrderStatusMetadata, type OrderWithStatus, PACKED_USEROP_TYPEHASH, PLACE_ORDER_SELECTOR, type PackedUserOperation, type Params, type PaymentInfo, PharosChain, type PharosChainParams, PolkadotHubChain, type PolkadotHubChainParams, type PostRequestStatus, type PostRequestTimeoutStatus, type PostRequestWithStatus, type QuoteNativeResult, type QuoteUniswapParams, type QuoteUniswapResult, 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 ResumeIntentOrderOptions, type RetryConfig, SELECT_SOLVER_TYPEHASH, STATE_COMMITMENTS_SLOT, type SelectBidResult, type SelectOptions, type SigningAccount, type StateMachineHeight, type StateMachineId, type StateMachineIdParams, type StateMachineResponse, type StateMachineUpdate, type StorageFacade, type SubmitBidOptions, SubstrateChain, Swap, TESTNET_CHAINS, type TeleportParams, TeleportStatus, TimeoutStatus, type TimeoutStatusKey, TokenGateway, type TokenGatewayAssetTeleportedResponse, type TokenGatewayAssetTeleportedWithStatus, type TokenInfo, type TokenPrice, type TokenPricesResponse, type Transaction, TronChain, type TronChainParams, USE_ETHERSCAN_CHAINS, type UniswapProtocol, type UniswapQuote, type UniswapQuoteToken, type UniswapTradeType, type XcmGatewayParams, __test, adjustDecimals, bytes20ToBytes32, bytes32ToBytes20, calculateAllowanceMappingLocation, calculateBalanceMappingLocation, chainConfigs, constructRedeemEscrowRequestBody, constructRefundEscrowRequestBody, convertCodecToIGetRequest, convertCodecToIProof, convertIGetRequestToCodec, convertIProofToCodec, convertStateIdToStateMachineId, convertStateMachineEnumToString, convertStateMachineIdToEnum, createEvmChain, createQueryClient, decodeUserOpScale, encodeERC7821ExecuteBatch, encodeISMPMessage, encodeStateMachineId, encodeUserOpScale, encodeWithdrawalRequest, estimateGasForPost, fetchPrice, fetchSourceProof, generateRootWithProof, getChainId, getConfigByStateMachineId, getContractCallInput, getGasPriceFromEtherscan, getOrFetchStorageSlot, getOrderPlacedFromTx, getPostRequestEventFromTx, getPostResponseEventFromTx, getRequestCommitment, getStateCommitmentFieldSlot, getStateCommitmentSlot, getStorageSlot, getViemChain, hexToString, hyperbridgeAddress, maxBigInt, normalizeAddressForEvmBytes32, normalizeAddressForStateMachine, normalizeEvmChainId, normalizeStateMachineId, orderCommitment, parseStateMachineId, pharosAtlantic, pharosMainnet, polkadotAssetHubPaseo, postRequestCommitment, queryAssetTeleported, queryGetRequest, queryPostRequest, quoteUniswap, requestCommitmentKey, responseCommitmentKey, retryPromise, teleport, teleportDot, transformOrderForContract, tronChainIds, tronNile };