From b90ea27eb10eeef29a38eb18ebcdd35f8afad05a Mon Sep 17 00:00:00 2001 From: bit-aloo Date: Wed, 11 Nov 2026 23:18:28 +0530 Subject: [PATCH 1/8] fix(handlers_sv2)!: drop is_client_authorized from the mining client traits The dispatcher never called it, so a policy returning false had no effect. It cannot enforce it either: an unauthorized open is answered with an OpenMiningChannel.Error, which only the implementor can send, so authorization belongs in handle_open_*_mining_channel. --- Cargo.lock | 1 - sv2/handlers-sv2/Cargo.toml | 1 - sv2/handlers-sv2/src/mining.rs | 15 ++++----------- sv2/handlers-sv2/src/mining_owned.rs | 15 ++++----------- 4 files changed, 8 insertions(+), 24 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 58a34da8dd..166783e88e 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -547,7 +547,6 @@ checksum = "1b43ede17f21864e81be2fa654110bf1e793774238d86ef8555c37e6519c0403" name = "handlers_sv2" version = "0.7.0" dependencies = [ - "binary_sv2", "common_messages_sv2", "extensions_sv2", "framing_sv2", diff --git a/sv2/handlers-sv2/Cargo.toml b/sv2/handlers-sv2/Cargo.toml index a444933d2c..43762ba99a 100644 --- a/sv2/handlers-sv2/Cargo.toml +++ b/sv2/handlers-sv2/Cargo.toml @@ -13,7 +13,6 @@ keywords = ["stratum", "mining", "bitcoin", "protocol"] [dependencies] parsers_sv2 = { path = "../parsers-sv2", version = "^0.7.0"} -binary_sv2 = { path = "../binary-sv2", version = "^8.0.0" } common_messages_sv2 = { path = "../subprotocols/common-messages", version = "^10.0.0" } framing_sv2 = { path = "../framing-sv2", version = "^9.0.0" } mining_sv2 = { path = "../subprotocols/mining", version = "^13.0.0" } diff --git a/sv2/handlers-sv2/src/mining.rs b/sv2/handlers-sv2/src/mining.rs index e86c19a5d8..fdded1abc4 100644 --- a/sv2/handlers-sv2/src/mining.rs +++ b/sv2/handlers-sv2/src/mining.rs @@ -1,5 +1,4 @@ use crate::error::HandlerErrorType; -use binary_sv2::Str0255; use framing_sv2::header::Header; use mining_sv2::{ CloseChannel, NewExtendedMiningJob, NewMiningJob, OpenExtendedMiningChannel, @@ -650,11 +649,6 @@ pub trait HandleMiningMessagesFromClientSync { fn get_channel_type_for_client(&self, client_id: Option) -> SupportedChannelTypes; fn is_work_selection_enabled_for_client(&self, client_id: Option) -> bool; - fn is_client_authorized( - &self, - client_id: Option, - user_identity: &Str0255, - ) -> Result; /// Returns the list of negotiated extension_types with a client. /// @@ -830,6 +824,7 @@ pub trait HandleMiningMessagesFromClientSync { tlv_fields: Option<&[Tlv]>, ) -> Result<(), Self::Error>; + /// Authorizing `msg.user_identity` is up to the implementor. fn handle_open_standard_mining_channel( &mut self, client_id: Option, @@ -837,6 +832,7 @@ pub trait HandleMiningMessagesFromClientSync { tlv_fields: Option<&[Tlv]>, ) -> Result<(), Self::Error>; + /// Authorizing `msg.user_identity` is up to the implementor. fn handle_open_extended_mining_channel( &mut self, client_id: Option, @@ -889,11 +885,6 @@ pub trait HandleMiningMessagesFromClientAsync { fn get_channel_type_for_client(&self, client_id: Option) -> SupportedChannelTypes; fn is_work_selection_enabled_for_client(&self, client_id: Option) -> bool; - fn is_client_authorized( - &self, - client_id: Option, - user_identity: &Str0255, - ) -> Result; /// Returns the list of negotiated extension types for a client. /// @@ -1081,6 +1072,7 @@ pub trait HandleMiningMessagesFromClientAsync { tlv_fields: Option<&[Tlv]>, ) -> Result<(), Self::Error>; + /// Authorizing `msg.user_identity` is up to the implementor. async fn handle_open_standard_mining_channel( &mut self, client_id: Option, @@ -1088,6 +1080,7 @@ pub trait HandleMiningMessagesFromClientAsync { tlv_fields: Option<&[Tlv]>, ) -> Result<(), Self::Error>; + /// Authorizing `msg.user_identity` is up to the implementor. async fn handle_open_extended_mining_channel( &mut self, client_id: Option, diff --git a/sv2/handlers-sv2/src/mining_owned.rs b/sv2/handlers-sv2/src/mining_owned.rs index 740421f6b9..86a133719f 100644 --- a/sv2/handlers-sv2/src/mining_owned.rs +++ b/sv2/handlers-sv2/src/mining_owned.rs @@ -1,5 +1,4 @@ use crate::{error::HandlerErrorType, mining::SupportedChannelTypes}; -use binary_sv2::Str0255; use framing_sv2::header::Header; use parsers_sv2::{parse_message_frame_with_tlvs, AnyMessage, Mining, MiningOwned, Tlv}; @@ -641,11 +640,6 @@ pub trait HandleMiningMessagesFromClientOwnedSync { fn get_channel_type_for_client(&self, client_id: Option) -> SupportedChannelTypes; fn is_work_selection_enabled_for_client(&self, client_id: Option) -> bool; - fn is_client_authorized( - &self, - client_id: Option, - user_identity: &Str0255, - ) -> Result; /// Returns the list of negotiated extension_types with a client. /// @@ -823,6 +817,7 @@ pub trait HandleMiningMessagesFromClientOwnedSync { tlv_fields: Option<&[Tlv]>, ) -> Result<(), Self::Error>; + /// Authorizing `msg.user_identity` is up to the implementor. fn handle_open_standard_mining_channel( &mut self, client_id: Option, @@ -830,6 +825,7 @@ pub trait HandleMiningMessagesFromClientOwnedSync { tlv_fields: Option<&[Tlv]>, ) -> Result<(), Self::Error>; + /// Authorizing `msg.user_identity` is up to the implementor. fn handle_open_extended_mining_channel( &mut self, client_id: Option, @@ -882,11 +878,6 @@ pub trait HandleMiningMessagesFromClientOwnedAsync { fn get_channel_type_for_client(&self, client_id: Option) -> SupportedChannelTypes; fn is_work_selection_enabled_for_client(&self, client_id: Option) -> bool; - fn is_client_authorized( - &self, - client_id: Option, - user_identity: &Str0255, - ) -> Result; /// Returns the list of negotiated extension types for a client. /// @@ -1078,6 +1069,7 @@ pub trait HandleMiningMessagesFromClientOwnedAsync { tlv_fields: Option<&[Tlv]>, ) -> Result<(), Self::Error>; + /// Authorizing `msg.user_identity` is up to the implementor. async fn handle_open_standard_mining_channel( &mut self, client_id: Option, @@ -1085,6 +1077,7 @@ pub trait HandleMiningMessagesFromClientOwnedAsync { tlv_fields: Option<&[Tlv]>, ) -> Result<(), Self::Error>; + /// Authorizing `msg.user_identity` is up to the implementor. async fn handle_open_extended_mining_channel( &mut self, client_id: Option, From 0927bfa7f7b14896572b50225789f5e3356bf769 Mon Sep 17 00:00:00 2001 From: bit-aloo Date: Wed, 11 Nov 2026 23:18:40 +0530 Subject: [PATCH 2/8] docs(handlers_sv2): fix references to a missing parameter and helper Handler docs called the TLV argument tlv_data, which is named tlv_fields, and pointed at an extract_worker_identity_from_submit_shares helper that extensions_sv2 does not have. --- sv2/handlers-sv2/src/common.rs | 8 ++++---- sv2/handlers-sv2/src/common_owned.rs | 8 ++++---- sv2/handlers-sv2/src/extensions.rs | 8 ++++---- sv2/handlers-sv2/src/extensions_owned.rs | 8 ++++---- sv2/handlers-sv2/src/job_declaration.rs | 8 ++++---- sv2/handlers-sv2/src/job_declaration_owned.rs | 8 ++++---- sv2/handlers-sv2/src/mining.rs | 13 ++++++------- sv2/handlers-sv2/src/mining_owned.rs | 13 ++++++------- sv2/handlers-sv2/src/template_distribution.rs | 8 ++++---- sv2/handlers-sv2/src/template_distribution_owned.rs | 8 ++++---- 10 files changed, 44 insertions(+), 46 deletions(-) diff --git a/sv2/handlers-sv2/src/common.rs b/sv2/handlers-sv2/src/common.rs index 958aa99458..d6160ddcb1 100644 --- a/sv2/handlers-sv2/src/common.rs +++ b/sv2/handlers-sv2/src/common.rs @@ -15,7 +15,7 @@ use crate::error::HandlerErrorType; /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_server()`. pub trait HandleCommonMessagesFromServerSync { @@ -129,7 +129,7 @@ pub trait HandleCommonMessagesFromServerSync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_server()`. #[trait_variant::make(Send)] @@ -257,7 +257,7 @@ pub trait HandleCommonMessagesFromServerAsync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_client()`. pub trait HandleCommonMessagesFromClientSync { @@ -354,7 +354,7 @@ pub trait HandleCommonMessagesFromClientSync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_client()`. #[trait_variant::make(Send)] diff --git a/sv2/handlers-sv2/src/common_owned.rs b/sv2/handlers-sv2/src/common_owned.rs index 759702c5f3..0fe6a947fb 100644 --- a/sv2/handlers-sv2/src/common_owned.rs +++ b/sv2/handlers-sv2/src/common_owned.rs @@ -15,7 +15,7 @@ use crate::error::HandlerErrorType; /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_server()`. pub trait HandleCommonMessagesFromServerOwnedSync { @@ -133,7 +133,7 @@ pub trait HandleCommonMessagesFromServerOwnedSync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_server()`. #[trait_variant::make(Send)] @@ -265,7 +265,7 @@ pub trait HandleCommonMessagesFromServerOwnedAsync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_client()`. pub trait HandleCommonMessagesFromClientOwnedSync { @@ -364,7 +364,7 @@ pub trait HandleCommonMessagesFromClientOwnedSync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_client()`. #[trait_variant::make(Send)] diff --git a/sv2/handlers-sv2/src/extensions.rs b/sv2/handlers-sv2/src/extensions.rs index cb18803b7c..e8a51921fd 100644 --- a/sv2/handlers-sv2/src/extensions.rs +++ b/sv2/handlers-sv2/src/extensions.rs @@ -13,7 +13,7 @@ use crate::error::HandlerErrorType; /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_server()`. pub trait HandleExtensionsFromServerSync { @@ -113,7 +113,7 @@ pub trait HandleExtensionsFromServerSync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_server()`. #[trait_variant::make(Send)] @@ -227,7 +227,7 @@ pub trait HandleExtensionsFromServerAsync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_client()`. pub trait HandleExtensionsFromClientSync { @@ -323,7 +323,7 @@ pub trait HandleExtensionsFromClientSync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_client()`. #[trait_variant::make(Send)] diff --git a/sv2/handlers-sv2/src/extensions_owned.rs b/sv2/handlers-sv2/src/extensions_owned.rs index b7a776c215..4c236142fd 100644 --- a/sv2/handlers-sv2/src/extensions_owned.rs +++ b/sv2/handlers-sv2/src/extensions_owned.rs @@ -18,7 +18,7 @@ use crate::error::HandlerErrorType; /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_server()`. pub trait HandleExtensionsFromServerOwnedSync { @@ -124,7 +124,7 @@ pub trait HandleExtensionsFromServerOwnedSync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_server()`. #[trait_variant::make(Send)] @@ -238,7 +238,7 @@ pub trait HandleExtensionsFromServerOwnedAsync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_client()`. pub trait HandleExtensionsFromClientOwnedSync { @@ -340,7 +340,7 @@ pub trait HandleExtensionsFromClientOwnedSync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_client()`. #[trait_variant::make(Send)] diff --git a/sv2/handlers-sv2/src/job_declaration.rs b/sv2/handlers-sv2/src/job_declaration.rs index 3f2b70bc33..e6a5a73607 100644 --- a/sv2/handlers-sv2/src/job_declaration.rs +++ b/sv2/handlers-sv2/src/job_declaration.rs @@ -18,7 +18,7 @@ use crate::error::HandlerErrorType; /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_server()`. pub trait HandleJobDeclarationMessagesFromServerSync { @@ -149,7 +149,7 @@ pub trait HandleJobDeclarationMessagesFromServerSync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_server()`. #[trait_variant::make(Send)] @@ -294,7 +294,7 @@ pub trait HandleJobDeclarationMessagesFromServerAsync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_client()`. pub trait HandleJobDeclarationMessagesFromClientSync { @@ -423,7 +423,7 @@ pub trait HandleJobDeclarationMessagesFromClientSync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_client()`. #[trait_variant::make(Send)] diff --git a/sv2/handlers-sv2/src/job_declaration_owned.rs b/sv2/handlers-sv2/src/job_declaration_owned.rs index e79400d4ec..3cfd991070 100644 --- a/sv2/handlers-sv2/src/job_declaration_owned.rs +++ b/sv2/handlers-sv2/src/job_declaration_owned.rs @@ -20,7 +20,7 @@ use crate::error::HandlerErrorType; /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_server()`. pub trait HandleJobDeclarationMessagesFromServerOwnedSync { @@ -155,7 +155,7 @@ pub trait HandleJobDeclarationMessagesFromServerOwnedSync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_server()`. #[trait_variant::make(Send)] @@ -303,7 +303,7 @@ pub trait HandleJobDeclarationMessagesFromServerOwnedAsync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_client()`. pub trait HandleJobDeclarationMessagesFromClientOwnedSync { @@ -434,7 +434,7 @@ pub trait HandleJobDeclarationMessagesFromClientOwnedSync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_client()`. #[trait_variant::make(Send)] diff --git a/sv2/handlers-sv2/src/mining.rs b/sv2/handlers-sv2/src/mining.rs index fdded1abc4..eaf3780390 100644 --- a/sv2/handlers-sv2/src/mining.rs +++ b/sv2/handlers-sv2/src/mining.rs @@ -26,7 +26,7 @@ pub enum SupportedChannelTypes { /// this contextual information is readily available or not. In cases where `server_id` is either /// irrelevant or can be inferred without the context, this should always be `None`. /// -/// Handler methods receive an optional `tlv_data` parameter containing validated TLV fields +/// Handler methods receive an optional `tlv_fields` parameter containing validated TLV fields /// when extension data is appended to messages. It will be `Some` only if validation succeeds /// against negotiated extensions. pub trait HandleMiningMessagesFromServerSync { @@ -319,7 +319,7 @@ pub trait HandleMiningMessagesFromServerSync { /// this contextual information is readily available or not. In cases where `server_id` is either /// irrelevant or can be inferred without the context, this should always be `None`. /// -/// Handler methods receive an optional `tlv_data` parameter containing validated TLV fields +/// Handler methods receive an optional `tlv_fields` parameter containing validated TLV fields /// when extension data is appended to messages. It will be `Some` only if validation succeeds /// against negotiated extensions. #[trait_variant::make(Send)] @@ -641,7 +641,7 @@ pub trait HandleMiningMessagesFromServerAsync { /// this contextual information is readily available or not. In cases where `client_id` is either /// irrelevant or can be inferred without the context, this should always be `None`. /// -/// Handler methods receive an optional `tlv_data` parameter containing validated TLV fields +/// Handler methods receive an optional `tlv_fields` parameter containing validated TLV fields /// when extension data is appended to messages. It will be `Some` only if validation succeeds /// against negotiated extensions. pub trait HandleMiningMessagesFromClientSync { @@ -691,10 +691,9 @@ pub trait HandleMiningMessagesFromClientSync { /// Handles a parsed mining message from a client. /// - /// The `tlv_data` parameter contains validated TLV fields if the message has extension + /// The `tlv_fields` parameter contains validated TLV fields if the message has extension /// data appended. It will be `Some` only if TLV validation succeeds against negotiated - /// extensions, otherwise `None`. Use `extensions_sv2` helper functions to extract - /// specific extension data (e.g., `extract_worker_identity_from_submit_shares`). + /// extensions, otherwise `None`. fn handle_mining_message_from_client( &mut self, client_id: Option, @@ -876,7 +875,7 @@ pub trait HandleMiningMessagesFromClientSync { /// this contextual information is readily available or not. In cases where `client_id` is either /// irrelevant or can be inferred without the context, this should always be `None`. /// -/// Handler methods receive an optional `tlv_data` parameter containing validated TLV fields +/// Handler methods receive an optional `tlv_fields` parameter containing validated TLV fields /// when extension data is appended to messages. It will be `Some` only if validation succeeds /// against negotiated extensions. #[trait_variant::make(Send)] diff --git a/sv2/handlers-sv2/src/mining_owned.rs b/sv2/handlers-sv2/src/mining_owned.rs index 86a133719f..d37bf346f6 100644 --- a/sv2/handlers-sv2/src/mining_owned.rs +++ b/sv2/handlers-sv2/src/mining_owned.rs @@ -11,7 +11,7 @@ use mining_sv2::*; /// this contextual information is readily available or not. In cases where `server_id` is either /// irrelevant or can be inferred without the context, this should always be `None`. /// -/// Handler methods receive an optional `tlv_data` parameter containing validated TLV fields +/// Handler methods receive an optional `tlv_fields` parameter containing validated TLV fields /// when extension data is appended to messages. It will be `Some` only if validation succeeds /// against negotiated extensions. pub trait HandleMiningMessagesFromServerOwnedSync { @@ -306,7 +306,7 @@ pub trait HandleMiningMessagesFromServerOwnedSync { /// this contextual information is readily available or not. In cases where `server_id` is either /// irrelevant or can be inferred without the context, this should always be `None`. /// -/// Handler methods receive an optional `tlv_data` parameter containing validated TLV fields +/// Handler methods receive an optional `tlv_fields` parameter containing validated TLV fields /// when extension data is appended to messages. It will be `Some` only if validation succeeds /// against negotiated extensions. #[trait_variant::make(Send)] @@ -632,7 +632,7 @@ pub trait HandleMiningMessagesFromServerOwnedAsync { /// this contextual information is readily available or not. In cases where `client_id` is either /// irrelevant or can be inferred without the context, this should always be `None`. /// -/// Handler methods receive an optional `tlv_data` parameter containing validated TLV fields +/// Handler methods receive an optional `tlv_fields` parameter containing validated TLV fields /// when extension data is appended to messages. It will be `Some` only if validation succeeds /// against negotiated extensions. pub trait HandleMiningMessagesFromClientOwnedSync { @@ -684,10 +684,9 @@ pub trait HandleMiningMessagesFromClientOwnedSync { /// Handles a parsed mining message from a client. /// - /// The `tlv_data` parameter contains validated TLV fields if the message has extension + /// The `tlv_fields` parameter contains validated TLV fields if the message has extension /// data appended. It will be `Some` only if TLV validation succeeds against negotiated - /// extensions, otherwise `None`. Use `extensions_sv2` helper functions to extract - /// specific extension data (e.g., `extract_worker_identity_from_submit_shares`). + /// extensions, otherwise `None`. fn handle_mining_message_from_client( &mut self, client_id: Option, @@ -869,7 +868,7 @@ pub trait HandleMiningMessagesFromClientOwnedSync { /// this contextual information is readily available or not. In cases where `client_id` is either /// irrelevant or can be inferred without the context, this should always be `None`. /// -/// Handler methods receive an optional `tlv_data` parameter containing validated TLV fields +/// Handler methods receive an optional `tlv_fields` parameter containing validated TLV fields /// when extension data is appended to messages. It will be `Some` only if validation succeeds /// against negotiated extensions. #[trait_variant::make(Send)] diff --git a/sv2/handlers-sv2/src/template_distribution.rs b/sv2/handlers-sv2/src/template_distribution.rs index 15dce450d4..4476a7157a 100644 --- a/sv2/handlers-sv2/src/template_distribution.rs +++ b/sv2/handlers-sv2/src/template_distribution.rs @@ -17,7 +17,7 @@ use crate::error::HandlerErrorType; /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_server()`. pub trait HandleTemplateDistributionMessagesFromServerSync { @@ -141,7 +141,7 @@ pub trait HandleTemplateDistributionMessagesFromServerSync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_server()`. #[trait_variant::make(Send)] @@ -277,7 +277,7 @@ pub trait HandleTemplateDistributionMessagesFromServerAsync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_client()`. pub trait HandleTemplateDistributionMessagesFromClientSync { @@ -395,7 +395,7 @@ pub trait HandleTemplateDistributionMessagesFromClientSync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_client()`. #[trait_variant::make(Send)] diff --git a/sv2/handlers-sv2/src/template_distribution_owned.rs b/sv2/handlers-sv2/src/template_distribution_owned.rs index a512ed1122..e21c2a8ade 100644 --- a/sv2/handlers-sv2/src/template_distribution_owned.rs +++ b/sv2/handlers-sv2/src/template_distribution_owned.rs @@ -15,7 +15,7 @@ use crate::error::HandlerErrorType; /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_server()`. pub trait HandleTemplateDistributionMessagesFromServerOwnedSync { @@ -143,7 +143,7 @@ pub trait HandleTemplateDistributionMessagesFromServerOwnedSync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_server()`. #[trait_variant::make(Send)] @@ -282,7 +282,7 @@ pub trait HandleTemplateDistributionMessagesFromServerOwnedAsync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_client()`. pub trait HandleTemplateDistributionMessagesFromClientOwnedSync { @@ -404,7 +404,7 @@ pub trait HandleTemplateDistributionMessagesFromClientOwnedSync { /// /// ## TLV Extension Support /// -/// The `tlv_data` parameter in message handlers contains validated TLV fields if the message has +/// The `tlv_fields` parameter in message handlers contains validated TLV fields if the message has /// extension data appended. TLV fields are only passed if they match negotiated extensions /// returned by `get_negotiated_extensions_with_client()`. #[trait_variant::make(Send)] From cbdfe40ffd7ee23ec2abaadbe562fb14da7eb019 Mon Sep 17 00:00:00 2001 From: bit-aloo Date: Wed, 11 Nov 2026 23:18:41 +0530 Subject: [PATCH 3/8] refactor(handlers_sv2): drop explicit imports a glob already covers mining.rs, common.rs and both job declaration files imported a list of names from a crate they also glob-imported. --- sv2/handlers-sv2/src/common.rs | 4 +--- sv2/handlers-sv2/src/job_declaration.rs | 7 +------ sv2/handlers-sv2/src/job_declaration_owned.rs | 7 +------ sv2/handlers-sv2/src/mining.rs | 11 +---------- 4 files changed, 4 insertions(+), 25 deletions(-) diff --git a/sv2/handlers-sv2/src/common.rs b/sv2/handlers-sv2/src/common.rs index d6160ddcb1..e64efd230e 100644 --- a/sv2/handlers-sv2/src/common.rs +++ b/sv2/handlers-sv2/src/common.rs @@ -1,6 +1,4 @@ -use common_messages_sv2::{ - ChannelEndpointChanged, Reconnect, SetupConnectionError, SetupConnectionSuccess, *, -}; +use common_messages_sv2::*; use framing_sv2::header::Header; use parsers_sv2::{parse_message_frame_with_tlvs, AnyMessage, CommonMessages, Tlv}; diff --git a/sv2/handlers-sv2/src/job_declaration.rs b/sv2/handlers-sv2/src/job_declaration.rs index e6a5a73607..c4315a5041 100644 --- a/sv2/handlers-sv2/src/job_declaration.rs +++ b/sv2/handlers-sv2/src/job_declaration.rs @@ -1,10 +1,5 @@ use framing_sv2::header::Header; -use job_declaration_sv2::{ - MESSAGE_TYPE_ALLOCATE_MINING_JOB_TOKEN, MESSAGE_TYPE_ALLOCATE_MINING_JOB_TOKEN_SUCCESS, - MESSAGE_TYPE_DECLARE_MINING_JOB, MESSAGE_TYPE_DECLARE_MINING_JOB_ERROR, - MESSAGE_TYPE_DECLARE_MINING_JOB_SUCCESS, MESSAGE_TYPE_PROVIDE_MISSING_TRANSACTIONS, - MESSAGE_TYPE_PROVIDE_MISSING_TRANSACTIONS_SUCCESS, MESSAGE_TYPE_PUSH_SOLUTION, *, -}; +use job_declaration_sv2::*; use parsers_sv2::{parse_message_frame_with_tlvs, AnyMessage, JobDeclaration, Tlv}; use crate::error::HandlerErrorType; diff --git a/sv2/handlers-sv2/src/job_declaration_owned.rs b/sv2/handlers-sv2/src/job_declaration_owned.rs index 3cfd991070..f819d9df80 100644 --- a/sv2/handlers-sv2/src/job_declaration_owned.rs +++ b/sv2/handlers-sv2/src/job_declaration_owned.rs @@ -1,10 +1,5 @@ use framing_sv2::header::Header; -use job_declaration_sv2::{ - MESSAGE_TYPE_ALLOCATE_MINING_JOB_TOKEN, MESSAGE_TYPE_ALLOCATE_MINING_JOB_TOKEN_SUCCESS, - MESSAGE_TYPE_DECLARE_MINING_JOB, MESSAGE_TYPE_DECLARE_MINING_JOB_ERROR, - MESSAGE_TYPE_DECLARE_MINING_JOB_SUCCESS, MESSAGE_TYPE_PROVIDE_MISSING_TRANSACTIONS, - MESSAGE_TYPE_PROVIDE_MISSING_TRANSACTIONS_SUCCESS, MESSAGE_TYPE_PUSH_SOLUTION, *, -}; +use job_declaration_sv2::*; use parsers_sv2::{ parse_message_frame_with_tlvs, AnyMessage, JobDeclaration, JobDeclarationOwned, Tlv, }; diff --git a/sv2/handlers-sv2/src/mining.rs b/sv2/handlers-sv2/src/mining.rs index eaf3780390..679ea9346c 100644 --- a/sv2/handlers-sv2/src/mining.rs +++ b/sv2/handlers-sv2/src/mining.rs @@ -1,16 +1,7 @@ use crate::error::HandlerErrorType; use framing_sv2::header::Header; -use mining_sv2::{ - CloseChannel, NewExtendedMiningJob, NewMiningJob, OpenExtendedMiningChannel, - OpenExtendedMiningChannelSuccess, OpenMiningChannelError, OpenStandardMiningChannel, - OpenStandardMiningChannelSuccess, SetCustomMiningJob, SetCustomMiningJobError, - SetCustomMiningJobSuccess, SetExtranoncePrefix, SetGroupChannel, SetNewPrevHash, SetTarget, - SubmitSharesError, SubmitSharesExtended, SubmitSharesStandard, SubmitSharesSuccess, - UpdateChannel, UpdateChannelError, -}; -use parsers_sv2::{parse_message_frame_with_tlvs, AnyMessage, Mining, Tlv}; - use mining_sv2::*; +use parsers_sv2::{parse_message_frame_with_tlvs, AnyMessage, Mining, Tlv}; #[derive(PartialEq, Eq, Copy, Clone)] pub enum SupportedChannelTypes { From b91f952a2ea78e44ad320dfc8d4ccbdb2fc678bc Mon Sep 17 00:00:00 2001 From: bit-aloo Date: Wed, 11 Nov 2026 23:18:41 +0530 Subject: [PATCH 4/8] docs(mining_sv2): stop describing UpdateChannel as extended-only The spec lets a client update any channel it opened, and a standard channel's SetTarget bound refers to its latest accepted UpdateChannel. --- sv2/subprotocols/mining/src/update_channel.rs | 2 -- 1 file changed, 2 deletions(-) diff --git a/sv2/subprotocols/mining/src/update_channel.rs b/sv2/subprotocols/mining/src/update_channel.rs index 8ee84ba10e..b09eedd161 100644 --- a/sv2/subprotocols/mining/src/update_channel.rs +++ b/sv2/subprotocols/mining/src/update_channel.rs @@ -6,8 +6,6 @@ use core::convert::TryInto; /// /// If a downstream performs device/connection aggregation (i.e. it is a proxy), it must send this /// message when downstream channels change. -/// -/// Only relevant for Extended Channels. #[derive(Serialize, Deserialize, Debug, Clone)] pub struct UpdateChannel<'decoder> { /// Channel identification. From f5b75d1d92ade742dea6af238c5d208cfdeaf648 Mon Sep 17 00:00:00 2001 From: bit-aloo Date: Wed, 11 Nov 2026 23:18:59 +0530 Subject: [PATCH 5/8] fix(handlers_sv2)!: stop gating mining messages on SupportedChannelTypes The enum predates group channels holding extended channels: no variant let a group-mode client receive the NewMiningJob its standard channels start with, or run standard and extended channels side by side. Whether a message fits a channel depends on per-channel state the implementor already tracks, so the dispatchers now route by direction only. SetCustomMiningJob and its replies stay gated on work selection, which SetupConnection negotiates. --- sv2/handlers-sv2/src/lib.rs | 2 +- sv2/handlers-sv2/src/mining.rs | 379 +++++++-------------------- sv2/handlers-sv2/src/mining_owned.rs | 374 +++++++------------------- 3 files changed, 204 insertions(+), 551 deletions(-) diff --git a/sv2/handlers-sv2/src/lib.rs b/sv2/handlers-sv2/src/lib.rs index 8d5d2b8eaa..e05659a9c6 100644 --- a/sv2/handlers-sv2/src/lib.rs +++ b/sv2/handlers-sv2/src/lib.rs @@ -19,7 +19,7 @@ pub use common::{ pub use mining::{ HandleMiningMessagesFromClientAsync, HandleMiningMessagesFromClientSync, - HandleMiningMessagesFromServerAsync, HandleMiningMessagesFromServerSync, SupportedChannelTypes, + HandleMiningMessagesFromServerAsync, HandleMiningMessagesFromServerSync, }; pub use template_distribution::{ diff --git a/sv2/handlers-sv2/src/mining.rs b/sv2/handlers-sv2/src/mining.rs index 679ea9346c..3b89b0d246 100644 --- a/sv2/handlers-sv2/src/mining.rs +++ b/sv2/handlers-sv2/src/mining.rs @@ -3,13 +3,6 @@ use framing_sv2::header::Header; use mining_sv2::*; use parsers_sv2::{parse_message_frame_with_tlvs, AnyMessage, Mining, Tlv}; -#[derive(PartialEq, Eq, Copy, Clone)] -pub enum SupportedChannelTypes { - Standard, - Extended, - Group, - GroupAndExtended, -} /// Synchronous handler trait for processing mining messages received from servers. /// /// The server ID identifies which server a message originated from. @@ -23,7 +16,6 @@ pub enum SupportedChannelTypes { pub trait HandleMiningMessagesFromServerSync { type Error: HandlerErrorType; - fn get_channel_type_for_server(&self, server_id: Option) -> SupportedChannelTypes; fn is_work_selection_enabled_for_server(&self, server_id: Option) -> bool; /// Returns the list of negotiated extension_types with a server. @@ -77,33 +69,16 @@ pub trait HandleMiningMessagesFromServerSync { message: Mining, tlv_fields: Option<&[Tlv]>, ) -> Result<(), Self::Error> { - let (channel_type, work_selection) = ( - self.get_channel_type_for_server(server_id), - self.is_work_selection_enabled_for_server(server_id), - ); + let work_selection = self.is_work_selection_enabled_for_server(server_id); use Mining::*; match message { - OpenStandardMiningChannelSuccess(m) => match channel_type { - SupportedChannelTypes::Standard - | SupportedChannelTypes::Group - | SupportedChannelTypes::GroupAndExtended => { - self.handle_open_standard_mining_channel_success(server_id, m, tlv_fields) - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_OPEN_STANDARD_MINING_CHANNEL_SUCCESS, - )), - }, - OpenExtendedMiningChannelSuccess(m) => match channel_type { - SupportedChannelTypes::Extended | SupportedChannelTypes::GroupAndExtended => { - self.handle_open_extended_mining_channel_success(server_id, m, tlv_fields) - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_OPEN_EXTENDED_MINING_CHANNEL_SUCCESS, - )), - }, + OpenStandardMiningChannelSuccess(m) => { + self.handle_open_standard_mining_channel_success(server_id, m, tlv_fields) + } + OpenExtendedMiningChannelSuccess(m) => { + self.handle_open_extended_mining_channel_success(server_id, m, tlv_fields) + } OpenMiningChannelError(m) => { self.handle_open_mining_channel_error(server_id, m, tlv_fields) @@ -114,62 +89,31 @@ pub trait HandleMiningMessagesFromServerSync { SubmitSharesSuccess(m) => self.handle_submit_shares_success(server_id, m, tlv_fields), SubmitSharesError(m) => self.handle_submit_shares_error(server_id, m, tlv_fields), - NewMiningJob(m) => match channel_type { - SupportedChannelTypes::Standard => { - self.handle_new_mining_job(server_id, m, tlv_fields) - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_NEW_MINING_JOB, - )), - }, - NewExtendedMiningJob(m) => match channel_type { - SupportedChannelTypes::Extended - | SupportedChannelTypes::Group - | SupportedChannelTypes::GroupAndExtended => { - self.handle_new_extended_mining_job(server_id, m, tlv_fields) - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_NEW_EXTENDED_MINING_JOB, - )), - }, + NewMiningJob(m) => self.handle_new_mining_job(server_id, m, tlv_fields), + NewExtendedMiningJob(m) => { + self.handle_new_extended_mining_job(server_id, m, tlv_fields) + } SetNewPrevHash(m) => self.handle_set_new_prev_hash(server_id, m, tlv_fields), - SetCustomMiningJobSuccess(m) => match (channel_type, work_selection) { - (SupportedChannelTypes::Extended, true) - | (SupportedChannelTypes::GroupAndExtended, true) => { - self.handle_set_custom_mining_job_success(server_id, m, tlv_fields) - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SET_CUSTOM_MINING_JOB_SUCCESS, - )), - }, - SetCustomMiningJobError(m) => match (channel_type, work_selection) { - (SupportedChannelTypes::Extended, true) - | (SupportedChannelTypes::Group, true) - | (SupportedChannelTypes::GroupAndExtended, true) => { - self.handle_set_custom_mining_job_error(server_id, m, tlv_fields) - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SET_CUSTOM_MINING_JOB_ERROR, - )), - }, + SetCustomMiningJobSuccess(m) if work_selection => { + self.handle_set_custom_mining_job_success(server_id, m, tlv_fields) + } + SetCustomMiningJobSuccess(_) => Err(Self::Error::unexpected_message( + 0, + MESSAGE_TYPE_SET_CUSTOM_MINING_JOB_SUCCESS, + )), + SetCustomMiningJobError(m) if work_selection => { + self.handle_set_custom_mining_job_error(server_id, m, tlv_fields) + } + SetCustomMiningJobError(_) => Err(Self::Error::unexpected_message( + 0, + MESSAGE_TYPE_SET_CUSTOM_MINING_JOB_ERROR, + )), SetTarget(m) => self.handle_set_target(server_id, m, tlv_fields), - SetGroupChannel(m) => match channel_type { - SupportedChannelTypes::Group | SupportedChannelTypes::GroupAndExtended => { - self.handle_set_group_channel(server_id, m, tlv_fields) - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SET_GROUP_CHANNEL, - )), - }, + SetGroupChannel(m) => self.handle_set_group_channel(server_id, m, tlv_fields), SubmitSharesExtended(_) => Err(Self::Error::unexpected_message( 0, MESSAGE_TYPE_SUBMIT_SHARES_EXTENDED, @@ -317,7 +261,6 @@ pub trait HandleMiningMessagesFromServerSync { pub trait HandleMiningMessagesFromServerAsync { type Error: HandlerErrorType; - fn get_channel_type_for_server(&self, server_id: Option) -> SupportedChannelTypes; fn is_work_selection_enabled_for_server(&self, server_id: Option) -> bool; /// Returns the list of negotiated extension_types with a server. @@ -376,36 +319,19 @@ pub trait HandleMiningMessagesFromServerAsync { message: Mining, tlv_fields: Option<&[Tlv]>, ) -> Result<(), Self::Error> { - let (channel_type, work_selection) = ( - self.get_channel_type_for_server(server_id), - self.is_work_selection_enabled_for_server(server_id), - ); + let work_selection = self.is_work_selection_enabled_for_server(server_id); async move { use Mining::*; match message { - OpenStandardMiningChannelSuccess(m) => match channel_type { - SupportedChannelTypes::Standard - | SupportedChannelTypes::Group - | SupportedChannelTypes::GroupAndExtended => { - self.handle_open_standard_mining_channel_success(server_id, m, tlv_fields) - .await - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_OPEN_STANDARD_MINING_CHANNEL_SUCCESS, - )), - }, - OpenExtendedMiningChannelSuccess(m) => match channel_type { - SupportedChannelTypes::Extended | SupportedChannelTypes::GroupAndExtended => { - self.handle_open_extended_mining_channel_success(server_id, m, tlv_fields) - .await - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_OPEN_EXTENDED_MINING_CHANNEL_SUCCESS, - )), - }, + OpenStandardMiningChannelSuccess(m) => { + self.handle_open_standard_mining_channel_success(server_id, m, tlv_fields) + .await + } + OpenExtendedMiningChannelSuccess(m) => { + self.handle_open_extended_mining_channel_success(server_id, m, tlv_fields) + .await + } OpenMiningChannelError(m) => { self.handle_open_mining_channel_error(server_id, m, tlv_fields) .await @@ -428,69 +354,40 @@ pub trait HandleMiningMessagesFromServerAsync { .await } - NewMiningJob(m) => match channel_type { - SupportedChannelTypes::Standard => { - self.handle_new_mining_job(server_id, m, tlv_fields).await - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_NEW_MINING_JOB, - )), - }, - NewExtendedMiningJob(m) => match channel_type { - SupportedChannelTypes::Extended - | SupportedChannelTypes::Group - | SupportedChannelTypes::GroupAndExtended => { - self.handle_new_extended_mining_job(server_id, m, tlv_fields) - .await - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_NEW_EXTENDED_MINING_JOB, - )), - }, + NewMiningJob(m) => self.handle_new_mining_job(server_id, m, tlv_fields).await, + NewExtendedMiningJob(m) => { + self.handle_new_extended_mining_job(server_id, m, tlv_fields) + .await + } SetNewPrevHash(m) => { self.handle_set_new_prev_hash(server_id, m, tlv_fields) .await } - SetCustomMiningJobSuccess(m) => match (channel_type, work_selection) { - (SupportedChannelTypes::Extended, true) - | (SupportedChannelTypes::GroupAndExtended, true) => { - self.handle_set_custom_mining_job_success(server_id, m, tlv_fields) - .await - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SET_CUSTOM_MINING_JOB_SUCCESS, - )), - }, - SetCustomMiningJobError(m) => match (channel_type, work_selection) { - (SupportedChannelTypes::Extended, true) - | (SupportedChannelTypes::Group, true) - | (SupportedChannelTypes::GroupAndExtended, true) => { - self.handle_set_custom_mining_job_error(server_id, m, tlv_fields) - .await - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SET_CUSTOM_MINING_JOB_ERROR, - )), - }, + SetCustomMiningJobSuccess(m) if work_selection => { + self.handle_set_custom_mining_job_success(server_id, m, tlv_fields) + .await + } + SetCustomMiningJobSuccess(_) => Err(Self::Error::unexpected_message( + 0, + MESSAGE_TYPE_SET_CUSTOM_MINING_JOB_SUCCESS, + )), + SetCustomMiningJobError(m) if work_selection => { + self.handle_set_custom_mining_job_error(server_id, m, tlv_fields) + .await + } + SetCustomMiningJobError(_) => Err(Self::Error::unexpected_message( + 0, + MESSAGE_TYPE_SET_CUSTOM_MINING_JOB_ERROR, + )), SetTarget(m) => self.handle_set_target(server_id, m, tlv_fields).await, - SetGroupChannel(m) => match channel_type { - SupportedChannelTypes::Group | SupportedChannelTypes::GroupAndExtended => { - self.handle_set_group_channel(server_id, m, tlv_fields) - .await - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SET_GROUP_CHANNEL, - )), - }, + SetGroupChannel(m) => { + self.handle_set_group_channel(server_id, m, tlv_fields) + .await + } SubmitSharesExtended(_) => Err(Self::Error::unexpected_message( 0, MESSAGE_TYPE_SUBMIT_SHARES_EXTENDED, @@ -638,7 +535,6 @@ pub trait HandleMiningMessagesFromServerAsync { pub trait HandleMiningMessagesFromClientSync { type Error: HandlerErrorType; - fn get_channel_type_for_client(&self, client_id: Option) -> SupportedChannelTypes; fn is_work_selection_enabled_for_client(&self, client_id: Option) -> bool; /// Returns the list of negotiated extension_types with a client. @@ -691,65 +587,27 @@ pub trait HandleMiningMessagesFromClientSync { message: Mining, tlv_fields: Option<&[Tlv]>, ) -> Result<(), Self::Error> { - let (channel_type, work_selection) = ( - self.get_channel_type_for_client(client_id), - self.is_work_selection_enabled_for_client(client_id), - ); + let work_selection = self.is_work_selection_enabled_for_client(client_id); use Mining::*; match message { - OpenStandardMiningChannel(m) => match channel_type { - SupportedChannelTypes::Standard - | SupportedChannelTypes::Group - | SupportedChannelTypes::GroupAndExtended => { - self.handle_open_standard_mining_channel(client_id, m, tlv_fields) - } - SupportedChannelTypes::Extended => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_OPEN_STANDARD_MINING_CHANNEL, - )), - }, - OpenExtendedMiningChannel(m) => match channel_type { - SupportedChannelTypes::Extended | SupportedChannelTypes::GroupAndExtended => { - self.handle_open_extended_mining_channel(client_id, m, tlv_fields) - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_OPEN_EXTENDED_MINING_CHANNEL, - )), - }, + OpenStandardMiningChannel(m) => { + self.handle_open_standard_mining_channel(client_id, m, tlv_fields) + } + OpenExtendedMiningChannel(m) => { + self.handle_open_extended_mining_channel(client_id, m, tlv_fields) + } UpdateChannel(m) => self.handle_update_channel(client_id, m, tlv_fields), - SubmitSharesStandard(m) => match channel_type { - SupportedChannelTypes::Standard - | SupportedChannelTypes::Group - | SupportedChannelTypes::GroupAndExtended => { - self.handle_submit_shares_standard(client_id, m, tlv_fields) - } - SupportedChannelTypes::Extended => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SUBMIT_SHARES_STANDARD, - )), - }, - SubmitSharesExtended(m) => match channel_type { - SupportedChannelTypes::Extended | SupportedChannelTypes::GroupAndExtended => { - self.handle_submit_shares_extended(client_id, m, tlv_fields) - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SUBMIT_SHARES_EXTENDED, - )), - }, - SetCustomMiningJob(m) => match (channel_type, work_selection) { - (SupportedChannelTypes::Extended, true) - | (SupportedChannelTypes::GroupAndExtended, true) => { - self.handle_set_custom_mining_job(client_id, m, tlv_fields) - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SET_CUSTOM_MINING_JOB, - )), - }, + SubmitSharesStandard(m) => self.handle_submit_shares_standard(client_id, m, tlv_fields), + SubmitSharesExtended(m) => self.handle_submit_shares_extended(client_id, m, tlv_fields), + SetCustomMiningJob(m) if work_selection => { + self.handle_set_custom_mining_job(client_id, m, tlv_fields) + } + SetCustomMiningJob(_) => Err(Self::Error::unexpected_message( + 0, + MESSAGE_TYPE_SET_CUSTOM_MINING_JOB, + )), CloseChannel(m) => self.handle_close_channel(client_id, m, tlv_fields), NewExtendedMiningJob(_) => Err(Self::Error::unexpected_message( 0, @@ -873,7 +731,6 @@ pub trait HandleMiningMessagesFromClientSync { pub trait HandleMiningMessagesFromClientAsync { type Error: HandlerErrorType; - fn get_channel_type_for_client(&self, client_id: Option) -> SupportedChannelTypes; fn is_work_selection_enabled_for_client(&self, client_id: Option) -> bool; /// Returns the list of negotiated extension types for a client. @@ -932,71 +789,37 @@ pub trait HandleMiningMessagesFromClientAsync { message: Mining, tlv_fields: Option<&[Tlv]>, ) -> Result<(), Self::Error> { - let (channel_type, work_selection) = ( - self.get_channel_type_for_client(client_id), - self.is_work_selection_enabled_for_client(client_id), - ); + let work_selection = self.is_work_selection_enabled_for_client(client_id); async move { use Mining::*; match message { - OpenStandardMiningChannel(m) => match channel_type { - SupportedChannelTypes::Standard - | SupportedChannelTypes::Group - | SupportedChannelTypes::GroupAndExtended => { - self.handle_open_standard_mining_channel(client_id, m, tlv_fields) - .await - } - SupportedChannelTypes::Extended => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_OPEN_STANDARD_MINING_CHANNEL, - )), - }, - OpenExtendedMiningChannel(m) => match channel_type { - SupportedChannelTypes::Extended | SupportedChannelTypes::GroupAndExtended => { - self.handle_open_extended_mining_channel(client_id, m, tlv_fields) - .await - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_OPEN_EXTENDED_MINING_CHANNEL, - )), - }, + OpenStandardMiningChannel(m) => { + self.handle_open_standard_mining_channel(client_id, m, tlv_fields) + .await + } + OpenExtendedMiningChannel(m) => { + self.handle_open_extended_mining_channel(client_id, m, tlv_fields) + .await + } UpdateChannel(m) => self.handle_update_channel(client_id, m, tlv_fields).await, - SubmitSharesStandard(m) => match channel_type { - SupportedChannelTypes::Standard - | SupportedChannelTypes::Group - | SupportedChannelTypes::GroupAndExtended => { - self.handle_submit_shares_standard(client_id, m, tlv_fields) - .await - } - SupportedChannelTypes::Extended => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SUBMIT_SHARES_STANDARD, - )), - }, - SubmitSharesExtended(m) => match channel_type { - SupportedChannelTypes::Extended | SupportedChannelTypes::GroupAndExtended => { - self.handle_submit_shares_extended(client_id, m, tlv_fields) - .await - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SUBMIT_SHARES_EXTENDED, - )), - }, - SetCustomMiningJob(m) => match (channel_type, work_selection) { - (SupportedChannelTypes::Extended, true) - | (SupportedChannelTypes::GroupAndExtended, true) => { - self.handle_set_custom_mining_job(client_id, m, tlv_fields) - .await - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SET_CUSTOM_MINING_JOB, - )), - }, + SubmitSharesStandard(m) => { + self.handle_submit_shares_standard(client_id, m, tlv_fields) + .await + } + SubmitSharesExtended(m) => { + self.handle_submit_shares_extended(client_id, m, tlv_fields) + .await + } + SetCustomMiningJob(m) if work_selection => { + self.handle_set_custom_mining_job(client_id, m, tlv_fields) + .await + } + SetCustomMiningJob(_) => Err(Self::Error::unexpected_message( + 0, + MESSAGE_TYPE_SET_CUSTOM_MINING_JOB, + )), CloseChannel(m) => self.handle_close_channel(client_id, m, tlv_fields).await, NewExtendedMiningJob(_) => Err(Self::Error::unexpected_message( 0, diff --git a/sv2/handlers-sv2/src/mining_owned.rs b/sv2/handlers-sv2/src/mining_owned.rs index d37bf346f6..425bdb1e79 100644 --- a/sv2/handlers-sv2/src/mining_owned.rs +++ b/sv2/handlers-sv2/src/mining_owned.rs @@ -1,4 +1,4 @@ -use crate::{error::HandlerErrorType, mining::SupportedChannelTypes}; +use crate::error::HandlerErrorType; use framing_sv2::header::Header; use parsers_sv2::{parse_message_frame_with_tlvs, AnyMessage, Mining, MiningOwned, Tlv}; @@ -17,7 +17,6 @@ use mining_sv2::*; pub trait HandleMiningMessagesFromServerOwnedSync { type Error: HandlerErrorType; - fn get_channel_type_for_server(&self, server_id: Option) -> SupportedChannelTypes; fn is_work_selection_enabled_for_server(&self, server_id: Option) -> bool; /// Returns the list of negotiated extension_types with a server. @@ -73,33 +72,16 @@ pub trait HandleMiningMessagesFromServerOwnedSync { message: MiningOwned, tlv_fields: Option<&[Tlv]>, ) -> Result<(), Self::Error> { - let (channel_type, work_selection) = ( - self.get_channel_type_for_server(server_id), - self.is_work_selection_enabled_for_server(server_id), - ); + let work_selection = self.is_work_selection_enabled_for_server(server_id); use parsers_sv2::MiningOwned::*; match message { - OpenStandardMiningChannelSuccess(m) => match channel_type { - SupportedChannelTypes::Standard - | SupportedChannelTypes::Group - | SupportedChannelTypes::GroupAndExtended => { - self.handle_open_standard_mining_channel_success(server_id, m, tlv_fields) - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_OPEN_STANDARD_MINING_CHANNEL_SUCCESS, - )), - }, - OpenExtendedMiningChannelSuccess(m) => match channel_type { - SupportedChannelTypes::Extended | SupportedChannelTypes::GroupAndExtended => { - self.handle_open_extended_mining_channel_success(server_id, m, tlv_fields) - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_OPEN_EXTENDED_MINING_CHANNEL_SUCCESS, - )), - }, + OpenStandardMiningChannelSuccess(m) => { + self.handle_open_standard_mining_channel_success(server_id, m, tlv_fields) + } + OpenExtendedMiningChannelSuccess(m) => { + self.handle_open_extended_mining_channel_success(server_id, m, tlv_fields) + } OpenMiningChannelError(m) => { self.handle_open_mining_channel_error(server_id, m, tlv_fields) @@ -110,62 +92,31 @@ pub trait HandleMiningMessagesFromServerOwnedSync { SubmitSharesSuccess(m) => self.handle_submit_shares_success(server_id, m, tlv_fields), SubmitSharesError(m) => self.handle_submit_shares_error(server_id, m, tlv_fields), - NewMiningJob(m) => match channel_type { - SupportedChannelTypes::Standard => { - self.handle_new_mining_job(server_id, m, tlv_fields) - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_NEW_MINING_JOB, - )), - }, - NewExtendedMiningJob(m) => match channel_type { - SupportedChannelTypes::Extended - | SupportedChannelTypes::Group - | SupportedChannelTypes::GroupAndExtended => { - self.handle_new_extended_mining_job(server_id, m, tlv_fields) - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_NEW_EXTENDED_MINING_JOB, - )), - }, + NewMiningJob(m) => self.handle_new_mining_job(server_id, m, tlv_fields), + NewExtendedMiningJob(m) => { + self.handle_new_extended_mining_job(server_id, m, tlv_fields) + } SetNewPrevHash(m) => self.handle_set_new_prev_hash(server_id, m, tlv_fields), - SetCustomMiningJobSuccess(m) => match (channel_type, work_selection) { - (SupportedChannelTypes::Extended, true) - | (SupportedChannelTypes::GroupAndExtended, true) => { - self.handle_set_custom_mining_job_success(server_id, m, tlv_fields) - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SET_CUSTOM_MINING_JOB_SUCCESS, - )), - }, - SetCustomMiningJobError(m) => match (channel_type, work_selection) { - (SupportedChannelTypes::Extended, true) - | (SupportedChannelTypes::Group, true) - | (SupportedChannelTypes::GroupAndExtended, true) => { - self.handle_set_custom_mining_job_error(server_id, m, tlv_fields) - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SET_CUSTOM_MINING_JOB_ERROR, - )), - }, + SetCustomMiningJobSuccess(m) if work_selection => { + self.handle_set_custom_mining_job_success(server_id, m, tlv_fields) + } + SetCustomMiningJobSuccess(_) => Err(Self::Error::unexpected_message( + 0, + MESSAGE_TYPE_SET_CUSTOM_MINING_JOB_SUCCESS, + )), + SetCustomMiningJobError(m) if work_selection => { + self.handle_set_custom_mining_job_error(server_id, m, tlv_fields) + } + SetCustomMiningJobError(_) => Err(Self::Error::unexpected_message( + 0, + MESSAGE_TYPE_SET_CUSTOM_MINING_JOB_ERROR, + )), SetTarget(m) => self.handle_set_target(server_id, m, tlv_fields), - SetGroupChannel(m) => match channel_type { - SupportedChannelTypes::Group | SupportedChannelTypes::GroupAndExtended => { - self.handle_set_group_channel(server_id, m, tlv_fields) - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SET_GROUP_CHANNEL, - )), - }, + SetGroupChannel(m) => self.handle_set_group_channel(server_id, m, tlv_fields), SubmitSharesExtended(_) => Err(Self::Error::unexpected_message( 0, MESSAGE_TYPE_SUBMIT_SHARES_EXTENDED, @@ -313,7 +264,6 @@ pub trait HandleMiningMessagesFromServerOwnedSync { pub trait HandleMiningMessagesFromServerOwnedAsync { type Error: HandlerErrorType; - fn get_channel_type_for_server(&self, server_id: Option) -> SupportedChannelTypes; fn is_work_selection_enabled_for_server(&self, server_id: Option) -> bool; /// Returns the list of negotiated extension_types with a server. @@ -376,36 +326,19 @@ pub trait HandleMiningMessagesFromServerOwnedAsync { message: MiningOwned, tlv_fields: Option<&[Tlv]>, ) -> Result<(), Self::Error> { - let (channel_type, work_selection) = ( - self.get_channel_type_for_server(server_id), - self.is_work_selection_enabled_for_server(server_id), - ); + let work_selection = self.is_work_selection_enabled_for_server(server_id); async move { use parsers_sv2::MiningOwned::*; match message { - OpenStandardMiningChannelSuccess(m) => match channel_type { - SupportedChannelTypes::Standard - | SupportedChannelTypes::Group - | SupportedChannelTypes::GroupAndExtended => { - self.handle_open_standard_mining_channel_success(server_id, m, tlv_fields) - .await - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_OPEN_STANDARD_MINING_CHANNEL_SUCCESS, - )), - }, - OpenExtendedMiningChannelSuccess(m) => match channel_type { - SupportedChannelTypes::Extended | SupportedChannelTypes::GroupAndExtended => { - self.handle_open_extended_mining_channel_success(server_id, m, tlv_fields) - .await - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_OPEN_EXTENDED_MINING_CHANNEL_SUCCESS, - )), - }, + OpenStandardMiningChannelSuccess(m) => { + self.handle_open_standard_mining_channel_success(server_id, m, tlv_fields) + .await + } + OpenExtendedMiningChannelSuccess(m) => { + self.handle_open_extended_mining_channel_success(server_id, m, tlv_fields) + .await + } OpenMiningChannelError(m) => { self.handle_open_mining_channel_error(server_id, m, tlv_fields) .await @@ -428,69 +361,40 @@ pub trait HandleMiningMessagesFromServerOwnedAsync { .await } - NewMiningJob(m) => match channel_type { - SupportedChannelTypes::Standard => { - self.handle_new_mining_job(server_id, m, tlv_fields).await - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_NEW_MINING_JOB, - )), - }, - NewExtendedMiningJob(m) => match channel_type { - SupportedChannelTypes::Extended - | SupportedChannelTypes::Group - | SupportedChannelTypes::GroupAndExtended => { - self.handle_new_extended_mining_job(server_id, m, tlv_fields) - .await - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_NEW_EXTENDED_MINING_JOB, - )), - }, + NewMiningJob(m) => self.handle_new_mining_job(server_id, m, tlv_fields).await, + NewExtendedMiningJob(m) => { + self.handle_new_extended_mining_job(server_id, m, tlv_fields) + .await + } SetNewPrevHash(m) => { self.handle_set_new_prev_hash(server_id, m, tlv_fields) .await } - SetCustomMiningJobSuccess(m) => match (channel_type, work_selection) { - (SupportedChannelTypes::Extended, true) - | (SupportedChannelTypes::GroupAndExtended, true) => { - self.handle_set_custom_mining_job_success(server_id, m, tlv_fields) - .await - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SET_CUSTOM_MINING_JOB_SUCCESS, - )), - }, - SetCustomMiningJobError(m) => match (channel_type, work_selection) { - (SupportedChannelTypes::Extended, true) - | (SupportedChannelTypes::Group, true) - | (SupportedChannelTypes::GroupAndExtended, true) => { - self.handle_set_custom_mining_job_error(server_id, m, tlv_fields) - .await - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SET_CUSTOM_MINING_JOB_ERROR, - )), - }, + SetCustomMiningJobSuccess(m) if work_selection => { + self.handle_set_custom_mining_job_success(server_id, m, tlv_fields) + .await + } + SetCustomMiningJobSuccess(_) => Err(Self::Error::unexpected_message( + 0, + MESSAGE_TYPE_SET_CUSTOM_MINING_JOB_SUCCESS, + )), + SetCustomMiningJobError(m) if work_selection => { + self.handle_set_custom_mining_job_error(server_id, m, tlv_fields) + .await + } + SetCustomMiningJobError(_) => Err(Self::Error::unexpected_message( + 0, + MESSAGE_TYPE_SET_CUSTOM_MINING_JOB_ERROR, + )), SetTarget(m) => self.handle_set_target(server_id, m, tlv_fields).await, - SetGroupChannel(m) => match channel_type { - SupportedChannelTypes::Group | SupportedChannelTypes::GroupAndExtended => { - self.handle_set_group_channel(server_id, m, tlv_fields) - .await - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SET_GROUP_CHANNEL, - )), - }, + SetGroupChannel(m) => { + self.handle_set_group_channel(server_id, m, tlv_fields) + .await + } SubmitSharesExtended(_) => Err(Self::Error::unexpected_message( 0, MESSAGE_TYPE_SUBMIT_SHARES_EXTENDED, @@ -638,7 +542,6 @@ pub trait HandleMiningMessagesFromServerOwnedAsync { pub trait HandleMiningMessagesFromClientOwnedSync { type Error: HandlerErrorType; - fn get_channel_type_for_client(&self, client_id: Option) -> SupportedChannelTypes; fn is_work_selection_enabled_for_client(&self, client_id: Option) -> bool; /// Returns the list of negotiated extension_types with a client. @@ -693,65 +596,27 @@ pub trait HandleMiningMessagesFromClientOwnedSync { message: MiningOwned, tlv_fields: Option<&[Tlv]>, ) -> Result<(), Self::Error> { - let (channel_type, work_selection) = ( - self.get_channel_type_for_client(client_id), - self.is_work_selection_enabled_for_client(client_id), - ); + let work_selection = self.is_work_selection_enabled_for_client(client_id); use parsers_sv2::MiningOwned::*; match message { - OpenStandardMiningChannel(m) => match channel_type { - SupportedChannelTypes::Standard - | SupportedChannelTypes::Group - | SupportedChannelTypes::GroupAndExtended => { - self.handle_open_standard_mining_channel(client_id, m, tlv_fields) - } - SupportedChannelTypes::Extended => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_OPEN_STANDARD_MINING_CHANNEL, - )), - }, - OpenExtendedMiningChannel(m) => match channel_type { - SupportedChannelTypes::Extended | SupportedChannelTypes::GroupAndExtended => { - self.handle_open_extended_mining_channel(client_id, m, tlv_fields) - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_OPEN_EXTENDED_MINING_CHANNEL, - )), - }, + OpenStandardMiningChannel(m) => { + self.handle_open_standard_mining_channel(client_id, m, tlv_fields) + } + OpenExtendedMiningChannel(m) => { + self.handle_open_extended_mining_channel(client_id, m, tlv_fields) + } UpdateChannel(m) => self.handle_update_channel(client_id, m, tlv_fields), - SubmitSharesStandard(m) => match channel_type { - SupportedChannelTypes::Standard - | SupportedChannelTypes::Group - | SupportedChannelTypes::GroupAndExtended => { - self.handle_submit_shares_standard(client_id, m, tlv_fields) - } - SupportedChannelTypes::Extended => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SUBMIT_SHARES_STANDARD, - )), - }, - SubmitSharesExtended(m) => match channel_type { - SupportedChannelTypes::Extended | SupportedChannelTypes::GroupAndExtended => { - self.handle_submit_shares_extended(client_id, m, tlv_fields) - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SUBMIT_SHARES_EXTENDED, - )), - }, - SetCustomMiningJob(m) => match (channel_type, work_selection) { - (SupportedChannelTypes::Extended, true) - | (SupportedChannelTypes::GroupAndExtended, true) => { - self.handle_set_custom_mining_job(client_id, m, tlv_fields) - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SET_CUSTOM_MINING_JOB, - )), - }, + SubmitSharesStandard(m) => self.handle_submit_shares_standard(client_id, m, tlv_fields), + SubmitSharesExtended(m) => self.handle_submit_shares_extended(client_id, m, tlv_fields), + SetCustomMiningJob(m) if work_selection => { + self.handle_set_custom_mining_job(client_id, m, tlv_fields) + } + SetCustomMiningJob(_) => Err(Self::Error::unexpected_message( + 0, + MESSAGE_TYPE_SET_CUSTOM_MINING_JOB, + )), CloseChannel(m) => self.handle_close_channel(client_id, m, tlv_fields), NewExtendedMiningJob(_) => Err(Self::Error::unexpected_message( 0, @@ -875,7 +740,6 @@ pub trait HandleMiningMessagesFromClientOwnedSync { pub trait HandleMiningMessagesFromClientOwnedAsync { type Error: HandlerErrorType; - fn get_channel_type_for_client(&self, client_id: Option) -> SupportedChannelTypes; fn is_work_selection_enabled_for_client(&self, client_id: Option) -> bool; /// Returns the list of negotiated extension types for a client. @@ -938,71 +802,37 @@ pub trait HandleMiningMessagesFromClientOwnedAsync { message: MiningOwned, tlv_fields: Option<&[Tlv]>, ) -> Result<(), Self::Error> { - let (channel_type, work_selection) = ( - self.get_channel_type_for_client(client_id), - self.is_work_selection_enabled_for_client(client_id), - ); + let work_selection = self.is_work_selection_enabled_for_client(client_id); async move { use parsers_sv2::MiningOwned::*; match message { - OpenStandardMiningChannel(m) => match channel_type { - SupportedChannelTypes::Standard - | SupportedChannelTypes::Group - | SupportedChannelTypes::GroupAndExtended => { - self.handle_open_standard_mining_channel(client_id, m, tlv_fields) - .await - } - SupportedChannelTypes::Extended => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_OPEN_STANDARD_MINING_CHANNEL, - )), - }, - OpenExtendedMiningChannel(m) => match channel_type { - SupportedChannelTypes::Extended | SupportedChannelTypes::GroupAndExtended => { - self.handle_open_extended_mining_channel(client_id, m, tlv_fields) - .await - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_OPEN_EXTENDED_MINING_CHANNEL, - )), - }, + OpenStandardMiningChannel(m) => { + self.handle_open_standard_mining_channel(client_id, m, tlv_fields) + .await + } + OpenExtendedMiningChannel(m) => { + self.handle_open_extended_mining_channel(client_id, m, tlv_fields) + .await + } UpdateChannel(m) => self.handle_update_channel(client_id, m, tlv_fields).await, - SubmitSharesStandard(m) => match channel_type { - SupportedChannelTypes::Standard - | SupportedChannelTypes::Group - | SupportedChannelTypes::GroupAndExtended => { - self.handle_submit_shares_standard(client_id, m, tlv_fields) - .await - } - SupportedChannelTypes::Extended => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SUBMIT_SHARES_STANDARD, - )), - }, - SubmitSharesExtended(m) => match channel_type { - SupportedChannelTypes::Extended | SupportedChannelTypes::GroupAndExtended => { - self.handle_submit_shares_extended(client_id, m, tlv_fields) - .await - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SUBMIT_SHARES_EXTENDED, - )), - }, - SetCustomMiningJob(m) => match (channel_type, work_selection) { - (SupportedChannelTypes::Extended, true) - | (SupportedChannelTypes::GroupAndExtended, true) => { - self.handle_set_custom_mining_job(client_id, m, tlv_fields) - .await - } - _ => Err(Self::Error::unexpected_message( - 0, - MESSAGE_TYPE_SET_CUSTOM_MINING_JOB, - )), - }, + SubmitSharesStandard(m) => { + self.handle_submit_shares_standard(client_id, m, tlv_fields) + .await + } + SubmitSharesExtended(m) => { + self.handle_submit_shares_extended(client_id, m, tlv_fields) + .await + } + SetCustomMiningJob(m) if work_selection => { + self.handle_set_custom_mining_job(client_id, m, tlv_fields) + .await + } + SetCustomMiningJob(_) => Err(Self::Error::unexpected_message( + 0, + MESSAGE_TYPE_SET_CUSTOM_MINING_JOB, + )), CloseChannel(m) => self.handle_close_channel(client_id, m, tlv_fields).await, NewExtendedMiningJob(_) => Err(Self::Error::unexpected_message( 0, From bdfc0fcc18bb2aa1b7585d049449d35e85de20df Mon Sep 17 00:00:00 2001 From: bit-aloo Date: Wed, 11 Nov 2026 23:19:12 +0530 Subject: [PATCH 6/8] fix(parsers_sv2)!: check a frame's length and channel bit against its header AnyMessage::try_from((Header, payload)) ignored the header's payload length and channel_msg bit, so a frame whose header disagreed with its body still decoded, and an intermediary routing on the header could read it differently from the endpoint. Both now fail with dedicated ParserError variants, which parse_message_frame_with_tlvs inherits. --- sv2/parsers-sv2/src/error.rs | 21 ++++++ sv2/parsers-sv2/src/lib.rs | 129 +++++++++++++++++++++++++++++++++-- 2 files changed, 143 insertions(+), 7 deletions(-) diff --git a/sv2/parsers-sv2/src/error.rs b/sv2/parsers-sv2/src/error.rs index 70f5ebd400..aec334ec75 100644 --- a/sv2/parsers-sv2/src/error.rs +++ b/sv2/parsers-sv2/src/error.rs @@ -6,6 +6,16 @@ pub enum ParserError { BinaryError(binary_sv2::Error), TlvError(crate::tlv::TlvError), ExtensionError(crate::tlv_extensions::ExtensionError), + /// The payload is not as long as its `Header` declares. + PayloadLengthMismatch { + declared: usize, + actual: usize, + }, + /// The `Header`'s channel_msg bit differs from the one the decoded message type defines. + ChannelBitMismatch { + message_type: u8, + channel_msg: bool, + }, } impl From for ParserError { @@ -37,6 +47,17 @@ impl core::fmt::Display for ParserError { ParserError::BinaryError(e) => write!(f, "Binary error: {e}"), ParserError::TlvError(e) => write!(f, "TLV error: {e}"), ParserError::ExtensionError(e) => write!(f, "Extension error: {e}"), + ParserError::PayloadLengthMismatch { declared, actual } => write!( + f, + "Payload is {actual} bytes, its header declares {declared}" + ), + ParserError::ChannelBitMismatch { + message_type, + channel_msg, + } => write!( + f, + "Header channel_msg bit is {channel_msg} for message type {message_type:#04x}" + ), } } } diff --git a/sv2/parsers-sv2/src/lib.rs b/sv2/parsers-sv2/src/lib.rs index a7c7d945b1..51658f69ac 100644 --- a/sv2/parsers-sv2/src/lib.rs +++ b/sv2/parsers-sv2/src/lib.rs @@ -2266,17 +2266,35 @@ impl IsSv2Message for MiningDeviceMessagesOwned { } } -/// TryFrom implementation for AnyMessage that includes extension_type from Header. +/// Decodes a frame's payload according to its `Header`. /// -/// This implementation handles all message types including Extensions messages which require -/// both extension_type and message_type to be correctly parsed. Standard protocol messages -/// (Common, Mining, etc.) have extension_type == 0 and only need the message_type. +/// The header's extension_type selects between Extensions messages and the standard protocol +/// messages (extension_type == 0). The payload must be exactly as long as the header declares, +/// and the header's channel_msg bit must match the one the decoded message type defines. impl<'a> TryFrom<(Header, &'a mut [u8])> for AnyMessage<'a> { type Error = ParserError; fn try_from(v: (Header, &'a mut [u8])) -> Result { - let header = v.0; - let payload = v.1; + let (header, payload) = v; + if payload.len() != header.payload_length() { + return Err(ParserError::PayloadLengthMismatch { + declared: header.payload_length(), + actual: payload.len(), + }); + } + let message = Self::decode_payload(header, payload)?; + if message.channel_bit() != header.channel_msg() { + return Err(ParserError::ChannelBitMismatch { + message_type: header.msg_type(), + channel_msg: header.channel_msg(), + }); + } + Ok(message) + } +} + +impl<'a> AnyMessage<'a> { + fn decode_payload(header: Header, payload: &'a mut [u8]) -> Result { let extension_type = header.ext_type_without_channel_msg(); let message_type = header.msg_type(); @@ -2655,13 +2673,20 @@ impl<'a> TryFrom> for MiningDeviceMessages<'a> { #[cfg(test)] mod test { - use crate::{AnyMessage, Extensions, ExtensionsNegotiation, JobDeclaration, Mining}; + use crate::{ + AnyMessage, CommonMessages, Extensions, ExtensionsNegotiation, JobDeclaration, Mining, + ParserError, + }; use alloc::vec; use alloc::vec::Vec; use binary_sv2::{Seq0255, Seq064K, Str0255, Sv2Option, B0255, B032, B064K, U256}; use codec_sv2::{EncodableFrame, MessageFrame}; + use common_messages_sv2::{ + MESSAGE_TYPE_CHANNEL_ENDPOINT_CHANGED, MESSAGE_TYPE_SETUP_CONNECTION_SUCCESS, + }; use core::convert::{TryFrom, TryInto}; use extensions_sv2::{RequestExtensions, EXTENSION_TYPE_EXTENSIONS_NEGOTIATION}; + use framing_sv2::header::Header; use job_declaration_sv2::PushSolution; use mining_sv2::{ NewMiningJob, SetCustomMiningJob, SetCustomMiningJobError, SetCustomMiningJobSuccess, @@ -2864,4 +2889,94 @@ mod test { "Header declared length [{message_length} bytes] differs from the actual payload length [{payload_length} bytes]", ); } + + fn header(extension_type: u16, message_type: u8, payload_length: usize) -> Header { + let ext = extension_type.to_le_bytes(); + let len = (payload_length as u32).to_le_bytes(); + Header::from_bytes(&[ext[0], ext[1], message_type, len[0], len[1], len[2]]).unwrap() + } + + // SetupConnectionSuccess { used_version: 2, flags: 0 } + const SETUP_CONNECTION_SUCCESS: [u8; 6] = [2, 0, 0, 0, 0, 0]; + // ChannelEndpointChanged { channel_id: 1 } + const CHANNEL_ENDPOINT_CHANGED: [u8; 4] = [1, 0, 0, 0]; + const CHANNEL_MSG: u16 = 0x8000; + + #[test] + fn header_decode_accepts_consistent_frames() { + let mut payload = SETUP_CONNECTION_SUCCESS; + let h = header(0, MESSAGE_TYPE_SETUP_CONNECTION_SUCCESS, payload.len()); + assert!(matches!( + AnyMessage::try_from((h, &mut payload[..])), + Ok(AnyMessage::Common(CommonMessages::SetupConnectionSuccess( + _ + ))) + )); + + let mut payload = CHANNEL_ENDPOINT_CHANGED; + let h = header( + CHANNEL_MSG, + MESSAGE_TYPE_CHANNEL_ENDPOINT_CHANGED, + payload.len(), + ); + assert!(matches!( + AnyMessage::try_from((h, &mut payload[..])), + Ok(AnyMessage::Common(CommonMessages::ChannelEndpointChanged( + _ + ))) + )); + } + + #[test] + fn header_decode_rejects_payload_length_mismatch() { + for declared in [0, 5, 7] { + let mut payload = SETUP_CONNECTION_SUCCESS; + let h = header(0, MESSAGE_TYPE_SETUP_CONNECTION_SUCCESS, declared); + assert!(matches!( + AnyMessage::try_from((h, &mut payload[..])), + Err(ParserError::PayloadLengthMismatch { declared: d, actual: 6 }) if d == declared + )); + } + } + + #[test] + fn header_decode_rejects_channel_bit_mismatch() { + let mut payload = SETUP_CONNECTION_SUCCESS; + let h = header( + CHANNEL_MSG, + MESSAGE_TYPE_SETUP_CONNECTION_SUCCESS, + payload.len(), + ); + assert!(matches!( + AnyMessage::try_from((h, &mut payload[..])), + Err(ParserError::ChannelBitMismatch { + channel_msg: true, + .. + }) + )); + + let mut payload = CHANNEL_ENDPOINT_CHANGED; + let h = header(0, MESSAGE_TYPE_CHANNEL_ENDPOINT_CHANGED, payload.len()); + assert!(matches!( + AnyMessage::try_from((h, &mut payload[..])), + Err(ParserError::ChannelBitMismatch { + channel_msg: false, + .. + }) + )); + } + + #[test] + fn frame_with_tlvs_applies_header_checks() { + let mut payload = SETUP_CONNECTION_SUCCESS; + let h = header( + CHANNEL_MSG, + MESSAGE_TYPE_SETUP_CONNECTION_SUCCESS, + payload.len(), + ); + assert!(matches!( + crate::parse_message_frame_with_tlvs(h, &mut payload[..], &[0x0002]), + Err(ParserError::ChannelBitMismatch { .. }) + )); + } } From 0fc5263ea35fbd0f3ffca920cadc284cb590f874 Mon Sep 17 00:00:00 2001 From: bit-aloo Date: Wed, 11 Nov 2026 23:19:30 +0530 Subject: [PATCH 7/8] fix(handlers_sv2): decode every frame through the header-checked parser With no extensions negotiated, the handlers decoded the payload from the message type alone, so a frame under an extension namespace was dispatched as a core message and the header's length and channel bit were never looked at. All entry points now share one decoder that goes through AnyMessage::try_from and only reads the TLV suffix when extensions were negotiated. --- sv2/handlers-sv2/src/common.rs | 50 +----- sv2/handlers-sv2/src/common_owned.rs | 52 +----- sv2/handlers-sv2/src/extensions.rs | 50 +----- sv2/handlers-sv2/src/extensions_owned.rs | 61 +------ sv2/handlers-sv2/src/job_declaration.rs | 50 +----- sv2/handlers-sv2/src/job_declaration_owned.rs | 68 +------- sv2/handlers-sv2/src/lib.rs | 16 ++ sv2/handlers-sv2/src/mining.rs | 50 +----- sv2/handlers-sv2/src/mining_owned.rs | 50 +----- sv2/handlers-sv2/src/template_distribution.rs | 50 +----- .../src/template_distribution_owned.rs | 68 +------- sv2/handlers-sv2/tests/frame_decoding.rs | 160 ++++++++++++++++++ 12 files changed, 266 insertions(+), 459 deletions(-) create mode 100644 sv2/handlers-sv2/tests/frame_decoding.rs diff --git a/sv2/handlers-sv2/src/common.rs b/sv2/handlers-sv2/src/common.rs index e64efd230e..9434e0ec18 100644 --- a/sv2/handlers-sv2/src/common.rs +++ b/sv2/handlers-sv2/src/common.rs @@ -1,6 +1,6 @@ use common_messages_sv2::*; use framing_sv2::header::Header; -use parsers_sv2::{parse_message_frame_with_tlvs, AnyMessage, CommonMessages, Tlv}; +use parsers_sv2::{AnyMessage, CommonMessages, Tlv}; use crate::error::HandlerErrorType; @@ -38,15 +38,8 @@ pub trait HandleCommonMessagesFromServerSync { payload: &mut [u8], ) -> Result<(), Self::Error> { let negotiated_extensions = self.get_negotiated_extensions_with_server(server_id)?; - if negotiated_extensions.is_empty() { - let parsed: CommonMessages<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self.handle_common_message_from_server(server_id, parsed, None); - } - let (message, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (message, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match message { AnyMessage::Common(parsed) => { self.handle_common_message_from_server(server_id, parsed, tlv_fields.as_deref()) @@ -154,17 +147,8 @@ pub trait HandleCommonMessagesFromServerAsync { ) -> Result<(), Self::Error> { async move { let negotiated_extensions = self.get_negotiated_extensions_with_server(server_id)?; - if negotiated_extensions.is_empty() { - let parsed: CommonMessages<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self - .handle_common_message_from_server(server_id, parsed, None) - .await; - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Common(parsed) => { self.handle_common_message_from_server(server_id, parsed, tlv_fields.as_deref()) @@ -280,15 +264,8 @@ pub trait HandleCommonMessagesFromClientSync { payload: &mut [u8], ) -> Result<(), Self::Error> { let negotiated_extensions = self.get_negotiated_extensions_with_client(client_id)?; - if negotiated_extensions.is_empty() { - let parsed: CommonMessages<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self.handle_common_message_from_client(client_id, parsed, None); - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Common(parsed) => { self.handle_common_message_from_client(client_id, parsed, tlv_fields.as_deref()) @@ -379,17 +356,8 @@ pub trait HandleCommonMessagesFromClientAsync { ) -> Result<(), Self::Error> { async move { let negotiated_extensions = self.get_negotiated_extensions_with_client(client_id)?; - if negotiated_extensions.is_empty() { - let parsed: CommonMessages<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self - .handle_common_message_from_client(client_id, parsed, None) - .await; - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Common(parsed) => { self.handle_common_message_from_client(client_id, parsed, tlv_fields.as_deref()) diff --git a/sv2/handlers-sv2/src/common_owned.rs b/sv2/handlers-sv2/src/common_owned.rs index 0fe6a947fb..0203dc2534 100644 --- a/sv2/handlers-sv2/src/common_owned.rs +++ b/sv2/handlers-sv2/src/common_owned.rs @@ -1,8 +1,6 @@ use common_messages_sv2::*; use framing_sv2::header::Header; -use parsers_sv2::{ - parse_message_frame_with_tlvs, AnyMessage, CommonMessages, CommonMessagesOwned, Tlv, -}; +use parsers_sv2::{AnyMessage, CommonMessagesOwned, Tlv}; use crate::error::HandlerErrorType; @@ -40,15 +38,8 @@ pub trait HandleCommonMessagesFromServerOwnedSync { payload: &mut [u8], ) -> Result<(), Self::Error> { let negotiated_extensions = self.get_negotiated_extensions_with_server(server_id)?; - if negotiated_extensions.is_empty() { - let parsed: CommonMessages<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self.handle_common_message_from_server(server_id, parsed.into_owned(), None); - } - let (message, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (message, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match message { AnyMessage::Common(parsed) => self.handle_common_message_from_server( server_id, @@ -160,17 +151,8 @@ pub trait HandleCommonMessagesFromServerOwnedAsync { ) -> Result<(), Self::Error> { async move { let negotiated_extensions = self.get_negotiated_extensions_with_server(server_id)?; - if negotiated_extensions.is_empty() { - let parsed: CommonMessages<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self - .handle_common_message_from_server(server_id, parsed.into_owned(), None) - .await; - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Common(parsed) => { self.handle_common_message_from_server( @@ -290,15 +272,8 @@ pub trait HandleCommonMessagesFromClientOwnedSync { payload: &mut [u8], ) -> Result<(), Self::Error> { let negotiated_extensions = self.get_negotiated_extensions_with_client(client_id)?; - if negotiated_extensions.is_empty() { - let parsed: CommonMessages<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self.handle_common_message_from_client(client_id, parsed.into_owned(), None); - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Common(parsed) => self.handle_common_message_from_client( client_id, @@ -391,17 +366,8 @@ pub trait HandleCommonMessagesFromClientOwnedAsync { ) -> Result<(), Self::Error> { async move { let negotiated_extensions = self.get_negotiated_extensions_with_client(client_id)?; - if negotiated_extensions.is_empty() { - let parsed: CommonMessages<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self - .handle_common_message_from_client(client_id, parsed.into_owned(), None) - .await; - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Common(parsed) => { self.handle_common_message_from_client( diff --git a/sv2/handlers-sv2/src/extensions.rs b/sv2/handlers-sv2/src/extensions.rs index e8a51921fd..0b62d70640 100644 --- a/sv2/handlers-sv2/src/extensions.rs +++ b/sv2/handlers-sv2/src/extensions.rs @@ -1,6 +1,6 @@ use extensions_sv2::{RequestExtensions, RequestExtensionsError, RequestExtensionsSuccess}; use framing_sv2::header::Header; -use parsers_sv2::{parse_message_frame_with_tlvs, AnyMessage, Extensions, Tlv}; +use parsers_sv2::{AnyMessage, Extensions, Tlv}; use crate::error::HandlerErrorType; @@ -38,15 +38,8 @@ pub trait HandleExtensionsFromServerSync { payload: &mut [u8], ) -> Result<(), Self::Error> { let negotiated_extensions = self.get_negotiated_extensions_with_server(server_id)?; - if negotiated_extensions.is_empty() { - let parsed: Extensions<'_> = (header.ext_type(), header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self.handle_extensions_message_from_server(server_id, parsed, None); - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Extensions(parsed) => { self.handle_extensions_message_from_server(server_id, parsed, tlv_fields.as_deref()) @@ -140,17 +133,8 @@ pub trait HandleExtensionsFromServerAsync { ) -> Result<(), Self::Error> { async move { let negotiated_extensions = self.get_negotiated_extensions_with_server(server_id)?; - if negotiated_extensions.is_empty() { - let parsed: Extensions<'_> = (header.ext_type(), header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self - .handle_extensions_message_from_server(server_id, parsed, None) - .await; - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Extensions(parsed) => { self.handle_extensions_message_from_server( @@ -252,15 +236,8 @@ pub trait HandleExtensionsFromClientSync { payload: &mut [u8], ) -> Result<(), Self::Error> { let negotiated_extensions = self.get_negotiated_extensions_with_client(client_id)?; - if negotiated_extensions.is_empty() { - let parsed: Extensions<'_> = (header.ext_type(), header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self.handle_extensions_message_from_client(client_id, parsed, None); - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Extensions(parsed) => { self.handle_extensions_message_from_client(client_id, parsed, tlv_fields.as_deref()) @@ -350,17 +327,8 @@ pub trait HandleExtensionsFromClientAsync { ) -> Result<(), Self::Error> { async move { let negotiated_extensions = self.get_negotiated_extensions_with_client(client_id)?; - if negotiated_extensions.is_empty() { - let parsed: Extensions<'_> = (header.ext_type(), header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self - .handle_extensions_message_from_client(client_id, parsed, None) - .await; - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Extensions(parsed) => { self.handle_extensions_message_from_client( diff --git a/sv2/handlers-sv2/src/extensions_owned.rs b/sv2/handlers-sv2/src/extensions_owned.rs index 4c236142fd..b8bb7983ed 100644 --- a/sv2/handlers-sv2/src/extensions_owned.rs +++ b/sv2/handlers-sv2/src/extensions_owned.rs @@ -2,10 +2,7 @@ use extensions_sv2::{ RequestExtensionsErrorOwned, RequestExtensionsOwned, RequestExtensionsSuccessOwned, }; use framing_sv2::header::Header; -use parsers_sv2::{ - parse_message_frame_with_tlvs, AnyMessage, Extensions, ExtensionsNegotiationOwned, - ExtensionsOwned, Tlv, -}; +use parsers_sv2::{AnyMessage, ExtensionsNegotiationOwned, ExtensionsOwned, Tlv}; use crate::error::HandlerErrorType; @@ -43,19 +40,8 @@ pub trait HandleExtensionsFromServerOwnedSync { payload: &mut [u8], ) -> Result<(), Self::Error> { let negotiated_extensions = self.get_negotiated_extensions_with_server(server_id)?; - if negotiated_extensions.is_empty() { - let parsed: Extensions<'_> = (header.ext_type(), header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self.handle_extensions_message_from_server( - server_id, - parsed.into_owned(), - None, - ); - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Extensions(parsed) => self.handle_extensions_message_from_server( server_id, @@ -151,17 +137,8 @@ pub trait HandleExtensionsFromServerOwnedAsync { ) -> Result<(), Self::Error> { async move { let negotiated_extensions = self.get_negotiated_extensions_with_server(server_id)?; - if negotiated_extensions.is_empty() { - let parsed: Extensions<'_> = (header.ext_type(), header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self - .handle_extensions_message_from_server(server_id, parsed.into_owned(), None) - .await; - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Extensions(parsed) => { self.handle_extensions_message_from_server( @@ -263,19 +240,8 @@ pub trait HandleExtensionsFromClientOwnedSync { payload: &mut [u8], ) -> Result<(), Self::Error> { let negotiated_extensions = self.get_negotiated_extensions_with_client(client_id)?; - if negotiated_extensions.is_empty() { - let parsed: Extensions<'_> = (header.ext_type(), header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self.handle_extensions_message_from_client( - client_id, - parsed.into_owned(), - None, - ); - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Extensions(parsed) => self.handle_extensions_message_from_client( client_id, @@ -367,17 +333,8 @@ pub trait HandleExtensionsFromClientOwnedAsync { ) -> Result<(), Self::Error> { async move { let negotiated_extensions = self.get_negotiated_extensions_with_client(client_id)?; - if negotiated_extensions.is_empty() { - let parsed: Extensions<'_> = (header.ext_type(), header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self - .handle_extensions_message_from_client(client_id, parsed.into_owned(), None) - .await; - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Extensions(parsed) => { self.handle_extensions_message_from_client( diff --git a/sv2/handlers-sv2/src/job_declaration.rs b/sv2/handlers-sv2/src/job_declaration.rs index c4315a5041..a51188aa1f 100644 --- a/sv2/handlers-sv2/src/job_declaration.rs +++ b/sv2/handlers-sv2/src/job_declaration.rs @@ -1,6 +1,6 @@ use framing_sv2::header::Header; use job_declaration_sv2::*; -use parsers_sv2::{parse_message_frame_with_tlvs, AnyMessage, JobDeclaration, Tlv}; +use parsers_sv2::{AnyMessage, JobDeclaration, Tlv}; use crate::error::HandlerErrorType; @@ -38,15 +38,8 @@ pub trait HandleJobDeclarationMessagesFromServerSync { payload: &mut [u8], ) -> Result<(), Self::Error> { let negotiated_extensions = self.get_negotiated_extensions_with_server(server_id)?; - if negotiated_extensions.is_empty() { - let parsed: JobDeclaration<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self.handle_job_declaration_message_from_server(server_id, parsed, None); - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::JobDeclaration(parsed) => self.handle_job_declaration_message_from_server( server_id, @@ -171,17 +164,8 @@ pub trait HandleJobDeclarationMessagesFromServerAsync { ) -> Result<(), Self::Error> { async move { let negotiated_extensions = self.get_negotiated_extensions_with_server(server_id)?; - if negotiated_extensions.is_empty() { - let parsed: JobDeclaration<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self - .handle_job_declaration_message_from_server(server_id, parsed, None) - .await; - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::JobDeclaration(parsed) => { self.handle_job_declaration_message_from_server( @@ -314,15 +298,8 @@ pub trait HandleJobDeclarationMessagesFromClientSync { payload: &mut [u8], ) -> Result<(), Self::Error> { let negotiated_extensions = self.get_negotiated_extensions_with_client(client_id)?; - if negotiated_extensions.is_empty() { - let parsed: JobDeclaration<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self.handle_job_declaration_message_from_client(client_id, parsed, None); - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::JobDeclaration(parsed) => self.handle_job_declaration_message_from_client( client_id, @@ -445,17 +422,8 @@ pub trait HandleJobDeclarationMessagesFromClientAsync { ) -> Result<(), Self::Error> { async move { let negotiated_extensions = self.get_negotiated_extensions_with_client(client_id)?; - if negotiated_extensions.is_empty() { - let parsed: JobDeclaration<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self - .handle_job_declaration_message_from_client(client_id, parsed, None) - .await; - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::JobDeclaration(parsed) => { self.handle_job_declaration_message_from_client( diff --git a/sv2/handlers-sv2/src/job_declaration_owned.rs b/sv2/handlers-sv2/src/job_declaration_owned.rs index f819d9df80..d71d8952a1 100644 --- a/sv2/handlers-sv2/src/job_declaration_owned.rs +++ b/sv2/handlers-sv2/src/job_declaration_owned.rs @@ -1,8 +1,6 @@ use framing_sv2::header::Header; use job_declaration_sv2::*; -use parsers_sv2::{ - parse_message_frame_with_tlvs, AnyMessage, JobDeclaration, JobDeclarationOwned, Tlv, -}; +use parsers_sv2::{AnyMessage, JobDeclarationOwned, Tlv}; use crate::error::HandlerErrorType; @@ -40,19 +38,8 @@ pub trait HandleJobDeclarationMessagesFromServerOwnedSync { payload: &mut [u8], ) -> Result<(), Self::Error> { let negotiated_extensions = self.get_negotiated_extensions_with_server(server_id)?; - if negotiated_extensions.is_empty() { - let parsed: JobDeclaration<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self.handle_job_declaration_message_from_server( - server_id, - parsed.into_owned(), - None, - ); - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::JobDeclaration(parsed) => self.handle_job_declaration_message_from_server( server_id, @@ -177,21 +164,8 @@ pub trait HandleJobDeclarationMessagesFromServerOwnedAsync { ) -> Result<(), Self::Error> { async move { let negotiated_extensions = self.get_negotiated_extensions_with_server(server_id)?; - if negotiated_extensions.is_empty() { - let parsed: JobDeclaration<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self - .handle_job_declaration_message_from_server( - server_id, - parsed.into_owned(), - None, - ) - .await; - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::JobDeclaration(parsed) => { self.handle_job_declaration_message_from_server( @@ -323,19 +297,8 @@ pub trait HandleJobDeclarationMessagesFromClientOwnedSync { payload: &mut [u8], ) -> Result<(), Self::Error> { let negotiated_extensions = self.get_negotiated_extensions_with_client(client_id)?; - if negotiated_extensions.is_empty() { - let parsed: JobDeclaration<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self.handle_job_declaration_message_from_client( - client_id, - parsed.into_owned(), - None, - ); - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::JobDeclaration(parsed) => self.handle_job_declaration_message_from_client( client_id, @@ -456,21 +419,8 @@ pub trait HandleJobDeclarationMessagesFromClientOwnedAsync { ) -> Result<(), Self::Error> { async move { let negotiated_extensions = self.get_negotiated_extensions_with_client(client_id)?; - if negotiated_extensions.is_empty() { - let parsed: JobDeclaration<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self - .handle_job_declaration_message_from_client( - client_id, - parsed.into_owned(), - None, - ) - .await; - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::JobDeclaration(parsed) => { self.handle_job_declaration_message_from_client( diff --git a/sv2/handlers-sv2/src/lib.rs b/sv2/handlers-sv2/src/lib.rs index e05659a9c6..8eddd990df 100644 --- a/sv2/handlers-sv2/src/lib.rs +++ b/sv2/handlers-sv2/src/lib.rs @@ -12,6 +12,22 @@ mod template_distribution_owned; pub use error::HandlerErrorType; +use framing_sv2::header::Header; +use parsers_sv2::{parse_message_frame_with_tlvs, AnyMessage, ParserError, Tlv}; + +/// Decodes a frame through the header-checked `AnyMessage` parser, reading the TLV suffix only +/// when extensions were negotiated. +fn decode_frame<'a>( + header: Header, + payload: &'a mut [u8], + negotiated_extensions: &[u16], +) -> Result<(AnyMessage<'a>, Option>), ParserError> { + if negotiated_extensions.is_empty() { + return Ok((AnyMessage::try_from((header, payload))?, None)); + } + parse_message_frame_with_tlvs(header, payload, negotiated_extensions) +} + pub use common::{ HandleCommonMessagesFromClientAsync, HandleCommonMessagesFromClientSync, HandleCommonMessagesFromServerAsync, HandleCommonMessagesFromServerSync, diff --git a/sv2/handlers-sv2/src/mining.rs b/sv2/handlers-sv2/src/mining.rs index 3b89b0d246..4c1beff261 100644 --- a/sv2/handlers-sv2/src/mining.rs +++ b/sv2/handlers-sv2/src/mining.rs @@ -1,7 +1,7 @@ use crate::error::HandlerErrorType; use framing_sv2::header::Header; use mining_sv2::*; -use parsers_sv2::{parse_message_frame_with_tlvs, AnyMessage, Mining, Tlv}; +use parsers_sv2::{AnyMessage, Mining, Tlv}; /// Synchronous handler trait for processing mining messages received from servers. /// @@ -37,15 +37,8 @@ pub trait HandleMiningMessagesFromServerSync { payload: &mut [u8], ) -> Result<(), Self::Error> { let negotiated_extensions = self.get_negotiated_extensions_with_server(server_id)?; - if negotiated_extensions.is_empty() { - let parsed: Mining<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self.handle_mining_message_from_server(server_id, parsed, None); - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Mining(parsed) => { self.handle_mining_message_from_server(server_id, parsed, tlv_fields.as_deref()) @@ -283,17 +276,8 @@ pub trait HandleMiningMessagesFromServerAsync { ) -> Result<(), Self::Error> { async move { let negotiated_extensions = self.get_negotiated_extensions_with_server(server_id)?; - if negotiated_extensions.is_empty() { - let parsed: Mining<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self - .handle_mining_message_from_server(server_id, parsed, None) - .await; - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Mining(parsed) => { self.handle_mining_message_from_server(server_id, parsed, tlv_fields.as_deref()) @@ -556,15 +540,8 @@ pub trait HandleMiningMessagesFromClientSync { payload: &mut [u8], ) -> Result<(), Self::Error> { let negotiated_extensions = self.get_negotiated_extensions_with_client(client_id)?; - if negotiated_extensions.is_empty() { - let parsed: Mining<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self.handle_mining_message_from_client(client_id, parsed, None); - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Mining(parsed) => { self.handle_mining_message_from_client(client_id, parsed, tlv_fields.as_deref()) @@ -753,17 +730,8 @@ pub trait HandleMiningMessagesFromClientAsync { ) -> Result<(), Self::Error> { async move { let negotiated_extensions = self.get_negotiated_extensions_with_client(client_id)?; - if negotiated_extensions.is_empty() { - let parsed: Mining<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self - .handle_mining_message_from_client(client_id, parsed, None) - .await; - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Mining(parsed) => { self.handle_mining_message_from_client(client_id, parsed, tlv_fields.as_deref()) diff --git a/sv2/handlers-sv2/src/mining_owned.rs b/sv2/handlers-sv2/src/mining_owned.rs index 425bdb1e79..460e22ff84 100644 --- a/sv2/handlers-sv2/src/mining_owned.rs +++ b/sv2/handlers-sv2/src/mining_owned.rs @@ -1,6 +1,6 @@ use crate::error::HandlerErrorType; use framing_sv2::header::Header; -use parsers_sv2::{parse_message_frame_with_tlvs, AnyMessage, Mining, MiningOwned, Tlv}; +use parsers_sv2::{AnyMessage, MiningOwned, Tlv}; use mining_sv2::*; @@ -38,15 +38,8 @@ pub trait HandleMiningMessagesFromServerOwnedSync { payload: &mut [u8], ) -> Result<(), Self::Error> { let negotiated_extensions = self.get_negotiated_extensions_with_server(server_id)?; - if negotiated_extensions.is_empty() { - let parsed: Mining<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self.handle_mining_message_from_server(server_id, parsed.into_owned(), None); - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Mining(parsed) => self.handle_mining_message_from_server( server_id, @@ -286,17 +279,8 @@ pub trait HandleMiningMessagesFromServerOwnedAsync { ) -> Result<(), Self::Error> { async move { let negotiated_extensions = self.get_negotiated_extensions_with_server(server_id)?; - if negotiated_extensions.is_empty() { - let parsed: Mining<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self - .handle_mining_message_from_server(server_id, parsed.into_owned(), None) - .await; - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Mining(parsed) => { self.handle_mining_message_from_server( @@ -563,15 +547,8 @@ pub trait HandleMiningMessagesFromClientOwnedSync { payload: &mut [u8], ) -> Result<(), Self::Error> { let negotiated_extensions = self.get_negotiated_extensions_with_client(client_id)?; - if negotiated_extensions.is_empty() { - let parsed: Mining<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self.handle_mining_message_from_client(client_id, parsed.into_owned(), None); - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Mining(parsed) => self.handle_mining_message_from_client( client_id, @@ -762,17 +739,8 @@ pub trait HandleMiningMessagesFromClientOwnedAsync { ) -> Result<(), Self::Error> { async move { let negotiated_extensions = self.get_negotiated_extensions_with_client(client_id)?; - if negotiated_extensions.is_empty() { - let parsed: Mining<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self - .handle_mining_message_from_client(client_id, parsed.into_owned(), None) - .await; - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::Mining(parsed) => { self.handle_mining_message_from_client( diff --git a/sv2/handlers-sv2/src/template_distribution.rs b/sv2/handlers-sv2/src/template_distribution.rs index 4476a7157a..961d033ff7 100644 --- a/sv2/handlers-sv2/src/template_distribution.rs +++ b/sv2/handlers-sv2/src/template_distribution.rs @@ -1,5 +1,5 @@ use framing_sv2::header::Header; -use parsers_sv2::{parse_message_frame_with_tlvs, AnyMessage, TemplateDistribution, Tlv}; +use parsers_sv2::{AnyMessage, TemplateDistribution, Tlv}; use template_distribution_sv2::*; use template_distribution_sv2::{ CoinbaseOutputConstraints, NewTemplate, RequestTransactionData, RequestTransactionDataError, @@ -42,15 +42,8 @@ pub trait HandleTemplateDistributionMessagesFromServerSync { payload: &mut [u8], ) -> Result<(), Self::Error> { let negotiated_extensions = self.get_negotiated_extensions_with_server(server_id)?; - if negotiated_extensions.is_empty() { - let parsed: TemplateDistribution<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self.handle_template_distribution_message_from_server(server_id, parsed, None); - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::TemplateDistribution(parsed) => self .handle_template_distribution_message_from_server( @@ -168,17 +161,8 @@ pub trait HandleTemplateDistributionMessagesFromServerAsync { ) -> Result<(), Self::Error> { async move { let negotiated_extensions = self.get_negotiated_extensions_with_server(server_id)?; - if negotiated_extensions.is_empty() { - let parsed: TemplateDistribution<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self - .handle_template_distribution_message_from_server(server_id, parsed, None) - .await; - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::TemplateDistribution(parsed) => { self.handle_template_distribution_message_from_server( @@ -302,15 +286,8 @@ pub trait HandleTemplateDistributionMessagesFromClientSync { payload: &mut [u8], ) -> Result<(), Self::Error> { let negotiated_extensions = self.get_negotiated_extensions_with_client(client_id)?; - if negotiated_extensions.is_empty() { - let parsed: TemplateDistribution<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self.handle_template_distribution_message_from_client(client_id, parsed, None); - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::TemplateDistribution(parsed) => self .handle_template_distribution_message_from_client( @@ -422,17 +399,8 @@ pub trait HandleTemplateDistributionMessagesFromClientAsync { ) -> Result<(), Self::Error> { async move { let negotiated_extensions = self.get_negotiated_extensions_with_client(client_id)?; - if negotiated_extensions.is_empty() { - let parsed: TemplateDistribution<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self - .handle_template_distribution_message_from_client(client_id, parsed, None) - .await; - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::TemplateDistribution(parsed) => { self.handle_template_distribution_message_from_client( diff --git a/sv2/handlers-sv2/src/template_distribution_owned.rs b/sv2/handlers-sv2/src/template_distribution_owned.rs index e21c2a8ade..138fcdc152 100644 --- a/sv2/handlers-sv2/src/template_distribution_owned.rs +++ b/sv2/handlers-sv2/src/template_distribution_owned.rs @@ -1,7 +1,5 @@ use framing_sv2::header::Header; -use parsers_sv2::{ - parse_message_frame_with_tlvs, AnyMessage, TemplateDistribution, TemplateDistributionOwned, Tlv, -}; +use parsers_sv2::{AnyMessage, TemplateDistributionOwned, Tlv}; use template_distribution_sv2::*; use crate::error::HandlerErrorType; @@ -40,19 +38,8 @@ pub trait HandleTemplateDistributionMessagesFromServerOwnedSync { payload: &mut [u8], ) -> Result<(), Self::Error> { let negotiated_extensions = self.get_negotiated_extensions_with_server(server_id)?; - if negotiated_extensions.is_empty() { - let parsed: TemplateDistribution<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self.handle_template_distribution_message_from_server( - server_id, - parsed.into_owned(), - None, - ); - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::TemplateDistribution(parsed) => self .handle_template_distribution_message_from_server( @@ -170,21 +157,8 @@ pub trait HandleTemplateDistributionMessagesFromServerOwnedAsync { ) -> Result<(), Self::Error> { async move { let negotiated_extensions = self.get_negotiated_extensions_with_server(server_id)?; - if negotiated_extensions.is_empty() { - let parsed: TemplateDistribution<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self - .handle_template_distribution_message_from_server( - server_id, - parsed.into_owned(), - None, - ) - .await; - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::TemplateDistribution(parsed) => { self.handle_template_distribution_message_from_server( @@ -307,19 +281,8 @@ pub trait HandleTemplateDistributionMessagesFromClientOwnedSync { payload: &mut [u8], ) -> Result<(), Self::Error> { let negotiated_extensions = self.get_negotiated_extensions_with_client(client_id)?; - if negotiated_extensions.is_empty() { - let parsed: TemplateDistribution<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self.handle_template_distribution_message_from_client( - client_id, - parsed.into_owned(), - None, - ); - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::TemplateDistribution(parsed) => self .handle_template_distribution_message_from_client( @@ -431,21 +394,8 @@ pub trait HandleTemplateDistributionMessagesFromClientOwnedAsync { ) -> Result<(), Self::Error> { async move { let negotiated_extensions = self.get_negotiated_extensions_with_client(client_id)?; - if negotiated_extensions.is_empty() { - let parsed: TemplateDistribution<'_> = (header.msg_type(), payload) - .try_into() - .map_err(Self::Error::parse_error)?; - return self - .handle_template_distribution_message_from_client( - client_id, - parsed.into_owned(), - None, - ) - .await; - } - let (parsed, tlv_fields) = - parse_message_frame_with_tlvs(header, payload, &negotiated_extensions) - .map_err(Self::Error::parse_error)?; + let (parsed, tlv_fields) = crate::decode_frame(header, payload, &negotiated_extensions) + .map_err(Self::Error::parse_error)?; match parsed { AnyMessage::TemplateDistribution(parsed) => { self.handle_template_distribution_message_from_client( diff --git a/sv2/handlers-sv2/tests/frame_decoding.rs b/sv2/handlers-sv2/tests/frame_decoding.rs new file mode 100644 index 0000000000..c2bfe546c7 --- /dev/null +++ b/sv2/handlers-sv2/tests/frame_decoding.rs @@ -0,0 +1,160 @@ +use common_messages_sv2::{ + ChannelEndpointChanged, Reconnect, SetupConnectionError, SetupConnectionSuccess, + MESSAGE_TYPE_CHANNEL_ENDPOINT_CHANGED, MESSAGE_TYPE_SETUP_CONNECTION_SUCCESS, +}; +use framing_sv2::header::Header; +use handlers_sv2::{HandleCommonMessagesFromServerSync, HandlerErrorType}; +use parsers_sv2::{ParserError, Tlv}; + +#[derive(Debug)] +enum Error { + Unexpected, + Parse(ParserError), +} + +impl HandlerErrorType for Error { + fn unexpected_message(_extension_type: u16, _message_type: u8) -> Self { + Error::Unexpected + } + fn parse_error(error: ParserError) -> Self { + Error::Parse(error) + } +} + +struct Client { + negotiated_extensions: Vec, + dispatched: Vec, +} + +impl HandleCommonMessagesFromServerSync for Client { + type Error = Error; + + fn get_negotiated_extensions_with_server( + &self, + _server_id: Option, + ) -> Result, Error> { + Ok(self.negotiated_extensions.clone()) + } + + fn handle_setup_connection_success( + &mut self, + _server_id: Option, + _msg: SetupConnectionSuccess, + _tlv_fields: Option<&[Tlv]>, + ) -> Result<(), Error> { + self.dispatched.push(MESSAGE_TYPE_SETUP_CONNECTION_SUCCESS); + Ok(()) + } + + fn handle_setup_connection_error( + &mut self, + _server_id: Option, + _msg: SetupConnectionError, + _tlv_fields: Option<&[Tlv]>, + ) -> Result<(), Error> { + unreachable!() + } + + fn handle_channel_endpoint_changed( + &mut self, + _server_id: Option, + _msg: ChannelEndpointChanged, + _tlv_fields: Option<&[Tlv]>, + ) -> Result<(), Error> { + self.dispatched.push(MESSAGE_TYPE_CHANNEL_ENDPOINT_CHANGED); + Ok(()) + } + + fn handle_reconnect( + &mut self, + _server_id: Option, + _msg: Reconnect, + _tlv_fields: Option<&[Tlv]>, + ) -> Result<(), Error> { + unreachable!() + } +} + +const CHANNEL_MSG: u16 = 0x8000; +// SetupConnectionSuccess { used_version: 2, flags: 0 } +const SETUP_CONNECTION_SUCCESS: [u8; 6] = [2, 0, 0, 0, 0, 0]; +// ChannelEndpointChanged { channel_id: 1 } +const CHANNEL_ENDPOINT_CHANGED: [u8; 4] = [1, 0, 0, 0]; + +fn header(extension_type: u16, message_type: u8, payload_length: usize) -> Header { + let ext = extension_type.to_le_bytes(); + let len = (payload_length as u32).to_le_bytes(); + Header::from_bytes(&[ext[0], ext[1], message_type, len[0], len[1], len[2]]).unwrap() +} + +/// Feeds one frame to a client, once with no extensions negotiated and once with one, and checks +/// that both decode paths give the same verdict. +fn dispatch(header: Header, payload: &[u8]) -> Result, Error> { + let mut verdicts = Vec::new(); + for negotiated_extensions in [vec![], vec![0x0002]] { + let mut client = Client { + negotiated_extensions, + dispatched: Vec::new(), + }; + let mut payload = payload.to_vec(); + verdicts.push( + client + .handle_common_message_frame_from_server(None, header, &mut payload) + .map(|()| client.dispatched), + ); + } + let with_extensions = verdicts.pop().unwrap(); + let without_extensions = verdicts.pop().unwrap(); + assert_eq!( + format!("{without_extensions:?}"), + format!("{with_extensions:?}") + ); + without_extensions +} + +#[test] +fn dispatches_consistent_frames() { + let h = header(0, MESSAGE_TYPE_SETUP_CONNECTION_SUCCESS, 6); + assert_eq!( + dispatch(h, &SETUP_CONNECTION_SUCCESS).unwrap(), + [MESSAGE_TYPE_SETUP_CONNECTION_SUCCESS] + ); + + let h = header(CHANNEL_MSG, MESSAGE_TYPE_CHANNEL_ENDPOINT_CHANGED, 4); + assert_eq!( + dispatch(h, &CHANNEL_ENDPOINT_CHANGED).unwrap(), + [MESSAGE_TYPE_CHANNEL_ENDPOINT_CHANGED] + ); +} + +#[test] +fn rejects_core_message_type_under_extension_namespace() { + let h = header(0x0002, MESSAGE_TYPE_SETUP_CONNECTION_SUCCESS, 6); + assert!(dispatch(h, &SETUP_CONNECTION_SUCCESS).is_err()); +} + +#[test] +fn rejects_channel_bit_mismatch() { + let h = header(CHANNEL_MSG, MESSAGE_TYPE_SETUP_CONNECTION_SUCCESS, 6); + assert!(matches!( + dispatch(h, &SETUP_CONNECTION_SUCCESS), + Err(Error::Parse(ParserError::ChannelBitMismatch { .. })) + )); + + let h = header(0, MESSAGE_TYPE_CHANNEL_ENDPOINT_CHANGED, 4); + assert!(matches!( + dispatch(h, &CHANNEL_ENDPOINT_CHANGED), + Err(Error::Parse(ParserError::ChannelBitMismatch { .. })) + )); +} + +#[test] +fn rejects_payload_length_mismatch() { + for declared in [0, 5, 7] { + let h = header(0, MESSAGE_TYPE_SETUP_CONNECTION_SUCCESS, declared); + assert!(matches!( + dispatch(h, &SETUP_CONNECTION_SUCCESS), + Err(Error::Parse(ParserError::PayloadLengthMismatch { .. })) + )); + } +} From f425aecf6d32f5048a0dcb302ffd7e056fb4b38c Mon Sep 17 00:00:00 2001 From: bit-aloo Date: Wed, 11 Nov 2026 23:19:31 +0530 Subject: [PATCH 8/8] chore: bump parsers_sv2, handlers_sv2, mining_sv2 and stratum-core parsers_sv2, handlers_sv2 and stratum-core break their public API; mining_sv2 only changes a doc comment. --- Cargo.lock | 8 ++++---- stratum-core/Cargo.toml | 6 +++--- sv2/handlers-sv2/Cargo.toml | 4 ++-- sv2/parsers-sv2/Cargo.toml | 2 +- sv2/subprotocols/mining/Cargo.toml | 2 +- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 166783e88e..5db065ea5c 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -545,7 +545,7 @@ checksum = "1b43ede17f21864e81be2fa654110bf1e793774238d86ef8555c37e6519c0403" [[package]] name = "handlers_sv2" -version = "0.7.0" +version = "0.8.0" dependencies = [ "common_messages_sv2", "extensions_sv2", @@ -726,7 +726,7 @@ checksum = "f8ca58f447f06ed17d5fc4043ce1b10dd205e060fb3ce5b979b8ed8e59ff3f79" [[package]] name = "mining_sv2" -version = "13.0.0" +version = "13.0.1" dependencies = [ "binary_sv2", "quickcheck", @@ -804,7 +804,7 @@ dependencies = [ [[package]] name = "parsers_sv2" -version = "0.7.0" +version = "0.8.0" dependencies = [ "binary_sv2", "codec_sv2", @@ -1161,7 +1161,7 @@ checksum = "a2eb9349b6444b326872e140eb1cf5e7c522154d69e7a0ffb0fb81c06b37543f" [[package]] name = "stratum-core" -version = "0.7.0" +version = "0.8.0" dependencies = [ "binary_sv2", "bitcoin", diff --git a/stratum-core/Cargo.toml b/stratum-core/Cargo.toml index a04da46d3b..34c26eef26 100644 --- a/stratum-core/Cargo.toml +++ b/stratum-core/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "stratum-core" -version = "0.7.0" +version = "0.8.0" authors = ["The Stratum V2 Developers"] edition = "2021" readme = "README.md" @@ -18,8 +18,8 @@ codec_sv2 = { path = "../sv2/codec-sv2", version = "^8.0.0", features = ["noise_ extensions_sv2 = { path = "../sv2/extensions-sv2", version = "^0.4.0" } framing_sv2 = { path = "../sv2/framing-sv2", version = "^9.0.0" } noise_sv2 = { path = "../sv2/noise-sv2", version = "^2.1.0" } -parsers_sv2 = { path = "../sv2/parsers-sv2", version = "^0.7.0" } -handlers_sv2 = { path = "../sv2/handlers-sv2", version = "^0.7.0" } +parsers_sv2 = { path = "../sv2/parsers-sv2", version = "^0.8.0" } +handlers_sv2 = { path = "../sv2/handlers-sv2", version = "^0.8.0" } channels_sv2 = { path = "../sv2/channels-sv2", version = "^9.0.0" } common_messages_sv2 = { path = "../sv2/subprotocols/common-messages", version = "^10.0.0" } mining_sv2 = { path = "../sv2/subprotocols/mining", version = "^13.0.0" } diff --git a/sv2/handlers-sv2/Cargo.toml b/sv2/handlers-sv2/Cargo.toml index 43762ba99a..4dc83a1b6c 100644 --- a/sv2/handlers-sv2/Cargo.toml +++ b/sv2/handlers-sv2/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "handlers_sv2" -version = "0.7.0" +version = "0.8.0" authors = ["The Stratum V2 Developers"] edition = "2021" readme = "README.md" @@ -12,7 +12,7 @@ homepage = "https://stratumprotocol.org" keywords = ["stratum", "mining", "bitcoin", "protocol"] [dependencies] -parsers_sv2 = { path = "../parsers-sv2", version = "^0.7.0"} +parsers_sv2 = { path = "../parsers-sv2", version = "^0.8.0"} common_messages_sv2 = { path = "../subprotocols/common-messages", version = "^10.0.0" } framing_sv2 = { path = "../framing-sv2", version = "^9.0.0" } mining_sv2 = { path = "../subprotocols/mining", version = "^13.0.0" } diff --git a/sv2/parsers-sv2/Cargo.toml b/sv2/parsers-sv2/Cargo.toml index f3b15fafd3..dde173d644 100644 --- a/sv2/parsers-sv2/Cargo.toml +++ b/sv2/parsers-sv2/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "parsers_sv2" -version = "0.7.0" +version = "0.8.0" authors = ["The Stratum V2 Developers"] edition = "2021" readme = "README.md" diff --git a/sv2/subprotocols/mining/Cargo.toml b/sv2/subprotocols/mining/Cargo.toml index c964c02d99..c90fc87f32 100644 --- a/sv2/subprotocols/mining/Cargo.toml +++ b/sv2/subprotocols/mining/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "mining_sv2" -version = "13.0.0" +version = "13.0.1" authors = ["The Stratum V2 Developers"] edition = "2021" readme = "README.md"