Skip to content

Vault: request_id event encoding (empty symbol convention) #115

@greatest0fallt1me

Description

@greatest0fallt1me

Description

Document and test how optional request_id is represented in deduct event topics so indexers parse consistently.

Requirements and context

  • Avoid breaking schema changes without an explicit version/migration note.
  • Align EVENT_SCHEMA.md with implementation.

Suggested execution

  • Fork the repo and create a branch: git checkout -b docs/vault-request-id-events
  • Implement changes in the Callora-Contracts Soroban workspace (contracts/*/src/).
  • Run cargo fmt, cargo clippy --all-targets --all-features -- -D warnings, and cargo test from the workspace root.
  • For WASM release builds: cargo build --target wasm32-unknown-unknown --release -p callora-vault (adjust -p if the crate name differs).

Deliverables

  • EVENT_SCHEMA.md + test.rs (where the Soroban test harness allows assertions).
  • UPGRADE.md note if behavior changes.

Test and commit

  • Run tests and ./scripts/coverage.sh (or cargo tarpaulin per tarpaulin.toml).
  • Cover edge cases; include summarized test output and brief security notes in the PR description.

Example commit message

docs(vault): clarify request_id event encoding

Guidelines

  • Minimum 95% line coverage for touched crates (workspace policy).
  • Clear documentation (Rust /// on public items where applicable; repo markdown as needed).
  • Timeframe: 96 hours from assignment unless agreed otherwise.

Metadata

Metadata

Assignees

Labels

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions