General release information

@plebhash

General release information

This release focuses on share accounting improvements, channel-management API refinements, and protocol/specification alignment.

Notable highlights include:

channels_sv2::server::share_accounting now tracks rejected shares alongside accepted shares, while share-work accounting has been updated to use u64 where appropriate for improved correctness and scalability.
channels_sv2::server added a stable_hashrate flag, providing additional control over hashrate stability behavior.
Standardized error_code constants were introduced across the protocol implementation.
channels_sv2 replaced reference-based getters with accessor APIs, simplifying the public API and improving encapsulation.
Custom-work mining received stability improvements, fixing a share-validation panic after SetNewPrevHash and correcting chain-tip transition handling for custom mining jobs.
Specification compatibility was improved through protocol-alignment fixes, ensuring closer adherence to the latest Stratum V2 specifications.

Crate changes

stratum-core
crate version was bumped from 0.3.0 to 0.4.0

channels_sv2
crate version was bumped from 5.0.0 to 5.1.0

mining_sv2
crate version was bumped from 9.0.0 to 10.0.0

job_declaration_sv2
crate version was bumped from 7.0.0 to 8.0.0

template_distribution_sv2
crate version was bumped from 5.0.0 to 5.1.0

common_messages_sv2
crate version was bumped from 7.1.0 to 7.2.0

parsers_sv2
crate version was bumped from 0.3.0 to 0.4.0

handlers_sv2
crate version was bumped from 0.3.0 to 0.4.0

stratum_translation
crate version was bumped from 0.2.0 to 0.3.0

What's Changed

add stable_hashrate flag to channels_sv2::server by @plebhash in #2152
add error_code constants by @plebhash in #2151
represent share work as u64 (where appropriate) by @plebhash in #2138
channels_sv2::server::share_accounting keeps track of rejected shares by @plebhash in #2149
refine CONTRIBUTING.md with versioning exception to stratum-core by @plebhash in #2158
fix validate_share panic after on_set_new_prev_hash in custom-work mode by @rx18-eng in #2156
add ERROR_CODE_OPEN_MINING_CHANNEL_EXTENDED_CHANNELS_NOT_SUPPORTED_FOR_STANDARD_JOBS by @plebhash in #2162
Revert "refine CONTRIBUTING.md with versioning exception to stratum-core" by @plebhash in #2160
fix specs incompatibilities by @GitGab19 in #2165
Fix custom mining job chain-tip transitions by @0xjc65eth in #2164
channels_sv2: replace ref getters with accessor APIs by @plebhash in #2161

New Contributors

@rx18-eng made their first contribution in #2156
@0xjc65eth made their first contribution in #2164

Full Changelog: v1.9.0...v1.10.0

@plebhash

General release information

Highlights of this release:

This release focuses on channels_sv2 extranonce and target improvements, fallible Sv1 APIs, and stronger framing/codec validation.

Notable highlights include:

channels_sv2 now clamps standard and extended channel targets to the declared max_target during channel creation and vardiff updates, fixing low-hashrate miners getting stuck when vardiff computed an easier target than allowed.
channels_sv2 added extranonce_manager, with ExtranonceAllocator and typed prefixes backed by a shared bitmap. It supports pool allocation and proxy sub-allocation from upstream prefixes, prevents standard/extended prefix overlap, and frees slots when prefixes are dropped.
Client share accounting now tracks rejected shares by upstream error_code, rather than only keeping a single rejected-share count.
sv1_api client/server trait methods now return Results across authorization, subscription, submit handling, extranonce/version-rolling state, status updates, and request-id tracking, allowing missing-state errors to propagate.
common_messages_sv2 added has_declare_tx_data(flags) for checking the Job Declaration DECLARE_TX_DATA setup flag.
Framing and codec coverage improved with quickcheck properties for SV2 headers/frames/handshake framing, plus Criterion benchmarks for encoding, decoding, serialization, Noise paths, and buffer-pool behavior.
Maintenance improved by committing Cargo.lock, dispatching stratum/main updates to sv2-apps, and documenting crate versioning rules for SemVer and public dependency exposure.

Crate changes

