@riftresearch/sdk 0.2.1 → 0.2.3

package/README.md

@@ -68,7 +68,7 @@ const swap = await executeSwap()
 console.log(`Swap ID: ${swap.swapId}`) // API order ID
 
 // Check status
-const status = await sdk.getSwapStatus(swap.swapId)
+const status = await sdk.getOrderStatus(swap.swapId)
 console.log(`Status: ${status.status}`)
 ```
 

package/dist/index.d.ts

@@ -1,3 +1,9 @@
+/**
+* Core domain types for Rift Swap Router.
+* Shared between SDK and server packages.
+*/
+type Address = string;
+type TxHash = string;
 type U256 = string;
 type BitcoinChain = {
 	kind: "BITCOIN";
@@ -124,6 +130,10 @@ type QuoteResponse = ExactInputQuoteResponse | ExactOutputQuoteResponse;
 type OrderStatus = "waiting_for_deposit" | "deposit_confirming" | "initiating_transfer" | "confirming_transfer" | "swap_complete" | "refunding_user" | "failed";
 interface OrderStatusResponse {
 	status: OrderStatus;
+	destinationAddress: Address;
+	payoutTransaction?: TxHash;
+	depositTransaction?: TxHash;
+	quote: QuoteResponse;
 }
 /**
 * Execution actions - the mechanism by which a step is executed.
@@ -359,9 +369,9 @@ interface ExactOutputQuoteResult extends QuoteResultBase {
 type QuoteResult = ExactInputQuoteResult | ExactOutputQuoteResult;
 interface GetQuoteResult {
 	quote: QuoteResult;
-	executeSwap: () => Promise<SwapResult>;
+	executeSwap: () => Promise<OrderResult>;
 }
-interface SwapResult {
+interface OrderResult {
 	swapId: string;
 	status: SwapStatus2;
 	rift: RiftOrder;
@@ -402,12 +412,18 @@ interface RiftSdkOptions {
 	sendBitcoin: SendBitcoinFn;
 	/** Rift API URL. Defaults to production API */
 	apiUrl?: string;
+	/** Optional preflight checks before executing swaps */
+	preflight?: {
+		/** Check sender balance before executing EVM steps (default: true) */
+		checkBalances?: boolean;
+	};
 }
 declare class RiftSdk {
 	private riftClient;
 	private publicClient;
 	private walletClient;
 	private sendBitcoinFn;
+	private preflightCheckBalances;
 	constructor(options: RiftSdkOptions);
 	/**
 	* Get a quote for a swap and return a function to execute it.
@@ -440,12 +456,13 @@ declare class RiftSdk {
 	*/
 	private executeBtcTransferStep;
 	private buildQuoteResult;
-	private buildSwapResult;
+	private buildOrderResult;
+	private assertSufficientBalance;
 	private getAddress;
 	private getRefundAddress;
 	/**
-	* Get the current status of a swap by its ID.
+	* Get the current status of an order by its ID.
 	*/
-	getSwapStatus(swapId: string): Promise<SwapResult>;
+	getOrderStatus(orderId: string): Promise<OrderStatusResponse>;
 }
-export { getSupportedModes, detectRoute, createClient, TradeParameters, TokenIdentifier, SwapStatus2 as SwapStatus, SwapRoute, SwapResult, SupportedModes, SendBitcoinFn, RiftSdkOptions, RiftSdk, RiftOrder, RiftClient, QuoteResult, OrderResponse, NativeToken, GetQuoteResult, ExecutionStep, ExecutionAction, EvmChain, EvmCallStep, EvmCallKind, Erc20Token, Currency, Chain, CBBTC_ETHEREUM, CBBTC_BASE, BtcTransferStep, BtcTransferKind, BitcoinChain, BTC, App };
+export { getSupportedModes, detectRoute, createClient, TradeParameters, TokenIdentifier, SwapStatus2 as SwapStatus, SwapRoute, SupportedModes, SendBitcoinFn, RiftSdkOptions, RiftSdk, RiftOrder, RiftClient, QuoteResult, OrderResult, OrderResponse, NativeToken, GetQuoteResult, ExecutionStep, ExecutionAction, EvmChain, EvmCallStep, EvmCallKind, Erc20Token, Currency, Chain, CBBTC_ETHEREUM, CBBTC_BASE, BtcTransferStep, BtcTransferKind, BitcoinChain, BTC, App };

package/dist/index.js

@@ -157,6 +157,7 @@ class RiftSdk {
   publicClient;
   walletClient;
   sendBitcoinFn;
+  preflightCheckBalances;
   constructor(options) {
     this.riftClient = new SwapRouterClient({
       baseUrl: options.apiUrl ?? "https://router-api-v2-production.up.railway.app"
@@ -164,6 +165,7 @@ class RiftSdk {
     this.publicClient = options.publicClient;
     this.walletClient = options.walletClient;
     this.sendBitcoinFn = options.sendBitcoin;
+    this.preflightCheckBalances = options.preflight?.checkBalances !== false;
   }
   async getQuote(params) {
     const route = detectRoute(params.from, params.to);
@@ -181,6 +183,9 @@ class RiftSdk {
       quote,
       executeSwap: async () => {
         const refundAddress = params.refundAddress ?? this.getRefundAddress(params);
+        if (this.preflightCheckBalances) {
+          await this.assertSufficientBalance(params.from, quote.from.amount);
+        }
         const orderResponse = await this.riftClient.createOrder({
           id: riftQuote.id,
           destinationAddress: params.destinationAddress,
@@ -197,7 +202,7 @@ class RiftSdk {
           }
         }
         const swap = await this.riftClient.getOrder(orderResponse.swapId);
-        return this.buildSwapResult(swap, {
+        return this.buildOrderResult(swap, {
           chained: isChained,
           riftOrderId: orderResponse.swapId
         });
@@ -266,10 +271,10 @@ class RiftSdk {
       };
     }
   }
-  buildSwapResult(swap, options) {
+  buildOrderResult(swap, options) {
     const riftOrderId = options?.riftOrderId;
     if (!riftOrderId) {
-      throw new Error("Missing rift order id for swap result.");
+      throw new Error("Missing rift order id for order result.");
     }
     return {
       swapId: riftOrderId,
@@ -277,6 +282,28 @@ class RiftSdk {
       rift: swap
     };
   }
+  async assertSufficientBalance(currency, amount) {
+    if (currency.chain.kind !== "EVM")
+      return;
+    const required = BigInt(amount);
+    const owner = this.getAddress();
+    if (currency.token.kind === "NATIVE") {
+      const balance2 = await this.publicClient.getBalance({ address: owner });
+      if (balance2 < required) {
+        throw new Error(`Insufficient balance for native token. Need ${required.toString()}, have ${balance2.toString()}`);
+      }
+      return;
+    }
+    const balance = await this.publicClient.readContract({
+      address: currency.token.address,
+      abi: erc20Abi,
+      functionName: "balanceOf",
+      args: [owner]
+    });
+    if (balance < required) {
+      throw new Error(`Insufficient balance for token ${currency.token.address}. Need ${required.toString()}, have ${balance.toString()}`);
+    }
+  }
   getAddress() {
     const account = this.walletClient.account;
     if (!account) {
@@ -290,13 +317,8 @@ class RiftSdk {
     }
     return this.getAddress();
   }
-  async getSwapStatus(swapId) {
-    const rift = await this.riftClient.getOrder(swapId);
-    return {
-      swapId,
-      status: rift.status,
-      rift
-    };
+  async getOrderStatus(orderId) {
+    return this.riftClient.getOrder(orderId);
   }
 }
 export {

package/package.json

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