[v10] Update and add new Markdown files#3095
Merged
Conversation
Closed
basfroman
changed the title
Markdown filesMarkdown files
chideraao
reviewed
Oct 13, 2025
| ### Method Renames | ||
| | Old Method | New Method | Notes | | ||
| |------------|------------|-------| | ||
| | `subtensor.get_subnets()` | `subtensor.get_all_subnets_netuid()` | More descriptive name | |
There was a problem hiding this comment.
what's the context of this method? looks like it should return all subnets but then what's the purpose of including the _netuid?
| | Old Method | New Method | Notes | | ||
| |------------|------------|-------| | ||
| | `subtensor.get_subnets()` | `subtensor.get_all_subnets_netuid()` | More descriptive name | | ||
| | `subtensor.get_stake_for_coldkey()` | `subtensor.get_stake_info_for_coldkey()` | Removed duplicate method | |
There was a problem hiding this comment.
how about subtensor.get_coldkey_stake_info()?
| | - | `from bittenosor import extrinsics` | Direct subpackage import | | ||
| | - | `from bittensor import mock` | Direct subpackage import | | ||
| | - | `from bittensor import get_async_subtensor` | Direct factory function import | | ||
| NOTE: **References to classes with non-capitalize names are no longer available in Bittensor SDK** |
There was a problem hiding this comment.
Suggested change
| NOTE: **References to classes with non-capitalize names are no longer available in Bittensor SDK** | |
| NOTE: **References to classes with non-capitalized names are no longer available from Bittensor SDK v10** |
| | - | `from bittensor import get_async_subtensor` | Direct factory function import | | ||
| NOTE: **References to classes with non-capitalize names are no longer available in Bittensor SDK** | ||
|
|
||
| ## Mechanisms related changes: |
There was a problem hiding this comment.
Suggested change
| ## Mechanisms related changes: | |
| Subnet mechanism–related changes |
| ### New Classes | ||
| - `bittensor.core.types.ExtrinsicResponse` - response for all extrinsics and related calls. | ||
| - `bittensor.core.types.BlockInfo` - result avalable from subtensor method `Async/Subtensor.get_block_info()`. Provides comprehensive information about a block in the blockchain, includes the link to block explorer on web service. | ||
| - `bittensor.core.errors.BalanceTypeError` - rises when expected amount of balance privided with wrong type data. |
There was a problem hiding this comment.
Suggested change
| - `bittensor.core.errors.BalanceTypeError` - rises when expected amount of balance privided with wrong type data. | |
| - `bittensor.core.errors.BalanceTypeError` - rises when the expected amount of balance is provided with wrong data type. |
| Now all stake operations fee is calculated with new `SimSwap` logic via `subtensor.sim_swap` method. Detailed logic you can find in class `bittensor.core.chain_data.sim_swap.SimSwapResult`. | ||
|
|
||
|
|
||
| ## Refined Logging Levels and Console Utilities |
There was a problem hiding this comment.
Suggested change
| ## Refined Logging Levels and Console Utilities | |
| ### Refined Logging Levels and Console Utilities |
| ``` | ||
| This design ensures that all logging remains both minimal by default and fully transparent on demand, depending on the user’s debugging needs. | ||
|
|
||
| ## Crowdloan implementation |
There was a problem hiding this comment.
Suggested change
| ## Crowdloan implementation | |
| ### Crowdloan implementation |
| ## Crowdloan implementation | ||
| The Crowdloan implementation is expected to be included in the final release of SDKv10. | ||
|
|
||
| ## Docstring Refactor and Standardization |
There was a problem hiding this comment.
Suggested change
| ## Docstring Refactor and Standardization | |
| ### Docstring Refactor and Standardization |
| A large-scale refactor has been applied to docstrings across the entire SDK to improve clarity, consistency, and technical accuracy. | ||
| Outdated or redundant descriptions have been removed, and all remaining docstrings were rewritten to follow a unified structure and terminology. | ||
|
|
||
| ## Resolution of TODOs |
There was a problem hiding this comment.
Suggested change
| ## Resolution of TODOs | |
| ### Resolution of TODOs |
| This cleanup improves overall maintainability, eliminates dead code paths, and ensures that every remaining comment in the SDK reflects active, intentional functionality rather than deferred work. | ||
| This update makes the inline documentation more transparent, readable, and aligned with current SDK behavior, ensuring developers can quickly understand method purposes, parameter semantics, and expected return types without referring to external sources. | ||
|
|
||
| ## Testing and Development Enhancements |
There was a problem hiding this comment.
Suggested change
| ## Testing and Development Enhancements | |
| ### Testing and Development Enhancements |
basfroman
added a commit
that referenced
this pull request
Oct 14, 2025
…-files [v10] Update and add new `Markdown` files
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
READMEBREAKING_CHANGES_v10.mdNEW_FEATURES.mdMIGRATION_DRAFT.mdEventually, the docs directory will be deleted, and all data will be presented in the migration guide at https://docs.learnbittensor.org/