Merge branch 'staging' into feat/thewhaleking/pyproject-toml

Author: basfroman

CHANGELOG.md

@@ -1,5 +1,84 @@
 # Changelog
 
+## 8.5.1 /2024-12-16
+
+## What's Changed
+* 8.5.0 bugfixes by @thewhaleking in https://github.com/opentensor/bittensor/pull/2541
+* Removes substrate call in format_error_message by @thewhaleking in https://github.com/opentensor/bittensor/pull/2542
+* Remove torch from the weights calls by @thewhaleking in https://github.com/opentensor/bittensor/pull/2543
+* optional arg fix by @thewhaleking in https://github.com/opentensor/bittensor/pull/2544
+* async cr3 not implemented by @thewhaleking in https://github.com/opentensor/bittensor/pull/2545
+* Backmerge master to staging 851 by @ibraheem-opentensor in https://github.com/opentensor/bittensor/pull/2546
+* Adds retry in CRv3 by @ibraheem-opentensor in https://github.com/opentensor/bittensor/pull/2547
+
+**Full Changelog**: https://github.com/opentensor/bittensor/compare/v8.5.0...v8.5.1
+
+## 8.5.0 /2024-12-12
+
+## What's Changed
+* add improved reveal-round params by @JohnReedV in https://github.com/opentensor/bittensor/pull/2509
+* fix: add default value to the get_block_number method in AsyncSubstrateInterface by @FLiotta in https://github.com/opentensor/bittensor/pull/2529
+* Mismatched "archive" index by @thewhaleking in https://github.com/opentensor/bittensor/pull/2530
+* Adds a factory function to create an initialised AsyncSubtensor object. by @thewhaleking in https://github.com/opentensor/bittensor/pull/2516
+* chore: fix some comments by @lvyaoting in https://github.com/opentensor/bittensor/pull/2515
+* Fixes E2E test chain buffer issues on devnet by @ibraheem-opentensor in https://github.com/opentensor/bittensor/pull/2531
+* Added e2e test for CRv3 + enhancements by @ibraheem-opentensor in https://github.com/opentensor/bittensor/pull/2532
+* Backmerge master to staging 850 by @ibraheem-opentensor in https://github.com/opentensor/bittensor/pull/2535
+* Enhancement/adds total stake functions by @ibraheem-opentensor in https://github.com/opentensor/bittensor/pull/2537
+* Fixes get_current_block by @thewhaleking in https://github.com/opentensor/bittensor/pull/2536
+* [SDK] Add `commit reveal v3` logic (python part only) by @roman-opentensor in https://github.com/opentensor/bittensor/pull/2484
+
+## New Contributors
+* @JohnReedV made their first contribution in https://github.com/opentensor/bittensor/pull/2509
+* @FLiotta made their first contribution in https://github.com/opentensor/bittensor/pull/2529
+* @lvyaoting made their first contribution in https://github.com/opentensor/bittensor/pull/2515
+
+**Full Changelog**: https://github.com/opentensor/bittensor/compare/v8.4.5...v8.5.0
+
+## 8.4.5 /2024-12-05
+
+## What's Changed
+* Overrides copy and deep copy for the metagraph by @ibraheem-opentensor in https://github.com/opentensor/bittensor/pull/2523
+
+**Full Changelog**: https://github.com/opentensor/bittensor/compare/v8.4.4...v8.4.5
+
+## 8.4.4 /2024-12-05
+
+## What's Changed
+* Removes the call that automatically sets everything to warning level debugging by @thewhaleking in https://github.com/opentensor/bittensor/pull/2508
+* Exit `set_weights` on success by @thewhaleking in https://github.com/opentensor/bittensor/pull/2511
+* `test_dendrite` test clean up by @thewhaleking in https://github.com/opentensor/bittensor/pull/2512
+* Adds --logging.info level so it can be set @ibraheem-opentensor in https://github.com/opentensor/bittensor/pull/2510
+* Allows wallet to be created through configs in the axon if it is provided by @ibraheem-opentensor in https://github.com/opentensor/bittensor/pull/2510
+* Changes verbosity level of ClientConnectorError and TimeoutError in the dendrite to debug by @ibraheem-opentensor in https://github.com/opentensor/bittensor/pull/2510
+* Fixes behaviour of config initialization for axon, subtensor, logging and threadpool by @ibraheem-opentensor in https://github.com/opentensor/bittensor/pull/2510
+* metagraph sync fix by @thewhaleking in https://github.com/opentensor/bittensor/pull/2514
+* Remove metadata retrieval of custom errors from format_error_message by @thewhaleking in https://github.com/opentensor/bittensor/pull/2518
+* Backmerge master to staging for 8.4.4 by @ibraheem-opentensor in https://github.com/opentensor/bittensor/pull/2519
+* Updates bt-decode to 0.4.0 by @ibraheem-opentensor in https://github.com/opentensor/bittensor/pull/2520
+
+**Full Changelog**: https://github.com/opentensor/bittensor/compare/v8.4.3...v8.4.4
+
+## 8.4.3 /2024-12-02
+
+## What's Changed
+
+* Fix logging config parsing by @ibraheem-opentensor in https://github.com/opentensor/bittensor/pull/2500
+* Improve  `submit_extrinsic` util by @thewhaleking in https://github.com/opentensor/bittensor/pull/2502
+* Backmerge master to staging for 843 by @ibraheem-opentensor in https://github.com/opentensor/bittensor/pull/2505
+* WS ensure_connected socket catch by @thewhaleking in https://github.com/opentensor/bittensor/pull/2507
+
+**Full Changelog**: https://github.com/opentensor/bittensor/compare/v8.4.2...v8.4.3
+
+## 8.4.2 /2024-11-28
+
+## What's Changed
+
+* Fix submit_extrinsic timeout by @thewhaleking in https://github.com/opentensor/bittensor/pull/2497
+* Backmerge master to staging for 841 by @ibraheem-opentensor in https://github.com/opentensor/bittensor/pull/2498
+
+**Full Changelog**: https://github.com/opentensor/bittensor/compare/v8.4.1...v8.4.2
+
 ## 8.4.1 /2024-11-27
 
 ## What's Changed

