This repository contains the low-level crates.
If you’re looking to run Sv2 applications at the most recent changes, check out the sv2-apps repository. Those crates are application-level, currently in alpha stage.
sv1/- Stratum V1 protocol implementation and utilitiessv2/- Stratum V2 protocol implementationsbinary-sv2/- Binary encoding/decoding for SV2 messagesbuffer/- Buffer management and poolingchannels-sv2/- Channel management for SV2codec-sv2/- SV2 message codec with encryption supportframing-sv2/- SV2 message framing utilitieshandlers_sv2/- SV2 message handler traitsnoise-sv2/- Noise protocol implementation for SV2parsers-sv2/- Message parsing utilitiessubprotocols/- SV2 subprotocol implementations
stratum-core/- Entrypoint for all the low-level crates insv2/andsv1/implementationsstratum-translation- Stratum V1 ↔ Stratum V2 translation utilities
To run integration tests locally:
./scripts/run-integration-tests.shThis will:
- Clone/update the integration test framework
- Update dependencies to use your local changes
- Run the full integration test suite
- Restore the original configuration
Our roadmap is publicly available as part of the broader SRI project, outlining current and future plans. Decisions are made through a consensus-driven approach via dev meetings, Discord, and GitHub.
We welcome contributions to improve these SV2 libraries! Here's how you can help:
- Start small: Check the good first issue label in the main SRI repository
- Join the community: Connect with us on Discord before starting larger contributions
- Open issues: Create GitHub issues for bugs, feature requests, or questions
- Follow standards: Ensure code follows Rust best practices and includes appropriate tests
Join our Discord community for technical support, discussions, and collaboration:
Join the Stratum V2 Discord Community
For detailed documentation and guides, visit: Stratum V2 Documentation
If you wish to support the development and maintenance of the Stratum V2 Reference Implementation, individual donations are greatly appreciated. You can donate through OpenSats, a 501(c)(3) public charity dedicated to supporting open-source Bitcoin projects.
For corporate entities interested in providing more substantial support, such as grants to SRI contributors, please get in touch with us directly. Your support can make a significant difference in accelerating development, research, and innovation.
SRI contributors are independently, financially supported by following entities:
This software is licensed under Apache 2.0 or MIT, at your option.
Minimum Supported Rust Version: 1.75.0
Website stratumprotocol.org · Discord SV2 Discord · Twitter @Stratumv2 ·