Skip to content

Add per-event topic schema docs for vault_created, vault_staked, vault_slashed, vault_completed in accountability_vault #494

Description

@1nonlypiece

Add per-event topic schema docs for vault_created, vault_staked, vault_slashed, vault_completed in accountability_vault

Description

contracts/accountability_vault/src/lib.rs publishes four event topics today (vault_created, vault_staked, vault_slashed, vault_completed, vault_cancelled, vault_withdrawn, milestone_checked_in) but contracts/README.md has no schema describing topic shape and payload types. Add a table documenting topic structure, payload type, and which function emits it so src/services/eventParser.ts can be reviewed against an authoritative spec.

Requirements and context

  • Must be secure, tested, and documented
  • Should be efficient and easy to review
  • Add an event schema table to contracts/README.md
  • List every topic emitted by contracts/accountability_vault/src/lib.rs
  • Cross-link to src/services/eventParser.ts EventType enum
  • Add a doc-drift test in contracts/accountability_vault/src/test.rs if feasible

Suggested execution

  • Fork the repo and create a branch
  • git checkout -b docs/event-schema-table
  • Implement changes
    • Update contracts/README.md
    • Optionally add an assertion test in contracts/accountability_vault/src/test.rs
    • Cross-reference backend parser
    • Include rationale and version notes
  • Test and commit
    • Run tests, cover edge cases
    • Include test output and notes

Example commit message

docs: document vault event topic schema

Guidelines

  • Minimum 95 percent test coverage
  • Clear documentation
  • Timeframe: 96 hours

Metadata

Metadata

Assignees

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions