Skip to content

feat: bounded ContractMonitor queue with overflow signaling#647

Merged
greatest0fallt1me merged 1 commit into
Predictify-org:masterfrom
DavidAkere204:feat/monitor-bounded-queue
Jun 27, 2026
Merged

feat: bounded ContractMonitor queue with overflow signaling#647
greatest0fallt1me merged 1 commit into
Predictify-org:masterfrom
DavidAkere204:feat/monitor-bounded-queue

Conversation

@DavidAkere204

Copy link
Copy Markdown
Contributor
  • Add MONITOR_QUEUE_CAP = 100 constant to config.rs
  • Replace unbounded store_alert (single-key overwrite) with a FIFO Vec capped at MONITOR_QUEUE_CAP entries stored under the 'MON_QUEUE' persistent key
  • Set 'MON_OVERFLOWED' flag to true whenever the oldest entry is evicted to make capacity exhaustion observable to operators
  • Avoid Vec::remove(0) in the hot path; eviction rebuilds via index loop
  • Add ContractMonitor::get_alerts, is_overflow, clear_overflow (admin- gated via require_auth + stored-admin check, no unwrap())
  • Expose get_monitor_alerts, is_monitor_overflow, clear_monitor_overflow as public contract entrypoints in lib.rs
  • Add bounded_queue_tests module covering: empty initial state, single insert, FIFO eviction at cap, cap-edge case, repeated overflow, admin clear, unauthorized clear rejection, and emit path

Closes #622

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! 🚀

- Add MONITOR_QUEUE_CAP = 100 constant to config.rs
- Replace unbounded store_alert (single-key overwrite) with a FIFO
  Vec<MonitoringAlert> capped at MONITOR_QUEUE_CAP entries stored under
  the 'MON_QUEUE' persistent key
- Set 'MON_OVERFLOWED' flag to true whenever the oldest entry is evicted
  to make capacity exhaustion observable to operators
- Avoid Vec::remove(0) in the hot path; eviction rebuilds via index loop
- Add ContractMonitor::get_alerts, is_overflow, clear_overflow (admin-
  gated via require_auth + stored-admin check, no unwrap())
- Expose get_monitor_alerts, is_monitor_overflow, clear_monitor_overflow
  as public contract entrypoints in lib.rs
- Add bounded_queue_tests module covering: empty initial state, single
  insert, FIFO eviction at cap, cap-edge case, repeated overflow, admin
  clear, unauthorized clear rejection, and emit path

Closes Predictify-org#622
@drips-wave

drips-wave Bot commented Jun 26, 2026

Copy link
Copy Markdown

@DavidAkere204 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

@greatest0fallt1me greatest0fallt1me merged commit d296260 into Predictify-org:master Jun 27, 2026
1 check failed
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 ContractMonitor pluggable alert sink with bounded queue and overflow signaling

2 participants