stratum-core
crate version was bumped from 0.2.1 to 0.3.0

channels_sv2
crate version was bumped from 4.0.0 to 5.0.0

mining_sv2
crate version was bumped from 8.0.0 to 9.0.0

common_messages_sv2
crate version was bumped from 7.0.0 to 7.1.0

parsers_sv2
crate version was bumped from 0.2.2 to 0.3.0

handlers_sv2
crate version was bumped from 0.2.2 to 0.3.0

sv1_api
crate version was bumped from 3.0.0 to 4.0.0

stratum_translation
crate version was bumped from 0.1.3 to 0.2.0

What's Changed

ci: dispatch stratum main updates to sv2-apps by @plebhash in #2121
Fix CI by @GitGab19 in #2127
Add prop test to framing by @Shourya742 in #2085
contribution guidelines for crate versioning by @plebhash in #2133
Make sv1 server trait methods return results by @Shourya742 in #2134
bump sv1-api dependent crate by @Shourya742 in #2137
channels_sv2: clamp target to max_target instead of erroring by @vnprc in #2118
Add codec benches by @Shourya742 in #2058
Add extranonce_manager module in channels_sv2 by @GitGab19 in #2098
channels_sv2::client::share_accounting keeps track of error_code for rejected shares by @plebhash in #2139
feat(common-messages): add has_declare_tx_data helper function by @wcqy-ye in #2129
use rust 1.85 in release-libs workflow by @GitGab19 in #2144
add override step to release-libs workflow by @GitGab19 in #2145
update error handling in release-libs.sh by @GitGab19 in #2146

New Contributors

@wcqy-ye made their first contribution in #2129

Full Changelog: v1.8.0...v1.9.0

@8144225309

General release information

Highlights of this release:

This release focuses on protocol correctness, share-accounting fixes, and stronger testing across the Stratum stack.

Notable highlights include:

channels_sv2 received the biggest functional improvements in this release: client-side share accounting now defers accepted-share totals to upstream acknowledgements, server-side batch accounting was corrected, duplicate shares are rejected even for block-finding submissions, and blocks_found metrics were added.
Several SV2 protocol crates were aligned more closely with the specification, including fixes to channel_bit / message_type definitions, moving CHANNEL_BIT_RECONNECT to common_messages_sv2, and renaming the Job Declaration channel-bit constant to CHANNEL_BIT_PUSH_SOLUTION.
sv1_api is safer and more robust: invalid Merkle-node conversions and invalid version-mask lengths now return errors instead of panicking.
Reliability and developer confidence improved with backend-agnostic codec encoding, new framing benchmarks, fuzz targets for SV2 datatypes and noise_sv2, codec property tests, CI cleanup, and workspace-level dependency consolidation.

Crate changes

stratum-core

crate version was bumped from 0.2.0 to 0.2.1

buffer_sv2

crate version was bumped from 3.0.0 to 3.0.1

handlers_sv2

crate version was bumped from 0.2.1 to 0.2.2

noise_sv2

crate version was bumped from 1.4.1 to 1.4.2

parsers_sv2

crate version was bumped from 0.2.1 to 0.2.2

common_messages_sv2

crate version was bumped from 6.0.2 to 7.0.0

template_distribution_sv2

crate version was bumped from 4.0.2 to 5.0.0

channels_sv2

crate version was bumped from 3.0.0 to 4.0.0

stratum-translation

crate version was bumped from 0.1.2 to 0.1.3

mining_sv2

crate version was bumped from 7.0.0 to 8.0.0

job_declaration_sv2

crate version was bumped from 6.0.0 to 7.0.0

sv1_api

crate version was bumped from 2.1.3 to 3.0.0

codec_sv2

crate version was bumped from 4.0.1 to 5.0.0

What's Changed

