Skip to main content

​
Changelog

This page tracks changes, improvements, and updates to the Clementine bridge project.
For the most up-to-date changelog, see CHANGELOG.md in the GitHub repository.

​
Version History

​
v0.4.0

Release notes will be filled out after the v0.4.0 release.
This version is currently in development. Check the GitHub releases page for updates.

​
Unreleased Changes

The main branch contains ongoing development work. Recent improvements include:
  • Enhanced MuSig2 implementation for better signature aggregation
  • Improved RPC authentication with mutual TLS
  • Database migration system improvements
  • Performance optimizations for circuit generation
  • Expanded test coverage for integration scenarios
Want to see what’s being worked on? Check the pull requests on GitHub.

​
Release Process

Clementine follows semantic versioning:
  • Major versions (x.0.0) - Breaking changes that require migration
  • Minor versions (0.x.0) - New features, backward compatible
  • Patch versions (0.0.x) - Bug fixes and minor improvements

​
Staying Updated

​
Watch the Repository

Stay informed about new releases:
  1. Watch releases on GitHub
  2. Click “Watch” → “Custom” → “Releases”
  3. Get notified when new versions are published

​
Upgrade Guides

When upgrading between versions:
  1. Read the release notes for breaking changes
  2. Update dependencies: 
    # Ensure you have the correct RISC Zero version
rzup install cargo-risczero 2.1.0
rzup install r0vm 2.1.0
  3. Run database migrations if schema changed: 
    # Migrations run automatically on startup
./target/release/clementine-core verifier --config config.toml
  4. Update configuration files if new options were added
  5. Run tests to verify compatibility: 
    cargo test --all-features

​
Recent Highlights

​
Architecture Improvements

  • Multi-actor support: Single binary can act as verifier, operator, or aggregator
  • Flexible configuration: Support for both TOML files and environment variables
  • Docker support: Pre-built images and compose files for easy deployment

​
Security Enhancements

  • Mutual TLS (mTLS): Encrypted and authenticated gRPC communications
  • Client certificate verification: Role-based access control for RPC methods
  • Key deletion covenant: N-of-N multisig with trust-minimized security

​
Developer Experience

  • Improved testing: Separate unit and integration test commands
  • Better documentation: Comprehensive usage guides and API docs
  • Helper scripts: Automated certificate generation and deployment tools
  • Docker Compose: Full local development environment

​
Performance

  • BitVM cache: Pre-generated cache for faster startup
  • Optimized circuits: Improved proof generation performance
  • Database optimizations: Better connection pooling and query performance

​
Breaking Changes

Always review breaking changes before upgrading to a new major version.
When we introduce breaking changes, we provide:
  • Migration guides for updating your code
  • Deprecation warnings in advance when possible
  • Backward compatibility for at least one minor version when feasible

​
Reporting Issues

Found a bug in a specific version?
  1. Check if it’s fixed in the latest release
  2. Search existing issues on GitHub
  3. Create a new issue with:
    • Version number where bug occurs
    • Steps to reproduce
    • Expected vs actual behavior
    • Environment details
See Contributing Guide for more details on reporting issues.

​
Version Support

​
Active Support

  • Current stable release: Full support with bug fixes and security updates
  • Previous minor version: Security updates and critical bug fixes

​
End of Life

Older versions may not receive updates. We recommend always using the latest stable release.
Subscribe to the Citrea blog for announcements about major releases and important updates.

​
Contributing to Changelog

The changelog is automatically updated based on GitHub activity. When submitting PRs:
  1. Use conventional commits: 
    feat: add new withdrawal mechanism
fix: resolve race condition in deposit flow
docs: update API documentation
  2. Link to issues: 
    fix: resolve deposit timeout issue (#123)
  3. Add breaking change notes in PR description if applicable
See the Contributing Guide for more details.

​
Historical Releases

For complete version history, including detailed commit logs and merged PRs, visit the GitHub releases page.

​
Roadmap

Interested in what’s coming next?

​
Getting Help

If you have questions about a specific version:
Star the Clementine repository on GitHub to show your support and stay updated!

Build docs developers (and LLMs) love

Get started for freeTalk to us