All notable changes to PredictIQ will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Comprehensive developer onboarding documentation (CONTRIBUTING.md, DEVELOPMENT.md, ARCHITECTURE.md)
- Repository cleanup and organization
- Documentation structure in docs/ directory
- Archive directory for historical documentation
- Pull request template in .github/
- CHANGELOG.md for tracking changes
- Reorganized repository structure for better navigation
- Moved gas optimization docs to docs/gas/
- Moved security docs to docs/security/
- Moved quick reference guides to docs/quick-reference/
- Archived historical implementation summaries
- Repository root decluttered
- Documentation hierarchy established
1.0.0 - 2024-01-15
- Initial release of PredictIQ smart contracts
- Market creation and management functionality
- Betting system with odds calculation
- Oracle integration (Pyth Network and Reflector)
- Hybrid resolution mechanism (oracle + community voting)
- Community voting system for disputed markets
- Dispute resolution mechanism
- Fee management system
- Circuit breaker for emergency pause
- Admin functions for contract management
- Comprehensive test suite
- Gas optimization benchmarks
- Event emission for off-chain indexing
- Multi-token support
- Governance module
- Role-based access control
- Input validation on all public functions
- Reentrancy protection
- Integer overflow protection
- Circuit breaker mechanism
- Monitoring and error tracking
- README with project overview
- API specification document
- Gas optimization guides
- Security documentation
- Quick reference guides
0.9.0 - 2023-12-01
- Beta release for testnet
- Core market functionality
- Basic oracle integration
- Initial test suite
- Performance optimization needed
- Additional oracle providers to be added
- Governance features in development
- Unreleased - Current development
- 1.0.0 - 2024-01-15 - Initial stable release
- 0.9.0 - 2023-12-01 - Beta release
See CONTRIBUTING.md for how to contribute to this project.
We use Semantic Versioning:
- MAJOR version for incompatible API changes
- MINOR version for backwards-compatible functionality additions
- PATCH version for backwards-compatible bug fixes
When adding entries:
- Add new entries to Unreleased section
- Use categories: Added, Changed, Deprecated, Removed, Fixed, Security
- Include issue/PR references where applicable
- Keep descriptions clear and concise
- Update version links at the bottom