sv1: remove third-party hex crate dependency by @8144225309 in #2054
Add btrust logo to readme by @pavlenex in #2061
Add machete to CI by @Shourya742 in #2073
feat(channels): add set_nominal_hashrate to client ExtendedChannel by @gimballock in #2077
Fix ci by @Shourya742 in #2081
move dependencies to workspace root by @Shourya742 in #2082
Make encoder backend agnostic by @Shourya742 in #2052
Add framing benches by @Shourya742 in #2051
sv1: return errors instead of panicking in MerkleNode TryFrom by @ashishkrshaw in #2084
defer channels_sv2::client share acceptance to upstream acknowledgement by @plebhash in #2090
feat(channels): add blocks_found metric to ShareAccounting by @gimballock in #2088
Check for duplicate share on block found by @GitGab19 in #2097
fix mismatches in channel_bit and message_type according to the specs by @lucasbalieiro in #2095
clarify the reporting process in SECURITY.md by @lucasbalieiro in #2100
prevent arithmetic overflow in certificate validity calculation by @lucasbalieiro in #2104
fix channels_sv2::server::ShareAccounting::update_share_accounting by @plebhash in #2102
Fix version mask unvalid len by @exd02 in #2109
Add fuzz targets for sv2 datatypes by @lucasbalieiro in #2074
add fuzz target for the noise_sv2 crate. by @lucasbalieiro in #2106
add codec prop test by @Shourya742 in #2087
channels-sv2: refine client share accounting counters by @plebhash in #2114

New Contributors

@8144225309 made their first contribution in #2054
@gimballock made their first contribution in #2077
@ashishkrshaw made their first contribution in #2084
@exd02 made their first contribution in #2109

Full Changelog: v1.7.0...v1.8.0

@lucasbalieiro

General release information

Highlights of this release:

