make raise_error param optional

Author: zyzniewski-reef

bittensor/core/async_subtensor.py

@@ -3281,9 +3281,10 @@ async def set_delegate_take(
         wallet: "Wallet",
         hotkey_ss58: str,
         take: float,
-        wait_for_inclusion=True,
-        wait_for_finalization=True,
-    ) -> None:
+        wait_for_inclusion: bool = True,
+        wait_for_finalization: bool = True,
+        raise_error: bool = False,
+    ) -> tuple[bool, str]:
         """
         Sets the delegate 'take' percentage for a neuron identified by its hotkey.
         The 'take' represents the percentage of rewards that the delegate claims from its nominators' stakes.
@@ -3294,6 +3295,11 @@ async def set_delegate_take(
             take (float): Percentage reward for the delegate.
             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.
+            raise_error: Raises relevant exception rather than returning `False` if unsuccessful.
+
+        Returns:
+            tuple[bool, str]: A tuple where the first element is a boolean indicating success or failure of the
+             operation, and the second element is a message providing additional information.
 
         Raises:
             DelegateTakeTooHigh: Delegate take is too high.
@@ -3316,30 +3322,35 @@ async def set_delegate_take(
 
         if current_take_u16 == take_u16:
             logging.info(":white_heavy_check_mark: [green]Already Set[/green]")
-            return
+            return True, ""
 
         logging.info(f"Updating {hotkey_ss58} take: current={current_take} new={take}")
 
         if current_take_u16 < take_u16:
-            await increase_take_extrinsic(
+            success, error = await increase_take_extrinsic(
                 self,
                 wallet,
                 hotkey_ss58,
                 take_u16,
                 wait_for_finalization=wait_for_finalization,
                 wait_for_inclusion=wait_for_inclusion,
+                raise_error=raise_error,
             )
         else:
-            await decrease_take_extrinsic(
+            success, error = await decrease_take_extrinsic(
                 self,
                 wallet,
                 hotkey_ss58,
                 take_u16,
                 wait_for_finalization=wait_for_finalization,
                 wait_for_inclusion=wait_for_inclusion,
+                raise_error=raise_error,
             )
 
-        logging.info(":white_heavy_check_mark: [green]Take Updated[/green]")
+        if success:
+            logging.info(":white_heavy_check_mark: [green]Take Updated[/green]")
+
+        return success, error
 
     async def set_subnet_identity(
         self,

bittensor/core/extrinsics/asyncex/take.py

@@ -2,6 +2,8 @@
 
 from bittensor_wallet.bittensor_wallet import Wallet
 
+from bittensor.utils import unlock_key
+
 if TYPE_CHECKING:
     from bittensor.core.async_subtensor import AsyncSubtensor
 
@@ -11,10 +13,14 @@ async def increase_take_extrinsic(
     wallet: Wallet,
     hotkey_ss58: str,
     take: int,
-    wait_for_inclusion=True,
-    wait_for_finalization=True,
-) -> None:
-    wallet.unlock_coldkey()
+    wait_for_inclusion: bool = True,
+    wait_for_finalization: bool = True,
+    raise_error: bool = False,
+) -> tuple[bool, str]:
+    unlock = unlock_key(wallet, raise_error=raise_error)
+
+    if not unlock.success:
+        return False, unlock.message
 
     call = await subtensor.substrate.compose_call(
         call_module="SubtensorModule",
@@ -25,12 +31,12 @@ async def increase_take_extrinsic(
         },
     )
 
-    await subtensor.sign_and_send_extrinsic(
+    return await subtensor.sign_and_send_extrinsic(
         call,
         wallet,
         wait_for_inclusion=wait_for_inclusion,
         wait_for_finalization=wait_for_finalization,
-        raise_error=True,
+        raise_error=raise_error,
     )
 
 
@@ -39,10 +45,14 @@ async def decrease_take_extrinsic(
     wallet: Wallet,
     hotkey_ss58: str,
     take: int,
-    wait_for_inclusion=True,
-    wait_for_finalization=True,
-) -> None:
-    wallet.unlock_coldkey()
+    wait_for_inclusion: bool = True,
+    wait_for_finalization: bool = True,
+    raise_error: bool = False,
+) -> tuple[bool, str]:
+    unlock = unlock_key(wallet, raise_error=raise_error)
+
+    if not unlock.success:
+        return False, unlock.message
 
     call = await subtensor.substrate.compose_call(
         call_module="SubtensorModule",
@@ -53,10 +63,10 @@ async def decrease_take_extrinsic(
         },
     )
 
-    await subtensor.sign_and_send_extrinsic(
+    return await subtensor.sign_and_send_extrinsic(
         call,
         wallet,
         wait_for_inclusion=wait_for_inclusion,
         wait_for_finalization=wait_for_finalization,
-        raise_error=True,
+        raise_error=raise_error,
     )

bittensor/core/extrinsics/take.py

@@ -2,6 +2,9 @@
 
 from bittensor_wallet.bittensor_wallet import Wallet
 
+from bittensor.utils.btlogging import logging
+from bittensor.utils import unlock_key
+
 if TYPE_CHECKING:
     from bittensor.core.subtensor import Subtensor
 
@@ -11,10 +14,14 @@ def increase_take_extrinsic(
     wallet: Wallet,
     hotkey_ss58: str,
     take: int,
-    wait_for_inclusion=True,
-    wait_for_finalization=True,
-) -> None:
-    wallet.unlock_coldkey()
+    wait_for_inclusion: bool = True,
+    wait_for_finalization: bool = True,
+    raise_error: bool = False,
+) -> tuple[bool, str]:
+    unlock = unlock_key(wallet, raise_error=raise_error)
+
+    if not unlock.success:
+        return False, unlock.message
 
     call = subtensor.substrate.compose_call(
         call_module="SubtensorModule",
@@ -25,12 +32,12 @@ def increase_take_extrinsic(
         },
     )
 
-    subtensor.sign_and_send_extrinsic(
+    return subtensor.sign_and_send_extrinsic(
         call,
         wallet,
         wait_for_inclusion=wait_for_inclusion,
         wait_for_finalization=wait_for_finalization,
-        raise_error=True,
+        raise_error=raise_error,
     )
 
 
@@ -39,10 +46,14 @@ def decrease_take_extrinsic(
     wallet: Wallet,
     hotkey_ss58: str,
     take: int,
-    wait_for_inclusion=True,
-    wait_for_finalization=True,
-) -> None:
-    wallet.unlock_coldkey()
+    wait_for_inclusion: bool = True,
+    wait_for_finalization: bool = True,
+    raise_error: bool = False,
+) -> tuple[bool, str]:
+    unlock = unlock_key(wallet, raise_error=raise_error)
+
+    if not unlock.success:
+        return False, unlock.message
 
     call = subtensor.substrate.compose_call(
         call_module="SubtensorModule",
@@ -53,10 +64,10 @@ def decrease_take_extrinsic(
         },
     )
 
-    subtensor.sign_and_send_extrinsic(
+    return subtensor.sign_and_send_extrinsic(
         call,
         wallet,
         wait_for_inclusion=wait_for_inclusion,
         wait_for_finalization=wait_for_finalization,
-        raise_error=True,
+        raise_error=raise_error,
     )

bittensor/core/subtensor.py

@@ -1577,9 +1577,10 @@ def set_delegate_take(
         wallet: "Wallet",
         hotkey_ss58: str,
         take: float,
-        wait_for_inclusion=True,
-        wait_for_finalization=True,
-    ) -> None:
+        wait_for_inclusion: bool = True,
+        wait_for_finalization: bool = True,
+        raise_error: bool = False,
+    ) -> tuple[bool, str]:
         """
         Sets the delegate 'take' percentage for a nueron identified by its hotkey.
         The 'take' represents the percentage of rewards that the delegate claims from its nominators' stakes.
@@ -1590,6 +1591,11 @@ def set_delegate_take(
             take (float): Percentage reward for the delegate.
             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.
+            raise_error: Raises relevant exception rather than returning `False` if unsuccessful.
+
+        Returns:
+            tuple[bool, str]: A tuple where the first element is a boolean indicating success or failure of the
+             operation, and the second element is a message providing additional information.
 
         Raises:
             DelegateTakeTooHigh: Delegate take is too high.
@@ -1612,30 +1618,35 @@ def set_delegate_take(
 
         if current_take_u16 == take_u16:
             logging.info(":white_heavy_check_mark: [green]Already Set[/green]")
-            return
+            return True, ""
 
         logging.info(f"Updating {hotkey_ss58} take: current={current_take} new={take}")
 
         if current_take_u16 < take_u16:
-            increase_take_extrinsic(
+            success, error = increase_take_extrinsic(
                 self,
                 wallet,
                 hotkey_ss58,
                 take_u16,
                 wait_for_finalization=wait_for_finalization,
                 wait_for_inclusion=wait_for_inclusion,
+                raise_error=raise_error,
             )
         else:
-            decrease_take_extrinsic(
+            success, error = decrease_take_extrinsic(
                 self,
                 wallet,
                 hotkey_ss58,
                 take_u16,
                 wait_for_finalization=wait_for_finalization,
                 wait_for_inclusion=wait_for_inclusion,
+                raise_error=raise_error,
             )
 
-        logging.info(":white_heavy_check_mark: [green]Take Updated[/green]")
+        if success:
+            logging.info(":white_heavy_check_mark: [green]Take Updated[/green]")
+
+        return success, error
 
     def is_hotkey_delegate(self, hotkey_ss58: str, block: Optional[int] = None) -> bool:
         """

bittensor/utils/__init__.py

@@ -330,7 +330,11 @@ def validate_chain_endpoint(endpoint_url: str) -> tuple[bool, str]:
     return True, ""
 
 
-def unlock_key(wallet: "Wallet", unlock_type="coldkey") -> "UnlockStatus":
+def unlock_key(
+    wallet: "Wallet",
+    unlock_type="coldkey",
+    raise_error=False,
+) -> "UnlockStatus":
     """
     Attempts to decrypt a wallet's coldkey or hotkey
     Args:
@@ -350,9 +354,15 @@ def unlock_key(wallet: "Wallet", unlock_type="coldkey") -> "UnlockStatus":
         getattr(wallet, unlocker)()
         return UnlockStatus(True, "")
     except PasswordError:
+        if raise_error:
+            raise
+
         err_msg = f"The password used to decrypt your {unlock_type.capitalize()} keyfile is invalid."
         return UnlockStatus(False, err_msg)
     except KeyFileError:
+        if raise_error:
+            raise
+
         err_msg = f"{unlock_type.capitalize()} keyfile is corrupt, non-writable, or non-readable, or non-existent."
         return UnlockStatus(False, err_msg)
 

tests/e2e_tests/test_delegate.py

@@ -91,6 +91,7 @@ def test_change_take(local_chain, subtensor, alice_wallet, bob_wallet):
             alice_wallet,
             alice_wallet.hotkey.ss58_address,
             0.1,
+            raise_error=True,
         )
 
     subtensor.root_register(
@@ -108,19 +109,22 @@ def test_change_take(local_chain, subtensor, alice_wallet, bob_wallet):
             bob_wallet,
             alice_wallet.hotkey.ss58_address,
             0.1,
+            raise_error=True,
         )
 
     with pytest.raises(bittensor.DelegateTakeTooHigh):
         subtensor.set_delegate_take(
             alice_wallet,
             alice_wallet.hotkey.ss58_address,
             0.5,
+            raise_error=True,
         )
 
     subtensor.set_delegate_take(
         alice_wallet,
         alice_wallet.hotkey.ss58_address,
         0.1,
+        raise_error=True,
     )
 
     take = subtensor.get_delegate_take(alice_wallet.hotkey.ss58_address)
@@ -132,6 +136,7 @@ def test_change_take(local_chain, subtensor, alice_wallet, bob_wallet):
             alice_wallet,
             alice_wallet.hotkey.ss58_address,
             0.15,
+            raise_error=True,
         )
 
     take = subtensor.get_delegate_take(alice_wallet.hotkey.ss58_address)
@@ -151,6 +156,7 @@ def test_change_take(local_chain, subtensor, alice_wallet, bob_wallet):
         alice_wallet,
         alice_wallet.hotkey.ss58_address,
         0.15,
+        raise_error=True,
     )
 
     take = subtensor.get_delegate_take(alice_wallet.hotkey.ss58_address)