diff --git a/docs/btcli/btcli-permissions.md b/docs/btcli/btcli-permissions.md index 667481dff..5d986ad45 100644 --- a/docs/btcli/btcli-permissions.md +++ b/docs/btcli/btcli-permissions.md @@ -111,15 +111,11 @@ See: [Coldkey and Hotkey Workstation Security](../keys/coldkey-hotkey-security) - `btcli config get` - `btcli config clear` - `btcli config metagraph` -- `btcli conf set` -- `btcli conf get` -- `btcli conf clear` -- `btcli conf metagraph` - -- `btcli c set` -- `btcli c get` -- `btcli c clear` -- `btcli c metagraph` +- `btcli config add-proxy` +- `btcli config proxies` +- `btcli config remove-proxy` +- `btcli config update-proxy` +- `btcli config clear-proxy` ### `wallet` @@ -144,14 +140,21 @@ See: [Coldkey and Hotkey Workstation Security](../keys/coldkey-hotkey-security) 1. **`regen hotkey`** is used to initialize a hotkey workstation using a pre-existing wallet's _seed phrase_. This is a high security risk operation due to the inherent risk of handling the seed phrase. +1. **`btcli wallet create`** is used to initialize a new coldkey and hotkey workstation with new seed phrases for both. This is a high security risk operation due to the inherent risk of handling the seed phrase. + +1. **`btcli wallet associate-hotkey`** is used to associate a hotkey with a coldkey on chain. + #### Permissionless operations - **`btcli wallet balance`**: Displays a wallet balance. - **`btcli wallet overview`**: Displays a wallet overview. +- **`btcli wallet list`**: Displays all the wallets and their corresponding hotkeys that are located in the wallet path. #### Operations requiring coldkey private key: - **`swap-hotkey`** rotates a hotkey coldkey owned by the coldkey. +- **`swap-coldkey`** announces and executes a coldkey swap to transfer assets on the coldkey to the destination coldkey. +- **`swap-check`** checks to see if a coldkey has an existing swap announcement. - **`new-hotkey`** creates a new hotkey owned by the coldkey. - **`transfer`** transfers TAO to another coldkey. - **`set-identity`** sets the coldkey's public identity information. @@ -160,16 +163,23 @@ See: [Coldkey and Hotkey Workstation Security](../keys/coldkey-hotkey-security) #### Operations requiring hotkey private key: - **`sign`** (with hotkey): sign a message with the hotkey +- **`verify`**: Verify a message signature using the signer's public key or SS58 address
`btcli wallet` #### `btcli wallet list` #### `btcli wallet swap-hotkey` +#### `btcli wallet swap-coldkey announce` +#### `btcli wallet swap-coldkey execute` +#### `btcli wallet swap-coldkey dispute` +#### `btcli wallet swap-check` #### `btcli wallet regen-coldkey` #### `btcli wallet regen-coldkeypub` #### `btcli wallet regen-hotkey` +#### `btcli wallet regen-hotkeypub` #### `btcli wallet new-hotkey` #### `btcli wallet new-coldkey` +#### `btcli wallet associate-hotkey` #### `btcli wallet create` #### `btcli wallet balance` #### `btcli wallet overview` @@ -178,108 +188,7 @@ See: [Coldkey and Hotkey Workstation Security](../keys/coldkey-hotkey-security) #### `btcli wallet set-identity` #### `btcli wallet get-identity` #### `btcli wallet sign` -#### `btcli wallet swap_hotkey` -#### `btcli wallet regen_coldkey` -#### `btcli wallet regen_coldkeypub` -#### `btcli wallet regen_hotkey` -#### `btcli wallet new_hotkey` -#### `btcli wallet new_coldkey` -#### `btcli wallet set_identity` -#### `btcli wallet get_identity` - -#### `btcli w list` - -#### `btcli w swap-hotkey` - -#### `btcli w regen-coldkey` - -#### `btcli w regen-coldkeypub` - -#### `btcli w regen-hotkey` - -#### `btcli w new-hotkey` - -#### `btcli w new-coldkey` - -#### `btcli w create` - -#### `btcli w balance` - -#### `btcli w overview` - -#### `btcli w transfer` - -#### `btcli w inspect` - -#### `btcli w set-identity` - -#### `btcli w get-identity` - -#### `btcli w sign` - -#### `btcli w swap_hotkey` - -#### `btcli w regen_coldkey` - -#### `btcli w regen_coldkeypub` - -#### `btcli w regen_hotkey` - -#### `btcli w new_hotkey` - -#### `btcli w new_coldkey` - -#### `btcli w set_identity` - -#### `btcli w get_identity` - -#### `btcli wallets list` - -#### `btcli wallets swap-hotkey` - -#### `btcli wallets regen-coldkey` - -#### `btcli wallets regen-coldkeypub` - -#### `btcli wallets regen-hotkey` - -#### `btcli wallets new-hotkey` - -#### `btcli wallets new-coldkey` - -#### `btcli wallets create` - -#### `btcli wallets balance` - -#### `btcli wallets history` - -#### `btcli wallets overview` - -#### `btcli wallets transfer` - -#### `btcli wallets inspect` - -#### `btcli wallets set-identity` - -#### `btcli wallets get-identity` - -#### `btcli wallets sign` - -#### `btcli wallets swap_hotkey` - -#### `btcli wallets regen_coldkey` - -#### `btcli wallets regen_coldkeypub` - -#### `btcli wallets regen_hotkey` - -#### `btcli wallets new_hotkey` - -#### `btcli wallets new_coldkey` - -#### `btcli wallets set_identity` - -#### `btcli wallets get_identity` +#### `btcli wallet verify`
@@ -295,36 +204,21 @@ See: [Coldkey and Hotkey Workstation Security](../keys/coldkey-hotkey-security) btcli stake #### `btcli stake add` #### `btcli stake remove` +#### `btcli stake auto` +#### `btcli stake set-auto` #### `btcli stake list` #### `btcli stake move` #### `btcli stake transfer` #### `btcli stake swap` +#### `btcli stake wizard` #### `btcli stake child` ##### `btcli stake child get` ##### `btcli stake child set` ##### `btcli stake child revoke` ##### `btcli stake child take` -#### `btcli stake children` -##### `btcli stake children get` -##### `btcli stake children set` -##### `btcli stake children revoke` -##### `btcli stake children take` -#### `btcli st add` -#### `btcli st remove` -#### `btcli st list` -#### `btcli st move` -#### `btcli st transfer` -#### `btcli st swap` -#### `btcli st child` -##### `btcli st child get` -##### `btcli st child set` -##### `btcli st child revoke` -##### `btcli st child take` -#### `btcli st children` -##### `btcli st children get` -##### `btcli st children set` -##### `btcli st children revoke` -##### `btcli st children take` +#### `btcli stake set-claim` +#### `btcli stake process-claim` + ### `sudo` @@ -339,6 +233,7 @@ See: [Coldkey and Hotkey Workstation Security](../keys/coldkey-hotkey-security) #### Write commands (require coldkey) - **`set`** sets the hyperparameters for a subnet (requires the coldkey of the subnet creator). +- **`trim`** sets the maximum number of UIDs on a subnet (requires the coldkey of the subnet creator). - **`set-take`** sets the validator take for a validator (requires the validator's coldkey). - **`senate-vote`** votes on a proposal before the senate (requres a coldkey with senate permissions). @@ -346,32 +241,12 @@ See: [Coldkey and Hotkey Workstation Security](../keys/coldkey-hotkey-security) `btcli sudo` #### `btcli sudo set` #### `btcli sudo get` +#### `btcli sudo trim` #### `btcli sudo senate` #### `btcli sudo proposals` #### `btcli sudo senate-vote` #### `btcli sudo set-take` #### `btcli sudo get-take` -#### `btcli sudo senate_vote` -#### `btcli sudo get_take` -#### `btcli sudo set_take` -#### `btcli su set` -#### `btcli su get` - -#### `btcli su senate` - -#### `btcli su proposals` - -#### `btcli su senate-vote` - -#### `btcli su set-take` - -#### `btcli su get-take` - -#### `btcli su senate_vote` - -#### `btcli su get_take` - -#### `btcli su set_take` @@ -383,20 +258,29 @@ See: [Coldkey and Hotkey Workstation Security](../keys/coldkey-hotkey-security) - **`show` alias `metagraph`** displays info about miner and validator activity on the subnet. - **`hyperparameters`** shows configuration of a specific subnet. - **`price`** displays a graph of alpha token prices of subnets over time. -- **`burn_cost`** shows current fee to create subnet. +- **`burn-cost`** shows current fee to create subnet. +- **`check-start`** checks if a subnet's emission schedule can be started. +- **`get-identity`** retrieves on-chain identity for a given subnet. +- **`mechanisms count`** shows how many mechanisms are registered under a subnet. +- **`mechanisms emissions`** display the current emission split across mechanisms for a subnet. #### Write commands (require coldkey) - **`create`**: Create a subnet (requires burn fee) - **`register/pow-register`**: Register a UID for the hotkey on a given subnet +- **`start`**: Starts a subnet's emission schedule +- **`set-identity`**: Sets on-chain identity for a given subnet. +- **`set-symbol`**: Sets on-chain symbol for a given subnet. +- **`mechanisms set`**: Configures how many mechanisms are registered for a subnet. +- **`mechanisms split-emissions`**: Updates the emission split across mechanisms for a subnet. :::tip -hyperparams are set with `btcli sudo`. +Subnet hyperparameters are set with `btcli sudo set`. ::: -Creating subnets requires a coldkey with sufficient balance. +Creating subnets requires a coldkey with sufficient balance to cover burn costs. -Miner and validator registering a hotkey uses a coldkey, has a TAO cost unless proof-of-work + @@ -411,30 +295,11 @@ Miner and validator registering a hotkey uses a coldkey, has a TAO cost unless p #### `btcli subnets metagraph` #### `btcli subnets show` #### `btcli subnets price` -#### `btcli subnets burn_cost` -#### `btcli subnets pow_register` -#### `btcli s hyperparameters` -#### `btcli s list` -#### `btcli s burn-cost` -#### `btcli s create` -#### `btcli s pow-register` -#### `btcli s register` -#### `btcli s metagraph` -#### `btcli s show` -#### `btcli s price` -#### `btcli s burn_cost` -#### `btcli s pow_register` -#### `btcli subnet hyperparameters` -#### `btcli subnet list` -#### `btcli subnet burn-cost` -#### `btcli subnet create` -#### `btcli subnet pow-register` -#### `btcli subnet register` -#### `btcli subnet metagraph` -#### `btcli subnet show` -#### `btcli subnet price` -#### `btcli subnet burn_cost` -#### `btcli subnet pow_register` +#### `btcli subnets check-start` +#### `btcli subnets start` +#### `btcli subnets get-identity` +#### `btcli subnets set-identity` +#### `btcli subnets set-symbol` @@ -449,14 +314,6 @@ To set weights with `commit`, a validator must meet several requirements. See [R #### `btcli weights reveal` #### `btcli weights commit` -#### `btcli wt reveal` - -#### `btcli wt commit` - -#### `btcli weight reveal` - -#### `btcli weight commit` - ### `proxy` @@ -480,14 +337,16 @@ There are no read-only proxy commands in btcli. To view proxies associated with :::tip Address book management The `btcli config` commands provide convenient local address book management for proxies: + - `btcli config add-proxy` - Save a proxy to your local address book - `btcli config proxies` - List all proxies in your address book - `btcli config remove-proxy` - Remove a proxy from your address book (local only, does not affect on-chain state) - `btcli config update-proxy` - Update a proxy entry in your address book -::: + ::: :::info Using proxies with other commands Many btcli commands support the `--proxy` flag, allowing you to execute operations through a proxy account. You can specify either: + - The proxy's SS58 address directly: `--proxy 5ABC...` - The proxy's name from your address book: `--proxy my-staking-proxy` @@ -500,15 +359,26 @@ See also: [Proxies Documentation](../keys/proxies/) `btcli proxy` #### `btcli proxy create` + #### `btcli proxy add` + #### `btcli proxy remove` + #### `btcli proxy kill` + #### `btcli proxy execute` ### `utils` +- `btcli utils convert` is a convenience command for performing conversions between minimal units (RAO) and TAO, or other chain-specific conversions. It is permissionless (no key required) because it performs no on-chain operation, just a local calculation. +- `btcli utils latency` returns the latency of all finney-like nodes. You can also view latency on additional networks by using the `--network` flag. +
+ `btcli utils` + #### `btcli utils convert` -`btcli utils convert` is a convenience command for performing conversions between minimal units (RAO) and TAO, or other chain-specific conversions. It is permissionless (no key required) because it performs no on-chain operation, just a local calculation. +#### `btcli utils latency` + +
diff --git a/docs/btcli/btcli.md b/docs/btcli/btcli.md index ae6c9e7e9..4e28b33b3 100644 --- a/docs/btcli/btcli.md +++ b/docs/btcli/btcli.md @@ -41,6 +41,7 @@ btcli [OPTIONS] COMMAND [ARGS]... - `proxy`: Proxy commands - `crowd`: Crowdloan commands, aliases: `cr`, `crowdloan` - `liquidity`: Liquidity commands, aliases: `l` +- `axon`: Axon serving commands - `utils` - `view`: HTML view commands @@ -66,7 +67,8 @@ aliases: conf, c - `add-proxy`: Adds a new pure proxy to the address book. - `proxies` : Displays the current proxies address book - `remove-proxy`: Removes a pure proxy from the address book. -- `update-proxy` +- `update-proxy`: Updates the details of a proxy in the address book. +- `clear-proxy`: Clears the proxy address book. Use with caution. ### `btcli config set` @@ -111,6 +113,8 @@ btcli config set [OPTIONS] | `--safe-staking`, `--safe`/`--no-safe-staking`, `--unsafe` | | Enable or disable safe staking mode. | | `--allow-partial-stake`, `--partial`, `--allow`/`--no-allow-partial-stake`, `--no-partial`, `--not-allow` | | Allow or prevent partial stakes | | `--dashboard-path`, `--dashboard_path`, `--dash_path`, `--dash.path` | TEXT | Path to save the dashboard HTML file. For example: `~/.bittensor/dashboard`. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | +| `--quiet` | | Display only critical information on the console. | | `--help` | | Show this message and exit. | ### `btcli config get` @@ -165,12 +169,20 @@ btcli config clear [OPTIONS] | `--allow-partial-stake`, `--partial`, `--allow`/`--no-allow-partial-stake`, `--no-partial`, `--not-allow` | | Allow or prevent partial stakes | | `--all` | | Clears the entire config. | | `--dashboard-path`, `--dashboard_path`, `--dash_path`, `--dash.path` | TEXT | Path to save the dashboard HTML file. For example: `~/.bittensor/dashboard`. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | +| `--quiet` | | Display only critical information on the console. | | `--help` | | Show this message and exit. | ### `btcli config add-proxy` Adds a new pure proxy to the address book. +**Example:** + +```bash +btcli config add-proxy --name test-proxy +``` + **Usage:** ```bash @@ -193,6 +205,12 @@ btcli config add-proxy [OPTIONS] Displays the current proxies address book +**Example:** + +```bash +btcli config proxies +``` + **Usage:** ```bash @@ -213,6 +231,12 @@ Removes a pure proxy from the address book. This command does not remove the proxy on chain. Only removes it from the address book. ::: +Example: + +```bash +btcli config remove-proxy --name test-proxy +``` + **Usage:** ```bash @@ -228,6 +252,18 @@ btcli config remove-proxy [OPTIONS] ### `btcli config update-proxy` +Updates the details of a proxy in the address book. + +:::info +This command not update the proxy on chain. It only updates it on the address book. +::: + +Example: + +```bash +btcli config update-proxy --name test-proxy +``` + **Usage:** ```bash @@ -246,6 +282,21 @@ btcli config update-proxy [OPTIONS] | `--note` | TEXT | Any notes about this entry | | `--help` | | Show this message and exit. | +### `btcli config clear-proxies` + +Clears the proxy address book. Use with caution. +Really only useful if you have corrupted your proxy address book. + +**Usage:** + +```bash +btcli config clear-proxies [OPTIONS] +``` + +| Options | Type | Description | +| -------- | ---- | --------------------------- | +| `--help` | | Show this message and exit. | + ## `btcli view` Display html dashboard with subnets list, stake, and neuron information. @@ -427,6 +478,7 @@ alias: swap_hotkey | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | | `--prompt`, `--prompt`, `--no-prompt`, `--yes`, `--no_prompt`, `-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | | `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | | `--proxy` | TEXT | Optional proxy to use for the transaction: either the SS58 or the name of the proxy if you have added it with btcli config add-proxy. | | `--announce-only`/`--no-announce-only` | | If set along with --proxy, will not actually make the extrinsic call, but rather just announce it to be made later. | @@ -465,6 +517,7 @@ alias: swap_coldkey | `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. | | `--proxy` | TEXT | Optional proxy to use for the transaction: either the SS58 or the name of the proxy if you have added it with btcli config add-proxy. | | `--announce-only`/`--no-announce-only` | | If set along with --proxy, will not actually make the extrinsic call, but rather just announce it to be made later. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | | `--force`, `--force-swap`, `-f` | | Force the swap even if the new coldkey is already scheduled for a swap. | @@ -1018,6 +1071,7 @@ alias: set_identity | `--proxy` | TEXT | Optional proxy to use for the transaction: either the SS58 or the name of the proxy if you have added it with btcli config add-proxy. | | `--announce-only`/`--no-announce-only` | | If set along with --proxy, will not actually make the extrinsic call, but rather just announce it to be made later. | | `--prompt`, `--prompt`, `--no-prompt`, `--yes`, `--no_prompt`, `-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | | `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | @@ -1055,17 +1109,17 @@ alias: get_identity **Options**: -| Option | Type | Description | -| -------------------------------------------------------------------------------------- | ---- | ------------------------------------------------------------------------------------ | -| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. | -| `-p`, `--wallet-path`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | -| `-H`, `--hotkey`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | -| `--ss58`, `--coldkey_ss58`, `--coldkey.ss58_address`, `--coldkey.ss58`, `--key`, `-k ` | TEXT | Coldkey address of the wallet | -| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. | -| `--quiet` | | Display only critical information on the console. | -| `--verbose` | | Enable verbose output. | -| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | -| `--help` | | Show this message and exit. | +| Option | Type | Description | +| --------------------------------------------------------------------------- | ---- | ------------------------------------------------------------------------------------ | +| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. | +| `-p`, `--wallet-path`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | +| `-H`, `--hotkey`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | +| `--ss58`, `--coldkey-ss58`, `--coldkey_ss58`, `--key`, `-k` | TEXT | Coldkey address of the wallet | +| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. | +| `--quiet` | | Display only critical information on the console. | +| `--verbose` | | Enable verbose output. | +| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | +| `--help` | | Show this message and exit. | ### `btcli wallet sign` @@ -1093,17 +1147,18 @@ btcli wallet sign [OPTIONS] **Options**: -| Option | Type | Description | -| ------------------------------------------------------------------------- | ---- | ---------------------------------------------------------------------------------------------------- | -| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. | -| `-p`, `--wallet-path`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | -| `-H`, `--hotkey`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | -| `--use-hotkey` / `--no-use-hotkey` | | If specified, the message will be signed by the hotkey. If not specified, the user will be prompted. | -| `--message` | TEXT | The message to encode and sign. | -| `--quiet` | | Display only critical information on the console. | -| `--verbose` | | Enable verbose output. | -| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | -| `--help` | | Show this message and exit. | +| Option | Type | Description | +| ------------------------------------------------------------------------- | ---- | ------------------------------------------------------------------------------------------------------------------ | +| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. | +| `-p`, `--wallet-path`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | +| `-H`, `--hotkey`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | +| `--use-hotkey` / `--no-use-hotkey` | | If specified, the message will be signed by the hotkey. If not specified, the user will be prompted. | +| `--message` | TEXT | The message to encode and sign. | +| `--quiet` | | Display only critical information on the console. | +| `--verbose` | | Enable verbose output. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | +| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | +| `--help` | | Show this message and exit. | ### `btcli wallet verify` @@ -1158,6 +1213,8 @@ alias: st **Commands**: - `add`: Stake TAO to one or more hotkeys on specific netuids with your coldkey. +- `auto`: Display auto-stake destinations for a wallet across all subnets. +- `set-auto`: Set the auto-stake destination hotkey for a coldkey. - `remove`: Unstake TAO from one or more hotkeys and transfer them back to the user's coldkey wallet. - `list`: Display detailed stake information for a wallet across all subnets. - `move`: Move staked TAO between hotkeys while keeping the same coldkey ownership. @@ -1255,6 +1312,7 @@ btcli stake add [OPTIONS] | `--mev-protection/--no-mev-protection` | | Enable or disable MEV protection (default: enabled). | | `--period`, `-era` | INTEGER | Length (in blocks) for which the transaction should be valid. | | `--prompt`, `--prompt`, `--no-prompt`, `--yes`, `--no_prompt`, `-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | | `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | @@ -1277,7 +1335,7 @@ btcli stake auto [OPTIONS] | `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | | The subtensor network to connect to. Default: finney. | | `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. | | `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | -| `--ss58`, `--coldkey_ss58`, `--coldkey.ss58_address`, `--coldkey.ss58` | | Coldkey address of the wallet | +| `--ss58`, `--coldkey-ss58`, `--coldkey_ss58`, `--key`, `-k` | TEXT | Coldkey address of the wallet | | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | | `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | @@ -1303,6 +1361,7 @@ btcli stake set-auto [OPTIONS] | `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). | | `--proxy` | TEXT | Optional proxy to use for the transaction: either the SS58 or the name of the proxy if you have added it with btcli config add-proxy. | | `--announce-only`/`--no-announce-only` | | If set along with --proxy, will not actually make the extrinsic call, but rather just announce it to be made later. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | | `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | @@ -1395,6 +1454,7 @@ btcli stake remove [OPTIONS] | `--mev-protection/--no-mev-protection` | | Enable or disable MEV protection (default: enabled). | | `--period`, `-era` | INTEGER | Length (in blocks) for which the transaction should be valid. | | `--prompt`, `--prompt`, `--no-prompt`, `--yes`, `--no_prompt`, `-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | | `--interactive`, `-t` | | Enter interactive mode for unstaking. | | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | @@ -1441,19 +1501,19 @@ btcli stake list [OPTIONS] **Options**: -| Option | Type | Description | -| -------------------------------------------------------------------------------------- | ---- | ------------------------------------------------------------------------------------ | -| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. | -| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. | -| `-p`, `--wallet-path`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | -| `-H`, `--hotkey`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | -| `--ss58`, `--coldkey_ss58`, `--coldkey.ss58_address`, `--coldkey.ss58`, `--key`, `-k ` | TEXT | Coldkey address of the wallet | -| `--prompt`, `--prompt`, `--no-prompt`, `--yes`, `--no_prompt`, `-y` | | Enable or disable interactive prompts. | -| `--live` | | Display live view of the table | -| `--quiet` | | Display only critical information on the console. | -| `--verbose` | | Enable verbose output. | -| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | -| `--help` | | Show this message and exit. | +| Option | Type | Description | +| --------------------------------------------------------------------------- | ---- | ------------------------------------------------------------------------------------ | +| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. | +| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. | +| `-p`, `--wallet-path`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | +| `-H`, `--hotkey`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | +| `--ss58`, `--coldkey-ss58`, `--coldkey_ss58`, `--key`, `-k` | TEXT | Coldkey address of the wallet | +| `--prompt`, `--prompt`, `--no-prompt`, `--yes`, `--no_prompt`, `-y` | | Enable or disable interactive prompts. | +| `--live` | | Display live view of the table | +| `--quiet` | | Display only critical information on the console. | +| `--verbose` | | Enable verbose output. | +| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | +| `--help` | | Show this message and exit. | ### `btcli stake move` @@ -1510,6 +1570,7 @@ btcli stake move [OPTIONS] | `--mev-protection/--no-mev-protection` | | Enable or disable MEV protection (default: enabled). | | `--period`, `-era` | INTEGER | Length (in blocks) for which the transaction should be valid. | | `--prompt`, `--prompt`, `--no-prompt`, `--yes`, `--no_prompt`, `-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | | `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | @@ -1590,6 +1651,7 @@ btcli stake transfer [OPTIONS] | `--mev-protection/--no-mev-protection` | | Enable or disable MEV protection (default: enabled). | | `--period`, `-era` | INTEGER | Length (in blocks) for which the transaction should be valid. | | `--prompt`, `--prompt`, `--no-prompt`, `--yes`, `--no_prompt`, `-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | | `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | @@ -1627,6 +1689,18 @@ btcli stake swap --wallet-name default --wallet-hotkey default --origin-netuid 1 btcli stake swap --origin-netuid 1 --dest-netuid 2 --amount 100 --no-mev-protection ``` +3. Swap stake with custom tolerance and partial stake: + +```bash +btcli stake swap --origin-netuid 1 --dest-netuid 2 --amount 100 --rate-tolerance 0.01 --allow-partial-stake +``` + +4. Swap stake without safe staking: + +```bash +btcli stake swap --origin-netuid 1 --dest-netuid 2 --amount 100 --unsafe +``` + **Usage**: ```console @@ -1635,27 +1709,31 @@ btcli stake swap [OPTIONS] **Options**: -| Option | Type | Description | -| ------------------------------------------------------------------------------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. | -| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. | -| `-p`, `--wallet-path`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | -| `-H`, `--hotkey`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey`, `--hotkey-ss58` | TEXT | Hotkey name or SS58 address of the hotkey | -| `--origin-netuid`, `-o` | INTEGER | The netuid to swap stake from. | -| `--dest-netuid`, `-d` | INTEGER | The netuid to swap stake to. | -| `--amount`, `-a` | FLOAT | The amount of stake to swap. | -| `--swap-all`, `--all` | | Swap all available stake. | -| `--proxy` | TEXT | Optional proxy to use for the transaction: either the SS58 or the name of the proxy if you have added it with btcli config add-proxy. | -| `--announce-only`/`--no-announce-only` | | If set along with --proxy, will not actually make the extrinsic call, but rather just announce it to be made later. | -| `--period`, `-era` | INTEGER | Length (in blocks) for which the transaction should be valid. | -| `--prompt`, `--prompt`, `--no-prompt`, `--yes`, `--no_prompt`, `-y` | | Enable or disable interactive prompts. | -| `--wait-for-inclusion`/ `--no-wait-for-inclusion` | | If `True`, waits until the transaction is included in a block. | -| `--wait-for-finalization`/ `--no-wait-for-finalization` | | If `True`, waits until the transaction is finalized on the blockchain. | -| `--mev-protection/--no-mev-protection` | | Enable or disable MEV protection (default: enabled). | -| `--quiet` | | Display only critical information on the console. | -| `--verbose` | | Enable verbose output. | -| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | -| `--help` | | Show this message and exit. | +| Option | Type | Description | +| ---------------------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. | +| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. | +| `-p`, `--wallet-path`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | +| `-H`, `--hotkey`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey`, `--hotkey-ss58` | TEXT | Hotkey name or SS58 address of the hotkey | +| `--origin-netuid`, `-o` | INTEGER | The netuid to swap stake from. | +| `--dest-netuid`, `-d` | INTEGER | The netuid to swap stake to. | +| `--amount`, `-a` | FLOAT | The amount of stake to swap. | +| `--swap-all`, `--all` | | Swap all available stake. | +| `--proxy` | TEXT | Optional proxy to use for the transaction: either the SS58 or the name of the proxy if you have added it with btcli config add-proxy. | +| `--announce-only`/`--no-announce-only` | | If set along with --proxy, will not actually make the extrinsic call, but rather just announce it to be made later. | +| `--period`, `-era` | INTEGER | Length (in blocks) for which the transaction should be valid. | +| `--prompt`, `--prompt`, `--no-prompt`, `--yes`, `--no_prompt`, `-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | +| `--wait-for-inclusion`/ `--no-wait-for-inclusion` | | If `True`, waits until the transaction is included in a block. | +| `--wait-for-finalization`/ `--no-wait-for-finalization` | | If `True`, waits until the transaction is finalized on the blockchain. | +| `--mev-protection/--no-mev-protection` | | Enable or disable MEV protection (default: enabled). | +| `--tolerance`, `--rate-tolerance` | FLOAT | Set the rate tolerance percentage for transactions (default: 0.05 for 5%). | +| `--safe-staking/--no-safe-staking`, `--safe/--unsafe` | | Enable or disable safe staking mode (default: enabled). | +| `--allow-partial-stake/--no-allow-partial-stake`, `--partial/--no-partial`, `--allow/--not-allow`, `--allow-partial/--not-partial` | | Enable or disable partial stake mode (default: disabled). | +| `--quiet` | | Display only critical information on the console. | +| `--verbose` | | Enable verbose output. | +| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | +| `--help` | | Show this message and exit. | ### `btcli stake wizard` @@ -1690,16 +1768,20 @@ btcli stake wizard [OPTIONS] **Parameters:** -| Options | Type | Description | -| --------------------------------------------------------------------------- | ---- | ------------------------------------------------------------------------------------ | -| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | | The subtensor network to connect to. Default: finney. | -| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. | -| `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | -| `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | -| `--mev-protection/--no-mev-protection` | | Enable or disable MEV protection (default: enabled). | -| `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | -| `--quiet` | | Display only critical information on the console. | -| `--verbose` | | Enable verbose output. | +| Options | Type | Description | +| ---------------------------------------------------------------------------------------------------------------------------------- | ----- | ------------------------------------------------------------------------------------------------------------------ | +| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | | The subtensor network to connect to. Default: finney. | +| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. | +| `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | +| `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | +| `--mev-protection/--no-mev-protection` | | Enable or disable MEV protection (default: enabled). | +| `--tolerance`, `--rate-tolerance` | FLOAT | Set the rate tolerance percentage for transactions (default: 0.05 for 5%). | +| `--safe-staking/--no-safe-staking`, `--safe/--unsafe` | | Enable or disable safe staking mode (default: enabled). | +| `--allow-partial-stake/--no-allow-partial-stake`, `--partial/--no-partial`, `--allow/--not-allow`, `--allow-partial/--not-partial` | | Enable or disable partial stake mode (default: disabled). | +| `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | +| `--quiet` | | Display only critical information on the console. | +| `--verbose` | | Enable verbose output. | ### `btcli stake claim` @@ -1753,6 +1835,7 @@ If a claim type—`keep` or `swap`—is not provided, you'll be prompted to choo | `--proxy` | TEXT | Optional proxy to use for the transaction: either the SS58 or the name of the proxy if you have added it with btcli config add-proxy. | | `--announce-only`/`--no-announce-only` | | If set along with --proxy, will not actually make the extrinsic call, but rather just announce it to be made later. | | `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | | `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | @@ -1792,18 +1875,19 @@ btcli stake process-claim [OPTIONS] **Parameters:** -| Options | Type | Description | -| --------------------------------------------------------------------------- | ---- | ---------------------------------------------------------------------------------------------- | -| `--netuids`, `--netuid`, `-n` | TEXT | Set the netuid(s) to exclude. Separate multiple netuids with a comma, for example: `-n 0,1,2`. | -| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. | -| `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | -| `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | -| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | | The subtensor network to connect to. Default: finney. | -| `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | -| `--quiet` | | Display only critical information on the console. | -| `--verbose` | | Enable verbose output. | -| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | -| `--help` | | Show this message and exit. | +| Options | Type | Description | +| --------------------------------------------------------------------------- | ---- | ------------------------------------------------------------------------------------------------------------------ | +| `--netuids`, `--netuid`, `-n` | TEXT | Set the netuid(s) to exclude. Separate multiple netuids with a comma, for example: `-n 0,1,2`. | +| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. | +| `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | +| `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | +| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | | The subtensor network to connect to. Default: finney. | +| `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | +| `--quiet` | | Display only critical information on the console. | +| `--verbose` | | Enable verbose output. | +| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | +| `--help` | | Show this message and exit. | ### `btcli stake child` @@ -2030,12 +2114,22 @@ Used to set hyperparameters for a specific subnet. This command allows subnet owners to modify hyperparameters such as its tempo, emission rates, and other hyperparameters. +:::info +When listing hyperparameters, descriptions, ownership information, and side-effects are displayed to help you make informed decisions. + +You can also set custom hyperparameters not in the standard list by using the exact parameter name from the chain metadata. +::: + **Example:** ``` btcli sudo set --netuid 1 --param tempo --value 400 ``` +```bash +btcli sudo set --netuid 1 --param custom_param_name --value 123 +``` + **Usage**: ```console @@ -2054,6 +2148,7 @@ btcli sudo set [OPTIONS] | `--param`, `--parameter` | TEXT | The subnet hyperparameter to set | | `--value` | TEXT | Value to set the hyperparameter to. | | `--proxy` | TEXT | Optional proxy to use for the transaction: either the SS58 or the name of the proxy if you have added it with btcli config add-proxy. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | | `--announce-only`/`--no-announce-only` | | If set along with --proxy, will not actually make the extrinsic call, but rather just announce it to be made later. | | `--prompt`, `--prompt`, `--no-prompt`, `--yes`, `--no_prompt`, `-y` | | Enable or disable interactive prompts. | | `--quiet` | | Display only critical information on the console. | @@ -2065,6 +2160,8 @@ btcli sudo set [OPTIONS] Shows a list of the hyperparameters for the specified subnet. +Displays hyperparameter values along with descriptions, ownership information (which parameters can be set by subnet owners vs root sudo), and side-effects. + **Example:** ``` @@ -2287,9 +2384,9 @@ btcli sudo trim [OPTIONS] | `--verbose` | | Enable verbose output. | | `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | | `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | - -| `--period`, `--era` | INTEGER | Length (in blocks) for which the transaction should be valid. | -| `--help` | | Show this message and exit. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | +| `--period`, `--era` | INTEGER | Length (in blocks) for which the transaction should be valid. | +| `--help` | | Show this message and exit. | ## `btcli subnets` @@ -2410,6 +2507,7 @@ btcli subnet mechanisms set [OPTIONS] | `--wait-for-inclusion` | | If `True`, waits until the transaction is included in a block. | | `--wait-for-finalization` | | If `True`, waits until the transaction is finalized on the blockchain. | | `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | | `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | @@ -2483,6 +2581,7 @@ alias: emissions-split | `--wait-for-inclusion` | | If `True`, waits until the transaction is included in a block. | | `--wait-for-finalization` | | If `True`, waits until the transaction is finalized on the blockchain. | | `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | | `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | @@ -2492,6 +2591,8 @@ alias: emissions-split Shows a list of the hyperparameters for the specified subnet. +Displays hyperparameter values along with descriptions, ownership information (which parameters can be set by subnet owners vs root sudo), and side-effects. + **Example:** ``` @@ -2650,6 +2751,7 @@ btcli subnets create [OPTIONS] | `--additional-info` | TEXT | Additional details for the subnet. | | `--mev-protection/--no-mev-protection` | | Enable or disable MEV protection (default: enabled). | | `--prompt`, `--prompt`, `--no-prompt`, `--yes`, `--no_prompt`, `-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | | `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | @@ -2945,6 +3047,7 @@ alias: set_identity | `--description` | TEXT | The description for the subnet. | | `--additional-info` | TEXT | Additional details for the subnet. | | `--prompt`, `--prompt`, `--no-prompt`, `--yes`, `--no_prompt`, `-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | | `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | @@ -3010,6 +3113,7 @@ btcli subnets start [OPTIONS] | `--announce-only`/`--no-announce-only` | | If set along with --proxy, will not actually make the extrinsic call, but rather just announce it to be made later. | | `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). | | `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | | `--help` | | Show this message and exit. | @@ -3050,6 +3154,7 @@ btcli subnets set-symbol [OPTIONS] | `--period`, `--era` | INTEGER | Length (in blocks) for which the transaction should be valid. | | `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | | `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | | `--help` | | Show this message and exit. | @@ -3207,12 +3312,13 @@ btcli proxy create [OPTIONS] | --------------------------------------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | | The subtensor network to connect to. Default: finney. | | `--proxy-type` | | Type of proxy | -| `--delay` | INTEGER | Delay, in number of blocks | +| `--delay` | INTEGER | Delay, in number of blocks (default 0) | | `--index` | INTEGER | A disambiguation index, in case this is called multiple times in the same transaction (e.g. with utility::batch). Unless you're using batch you probably just want to use 0. | | `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. | | `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | | `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | | `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | | `--wait-for-inclusion` | | If `True`, waits until the transaction is included in a block. | | `--wait-for-finalization` | | If `True`, waits until the transaction is finalized on the blockchain. | | `--period`, `--era` | INTEGER | Length (in blocks) for which the transaction should be valid. | @@ -3252,23 +3358,24 @@ btcli proxy add [OPTIONS] **Parameters:** -| Options | Type | Description | -| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------ | -| `--delegate` | | The SS58 address of the delegate to add | -| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | | The subtensor network to connect to. Default: finney. | -| `--proxy-type` | | Type of proxy | -| `--delay` | INTEGER | Delay, in number of blocks | -| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. | -| `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | -| `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | -| `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | -| `--wait-for-inclusion` | | If `True`, waits until the transaction is included in a block. | -| `--wait-for-finalization` | | If `True`, waits until the transaction is finalized on the blockchain. | -| `--period`, `--era` | INTEGER | Length (in blocks) for which the transaction should be valid. | -| `--quiet` | | Display only critical information on the console. | -| `--verbose` | | Enable verbose output. | -| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | -| `--help` | | Show this message and exit. | +| Options | Type | Description | +| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | +| `--delegate` | | The SS58 address of the delegate to add | +| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | | The subtensor network to connect to. Default: finney. | +| `--proxy-type` | | Type of proxy | +| `--delay` | INTEGER | Delay, in number of blocks (default 0) | +| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. | +| `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | +| `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | +| `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | +| `--wait-for-inclusion` | | If `True`, waits until the transaction is included in a block. | +| `--wait-for-finalization` | | If `True`, waits until the transaction is finalized on the blockchain. | +| `--period`, `--era` | INTEGER | Length (in blocks) for which the transaction should be valid. | +| `--quiet` | | Display only critical information on the console. | +| `--verbose` | | Enable verbose output. | +| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | +| `--help` | | Show this message and exit. | --- @@ -3294,23 +3401,24 @@ btcli proxy remove [OPTIONS] **Parameters:** -| Options | Type | Description | -| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------ | -| `--delegate` | | The SS58 address of the delegate to remove | -| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | | The subtensor network to connect to. Default: finney. | -| `--proxy-type` | | Type of proxy | -| `--delay` | INTEGER | Delay, in number of blocks | -| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. | -| `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | -| `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | -| `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | -| `--wait-for-inclusion` | | If `True`, waits until the transaction is included in a block. | -| `--wait-for-finalization` | | If `True`, waits until the transaction is finalized on the blockchain. | -| `--period`, `--era` | INTEGER | Length (in blocks) for which the transaction should be valid. | -| `--quiet` | | Display only critical information on the console. | -| `--verbose` | | Enable verbose output. | -| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | -| `--help` | | Show this message and exit. | +| Options | Type | Description | +| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | +| `--delegate` | | The SS58 address of the delegate to remove | +| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | | The subtensor network to connect to. Default: finney. | +| `--proxy-type` | | Type of proxy | +| `--delay` | INTEGER | Delay, in number of blocks | +| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. | +| `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | +| `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | +| `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | +| `--wait-for-inclusion` | | If `True`, waits until the transaction is included in a block. | +| `--wait-for-finalization` | | If `True`, waits until the transaction is finalized on the blockchain. | +| `--period`, `--era` | INTEGER | Length (in blocks) for which the transaction should be valid. | +| `--quiet` | | Display only critical information on the console. | +| `--verbose` | | Enable verbose output. | +| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | +| `--help` | | Show this message and exit. | --- @@ -3364,6 +3472,31 @@ btcli proxy kill [OPTIONS] ### `btcli proxy execute` +Executes a previously announced proxy call. + +This command submits the inner call on-chain using the proxy relationship. The command will fail if the required delay has not passed or if the call does not match the announcement parameters. + +If you do not provide the call hash or call hex of the announced call in the command, you would be prompted to enter details of the call including the module name and call function. + +:::info +Using the `--call-hash` flag attempts to resolve the call from the proxy announcements address book. Use this flag only if the announcement was created through BTCLI. +If the announcement was created by any other method, you must provide the call hex using the `--call-hex` flag or rebuild the call explicitly via the command prompts. +::: + +**Common Examples:** + +1. Using the call hash + +```bash +btcli proxy execute --call-hash caf4da69610d379c2e2e5...0cbc6b012f6cff6340c45a1 +``` + +2. Using the call hex + +```bash +btcli proxy execute --call-hex 0x0503008f0667364ff11915b0b2a54387...27948e8f950f79a69cff9c029cdb69 +``` + **Usage:** ```bash @@ -3384,6 +3517,7 @@ btcli proxy execute [OPTIONS] | `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | | `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | | `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | | `--wait-for-inclusion` | | If `True`, waits until the transaction is included in a block. | | `--wait-for-finalization` | | If `True`, waits until the transaction is finalized on the blockchain. | | `--period`, `--era` | INTEGER | Length (in blocks) for which the transaction should be valid. | @@ -3426,6 +3560,7 @@ Create a crowdloan that can either: 1. Raise funds for a specific address (general fundraising) 2. Create a new leased subnet where contributors receive emissions +3. Attach any custom Substrate call (using `--custom-call-pallet`, `--custom-call-method`, `--custom-call-args`) **EXAMPLES** @@ -3447,6 +3582,12 @@ Subnet lease ending at block 500000: btcli crowd create --subnet-lease --emissions-share 25 --lease-end-block 500000 ``` +Custom call: + +```bash +btcli crowd create --deposit 10 --cap 1000 --duration 1000 --min-contribution 1 --custom-call-pallet "SomeModule" --custom-call-method "some_method" --custom-call-args '{"param1": "value", "param2": 42}' +``` + **Usage:** ```bash @@ -3471,6 +3612,9 @@ btcli crowd create [OPTIONS] | `--subnet-lease/--fundraising` | | Create a subnet leasing crowdloan (True) or general fundraising (False). | | `--emissions-share`, `--emissions` | INTEGER | Percentage of emissions for contributors (0-100) for subnet leasing. | | `--lease-end-block`, `--lease-end` | INTEGER | Block number when subnet lease ends (omit for perpetual lease). | +| `--custom-call-pallet` | TEXT | Pallet name for custom Substrate call to attach to crowdloan. | +| `--custom-call-method` | TEXT | Method name for custom Substrate call to attach to crowdloan. | +| `--custom-call-args` | TEXT | JSON string of arguments for custom call (e.g., `{"arg1": "value1", "arg2": 123}`). | | `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | | `--wait-for-inclusion` | | If `True`, waits until the transaction is included in a block. | | `--wait-for-finalization` | | If `True`, waits until the transaction is finalized on the blockchain. | @@ -3705,18 +3849,47 @@ List crowdloans together with their funding progress and key metadata. Shows every crowdloan on the selected network, including current status (Active, Funded, Closed, Finalized), whether it is a subnet leasing crowdloan, or a general fundraising crowdloan. -Use `--verbose` for full-precision amounts and longer addresses. +:::tip -**EXAMPLES** +- Use `--verbose` for full-precision amounts and longer addresses. +- Use `--status` to filter by status (`active`, `funded`, `closed`, `finalized`). +- Use `--type` to filter by type (`subnet`, `fundraising`). +- Use `--sort-by` and `--sort-order` to sort results. +- Use `--search-creator` to search by creator address or identity name. + ::: + +**COMMON EXAMPLES** + +1. List all on-chain crowdloans: ```bash btcli crowd list ``` +2. List on-chain crowdloans with or full-precision amounts and longer addresses: + ```bash btcli crowd list --verbose ``` +3. Filter returned crowdloans by status—`active`, `funded`, `closed`, `finalized`—or type—`subnet`, `fundraising`: + +```bash +btcli crowd list --status active --type subnet +``` + +4. Sort returned crowdloans—`raised`, `end`, `contributors`, `id`: + +```bash +btcli crowd list --sort-by raised --sort-order desc +``` + +5. Show crowdloans created by a specific wallet: + +```bash +btcli crowd list --search-creator "5D..." +``` + **Usage:** ```bash @@ -3725,13 +3898,18 @@ btcli crowd list [OPTIONS] **Parameters:** -| Options | Type | Description | -| --------------------------------------------------------------------------- | ---- | ----------------------------------------------------- | -| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | | The subtensor network to connect to. Default: finney. | -| `--quiet` | | Display only critical information on the console. | -| `--verbose` | | Enable verbose output. | -| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | -| `--help` | | Show this message and exit. | +| Options | Type | Description | +| --------------------------------------------------------------------------- | ---- | ------------------------------------------------------------ | +| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | | The subtensor network to connect to. Default: finney. | +| `--quiet` | | Display only critical information on the console. | +| `--verbose` | | Enable verbose output. | +| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | +| `--status` | TEXT | Filter by status: `active`, `funded`, `closed`, `finalized` | +| `--type` | TEXT | Filter by type: `subnet`, `fundraising` | +| `--sort-by` | TEXT | Sort by: `raised`, `end`, `contributors`, `id` | +| `--sort-order` | TEXT | Sort order: asc, desc (default: desc for raised, asc for id) | +| `--search-creator` | TEXT | Search by creator address or identity name | +| `--help` | | Show this message and exit. | ### `btcli crowd info` @@ -3739,16 +3917,28 @@ Display detailed information about a specific crowdloan. Includes funding progress, target account, and call details among other information. -**EXAMPLES** +:::info +Use `--show-contributors` to display the list of contributors (default: false). +::: + +**COMMON EXAMPLES** + +1. Display information about a crowdloan: ```bash btcli crowd info --id 0 ``` +2. Display information about a crowdloan with full-precision amounts and longer addresses + ```bash btcli crowd info --id 1 --verbose ``` +```bash +btcli crowd info --id 0 --show-contributors +``` + **Usage:** ```bash @@ -3767,8 +3957,47 @@ btcli crowd info [OPTIONS] | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | | `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | +| `--show-contributors` | | Show contributor list with identities. | | `--help` | | Show this message and exit. | +### `btcli crowd contributors` + +List all contributors to a specific crowdloan. + +Shows contributor addresses, contribution amounts, identity names, and percentages. +Contributors are sorted by contribution amount (highest first). + +**EXAMPLES** + +```bash +btcli crowd contributors --id 0 +``` + +```bash +btcli crowd contributors --id 1 --verbose +``` + +```bash +btcli crowd contributors --id 2 --json-output +``` + +**Usage:** + +```bash +btcli crowd contributors [OPTIONS] +``` + +**Parameters:** + +| Options | Type | Description | +| --------------------------------------------------------------------------- | ------- | ----------------------------------------------------- | +| `--crowdloan-id`, `--crowdloan_id`, `--id` | INTEGER | The ID of the crowdloan to list contributors for | +| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | | The subtensor network to connect to. Default: finney. | +| `--quiet` | | Display only critical information on the console. | +| `--verbose` | | Enable verbose output. | +| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | +| `--help` | | Show this message and exit. | + ## `btcli liquidity` **Usage:** @@ -3815,6 +4044,7 @@ btcli liquidity add [OPTIONS] | `--price-low`, `--price_low`, `--liquidity-price-low`, `--liquidity_price_low` | FLOAT | Low price for the adding liquidity position. | | `--price-high`, `--price_high`, `--liquidity-price-high`, `--liquidity_price_high` | FLOAT | High price for the adding liquidity position. | | `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | | `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | @@ -3868,6 +4098,7 @@ btcli liquidity modify [OPTIONS] | `--position-id`, `--position_id` | INTEGER | Position ID for modification or removing. | | `--liquidity-delta`, `--liquidity_delta` | FLOAT | Liquidity amount for modification. | | `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | | `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | @@ -3897,11 +4128,121 @@ btcli liquidity remove [OPTIONS] | `--position-id`, `--position_id` | INTEGER | Position ID for modification or removal. | | `--all`, `--a` | | Whether to remove all liquidity positions for given subnet. | | `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | +| `--no` | | Automatically decline any confirmation prompts. The prompt message is still displayed unless --quiet is specified. | | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | | `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | | `--help` | | Show this message and exit. | +## `btcli axon` + +**Usage**: + +```console +btcli axon [OPTIONS] COMMAND [ARGS]... +``` + +**Options**: + +- `--help`: Show this message and exit. + +**Commands**: + +- `reset`: Reset the axon information for a neuron on the network. +- `set`: Set the axon information for a neuron on the network. + +### `btcli axon reset` + +Reset the axon information for a neuron on the network. + +This command removes the serving endpoint by setting the IP to `0.0.0.0` and port to `1`, +indicating the neuron is no longer serving. + +**USAGE** + +```bash +btcli axon reset [OPTIONS] +``` + +The command requires you to specify the netuid where the neuron is registered. +It will reset the axon information for the hotkey associated with the wallet. + +**EXAMPLE** + +```bash +btcli axon reset --netuid 1 --wallet-name my_wallet --wallet-hotkey my_hotkey +``` + +:::info +This command is used to stop serving on a specific subnet. The neuron will +remain registered but will not be reachable by other neurons until a new axon is set. +::: + +**Parameters:** + +| Options | Type | Description | +| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------ | +| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). | +| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. | +| `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | +| `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | +| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | | The subtensor network to connect to. Default: finney. | +| `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | +| `--wait-for-inclusion` | | If `True`, waits until the transaction is included in a block. | +| `--wait-for-finalization` | | If `True`, waits until the transaction is finalized on the blockchain. | +| `--quiet` | | Display only critical information on the console. | +| `--verbose` | | Enable verbose output. | +| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | +| `--help` | | Show this message and exit. | + +### `btcli axon set` + +Set the axon information for a neuron on the network. + +This command configures the serving endpoint for a neuron by specifying its IP address +and port, allowing other neurons to connect to it. + +**USAGE** + +```bash +btcli axon set [OPTIONS] +``` + +The command requires you to specify the netuid, IP address, and port number. +It will set the axon information for the hotkey associated with the wallet. + +**EXAMPLE** + +```bash +btcli axon set --netuid 1 --ip 192.168.1.100 --port 8091 --wallet-name my_wallet --wallet-hotkey my_hotkey +``` + +:::info +This command is used to advertise your serving endpoint on the network. Make sure the IP and port are accessible from the internet if you want other neurons to connect. + +::: + +**Parameters:** + +| Options | Type | Description | +| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------ | +| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). | +| `--ip` | TEXT | IP address to set for the axon (e.g., '192.168.1.1') | +| `--port` | INTEGER | Port number to set for the axon (0-65535) | +| `--ip-type` | INTEGER | IP type (4 for IPv4, 6 for IPv6) | +| `--protocol` | INTEGER | Protocol version | +| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. | +| `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | +| `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | +| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | | The subtensor network to connect to. Default: finney. | +| `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | +| `--wait-for-inclusion` | | If `True`, waits until the transaction is included in a block. | +| `--wait-for-finalization` | | If `True`, waits until the transaction is finalized on the blockchain. | +| `--quiet` | | Display only critical information on the console. | +| `--verbose` | | Enable verbose output. | +| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | +| `--help` | | Show this message and exit. | + ## `btcli utils` **Usage**: diff --git a/docs/subnets/subnet-hyperparameters.md b/docs/subnets/subnet-hyperparameters.md index 0c1c55eb7..028e2fd64 100644 --- a/docs/subnets/subnet-hyperparameters.md +++ b/docs/subnets/subnet-hyperparameters.md @@ -21,53 +21,59 @@ Anyone can view the parameters of any subnet. **Example** ```bash -btcli subnet hyperparameters --netuid 19 +btcli subnet hyperparameters --netuid 14 ``` ```console -Netuid: 19 -Using the specified network test from config - - Subnet Hyperparameters - NETUID: 19 (inference) - Network: test - - - HYPERPARAMETER VALUE NORMALIZED - ──────────────────────────────────────────────────────────────────────── - activity_cutoff 5000 5000 - adjustment_alpha 17893341751498265066 0.97 - adjustment_interval 360 360 - alpha_high 58982 0.9000076295 - alpha_low 45875 0.7000076295 - alpha_sigmoid_steepness 0.0 0 - bonds_moving_avg 900000 4.878909776e-14 - bonds_reset_enabled False False - commit_reveal_period 1 1 - commit_reveal_weights_enabled False False - difficulty 18446744073709551615 1 - immunity_period 5000 5000 - kappa 32767 0.4999923705 - liquid_alpha_enabled False False - max_burn 100000000000 100.0000 τ - max_difficulty 18446744073709551615 1 - max_regs_per_block 1 1 - max_validators 64 64 - max_weight_limit 65535 1 - min_allowed_weights 1 1 - min_burn 500000 0.0005 τ - min_difficulty 18446744073709551615 1 - registration_allowed True True - rho 10 10 - serving_rate_limit 50 50 - subnet_is_active True True - target_regs_per_interval 1 1 - tempo 360 360 - transfers_enabled True True - user_liquidity_enabled True True - weights_rate_limit 100 100 - weights_version 0 0 - yuma_version 2 2 - ──────────────────────────────────────────────────────────────────────── + Subnet Hyperparameters + NETUID: 14 (TAOHash) - Network: finney + + + HYPERPARAMETER VALUE NORMALIZED OWNER SETTABLE DESCRIPTION + ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── + activity_cutoff 5000 5000 Yes Minimum activity level required for neurons to remain active. link + adjustment_alpha 14757395258967641292 0.8 Yes Alpha parameter for difficulty adjustment algorithm. link + adjustment_interval 360 360 No (Root Only) Number of blocks between automatic difficulty adjustments. link + alpha_high 58982 0.9000076295 Yes High bound of the alpha range for stake calculations. link + alpha_low 45875 0.7000076295 Yes Low bound of the alpha range for stake calculations. link + alpha_sigmoid_steepness 0.0 0 No (Root Only) Steepness parameter for alpha sigmoid function. link + bonds_moving_avg 1 5.421010862e-20 Yes Moving average window size for bond calculations. link + bonds_reset_enabled False False Yes Enable or disable periodic bond resets. link + commit_reveal_period 1 1 Yes Duration (in blocks) for commit-reveal weight submission scheme. link + commit_reveal_weights_enabled True True Yes Enable or disable commit-reveal scheme for weight submissions. link + difficulty 10000000 5.421010862e-13 No (Root Only) Current proof-of-work difficulty for registration. link + immunity_period 5000 5000 Yes Duration (in blocks) during which newly registered neurons are protected from certain penalties. link + kappa 32767 0.4999923705 No (Root Only) Kappa determines the scaling factor for consensus calculations. link + liquid_alpha_enabled False False Yes Enable or disable liquid alpha staking mechanism. link + max_burn 100000000000 ‎100.0000 τ‎ No (Root Only) Maximum TAO burn amount cap for subnet registration. link + max_difficulty 18446744073709551615 1 Yes Maximum proof-of-work difficulty cap. link + max_regs_per_block 1 1 No (Root Only) Maximum number of registrations allowed per block. link + max_validators 64 64 No (Root Only) Maximum number of validators allowed in the subnet. link + max_weight_limit 65535 1 Yes No description available. + min_allowed_weights 1 1 Yes Minimum number of weight connections a neuron must maintain to stay active. link + min_burn 500000 ‎0.0005 τ‎ Yes Minimum TAO burn amount required for subnet registration. link + min_difficulty 10000000 5.421010862e-13 No (Root Only) Minimum proof-of-work difficulty required for registration link + registration_allowed True True No (Root Only) Enable or disable new registrations to the subnet. link + rho 10 10 Yes Rho controls the rate at which weights decay over time. link + serving_rate_limit 50 50 Yes Rate limit for serving requests. link + subnet_is_active True True Yes Whether the subnet is currently active and operational. link + target_regs_per_interval 1 1 No (Root Only) Target number of new registrations per adjustment interval. link + tempo 360 360 No (Root Only) Number of blocks between epoch transitions link + transfers_enabled True True Yes Enable or disable TAO transfers within the subnet. link + user_liquidity_enabled False False COMPLICATED (Owner/Sudo) Enable or disable user liquidity features. link + weights_rate_limit 100 100 No (Root Only) Maximum number of weight updates allowed per epoch. link + weights_version 28 28 Yes Version key for weight sets. link + yuma_version 2 2 Yes Version of the Yuma consensus mechanism. link + ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── + + + +💡 Tip: Use btcli sudo set --param --value to modify hyperparameters. +💡 Tip: Subnet owners can set parameters marked 'Yes'. Parameters marked 'No (Root Only)' require root sudo access. +💡 Tip: To set custom hyperparameters not in this list, use the exact parameter name from the chain metadata. + Example: btcli sudo set --netuid 14 --param custom_param_name --value 123 + The parameter name must match exactly as defined in the chain's AdminUtils pallet metadata. +📚 For detailed documentation, visit: https://docs.bittensor.com ``` :::tip