You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/sdk/subtensor-api.md
+55-29Lines changed: 55 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,20 +4,65 @@ title: Subtensor API
4
4
5
5
# Subtensor API
6
6
7
-
The SubtensorApi is a high-level, unified interface to interact with the Bittensor blockchain. It wraps both the synchronous and asynchronous Subtensor implementations, providing modular access to chain subsystems like wallets, delegates, neurons, and more.
7
+
8
+
## Overview
9
+
10
+
The SubtensorApi is a unified interface for the Bittensor blockchain. It wraps both the synchronous and asynchronous Subtensor implementations, providing modular access to chain subsystems like wallets, delegates, neurons, and more.
11
+
12
+
13
+
### Modules
14
+
15
+
All methods are grouped into logical modules for better organization and readability. Some methods may belong to more than one group if they span multiple functional areas. This does not compromise the internal logic — rather, it enhances discoverability and cohesion. Method equivalence between `SubtensorApi` and the original `Subtensor` is automatically verified by test coverage on every pull request (PR).
16
+
17
+
18
+
<details>
19
+
<summary>Subsystem modules</summary>
20
+
21
+
| Property | Description |
22
+
|----------|-------------|
23
+
| chain | Blockchain interaction methods |
24
+
| commitments | Commitment and reveal logic |
25
+
| delegates | Delegate management tools |
26
+
| extrinsics | Transaction construction and signing |
27
+
| metagraphs | Metagraph data and operations |
28
+
| neurons | Neuron-level APIs |
29
+
| queries | General query endpoints |
30
+
| staking | Staking operations |
31
+
| subnets | Subnet access and management |
32
+
| wallets | Wallet creation, import/export |
33
+
</details>
34
+
35
+
### Configuration
36
+
37
+
The behavior of the `SubtensorApi` object is configured with the following parameters.
38
+
<details>
39
+
<summary>Parameters</summary>
40
+
41
+
| Parameter | Type | Description | Default Value |
All methods are grouped into logical modules for better organization and readability. Some methods may belong to more than one group if they span multiple functional areas. This does not compromise the internal logic — rather, it enhances discoverability and cohesion. Method equivalence between `SubtensorApi` and the original `Subtensor` is automatically verified by test coverage on every pull request (PR).
91
-
92
-
The following properties are modular access points for specialized subsystems:
93
-
94
-
| Property | Description |
95
-
|----------|-------------|
96
-
| chain | Blockchain interaction methods |
97
-
| commitments | Commitment and reveal logic |
98
-
| delegates | Delegate management tools |
99
-
| extrinsics | Transaction construction and signing |
0 commit comments