@riftresearch/sdk 0.2.2 → 0.2.4

package/README.md

@@ -2,19 +2,15 @@
 
 SDK for swapping between Bitcoin and EVM chains.
 
-## Installation
+## Quickstart
+
+Install the SDK:
 
 ```bash
 npm install @riftresearch/sdk
-# or
-pnpm add @riftresearch/sdk
-# or
-yarn add @riftresearch/sdk
-# or
-bun add @riftresearch/sdk
 ```
 
-## Quickstart
+Then use it:
 
 ```ts
 import { RiftSdk, BTC, type Currency } from '@riftresearch/sdk'
@@ -46,8 +42,8 @@ const sdk = new RiftSdk({
   publicClient,
   walletClient,
   sendBitcoin: async ({ recipient, amountSats }) => {
-    // Only needed for BTC -> ERC20 swaps
-    throw new Error('Not implemented')
+    // Implement your Bitcoin wallet connection, e.g.:
+    // window.bitcoin.transfer({ recipient, amountSats })
   },
 })
 
@@ -71,13 +67,3 @@ console.log(`Swap ID: ${swap.swapId}`) // API order ID
 const status = await sdk.getOrderStatus(swap.swapId)
 console.log(`Status: ${status.status}`)
 ```
-
-## Build & Publish
-
-The SDK uses **bunup**.
-
-- Build: `bun run --filter '@riftresearch/sdk' build`
-- Publish (from repo root): `bun run publish:sdk`
-- Release (version bump + build + publish): `bun run release:sdk`
-
-The `dist/` directory is what gets published to npm.

package/dist/index.d.ts

@@ -412,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.
@@ -451,8 +457,11 @@ declare class RiftSdk {
 	private executeBtcTransferStep;
 	private buildQuoteResult;
 	private buildOrderResult;
+	private assertSufficientBalance;
 	private getAddress;
 	private getRefundAddress;
+	private assertEvmChainMatch;
+	private assertEvmChainMatchForSteps;
 	/**
 	* Get the current status of an order by its ID.
 	*/

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,12 +183,16 @@ 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,
           refundAddress,
           approvalMode: params.approvalMode
         });
+        this.assertEvmChainMatchForSteps(orderResponse.executionSteps);
         for (const step of orderResponse.executionSteps) {
           const result = await this.executeStep(step);
           if (isMonochain && step.action === "evm_call" && step.kind === "oneinch_swap" && result.txHash) {
@@ -277,6 +283,29 @@ class RiftSdk {
       rift: swap
     };
   }
+  async assertSufficientBalance(currency, amount) {
+    if (currency.chain.kind !== "EVM")
+      return;
+    this.assertEvmChainMatch(currency.chain.chainId);
+    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,6 +319,35 @@ class RiftSdk {
     }
     return this.getAddress();
   }
+  assertEvmChainMatch(expectedChainId) {
+    const walletChainId = this.walletClient.chain?.id;
+    if (!walletChainId) {
+      throw new Error("Wallet client is missing an EVM chain configuration");
+    }
+    if (walletChainId !== expectedChainId) {
+      throw new Error(`Wallet client chain mismatch. Expected ${expectedChainId}, got ${walletChainId}`);
+    }
+    const publicChainId = this.publicClient.chain?.id;
+    if (!publicChainId) {
+      throw new Error("Public client is missing an EVM chain configuration");
+    }
+    if (publicChainId !== expectedChainId) {
+      throw new Error(`Public client chain mismatch. Expected ${expectedChainId}, got ${publicChainId}`);
+    }
+  }
+  assertEvmChainMatchForSteps(steps) {
+    const evmSteps = steps.filter((step) => step.action === "evm_call");
+    const firstStep = evmSteps[0];
+    if (!firstStep)
+      return;
+    const expectedChainId = firstStep.chainId;
+    for (const step of evmSteps) {
+      if (step.chainId !== expectedChainId) {
+        throw new Error(`Mixed EVM chain IDs in execution steps. Expected ${expectedChainId}, got ${step.chainId}`);
+      }
+    }
+    this.assertEvmChainMatch(expectedChainId);
+  }
   async getOrderStatus(orderId) {
     return this.riftClient.getOrder(orderId);
   }

package/package.json

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