Repository navigation
docs: update network specification and architecture table with BitChat and Dispatch details - #36
Merged
Merged
Conversation
…t and Dispatch details
There was a problem hiding this comment.
🟡 Changes recommended
Critical security and protocol-accuracy findings remain unresolved.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Updates the README architecture overview and network specification with BitChat and Dispatch details.
Changes:
- Adds Dispatch and BitChat architecture entries.
- Expands BitChat documentation for discovery, transport, binders, tasks, and UI routing.
File summaries
| File | Findings |
|---|---|
README.md |
Moderate (3 votes): incorrect BitChat module locations and overstated P2P behavior. Nit (1 vote): omits Dispatch API and frontend player entry points. |
docs/UCORE_NETWORK_SPEC_2026.md |
Critical (3 votes): incorrectly marks unauthenticated, unencrypted JSON/SQLite handling as implemented. Nit (2 votes): inaccurate binder and commit-path description. Critical (1 vote): missing default route authentication. Critical (1 vote): unvalidated binder_name permits writes outside the vault. |
Review details
Suppressed comments (3)
README.md:16
- The location column omits the public API and player that this row describes:
/p/:tokenis served throughbackend/app/api/dispatch_api.pyand the Tri-Mode player lives infrontend-vue/src/surfaces/dispatch/. Please list those entry points (or narrow the responsibility text), otherwise this architecture table directs readers only to service internals.
| **Sovereign Dispatch** | `backend/app/services/dispatch_*` | Ephemeral stories (`/p/:token`), Tri-Mode player, bulletproof email, and offline capsules |
docs/UCORE_NETWORK_SPEC_2026.md:67
- Neither mDNS/Bonjour nor UDP beacon reception is implemented in
mesh_transport.py:send_broadcast_beacon()only callssendto, andstart()merely flips_runningwithout creating a listener. Devices therefore cannot discover peers as this sentence says; implement the listener/advertiser or document this as outbound announcement only.
1. **Discovery**: Devices on the same subnet discover the uCore BitChat endpoint via **mDNS / Bonjour** service advertisement (`_bitchat._tcp.local.`) and standard library UDP broadcast beacons on port `53535` (`backend/app/services/mesh_transport.py`).
docs/UCORE_NETWORK_SPEC_2026.md:74
convert_message_to_task()delegates todefault_tasker_dir(), whose default is$UDOS_HOME/flow/tasks(withUFLOW_TASKS_DIR/UCORE_TASKER_DIRoverrides), not~/Vault/tasks. The documented path is wrong and users or integrations will look in the wrong location.
* **Convert to Task**: Chat action items can be promoted directly to sovereign `.tasker` markdown tasks in `~/Vault/tasks/inbox/` with optional Apple Reminders synchronization.
- Files reviewed: 2/2 changed files
- Comments generated: 5
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| --- | ||
|
|
||
| ## 3. BitChat: Local-First Private Communication | ||
| ## 3. BitChat: Local-First Private Communication (Implemented) |
| 1. **Discovery**: Devices on the same subnet discover the uCore BitChat endpoint via **mDNS / Bonjour** service advertisement (`_bitchat._tcp.local.`). | ||
| 2. **Transport**: Lightweight WebSocket connection (`/api/network/bitchat/ws`). | ||
| 1. **Discovery**: Devices on the same subnet discover the uCore BitChat endpoint via **mDNS / Bonjour** service advertisement (`_bitchat._tcp.local.`) and standard library UDP broadcast beacons on port `53535` (`backend/app/services/mesh_transport.py`). | ||
| 2. **Transport**: Lightweight WebSocket connection (`/api/network/bitchat/ws`) and fallback REST endpoints (`/api/network/bitchat/send`, `/api/network/bitchat/messages`). |
| * Discussions regarding project briefs, decisions, or research can be saved with one click. | ||
| * The selected chat thread is formatted as Markdown evidence and committed to the active binder under `evidence/chats/YYYY-MM-DD-thread.md`. | ||
| ### uDos Integration: "Save to Binder" & "Convert to Task" | ||
| * **Save to Binder**: Discussions regarding project briefs, decisions, or research can be saved with one click. The selected chat thread is formatted as Markdown evidence and committed to the active binder under `~/Vault/binders/<binder>/evidence/chats/YYYY-MM-DD-thread.md`. |
| | **Sovereign Identity** | `backend/app/identity/` | Local profiles, keys, and headless WordPress RBAC mapping (`wordpress_mapper.py`) | | ||
| | **Network & Privacy** | `uCore-Network` | Spec: Offline local portals, BitChat LAN P2P chat, and home privacy stack | | ||
| | **Sovereign Dispatch** | `backend/app/services/dispatch_*` | Ephemeral stories (`/p/:token`), Tri-Mode player, bulletproof email, and offline capsules | | ||
| | **Network & BitChat** | `backend/app/services/mesh_*`, `bitchat_*` | Local LAN subnet beacon discovery, zero-cloud BitChat P2P messaging, and binder bridges | |
| * Discussions regarding project briefs, decisions, or research can be saved with one click. | ||
| * The selected chat thread is formatted as Markdown evidence and committed to the active binder under `evidence/chats/YYYY-MM-DD-thread.md`. | ||
| ### uDos Integration: "Save to Binder" & "Convert to Task" | ||
| * **Save to Binder**: Discussions regarding project briefs, decisions, or research can be saved with one click. The selected chat thread is formatted as Markdown evidence and committed to the active binder under `~/Vault/binders/<binder>/evidence/chats/YYYY-MM-DD-thread.md`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updates README.md architecture overview and UCORE_NETWORK_SPEC_2026.md to reflect the implemented BitChat service, mesh beacon transport, and sovereign dispatch engine.