Skip to content

docs: emergency ops, intents catalog, and threat model#6

Merged
sirambrosio merged 7 commits into
mainfrom
docs/emergency-ops-and-threat-model
Apr 20, 2026
Merged

docs: emergency ops, intents catalog, and threat model#6
sirambrosio merged 7 commits into
mainfrom
docs/emergency-ops-and-threat-model

Conversation

@sirambrosio
Copy link
Copy Markdown
Contributor

Summary

  • Gap C: Added "Emergency Operations" section to spec/governance.md — covers trigger conditions, ACTION_SUSPEND_IEO schema, 2-of-3 multi-sig threshold, and the full reactivation process.
  • Gap D: Created docs/INTENTS_CATALOG.md — authoritative list of SUBMIT_RECORD, READ_RECORDS, EXPORT_DATA, and MANAGE_CONSENT with descriptions, authorized IEO types, data scope, and restrictions.
  • Gap E: Created docs/THREAT_MODEL.md — three adversary models (network observer, compromised relayer, malicious IEO), trust assumptions table, attack surfaces with implemented mitigations, and explicit out-of-scope items.

Files changed

  • spec/governance.md — new Emergency Operations section before BIP Index
  • docs/INTENTS_CATALOG.md — new file
  • docs/THREAT_MODEL.md — new file

Test plan

  • Review Emergency Operations section for alignment with existing Governance contract action types
  • Confirm INTENTS_CATALOG intent list matches spec/ieo.md Exchange Intents table
  • Confirm THREAT_MODEL adversary models are consistent with spec/exchange.md access control rules

🤖 Generated with Claude Code

sirambrosio and others added 7 commits April 20, 2026 10:08
- docs/ARCHITECTURE.md: system diagram + sequence diagrams for create BEO,
  grant ConsentToken, submit BioRecord, and destroy BEO flows. Component
  responsibilities + trust boundaries documented.
- docs/GLOSSARY.md: canonical definitions for BEO, IEO, BioRecord,
  ConsentToken, Scope, Intent, Domain, Guardian, Recovery, Relayer, and
  taxonomy terms. Normative — all implementations MUST use these meanings.
- docs/ERROR_CODES.md: consolidated stable error code catalog cross-linked
  to contracts, API, SDK, CLI, and MCP sources.
- docs/SLA.md: 99.5% monthly uptime target for Registry API, P95 <500ms
  for reads and <3s for writes, maintenance windows, incident
  classification, communication channels, data integrity guarantees,
  SLA breach reporting procedure.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Merge contracts (78 abort_codes) + API (31 machine codes) + SDK/CLI/MCP
surfaces into one canonical catalog. Downstream repos will link here
instead of duplicating tables.

Structure:
- Part I — Protocol-level string codes (SDK/CLI/MCP)
- Part II — Registry API HTTP + machine codes
- Part III — Move abort_code ranges per module
- Part IV — SDK / CLI / MCP surface notes

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Gap C: add Emergency Operations section to spec/governance.md covering
  trigger conditions, ACTION_SUSPEND_IEO, 2-of-3 threshold, and
  reactivation process.
- Gap D: create docs/INTENTS_CATALOG.md as authoritative reference for
  SUBMIT_RECORD, READ_RECORDS, EXPORT_DATA, and MANAGE_CONSENT.
- Gap E: create docs/THREAT_MODEL.md with adversary models (network
  observer, compromised relayer, malicious IEO), trust assumptions,
  attack surfaces with mitigations, and explicit out-of-scope items.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@sirambrosio sirambrosio merged commit 193a4dc into main Apr 20, 2026
@sirambrosio sirambrosio deleted the docs/emergency-ops-and-threat-model branch April 20, 2026 19:03
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