updated protocol crates to be aligned with latest breaking GROUP CHANNEL changes in the Sv2 specification (see stratum-mining/sv2-spec#162)
- Extended Channels can now be grouped into Group Channels, bringing them in line with the long-standing behavior of Standard Channels
fuzzing coverage expanded to all Sv2 messages
multiple improvements on jobs management in channels_sv2
benchmarking fixed on buffer_sv2, and also added to noise_sv2, laying the groundwork for more systematic performance analysis

Crate changes

stratum-core

crate version was bumped from 0.1.0 to 0.2.0

channels_sv2

crate version was bumped from 2.0.0 to 3.0.0

codec_sv2

crate version was bumped from 4.0.0 to 4.0.1

handlers_sv2

crate version was bumped from 0.2.0 to 0.2.1

binary_sv2

crate version was bumped from 5.0.0 to 5.0.1

mining_sv2

crate version was bumped from 6.0.0 to 7.0.0

framing_sv2

crate version was bumped from 6.0.0 to 6.0.1

parsers_sv2

crate version was bumped from 0.2.0 to 0.2.1

stratum-translation

crate version was bumped from 0.1.1 to 0.1.2

noise_sv2

crate version was bumped from 1.4.0 to 1.4.1

job_declaration_sv2

crate version was bumped from 5.0.2 to 6.0.0

buffer_sv2

crate version was bumped from 2.0.0 to 3.0.0

sv1_api

crate version was bumped from 2.1.2 to 2.1.3

What's Changed

update run-integration-tests.sh scripts to patch the sources from crates.io by @lucasbalieiro in #2012
add SECURITY.md by @GitGab19 in #2016
noise-sv2: add 10s clock skew tolerance to signature verification by @lucasbalieiro in #2017
Remove deprecated actions-rs from workflow by @Shourya742 in #2024
introduce fuzz coverage for all subprotocol::common_messages_sv2 by @lucasbalieiro in #2020
avoid calling mark_past_jobs_as_stale 2x by @plebhash in #2025
fix integration-test script patch by @lucasbalieiro in #2027
ci: detect companion PR changes and conditionally trigger integration tests by @lucasbalieiro in #2026
JobStore trait methods return owned types instead of refs by @plebhash in #2011
make run-integration-tests.sh update the integration tests Cargo.lock. by @lucasbalieiro in #2031
rename DeclareMiningJob.tx_ids_list to wtxid_list by @plebhash in #2029
associate Target to Job and use it for share validation (instead of channel Target) by @plebhash in #2000
make SupportedChannelTypes Copy by @coleFD in #2033
Add miri workflow by @Shourya742 in #2023
Remove profile from workspace toml by @Shourya742 in #2036
Add rust-toolchain.toml by @Shourya742 in #2034
fuzz: refactor SV2 message fuzzing and expand coverage by @lucasbalieiro in #2028
Avoid recursion when generating keypair by @Shourya742 in #2038
Add context to sv1 handler by @Shourya742 in #2047
add rust-analyzer to rust-toolchain.toml by @plebhash in #2048
implements the Display trait for sv1 messages by @lucasbalieiro in #2050
add Group Channel adaptations on channels_sv2 + mining_sv2 by @plebhash in #2044
Add noise bench by @Shourya742 in #2037
Arrange buffer-sv2 fuzz and bench correctly by @Shourya742 in #2035
bump PATCH of binary_sv2 by @GitGab19 in #2055
bump sv1_api version by @plebhash in #2056

Full Changelog: v1.6.0...v1.7.0

@lucasbalieiro

General release information

Highlights of this release:

added support for Sv2 Extensions via the introduction of extensions_sv2 crate, and some adaptations to handlers_sv2 and parsers_sv2
started actively fuzzing and performing regression tests against the fuzzing corpus
many crates were deprecated, namely:
- binary_codec_sv2, with its functionality incorporated into binary_sv2
- roles_logic_sv2, with some of its funcitonality inherited by crates like channels_sv2, handlers_sv2, parsers_sv2, and stratum-apps (on sv2-apps repo)
- network_helpers_sv2, with some of its functionality inherited by stratum-apps crate (on sv2-apps repo)
- rpc_sv2, with some of its functionality inherited by stratum-apps crate (on sv2-apps repo)
- bip32_derivation
- error_handling

⚠️ Most importantly, this is the first release where SRI is split across different repositories. Moving forward, this repository will carry library crates (and continue under the same global versioning scheme), and Sv2 applications (a.k.a. "roles") will live under https://github.com/stratum-mining/sv2-apps under a new global versioning scheme.

Crate changes

channels_sv2

crate version was bumped from 1.0.2 to 2.0.0

codec_sv2

crate version was bumped from 3.0.1 to 4.0.0

handlers_sv2

crate version was bumped from 0.1.0 to 0.2.0

binary_sv2

crate version was bumped from 4.0.0 to 5.0.0

mining_sv2

crate version was bumped from 5.0.1 to 6.0.0

framing_sv2

crate version was bumped from 5.0.2 to 6.0.0

parsers_sv2

crate version was bumped from 0.1.2 to 0.2.0

What's Changed

Improve display for u32 fields in protocol messages by @lucasbalieiro in #1919
Enforce upstream channel opening by @Shourya742 in #1917
add readme to handlers_sv2 by @Shourya742 in #1920
chore(IT): remove unused imports in integration test by @Shourya742 in #1922
Fix extranonce size during client side channel initialization by @Shourya742 in #1923
Fix extranonce range calculation in JDC by @Shourya742 in #1925
Disable ascii for file by @Shourya742 in #1929
tProxy: improve Sv1Server messages received in downstream.rs by @GitGab19 in #1930
ci: migrate from deprecated macos-13 to macos-latest ARM64 runner by @GitGab19 in #1936
channels_sv2::outputs::deserialize_outputs by @plebhash in #1934
Cleanup roles logic sv2 utils by @lucasbalieiro in #1928
deprecate mining-device-sv1 in favor of minerd by @plebhash in #1937
mining-device-sv1 removal from coverage-roles.sh script by @GitGab19 in #1942
Make handlers context aware by @Shourya742 in #1939
Fix CI build failure by pinning generic-array to 0.14.7 by @Shourya742 in #1945
Refactor Pool by @Shourya742 in #1926
refine extranonce assumptions by @plebhash in #1944
Improve crates re-exports by @GitGab19 in #1931
Save only future template in pool by @Shourya742 in #1949
deprecate roles_logic_sv2, benches, error_handling, utils::bip32_derivation by @lucasbalieiro in #1947
remove deprecated crate from coverage script by @lucasbalieiro in #1957
remove noisy log when downloading the minerd binary by @lucasbalieiro in #1954
update ITF to use TP v.0.1.19 by @GitGab19 in #1955
Remove binary codec sv2 by @Shourya742 in #1952
migrate mining_sv2::Target to bitcoin::Target by @icarusmaximal in #1950
remove unnecessary files by @lucasbalieiro in #1960
revert unnecessary version bumps by @plebhash in #1959
Remove unreachable macro and add share validation error variant in Pool by @Shourya742 in #1962
make roles use bitcoin from stratum-apps::stratum-core by @GitGab19 in #1963
improve share validation by @plebhash in #1966
fix how SubmitShares.Success is being crafted by @plebhash in #1968
Correct Vardiff insertions by @Shourya742 in #1971
New stratum-core structure by @lucasbalieiro in #1860
update code coverage workflow by @lucasbalieiro in #1979
fix channel_msg bit check in sv2 frame header by @vnprc in #1982
fix potential arithmetic overflows on definition of impl_into_encodable_field_for_seq of binary_sv2 by @plebhash in #1985
refactor: improve fuzz test suite with targeted harnesses by @erickcestari in #1973
Add message variant for mining handler by @Shourya742 in #1996
add boundary checks to decodable proc_macro by @lucasbalieiro in #1989
add github action to run a fuzz regression test by @lucasbalieiro in #1992
fuzz: fix wrong clone when calling to_bytes by @lucasbalieiro in #1999
fix outdated Rust Docs for ShareValidationResult by @plebhash in #2004
properly mark past jobs as stale on server channels by @plebhash in #2002
Add support for extensions negotiations, TLV, and Worker-Specific Hashrate Tracking extension by @GitGab19 in #1983
Fix version bumps in derive_codec_sv2 + remove unused dependencies in extensions_sv2 by @GitGab19 in #2005
remove dev-dependencies from extensions_sv2 by @GitGab19 in #2006
add extensions_sv2 and stratum-core to semver-check workflow by @GitGab19 in #2007
fix stratum-core path on release-libs.yaml by @plebhash in #2009

New Contributors

@icarusmaximal made their first contribution in #1950
@vnprc made their first contribution in #1982
@erickcestari made their first contribution in #1973

Full Changelog: v1.5.0...v1.6.0

@plebhash

General release information

Highlights of this release:

Translator Proxy was re-written with new functionality, namely:
- aggregated and non-aggregated modes
- optional vardiff
- ability to fallback
Job Declarator Client was re-written with new functionality, namely:
- allowing multiple downstream clients at the same time
- allowing downstream clients to establish Standard Channels
new stratum-translation crate modularizes Sv1 ↔ Sv2 translation logic
BIP141 fields are now stripped from coinbase on Extended Jobs
new APIs added to network_helpers_sv2, expanding ways it can be used

⚠️ Most importantly, this is the last release where SRI is structured as a monorepo. Moving forward, this repository will carry library crates (and continue under the same global versioning scheme), and Sv2 applications (a.k.a. "roles") will live under https://github.com/stratum-mining/sv2-apps under a new global versioning scheme.

Crate changes

`sv2_ffi`

this crate was deprecated

`roles_logic_sv2`

crate version was bumped from 3.0.0 to 4.0.0

based on interactions with early adopters, some modules of roles_logic_sv2 were isolated into standalone crates, namely:

handlers_sv2
parsers_sv2
channels_sv2

`handlers_sv2`

new crate published at version 0.1.0

`parsers_sv2`

new crate published at version 0.1.1

`channels_sv2`

new crate published at version 0.1.0 and then bumped to 1.0.2

`network_helpers_sv2`

crate version was bumped from 4.0.0 to 4.0.1

`stratum-common`

crate version was bumped from 4.0.0 to 4.0.1

`common_messages_sv2`

crate version was bumped from 5.0.0 to 6.0.1

`binary_codec_sv2`

crate version was bumped from 2.0.0 to 3.0.0

`binary_sv2`

crate version was bumped from 3.0.0 to 4.0.0

`framing_sv2`

crate version was bumped from 5.0.0 to 5.0.1

`codec_sv2`

crate version was bumped from 2.1.0 to 3.0.1

`mining_sv2`

crate version was bumped from 4.0.0 to 5.0.1

`job_declaration_sv2`

crate version was bumped from 4.0.0 to 5.0.1

`template_distribution_sv2`

crate version was bumped from 3.0.0 to 4.0.1

`sv1_api`

crate version was bumped from 2.1.0 to 2.1.1

`rpc_sv2`

crate version was bumped from 1.1.0 to 1.1.1

PR List

isolate channels_sv2 and parsers_sv2 into standalone crates by @plebhash in #1795
introduce custom difficulty TP on Integration Tests by @plebhash in #1760
Fix broken Getting Started link in README by @Cyber-Lord in #1803
Improve tracing defaults and add download warning log by @lucasbalieiro in #1807
standardize rewards to pool/solo mining into a single scriptPubKey by @lucasbalieiro in #1800
Rename config-helpers to config_helpers_sv2 and remove of unused roles-logic-sv2 by @GitGab19 in #1812
Update rpc_sv2 version to 1.1.0 in Cargo.toml and Cargo.lock by @GitGab19 in #1815
ci: add semver checks for config-helpers in workflow by @GitGab19 in #1813
deprecate test/scale crate by @lucasbalieiro in #1809
bump: sv1_api v1.0.1 → v2.0.0 by @GitGab19 in #1820
add noise stream by @Shourya742 in #1792
Refactor handler by @Shourya742 in #1806
Update roles rust edition to 2021 by @lucasbalieiro in #1818
remove pool and miner tag from extranonce_prefix by @plebhash in #1824
run clippy and fmt across codebase by @lucasbalieiro in #1830
fix overlooked consequences of SetupConnection.REQUIRES_WORK_SELECTION by @plebhash in #1826
allow updating Standard Channel Server state with Extended Job from Group Channel by @plebhash in #1828
Disambiguate handler method names for client/server message processing by @Shourya742 in #1831
downgrade roles_logic_sv2 to 4.0.0 by @GitGab19 in #1836
strip BIP141 from Extended Jobs by @plebhash in #1832
feat: add stratum-translation library for SV1↔SV2 protocol translation by @GitGab19 in #1833
Deprecate sv2-ffi crate by @GitGab19 in #1835
fix sigops calculation for CoinbaseOutputContraints by @plebhash in #1838
feat: add set_chain_tip method to client channels' APIs by @GitGab19 in #1839
Finishes rust docs for channel_sv2 by @lucasbalieiro in #1817
Turns channel_sv2::client::* no_std compatible by @lucasbalieiro in #1840
make parsers_sv2 no_std compatible by @lucasbalieiro in #1842
fix SetCustomMiningJob edge cases by @plebhash in #1845
channels_sv2 adaptations for new JDC by @plebhash in #1846
enforce full allocation of template revenue on JobFactory::new_coinbase_tx_prefix_and_suffix by @plebhash in #1849
improve sniffer logging data by @lucasbalieiro in #1855
fix the divergence of field names in DeclareMiningJob by @lucasbalieiro in #1856
revert renaming MAX_EXTRANONCE_LEN by @plebhash in #1864
Fix display trait behavior for Str0255 and B0255 by @lucasbalieiro in #1865
remove unnecessary Cargo.lock and add to .gitignore by @lucasbalieiro in #1868
fix: remove unwrap in JDS by @GitGab19 in #1879
chore: Clippy update by @Shourya742 in #1888
Improve handlers by @Shourya742 in #1886
Add close channel method to pool by @Shourya742 in #1890
JobStore as generic by @plebhash in #1884
implements display traits for sv1 messages by @lucasbalieiro in #1891
Make vardiff pool statically dispatch by @Shourya742 in #1896
improve pool vardiff error logs by @plebhash in #1900
Speed up (sv2 native) CPU miner by @Sjors in #1901
New Job Declarator Client by @Shourya742 in #1843
fix: correct typo 'Startum' to 'Stratum' in V1 protocol documentation by @BRIGHTON-ASUMANI in #1893
New Translator Proxy by @GitGab19 in #1791
cover handlers_sv2 on release-libs.yaml by @plebhash in #1908
deprecate channel_logic and job_creator modules from roles_logic_sv2 crate by @GitGab19 in #1906
ci(msrv): enforce locked builds in MSRV workflow by @Sjors in #1905
bump PATCH of binary_sv2 crate by @GitGab19 in #1909
specify dependencies versions of stratum_translation crate by @GitGab19 in #1910
Fix stratum-common v4.0.0 and rpc_sv2 v1.1.0 version conflict by @GitGab19 in #1913
bump PATCH for codec_sv2 + framing_sv2 + parsers_sv2 + common_messages_sv2 by @plebhash in #1912

New Contributors

@Cyber-Lord made their first contribution in #1803
@BRIGHTON-ASUMANI made their first contribution in #1893

Full Changelog: v1.4.0...v1.5.0

@jbesraa

General release information

Highlights of this release:

Implemented recent Job Declaration (JD) spec changes in SRI
Introduced simplified and unified channel/job APIs in roles_logic_sv2, enabling correct SV2 behavior across all channel states without imposing architectural decisions on adopters. Pool migrated to use these APIs
Modularized vardiff logic to make it reusable across roles
Deprecated mining_proxy_sv2 and cleaned up roles_logic_sv2 internals
Simplified UX for configuring custom coinbase output with user-defined reward address
Added documentation for all roles: Pool, JDS, JDC, and tProxy

This release also includes internal refactors, documentation improvements, and CI/test enhancements.

Crate changes

`const_sv2`

this crate has been deprecated

`roles_logic_sv2`

some new modules were introduced, namely:

channels

some modules were refactored, namely:

handlers
channel_logic

it had the following modules removed, namely:

common_properties
job_dispatcher

crate version was bumped from 2.0.0 to 3.0.0

`stratum_common`

crate version was bumped from 2.0.0 to 3.0.0

`network_helpers_sv2`

crate version was bumped from 3.0.0 to 4.0.0

`job_declaration_sv2`

crate version was bumped from 3.0.0 to 4.0.0

`mining_sv2`

crate version was bumped from 3.0.0 to 4.0.0

`common_messages_sv2`

crate version was bumped from 4.0.0 to 5.0.0

`framing_sv2`

crate version was bumped from 4.0.0 to 5.0.0

`noise_sv2`

crate version was bumped from 1.3.0 to 1.4.0

`template_distribution_sv2`

crate version was bumped from 3.0.0 to 3.1.0

`codec_sv2`

crate version was bumped from 2.0.0 to 2.1.0

`sv2_ffi`

crate version was bumped from 2.0.0 to 2.1.0

`binary_sv2`

crate version was bumped from 2.0.0 to 3.0.0

PR List

Use same(1.44.1) tokio version across the project by @jbesraa in #1603
Make Sniffer unblocking and upgrade TP by @jbesraa in #1592
rust 1.85 set in cargo-semver-check workflow by @GitGab19 in #1622
Reintroduce TProxy-JD integration test by @jbesraa in #1625
Improve UpdateChannel/SetTarget handling on Pool and tProxy by @GitGab19 in #1620
Remove unused url module by @jbesraa in #1636
Refactor IsUpstream and IsMiningUpstream traits to simplify generics used inside handlers by @GitGab19 in #1628
remove github hooks by @Shourya742 in #1645
Change SUBMIT_SOLUTION_JD to PUSH_SOLUTION by @jbesraa in #1629
Renaming of translator config and mining proxy config by @Sansh2356 in #1639
JDS documentation improvements by @GitGab19 in #1640
Move constants to stratum-common by @jbesraa in #1642
#1629 followup by @jbesraa in #1646
Remove SetCustomMiningJob::extranonce_size by @jbesraa in #1651
Upgrade corepc to 0.7.0 by @jbesraa in #1663
remove dockerfile from tproxy by @Shourya742 in #1656
Change async mining terminology by @jbesraa in #1654
Document pub code in pool by @Shourya742 in #1542
Add translator docs by @Shourya742 in #1658
Remove short transaction ids by @jbesraa in #1650
SV2 Constants Cleanup by @jbesraa in #1667
add jdc doc by @Shourya742 in #1614
sv1_api: Setup framework to test IsServer by @pool2win in #1668
Combine Sniffer integration tests by @jbesraa in #1662
remove run.sh from jd-client by @Shourya742 in #1711
Add MockDownstream by @jbesraa in #1671
remove special library naming in roles by @Shourya742 in #1709
using Box for large variants in v1 crate by @Shourya742 in #1716
remove redundant map_err's in translators by @Shourya742 in #1712
Add MockUpstream module by @jbesraa in #1715
Refactor and unification of CoinbaseOutput type by @apoelstra in #1719
introduce simplified APIs for channel and job logic (server side) by @plebhash in #1672
fix integration tests lockfile by @plebhash in #1721
stop excluding config-helpers from roles workspace by @plebhash in #1723
separate vardiff module by @Shourya742 in #1714
introduce simplified APIs for channel and job logic (client side) by @plebhash in #1724
realocate constants to their specific crates by @plebhash in #1728
add verification on roles_logic_sv2::channels::*::standard::StandardChannel::set_extranonce_prefix by @plebhash in #1730
migrate Pool to new channels module of roles_logic_sv2 by @plebhash in #1718
Add vardiff test framework by @Shourya742 in #1729
Refactor CLI argument parsing with clap by @lucasbalieiro in #1739
fix group channel handling on pool by @plebhash in #1748
Update vardiff by @Shourya742 in #1747
fix unnecessary version bumps by @plebhash in #1749
add support for Custom Jobs on channels::server APIs by @plebhash in #1741
Simplify network helpers by @Shourya742 in #1750
add get_chain_tip to client channels by @plebhash in #1756
add get_share_accounting to client channels by @plebhash in #1757
update imports in roles and tests to reflect library reorganization by @lucasbalieiro in #1744
Add vardiff to pool by @Shourya742 in #1737
run Integration Tests via cargo nextest by @plebhash in #1758
remove SetCustomMiningJob.coinbase_tx_value_remaining by @plebhash in #1745
remove redudant fields from AllocateMiningJobToken.Success by @plebhash in #1759
cover crate examples on CI by @plebhash in #1754
Refactor network helpers pass 2 by @Shourya742 in #1764
Correct Coinbase Output Length Calculation in Pool Role Implementation by @lucasbalieiro in #1761
Handle overlflow in u256 by @GitGab19 in #1752
run clippy on the entire codebase by @lucasbalieiro in #1769
change coverage workflows to run only when commits are pushed to main by @lucasbalieiro in #1767
fix coinbase deserialization by @plebhash in #1772
decouple job state from channels with JobStore by @coleFD in #1779
Update readme logos by @pavlenex in #1784
Refactor sv1 connection by @Shourya742 in #1782
add check on coinbase output script pubkey for custom job on Pool by @plebhash in #1775
Implements Display for messages across the codebase by @lucasbalieiro in #1755
add static lifetime converters to roles_logic_sv2::parsers module by @plebhash in #1790
fix unnecessary creation of group channels on pool by @plebhash in #1788
re-introduce dedicated function to deserialize outputs from NewTemplate message by @plebhash in #1777
deprecate mining_proxy_sv2 and related modules of roles_logic_sv2 by @plebhash in #1765
use cursor in deserialize_template_outputs by @Shourya742 in #1794
Implements roles functionality to write logs t...

@jbesraa

General release information

This release migrates the old CI system based on Message Generator into the new SRI Integration Tests Framework.

crate changes

`noise_sv2`

no_std compatibility was made optional

crate version was bumped from v1.2.1 to v1.3.0

`codec_sv2`

no_std compatibility was made optional

crate version was bumped from v1.3.1 to v2.0.0

`key-utils`

was made no_std-compatible (optionally)

crate version was bumped from v1.1.0 to v1.2.0

`roles_logic_sv2`

some modules were refactored, namely:

handlers
job_creator
job_dispatcher
channel_logic

it had the following modules removed:

routers
selectors

crate version was bumped from v1.2.3 to v2.0.0

`network_helpers_sv2`

the async_std flavors were removed, leaving only tokio flavor

Connection no longer returns AbortHandles

crate version was bumped from v2.0.2 to v3.0.0