thePR0M3TH3AN/bitvid
1
0 Fork 0
mirror of https://github.com/PR0M3TH3AN/bitvid.git synced 2026-10-27 07:52:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
dd3fbfdae642ea5ebfceffdf82b7b1726efbbe84
bitvid/PROTOCOL_INVENTORY.md
T
google-labs-jules[bot]andPR0M3TH3AN c75ed4d431 feat(protocol): Create initial protocol inventory and report 
- Create `PROTOCOL_INVENTORY.md` to track non-NIP dependencies (BitTorrent, HLS, LNURL, HTTP Auth).
- Generate `reports/protocol/protocol-report-2026-02-25.md` with findings and recommendations.
- Fix linting false positives by excluding `torch/` and `dev/` directories from design system checks.
- Add `protocol-research-agent` task log.

Co-authored-by: PR0M3TH3AN <[email protected]>
2026-02-25 18:25:04 +00:00

3.6 KiB
Raw Blame History

Protocol Inventory

This document tracks external protocol and specification dependencies used by the codebase. It complements NIP_INVENTORY.md which specifically tracks Nostr Implementation Possibilities.

1. Nostr (NIPs)

For a detailed inventory of supported NIPs (Nostr Implementation Possibilities), please refer to NIP_INVENTORY.md.

Summary of Key NIPs:

  • NIP-01: Basic Protocol Flow (Compliant)
  • NIP-71: Video Events (Partial/Compliant)
  • NIP-94: File Metadata (Compliant)
  • NIP-44: Encrypted Payloads (Compliant)

2. BitTorrent / WebTorrent

Protocol Spec Source URL Implementation Status
BitTorrent BEP-0003 bittorrent.org js/services/playbackService.js Compliant (via WebTorrent)
Magnet URI BEP-0009 bittorrent.org js/magnetUtils.js Compliant
WebSeed BEP-0019 bittorrent.org js/magnetUtils.js Compliant
WebTorrent WebRTC-based BitTorrent webtorrent.io js/services/playbackService.js Compliant

Notes:

  • js/magnetUtils.js implements parsing and normalization of magnet links, ensuring xt, ws, and xs parameters are handled correctly.
  • js/services/playbackService.js handles the fallback logic between HTTP and WebTorrent playback.

3. Media Streaming

Protocol Spec Source URL Implementation Status
HLS RFC 8216 rfc-editor.org Native Browser / video tag Compliant

Notes:

  • The application supports .m3u8 (HLS) playback natively via the browser's video element (Safari) or via HLS.js if integrated (currently relies on browser/device native support or passthrough).
  • Inputs in components/upload-modal.html accept .m3u8 and .ts files.

4. Lightning Network (LNURL)

Protocol Spec Source URL Implementation Status
LNURL LUD-01, LUD-06, LUD-16 github.com/lnurl js/payments/lnurl.js Compliant
Zap Requests NIP-57 nips.be js/payments/zapRequests.js Compliant

Notes:

  • js/payments/lnurl.js implements Bech32 decoding/encoding and LNURL resolution.
  • js/payments/zapReceiptValidator.js validates receipts against the LNURL server's public key.

5. HTTP & Authentication

Protocol Spec Source URL Implementation Status
Nostr HTTP Auth NIP-98 / Kind 27235 nips.be js/services/r2Service.js Compliant
S3 / R2 API AWS S3 Compat aws.amazon.com js/services/r2Service.js Compliant

Notes:

  • js/services/r2Service.js uses NIP-98 style authentication for uploads to compatible storage services (Cloudflare R2).

Compliance & Remediation

  • NIP-42 (Auth): Marked as Non-compliant in NIP_INVENTORY.md. Remediation involves implementing AUTH command handling in js/nostr/client.js.
  • HLS: Reliance on native browser support might limit compatibility on some desktop browsers (Firefox/Chrome on Windows without extensions). Consider integrating hls.js if not already present.
Reference in new issue View Git Blame Copy Permalink