@hyperbridge/sdk 1.8.8 → 1.9.1

package/dist/node/index.d.ts

@@ -2900,7 +2900,6 @@ declare const IntentOrderStatus: Readonly<{
     AWAITING_BIDS: "AWAITING_BIDS";
     BIDS_RECEIVED: "BIDS_RECEIVED";
     BID_SELECTED: "BID_SELECTED";
-    USEROP_SUBMITTED: "USEROP_SUBMITTED";
     FILLED: "FILLED";
     PARTIAL_FILL: "PARTIAL_FILL";
     EXPIRED: "EXPIRED";
@@ -2935,11 +2934,6 @@ type IntentOrderStatusUpdate = {
     selectedSolver: HexString;
     userOpHash: HexString;
     userOp: PackedUserOperation;
-} | {
-    status: "USEROP_SUBMITTED";
-    commitment: HexString;
-    userOpHash: HexString;
-    selectedSolver: HexString;
     transactionHash?: HexString;
 } | {
     status: "FILLED";
@@ -2986,8 +2980,8 @@ interface SelectBidResult {
 interface ExecuteIntentOrderOptions {
     order: Order;
     sessionPrivateKey?: HexString;
-    minBids?: number;
-    bidTimeoutMs?: number;
+    /** Duration in ms to collect bids before selecting the best one. */
+    auctionTimeMs: number;
     pollIntervalMs?: number;
     /**
      * If set, bids are restricted to the given solver until `timeoutMs` elapses,
@@ -3000,6 +2994,17 @@ interface ExecuteIntentOrderOptions {
         timeoutMs: number;
     };
 }
+/** Options for resuming execution of a previously placed intent order */
+interface ResumeIntentOrderOptions {
+    sessionPrivateKey?: HexString;
+    /** Duration in ms to collect bids before selecting the best one. */
+    auctionTimeMs: number;
+    pollIntervalMs?: number;
+    solver?: {
+        address: HexString;
+        timeoutMs: number;
+    };
+}
 /** Type for ERC-7821 Call struct */
 type ERC7821Call = {
     target: `0x${string}`;
@@ -3973,7 +3978,7 @@ declare class IntentGateway {
      *    The caller must sign the transaction and pass it back via `gen.next(signedTx)`.
      * 3. Yields `ORDER_PLACED` with the finalised order and transaction hash once
      *    the `OrderPlaced` event is confirmed.
-     * 4. Delegates to {@link OrderExecutor.executeIntentOrder} and forwards all
+     * 4. Delegates to {@link OrderExecutor.executeOrder} and forwards all
      *    subsequent status updates until the order is filled, exhausted, or fails.
      *
      * @param order - The order to place and execute. `order.fees` may be 0; it
@@ -3983,24 +3988,50 @@ declare class IntentGateway {
      * @param options - Optional tuning parameters:
      *   - `maxPriorityFeePerGasBumpPercent` — bump % for the priority fee estimate (default 8).
      *   - `maxFeePerGasBumpPercent` — bump % for the max fee estimate (default 10).
-     *   - `minBids` — minimum bids to collect before selecting (default 1).
-     *   - `bidTimeoutMs` — how long to poll for bids before giving up (default 60 000 ms).
+     *   - `auctionTimeMs` — duration in ms to collect bids before selecting the best one.
      *   - `pollIntervalMs` — interval between bid-polling attempts.
      * @yields {@link IntentOrderStatusUpdate} at each lifecycle stage.
      * @throws If the `placeOrder` generator behaves unexpectedly, or if gas
      *   estimation returns zero.
      */
-    execute(order: Order, graffiti?: HexString, options?: {
+    execute(order: Order, graffiti: HexString | undefined, options: {
+        auctionTimeMs: number;
         maxPriorityFeePerGasBumpPercent?: number;
         maxFeePerGasBumpPercent?: number;
-        minBids?: number;
-        bidTimeoutMs?: number;
         pollIntervalMs?: number;
         solver?: {
             address: HexString;
             timeoutMs: number;
         };
     }): AsyncGenerator<IntentOrderStatusUpdate, void, HexString>;
+    /**
+     * Validates that an order has the minimum fields required for post-placement
+     * resume (i.e. it was previously placed and has an on-chain identity).
+     *
+     * @throws If `order.id` or `order.session` is missing or zero-valued.
+     */
+    private assertOrderCanResume;
+    /**
+     * Resumes execution of a previously placed order.
+     *
+     * Use this method after an app restart or crash to pick up where
+     * {@link execute} left off. The order must already be placed on-chain
+     * (i.e. it must have a valid `id` and `session`).
+     *
+     * Internally delegates to {@link OrderExecutor.executeOrder} and
+     * yields the same status updates as the execution phase of {@link execute}:
+     * `AWAITING_BIDS`, `BIDS_RECEIVED`, `BID_SELECTED`,
+     * `FILLED`, `PARTIAL_FILL`, `EXPIRED`, or `FAILED`.
+     *
+     * Callers may check {@link isOrderFilled} or {@link isOrderRefunded} before
+     * calling this method to avoid resuming an already-terminal order.
+     *
+     * @param order - A previously placed order with a valid `id` and `session`.
+     * @param options - Optional tuning parameters for bid collection and execution.
+     * @yields {@link IntentOrderStatusUpdate} at each execution stage.
+     * @throws If the order is missing required fields for resumption.
+     */
+    resume(order: Order, options: ResumeIntentOrderOptions): AsyncGenerator<IntentOrderStatusUpdate, void>;
     /**
      * Returns both the native token cost and the relayer fee for cancelling an
      * order. Use `relayerFee` to approve the ERC-20 spend before submitting.
@@ -8131,4 +8162,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, 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 IChain, type IConfig, type IEvmChain, type IEvmConfig, type IGetRequest, type IGetRequestMessage, type IGetResponse, type IGetResponseMessage, type IHyperbridgeConfig, type IIsmpMessage, type IMessage, type IPolkadotHubConfig, type IPostRequest, type IPostResponse, type IProof, type IRequestMessage, type ISubstrateConfig, type ITimeoutPostRequestMessage, IndexerClient, type IndexerQueryClient, IntentGateway, type IntentGatewayContext, type IntentGatewayParams, ABI$1 as IntentGatewayV2ABI, IntentOrderStatus, type IntentOrderStatusKey, type IntentOrderStatusUpdate, IntentsCoprocessor, 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, 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 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, 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 CancelEvent, type CancelOptions, type CancelQuote, type ChainConfig, type ChainConfigData, ChainConfigService, Chains, type ClientConfig, 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 IChain, type IConfig, type IEvmChain, type IEvmConfig, type IGetRequest, type IGetRequestMessage, type IGetResponse, type IGetResponseMessage, type IHyperbridgeConfig, type IIsmpMessage, type IMessage, type IPolkadotHubConfig, type IPostRequest, type IPostResponse, type IProof, type IRequestMessage, type ISubstrateConfig, type ITimeoutPostRequestMessage, IndexerClient, type IndexerQueryClient, IntentGateway, type IntentGatewayContext, type IntentGatewayParams, ABI$1 as IntentGatewayV2ABI, IntentOrderStatus, type IntentOrderStatusKey, type IntentOrderStatusUpdate, IntentsCoprocessor, 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, 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, polkadotAssetHubPaseo, postRequestCommitment, queryAssetTeleported, queryGetRequest, queryPostRequest, requestCommitmentKey, responseCommitmentKey, retryPromise, teleport, teleportDot, transformOrderForContract, tronChainIds, tronNile };