diff --git a/Cargo.lock b/Cargo.lock index 58a34da8dd..5db065ea5c 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -545,9 +545,8 @@ checksum = "1b43ede17f21864e81be2fa654110bf1e793774238d86ef8555c37e6519c0403" [[package]] name = "handlers_sv2" -version = "0.7.0" +version = "0.8.0" dependencies = [ - "binary_sv2", "common_messages_sv2", "extensions_sv2", "framing_sv2", @@ -727,7 +726,7 @@ checksum = "f8ca58f447f06ed17d5fc4043ce1b10dd205e060fb3ce5b979b8ed8e59ff3f79" [[package]] name = "mining_sv2" -version = "13.0.0" +version = "13.0.1" dependencies = [ "binary_sv2", "quickcheck", @@ -805,7 +804,7 @@ dependencies = [ [[package]] name = "parsers_sv2" -version = "0.7.0" +version = "0.8.0" dependencies = [ "binary_sv2", "codec_sv2", @@ -1162,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 a444933d2c..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,8 +12,7 @@ homepage = "https://stratumprotocol.org" keywords = ["stratum", "mining", "bitcoin", "protocol"] [dependencies] -parsers_sv2 = { path = "../parsers-sv2", version = "^0.7.0"} -binary_sv2 = { path = "../binary-sv2", version = "^8.0.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/handlers-sv2/src/common.rs b/sv2/handlers-sv2/src/common.rs index 958aa99458..9434e0ec18 100644 --- a/sv2/handlers-sv2/src/common.rs +++ b/sv2/handlers-sv2/src/common.rs @@ -1,8 +1,6 @@ -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}; +use parsers_sv2::{AnyMessage, CommonMessages, Tlv}; use crate::error::HandlerErrorType; @@ -15,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 HandleCommonMessagesFromServerSync { @@ -40,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()) @@ -129,7 +120,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)] @@ -156,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()) @@ -257,7 +239,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 { @@ -282,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()) @@ -354,7 +329,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)] @@ -381,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 759702c5f3..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; @@ -15,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 HandleCommonMessagesFromServerOwnedSync { @@ -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, @@ -133,7 +124,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)] @@ -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( @@ -265,7 +247,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 { @@ -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, @@ -364,7 +339,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)] @@ -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 cb18803b7c..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; @@ -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 { @@ -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()) @@ -113,7 +106,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)] @@ -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( @@ -227,7 +211,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 { @@ -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()) @@ -323,7 +300,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)] @@ -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 b7a776c215..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; @@ -18,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 HandleExtensionsFromServerOwnedSync { @@ -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, @@ -124,7 +110,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)] @@ -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( @@ -238,7 +215,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 { @@ -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, @@ -340,7 +306,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)] @@ -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 3f2b70bc33..a51188aa1f 100644 --- a/sv2/handlers-sv2/src/job_declaration.rs +++ b/sv2/handlers-sv2/src/job_declaration.rs @@ -1,11 +1,6 @@ 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 parsers_sv2::{parse_message_frame_with_tlvs, AnyMessage, JobDeclaration, Tlv}; +use job_declaration_sv2::*; +use parsers_sv2::{AnyMessage, JobDeclaration, Tlv}; use crate::error::HandlerErrorType; @@ -18,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 HandleJobDeclarationMessagesFromServerSync { @@ -43,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, @@ -149,7 +137,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)] @@ -176,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( @@ -294,7 +273,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 { @@ -319,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, @@ -423,7 +395,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)] @@ -450,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 e79400d4ec..d71d8952a1 100644 --- a/sv2/handlers-sv2/src/job_declaration_owned.rs +++ b/sv2/handlers-sv2/src/job_declaration_owned.rs @@ -1,13 +1,6 @@ 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 parsers_sv2::{ - parse_message_frame_with_tlvs, AnyMessage, JobDeclaration, JobDeclarationOwned, Tlv, -}; +use job_declaration_sv2::*; +use parsers_sv2::{AnyMessage, JobDeclarationOwned, Tlv}; use crate::error::HandlerErrorType; @@ -20,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 HandleJobDeclarationMessagesFromServerOwnedSync { @@ -45,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, @@ -155,7 +137,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)] @@ -182,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( @@ -303,7 +272,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 { @@ -328,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, @@ -434,7 +392,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)] @@ -461,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 8d5d2b8eaa..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, @@ -19,7 +35,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 e86c19a5d8..4c1beff261 100644 --- a/sv2/handlers-sv2/src/mining.rs +++ b/sv2/handlers-sv2/src/mining.rs @@ -1,25 +1,8 @@ use crate::error::HandlerErrorType; -use binary_sv2::Str0255; 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::{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. @@ -27,13 +10,12 @@ 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 { 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. @@ -55,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()) @@ -87,33 +62,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) @@ -124,62 +82,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, @@ -320,14 +247,13 @@ 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)] 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. @@ -350,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()) @@ -386,36 +303,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 @@ -438,69 +338,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, @@ -642,19 +513,13 @@ 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 { 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; - fn is_client_authorized( - &self, - client_id: Option, - user_identity: &Str0255, - ) -> Result; /// Returns the list of negotiated extension_types with a client. /// @@ -675,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()) @@ -697,75 +555,36 @@ 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, 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, @@ -830,6 +649,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 +657,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, @@ -880,20 +701,14 @@ 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)] 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; - fn is_client_authorized( - &self, - client_id: Option, - user_identity: &Str0255, - ) -> Result; /// Returns the list of negotiated extension types for a client. /// @@ -915,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()) @@ -951,71 +757,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, @@ -1081,6 +853,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 +861,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..460e22ff84 100644 --- a/sv2/handlers-sv2/src/mining_owned.rs +++ b/sv2/handlers-sv2/src/mining_owned.rs @@ -1,7 +1,6 @@ -use crate::{error::HandlerErrorType, mining::SupportedChannelTypes}; -use binary_sv2::Str0255; +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::*; @@ -12,13 +11,12 @@ 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 { 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. @@ -40,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, @@ -74,33 +65,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) @@ -111,62 +85,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, @@ -307,14 +250,13 @@ 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)] 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. @@ -337,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( @@ -377,36 +310,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 @@ -429,69 +345,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, @@ -633,19 +520,13 @@ 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 { 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; - fn is_client_authorized( - &self, - client_id: Option, - user_identity: &Str0255, - ) -> Result; /// Returns the list of negotiated extension_types with a client. /// @@ -666,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, @@ -690,75 +564,36 @@ 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, 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, @@ -823,6 +658,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 +666,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, @@ -873,20 +710,14 @@ 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)] 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; - fn is_client_authorized( - &self, - client_id: Option, - user_identity: &Str0255, - ) -> Result; /// Returns the list of negotiated extension types for a client. /// @@ -908,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( @@ -948,71 +770,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, @@ -1078,6 +866,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 +874,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, diff --git a/sv2/handlers-sv2/src/template_distribution.rs b/sv2/handlers-sv2/src/template_distribution.rs index 15dce450d4..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, @@ -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 { @@ -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( @@ -141,7 +134,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)] @@ -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( @@ -277,7 +261,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 { @@ -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( @@ -395,7 +372,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)] @@ -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 a512ed1122..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; @@ -15,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 HandleTemplateDistributionMessagesFromServerOwnedSync { @@ -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( @@ -143,7 +130,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)] @@ -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( @@ -282,7 +256,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 { @@ -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( @@ -404,7 +367,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)] @@ -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 { .. })) + )); + } +} 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/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 { .. }) + )); + } } 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" 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.