Skip to content

feat: hysteresis for oracle-health state transitions#793

Open
fadesany wants to merge 1 commit into
Predictify-org:masterfrom
fadesany:feat/oracle-health-hysteresis
Open

feat: hysteresis for oracle-health state transitions#793
fadesany wants to merge 1 commit into
Predictify-org:masterfrom
fadesany:feat/oracle-health-hysteresis

Conversation

@fadesany

Copy link
Copy Markdown
Contributor

Summary

Add hysteresis to monitor_oracle_health to prevent flapping on single-sample status changes. Instead of flipping state on every probe, we now require N consecutive bad samples to mark Degraded and M consecutive good samples to recover to Working.

Changes

  • config.rs: Added ORACLE_HEALTH_DEGRADED_THRESHOLD (3) and ORACLE_HEALTH_RECOVERY_THRESHOLD (3)
  • graceful_degradation.rs:
    • Added consecutive_good field to OracleDegradationState
    • Rewrote record_oracle_health with hysteresis:
      • 3 consecutive failures → Working → Degraded
      • 3 consecutive successes → Degraded → Working
      • Good sample resets failure counter; bad sample resets good counter
    • monitor_oracle_health now routes samples through the hysteresis gate
    • OracleHealthStatusEvent emitted only on actual state transitions
  • Tests: 6 new hysteresis tests covering degradation, recovery, edge cases, event emission

closes #623

Acceptance Criteria

  • ✅ No event emitted on no-op transitions
  • ✅ Thresholds configurable in config.rs
  • ✅ Tests cover both directions (degradation and recovery)
  • ✅ No unwrap() introduced
  • ✅ OracleHealth enum reused without breaking change

Pull Request Description

📋 Basic Information

Type of Change

Please select the type of change this PR introduces:

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📚 Documentation update
  • 🧪 Test addition/update
  • 🔧 Refactoring (no functional changes)
  • ⚡ Performance improvement
  • 🔒 Security fix
  • 🎨 UI/UX improvement
  • 🚀 Deployment/Infrastructure change

Related Issues

Closes #(issue number)
Fixes #(issue number)
Related to #(issue number)

Priority Level

  • 🔴 Critical (blocking other development)
  • 🟡 High (significant impact)
  • 🟢 Medium (moderate impact)
  • 🔵 Low (minor improvement)

📝 Detailed Description

What does this PR do?

Why is this change needed?

How was this tested?

Alternative Solutions Considered


🏗️ Smart Contract Specific

Contract Changes

Please check all that apply:

  • Core contract logic modified
  • Oracle integration changes (Pyth/Reflector)
  • New functions added
  • Existing functions modified
  • Storage structure changes
  • Events added/modified
  • Error handling improved
  • Gas optimization
  • Access control changes
  • Admin functions modified
  • Fee structure changes

Oracle Integration

  • Pyth oracle integration affected
  • Reflector oracle integration affected
  • Oracle configuration changes
  • Price feed handling modified
  • Oracle fallback mechanisms
  • Price validation logic

Market Resolution Logic

  • Hybrid resolution algorithm changed
  • Dispute mechanism modified
  • Fee structure updated
  • Voting mechanism changes
  • Community weight calculation
  • Oracle weight calculation

Security Considerations

  • Access control reviewed
  • Reentrancy protection
  • Input validation
  • Overflow/underflow protection
  • Oracle manipulation protection

🧪 Testing

Test Coverage

  • Unit tests added/updated
  • Integration tests added/updated
  • All tests passing locally
  • Manual testing completed
  • Oracle integration tested
  • Edge cases covered
  • Error conditions tested
  • Gas usage optimized
  • Cross-contract interactions tested

Test Results

# Paste test output here
cargo test
# Expected output: X tests passed, Y tests failed

Manual Testing Steps


📚 Documentation

Documentation Updates

  • README updated
  • Code comments added/updated
  • API documentation updated
  • Examples updated
  • Deployment instructions updated
  • Contributing guidelines updated
  • Architecture documentation updated

Breaking Changes

Breaking Changes:

Migration Guide:


🔍 Code Quality

Code Review Checklist

  • Code follows Rust/Soroban best practices
  • Self-review completed
  • No unnecessary code duplication
  • Error handling is appropriate
  • Logging/monitoring added where needed
  • Security considerations addressed
  • Performance implications considered
  • Code is readable and well-commented
  • Variable names are descriptive
  • Functions are focused and small

Performance Impact

  • Gas Usage:
  • Storage Impact:
  • Computational Complexity:

Security Review

  • No obvious security vulnerabilities
  • Access controls properly implemented
  • Input validation in place
  • Oracle data properly validated
  • No sensitive data exposed

🚀 Deployment & Integration

Deployment Notes

  • Network: Testnet/Mainnet
  • Contract Address:
  • Migration Required: Yes/No
  • Special Instructions:

Integration Points

  • Frontend integration considered
  • API changes documented
  • Backward compatibility maintained
  • Third-party integrations updated

📊 Impact Assessment

User Impact

  • End Users:
  • Developers:
  • Admins:

Business Impact

  • Revenue:
  • User Experience:
  • Technical Debt:

✅ Final Checklist

Pre-Submission

  • Code follows Rust/Soroban best practices
  • All CI checks passing
  • No breaking changes (or breaking changes are documented)
  • Ready for review
  • PR description is complete and accurate
  • All required sections filled out
  • Test results included
  • Documentation updated

Review Readiness

  • Self-review completed
  • Code is clean and well-formatted
  • Commit messages are clear and descriptive
  • Branch is up to date with main
  • No merge conflicts

📸 Screenshots (if applicable)

🔗 Additional Resources

  • Design Document:
  • Technical Spec:
  • Related Discussion:
  • External Documentation:

💬 Notes for Reviewers

Please pay special attention to:

Questions for reviewers:


Thank you for your contribution to Predictify! 🚀

## Summary

Add hysteresis to `monitor_oracle_health` to prevent flapping on single-sample status changes.
Instead of flipping state on every probe, we now require N consecutive bad samples to mark
Degraded and M consecutive good samples to recover to Working.

## Changes

- **config.rs**: Added `ORACLE_HEALTH_DEGRADED_THRESHOLD` (3) and `ORACLE_HEALTH_RECOVERY_THRESHOLD` (3)
- **graceful_degradation.rs**:
  - Added `consecutive_good` field to `OracleDegradationState`
  - Rewrote `record_oracle_health` with hysteresis:
    * 3 consecutive failures → Working → Degraded
    * 3 consecutive successes → Degraded → Working
    * Good sample resets failure counter; bad sample resets good counter
  - `monitor_oracle_health` now routes samples through the hysteresis gate
  - `OracleHealthStatusEvent` emitted only on actual state transitions
- **Tests**: 6 new hysteresis tests covering degradation, recovery, edge cases, event emission

## Acceptance Criteria

- ✅ No event emitted on no-op transitions
- ✅ Thresholds configurable in config.rs
- ✅ Tests cover both directions (degradation and recovery)
- ✅ No unwrap() introduced
- ✅ OracleHealth enum reused without breaking change
@drips-wave

drips-wave Bot commented Jun 30, 2026

Copy link
Copy Markdown

@fadesany Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

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.

Add OracleHealth degradation hysteresis to graceful_degradation::monitor_oracle_health

1 participant