Skip to content

docs(readme): add architecture overview and correct test list - #9

Open
brianlukonsolo wants to merge 1 commit into
mainfrom
docs/readme-architecture-update
Open

docs(readme): add architecture overview and correct test list#9
brianlukonsolo wants to merge 1 commit into
mainfrom
docs/readme-architecture-update

Conversation

@brianlukonsolo

Copy link
Copy Markdown
Owner

Summary

Studied the project and updated the README to fill accuracy/coverage gaps. No source code changed — docs only.

Changes

  • New Architecture section documenting the three-process runtime model that wasn't described before:
    • OpenResty/nginx worker (8080) serving the HTTP API + static frontend
    • P2P daemon (p2p_daemon.lua, 19100/tcp) — signed native TCP transport over TLS
    • Gossip daemon (gossip_daemon.lua, 19090/udp) — UDP discovery announcements
    • Explains that the daemons never touch state directly — they bridge into the node over loopback HTTP via the peer-authenticated /api/network/p2p/* and /api/network/gossip/announce routes.
  • Published-ports table and a source-layout guide mapping app.lua, init_worker.lua, the daemons, and each classes/ module.
  • Added SQLite to the Stack list.
  • Fixed the Tests section./test.sh runs both blockchain_spec.lua and config_spec.lua, but only the former was documented.

🤖 Generated with Claude Code

- Document the three-process runtime model (nginx worker + P2P daemon +
  gossip daemon) and the loopback /api/network bridge between them
- Add a published-ports table and a source-layout guide
- Note SQLite in the stack list
- Fix the Tests section to list both blockchain_spec.lua and config_spec.lua

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant