Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (24 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

31 lines (24 loc) · 1.44 KB
Raw

Contributing to zkCoins API

This repository is the standalone API process (src/startup.rs loads config and connects the kernel). It exposes REST on top of the node's internal kernel RPC (specification §7.5 / §7.8).

What belongs here

  • The public REST service layer (multi-tenant, hosted-wallet surface).
  • Planned API-local scope (not implemented yet): LNURL mappings, aliasing, rate limits, push subscriptions. Coins, proofs, and the nullifier accumulator stay in the node — this layer never touches the node's database directly.
  • No SPEND keys, no Bitcoin access — proving, broadcasting, and chain scanning stay in the node.

Workflow

  • Default branch is develop; open PRs against it.
  • Commit messages: English, concise, what not how.
  • House rules for the trust model and Rust style follow zk-coins/node/CONTRIBUTING.md. Workflow here differs: PRs target develop (this repo has no staging), there is no Node .githooks setup, and CI is the single lint-and-build job in .github/workflows/ci.yaml.

Related Repos