@riftresearch/sdk 0.9.0 → 0.11.0

package/dist/index.d.ts

@@ -57,7 +57,6 @@ interface CalculatedInputAmount {
 	/** Maximum input required after slippage (optional - not all routes provide this) */
 	maximum?: U256;
 }
-type QuoteQuality = "fast" | "optimal";
 /**
 * A single fee component with amount in native currency and USD equivalent.
 */
@@ -175,6 +174,8 @@ interface EvmCallStep {
 	spenderAddress?: string;
 	/** Amount for display/verification (for approval, transfer_evm) */
 	amount?: U256;
+	/** DEX execution venue label (for dex_swap, e.g. "spandex.paraswap") */
+	venue?: string;
 }
 /**
 * BTC Transfer step - send Bitcoin to an address.
@@ -296,8 +297,6 @@ interface QuoteParameters {
 	* `minimum`/`maximum` bounds; direct OTC routes may ignore it.
 	*/
 	slippageBps: number;
-	/** Optional DEX quote quality target for DEX-backed routes. */
-	quoteQuality?: QuoteQuality;
 	/**
 	* Approval amount strategy for ERC20 swaps.
 	* - "full" (default): approve max uint256
@@ -455,6 +454,8 @@ declare class RiftSdk {
 	private executeBtcTransferStep;
 	private buildQuoteResult;
 	private buildSwapResult;
+	private buildDexSwapRevertMessage;
+	private resolveDexVenueLabel;
 	private assertSufficientBalance;
 	private getAddress;
 	private getRefundAddress;
@@ -469,4 +470,4 @@ declare class RiftSdk {
 	getSwapStatus(swapId: string): Promise<SwapStatusResponse>;
 }
 declare function createRiftSdk(options: RiftSdkOptions): RiftSdk;
-export { getSupportedModes, detectRoute, createRiftSdk, createCurrency, TokenIdentifier, SwapStatus, SwapRouterApiError, SwapRoute, SwapResult, SwapResponse, SupportedModes, SendBitcoinFn, RiftSwap, RiftSdkOptions, RiftSdk, QuoteResult, QuoteQuality, QuoteParameters, NativeToken, GetQuoteResult, ExecutionStep, ExecutionAction, ExecuteSwapStepType, ExecuteSwapOptions, ExecuteSwapOnExecuteStepCallback, EvmChain, EvmCallStep, EvmCallKind, Erc20Token, Currency, Currencies, Chain, BtcTransferStep, BtcTransferKind, BitcoinChain };
+export { getSupportedModes, detectRoute, createRiftSdk, createCurrency, TokenIdentifier, SwapStatus, SwapRouterApiError, SwapRoute, SwapResult, SwapResponse, SupportedModes, SendBitcoinFn, RiftSwap, RiftSdkOptions, RiftSdk, QuoteResult, QuoteParameters, NativeToken, GetQuoteResult, ExecutionStep, ExecutionAction, ExecuteSwapStepType, ExecuteSwapOptions, ExecuteSwapOnExecuteStepCallback, EvmChain, EvmCallStep, EvmCallKind, Erc20Token, Currency, Currencies, Chain, BtcTransferStep, BtcTransferKind, BitcoinChain };

package/dist/index.js

@@ -218,8 +218,7 @@ class RiftSdk {
       from: params.from,
       to: params.to,
       amount: params.amount,
-      slippageBps: params.slippageBps,
-      quoteQuality: params.quoteQuality
+      slippageBps: params.slippageBps
     };
     const riftQuote = this.unwrapEdenResult(await this.riftClient.quote.post(quoteRequest));
     const quote = this.buildQuoteResult(riftQuote, params);
@@ -268,7 +267,7 @@ class RiftSdk {
             kind: "kind" in step ? step.kind : undefined,
             chainId: "chainId" in step ? step.chainId : undefined
           });
-          const result = await this.executeStep(step, context, swapResponse.swapId);
+          const result = await this.executeStep(step, context, swapResponse.swapId, route);
           this.logDebug("step completed", {
             stepId: step.id,
             txHash: result.txHash
@@ -300,15 +299,15 @@ class RiftSdk {
       }
     };
   }
-  async executeStep(step, context, swapId) {
+  async executeStep(step, context, swapId, route) {
     switch (step.action) {
       case "evm_call":
-        return this.executeEvmCallStep(step, context, swapId);
+        return this.executeEvmCallStep(step, context, swapId, route);
       case "btc_transfer":
         return this.executeBtcTransferStep(step, context);
     }
   }
-  async executeEvmCallStep(step, context, swapId) {
+  async executeEvmCallStep(step, context, swapId, route) {
     const walletClient = this.requireWalletClient(context);
     const publicClient = this.requirePublicClient(context);
     const account = walletClient.account;
@@ -345,26 +344,30 @@ class RiftSdk {
         stepId: effectiveStep.id,
         error: estimateError instanceof Error ? estimateError.message : String(estimateError)
       });
-      let refreshed;
       try {
-        refreshed = this.unwrapEdenResult(await this.riftClient.swap({ swapId })["refresh-step"].post({ stepId: effectiveStep.id }));
-      } catch (refreshError) {
-        throw new Error(`estimateGas failed for dex_swap step and refresh-step failed: ${refreshError instanceof Error ? refreshError.message : String(refreshError)}`);
-      }
-      if (!refreshed?.step) {
-        throw new Error("estimateGas failed for dex_swap step and refresh-step returned no step");
-      }
-      if (refreshed.step.kind !== "dex_swap") {
-        throw new Error(`refresh-step returned unexpected step kind: ${refreshed.step.kind}`);
+        const refreshed = this.unwrapEdenResult(await this.riftClient.swap({ swapId })["refresh-step"].post({ stepId: effectiveStep.id }));
+        if (!refreshed?.step) {
+          throw new Error("estimateGas failed for dex_swap step and refresh-step returned no step");
+        }
+        if (refreshed.step.kind !== "dex_swap") {
+          throw new Error(`refresh-step returned unexpected step kind: ${refreshed.step.kind}`);
+        }
+        effectiveStep = refreshed.step;
+        txRequest = {
+          account,
+          to: effectiveStep.to,
+          data: effectiveStep.calldata,
+          value: effectiveStep.value ? BigInt(effectiveStep.value) : undefined
+        };
+        estimatedGas = await publicClient.estimateGas(txRequest);
+      } catch (retrySimulationError) {
+        this.logDebug("dex_swap simulation failed after refresh-step attempt", {
+          swapId,
+          stepId: effectiveStep.id,
+          error: retrySimulationError instanceof Error ? retrySimulationError.message : String(retrySimulationError)
+        });
+        throw new Error(this.buildDexSwapRevertMessage(route, effectiveStep.venue));
       }
-      effectiveStep = refreshed.step;
-      txRequest = {
-        account,
-        to: effectiveStep.to,
-        data: effectiveStep.calldata,
-        value: effectiveStep.value ? BigInt(effectiveStep.value) : undefined
-      };
-      estimatedGas = await publicClient.estimateGas(txRequest);
     }
     const gasLimit = (estimatedGas * GAS_LIMIT_MULTIPLIER_NUMERATOR + GAS_LIMIT_MULTIPLIER_DENOMINATOR - 1n) / GAS_LIMIT_MULTIPLIER_DENOMINATOR;
     this.logDebug("using buffered gas limit", {
@@ -381,6 +384,9 @@ class RiftSdk {
       hash: txHash
     });
     if (receipt.status !== "success") {
+      if (effectiveStep.kind === "dex_swap") {
+        throw new Error(this.buildDexSwapRevertMessage(route, effectiveStep.venue, txHash));
+      }
       throw new Error(`EVM step transaction reverted (${effectiveStep.kind}) with hash ${txHash}`);
     }
     return { txHash };
@@ -426,6 +432,17 @@ class RiftSdk {
       rift: swap
     };
   }
+  buildDexSwapRevertMessage(route, venue, txHash) {
+    const venueLabel = this.resolveDexVenueLabel(venue);
+    const baseMessage = route?.type === "dex_then_rift" ? `The pre-swap into cbBTC failed on ${venueLabel}; consider increasing slippage tolerance.` : `The DEX swap failed on ${venueLabel}; consider increasing slippage tolerance.`;
+    return txHash ? `${baseMessage} Transaction hash: ${txHash}` : baseMessage;
+  }
+  resolveDexVenueLabel(venue) {
+    if (typeof venue !== "string")
+      return "the selected venue";
+    const trimmed = venue.trim();
+    return trimmed.length > 0 ? trimmed : "the selected venue";
+  }
   async assertSufficientBalance(currency, amount, context) {
     if (currency.chain.kind !== "EVM")
       return;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@riftresearch/sdk",
-	"version": "0.9.0",
+	"version": "0.11.0",
 	"description": "SDK for swapping between bitcoin and evm chains",
 	"license": "MIT",
 	"files": [