@ravnexchange/react 0.1.5 → 0.1.7

package/dist/useRavnStatus.d.ts

@@ -1,16 +1,26 @@
-import { type RavnClient, type StatusDTO } from "@ravnexchange/sdk";
+import { type RavnClient, type SettlementStatus, type StatusDTO } from "@ravnexchange/sdk";
 export interface UseRavnStatusResult {
     status: StatusDTO | null;
     isLoading: boolean;
     error: unknown;
 }
 export declare function isPermanentError(err: unknown): boolean;
+/** Whether to poll again after `status`: until it's terminal, then once more after a success when
+ * `txHash` is set, as RAVN's node may be a block behind yours on that fee tx and a success it
+ * answers before seeing it books no fee. */
+export declare function pollAgain(status: SettlementStatus, txHash: string | undefined, rechecked: boolean): boolean;
+/** How long to wait before the next poll after `status`: an expired swap's refund can take hours
+ * (Across: a later settlement bundle), so it's asked about once a minute, not every few seconds. */
+export declare function nextPollMs(status: SettlementStatus, intervalMs: number): number;
 /**
  * Polls /v1/status until it reaches a terminal state (see isPollingTerminal: "unknown"
- * counts as terminal, it means the venue has no live tracker and never will for this swap).
+ * counts as terminal, it means the venue has no live tracker and never will for this swap;
+ * "expired" doesn't, a refund is due, and is polled once a minute until it lands; nor does
+ * "not_found", the venue has no record of this swap: brief right after sending, otherwise it
+ * stays so while mounted).
  * Pass `params: null` to not poll at all (e.g. before execution has produced a ref).
- * `txHash`: the fee payment a DEPOSIT's `fee.transaction` asked for (or a two-hop route's hop-1
- * tx). Without it the swap's status still arrives, but its fee is never proven and nothing is owed.
+ * `txHash`: executeAndTrack's `statusTxHash`, or the fee payment a DEPOSIT's `fee.transaction`
+ * asked for (or a two-hop route's hop-1 tx). Without it the swap's status still arrives, but its fee is never proven and nothing is owed.
  */
 export declare function useRavnStatus(client: RavnClient, params: {
     quoteToken: string;

package/dist/useRavnStatus.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isPermanentError = isPermanentError;
+exports.pollAgain = pollAgain;
+exports.nextPollMs = nextPollMs;
 exports.useRavnStatus = useRavnStatus;
 const react_1 = require("react");
 const sdk_1 = require("@ravnexchange/sdk");
@@ -12,12 +14,26 @@ const PERMANENT_ERROR_CODES = new Set(["UNAUTHORIZED", "INVALID_REQUEST", "QUOTE
 function isPermanentError(err) {
     return err instanceof sdk_1.RavnApiError && PERMANENT_ERROR_CODES.has(err.code);
 }
+/** Whether to poll again after `status`: until it's terminal, then once more after a success when
+ * `txHash` is set, as RAVN's node may be a block behind yours on that fee tx and a success it
+ * answers before seeing it books no fee. */
+function pollAgain(status, txHash, rechecked) {
+    return !(0, polling_1.isPollingTerminal)(status) || (status === "success" && !!txHash && !rechecked);
+}
+/** How long to wait before the next poll after `status`: an expired swap's refund can take hours
+ * (Across: a later settlement bundle), so it's asked about once a minute, not every few seconds. */
+function nextPollMs(status, intervalMs) {
+    return status === "expired" ? Math.max(intervalMs, 60000) : intervalMs;
+}
 /**
  * Polls /v1/status until it reaches a terminal state (see isPollingTerminal: "unknown"
- * counts as terminal, it means the venue has no live tracker and never will for this swap).
+ * counts as terminal, it means the venue has no live tracker and never will for this swap;
+ * "expired" doesn't, a refund is due, and is polled once a minute until it lands; nor does
+ * "not_found", the venue has no record of this swap: brief right after sending, otherwise it
+ * stays so while mounted).
  * Pass `params: null` to not poll at all (e.g. before execution has produced a ref).
- * `txHash`: the fee payment a DEPOSIT's `fee.transaction` asked for (or a two-hop route's hop-1
- * tx). Without it the swap's status still arrives, but its fee is never proven and nothing is owed.
+ * `txHash`: executeAndTrack's `statusTxHash`, or the fee payment a DEPOSIT's `fee.transaction`
+ * asked for (or a two-hop route's hop-1 tx). Without it the swap's status still arrives, but its fee is never proven and nothing is owed.
  */
 function useRavnStatus(client, params, intervalMs = 4000) {
     const [status, setStatus] = (0, react_1.useState)(null);
@@ -29,6 +45,7 @@ function useRavnStatus(client, params, intervalMs = 4000) {
             return;
         }
         let cancelled = false;
+        let rechecked = false;
         let timer;
         const poll = () => {
             setIsLoading(true);
@@ -39,8 +56,9 @@ function useRavnStatus(client, params, intervalMs = 4000) {
                     return;
                 setStatus(s);
                 setError(null);
-                if (!(0, polling_1.isPollingTerminal)(s.status)) {
-                    timer = setTimeout(poll, intervalMs);
+                if (pollAgain(s.status, params.txHash, rechecked)) {
+                    rechecked || (rechecked = (0, polling_1.isPollingTerminal)(s.status));
+                    timer = setTimeout(poll, nextPollMs(s.status, intervalMs));
                 }
             })
                 .catch((err) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ravnexchange/react",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "React hooks for @ravnexchange/sdk: quote/execute/status state management. Bring your own wallet.",
   "keywords": ["ravn", "cross-chain", "swap", "swap-api", "dex-aggregator", "bitcoin", "native-btc", "solana", "evm", "crypto", "defi", "react", "react-hooks", "typescript"],
   "main": "./dist/index.js",
@@ -14,7 +14,7 @@
     "build": "tsc -p tsconfig.build.json"
   },
   "peerDependencies": {
-    "@ravnexchange/sdk": ">=0.1.13",
+    "@ravnexchange/sdk": ">=0.2.0",
     "react": ">=18"
   },
   "devDependencies": {