Merge pull request #3076 from opentensor/feat/roman/mechid-related-changes

[v10] `mechid` related changes

Author: basfroman

MIGRATION.md

@@ -234,3 +234,20 @@ Removing deprecated extrinsics and replacing them with consistent ones:
 - method `query_map_subtensor` has updated parameters order.
 - method `query_map` has updated parameters order.
 - method `add_stake_multiple` has updated parameters order.
+
+### Mechid related changes:
+In the next subtensor methods got updated the parameters order:
+  - `bonds`
+  - `get_metagraph_info`
+  - `get_timelocked_weight_commits`
+  - `metagraph`
+  - `weights`
+  - `commit_weights`
+  - `reveal_weights`
+  - `set_weights`
+
+Additional:
+  - `bittensor.core.chain_data.metagraph_info.MetagraphInfo` got required attribute `mechid: int`.
+
+### Renames parameters:
+- `get_metagraph_info`: `field_indices` -> `selected_indices` (to be consistent)

bittensor/core/async_subtensor.py

@@ -869,10 +869,10 @@ async def blocks_since_last_update(self, netuid: int, uid: int) -> Optional[int]
     async def bonds(
         self,
         netuid: int,
+        mechid: int = 0,
         block: Optional[int] = None,
         block_hash: Optional[str] = None,
         reuse_block: bool = False,
-        mechid: int = 0,
     ) -> list[tuple[int, list[tuple[int, int]]]]:
         """Retrieves the bond distribution set by subnet validators within a specific subnet.
 
@@ -882,10 +882,10 @@ async def bonds(
 
         Parameters:
             netuid: Subnet identifier.
+            mechid: Subnet mechanism identifier.
             block: The block number for this query. Do not specify if using block_hash or reuse_block.
             block_hash: The hash of the block for the query. Do not specify if using reuse_block or block.
             reuse_block: Whether to reuse the last-used block hash. Do not set if using block_hash or block.
-            mechid: Subnet mechanism identifier.
 
         Returns:
             List of tuples mapping each neuron's UID to its bonds with other neurons.
@@ -1921,15 +1921,16 @@ async def get_minimum_required_stake(self):
 
         return Balance.from_rao(getattr(result, "value", 0))
 
-    # TODO: update parameters order in SDKv10, rename `field_indices` to `selected_indices`
     async def get_metagraph_info(
         self,
         netuid: int,
-        field_indices: Optional[Union[list[SelectiveMetagraphIndex], list[int]]] = None,
+        mechid: int = 0,
+        selected_indices: Optional[
+            Union[list[SelectiveMetagraphIndex], list[int]]
+        ] = None,
         block: Optional[int] = None,
         block_hash: Optional[str] = None,
         reuse_block: bool = False,
-        mechid: int = 0,
     ) -> Optional[MetagraphInfo]:
         """
         Retrieves full or partial metagraph information for the specified subnet (netuid).
