Apply review suggestions

Author: shamil-gadelshin

pallets/subtensor/src/coinbase/run_coinbase.rs

@@ -174,7 +174,7 @@ impl<T: Config> Pallet<T> {
         let tao_weight: U96F32 = root_tao.saturating_mul(Self::get_tao_weight());
         log::debug!("tao_weight: {tao_weight:?}");
 
-        // --- 6. Seperate out root dividends in alpha and sell them into tao.
+        // --- 6. Seperate out root dividends in alpha and keep them.
         // Then accumulate those dividends for later.
         for netuid_i in subnets_to_emit_to.iter() {
             // Get remaining alpha out.
@@ -237,15 +237,15 @@ impl<T: Config> Pallet<T> {
                 let pending_alpha = PendingEmission::<T>::get(netuid);
                 PendingEmission::<T>::insert(netuid, AlphaCurrency::ZERO);
 
-                // Get and drain the subnet pending root divs.
+                // Get and drain the subnet pending root alpha divs.
                 let pending_root_alpha = PendingRootAlphaDivs::<T>::get(netuid);
                 PendingRootAlphaDivs::<T>::insert(netuid, AlphaCurrency::ZERO);
 
                 // Get owner cut and drain.
                 let owner_cut = PendingOwnerCut::<T>::get(netuid);
                 PendingOwnerCut::<T>::insert(netuid, AlphaCurrency::ZERO);
 
-                // Drain pending root divs, alpha emission, and owner cut.
+                // Drain pending root alpha divs, alpha emission, and owner cut.
                 Self::drain_pending_emission(netuid, pending_alpha, pending_root_alpha, owner_cut);
             } else {
                 // Increment
@@ -306,7 +306,7 @@ impl<T: Config> Pallet<T> {
         // Setup.
         let zero: U96F32 = asfloat!(0.0);
 
-        // Accumulate root divs and alpha_divs. For each hotkey we compute their
+        // Accumulate root alpha divs and alpha_divs. For each hotkey we compute their
         // local and root dividend proportion based on their alpha_stake/root_stake
         let mut total_root_divs: U96F32 = asfloat!(0);
         let mut total_alpha_divs: U96F32 = asfloat!(0);
@@ -532,7 +532,7 @@ impl<T: Config> Pallet<T> {
             // Get take prop
             let alpha_take: U96F32 =
                 Self::get_hotkey_take_float(&hotkey).saturating_mul(root_alpha);
-            // Remove take prop from root_tao
+            // Remove take prop from root_alpha
             root_alpha = root_alpha.saturating_sub(alpha_take);
             // Give the validator their take.
             log::debug!("hotkey: {hotkey:?} alpha_take: {alpha_take:?}");
@@ -549,7 +549,7 @@ impl<T: Config> Pallet<T> {
                 tou64!(root_alpha).into(),
             );
 
-            // Record root dividends for this validator on this subnet.
+            // Record root alpha dividends for this validator on this subnet.
             AlphaDividendsPerSubnet::<T>::mutate(netuid, hotkey.clone(), |divs| {
                 *divs = divs.saturating_add(tou64!(root_alpha).into());
             });

pallets/subtensor/src/lib.rs

@@ -1383,7 +1383,7 @@ pub mod pallet {
     /// --- MAP ( netuid ) --> pending_emission
     pub type PendingEmission<T> =
         StorageMap<_, Identity, NetUid, AlphaCurrency, ValueQuery, DefaultPendingEmission<T>>;
-    /// --- MAP ( netuid ) --> pending_root_emission
+    /// --- MAP ( netuid ) --> pending_root_alpha_emission
     #[pallet::storage]
     pub type PendingRootAlphaDivs<T> =
         StorageMap<_, Identity, NetUid, AlphaCurrency, ValueQuery, DefaultZeroAlpha<T>>;

pallets/subtensor/src/macros/dispatches.rs

@@ -2367,15 +2367,7 @@ mod dispatches {
             Ok(())
         }
 
-        /// --- Sets the root claim type for the coldkey.
-        /// # Args:
-        /// * 'origin': (<T as frame_system::Config>Origin):
-        /// 	- The signature of the caller's coldkey.
-        ///
-        /// # Event:
-        /// * RootClaimTypeSet;
-        /// 	- On the successfully setting the root claim type for the coldkey.
-        ///
+        /// --- Sets root claim number (sudo extrinsic).
         #[pallet::call_index(123)]
         #[pallet::weight((
             Weight::from_parts(4_000_000, 0).saturating_add(T::DbWeight::get().writes(1_u64)),
@@ -2395,15 +2387,7 @@ mod dispatches {
             Ok(())
         }
 
-        /// --- Sets the root claim type for the coldkey.
-        /// # Args:
-        /// * 'origin': (<T as frame_system::Config>Origin):
-        /// 	- The signature of the caller's coldkey.
-        ///
-        /// # Event:
-        /// * RootClaimTypeSet;
-        /// 	- On the successfully setting the root claim type for the coldkey.
-        ///
+        /// --- Sets root claim threshold for subnet (sudo or owner origin).
         #[pallet::call_index(124)]
         #[pallet::weight((
             Weight::from_parts(5_711_000, 0).saturating_add(T::DbWeight::get().writes(1_u64)),

pallets/subtensor/src/staking/claim_root.rs

@@ -101,7 +101,7 @@ impl<T: Config> Pallet<T> {
         let root_claimed: I96F32 =
             I96F32::saturating_from_num(RootClaimed::<T>::get((hotkey, coldkey, netuid)));
 
-        // Substract the already claimed alpha.
+        // Subtract the already claimed alpha.
         let owed: I96F32 = claimable.saturating_sub(root_claimed);
 
         owed
@@ -131,7 +131,7 @@ impl<T: Config> Pallet<T> {
         root_claim_type: RootClaimTypeEnum,
         ignore_minimum_condition: bool,
     ) {
-        // Substract the root claimed.
+        // Subtract the root claimed.
         let owed: I96F32 = Self::get_root_owed_for_hotkey_coldkey_float(hotkey, coldkey, netuid);
 
         if !ignore_minimum_condition

pallets/subtensor/src/staking/helpers.rs

@@ -326,9 +326,9 @@ impl<T: Config> Pallet<T> {
         });
     }
 
-    /// The function clears Alpha map in batches. Each run will check ALPHA_MAP_CLEAN_BATCH_SIZE
+    /// The function clears Alpha map in batches. Each run will check ALPHA_MAP_BATCH_SIZE
     /// alphas. It keeps the alpha value stored when it's >= than MIN_ALPHA.
-    /// The function uses AlphaMapCleanLastKey as a storage for key iterator between runs.
+    /// The function uses AlphaMapLastKey as a storage for key iterator between runs.
     pub fn populate_root_coldkey_staking_maps() {
         // Get starting key for the batch. Get the first key if we restart the process.
         let mut new_starting_raw_key = AlphaMapLastKey::<T>::get();

pallets/subtensor/src/tests/coinbase.rs

@@ -947,7 +947,6 @@ fn test_drain_base_with_subnet_with_two_stakers_registered_and_root_different_am
         SubtensorModule::drain_pending_emission(
             netuid,
             pending_alpha,
-            //   pending_tao,
             AlphaCurrency::ZERO,
             AlphaCurrency::ZERO,
         );