@riftresearch/sdk 0.2.1 → 0.2.2

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;
@@ -440,12 +450,12 @@ declare class RiftSdk {
 	*/
 	private executeBtcTransferStep;
 	private buildQuoteResult;
-	private buildSwapResult;
+	private buildOrderResult;
 	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

@@ -197,7 +197,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 +266,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,
@@ -290,13 +290,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.2",
 	"description": "SDK for swapping between bitcoin and evm chains",
 	"license": "MIT",
 	"files": [