@@ -1940,7 +1941,7 @@ async def get_metagraph_info(
 
         Parameters:
             netuid: The unique identifier of the subnet to query.
-            field_indices: Optional list of SelectiveMetagraphIndex or int values specifying which fields to retrieve.
+            selected_indices: Optional list of SelectiveMetagraphIndex or int values specifying which fields to retrieve.
                 If not provided, all available fields will be returned.
             block: The blockchain block number for the query.
             block_hash: The hash of the blockchain block number at which to perform the query.
@@ -1960,14 +1961,14 @@ async def get_metagraph_info(
             # Retrieve selective data from the metagraph from subnet 2 mechanism 0
             partial_meta_info = subtensor.get_metagraph_info(
                 netuid=2,
-                field_indices=[SelectiveMetagraphIndex.Name, SelectiveMetagraphIndex.OwnerHotkeys]
+                selected_indices=[SelectiveMetagraphIndex.Name, SelectiveMetagraphIndex.OwnerHotkeys]
             )
 
             # Retrieve selective data from the metagraph from subnet 2 mechanism 1
             partial_meta_info = subtensor.get_metagraph_info(
                 netuid=2,
                 mechid=1,
-                field_indices=[SelectiveMetagraphIndex.Name, SelectiveMetagraphIndex.OwnerHotkeys]
+                selected_indices=[SelectiveMetagraphIndex.Name, SelectiveMetagraphIndex.OwnerHotkeys]
             )
 
         Notes:
@@ -1982,9 +1983,9 @@ async def get_metagraph_info(
         indexes = (
             [
                 f.value if isinstance(f, SelectiveMetagraphIndex) else f
-                for f in field_indices
+                for f in selected_indices
             ]
-            if field_indices is not None
+            if selected_indices is not None
             else [f for f in range(len(SelectiveMetagraphIndex))]
         )
 
@@ -2695,24 +2696,23 @@ async def get_subnet_prices(
         prices.update({0: Balance.from_tao(1)})
         return prices
 
-    # TODO: update order in SDKv10
     async def get_timelocked_weight_commits(
         self,
         netuid: int,
+        mechid: int = 0,
         block: Optional[int] = None,
         block_hash: Optional[str] = None,
         reuse_block: bool = False,
-        mechid: int = 0,
     ) -> list[tuple[str, int, str, int]]:
         """
         Retrieves CRv4 weight commit information for a specific subnet.
 
         Parameters:
             netuid: Subnet identifier.
-            block (Optional[int]): The blockchain block number for the query.
+            mechid: Subnet mechanism identifier.
+            block: The blockchain block number for the query.
             block_hash: The hash of the block to retrieve the stake from. Do not specify if using block or reuse_block.
             reuse_block: Whether to use the last-used block. Do not set if using block_hash or block.
-            mechid: Subnet mechanism identifier.
 
         Returns:
             A list of commit details, where each item contains:
@@ -3539,23 +3539,22 @@ async def max_weight_limit(
         )
         return None if call is None else u16_normalized_float(int(call))
 
-    # TODO: update parameters order in SDKv10
     async def metagraph(
         self,
         netuid: int,
+        mechid: int = 0,
         lite: bool = True,
         block: Optional[int] = None,
-        mechid: int = 0,
     ) -> "AsyncMetagraph":
         """
         Returns a synced metagraph for a specified subnet within the Bittensor network.
         The metagraph represents the network's structure, including neuron connections and interactions.
 
         Parameters:
             netuid: The network UID of the subnet to query.
+            mechid: Subnet mechanism identifier.
             lite: If true, returns a metagraph using a lightweight sync (no weights, no bonds).
             block: Block number for synchronization, or `None` for the latest block.
-            mechid: Subnet mechanism identifier.
 
         Returns:
             The metagraph representing the subnet's structure and neuron relationships.
@@ -4007,14 +4006,13 @@ async def handler(block_data: dict):
         )
         return True
 
-    # TODO: update order in SDKv10
     async def weights(
         self,
         netuid: int,
+        mechid: int = 0,
         block: Optional[int] = None,
         block_hash: Optional[str] = None,
         reuse_block: bool = False,
-        mechid: int = 0,
     ) -> list[tuple[int, list[tuple[int, int]]]]:
         """
         Retrieves the weight distribution set by neurons within a specific subnet of the Bittensor network.
@@ -4463,13 +4461,13 @@ async def commit_weights(
         salt: Salt,
         uids: UIDs,
         weights: Weights,
+        mechid: int = 0,
         version_key: int = version_as_int,
         max_retries: int = 5,
         period: Optional[int] = 16,
         raise_error: bool = True,
         wait_for_inclusion: bool = False,
         wait_for_finalization: bool = False,
-        mechid: int = 0,
     ) -> ExtrinsicResponse:
         """
         Commits a hash of the subnet validator's weight vector to the Bittensor blockchain using the provided wallet.
@@ -4481,6 +4479,7 @@ async def commit_weights(
             salt: list of randomly generated integers as salt to generated weighted hash.
             uids: NumPy array of neuron UIDs for which weights are being committed.
             weights: NumPy array of weight values corresponding to each UID.
+            mechid: The subnet mechanism unique identifier.
             version_key: Version key for compatibility with the network.
             max_retries: The number of maximum attempts to commit weights.
             period: The number of blocks during which the transaction will remain valid after it's submitted. If
@@ -4489,7 +4488,6 @@ async def commit_weights(
             raise_error: Raises a relevant exception rather than returning `False` if unsuccessful.
             wait_for_inclusion: Whether to wait for the extrinsic to be included in a block.
             wait_for_finalization: Whether to wait for finalization of the extrinsic.
-            mechid: The subnet mechanism unique identifier.
 
         Returns:
             ExtrinsicResponse: The result object of the extrinsic execution.
@@ -4810,13 +4808,13 @@ async def reveal_weights(
         uids: UIDs,
         weights: Weights,
         salt: Salt,
+        mechid: int = 0,
         max_retries: int = 5,
         version_key: int = version_as_int,
         period: Optional[int] = 16,
         raise_error: bool = False,
         wait_for_inclusion: bool = True,
         wait_for_finalization: bool = True,
-        mechid: int = 0,
     ) -> ExtrinsicResponse:
         """
         Reveals the weights for a specific subnet on the Bittensor blockchain using the provided wallet.
@@ -4828,6 +4826,7 @@ async def reveal_weights(
             uids: NumPy array of neuron UIDs for which weights are being revealed.
             weights: NumPy array of weight values corresponding to each UID.
             salt: NumPy array of salt values corresponding to the hash function.
+            mechid: The subnet mechanism unique identifier.
             max_retries: The number of maximum attempts to reveal weights.
             version_key: Version key for compatibility with the network.
             period: The number of blocks during which the transaction will remain valid after it's submitted. If the
@@ -4836,7 +4835,6 @@ async def reveal_weights(
             raise_error: Raises a relevant exception rather than returning `False` if unsuccessful.
             wait_for_inclusion: Waits for the transaction to be included in a block.
             wait_for_finalization: Waits for the transaction to be finalized on the blockchain.
-            mechid: The subnet mechanism unique identifier.
 
         Returns:
             ExtrinsicResponse: The result object of the extrinsic execution.
@@ -5122,6 +5120,7 @@ async def set_weights(
         netuid: int,
         uids: UIDs,
         weights: Weights,
+        mechid: int = 0,
         block_time: float = 12.0,
         commit_reveal_version: int = 4,
         max_retries: int = 5,
@@ -5130,7 +5129,6 @@ async def set_weights(
         raise_error: bool = False,
         wait_for_inclusion: bool = True,
         wait_for_finalization: bool = True,
-        mechid: int = 0,
     ) -> ExtrinsicResponse:
         """
         Sets the weight vector for a neuron acting as a validator, specifying the weights assigned to subnet miners
@@ -5146,6 +5144,7 @@ async def set_weights(
             uids: The list of subnet miner neuron UIDs that the weights are being set for.
             weights: The corresponding weights to be set for each UID, representing the validator's evaluation of each
                 miner's performance.
+            mechid: The subnet mechanism unique identifier.
             block_time: The number of seconds for block duration.
             commit_reveal_version: The version of the chain commit-reveal protocol to use.
             max_retries: The number of maximum attempts to set weights.
@@ -5156,7 +5155,6 @@ async def set_weights(
             raise_error: Raises a relevant exception rather than returning `False` if unsuccessful.
             wait_for_inclusion: Waits for the transaction to be included in a block.
             wait_for_finalization: Waits for the transaction to be finalized on the blockchain.
-            mechid: The subnet mechanism unique identifier.
 
         Returns:
             ExtrinsicResponse: The result object of the extrinsic execution.

bittensor/core/chain_data/metagraph_info.py

@@ -70,6 +70,7 @@ def process_nested(
 class MetagraphInfo(InfoBase):
     # Subnet index
     netuid: int
+    mechid: int
 
     # Name and symbol
     name: str
@@ -173,8 +174,6 @@ class MetagraphInfo(InfoBase):
 
     commitments: Optional[tuple[tuple[str, str]]]
 
-    mechid: int = 0
-
     @classmethod
     def _from_dict(cls, decoded: dict) -> "MetagraphInfo":
         """Returns a MetagraphInfo object from decoded chain data."""