@sodax/sdk 1.0.1-beta → 1.0.2-beta

package/dist/index.mjs

@@ -12907,7 +12907,8 @@ var SwapService = class {
     intentParams: params,
     spokeProvider,
     fee = this.config.partnerFee,
-    raw
+    raw,
+    skipSimulation = false
   }) {
     invariant6(
       this.configService.isValidOriginalAssetAddress(params.srcChain, params.inputToken),
@@ -12976,7 +12977,8 @@ var SwapService = class {
           },
           spokeProvider,
           this.hubProvider,
-          raw
+          raw,
+          skipSimulation
         );
         return {
           ok: true,
@@ -12996,6 +12998,179 @@ var SwapService = class {
       };
     }
   }
+  /**
+   * Creates a limit order intent (no deadline, must be cancelled manually by user).
+   * Similar to swap but enforces deadline=0n (no deadline).
+   * Limit orders remain active until manually cancelled by the user.
+   *
+   * @param {Prettify<LimitOrderParams<S> & OptionalTimeout>} params - Object containing:
+   *   - intentParams: The parameters for creating the limit order (deadline is automatically set to 0n, deadline field should be omitted).
+   *   - spokeProvider: The spoke provider instance.
+   *   - fee: (Optional) Partner fee configuration.
+   *   - timeout: (Optional) Timeout in milliseconds for the transaction (default: 60 seconds).
+   *   - skipSimulation: (Optional) Whether to skip transaction simulation (default: false).
+   * @returns {Promise<Result<[SolverExecutionResponse, Intent, IntentDeliveryInfo], IntentError<IntentErrorCode>>>} A promise resolving to a Result containing a tuple of SolverExecutionResponse, Intent, and intent delivery info, or an IntentError if the operation fails.
+   *
+   * @example
+   * const payload = {
+   *     "inputToken": "0x2170Ed0880ac9A755fd29B2688956BD959F933F8", // BSC ETH token address
+   *     "outputToken": "0x2f2a2543B76A4166549F7aaB2e75Bef0aefC5B0f", // ARB WBTC token address
+   *     "inputAmount": 1000000000000000n, // The amount of input tokens
+   *     "minOutputAmount": 900000000000000n, // min amount you are expecting to receive
+   *     // deadline is omitted - will be automatically set to 0n
+   *     "allowPartialFill": false, // Whether the intent can be partially filled
+   *     "srcChain": "0x38.bsc", // Chain ID where input tokens originate
+   *     "dstChain": "0xa4b1.arbitrum", // Chain ID where output tokens should be delivered
+   *     "srcAddress": "0x..", // Source address (original address on spoke chain)
+   *     "dstAddress": "0x...", // Destination address (original address on spoke chain)
+   *     "solver": "0x..", // Optional specific solver address (address(0) = any solver)
+   *     "data": "0x..", // Additional arbitrary data
+   * } satisfies CreateLimitOrderParams;
+   *
+   * const createLimitOrderResult = await swapService.createLimitOrder({
+   *   intentParams: payload,
+   *   spokeProvider,
+   *   fee, // optional
+   *   timeout, // optional
+   * });
+   *
+   * if (createLimitOrderResult.ok) {
+   *   const [solverExecutionResponse, intent, intentDeliveryInfo] = createLimitOrderResult.value;
+   *   console.log('Intent execution response:', solverExecutionResponse);
+   *   console.log('Intent:', intent);
+   *   console.log('Intent delivery info:', intentDeliveryInfo);
+   *   // Limit order is now active and will remain until cancelled manually
+   * } else {
+   *   // handle error
+   * }
+   */
+  async createLimitOrder({
+    intentParams: params,
+    spokeProvider,
+    fee = this.config.partnerFee,
+    timeout = DEFAULT_RELAY_TX_TIMEOUT,
+    skipSimulation = false
+  }) {
+    const limitOrderParams = {
+      ...params,
+      deadline: 0n
+    };
+    return this.createAndSubmitIntent({
+      intentParams: limitOrderParams,
+      spokeProvider,
+      fee,
+      timeout,
+      skipSimulation
+    });
+  }
+  /**
+   * Creates a limit order intent (no deadline, must be cancelled manually by user).
+   * Similar to createIntent but enforces deadline=0n (no deadline) and uses LimitOrderParams.
+   * Limit orders remain active until manually cancelled by the user.
+   * NOTE: This method does not submit the intent to the Solver API
+   *
+   * @param {Prettify<LimitOrderParams<S> & OptionalRaw<R>>} params - Object containing:
+   *   - intentParams: The parameters for creating the limit order (deadline is automatically set to 0n, deadline field should be omitted).
+   *   - spokeProvider: The spoke provider instance.
+   *   - fee: (Optional) Partner fee configuration.
+   *   - raw: (Optional) Whether to return the raw transaction data instead of executing it
+   *   - skipSimulation: (Optional) Whether to skip transaction simulation (default: false).
+   * @returns {Promise<Result<[TxReturnType<S, R>, Intent & FeeAmount, Hex], IntentError<'CREATION_FAILED'>>>} The encoded contract call or raw transaction data, Intent and intent data as hex
+   *
+   * @example
+   * const payload = {
+   *     "inputToken": "0x2170Ed0880ac9A755fd29B2688956BD959F933F8", // BSC ETH token address
+   *     "outputToken": "0x2f2a2543B76A4166549F7aaB2e75Bef0aefC5B0f", // ARB WBTC token address
+   *     "inputAmount": 1000000000000000n, // The amount of input tokens
+   *     "minOutputAmount": 900000000000000n, // min amount you are expecting to receive
+   *     // deadline is omitted - will be automatically set to 0n
+   *     "allowPartialFill": false, // Whether the intent can be partially filled
+   *     "srcChain": "0x38.bsc", // Chain ID where input tokens originate
+   *     "dstChain": "0xa4b1.arbitrum", // Chain ID where output tokens should be delivered
+   *     "srcAddress": "0x..", // Source address (original address on spoke chain)
+   *     "dstAddress": "0x...", // Destination address (original address on spoke chain)
+   *     "solver": "0x..", // Optional specific solver address (address(0) = any solver)
+   *     "data": "0x..", // Additional arbitrary data
+   * } satisfies CreateLimitOrderParams;
+   *
+   * const createLimitOrderIntentResult = await swapService.createLimitOrderIntent({
+   *   intentParams: payload,
+   *   spokeProvider,
+   *   fee, // optional
+   *   raw, // optional
+   * });
+   *
+   * if (createLimitOrderIntentResult.ok) {
+   *   const [txResult, intent, intentData] = createLimitOrderIntentResult.value;
+   *   console.log('Transaction result:', txResult);
+   *   console.log('Intent:', intent);
+   *   console.log('Intent data:', intentData);
+   * } else {
+   *   // handle error
+   * }
+   */
+  async createLimitOrderIntent({
+    intentParams: params,
+    spokeProvider,
+    fee = this.config.partnerFee,
+    raw,
+    skipSimulation = false
+  }) {
+    const limitOrderParams = {
+      ...params,
+      deadline: 0n
+    };
+    return this.createIntent({
+      intentParams: limitOrderParams,
+      spokeProvider,
+      fee,
+      raw,
+      skipSimulation
+    });
+  }
+  /**
+   * Syntactic sugar for cancelAndSubmitIntent: cancels a limit order intent and submits it to the Relayer API.
+   * Similar to swap function that wraps createAndSubmitIntent.
+   *
+   * @param params - Object containing:
+   * @param params.intent - The limit order intent to cancel.
+   * @param params.spokeProvider - The spoke provider instance.
+   * @param params.timeout - (Optional) Timeout in milliseconds for the transaction (default: 60 seconds).
+   * @returns
+   *   A promise resolving to a Result containing a tuple of cancel transaction hash and destination transaction hash,
+   *   or an IntentError if the operation fails.
+   *
+   * @example
+   * // Get intent first (or use intent from createLimitOrder response)
+   * const intent: Intent = await swapService.getIntent(txHash);
+   *
+   * // Cancel the limit order
+   * const result = await swapService.cancelLimitOrder({
+   *   intent,
+   *   spokeProvider,
+   *   timeout, // optional
+   * });
+   *
+   * if (result.ok) {
+   *   const [cancelTxHash, dstTxHash] = result.value;
+   *   console.log('Cancel transaction hash:', cancelTxHash);
+   *   console.log('Destination transaction hash:', dstTxHash);
+   * } else {
+   *   // handle error
+   *   console.error('[cancelLimitOrder] error:', result.error);
+   * }
+   */
+  async cancelLimitOrder({
+    intent,
+    spokeProvider,
+    timeout = DEFAULT_RELAY_TX_TIMEOUT
+  }) {
+    return this.cancelAndSubmitIntent({
+      intent,
+      spokeProvider,
+      timeout
+    });
+  }
   /**
    * Cancels an intent
    * @param {Intent} intent - The intent to cancel
@@ -13037,7 +13212,97 @@ var SwapService = class {
     } catch (error) {
       return {
         ok: false,
-        error
+        error: {
+          code: "CANCEL_FAILED",
+          data: {
+            payload: intent,
+            error
+          }
+        }
+      };
+    }
+  }
+  /**
+   * Cancels an intent on the spoke chain, submits the cancel intent to the relayer API,
+   * and waits until the intent cancel is executed (on the destination/hub chain).
+   * Follows a similar workflow to createAndSubmitIntent, but for cancelling.
+   *
+   * @param params - The parameters for canceling and submitting the intent.
+   * @param params.intent - The intent to be canceled.
+   * @param params.spokeProvider - The provider for the spoke chain.
+   * @param params.timeout - Optional timeout in milliseconds (default: 60 seconds).
+   * @returns
+   *   A Result containing the SolverExecutionResponse (cancel tx), intent, and relay info,
+   *   or an IntentError on failure.
+   */
+  async cancelAndSubmitIntent({
+    intent,
+    spokeProvider,
+    timeout = DEFAULT_RELAY_TX_TIMEOUT
+  }) {
+    try {
+      const cancelResult = await this.cancelIntent(intent, spokeProvider, false);
+      if (!cancelResult.ok) {
+        return cancelResult;
+      }
+      const cancelTxHash = cancelResult.value;
+      const verifyTxHashResult = await SpokeService.verifyTxHash(cancelTxHash, spokeProvider);
+      if (!verifyTxHashResult.ok) {
+        return {
+          ok: false,
+          error: {
+            code: "CANCEL_FAILED",
+            data: {
+              payload: intent,
+              error: verifyTxHashResult.error
+            }
+          }
+        };
+      }
+      let dstIntentTxHash;
+      if (spokeProvider.chainConfig.chain.id !== this.hubProvider.chainConfig.chain.id) {
+        const intentRelayChainId = intent.srcChain.toString();
+        const submitPayload = {
+          action: "submit",
+          params: {
+            chain_id: intentRelayChainId,
+            tx_hash: cancelTxHash
+          }
+        };
+        const submitResult = await this.submitIntent(submitPayload);
+        if (!submitResult.ok) {
+          return submitResult;
+        }
+        const packet = await waitUntilIntentExecuted({
+          intentRelayChainId,
+          spokeTxHash: cancelTxHash,
+          timeout,
+          apiUrl: this.config.relayerApiEndpoint
+        });
+        if (!packet.ok) {
+          return {
+            ok: false,
+            error: packet.error
+          };
+        }
+        dstIntentTxHash = packet.value.dst_tx_hash;
+      } else {
+        dstIntentTxHash = cancelTxHash;
+      }
+      return {
+        ok: true,
+        value: [cancelTxHash, dstIntentTxHash]
+      };
+    } catch (error) {
+      return {
+        ok: false,
+        error: {
+          code: "CANCEL_FAILED",
+          data: {
+            payload: intent,
+            error
+          }
+        }
       };
     }
   }
