@satora/swap 0.0.3 → 0.0.5-rc.0

package/README.md

@@ -0,0 +1,96 @@
+# @satora/swap
+
+The Satora swap client — a Lightning / on-chain BTC / Arkade ↔ EVM on/off-ramp.
+Pure TypeScript, works in every JS environment (browser, Node, React Native).
+
+This is the `@satora`-scoped name for the swap client and re-exports the
+[`@lendasat/lendaswap-sdk-pure`](https://www.npmjs.com/package/@lendasat/lendaswap-sdk-pure)
+bundle verbatim (`Client`, `ClientBuilder`, `Asset`, `EvmSigner`, storage
+backends, …). New code should import `@satora/swap`.
+
+## Install
+
+```sh
+npm install @satora/swap
+```
+
+## Supported swaps
+
+| Direction | Source                      | Target                      |
+| --------- | --------------------------- | --------------------------- |
+| BTC → EVM | Lightning, Arkade, on-chain | Ethereum, Polygon, Arbitrum |
+| EVM → BTC | Ethereum, Polygon, Arbitrum | Lightning, Arkade, on-chain |
+
+Refunds: Lightning auto-expires; Arkade refunds off-chain; on-chain BTC and EVM
+refund after their timelock.
+
+## Quick start
+
+### Build a client
+
+```ts
+import { Client, IdbWalletStorage, IdbSwapStorage } from "@satora/swap";
+
+// Browser, persistent storage (IndexedDB). Omit the storages for a fresh
+// ephemeral wallet, or pass .withMnemonic("abandon abandon …") to import one.
+const client = await Client.builder()
+  .withSignerStorage(new IdbWalletStorage())
+  .withSwapStorage(new IdbSwapStorage())
+  .build();
+
+const mnemonic = client.getMnemonic(); // back this up
+```
+
+### Quote and create a swap
+
+`createSwap` handles every direction; the SDK routes by source/target asset.
+
+```ts
+import { Asset } from "@satora/swap";
+
+const quote = await client.getQuote({
+  sourceChain: Asset.BTC_ARKADE.chain,
+  sourceToken: Asset.BTC_ARKADE.tokenId,
+  targetChain: Asset.USDC_POLYGON.chain,
+  targetToken: Asset.USDC_POLYGON.tokenId,
+  sourceAmount: 100_000, // sats
+});
+
+// BTC → EVM: Arkade BTC to USDC on Polygon
+const {response} = await client.createSwap({
+  source: Asset.BTC_ARKADE,
+  target: Asset.USDC_POLYGON,
+  sourceAmount: 100_000,       // sats
+  targetAddress: "0x…",        // your EVM address
+});
+const swapId = response.id;
+```
+
+### Fund EVM-sourced swaps
+
+EVM-sourced swaps are funded after creation. The SDK runs the full Permit2 flow
+(allowance, ERC-20 approval, EIP-712 signing, submission) in one call — you
+provide an `EvmSigner` (a small wallet abstraction; adapters for viem/wagmi and
+ethers v6 are a few lines — see the underlying SDK's README).
+
+```ts
+const {txHash} = await client.fundSwap(swapId, signer);
+```
+
+### Monitor, claim, refund
+
+```ts
+const swap = await client.getSwap(swapId);
+// pending → clientfunded → serverfunded → clientredeemed → serverredeemed
+
+// BTC → EVM: once serverfunded, claim your tokens
+await client.claim(swapId);
+
+// Refund after timeout
+await client.refundSwap(swapId, {destinationAddress: "bc1q…"}); // or "ark1…"
+await client.collabRefundEvmWithSigner(swapId, signer, "swap-back"); // EVM, instant/gasless
+```
+
+## License
+
+MIT

package/dist/cctp-bridge.cjs

@@ -0,0 +1,25 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/cctp-bridge.ts
+var cctp_bridge_exports = {};
+module.exports = __toCommonJS(cctp_bridge_exports);
+__reExport(cctp_bridge_exports, require("@lendasat/lendaswap-sdk-pure/cctp-bridge"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("@lendasat/lendaswap-sdk-pure/cctp-bridge")
+});
+//# sourceMappingURL=cctp-bridge.cjs.map

package/dist/cctp-bridge.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/cctp-bridge.ts"],"sourcesContent":["/** Re-export of the legacy `@lendasat/lendaswap-sdk-pure/cctp-bridge` entry point. */\nexport * from \"@lendasat/lendaswap-sdk-pure/cctp-bridge\";\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA;AAAA;AACA,gCAAc,qDADd;","names":[]}

package/dist/cctp-bridge.d.cts

@@ -0,0 +1 @@
+export * from '@lendasat/lendaswap-sdk-pure/cctp-bridge';

package/dist/cctp-bridge.d.ts

@@ -1,3 +1 @@
-/** Re-export of the legacy `@lendasat/lendaswap-sdk-pure/cctp-bridge` entry point. */
-export * from "@lendasat/lendaswap-sdk-pure/cctp-bridge";
-//# sourceMappingURL=cctp-bridge.d.ts.map
+export * from '@lendasat/lendaswap-sdk-pure/cctp-bridge';

package/dist/cctp-bridge.js

@@ -1,3 +1,3 @@
-/** Re-export of the legacy `@lendasat/lendaswap-sdk-pure/cctp-bridge` entry point. */
+// src/cctp-bridge.ts
 export * from "@lendasat/lendaswap-sdk-pure/cctp-bridge";
 //# sourceMappingURL=cctp-bridge.js.map

package/dist/cctp-bridge.js.map

@@ -1 +1 @@
-{"version":3,"file":"cctp-bridge.js","sourceRoot":"","sources":["../src/cctp-bridge.ts"],"names":[],"mappings":"AAAA,sFAAsF;AACtF,cAAc,0CAA0C,CAAC"}
+{"version":3,"sources":["../src/cctp-bridge.ts"],"sourcesContent":["/** Re-export of the legacy `@lendasat/lendaswap-sdk-pure/cctp-bridge` entry point. */\nexport * from \"@lendasat/lendaswap-sdk-pure/cctp-bridge\";\n"],"mappings":";AACA,cAAc;","names":[]}

package/dist/delegate.cjs

@@ -0,0 +1,25 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/delegate.ts
+var delegate_exports = {};
+module.exports = __toCommonJS(delegate_exports);
+__reExport(delegate_exports, require("@lendasat/lendaswap-sdk-pure/delegate"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("@lendasat/lendaswap-sdk-pure/delegate")
+});
+//# sourceMappingURL=delegate.cjs.map

package/dist/delegate.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/delegate.ts"],"sourcesContent":["/** Re-export of the legacy `@lendasat/lendaswap-sdk-pure/delegate` entry point. */\nexport * from \"@lendasat/lendaswap-sdk-pure/delegate\";\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA;AAAA;AACA,6BAAc,kDADd;","names":[]}

