@riftresearch/sdk 0.2.3 → 0.3.0

package/README.md

@@ -2,43 +2,30 @@
 
 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'
+import { RiftSdk, Currencies, createCurrency } from '@riftresearch/sdk'
 import { createPublicClient, createWalletClient, http } from 'viem'
 import { privateKeyToAccount } from 'viem/accounts'
-import { base } from 'viem/chains'
+import { ethereum } from 'viem/chains'
 
-// Define USDC on Base
-const USDC_BASE: Currency = {
-  chain: { kind: 'EVM', chainId: 8453 },
-  token: {
-    kind: 'TOKEN',
-    address: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913',
-    decimals: 6,
-  },
-}
 
 // Setup viem clients
 const account = privateKeyToAccount('0x...')
-const publicClient = createPublicClient({ chain: base, transport: http() })
+const publicClient = createPublicClient({ chain: ethereum, transport: http(process.env.ETH_RPC) })
 const walletClient = createWalletClient({
   account,
-  chain: base,
-  transport: http(),
+  chain: ethereum,
+  transport: http(process.env.ETH_RPC),
 })
 
 // Initialize SDK
@@ -46,15 +33,22 @@ 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 })
   },
 })
 
+// Optionally create a custom ERC-20
+const ethereumPepe = createCurrency({
+  chainId: 1,
+  address: '0x6982508145454Ce325dDbE47a25d4ec3d2311933',
+  decimals: 18,
+})
+
 // Get a quote
 const { quote, executeSwap } = await sdk.getQuote({
-  from: USDC_BASE,
-  to: BTC,
+  from: Currencies.Ethereum.USDC,
+  to: Currencies.Bitcoin.BTC,
   amount: '100000000', // 100 USDC (6 decimals)
   mode: 'exact_input',
   destinationAddress: 'bc1q...',
@@ -71,13 +65,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

@@ -202,12 +202,31 @@ interface OrderResponse {
 	/** Ordered list of steps the client must execute */
 	executionSteps: ExecutionStep[];
 }
-/** Native BTC on Bitcoin */
-declare const BTC: Currency;
-/** cbBTC on Ethereum mainnet */
-declare const CBBTC_ETHEREUM: Currency;
-/** cbBTC on Base */
-declare const CBBTC_BASE: Currency;
+/** Create an ERC-20 currency on an EVM chain */
+declare function createCurrency(params: {
+	chainId: number;
+	address: string;
+	decimals: number;
+}): Currency;
+declare const Currencies: {
+	Bitcoin: {
+		BTC: Currency;
+	};
+	Ethereum: {
+		ETH: Currency;
+		WETH: Currency;
+		USDC: Currency;
+		USDT: Currency;
+		CBBTC: Currency;
+		WBTC: Currency;
+	};
+	Base: {
+		ETH: Currency;
+		WETH: Currency;
+		USDC: Currency;
+		CBBTC: Currency;
+	};
+};
 import { treaty } from "@elysiajs/eden";
 import { Elysia } from "elysia";
 declare const app: Elysia;
@@ -430,8 +449,8 @@ declare class RiftSdk {
 	*
 	* @example
 	* const { quote, executeSwap } = await sdk.getQuote({
-	*   from: CBBTC_BASE,
-	*   to: BTC,
+	*   from: Currencies.Base.CBBTC,
+	*   to: Currencies.Bitcoin.BTC,
 	*   amount: '100000000', // 1 cbBTC
 	*   mode: 'exact_input',
 	*   destinationAddress: 'bc1q...',
@@ -460,9 +479,11 @@ declare class RiftSdk {
 	private assertSufficientBalance;
 	private getAddress;
 	private getRefundAddress;
+	private assertEvmChainMatch;
+	private assertEvmChainMatchForSteps;
 	/**
 	* Get the current status of an order by its ID.
 	*/
 	getOrderStatus(orderId: string): Promise<OrderStatusResponse>;
 }
-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 };
+export { getSupportedModes, detectRoute, createCurrency, 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, Currencies, Chain, BtcTransferStep, BtcTransferKind, BitcoinChain, App };

package/dist/index.js

@@ -17,17 +17,73 @@ var CBBTC_TOKEN = {
   address: CBBTC_ADDRESS,
   decimals: 8
 };
-var BTC = {
-  chain: BTC_CHAIN,
-  token: { kind: "NATIVE", decimals: 8 }
-};
-var CBBTC_ETHEREUM = {
-  chain: ETH_CHAIN,
-  token: CBBTC_TOKEN
-};
-var CBBTC_BASE = {
-  chain: BASE_CHAIN,
-  token: CBBTC_TOKEN
+function createCurrency(params) {
+  return {
+    chain: { kind: "EVM", chainId: params.chainId },
+    token: {
+      kind: "TOKEN",
+      address: params.address,
+      decimals: params.decimals
+    }
+  };
+}
+var Currencies = {
+  Bitcoin: {
+    BTC: {
+      chain: BTC_CHAIN,
+      token: { kind: "NATIVE", decimals: 8 }
+    }
+  },
+  Ethereum: {
+    ETH: {
+      chain: ETH_CHAIN,
+      token: { kind: "NATIVE", decimals: 18 }
+    },
+    WETH: createCurrency({
+      chainId: 1,
+      address: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
+      decimals: 18
+    }),
+    USDC: createCurrency({
+      chainId: 1,
+      address: "0xA0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
+      decimals: 6
+    }),
+    USDT: createCurrency({
+      chainId: 1,
+      address: "0xdAC17F958D2ee523a2206206994597C13D831ec7",
+      decimals: 6
+    }),
+    CBBTC: {
+      chain: ETH_CHAIN,
+      token: CBBTC_TOKEN
+    },
+    WBTC: createCurrency({
+      chainId: 1,
+      address: "0x2260FAC5E5542a773Aa44fBCfeDf7C193bc2C599",
+      decimals: 8
+    })
+  },
+  Base: {
+    ETH: {
+      chain: BASE_CHAIN,
+      token: { kind: "NATIVE", decimals: 18 }
+    },
+    WETH: createCurrency({
+      chainId: 8453,
+      address: "0x4200000000000000000000000000000000000006",
+      decimals: 18
+    }),
+    USDC: createCurrency({
+      chainId: 8453,
+      address: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
+      decimals: 6
+    }),
+    CBBTC: {
+      chain: BASE_CHAIN,
+      token: CBBTC_TOKEN
+    }
+  }
 };
 // src/apiClient.ts
 class SwapRouterApiError extends Error {
@@ -192,6 +248,7 @@ class RiftSdk {
           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) {
@@ -285,6 +342,7 @@ class RiftSdk {
   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") {
@@ -317,6 +375,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);
   }
@@ -324,9 +411,8 @@ class RiftSdk {
 export {
   getSupportedModes,
   detectRoute,
+  createCurrency,
   createClient,
   RiftSdk,
-  CBBTC_ETHEREUM,
-  CBBTC_BASE,
-  BTC
+  Currencies
 };

package/package.json

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