@@ -15678,6 +15943,29 @@ var BackendApiService = class {
     const endpoint = `/solver/orderbook?${queryString}`;
     return this.makeRequest(endpoint, { method: "GET" });
   }
+  /**
+   * Get all intents created by a specific user address with optional filters.
+   *
+   * @param params - Options to filter the user intents.
+   * @param params.userAddress - The user's wallet address on the hub chain (required).
+   * @param params.startDate - Optional. Start timestamp in milliseconds (number, required if filtering by date).
+   * @param params.endDate - Optional. End timestamp in milliseconds (number, required if filtering by date).
+   * @param params.limit - Optional. Max number of results (string).
+   * @param params.offset - Optional. Pagination offset (string).
+   *
+   * @returns {Promise<UserIntentsResponse>} Promise resolving to an array of intent responses for the user.
+   */
+  async getUserIntents(params) {
+    const { userAddress, startDate, endDate, limit, offset } = params;
+    const queryParams = new URLSearchParams();
+    if (startDate) queryParams.append("startDate", new Date(startDate).toISOString());
+    if (endDate) queryParams.append("endDate", new Date(endDate).toISOString());
+    if (limit) queryParams.append("limit", limit);
+    if (offset) queryParams.append("offset", offset);
+    const queryString = queryParams.toString();
+    const endpoint = queryString.length > 0 ? `/intent/user/${userAddress}?${queryString}` : `/intent/user/${userAddress}`;
+    return this.makeRequest(endpoint, { method: "GET" });
+  }
   // Money Market endpoints
   /**
    * Get money market position for a specific user
@@ -17154,7 +17442,13 @@ var StakingService = class {
         spokeProvider,
         this.hubProvider
       );
-      const data = this.buildUnstakeData(hubWallet, params);
+      const xSoda = this.hubProvider.chainConfig.addresses.xSoda;
+      const underlyingSodaAmount = await StakingLogic.convertXSodaSharesToSoda(
+        xSoda,
+        params.amount,
+        this.hubProvider.publicClient
+      );
+      const data = this.buildUnstakeData(hubWallet, params, xSoda, underlyingSodaAmount);
       let txResult;
       if (isHub) {
         txResult = await SpokeService.deposit(
@@ -17197,13 +17491,12 @@ var StakingService = class {
    * @param params - The unstake parameters
    * @returns The encoded contract call data
    */
-  buildUnstakeData(hubWallet, params) {
+  buildUnstakeData(hubWallet, params, xSoda, underlyingSodaAmount) {
     const hubConfig = getHubChainConfig();
     const stakedSoda = hubConfig.addresses.stakedSoda;
-    const xSoda = hubConfig.addresses.xSoda;
     const calls = [];
     calls.push(StakingLogic.encodeXSodaRedeem(xSoda, params.amount, hubWallet, hubWallet));
-    calls.push(StakingLogic.encodeUnstake(stakedSoda, hubWallet, params.amount));
+    calls.push(StakingLogic.encodeUnstake(stakedSoda, hubWallet, underlyingSodaAmount));
     return encodeContractCalls(calls);
   }
   /**