@hypawave/sdk 0.1.0 → 0.1.2
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.
- package/README.md +24 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,6 +8,8 @@
|
|
|
8
8
|
|
|
9
9
|
*Status: Alpha. API is usable; breaking changes possible before 1.0.*
|
|
10
10
|
|
|
11
|
+
> ⚠️ **Hypawave has no token and will never issue one.** Any "HYPA," "WAVE," airdrop, or token offer claiming to be from Hypawave is a scam. Hypawave is non-custodial Bitcoin Lightning settlement — buyers pay creators directly in sats. The protocol fee is the only economic primitive.
|
|
12
|
+
|
|
11
13
|
TypeScript SDK for settlement-triggered Lightning execution. Fetch creator-direct Lightning invoices, confirm preimage proof, and trigger deterministic unlocks.
|
|
12
14
|
|
|
13
15
|
**Payment is the authorization — confirmed settlement unconditionally unlocks access.**
|
|
@@ -331,6 +333,17 @@ const settings = await pp.getSettings();
|
|
|
331
333
|
// settings.btc_usd_price
|
|
332
334
|
```
|
|
333
335
|
|
|
336
|
+
### Other Methods
|
|
337
|
+
|
|
338
|
+
Additional methods available — see types for full signatures, or [openapi.json](https://hypawave.com/.well-known/openapi.json) for the complete API reference.
|
|
339
|
+
|
|
340
|
+
- `listInvoices(params?)` — list invoices with filters and pagination
|
|
341
|
+
- `getPayerReceipt(invoiceId, accessToken)` — receipt fetch using a payer access token (no API key needed)
|
|
342
|
+
- `getUploadUrl(params)` — signed URL for encrypted file upload (creator side)
|
|
343
|
+
- `storeFile(params)` — register an uploaded file against an invoice
|
|
344
|
+
- `storeFileKey(params)` — register a file's encryption key against an invoice
|
|
345
|
+
- `request(path, options)` — low-level escape hatch for direct API calls
|
|
346
|
+
|
|
334
347
|
## Error Handling
|
|
335
348
|
|
|
336
349
|
All API errors throw `HypawaveAPIError` with structured fields:
|
|
@@ -422,6 +435,17 @@ Hypawave is the execution layer: the same preimage that proves payment atomicall
|
|
|
422
435
|
- **Security**: report privately to support@hypawave.com (please do not file public issues for vulnerabilities)
|
|
423
436
|
- **General inquiries**: support@hypawave.com
|
|
424
437
|
|
|
438
|
+
### Official Channels Only
|
|
439
|
+
|
|
440
|
+
Hypawave only operates via these official channels. Anything else is impersonation:
|
|
441
|
+
|
|
442
|
+
- **Website**: [hypawave.com](https://hypawave.com)
|
|
443
|
+
- **GitHub**: [github.com/hypawave/sdk](https://github.com/hypawave/sdk)
|
|
444
|
+
- **npm**: [npmjs.com/package/@hypawave/sdk](https://www.npmjs.com/package/@hypawave/sdk)
|
|
445
|
+
- **Email**: support@hypawave.com
|
|
446
|
+
|
|
447
|
+
There is no Hypawave token, airdrop, ICO, or sale. Hypawave does not request wallet connections outside its documented payment flow. Verify any link claiming to be Hypawave against this list before connecting a wallet or signing transactions.
|
|
448
|
+
|
|
425
449
|
## License
|
|
426
450
|
|
|
427
451
|
[MIT](./LICENSE)
|
package/package.json
CHANGED