Root claim

common/src/lib.rs

@@ -159,6 +159,7 @@ pub enum ProxyType {
     SudoUncheckedSetCode,
     SwapHotkey,
     SubnetLeaseBeneficiary, // Used to operate the leased subnet
+    RootClaim,
 }
 
 impl Default for ProxyType {

pallets/admin-utils/src/tests/mod.rs

@@ -2663,7 +2663,6 @@ fn test_trim_to_max_allowed_uids() {
             assert!(!AlphaDividendsPerSubnet::<Test>::contains_key(
                 netuid, hotkey
             ));
-            assert!(!TaoDividendsPerSubnet::<Test>::contains_key(netuid, hotkey));
             assert!(!Axons::<Test>::contains_key(netuid, hotkey));
             assert!(!NeuronCertificates::<Test>::contains_key(netuid, hotkey));
             assert!(!Prometheus::<Test>::contains_key(netuid, hotkey));

pallets/subtensor/src/benchmarks.rs

@@ -1577,4 +1577,83 @@ mod pallet_benchmarks {
         #[extrinsic_call]
         _(RawOrigin::Signed(coldkey.clone()), netuid, hotkey.clone());
     }
+    #[benchmark]
+    fn set_root_claim_type() {
+        let coldkey: T::AccountId = whitelisted_caller();
+
+        #[extrinsic_call]
+        _(RawOrigin::Signed(coldkey.clone()), RootClaimTypeEnum::Keep);
+    }
+
+    #[benchmark]
+    fn claim_root() {
+        let coldkey: T::AccountId = whitelisted_caller();
+        let hotkey: T::AccountId = account("A", 0, 1);
+
+        let netuid = Subtensor::<T>::get_next_netuid();
+
+        let lock_cost = Subtensor::<T>::get_network_lock_cost();
+        Subtensor::<T>::add_balance_to_coldkey_account(&coldkey, lock_cost.into());
+
+        assert_ok!(Subtensor::<T>::register_network(
+            RawOrigin::Signed(coldkey.clone()).into(),
+            hotkey.clone()
+        ));
+
+        SubtokenEnabled::<T>::insert(netuid, true);
+        Subtensor::<T>::set_network_pow_registration_allowed(netuid, true);
+        NetworkRegistrationAllowed::<T>::insert(netuid, true);
+        FirstEmissionBlockNumber::<T>::insert(netuid, 0);
+
+        SubnetMechanism::<T>::insert(netuid, 1);
+        SubnetworkN::<T>::insert(netuid, 1);
+        Subtensor::<T>::set_tao_weight(u64::MAX); // Set TAO weight to 1.0
+
+        let root_stake = 100_000_000u64;
+        Subtensor::<T>::increase_stake_for_hotkey_and_coldkey_on_subnet(
+            &hotkey,
+            &coldkey,
+            NetUid::ROOT,
+            root_stake.into(),
+        );
+
+        let initial_total_hotkey_alpha = 100_000_000u64;
+        Subtensor::<T>::increase_stake_for_hotkey_and_coldkey_on_subnet(
+            &hotkey,
+            &coldkey,
+            netuid,
+            initial_total_hotkey_alpha.into(),
+        );
+
+        let pending_root_alpha = 10_000_000u64;
+        Subtensor::<T>::drain_pending_emission(
+            netuid,
+            AlphaCurrency::ZERO,
+            pending_root_alpha.into(),
+            AlphaCurrency::ZERO,
+        );
+
+        let initial_stake =
+            Subtensor::<T>::get_stake_for_hotkey_and_coldkey_on_subnet(&hotkey, &coldkey, netuid);
+
+        assert_ok!(Subtensor::<T>::set_root_claim_type(
+            RawOrigin::Signed(coldkey.clone()).into(),
+            RootClaimTypeEnum::Keep
+        ),);
+
+        #[extrinsic_call]
+        _(RawOrigin::Signed(coldkey.clone()));
+
+        // Verification
+        let new_stake =
+            Subtensor::<T>::get_stake_for_hotkey_and_coldkey_on_subnet(&hotkey, &coldkey, netuid);
+
+        assert!(new_stake > initial_stake);
+    }
+
+    #[benchmark]
+    fn sudo_set_num_root_claims() {
+        #[extrinsic_call]
+        _(RawOrigin::Root, 100);
+    }
 }

pallets/subtensor/src/coinbase/block_step.rs

@@ -7,7 +7,8 @@ impl<T: Config + pallet_drand::Config> Pallet<T> {
     /// Executes the necessary operations for each block.
     pub fn block_step() -> Result<(), &'static str> {
         let block_number: u64 = Self::get_current_block_as_u64();
-        log::debug!("block_step for block: {block_number:?} ");
+        let last_block_hash: T::Hash = <frame_system::Pallet<T>>::parent_hash();
+
         // --- 1. Adjust difficulties.
         Self::adjust_registration_terms_for_networks();
         // --- 2. Get the current coinbase emission.
@@ -21,6 +22,11 @@ impl<T: Config + pallet_drand::Config> Pallet<T> {
         Self::run_coinbase(block_emission);
         // --- 4. Set pending children on the epoch; but only after the coinbase has been run.
         Self::try_set_pending_children(block_number);
+        // --- 5. Run auto-claim root divs.
+        Self::run_auto_claim_root_divs(last_block_hash);
+        // --- 6. Populate root coldkey maps.
+        Self::populate_root_coldkey_staking_maps();
+
         // Return ok.
         Ok(())
     }

pallets/subtensor/src/coinbase/root.rs

@@ -366,22 +366,24 @@ impl<T: Config> Pallet<T> {
     /// * 'NotSubnetOwner': If the caller does not own the specified subnet.
     ///
     pub fn do_dissolve_network(netuid: NetUid) -> dispatch::DispatchResult {
-        // 1. --- The network exists?
+        // --- The network exists?
         ensure!(
             Self::if_subnet_exist(netuid) && netuid != NetUid::ROOT,
             Error::<T>::SubnetNotExists
         );
 
-        // 2. --- Perform the cleanup before removing the network.
+        Self::finalize_all_subnet_root_dividends(netuid);
+
+        // --- Perform the cleanup before removing the network.
         T::SwapInterface::dissolve_all_liquidity_providers(netuid)?;
         Self::destroy_alpha_in_out_stakes(netuid)?;
         T::SwapInterface::clear_protocol_liquidity(netuid)?;
         T::CommitmentsInterface::purge_netuid(netuid);
 
-        // 3. --- Remove the network
+        // --- Remove the network
         Self::remove_network(netuid);
 
-        // 4. --- Emit the NetworkRemoved event
+        // --- Emit the NetworkRemoved event
         log::info!("NetworkRemoved( netuid:{netuid:?} )");
         Self::deposit_event(Event::NetworkRemoved(netuid));
 
@@ -476,8 +478,7 @@ impl<T: Config> Pallet<T> {
         // --- 15. Mechanism step / emissions bookkeeping.
         FirstEmissionBlockNumber::<T>::remove(netuid);
         PendingEmission::<T>::remove(netuid);
-        PendingRootDivs::<T>::remove(netuid);
-        PendingAlphaSwapped::<T>::remove(netuid);
+        PendingRootAlphaDivs::<T>::remove(netuid);
         PendingOwnerCut::<T>::remove(netuid);
         BlocksSinceLastStep::<T>::remove(netuid);
         LastMechansimStepBlock::<T>::remove(netuid);
@@ -510,6 +511,7 @@ impl<T: Config> Pallet<T> {
         RAORecycledForRegistration::<T>::remove(netuid);
         MaxRegistrationsPerBlock::<T>::remove(netuid);
         WeightsVersionKey::<T>::remove(netuid);
+        PendingRootAlphaDivs::<T>::remove(netuid);
 
         // --- 17. Subtoken / feature flags.
         LiquidAlphaOn::<T>::remove(netuid);
@@ -528,7 +530,6 @@ impl<T: Config> Pallet<T> {
         let _ = NeuronCertificates::<T>::clear_prefix(netuid, u32::MAX, None);
         let _ = Prometheus::<T>::clear_prefix(netuid, u32::MAX, None);
         let _ = AlphaDividendsPerSubnet::<T>::clear_prefix(netuid, u32::MAX, None);
-        let _ = TaoDividendsPerSubnet::<T>::clear_prefix(netuid, u32::MAX, None);
         let _ = PendingChildKeys::<T>::clear_prefix(netuid, u32::MAX, None);
         let _ = AssociatedEvmAddress::<T>::clear_prefix(netuid, u32::MAX, None);