This repo is the catch-all for everything research-, design-, and ops-flavoured across the zkCoins project: papers, primary sources, protocol analysis, design drafts, benchmark write-ups, throwaway spikes, and upstream reference repos. Shippable software lives in zk-coins/node / zk-coins/sdk / zk-coins/app; the target-design specification lives in zk-coins/docs.
| Material | Location |
|---|---|
| Paper PDFs (ePrint etc.) | repo root, <topic>-paper.pdf, referenced from README.md |
| Archived full-text articles / threads | primary-sources/ |
| Original upstream repos | upstream/ as git submodules (see .gitmodules) |
| Design drafts | zkcoins-design/ |
| Benchmark results | benchmarks/ |
| Throwaway research crates / experiments | spikes/ |
| Community & research pages | community-content/ |
| Backend/deployment ops notes | operations/ |
| Formal analysis | formal/ |
| Working notes | notes/ |
- Put it in the matching directory above; create a new top-level directory only if nothing fits.
- Give each imported directory a short
README.mdstating its provenance (where it came from, when, and why) — archived material is kept verbatim, not rewritten. - Reference new papers and analyses from the root
README.mdcontents tree. - Add upstream code as a submodule under
upstream/, never as a copy. - Commit directly to
develop(this repo is not branch-protected). Commit messages: English, concise, what not how.
developis the working branch — commit to it directly (see rule 5 above).mainis the released, stable snapshot.- On every push to
develop, an auto-release-PR workflow opens aRelease: develop -> mainPR (unless one is already open). A maintainer merges it to cut a release.
- zk-coins/node — Rust backend.
- zk-coins/docs — specification (docs.zkcoins.com).