-
Notifications
You must be signed in to change notification settings - Fork 84
Labels
Stellar WaveIssues in the Stellar wave programIssues in the Stellar wave programcontractsmonitoringobservabilitysoroban
Description
Description
- Resolution, disputes, and pause events must be observable by indexers.
Requirements and context
- Must be secure, tested, and documented.
- Should be efficient and easy to review for auditors and integrators.
- Scope is Predictify Hybrid Soroban smart contracts in
predictify-contractsonly (no frontend or backend services).
Suggested execution
- Fork the repository and create a branch:
git checkout -b feature/monitoring-hooks
- Implement changes:
- Contract / module: update logic in
contracts/predictify-hybrid/src/monitoring.rsand related modules as required. - Tests: extend or add
tests(and supporting test utilities undercontracts/predictify-hybrid/src/tests/when applicable). - Documentation: update or add
docs/gas/GAS_MONITORING.md; add a link fromdocs/README.mdwhen adding new top-level docs. - Comments: use Rust doc comments (
///,//!) on all new or changed public contract API — equivalent discipline to NatSpec for Solidity.
- Contract / module: update logic in
Primary touchpoints: contracts/predictify-hybrid/src/monitoring.rs
Test and commit
- Run
cargo test -p predictify-hybridand narrow with filters while iterating. - Add regression tests for every bug or ambiguity found during review.
- In the PR, include summarized test output and short security notes (threat model, invariants proven, explicit non-goals).
Example commit message
feat(contract): monitoring hooks for critical transitions
Guidelines
- Target ≥ 95% line coverage on modules touched (e.g.
cargo llvm-cov/cargo tarpaulinper repo conventions). - Documentation must be sufficient for an external integrator without reading all Rust internals.
- Timeframe: 96 hours from assignment.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Stellar WaveIssues in the Stellar wave programIssues in the Stellar wave programcontractsmonitoringobservabilitysoroban