package/dist/delegate.d.cts

@@ -0,0 +1 @@
+export * from '@lendasat/lendaswap-sdk-pure/delegate';

package/dist/delegate.d.ts

@@ -1,3 +1 @@
-/** Re-export of the legacy `@lendasat/lendaswap-sdk-pure/delegate` entry point. */
-export * from "@lendasat/lendaswap-sdk-pure/delegate";
-//# sourceMappingURL=delegate.d.ts.map
+export * from '@lendasat/lendaswap-sdk-pure/delegate';

package/dist/delegate.js

@@ -1,3 +1,3 @@
-/** Re-export of the legacy `@lendasat/lendaswap-sdk-pure/delegate` entry point. */
+// src/delegate.ts
 export * from "@lendasat/lendaswap-sdk-pure/delegate";
 //# sourceMappingURL=delegate.js.map

package/dist/delegate.js.map

@@ -1 +1 @@
-{"version":3,"file":"delegate.js","sourceRoot":"","sources":["../src/delegate.ts"],"names":[],"mappings":"AAAA,mFAAmF;AACnF,cAAc,uCAAuC,CAAC"}
+{"version":3,"sources":["../src/delegate.ts"],"sourcesContent":["/** Re-export of the legacy `@lendasat/lendaswap-sdk-pure/delegate` entry point. */\nexport * from \"@lendasat/lendaswap-sdk-pure/delegate\";\n"],"mappings":";AACA,cAAc;","names":[]}

