@ravnexchange/sdk 0.1.13 → 0.1.14

package/dist/types.d.ts

@@ -154,6 +154,19 @@ export type ExecutionDTO = {
     submit?: {
         url: string;
     };
+    /**
+     * Only when your key sets a fee and the route has no fee of its own (Eco, Layerswap, Mayan's
+     * routes paying no referrer): RAVN's fee, a transfer of the input token to RAVN;
+     * `transaction` already leaves it out. Skip it and the swap still fills; no fee is owed to
+     * you. With no `statusRef` here (you poll with the swap's own tx hash), a wallet that batches
+     * atomically (EIP-5792 `wallet_sendCalls`, one transaction) may send `fee.transaction` in the
+     * same batch as `transaction`, and the swap's tx proves it (an ERC-20 sell only: a native coin
+     * batched leaves nothing to read). Otherwise — including a batch the wallet splits into
+     * several transactions — send it as a transaction of its own from the user's regular wallet
+     * once the swap has confirmed, and pass its hash as `txHash` to getStatus. A fee paid on a
+     * swap the venue refunds stays with RAVN.
+     */
+    fee?: DepositFeeDTO;
 } | {
     executionType: "SIGNATURE";
     /** Pass this, not the quote's own token, to submitSignature and getStatus. */
@@ -180,12 +193,14 @@ export type ExecutionDTO = {
     };
     /** Poll getStatus with this, not `deposit.address`. */
     statusRef: string;
-    /** Only when your key sets a fee and the venue has no fee of its own (today Rift). Skip it
-     * and the swap still fills on `deposit.amount`; no fee is owed to you. */
+    /** Only when your key sets a fee and the venue has no fee of its own (Rift; private swaps from
+     * an EVM chain or Bitcoin). Skip it and the swap still fills on `deposit.amount`; no 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;
 };
-/** RAVN's integrator fee beside a deposit, in the input token, paid by your user to RAVN; your
- * share is paid out as usual. `deposit.amount` already leaves it out. */
+/** 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 {
     /** Base units of the input token. */
     amount: string;
@@ -197,7 +212,7 @@ export interface DepositFeeDTO {
      * smart-wallet batch it can't be proven, and nothing is owed on it), then pass its hash as
      * `txHash` to getStatus once it has confirmed (simplest: on every poll). Absent on Bitcoin: pay `amount` to `address`
      * as an extra output of the SAME transaction that pays the deposit; RAVN finds it there once
-     * that transaction confirms. */
+     * that transaction confirms. One deposit per Bitcoin transaction: a fee output proves one swap. */
     transaction?: {
         to: string;
         data: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ravnexchange/sdk",
-  "version": "0.1.13",
+  "version": "0.1.14",
   "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",