@hypawave/sdk 0.4.0 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/AGENTS.md +1 -1
  2. package/CHANGELOG.md +11 -0
  3. package/README.md +2 -0
  4. package/package.json +1 -1
  5. package/skills/hypawave/SKILL.md +1 -1
package/AGENTS.md CHANGED
@@ -91,7 +91,7 @@ For Paths 3a / 3b, there is no SDK — use raw HTTP with pubkey signatures per t
91
91
 
92
92
  ## Non-negotiables
93
93
 
94
- 1. **Preimage is mandatory** for principal settlements. Pay via a wallet that returns the preimage (LND, Core Lightning, LNbits admin key, Alby/NWC, Phoenixd). Consumer wallets like Wallet of Satoshi or Phoenix mobile cannot satisfy this.
94
+ 1. **Preimage is mandatory** for principal settlements. Pay via a wallet that returns the preimage (LND, Core Lightning, LNbits admin key, Alby/NWC, Phoenixd). Consumer wallets like Wallet of Satoshi or Phoenix mobile cannot satisfy this. The wallet also needs **funded outbound liquidity ≥ amount + fees** — a fresh/empty node or "fee-credit" balance can't pay even when total balance ≥ price. For small or test payments, a **custodial wallet over NWC (e.g. Coinos)** skips channel setup entirely — only funding is needed.
95
95
  2. **Confirm before unlocking.** Always submit preimage to the confirm endpoint before requesting file keys or download URLs.
96
96
  3. **Funds flow buyer→seller directly.** Never route principal through any Hypawave endpoint. Only activation fees (small, Hypawave-issued bolt11s) go to Hypawave.
97
97
  4. **Honor `terms_hash`** on Path 3b offers. If the server returns `409 terms_changed`, re-read the offer before paying.
package/CHANGELOG.md CHANGED
@@ -5,6 +5,17 @@ All notable changes to `@hypawave/sdk` are documented here.
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
+ ## [0.4.1]
9
+
10
+ ### Changed
11
+ - Docs only — no API changes. Clarified payer-wallet requirements in `README.md`,
12
+ `AGENTS.md`, and the bundled `skills/hypawave/SKILL.md`: the wallet needs
13
+ **funded outbound liquidity ≥ amount + fees** (a fresh/empty node or Phoenix
14
+ "fee-credit" balance can't pay even when total balance ≥ price), and for small
15
+ or test payments a **custodial wallet over NWC (e.g. Coinos)** avoids channel
16
+ setup entirely — only funding is needed. Mirrors the buyer-wallet guidance in
17
+ `llms.txt`.
18
+
8
19
  ## [0.4.0]
9
20
 
10
21
  ### Added
package/README.md CHANGED
@@ -44,6 +44,8 @@ This SDK requires **programmable Lightning infrastructure** that exposes the pre
44
44
 
45
45
  - LND, CLN, Alby API, LNbits, NWC, or equivalent
46
46
 
47
+ The wallet also needs **funded outbound liquidity ≥ amount + routing fees** — a fresh/empty node or a "fee-credit" balance (e.g. Phoenix below the channel-open threshold) cannot pay even when total balance ≥ price; only spendable channel liquidity counts. For small or test payments, a **custodial wallet over NWC (e.g. Coinos)** skips channel setup entirely — no liquidity minimum, only funding is needed.
48
+
47
49
  **Consumer wallets (Wallet of Satoshi, Phoenix, etc.) do not reliably expose the preimage and are not suitable for agent integrations.** Files and data will not unlock without a preimage.
48
50
 
49
51
  ## Install
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hypawave/sdk",
3
- "version": "0.4.0",
3
+ "version": "0.4.1",
4
4
  "description": "TypeScript SDK for Lightning settlement, preimage proof, and execution unlocks for AI agents.",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
package/skills/hypawave/SKILL.md CHANGED
@@ -86,7 +86,7 @@ For Paths 3a / 3b, there is no SDK — use raw HTTP with pubkey signatures per t
86
86
 
87
87
  ## Non-negotiables
88
88
 
89
- 1. **Preimage is mandatory** for principal settlements. Pay via a wallet that returns the preimage (LND, Core Lightning, LNbits admin key, Alby/NWC, Phoenixd). Consumer wallets like Wallet of Satoshi or Phoenix mobile cannot satisfy this.
89
+ 1. **Preimage is mandatory** for principal settlements. Pay via a wallet that returns the preimage (LND, Core Lightning, LNbits admin key, Alby/NWC, Phoenixd). Consumer wallets like Wallet of Satoshi or Phoenix mobile cannot satisfy this. The wallet also needs **funded outbound liquidity ≥ amount + fees** — a fresh/empty node or "fee-credit" balance can't pay even when total balance ≥ price. For small or test payments, a **custodial wallet over NWC (e.g. Coinos)** skips channel setup entirely — only funding is needed.
90
90
  2. **Confirm before unlocking.** Always submit preimage to the confirm endpoint before requesting file keys or download URLs.
91
91
  3. **Funds flow buyer→seller directly.** Never route principal through any Hypawave endpoint. Only activation fees (small, Hypawave-issued bolt11s) go to Hypawave.
92
92
  4. **Honor `terms_hash`** on Path 3b offers. If the server returns `409 terms_changed`, re-read the offer before paying.