@riftresearch/sdk 0.16.0 → 0.17.0

package/README.md

@@ -64,8 +64,19 @@ const swap = await executeSwap({
 console.log(`Order ID: ${swap.orderId}`)
 
 // Check status
-const status = await sdk.getSwapStatus(swap.orderId)
+const status = await sdk.getOrderStatus(swap.orderId)
 console.log(`Status: ${status.status}`)
+
+// List orders with filters and cursor pagination
+const page = await sdk.getOrders({
+  sender: '0x1234...',
+  status: 'unfilled',
+  orderType: 'limit',
+  limit: 20,
+})
+
+console.log(`Fetched ${page.items.length} orders`)
+console.log(`Next cursor: ${page.nextCursor}`)
 ```
 
 ## Limit Orders

package/dist/index.d.ts

@@ -184,6 +184,10 @@ interface AnalyticsOrderResponse {
 	lastSourceUpdateAt: string | null;
 	terminalAt: string | null;
 }
+interface AnalyticsOrdersResponse {
+	items: AnalyticsOrderResponse[];
+	nextCursor: string | null;
+}
 interface ErrorResponse {
 	error: string;
 }
@@ -366,6 +370,8 @@ import { Chain as Chain3 } from "viem";
 import { Account, PublicClient, Transport, WalletClient } from "viem";
 import { Chain as Chain2 } from "viem/chains";
 type RiftSwap = AnalyticsOrderResponse;
+type RiftOrdersPage = AnalyticsOrdersResponse;
+type OrderTypeFilter = "market" | "limit";
 interface QuoteParameters {
 	/** The currency to swap from */
 	from: Currency;
@@ -434,6 +440,22 @@ interface SwapResult {
 	status: AnalyticsOrderStatus;
 	rift: RiftSwap;
 }
+interface GetOrdersOptions {
+	/** Filter by exact sender address */
+	sender?: string;
+	/** Filter by exact destination address */
+	destination?: string;
+	/** Filter by exact refund address */
+	refund?: string;
+	/** Filter by execution type */
+	orderType?: OrderTypeFilter;
+	/** Filter by coarse public order status */
+	status?: AnalyticsOrderStatus;
+	/** Page size. The API clamps this between 1 and 100, defaulting to 50. */
+	limit?: number;
+	/** Opaque cursor returned by a previous getOrders() response */
+	cursor?: string;
+}
 type CancelOrderResult = CancelOrderResponse;
 /**
 * Function type for sending Bitcoin.
@@ -585,8 +607,17 @@ declare class RiftSdk {
 	/**
 	* Get the current status of an order by its ID.
 	*/
+	getOrderStatus(orderId: string): Promise<AnalyticsOrderResponse>;
+	/**
+	* @deprecated Use getOrderStatus() instead.
+	*/
 	getSwapStatus(orderId: string): Promise<AnalyticsOrderResponse>;
 	/**
+	* List orders through the public `/orders` endpoint with the same filters
+	* exposed by the swap-router OpenAPI documentation.
+	*/
+	getOrders(options?: GetOrdersOptions): Promise<RiftOrdersPage>;
+	/**
 	* Cancel a supported limit order through the swap router.
 	*
 	* The SDK first requests the backend-specific typed-data payload from the
@@ -596,4 +627,4 @@ declare class RiftSdk {
 	cancelOrder<chain extends Chain3 | undefined = Chain3 | undefined>(options: CancelOrderOptions<chain>): Promise<CancelOrderResult>;
 }
 declare function createRiftSdk(options: RiftSdkOptions): RiftSdk;
-export { getSupportedModes, detectRoute, createRiftSdk, createCurrency, TokenIdentifier, AnalyticsOrderStatus as SwapStatus, SwapRouterApiError, SwapRoute, SwapResult, SwapResponse, SupportedModes, SendBitcoinFn, RiftSwap, RiftSdkOptions, RiftSdk, QuoteResult, QuoteParameters, NativeToken, LimitPricing, GetQuoteResult, ExecutionStep, ExecutionAction, ExecuteSwapStepType, ExecuteSwapOptions, ExecuteSwapOnExecuteStepCallback, EvmChain, EvmCallStep, EvmCallKind, Erc20Token, Currency, Currencies, CreateLimitOrderOptions, Chain, CancelOrderResult, CancelOrderOptions, BtcTransferStep, BtcTransferKind, BitcoinChain };
+export { getSupportedModes, detectRoute, createRiftSdk, createCurrency, TokenIdentifier, AnalyticsOrderStatus as SwapStatus, SwapRouterApiError, SwapRoute, SwapResult, SwapResponse, SupportedModes, SendBitcoinFn, RiftSwap, RiftSdkOptions, RiftSdk, RiftOrdersPage, QuoteResult, QuoteParameters, OrderTypeFilter, NativeToken, LimitPricing, GetQuoteResult, GetOrdersOptions, ExecutionStep, ExecutionAction, ExecuteSwapStepType, ExecuteSwapOptions, ExecuteSwapOnExecuteStepCallback, EvmChain, EvmCallStep, EvmCallKind, Erc20Token, Currency, Currencies, CreateLimitOrderOptions, Chain, CancelOrderResult, CancelOrderOptions, BtcTransferStep, BtcTransferKind, BitcoinChain };

package/dist/index.js

@@ -183,6 +183,20 @@ import {
 } from "viem";
 
 // src/client.ts
+function buildQueryString(query) {
+  if (!query) {
+    return "";
+  }
+  const searchParams = new URLSearchParams;
+  for (const [key, value] of Object.entries(query)) {
+    if (value === undefined) {
+      continue;
+    }
+    searchParams.set(key, String(value));
+  }
+  const search = searchParams.toString();
+  return search.length > 0 ? `?${search}` : "";
+}
 async function request(baseUrl, path, init) {
   try {
     const response = await fetch(`${baseUrl}${path}`, init);
@@ -274,12 +288,16 @@ function createClient(baseUrl) {
   const limit = {
     post: (body) => postJson(normalizedBaseUrl, "/order/limit", body)
   };
+  const orders = {
+    get: (query) => get(normalizedBaseUrl, `/orders${buildQueryString(query)}`)
+  };
   return {
     quote: {
       post: (body) => postJson(normalizedBaseUrl, "/quote", body)
     },
     market,
     limit,
+    orders,
     swap
   };
 }
@@ -995,9 +1013,15 @@ class RiftSdk {
     }
     return context.sendBitcoin;
   }
-  async getSwapStatus(orderId) {
+  async getOrderStatus(orderId) {
     return this.unwrapEdenResult(await this.riftClient.swap({ orderId }).get());
   }
+  async getSwapStatus(orderId) {
+    return this.getOrderStatus(orderId);
+  }
+  async getOrders(options) {
+    return this.unwrapEdenResult(await this.riftClient.orders.get(options));
+  }
   async cancelOrder(options) {
     const walletClient = options.walletClient;
     const account = walletClient.account;

package/package.json

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