package/dist/index.cjs

@@ -0,0 +1,25 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+module.exports = __toCommonJS(src_exports);
+__reExport(src_exports, require("@lendasat/lendaswap-sdk-pure"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("@lendasat/lendaswap-sdk-pure")
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * @satora/swap — the Satora-scoped name for the swap client.\n *\n * Re-exports the legacy `@lendasat/lendaswap-sdk-pure` bundle verbatim\n * (Client, ClientBuilder, signer helpers, etc.) so new code can import\n * `@satora/swap` while the published legacy package keeps working. This\n * is the seam for migrating implementation into `@satora/*` later.\n */\nexport * from \"@lendasat/lendaswap-sdk-pure\";\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA;AAAA;AAQA,wBAAc,yCARd;","names":[]}

package/dist/index.d.cts

@@ -0,0 +1,4 @@
+export * from '@lendasat/lendaswap-sdk-pure';
+import '@lendasat/lendaswap-sdk-pure/node';
+import '@lendasat/lendaswap-sdk-pure/delegate';
+import '@lendasat/lendaswap-sdk-pure/cctp-bridge';

package/dist/index.d.ts

@@ -1,10 +1,4 @@
-/**
- * @satora/swap — the Satora-scoped name for the swap client.
- *
- * Re-exports the legacy `@lendasat/lendaswap-sdk-pure` bundle verbatim
- * (Client, ClientBuilder, signer helpers, etc.) so new code can import
- * `@satora/swap` while the published legacy package keeps working. This
- * is the seam for migrating implementation into `@satora/*` later.
- */
-export * from "@lendasat/lendaswap-sdk-pure";
-//# sourceMappingURL=index.d.ts.map
+export * from '@lendasat/lendaswap-sdk-pure';
+import '@lendasat/lendaswap-sdk-pure/node';
+import '@lendasat/lendaswap-sdk-pure/delegate';
+import '@lendasat/lendaswap-sdk-pure/cctp-bridge';

package/dist/index.js

@@ -1,10 +1,3 @@
-/**
- * @satora/swap — the Satora-scoped name for the swap client.
- *
- * Re-exports the legacy `@lendasat/lendaswap-sdk-pure` bundle verbatim
- * (Client, ClientBuilder, signer helpers, etc.) so new code can import
- * `@satora/swap` while the published legacy package keeps working. This
- * is the seam for migrating implementation into `@satora/*` later.
- */
+// src/index.ts
 export * from "@lendasat/lendaswap-sdk-pure";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,cAAc,8BAA8B,CAAC"}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * @satora/swap — the Satora-scoped name for the swap client.\n *\n * Re-exports the legacy `@lendasat/lendaswap-sdk-pure` bundle verbatim\n * (Client, ClientBuilder, signer helpers, etc.) so new code can import\n * `@satora/swap` while the published legacy package keeps working. This\n * is the seam for migrating implementation into `@satora/*` later.\n */\nexport * from \"@lendasat/lendaswap-sdk-pure\";\n"],"mappings":";AAQA,cAAc;","names":[]}

package/dist/node.cjs

@@ -0,0 +1,25 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/node.ts
+var node_exports = {};
+module.exports = __toCommonJS(node_exports);
+__reExport(node_exports, require("@lendasat/lendaswap-sdk-pure/node"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("@lendasat/lendaswap-sdk-pure/node")
+});
+//# sourceMappingURL=node.cjs.map

package/dist/node.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/node.ts"],"sourcesContent":["/** Re-export of the legacy `@lendasat/lendaswap-sdk-pure/node` entry point. */\nexport * from \"@lendasat/lendaswap-sdk-pure/node\";\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA;AAAA;AACA,yBAAc,8CADd;","names":[]}

