make Pool use newer extranonce APIs (coming from PR #2098 on stratum repository)

Author: GitGab19

pool-apps/pool/src/lib/channel_manager/mining_message_handler.rs

@@ -101,6 +101,13 @@ impl HandleMiningMessagesFromClientAsync for ChannelManager {
                 channel_manager_data
                     .vardiff
                     .remove(&(downstream_id, msg.channel_id).into());
+
+                if let Some(prefix_id) = channel_manager_data
+                    .channel_to_local_index
+                    .remove(&(downstream_id, msg.channel_id))
+                {
+                    channel_manager_data.extranonce_allocator.free(prefix_id);
+                }
                 Ok(())
             })
     }
@@ -168,12 +175,15 @@ impl HandleMiningMessagesFromClientAsync for ChannelManager {
 
                 let nominal_hash_rate = msg.nominal_hash_rate;
                 let requested_max_target = Target::from_le_bytes(msg.max_target.inner_as_ref().try_into().unwrap());
-                let extranonce_prefix = channel_manager_data.extranonce_prefix_factory_standard.next_prefix_standard().map_err(PoolError::shutdown)?;
+                let prefix = channel_manager_data.extranonce_allocator.allocate_standard().map_err(PoolError::shutdown)?;
+                let extranonce_prefix = prefix.as_bytes().to_vec();
+                let local_index = prefix.local_index();
 
                 let channel_id = downstream_data.channel_id_factory.fetch_add(1, Ordering::SeqCst);
+                channel_manager_data.channel_to_local_index.insert((downstream_id, channel_id), local_index);
                 let job_store = DefaultJobStore::new();
 
-                let mut standard_channel = match StandardChannel::new_for_pool(channel_id, user_identity.to_string(), extranonce_prefix.to_vec(), requested_max_target, nominal_hash_rate, self.share_batch_size, self.shares_per_minute, job_store, self.pool_tag_string.clone()) {
+                let mut standard_channel = match StandardChannel::new_for_pool(channel_id, user_identity.to_string(), extranonce_prefix, requested_max_target, nominal_hash_rate, self.share_batch_size, self.shares_per_minute, job_store, self.pool_tag_string.clone()) {
                     Ok(channel) => channel,
                     Err(e) => match e {
                         StandardChannelError::InvalidNominalHashrate => {
@@ -305,11 +315,11 @@ impl HandleMiningMessagesFromClientAsync for ChannelManager {
                     .super_safe_lock(|downstream_data| {
                         let mut messages: Vec<RouteMessageTo> = Vec::new();
 
-                        let extranonce_prefix = match channel_manager_data
-                            .extranonce_prefix_factory_extended
-                            .next_prefix_extended(requested_min_rollable_extranonce_size.into())
+                        let (extranonce_prefix, local_index) = match channel_manager_data
+                            .extranonce_allocator
+                            .allocate_extended(requested_min_rollable_extranonce_size.into())
                         {
-                            Ok(extranonce_prefix) => extranonce_prefix.to_vec(),
+                            Ok(prefix) => (prefix.as_bytes().to_vec(), prefix.local_index()),
                             Err(_) => {
                                 error!("OpenMiningChannelError: min-extranonce-size-too-large");
                                 let open_extended_mining_channel_error = OpenMiningChannelError {
@@ -355,6 +365,7 @@ impl HandleMiningMessagesFromClientAsync for ChannelManager {
                         let channel_id = downstream_data
                             .channel_id_factory
                             .fetch_add(1, Ordering::SeqCst);
+                        channel_manager_data.channel_to_local_index.insert((downstream_id, channel_id), local_index);
                         let job_store = DefaultJobStore::new();
 
                         let mut extended_channel = match ExtendedChannel::new_for_pool(

pool-apps/pool/src/lib/channel_manager/mod.rs

@@ -19,6 +19,7 @@ use stratum_apps::{
     stratum_core::{
         bitcoin::{Amount, TxOut},
         channels_sv2::{
+            extranonce_manager::ExtranonceAllocator,
             server::{
                 extended::ExtendedChannel,
                 group::GroupChannel,
@@ -30,7 +31,7 @@ use stratum_apps::{
         handlers_sv2::{
             HandleMiningMessagesFromClientAsync, HandleTemplateDistributionMessagesFromServerAsync,
         },
-        mining_sv2::{ExtendedExtranonce, SetTarget},
+        mining_sv2::SetTarget,
         parsers_sv2::{Mining, TemplateDistribution, Tlv},
         template_distribution_sv2::{NewTemplate, SetNewPrevHash},
     },
@@ -60,12 +61,11 @@ pub struct ChannelManagerData {
     // Mapping of `downstream_id` → `Downstream` object,
     // used by the channel manager to locate and interact with downstream clients.
     pub(crate) downstream: HashMap<DownstreamId, Downstream>,
-    // Extranonce prefix factory for **extended downstream channels**.
-    // Each new extended downstream receives a unique extranonce prefix.
-    extranonce_prefix_factory_extended: ExtendedExtranonce,
-    // Extranonce prefix factory for **standard downstream channels**.
-    // Each new standard downstream receives a unique extranonce prefix.
-    extranonce_prefix_factory_standard: ExtendedExtranonce,
+    // Extranonce allocator for both standard and extended downstream channels.
+    // Each new downstream channel receives a unique extranonce prefix.
+    pub(crate) extranonce_allocator: ExtranonceAllocator,
+    // Mapping of `(downstream_id, channel_id)` → `local_index` for freeing extranonces.
+    pub(crate) channel_to_local_index: HashMap<(DownstreamId, ChannelId), usize>,
     // Factory that assigns a unique ID to each new **downstream connection**.
     downstream_id_factory: AtomicUsize,
     // Mapping of `(downstream_id, channel_id)` → vardiff controller.
@@ -118,32 +118,21 @@ impl ChannelManager {
         coinbase_outputs: Vec<u8>,
         job_declarator: Option<JobDeclarator>,
     ) -> PoolResult<Self, error::ChannelManager> {
-        let range_0 = 0..0;
-        let range_1 = 0..POOL_ALLOCATION_BYTES;
-        let range_2 = POOL_ALLOCATION_BYTES..POOL_ALLOCATION_BYTES + CLIENT_SEARCH_SPACE_BYTES;
-
-        let make_extranonce_factory = || {
-            // simulating a scenario where there are multiple mining servers
-            // this static prefix allows unique extranonce_prefix allocation
-            // for this mining server
-            let static_prefix = config.server_id().to_be_bytes().to_vec();
-
-            ExtendedExtranonce::new(
-                range_0.clone(),
-                range_1.clone(),
-                range_2.clone(),
-                Some(static_prefix),
-            )
-            .expect("Failed to create ExtendedExtranonce with valid ranges")
-        };
+        // Server ID is used to distinguish multiple pool server instances.
+        // It takes 2 bytes of the local_prefix, leaving 2 bytes for channel IDs (65,536 channels).
+        let server_id = config.server_id().to_be_bytes().to_vec();
 
-        let extranonce_prefix_factory_extended = make_extranonce_factory();
-        let extranonce_prefix_factory_standard = make_extranonce_factory();
+        let extranonce_allocator = ExtranonceAllocator::new(
+            FULL_EXTRANONCE_SIZE, // 20 bytes total extranonce
+            Some(server_id),      // 2-byte server identifier
+            65_536,               // max concurrent channels (2^16, fits in 2 bytes)
+        )
+        .expect("Failed to create ExtranonceAllocator with valid configuration");
 
         let channel_manager_data = Arc::new(Mutex::new(ChannelManagerData {
             downstream: HashMap::new(),
-            extranonce_prefix_factory_extended,
-            extranonce_prefix_factory_standard,
+            extranonce_allocator,
+            channel_to_local_index: HashMap::new(),
             downstream_id_factory: AtomicUsize::new(1),
             vardiff: HashMap::new(),
             coinbase_outputs,
@@ -442,6 +431,19 @@ impl ChannelManager {
             cm_data
                 .vardiff
                 .retain(|key, _| key.downstream_id != downstream_id);
+            // Free extranonce prefixes for all channels belonging to this downstream
+            let prefix_ids_to_free: Vec<usize> = cm_data
+                .channel_to_local_index
+                .iter()
+                .filter(|((ds_id, _), _)| *ds_id == downstream_id)
+                .map(|(_, prefix_id)| *prefix_id)
+                .collect();
+            for prefix_id in prefix_ids_to_free {
+                cm_data.extranonce_allocator.free(prefix_id);
+            }
+            cm_data
+                .channel_to_local_index
+                .retain(|(ds_id, _), _| *ds_id != downstream_id);
         });
         self.channel_manager_channel
             .downstream_sender

pool-apps/pool/src/lib/error.rs

@@ -9,6 +9,7 @@ use stratum_apps::{
     stratum_core::{
         binary_sv2, bitcoin,
         channels_sv2::{
+            extranonce_manager::ExtranonceAllocatorError,
             server::{
                 error::{ExtendedChannelError, GroupChannelError, StandardChannelError},
                 share_accounting::ShareValidationError,
@@ -17,7 +18,6 @@ use stratum_apps::{
         },
         codec_sv2, framing_sv2,
         handlers_sv2::HandlerErrorType,
-        mining_sv2::ExtendedExtranonceError,
         noise_sv2,
         parsers_sv2::{Mining, ParserError},
     },
@@ -105,7 +105,7 @@ pub enum ChannelSv2Error {
     ExtendedChannelServerSide(ExtendedChannelError),
     StandardChannelServerSide(StandardChannelError),
     GroupChannelServerSide(GroupChannelError),
-    ExtranonceError(ExtendedExtranonceError),
+    ExtranonceError(ExtranonceAllocatorError),
     ShareValidationError(ShareValidationError),
 }
 
@@ -380,8 +380,8 @@ impl From<GroupChannelError> for PoolErrorKind {
     }
 }
 
-impl From<ExtendedExtranonceError> for PoolErrorKind {
-    fn from(value: ExtendedExtranonceError) -> Self {
+impl From<ExtranonceAllocatorError> for PoolErrorKind {
+    fn from(value: ExtranonceAllocatorError) -> Self {
         PoolErrorKind::ChannelSv2(ChannelSv2Error::ExtranonceError(value))
     }
 }