@ravnexchange/sdk 0.1.3 → 0.1.5

package/dist/client.d.ts

@@ -13,18 +13,18 @@ export declare class RavnClient {
     private readonly fetchImpl;
     constructor(config?: RavnClientConfig);
     private request;
-    /** POST /v1/quote — omitting destinationAddress/refundAddress returns a preview-only quote (see QuoteDTO.executable). */
+    /** POST /v1/quote: omitting destinationAddress/refundAddress returns a preview-only quote (see QuoteDTO.executable). */
     getQuote(params: GetQuoteParams): Promise<QuoteDTO>;
-    /** POST /v1/execute — branch on the returned executionType (TRANSACTION / SIGNATURE / DEPOSIT). */
+    /** POST /v1/execute: branch on the returned executionType (TRANSACTION / SIGNATURE / DEPOSIT). */
     execute(params: ExecuteParams): Promise<ExecutionDTO>;
-    /** POST /v1/submit-signature — for SIGNATURE-type executions only. Returns the ref to poll getStatus with. */
+    /** POST /v1/submit-signature: for SIGNATURE-type executions only. Returns the ref to poll getStatus with. */
     submitSignature(params: SubmitSignatureParams): Promise<{
         statusRef: string;
     }>;
-    /** GET /v1/status — `ref` is the DEPOSIT address or the statusRef from submitSignature. */
+    /** GET /v1/status: `ref` is the DEPOSIT address or the statusRef from submitSignature. */
     getStatus(quoteToken: string, ref: string): Promise<StatusDTO>;
-    /** GET /v1/tokens — RAVN's listed token registry for one chain. Not a per-pair routability guarantee. */
+    /** GET /v1/tokens: RAVN's listed token registry for one chain. Not a per-pair routability guarantee. */
     getTokens(chainId: number): Promise<TokenDTO[]>;
-    /** GET /v1/chains — every chain RAVN lists tokens for. Static; safe to cache client-side. */
+    /** GET /v1/chains: every chain RAVN lists tokens for. Static; safe to cache client-side. */
     getChains(): Promise<ChainDTO[]>;
 }

package/dist/client.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RavnClient = void 0;
 const types_1 = require("./types");
-// ravn.exchange is the marketing site (separate deployment, no /api/* routes at all) — the
+// ravn.exchange is the marketing site (separate deployment, no /api/* routes at all); the
 // actual app, including this API, is served from the app subdomain. A caller that omits
 // baseUrl entirely was 404ing on every single call until this fix.
 const DEFAULT_BASE_URL = "https://app.ravn.exchange/api/v1";
@@ -27,7 +27,7 @@ class RavnClient {
         }
         catch {
             // A non-JSON body (an intermediary's HTML error page, an empty 204/502/504) must still
-            // surface as the one error type this client promises — never a raw SyntaxError.
+            // surface as the one error type this client promises, never a raw SyntaxError.
             throw new types_1.RavnApiError("INTERNAL", `HTTP ${res.status}: response was not valid JSON`, undefined, undefined);
         }
         if (!res.ok || body.error) {
@@ -36,32 +36,32 @@ class RavnClient {
         }
         return body.data;
     }
-    /** POST /v1/quote — omitting destinationAddress/refundAddress returns a preview-only quote (see QuoteDTO.executable). */
+    /** POST /v1/quote: omitting destinationAddress/refundAddress returns a preview-only quote (see QuoteDTO.executable). */
     getQuote(params) {
         return this.request("/quote", { method: "POST", body: JSON.stringify(params) });
     }
-    /** POST /v1/execute — branch on the returned executionType (TRANSACTION / SIGNATURE / DEPOSIT). */
+    /** POST /v1/execute: branch on the returned executionType (TRANSACTION / SIGNATURE / DEPOSIT). */
     execute(params) {
         return this.request("/execute", { method: "POST", body: JSON.stringify(params) });
     }
-    /** POST /v1/submit-signature — for SIGNATURE-type executions only. Returns the ref to poll getStatus with. */
+    /** POST /v1/submit-signature: for SIGNATURE-type executions only. Returns the ref to poll getStatus with. */
     submitSignature(params) {
         return this.request("/submit-signature", {
             method: "POST",
             body: JSON.stringify(params),
         });
     }
-    /** GET /v1/status — `ref` is the DEPOSIT address or the statusRef from submitSignature. */
+    /** GET /v1/status: `ref` is the DEPOSIT address or the statusRef from submitSignature. */
     getStatus(quoteToken, ref) {
         const qs = new URLSearchParams({ quoteToken, ref }).toString();
         return this.request(`/status?${qs}`, { method: "GET" });
     }
-    /** GET /v1/tokens — RAVN's listed token registry for one chain. Not a per-pair routability guarantee. */
+    /** GET /v1/tokens: RAVN's listed token registry for one chain. Not a per-pair routability guarantee. */
     getTokens(chainId) {
         const qs = new URLSearchParams({ chainId: String(chainId) }).toString();
         return this.request(`/tokens?${qs}`, { method: "GET" });
     }