VERSION

@@ -1 +1 @@
-8.4.1
+8.5.1

bittensor/__init__.py

@@ -17,11 +17,20 @@
 
 import warnings
 
-from .core.settings import __version__, version_split, DEFAULTS
+from .core.settings import __version__, version_split, DEFAULTS, DEFAULT_NETWORK
+from .core.async_subtensor import AsyncSubtensor
 from .utils.btlogging import logging
 from .utils.deprecated import *
 
 
+async def async_subtensor(network: str = DEFAULT_NETWORK) -> AsyncSubtensor:
+    """
+    Creates an initialised AsyncSubtensor object.
+    """
+    async with AsyncSubtensor(network=network) as subtensor_:
+        return subtensor_
+
+
 def __getattr__(name):
     if name == "version_split":
         warnings.warn(

bittensor/core/async_subtensor.py

@@ -22,6 +22,7 @@
     SubnetHyperparameters,
     decode_account_id,
 )
+from bittensor.core.extrinsics.async_commit_reveal import commit_reveal_v3_extrinsic
 from bittensor.core.extrinsics.async_registration import register_extrinsic
 from bittensor.core.extrinsics.async_root import (
     set_root_weights_extrinsic,
@@ -236,7 +237,7 @@ async def get_current_block(self) -> int:
 
         Knowing the current block number is essential for querying real-time data and performing time-sensitive operations on the blockchain. It serves as a reference point for network activities and data synchronization.
         """
-        return await self.substrate.get_block_number()
+        return await self.substrate.get_block_number(None)
 
     async def get_block_hash(self, block_id: Optional[int] = None):
         """
@@ -1184,11 +1185,9 @@ async def sign_and_send_extrinsic(
             if await response.is_success:
                 return True, ""
             else:
-                return False, format_error_message(
-                    await response.error_message, substrate=self.substrate
-                )
+                return False, format_error_message(await response.error_message)
         except SubstrateRequestException as e:
-            return False, format_error_message(e, substrate=self.substrate)
+            return False, format_error_message(e)
 
     async def get_children(self, hotkey: str, netuid: int) -> tuple[bool, list, str]:
         """
@@ -1218,7 +1217,7 @@ async def get_children(self, hotkey: str, netuid: int) -> tuple[bool, list, str]
             else:
                 return True, [], ""
         except SubstrateRequestException as e:
-            return False, [], format_error_message(e, self.substrate)
+            return False, [], format_error_message(e)
 
     async def get_subnet_hyperparameters(
         self, netuid: int, block_hash: Optional[str] = None, reuse_block: bool = False
@@ -1429,6 +1428,34 @@ async def blocks_since_last_update(self, netuid: int, uid: int) -> Optional[int]
         call = await self.get_hyperparameter(param_name="LastUpdate", netuid=netuid)
         return None if call is None else await self.get_current_block() - int(call[uid])
 
+    async def commit_reveal_enabled(
+        self, netuid: int, block_hash: Optional[str] = None
+    ) -> bool:
+        """
+        Check if commit-reveal mechanism is enabled for a given network at a specific block.
+
+        Arguments:
+            netuid (int): The network identifier for which to check the commit-reveal mechanism.
+            block_hash (Optional[str]): The block hash of block at which to check the parameter (default is None, which implies the current block).
+
+        Returns:
+            (bool): Returns the integer value of the hyperparameter if available; otherwise, returns None.
+        """
+        call = await self.get_hyperparameter(
+            param_name="CommitRevealWeightsEnabled",
+            block_hash=block_hash,
+            netuid=netuid,
+        )
+        return True if call is True else False
+
+    async def get_subnet_reveal_period_epochs(
+        self, netuid: int, block_hash: Optional[str] = None
+    ) -> int:
+        """Retrieve the SubnetRevealPeriodEpochs hyperparameter."""
+        return await self.get_hyperparameter(
+            param_name="RevealPeriodEpochs", block_hash=block_hash, netuid=netuid
+        )
+
     # Extrinsics =======================================================================================================
 
     async def transfer(
@@ -1570,20 +1597,31 @@ async def set_weights(
 
         This function is crucial in shaping the network's collective intelligence, where each neuron's learning and contribution are influenced by the weights it sets towards others【81†source】.
         """
-        uid = await self.get_uid_for_hotkey_on_subnet(
-            wallet.hotkey.ss58_address, netuid
-        )
         retries = 0
         success = False
-        message = "No attempt made. Perhaps it is too soon to set weights!"
-        while retries < max_retries and await self.blocks_since_last_update(
-            netuid, uid
-        ) > await self.weights_rate_limit(netuid):
-            try:
+        if (
+            uid := await self.get_uid_for_hotkey_on_subnet(
+                wallet.hotkey.ss58_address, netuid
+            )
+        ) is None:
+            return (
+                False,
+                f"Hotkey {wallet.hotkey.ss58_address} not registered in subnet {netuid}",
+            )
+
+        if (await self.commit_reveal_enabled(netuid=netuid)) is True:
+            # go with `commit reveal v3` extrinsic
+            message = "No attempt made. Perhaps it is too soon to commit weights!"
+            while (
+                await self.blocks_since_last_update(netuid, uid)
+                > await self.weights_rate_limit(netuid)
+                and retries < max_retries
+                and success is False
+            ):
                 logging.info(
-                    f"Setting weights for subnet #[blue]{netuid}[/blue]. Attempt [blue]{retries + 1} of {max_retries}[/blue]."
+                    f"Committing weights for subnet #{netuid}. Attempt {retries + 1} of {max_retries}."
                 )
-                success, message = await set_weights_extrinsic(
+                success, message = await commit_reveal_v3_extrinsic(
                     subtensor=self,
                     wallet=wallet,
                     netuid=netuid,
@@ -1593,12 +1631,37 @@ async def set_weights(
                     wait_for_inclusion=wait_for_inclusion,
                     wait_for_finalization=wait_for_finalization,
                 )
-            except Exception as e:
-                logging.error(f"Error setting weights: {e}")
-            finally:
                 retries += 1
+            return success, message
+        else:
+            # go with classic `set weights extrinsic`
+            message = "No attempt made. Perhaps it is too soon to set weights!"
+            while (
+                retries < max_retries
+                and await self.blocks_since_last_update(netuid, uid)
+                > await self.weights_rate_limit(netuid)
+                and success is False
+            ):
+                try:
+                    logging.info(
+                        f"Setting weights for subnet #[blue]{netuid}[/blue]. Attempt [blue]{retries + 1} of {max_retries}[/blue]."
+                    )
+                    success, message = await set_weights_extrinsic(
+                        subtensor=self,
+                        wallet=wallet,
+                        netuid=netuid,
+                        uids=uids,
+                        weights=weights,
+                        version_key=version_key,
+                        wait_for_inclusion=wait_for_inclusion,
+                        wait_for_finalization=wait_for_finalization,
+                    )
+                except Exception as e:
+                    logging.error(f"Error setting weights: {e}")
+                finally:
+                    retries += 1
 
-        return success, message
+            return success, message
 
     async def root_set_weights(
         self,

bittensor/core/axon.py

@@ -341,7 +341,7 @@ def __init__(
         self.config = config  # type: ignore
 
         # Get wallet or use default.
-        self.wallet = wallet or Wallet()
+        self.wallet = wallet or Wallet(config=self.config)
 
         # Build axon objects.
         self.uuid = str(uuid.uuid1())
@@ -594,7 +594,7 @@ def config(cls) -> "Config":
         """
         parser = argparse.ArgumentParser()
         Axon.add_args(parser)  # Add specific axon-related arguments
-        return Config(parser, args=[])
+        return Config(parser)
 
     @classmethod
     def help(cls):

bittensor/core/dendrite.py

@@ -241,7 +241,10 @@ def log_exception(self, exception: Exception):
         """
         error_id = str(uuid.uuid4())
         error_type = exception.__class__.__name__
-        logging.error(f"{error_type}#{error_id}: {exception}")
+        if isinstance(exception, (aiohttp.ClientConnectorError, asyncio.TimeoutError)):
+            logging.debug(f"{error_type}#{error_id}: {exception}")
+        else:
+            logging.error(f"{error_type}#{error_id}: {exception}")
 
     def process_error_message(
         self,

bittensor/core/errors.py

@@ -17,10 +17,15 @@
 
 from __future__ import annotations
 
-from bittensor.core.synapse import Synapse
+from typing import Optional, TYPE_CHECKING
 
+from substrateinterface.exceptions import SubstrateRequestException
 
-class ChainError(BaseException):
+if TYPE_CHECKING:
+    from bittensor.core.synapse import Synapse
+
+
+class ChainError(SubstrateRequestException):
     """Base error for any chain related errors."""
 
 
@@ -81,7 +86,9 @@ class InvalidRequestNameError(Exception):
 
 
 class SynapseException(Exception):
-    def __init__(self, message="Synapse Exception", synapse: "Synapse" | None = None):
+    def __init__(
+        self, message="Synapse Exception", synapse: Optional["Synapse"] = None
+    ):
         self.message = message
         self.synapse = synapse
         super().__init__(self.message)
@@ -123,7 +130,7 @@ class SynapseDendriteNoneException(SynapseException):
     def __init__(
         self,
         message="Synapse Dendrite is None",
-        synapse: "Synapse" | None = None,
+        synapse: Optional["Synapse"] = None,
     ):
         self.message = message
         super().__init__(self.message, synapse)