package/dist/node.d.cts

@@ -0,0 +1 @@
+export * from '@lendasat/lendaswap-sdk-pure/node';

package/dist/node.d.ts

@@ -1,3 +1 @@
-/** Re-export of the legacy `@lendasat/lendaswap-sdk-pure/node` entry point. */
-export * from "@lendasat/lendaswap-sdk-pure/node";
-//# sourceMappingURL=node.d.ts.map
+export * from '@lendasat/lendaswap-sdk-pure/node';

package/dist/node.js

@@ -1,3 +1,3 @@
-/** Re-export of the legacy `@lendasat/lendaswap-sdk-pure/node` entry point. */
+// src/node.ts
 export * from "@lendasat/lendaswap-sdk-pure/node";
 //# sourceMappingURL=node.js.map

package/dist/node.js.map

@@ -1 +1 @@
-{"version":3,"file":"node.js","sourceRoot":"","sources":["../src/node.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,cAAc,mCAAmC,CAAC"}
+{"version":3,"sources":["../src/node.ts"],"sourcesContent":["/** Re-export of the legacy `@lendasat/lendaswap-sdk-pure/node` entry point. */\nexport * from \"@lendasat/lendaswap-sdk-pure/node\";\n"],"mappings":";AACA,cAAc;","names":[]}

package/package.json

@@ -1,27 +1,51 @@
 {
   "name": "@satora/swap",
-  "version": "0.0.3",
+  "version": "0.0.5-rc.0",
   "description": "Satora swap client",
   "type": "module",
-  "main": "dist/index.js",
+  "main": "dist/index.cjs",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
     },
     "./node": {
-      "types": "./dist/node.d.ts",
-      "import": "./dist/node.js"
+      "import": {
+        "types": "./dist/node.d.ts",
+        "default": "./dist/node.js"
+      },
+      "require": {
+        "types": "./dist/node.d.cts",
+        "default": "./dist/node.cjs"
+      }
     },
     "./delegate": {
-      "types": "./dist/delegate.d.ts",
-      "import": "./dist/delegate.js"
+      "import": {
+        "types": "./dist/delegate.d.ts",
+        "default": "./dist/delegate.js"
+      },
+      "require": {
+        "types": "./dist/delegate.d.cts",
+        "default": "./dist/delegate.cjs"
+      }
     },
     "./cctp-bridge": {
-      "types": "./dist/cctp-bridge.d.ts",
-      "import": "./dist/cctp-bridge.js"
+      "import": {
+        "types": "./dist/cctp-bridge.d.ts",
+        "default": "./dist/cctp-bridge.js"
+      },
+      "require": {
+        "types": "./dist/cctp-bridge.d.cts",
+        "default": "./dist/cctp-bridge.cjs"
+      }
     }
   },
   "files": [
@@ -32,6 +56,7 @@
   },
   "devDependencies": {
     "@biomejs/biome": "2.3.15",
+    "tsup": "^8.5.1",
     "typescript": "^5.7.0"
   },
   "license": "MIT",
@@ -39,7 +64,7 @@
     "access": "public"
   },
   "scripts": {
-    "build": "tsc -p tsconfig.build.json",
+    "build": "tsup",
     "check-types": "tsc -p tsconfig.json --noEmit",
     "lint": "biome check .",
     "lint:fix": "biome check --write .",

package/dist/cctp-bridge.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"cctp-bridge.d.ts","sourceRoot":"","sources":["../src/cctp-bridge.ts"],"names":[],"mappings":"AAAA,sFAAsF;AACtF,cAAc,0CAA0C,CAAC"}

package/dist/delegate.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"delegate.d.ts","sourceRoot":"","sources":["../src/delegate.ts"],"names":[],"mappings":"AAAA,mFAAmF;AACnF,cAAc,uCAAuC,CAAC"}

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,cAAc,8BAA8B,CAAC"}

package/dist/node.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../src/node.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,cAAc,mCAAmC,CAAC"}