-    /** GET /v1/chains — every chain RAVN lists tokens for. Static; safe to cache client-side. */
+    /** GET /v1/chains: every chain RAVN lists tokens for. Static; safe to cache client-side. */
     getChains() {
         return this.request("/chains", { method: "GET" });
     }

package/dist/execute-and-track.d.ts

@@ -12,17 +12,17 @@ export interface ExecuteAndTrackHandlers {
     sendTransaction(tx: TxLike): Promise<string>;
     /**
      * Wait for a transaction hash to confirm. Called on the approval before the main tx is ever
-     * sent — sending both back-to-back races the allowance and is the most common integration bug
+     * sent: sending both back-to-back races the allowance and is the most common integration bug
      * this helper exists to prevent.
      */
     waitForReceipt(hash: string, chainId?: number): Promise<void>;
     /** Sign an EIP-712 typed-data payload. Only called for SIGNATURE executions. */
     signTypedData?(typedData: Record<string, unknown>): Promise<`0x${string}`>;
     /**
-     * The API sends `approval` whenever the venue generically needs an allowance — it deliberately
+     * The API sends `approval` whenever the venue generically needs an allowance: it deliberately
      * never reads the chain to check whether the caller already has one (that's an RPC round-trip
      * on every execute). Without this handler, that approval tx is sent unconditionally, even when
-     * unnecessary — the caller pays gas for a redundant approve on every swap of the same
+     * unnecessary: the caller pays gas for a redundant approve on every swap of the same
      * token/spender. Supply this (an allowance read against your own RPC) to skip it when already
      * sufficient, same as the first-party app's own ensureErc20Allowance does.
      */
@@ -37,7 +37,7 @@ export interface ExecuteAndTrackResult {
     execution: ExecutionDTO;
     approvalTxHash?: string;
     txHash?: string;
-    /** Pass to client.getStatus(quoteToken, ref) — same value as txHash for TRANSACTION. */
+    /** Pass to client.getStatus(quoteToken, ref): same value as txHash for TRANSACTION. */
     statusRef?: string;
     /** Set once pollUntilTerminal reaches a terminal status. Absent for DEPOSIT (see below) or when polling is turned off. */
     finalStatus?: StatusDTO;
@@ -45,7 +45,7 @@ export interface ExecuteAndTrackResult {
 /**
  * Sequences execute() → approval (if any) → wait for its receipt → main tx/signature → status
  * polling, using caller-supplied signing/sending functions. The SDK stays wallet-agnostic (no
- * RPC dependency) — this just gets the ORDER right, which quickstart's own docs flag as the
+ * RPC dependency); this just gets the ORDER right, which quickstart's own docs flag as the
  * most common integration failure: sending the main tx before the approval has confirmed.
  */
 export declare function executeAndTrack(client: RavnClient, params: ExecuteParams, handlers: ExecuteAndTrackHandlers, options?: ExecuteAndTrackOptions): Promise<ExecuteAndTrackResult>;

package/dist/execute-and-track.js

@@ -5,7 +5,7 @@ const polling_1 = require("./polling");
 /**
  * Sequences execute() → approval (if any) → wait for its receipt → main tx/signature → status
  * polling, using caller-supplied signing/sending functions. The SDK stays wallet-agnostic (no
- * RPC dependency) — this just gets the ORDER right, which quickstart's own docs flag as the
+ * RPC dependency); this just gets the ORDER right, which quickstart's own docs flag as the
  * most common integration failure: sending the main tx before the approval has confirmed.
  */
 async function executeAndTrack(client, params, handlers, options = {}) {
@@ -21,7 +21,7 @@ async function executeAndTrack(client, params, handlers, options = {}) {
             await new Promise((resolve) => setTimeout(resolve, pollIntervalMs));
         }
     };
-    // Sends and confirms an approval unless the caller already knows it's covered — see
+    // Sends and confirms an approval unless the caller already knows it's covered; see
     // ExecuteAndTrackHandlers.hasAllowance's doc comment for why the API can't decide this itself.
     const maybeSendApproval = async (approval) => {
         if (!approval)
@@ -46,7 +46,7 @@ async function executeAndTrack(client, params, handlers, options = {}) {
         }
         // A signed order isn't allowance-free: CoW's vault relayer and Bebop/0x's Permit2 still pull
         // the sell token with transferFrom, so this on-chain allowance (separate from approvalData's
-        // gasless per-trade signature) must be confirmed before signing — otherwise the order is
+        // gasless per-trade signature) must be confirmed before signing, otherwise the order is
         // accepted and simply never fills, with no error to explain why.
         const approvalTxHash = await maybeSendApproval(execution.approval);
         let approvalSignature;
@@ -57,7 +57,7 @@ async function executeAndTrack(client, params, handlers, options = {}) {
         const { statusRef } = await client.submitSignature({ quoteToken: params.quoteToken, signature, approvalSignature });
         return { execution, approvalTxHash, statusRef, finalStatus: await pollStatus(statusRef) };
     }
-    // DEPOSIT: nothing to sign or send from here — the user moves funds to execution.deposit.address
+    // DEPOSIT: nothing to sign or send from here; the user moves funds to execution.deposit.address
     // out-of-band, and this helper has no way to know when that happens. Returned without polling;
     // start polling yourself (getStatus / useRavnStatus) once the deposit is actually sent.
     return { execution, statusRef: execution.statusRef };

package/dist/polling.d.ts

@@ -1,7 +1,7 @@
 import type { SettlementStatus } from "./types";
 /**
  * Whether a status is done changing. "unknown" counts as terminal even though it isn't a real
- * outcome — it means the venue has no live tracker (see StatusDTO.tracking), so it will never
+ * outcome: it means the venue has no live tracker (see StatusDTO.tracking), so it will never
  * change and polling forever would just spin. Only "pending"/"processing" keep polling.
  */
 export declare function isPollingTerminal(status: SettlementStatus): boolean;

package/dist/polling.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isPollingTerminal = isPollingTerminal;
 /**
  * Whether a status is done changing. "unknown" counts as terminal even though it isn't a real
- * outcome — it means the venue has no live tracker (see StatusDTO.tracking), so it will never
+ * outcome: it means the venue has no live tracker (see StatusDTO.tracking), so it will never
  * change and polling forever would just spin. Only "pending"/"processing" keep polling.
  */
 function isPollingTerminal(status) {

package/dist/types.d.ts

@@ -1,6 +1,6 @@
 /**
  * Wire types for RAVN's public /api/v1 surface. Deliberately a standalone mirror of
- * src/lib/api/v1/dto.ts's public DTOs, not an import from it — this package ships to npm on
+ * src/lib/api/v1/dto.ts's public DTOs, not an import from it: this package ships to npm on
  * its own and can't depend on the app's internal source tree. Keep these two in sync by hand
  * when the API's public contract changes; that file's own comment already promises the shape
  * is frozen for third parties, so drift should be rare.
@@ -15,7 +15,7 @@ export interface TokenDTO {
     logoUrl?: string;
 }
 export interface QuoteDTO {
-    /** Opaque handle — pass back to execute() verbatim. Do not parse. */
+    /** Opaque handle: pass back to execute() verbatim. Do not parse. */
     quoteToken: string;
     venue: {
         id: string;
@@ -31,14 +31,14 @@ export interface QuoteDTO {
         amount: string;
     };
     /** `supported: false` means the venue has no fee mechanism at all (bps will be 0 either
-     * way) — distinct from `supported: true, bps: 0`, a real, intentional zero fee. */
+     * way); distinct from `supported: true, bps: 0`, a real, intentional zero fee. */
     fee: {
         bps: number;
         amount: string;
         token: TokenDTO;
         supported: boolean;
     };
-    /** False means this is a preview-only price — see RavnClient.getQuote's destinationAddress note. */
+    /** False means this is a preview-only price; see RavnClient.getQuote's destinationAddress note. */
     executable: boolean;
     slippage: {
         bps: number;
@@ -146,12 +146,12 @@ export interface GetQuoteParams {
     /** Positive integer string, in the token's smallest unit (no decimals). */
     inputAmount: string;
     userAddress: string;
-    /** Omitting this yields a preview-only quote — see QuoteDTO.executable. */
+    /** Omitting this yields a preview-only quote; see QuoteDTO.executable. */
     destinationAddress?: string;
     refundAddress?: string;
     slippageBps?: number;
     rankingMode?: "best_output" | "fastest";
-    /** Drop specific venues from this race — e.g. a risk objection to one of them. */
+    /** Drop specific venues from this race, e.g. a risk objection to one of them. */
     excludeVenues?: string[];
     /** Test quote -> execute -> status with no real funds and no live venue settlement. See
      * the API's own sandbox field description for per-venue/per-route exceptions. */

package/dist/types.js

@@ -1,7 +1,7 @@
 "use strict";
 /**
  * Wire types for RAVN's public /api/v1 surface. Deliberately a standalone mirror of
- * src/lib/api/v1/dto.ts's public DTOs, not an import from it — this package ships to npm on
+ * src/lib/api/v1/dto.ts's public DTOs, not an import from it: this package ships to npm on
  * its own and can't depend on the app's internal source tree. Keep these two in sync by hand
  * when the API's public contract changes; that file's own comment already promises the shape
  * is frozen for third parties, so drift should be rare.

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "@ravnexchange/sdk",
-  "version": "0.1.3",
-  "description": "Typed client for the RAVN integrator API (/api/v1) — quote, execute, submit-signature, status.",
+  "version": "0.1.5",
+  "description": "Typed client for the RAVN integrator API (/api/v1): quote, execute, submit-signature, status.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": ["dist"],
   "license": "MIT",
+  "repository": { "type": "git", "url": "git+https://github.com/ravndex/ravn-sdk.git", "directory": "core" },
+  "homepage": "https://github.com/ravndex/ravn-sdk#readme",
   "publishConfig": { "access": "public" },
   "scripts": {
     "build": "tsc -p tsconfig.build.json"