@ravnexchange/sdk 0.2.1 → 0.2.3

package/dist/types.d.ts

@@ -65,7 +65,8 @@ export interface QuoteDTO {
      * minimum shown can no longer be met). */
     expiresAt: number;
     /** Present on 2-hop (`venue.id === "compose"`) and Relay dest-call quotes. Sign hop 1; hop 2 is
-     * a unique deposit, not a second wallet tx. */
+     * a unique deposit, not a second wallet tx. The stablecoin route also sweeps its leftover through
+     * 0x (`0x_swap`), which isn't listed here. */
     hops?: {
         id: string;
         name: string;
@@ -188,6 +189,14 @@ export type ExecutionDTO = {
      * stays with RAVN.
      */
     fee?: DepositFeeDTO;
+    /** EVM: everything to send, in order (approval.reset, approval, the swap or the deposit
+     * transfer, RAVN's fee). Each once the one before has succeeded (stop if one reverts), or, when
+     * `batch` is true, all in one atomic wallet batch (EIP-5792 `wallet_sendCalls`,
+     * `atomicRequired: true`): simulate it first, and send them one by one if that fails or the
+     * last call needs more than ~400k gas. */
+    calls?: CallDTO[];
+    /** Whether `calls` (more than one) may go in one atomic wallet batch. */
+    batch?: boolean;
 } | {
     executionType: "SIGNATURE";
     /** True for a sandbox quote: nothing here is real (see GetQuoteParams.sandbox); never send
@@ -221,6 +230,13 @@ export type ExecutionDTO = {
         amount: string;
         chainId?: number;
         expiresAt?: string;
+        /** Bitcoin, from a native SegWit (bc1q…) userAddress: the deposit (and RAVN's fee as a second
+         * output) as a ready-to-sign PSBT, base64, change back to it. Absent when it can't be built. */
+        psbt?: string;
+        /** Solana, when the deposit carries RAVN's fee: deposit and fee as one unsigned transaction,
+         * base64. Sign and send it within a minute (its blockhash expires; a retry with the same
+         * Idempotency-Key returns this same one). */
+        transaction?: string;
     };
     /** Poll getStatus with this, not `deposit.address`. */
     statusRef: string;
@@ -229,7 +245,22 @@ export type ExecutionDTO = {
      * fee is owed to you. A fee paid on a swap the venue then refunds stays with RAVN and nothing
      * is owed on it, so send an EVM fee payment once the deposit has confirmed. */
     fee?: DepositFeeDTO;
+    /** EVM: everything to send, in order (approval.reset, approval, the swap or the deposit
+     * transfer, RAVN's fee). Each once the one before has succeeded (stop if one reverts), or, when
+     * `batch` is true, all in one atomic wallet batch (EIP-5792 `wallet_sendCalls`,
+     * `atomicRequired: true`): simulate it first, and send them one by one if that fails or the
+     * last call needs more than ~400k gas. */
+    calls?: CallDTO[];
+    /** Whether `calls` (more than one) may go in one atomic wallet batch. */
+    batch?: boolean;
 };
+/** One EVM transaction to send, as given. */
+export interface CallDTO {
+    to: string;
+    data: string;
+    value: string;
+    chainId: number;
+}
 /** RAVN's integrator fee beside a deposit (or a transaction), in the input token, paid by your user
  * to RAVN; your share is paid out as usual. `deposit.amount` (the transaction) already leaves it out. */
 export interface DepositFeeDTO {
@@ -301,16 +332,22 @@ export interface GetQuoteParams {
      * wait; a quote with slippage.noMinimum counts only 2000 ms past the limit). A positive integer;
      * default 6000, clamped to 1000–15000. An API that predates it ignores it. */
     timeoutMs?: number;
-    /** Drop specific venues from this race, e.g. a risk objection to one of them. */
+    /** Venues never to use, e.g. a risk objection to one of them. An excluded venue is used
+     * nowhere in the route, including the steps of RAVN's multi-step routes (compose, relay quotes
+     * with hops); a multi-step route that needs it isn't offered. Venues that swap for you may still
+     * route through it on their own (see onlyVenues). */
     excludeVenues?: string[];
     /** Race only these venues, e.g. ["bebop"] for an RFQ-only race. Every other venue is left
-     * out, including ones RAVN adds later; excludeVenues still applies on top. Matches the quote's
-     * venue.id, the venue you deal with, not every venue funds pass through: RAVN's multi-step
-     * routes (compose, relay quotes with hops) and venues such as Rift, Across (swapping before or
-     * after bridging) and Mayan (a Solana order starting in another token swaps through Jupiter
-     * first) route through others. An empty list is
-     * rejected (INVALID_REQUEST); if none of them can quote, NO_LIQUIDITY lists every left-out
-     * venue in error.details.excludedVenues. */
+     * out, including ones RAVN adds later; excludeVenues still applies on top. It covers every
+     * venue RAVN routes funds through: a multi-step route is offered only when its own venue.id and
+     * every venue in its hops are listed, e.g. ["compose", "jupiter", "relay"] or
+     * ["relay", "kyberswap"]. RAVN's stablecoin route also needs "0x_swap" beside its hops: it
+     * sweeps the leftover. Venues that swap for you may route through other venues of their own
+     * choosing, which neither list can reach: Layerswap (a Solana token often goes through Jupiter
+     * first), Relay, Rift, Across (when it swaps before or after bridging) and Mayan (Jupiter on
+     * Solana, other DEXs such as Nordstern on EVM). An empty list is rejected (INVALID_REQUEST); if
+     * none of them can quote, NO_LIQUIDITY lists every left-out venue in
+     * error.details.excludedVenues. */
     onlyVenues?: string[];
     /** Settle privately: the race narrows to NEAR Intents (Confidential Intents) and Houdini Swap,
      * and NO_LIQUIDITY replaces a public fill if neither can quote. Houdini is sent the request's IP,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ravnexchange/sdk",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Typed client for the RAVN integrator API (/api/v1): quote, execute, submit-signature, status.",
   "keywords": ["ravn", "cross-chain", "swap", "swap-api", "dex-aggregator", "bitcoin", "native-btc", "solana", "evm", "crypto", "defi", "typescript", "sdk", "api-client"],
   "main": "./dist/index.js",