By EZ in Releases — Oct 17, 2024

Stratum v2 SRI v1.1.0: Improved Protocol Crates Documentation, More Testing Abilities

SRI is a reference implementation of the Stratum V2 protocol written in Rust. Stratum V2 is a next-generation bitcoin mining protocol designed to enhance the network efficiency, security, flexibility and decentralization.

We are 100% community-funded. Support our work.

"New Stratum V2 SRI release 1.1.0 is out! This release is focused on improving the protocol crates documentation and adding more testing abilities to the project. Moreover, we have refined our release and git branching process," announced the project.

"Kudos to our contributors for making v1.10 happen and to all the community testers stress-testing our implementation."

You can use Stratum Benchmarking Tool to check out the benefits of SV2. Check out this updated guide here to get started with Startum v2.

What's new

noise-sv2 , codec-sv2, const_sv2, and framing-sv2 crates documentation have been re-written.
- All the public functions should now have documentation accessible easily for the library users through https://www.docs.rs.
- Documentation was also added for non public functions to make it easier for developers to maintain the code-base.
- In addition to the documentation, example folder was added for both crates, demonstrating how to use library code in practice.
New integration test framework. "This testing framework allows us to run multiple roles and intercept messages exchanged between them, giving us the ability to assert the roles behavior in different scenarios."
- "While we are not going to remove the Message Generator testing framework completely, we aim to migrate most of the current Message Generator tests to the new testing framework."
New release and contributing process. "We stopped using dev branch and now we are developing and making pull requests against main branch. and for the release we are tagging every release through Github and creating a specific branch for it."
- or more info about the release and contributing process please refer to RELEASE.md and CONTRIBUTING.md.
"From this release we are stopping to release the following crates (pool_sv2, jd_client, jd_server, mining_proxy_sv2, translator_sv2), as they are only in PoC phase. It is planned to stabilize and start releasing them again during Q1/Q2 2025."