archetech / archon / 26417723498

89%

push

github

docs(services): add missing mediator specs and audit-fix all service docs (#560)

* docs: add READMEs for filecoin, filecoin-wallet, pinning, zcash mediators

These mediators existed in services/ but had no corresponding spec under
docs/services/mediators/. Adds spec-style READMEs matching the existing
satoshi / ethereum docs.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* docs: add services index README and condense docs/index.md

Adds docs/services/README.md as a categorized index of the service
specs (core / anchoring / P2P / storage / payments), and replaces the
flat list in docs/index.md with a short grouped overview that defers to
the new index. Picks up the four previously-missing entries (zcash,
filecoin, filecoin-wallet, pinning).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* docs(filecoin-wallet): address Copilot review on PR #560

- /dag/export uses POST (Kubo HTTP RPC), not GET.
- Admin key is mandatory: ARCHON_ADMIN_API_KEY must be set or every
  /api/v1/* request is rejected with 403. Document the exact status
  codes returned by requireAdminKeyFor in both the HTTP API section
  and the conformance requirements.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* docs(services): fix accuracy issues across all service specs

Comprehensive audit-driven fixes against canonical source. Per-doc highlights:

- gatekeeper: clearQueue returns boolean (not array); remove unread
  ARCHON_DATA_DIR; correct CORS defaults; clarify verifyDb queue-clear
  semantics and GC loop ordering; size check is JSON.stringify length.
- keymaster: vaults/items uses raw body + X-Options header (not JSON);
  ids/:id/recover has no body; lightning/zap field is `did` not `id`;
  flatten 7 nested response envelopes; correct decryptMessage selection;
  files/dmail attachments read name from X-Options header; remove
  bogus asset maxDataLength claim; route count 148; add 3 missing
  routes.
- drawb... (continued)

2203 of 2529 branches covered (87.11%)

Branch coverage included in aggregate %.

4622 of 4826 relevant lines covered (95.77%)

1067.06 hits per line