Updates docstrings + logging

Author: ibraheem-abe

bittensor/core/extrinsics/move_stake.py

@@ -224,10 +224,10 @@ def swap_stake_extrinsic(
 
             logging.info(
                 f"Swapping stake with safety for hotkey [blue]{hotkey_ss58}[/blue]\n"
-                f"Amount: [green]{amount}[/green] from netuid [yellow]{origin_netuid}[/yellow] to netuid "
-                f"[yellow]{destination_netuid}[/yellow]\n"
+                f"Amount: [green]{amount}[/green] from netuid [green]{origin_netuid}[/green] to netuid "
+                f"[green]{destination_netuid}[/green]\n"
                 f"Current price ratio: [green]{swap_rate_ratio:.4f}[/green], "
-                f"Ratio with tolerance: [yellow]{swap_rate_ratio_with_tolerance:.4f}[/yellow]"
+                f"Ratio with tolerance: [green]{swap_rate_ratio_with_tolerance:.4f}[/green]"
             )
             call_params.update(
                 {
@@ -239,8 +239,8 @@ def swap_stake_extrinsic(
         else:
             logging.info(
                 f"Swapping stake for hotkey [blue]{hotkey_ss58}[/blue]\n"
-                f"Amount: [green]{amount}[/green] from netuid [yellow]{origin_netuid}[/yellow] to netuid "
-                f"[yellow]{destination_netuid}[/yellow]"
+                f"Amount: [green]{amount}[/green] from netuid [green]{origin_netuid}[/green] to netuid "
+                f"[green]{destination_netuid}[/green]"
             )
             call_function = "swap_stake"
 

bittensor/core/extrinsics/staking.py

@@ -114,11 +114,11 @@ def add_stake_extrinsic(
 
             logging.info(
                 f":satellite: [magenta]Safe Staking to:[/magenta] "
-                f"[blue]netuid: [yellow]{netuid}[/yellow], amount: [green]{staking_balance}[/green], "
-                f"tolerance percentage: [yellow]{rate_threshold*100}%[/yellow], "
-                f"price limit: [yellow]{rate_with_tolerance}[/yellow], "
+                f"[blue]netuid: [green]{netuid}[/green], amount: [green]{staking_balance}[/green], "
+                f"tolerance percentage: [green]{rate_threshold*100}%[/green], "
+                f"price limit: [green]{rate_with_tolerance}[/green], "
                 f"original price: [green]{base_rate}[/green], "
-                f"with partial stake: [yellow]{allow_partial_stake}[/yellow] "
+                f"with partial stake: [green]{allow_partial_stake}[/green] "
                 f"on [blue]{subtensor.network}[/blue][/magenta]...[/magenta]"
             )
 
@@ -132,7 +132,7 @@ def add_stake_extrinsic(
         else:
             logging.info(
                 f":satellite: [magenta]Staking to:[/magenta] "
-                f"[blue]netuid: [yellow]{netuid}[/yellow], amount: [green]{staking_balance}[/green] "
+                f"[blue]netuid: [green]{netuid}[/green], amount: [green]{staking_balance}[/green] "
                 f"on [blue]{subtensor.network}[/blue][magenta]...[/magenta]"
             )
             call_function = "add_stake"

bittensor/core/extrinsics/unstaking.py

@@ -102,11 +102,11 @@ def unstake_extrinsic(
 
             logging.info(
                 f":satellite: [magenta]Safe Unstaking from:[/magenta] "
-                f"netuid: [yellow]{netuid}[/yellow], amount: [green]{unstaking_balance}[/green], "
-                f"tolerance percentage: [yellow]{rate_threshold*100}%[/yellow], "
-                f"price limit: [yellow]{rate_with_tolerance}[/yellow], "
+                f"netuid: [green]{netuid}[/green], amount: [green]{unstaking_balance}[/green], "
+                f"tolerance percentage: [green]{rate_threshold*100}%[/green], "
+                f"price limit: [green]{rate_with_tolerance}[/green], "
                 f"original price: [green]{base_rate}[/green], "
-                f"with partial unstake: [yellow]{allow_partial_stake}[/yellow] "
+                f"with partial unstake: [green]{allow_partial_stake}[/green] "
                 f"on [blue]{subtensor.network}[/blue][magenta]...[/magenta]"
             )
 
@@ -120,7 +120,7 @@ def unstake_extrinsic(
         else:
             logging.info(
                 f":satellite: [magenta]Unstaking from:[/magenta] "
-                f"netuid: [yellow]{netuid}[/yellow], amount: [green]{unstaking_balance}[/green] "
+                f"netuid: [green]{netuid}[/green], amount: [green]{unstaking_balance}[/green] "
                 f"on [blue]{subtensor.network}[/blue][magenta]...[/magenta]"
             )
             call_function = "remove_stake"

bittensor/core/subtensor.py

@@ -2145,15 +2145,21 @@ def add_stake(
             amount (Balance): The amount of TAO to stake.
             wait_for_inclusion (bool): Waits for the transaction to be included in a block.
             wait_for_finalization (bool): Waits for the transaction to be finalized on the blockchain.
-            safe_staking (bool): If true, the staking process will have safety checks enabled. .
-            allow_partial_stake (bool): If true, partial stake will be allowed in-case full stake doesnt fulfill the threshold.
-            rate_threshold (float): The threshold in percentage of price which can be allowed to fluctuate. 0.005 = 0.5% by default.
+            safe_staking (bool): If true, enables price safety checks to protect against fluctuating prices. The stake
+                will only execute if the price change doesn't exceed the rate threshold. Default is False.
+            allow_partial_stake (bool): If true and safe_staking is enabled, allows partial staking when
+                the full amount would exceed the price threshold. If false, the entire stake fails if it would
+                exceed the threshold. Default is False.
+            rate_threshold (float): The maximum allowed price change ratio when staking. For example,
+                0.005 = 0.5% maximum price increase. Only used when safe_staking is True. Default is 0.005.
 
         Returns:
-            bool: ``True`` if the staking is successful, False otherwise.
+            bool: True if the staking is successful, False otherwise.
 
         This function enables neurons to increase their stake in the network, enhancing their influence and potential
             rewards in line with Bittensor's consensus and reward mechanisms.
+            When safe_staking is enabled, it provides protection against price fluctuations during the time stake is
+            executed and the time it is actually processed by the chain.
         """
         amount = check_and_convert_to_balance(amount)
         return add_stake_extrinsic(
@@ -2785,7 +2791,7 @@ def swap_stake(
             amount (Union[Balance, float]): The amount to swap.
             wait_for_inclusion (bool): Waits for the transaction to be included in a block.
             wait_for_finalization (bool): Waits for the transaction to be finalized on the blockchain.
-            safe_staking (bool): If true, enables price safety checks to protect against price impact. The swap
+            safe_staking (bool): If true, enables price safety checks to protect against fluctuating prices. The swap
                 will only execute if the price ratio between subnets doesn't exceed the rate threshold.
                 Default is False.
             allow_partial_stake (bool): If true and safe_staking is enabled, allows partial stake swaps when
@@ -2923,12 +2929,20 @@ def unstake(
             amount (Balance): The amount of TAO to unstake. If not specified, unstakes all.
             wait_for_inclusion (bool): Waits for the transaction to be included in a block.
             wait_for_finalization (bool): Waits for the transaction to be finalized on the blockchain.
+            safe_staking (bool): If true, enables price safety checks to protect against fluctuating prices. The unstake
+                will only execute if the price change doesn't exceed the rate threshold. Default is False.
+            allow_partial_stake (bool): If true and safe_staking is enabled, allows partial unstaking when
+                the full amount would exceed the price threshold. If false, the entire unstake fails if it would
+                exceed the threshold. Default is False.
+            rate_threshold (float): The maximum allowed price change ratio when unstaking. For example,
+                0.005 = 0.5% maximum price decrease. Only used when safe_staking is True. Default is 0.005.
 
         Returns:
             bool: ``True`` if the unstaking process is successful, False otherwise.
 
         This function supports flexible stake management, allowing neurons to adjust their network participation and
-            potential reward accruals.
+            potential reward accruals. When safe_staking is enabled, it provides protection against price fluctuations
+            during the time unstake is executed and the time it is actually processed by the chain.
         """
         amount = check_and_convert_to_balance(amount)
         return unstake_extrinsic(