@riftresearch/sdk 0.12.2 → 0.13.0

package/README.md

@@ -67,3 +67,37 @@ console.log(`Swap ID: ${swap.swapId}`)
 const status = await sdk.getSwapStatus(swap.swapId)
 console.log(`Status: ${status.status}`)
 ```
+
+## Limit Orders
+
+You can place limit orders with a fixed price instead of using a market quote:
+
+```ts
+import { RiftSdk, Currencies } from '@riftresearch/sdk'
+import { createPublicClient, createWalletClient, http } from 'viem'
+import { base } from 'viem/chains'
+import { privateKeyToAccount } from 'viem/accounts'
+
+const account = privateKeyToAccount('0x...')
+const publicClient = createPublicClient({ chain: base, transport: http() })
+const walletClient = createWalletClient({ account, chain: base, transport: http() })
+
+const sdk = new RiftSdk({ integratorName: 'my-app' })
+
+const result = await sdk.createLimitOrder({
+  from: Currencies.Base.USDC,
+  to: Currencies.Bitcoin.BTC,
+  pricing: {
+    sellAmount: '1000000',   // 1 USDC (6 decimals)
+    buyAmount: '2500',       // 2500 sats
+  },
+  destinationAddress: 'bc1q...',
+  refundAddress: '0x...',
+  walletClient,
+  publicClient,
+  validUntil: Math.floor(Date.now() / 1000) + 3600, // optional: order expires in 1 hour
+})
+
+console.log(`Order ID: ${result.swapId}`)
+console.log(`Status: ${result.status}`)
+```

package/dist/index.d.ts

@@ -417,7 +417,8 @@ type CreateLimitOrderOptions<chain extends Chain2 | undefined = Chain2 | undefin
 	destinationAddress: string;
 	refundAddress?: string;
 	approvalMode?: "full" | "partial";
-	validForSeconds?: number;
+	/** Absolute Unix timestamp in UTC seconds when the limit order expires. Defaults to now + 1 year if not provided. */
+	validUntil?: number;
 };
 type ExecuteSwapOnExecuteStepCallback = (type: ExecuteSwapStepType) => void | Promise<void>;
 type ExecuteSwapContext<chain extends Chain2 | undefined = Chain2 | undefined> = {
@@ -483,6 +484,7 @@ declare class RiftSdk {
 	getQuote(params: QuoteParameters): Promise<GetQuoteResult>;
 	createLimitOrder<chain extends Chain3 | undefined = Chain3 | undefined>(options: CreateLimitOrderOptions<chain>): Promise<SwapResult>;
 	private assertPositiveIntegerString;
+	private assertValidLimitValidUntil;
 	private executeOrderFlow;
 	/**
 	* Execute a single step from the server's execution steps.

package/dist/index.js

@@ -255,6 +255,10 @@ function createClient(baseUrl) {
 var GAS_LIMIT_MULTIPLIER_NUMERATOR = 3n;
 var GAS_LIMIT_MULTIPLIER_DENOMINATOR = 2n;
 var GPV2_SETTLEMENT = "0x9008d19f58aabd9ed0d60971565aa8510560ab41";
+var DEFAULT_LIMIT_VALIDITY_WINDOW_SECONDS = 365 * 24 * 60 * 60;
+var MIN_LIMIT_VALIDITY_LEAD_TIME_SECONDS = 60;
+var MAX_LIMIT_VALIDITY_WINDOW_SECONDS = DEFAULT_LIMIT_VALIDITY_WINDOW_SECONDS;
+var MAX_COW_VALID_TO = 4294967295;
 
 class RiftSdk {
   riftClient;
@@ -369,8 +373,8 @@ class RiftSdk {
     }
     this.assertPositiveIntegerString(options.pricing.buyAmount, "pricing.buyAmount");
     this.assertPositiveIntegerString(options.pricing.sellAmount, "pricing.sellAmount");
-    if (options.validForSeconds !== undefined && (!Number.isInteger(options.validForSeconds) || options.validForSeconds <= 0)) {
-      throw new Error("validForSeconds must be a positive integer when provided");
+    if (options.validUntil !== undefined) {
+      this.assertValidLimitValidUntil(options.validUntil, "validUntil");
     }
     let refundAddress;
     let senderAddress;
@@ -431,7 +435,7 @@ class RiftSdk {
           destinationAddress: options.destinationAddress,
           refundAddress,
           ...options.approvalMode ? { approvalMode: options.approvalMode } : {},
-          ...typeof options.validForSeconds === "number" ? { validForSeconds: options.validForSeconds } : {},
+          ...typeof options.validUntil === "number" ? { validUntil: options.validUntil } : {},
           integratorName: this.integratorName
         };
         this.logDebug("creating limit order", {
@@ -450,6 +454,19 @@ class RiftSdk {
       throw new Error(`${field} must be greater than zero`);
     }
   }
+  assertValidLimitValidUntil(validUntil, field) {
+    if (!Number.isInteger(validUntil)) {
+      throw new Error(`${field} must be an integer when provided`);
+    }
+    if (validUntil > MAX_COW_VALID_TO) {
+      throw new Error(`${field} exceeds the maximum supported Unix timestamp`);
+    }
+    const nowSeconds = Math.floor(Date.now() / 1000);
+    const secondsUntilExpiry = validUntil - nowSeconds;
+    if (secondsUntilExpiry < MIN_LIMIT_VALIDITY_LEAD_TIME_SECONDS || secondsUntilExpiry > MAX_LIMIT_VALIDITY_WINDOW_SECONDS) {
+      throw new Error(`${field} must be between 60 seconds and 31536000 seconds in the future`);
+    }
+  }
   async executeOrderFlow(params) {
     const swapResponse = await params.createOrder();
     this.logDebug("order created", {

package/package.json

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