Skip to content

Latest commit

 

History

History
50 lines (41 loc) · 4.71 KB

README.md

File metadata and controls

50 lines (41 loc) · 4.71 KB

Documentation

This documentation describes the code on main. Each project has its own documentation; the deployment lifecycle, the E2E harness and the development toolchain are shared. Each topic has one canonical page; other pages link to it rather than restating it, so a behavior change needs one documentation edit.

Projects

Project Start here
Tempo Earn Earn documentation: architecture, engines, modules, integrations, audits, glossary
Zone router Zone router: ZoneRouter, its factory and spenders
Card spend Design: the provider-agnostic core; providers: Bridge, Rain

Document ownership

Shared topics. Each project's index above owns its own topics.

Topic Canonical document
Repository map: the projects and shared tooling README
Contribution setup, per-area commands, and pull request conventions Contributing
Vulnerability reporting and security scope Security policy
Threat models: attackers, trust boundaries, invariants, accepted risks Threat models
Toolchain, required checks, contract size, gas, coverage, CI, dependency policy Development
Localnet consumer API, layer, lifecycle, and image and fixture constraints Localnet
Shared deployment lifecycle, records, verification, handoffs, hosted releases Deployment
Authored profile JSON, rewards configuration, and test fixture bootstrap Profiles
Deployment package exports, ABIs, modules, and registries deployments/README.md
Current hosted state and troubleshooting Hosted environments
Stacks deployed outside this repository External deployments
E2E cases, selection, profile acceptance, credentials, and existing devnets E2E environments
User-perceived latency benchmarks and Zone withdrawal exit latency Benchmarks
Agent instruction structure and maintenance Guide maintenance

Documentation rules

  • Document current behavior only. Implementation claims come from main; there are no plans, rollout history, dated snapshots, or legacy notes.
  • One canonical page per topic. Update the page that owns the changed behavior; other pages link to it rather than restating it.
  • Addresses have one owner. Generated deployment.json records own profile deployments; a test profile's fixture.json owns its E2E fixture; factory registries own shared releases. Other pages link rather than copy.
  • Security claims are explicit. “Private” always identifies the observer, the sequencer's visibility, and public amount/timing leakage.
  • Removing an integration removes every reference to it.

Projects add their own rules, such as Earn's.