From 849a74710c0f9c6ee5bd782ac5498b89c8ebd258 Mon Sep 17 00:00:00 2001 From: Dera Okeke Date: Tue, 16 Dec 2025 20:22:03 +0100 Subject: [PATCH 1/3] BTCLI 9.16 updates --- docs/btcli/btcli.md | 230 +++++++++++++++++++++++++++++++++++++++----- 1 file changed, 208 insertions(+), 22 deletions(-) diff --git a/docs/btcli/btcli.md b/docs/btcli/btcli.md index a35964caf..aa5ed6d40 100644 --- a/docs/btcli/btcli.md +++ b/docs/btcli/btcli.md @@ -38,6 +38,7 @@ btcli [OPTIONS] COMMAND [ARGS]... - `sudo`: Sudo commands, alias: `su` - `subnets`: Subnets commands, alias: `s`, `subnet` - `weights`: Weights commands, aliases: `wt`, `weight` +- `proxy`: Proxy commands - `crowd`: Crowdloan commands, aliases: `cr`, `crowdloan` - `liquidity`: Liquidity commands, aliases: `l` - `utils` @@ -62,6 +63,10 @@ aliases: conf, c - `set`: Sets or updates configuration values in the BTCLI config file. - `get`: Prints the current config file in a table. - `clear`: Clears the fields in the config file and sets them to 'None'. +- `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` ### `btcli config set` @@ -78,13 +83,15 @@ Set specific values: `btcli config set --wallet-name default --network finney` `btcli config set --safe-staking --rate-tolerance 0.1` -Note: +:::info - Network values can be network names (e.g., 'finney', 'test') or websocket URLs - Rate tolerance is specified as a decimal (e.g., 0.05 for 0.05%) - Changes are saved to `~/.bittensor/btcli.yaml` - Use `btcli config get` to view current settings +::: + **Usage**: ```console @@ -160,6 +167,85 @@ btcli config clear [OPTIONS] | `--dashboard-path`, `--dashboard_path`, `--dash_path`, `--dash.path` | TEXT | Path to save the dashboard HTML file. For example: `~/.bittensor/dashboard`. | | `--help` | | Show this message and exit. | +### `btcli config add-proxy` + +Adds a new pure proxy to the address book. + +**Usage:** + +```bash +btcli config add-proxy [OPTIONS] +``` + +**Parameters:** + +| Options | Type | Description | +| -------------------------- | ------- | ---------------------------------------------------------------------- | +| `--name` | | Name of the proxy | +| `--address` | | The SS58 address of the pure proxy/delegatee | +| `--proxy_type` | | The type of this proxy | +| `--spawner`, `--delegator` | | The SS58 address of the spawner (pure proxy)/delegator (regular proxy) | +| `--delay` | INTEGER | Delay, in blocks. | +| `--note` | TEXT | Any notes about this entry | +| `--help` | | Show this message and exit. | + +### `btcli config proxies` + +Displays the current proxies address book + +**Usage:** + +```bash +btcli config proxies [OPTIONS] +``` + +**Parameters:** + +| Options | Type | Description | +| -------- | ---- | --------------------------- | +| `--help` | | Show this message and exit. | + +### `btcli config remove-proxy` + +Removes a pure proxy from the address book. + +:::info +This command does not remove the proxy on chain. Only removes it from the address book. +::: + +**Usage:** + +```bash +btcli config remove-proxy [OPTIONS] +``` + +**Parameters:** + +| Options | Type | Description | +| -------- | ---- | ------------------------------- | +| `--name` | | Name of the proxy to be removed | +| `--help` | | Show this message and exit. | + +### `btcli config update-proxy` + +**Usage:** + +```bash +btcli config update-proxy [OPTIONS] +``` + +**Parameters:** + +| Options | Type | Description | +| -------------- | ------- | ---------------------------------- | +| `--name` | | Name of the proxy | +| `--address` | | The SS58 address of the pure proxy | +| `--proxy_type` | | The type of this pure proxy | +| `--spawner` | | The SS58 address of the spawner | +| `--delay` | INTEGER | Delay, in blocks. | +| `--note` | TEXT | Any notes about this entry | +| `--help` | | Show this message and exit. | + ## `btcli view` Display html dashboard with subnets list, stake, and neuron information. @@ -1069,6 +1155,7 @@ alias: st - `transfer`: Transfer stake between coldkeys while keeping the same hotkey ownership. - `swap`: Swap stake between different subnets while keeping the same coldkey-hotkey pair ownership. - `claim`: Set the root claim type for your coldkey, alias `set-claim`. +- `wizard`: Interactive wizard that guides you through stake movement operations. - `process-claim`: Manually claim accumulated root network emissions for your coldkey. - `child`: Child Hotkey commands, alias: `children` - `children` @@ -1121,6 +1208,10 @@ Common Examples: ```sh btcli stake add --all --netuid 3 ``` +8. Stake without MEV protection: + ```sh + btcli stake add --amount 100 --netuid 1 --no-mev-protection + ``` Safe Staking Parameters:--safe: Enables rate tolerance checks `--tolerance`: Maximum % rate change allowed (0.05 = 5%) @@ -1150,6 +1241,7 @@ btcli stake add [OPTIONS] | `--tolerance`, `--rate-tolerance` | FLOAT | Set the rate tolerance percentage for transactions (e.g. 0.1 for 0.1%) | | `--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 | +| `--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. | | `--quiet` | | Display only critical information on the console. | @@ -1248,11 +1340,16 @@ Common Examples: ``` btcli stake remove --all-alpha ``` +7. Unstake without MEV protection: + ```bash + btcli stake remove --amount 100 --netuid 1 --no-mev-protection + ``` Safe Staking Parameters: -`--safe`: Enables rate tolerance checks during unstaking -`--tolerance`: Max allowed rate change (0.05 = 5%) -`--partial`: Complete partial unstake if rates exceed tolerance + +- `--safe`: Enables rate tolerance checks during unstaking +- `--tolerance`: Max allowed rate change (0.05 = 5%) +- `--partial`: Complete partial unstake if rates exceed tolerance **Usage**: @@ -1280,6 +1377,7 @@ btcli stake remove [OPTIONS] | `--tolerance`, `--rate-tolerance` | FLOAT | Set the rate tolerance percentage for transactions (e.g. 0.1 for 0.1%) | | `--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 | +| `--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. | | `--interactive`, `-t` | | Enter interactive mode for unstaking. | @@ -1354,22 +1452,28 @@ This command allows you to: You can specify: -- The origin subnet (--origin-netuid) -- The destination subnet (--dest-netuid) -- The destination hotkey (--dest-hotkey) -- The amount to move (--amount) +- The origin subnet (`--origin-netuid`) +- The destination subnet (`--dest-netuid`) +- The destination hotkey (`--dest-hotkey`) +- The amount to move (`--amount`) If no arguments are provided, an interactive selection menu will be shown. -**Example:** +1. Interactive move (guided prompts): -``` +```bash btcli stake move ``` -**Usage**: +2. Move stake without MEV protection: -```console +```bash +btcli stake move --no-mev-protection +``` + +**Usage:** + +```bash btcli stake move [OPTIONS] ``` @@ -1386,6 +1490,7 @@ btcli stake move [OPTIONS] | `to`, `--dest-ss58`, `--dest` | TEXT | Destination validator hotkey SS58. | | `--amount` | FLOAT | The amount of TAO to stake | | `--stake-all`, `--all` | | Stake all. | +| `--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. | | `--quiet` | | Display only critical information on the console. | @@ -1420,12 +1525,30 @@ Transfer 100 TAO from subnet 1 to subnet 2: btcli stake transfer --origin-netuid 1 --dest-netuid 2 --dest wallet2 --amount 100 ``` -Using SS58 address: +Using Destination SS58 address: ``` btcli stake transfer --origin-netuid 1 --dest-netuid 2 --dest 5FrLxJsyJ5x9n2rmxFwosFraxFCKcXZDngEP9H7qjkKgHLcK --amount 100 ``` +Using Origin hotkey SS58 address (useful when transferring stake from a delegate): + +```bash +btcli stake transfer --wallet-hotkey 5FrLxJsyJ5x9n2rmxFwosFraxFCKcXZDngEP9H7qjkKgHLcK --wallet-name sample_wallet +``` + +Transfer all available stake from origin hotkey: + +```bash +btcli stake transfer --all --origin-netuid 1 --dest-netuid 2 +``` + +Transfer stake without MEV protection: + +```bash +btcli stake transfer --origin-netuid 1 --dest-netuid 2 --amount 100 --no-mev-protection +``` + **Usage**: ```console @@ -1445,6 +1568,7 @@ btcli stake transfer [OPTIONS] | `--dest-ss58`, `--dest` | TEXT | The destination wallet name or SS58 address to transfer stake to. | | `--amount` | FLOAT | The amount of stake to transfer. | | `--stake-all`, `--all` | | Stake all. | +| `--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. | | `--quiet` | | Display only critical information on the console. | @@ -1464,20 +1588,26 @@ This command allows you to: You can specify: -- The origin subnet (--origin-netuid) -- The destination subnet (--dest-netuid) -- The amount to swap (--amount) +- The origin subnet (`--origin-netuid`) +- The destination subnet (`--dest-netuid`) +- The amount to swap (`--amount`) If no arguments are provided, an interactive selection menu will be shown. -**Example:** +**Examples:** -Swap 100 TAO from subnet 1 to subnet 2: +1. Swap 100 TAO from subnet 1 to subnet 2: -``` +```bash btcli stake swap --wallet-name default --wallet-hotkey default --origin-netuid 1 --dest-netuid 2 --amount 100 ``` +2. Swap stake without MEV protection: + +```bash +btcli stake swap --origin-netuid 1 --dest-netuid 2 --amount 100 --no-mev-protection +``` + **Usage**: ```console @@ -1500,11 +1630,56 @@ btcli stake swap [OPTIONS] | `--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. | +### `btcli stake wizard` + +Interactive wizard that guides you through stake movement operations. + +This wizard helps you understand and choose the right stake movement command: + +- Move: Move stake between hotkeys (same coldkey) +- Transfer: Transfer stake between coldkeys (same hotkey) +- Swap: Swap stake between subnets (same coldkey-hotkey pair) + +The wizard will: + +1. Explain the differences between each operation +2. Help you select the appropriate operation +3. Guide you through the selection process +4. Execute the operation with your choices + +**EXAMPLE** + +Start the wizard: + +```bash +btcli stake wizard +``` + +**Usage:** + +```bash +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. | + ### `btcli stake claim` Set the root claim type for your coldkey. @@ -1515,13 +1690,16 @@ Root claim types control how staking emissions are handled on the ROOT network ( - Swap: Future Root Alpha Emissions are swapped to TAO and added to root stake (default) - Keep: Future Root Alpha Emissions are kept as Alpha tokens +- Keep Specific: Keep specific subnets as Alpha, swap others to TAO. You can use this type by selecting the netuids. **USAGE:** ```bash -btcli stake claim -btcli stake claim keep -btcli stake claim swap +btcli stake claim (Full wizard) +btcli stake claim keep (Keep all subnets) +btcli stake claim swap (Swap all subnets) +btcli stake claim keep --netuids 1-5,10,20-30 (Keep specific subnets) +btcli stake claim swap --netuids 1-30 (Swap specific subnets) ``` With specific wallet: @@ -1546,6 +1724,7 @@ If a claim type—`keep` or `swap`—is not provided, you'll be prompted to choo | Options | Type | Description | | --------------------------------------------------------------------------- | ---- | ------------------------------------------------------------------------------------ | +| `--netuids`, `-n` | TEXT | Netuids to select. Supports ranges and comma-separated values, e.g., '1-5,10,20-30'. | | `--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 | @@ -2396,6 +2575,12 @@ btcli subnets create btcli subnets create --subnet-name MySubnet --github-repo https://github.com/myorg/mysubnet --subnet-contact team@mysubnet.net ``` +3. Create subnet without MEV protection: + +```bash +btcli subnets create --no-mev-protection +``` + **Usage**: ```console @@ -2417,6 +2602,7 @@ btcli subnets create [OPTIONS] | `--discord-handle`, `discord` | TEXT | The Discord handle for the subnet. | | `--description` | TEXT | The description for the subnet. | | `--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. | | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | From 197542f2a9f96ef8fbe1625db0fff22015f00014 Mon Sep 17 00:00:00 2001 From: Dera Okeke Date: Tue, 16 Dec 2025 22:07:05 +0100 Subject: [PATCH 2/3] added --proxy flags --- docs/btcli/btcli.md | 1134 ++++++++++++++++++++++++------------------- 1 file changed, 623 insertions(+), 511 deletions(-) diff --git a/docs/btcli/btcli.md b/docs/btcli/btcli.md index aa5ed6d40..d153a57ef 100644 --- a/docs/btcli/btcli.md +++ b/docs/btcli/btcli.md @@ -371,16 +371,18 @@ alias: associate_hotkey **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 name or SS58 address of the hotkey. | -| `--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. | -| `--prompt`, `--prompt`, `--no-prompt`, `--yes`, `--no_prompt`, `-y` | | Enable or disable interactive prompts. | -| `--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 name or SS58 address of the hotkey. | +| `--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. | +| `--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. | +| `--help` | | Show this message and exit. | | | ### `btcli wallet swap-hotkey` @@ -414,20 +416,21 @@ alias: swap_hotkey **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 | -| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). | -| ` --all-netuids`/`--no-all-netuids`, | | Use all netuids | -| `--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. | -| `--prompt`, `--prompt`, `--no-prompt`, `--yes`, `--no_prompt`, `-y` | | Enable or disable interactive prompts. | -| `--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 | +| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). | +| ` --all-netuids`/`--no-all-netuids`, | | Use all netuids | +| `--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. | +| `--prompt`, `--prompt`, `--no-prompt`, `--yes`, `--no_prompt`, `-y` | | Enable or disable interactive prompts. | +| `--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. | +| `--help` | | Show this message and exit. | ### `btcli wallet swap-coldkey` @@ -453,17 +456,19 @@ alias: swap_coldkey **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 | -| `--new-coldkey`, `--new-coldkey-ss58`, `--new-wallet`, `--new` | TEXT | SS58 address of the new coldkey that will replace the current one. | -| `--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. | -| `--force`, `--force-swap`, `-f` | | Force the swap even if the new coldkey is already scheduled for a swap. | -| `--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 | +| `--new-coldkey`, `--new-coldkey-ss58`, `--new-wallet`, `--new` | TEXT | SS58 address of the new coldkey that will replace the current one. | +| `--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. | +| `--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. | +| `--help` | | Show this message and exit. | | | ### `btcli wallet swap-check` @@ -946,22 +951,24 @@ btcli wallet transfer [OPTIONS] **Options**: -| Option | Type | Description | -| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------ | -| `--destination`, `--dest`, `-d` | TEXT | Destination address (ss58) of the wallet (coldkey). | -| `--amount`, `-a` | FLOAT | Amount (in TAO) to transfer. | -| `--all` | | Transfer all available balance. | -| `--all` | | Whether to display the balances for all the wallets. | -| `--period`, `-era` | INTEGER | Length (in blocks) for which the transaction should be valid. | -| `--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 | -| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. | -| `--prompt`, `--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. | +| Option | Type | Description | +| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| `--destination`, `--dest`, `-d` | TEXT | Destination address (ss58) of the wallet (coldkey). | +| `--amount`, `-a` | FLOAT | Amount (in TAO) to transfer. | +| `--all` | | Transfer all available balance. | +| `--all` | | Whether to display the balances for all the wallets. | +| `--period`, `-era` | INTEGER | Length (in blocks) for which the transaction should be valid. | +| `--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. | +| `--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 | +| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. | +| `--prompt`, `--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. | ### `btcli wallet set-identity` @@ -995,24 +1002,26 @@ alias: set_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 | -| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. | -| `--id-name` | TEXT | The display name for the identity. | -| `--web-url`, `--web` | TEXT | The web URL for the identity. | -| `--image-url`, `--image` | TEXT | The image URL for the identity. | -| `--discord` | TEXT | The Discord handle for the identity. | -| `--description` | TEXT | The description for the identity. | -| `--additional` | TEXT | Additional details for the identity. | -| `--github` | TEXT | The GitHub repository for the identity. | -| `--prompt`, `--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. | +| 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 | +| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. | +| `--id-name` | TEXT | The display name for the identity. | +| `--web-url`, `--web` | TEXT | The web URL for the identity. | +| `--image-url`, `--image` | TEXT | The image URL for the identity. | +| `--discord` | TEXT | The Discord handle for the identity. | +| `--description` | TEXT | The description for the identity. | +| `--additional` | TEXT | Additional details for the identity. | +| `--github` | TEXT | The GitHub repository for the 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. | +| `--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 get-identity` @@ -1237,6 +1246,8 @@ btcli stake add [OPTIONS] | `--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 | +| `--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. | | `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. | | `--tolerance`, `--rate-tolerance` | FLOAT | Set the rate tolerance percentage for transactions (e.g. 0.1 for 0.1%) | | `--safe-staking`, `--safe`/`--no-safe-staking`, `--unsafe` | | Enable or disable safe staking mode. | @@ -1284,19 +1295,21 @@ btcli stake set-auto [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`. | -| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). | -| `--quiet` | | Display only critical information on the console. | -| `--verbose` | | Enable verbose output. | -| `--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. | -| `--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. | +| `--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`. | +| `--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. | +| `--quiet` | | Display only critical information on the console. | +| `--verbose` | | Enable verbose output. | +| `--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. | +| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | +| `--help` | | Show this message and exit. | ### `btcli stake remove` @@ -1374,6 +1387,8 @@ btcli stake remove [OPTIONS] | `--include-hotkeys`, `-in` | TEXT | Specifies hotkeys by name or ss58 address to unstake from. For example, `-in hk1,hk2` | | `--exclude-hotkeys`, `-ex` | TEXT | Specifies hotkeys by name or ss58 address to not to unstake from (use this option only with `--all-hotkeys`) i.e. `--all-hotkeys -ex hk3,hk4` | | `--all-hotkeys`/ `--no-all-hotkeys` | | When set, this command unstakes from all hotkeys associated with the wallet. Do not use if specifying hotkeys in `--include-hotkeys`. | +| `--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. | | `--tolerance`, `--rate-tolerance` | FLOAT | Set the rate tolerance percentage for transactions (e.g. 0.1 for 0.1%) | | `--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 | @@ -1479,24 +1494,26 @@ btcli stake move [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`. | -| `from`, `-H`, `--hotkey`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey`, `--hotkey-ss58` | TEXT | Validator hotkey or SS58 where the stake is currently located. | -| `--origin-netuid` | INTEGER | Origin netuid. | -| `--dest-netuid` | INTEGER | Destination netuid. | -| `to`, `--dest-ss58`, `--dest` | TEXT | Destination validator hotkey SS58. | -| `--amount` | FLOAT | The amount of TAO to stake | -| `--stake-all`, `--all` | | Stake all. | -| `--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. | -| `--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`. | +| `from`, `-H`, `--hotkey`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey`, `--hotkey-ss58` | TEXT | Validator hotkey or SS58 where the stake is currently located. | +| `--origin-netuid` | INTEGER | Origin netuid. | +| `--dest-netuid` | INTEGER | Destination netuid. | +| `to`, `--dest-ss58`, `--dest` | TEXT | Destination validator hotkey SS58. | +| `--amount` | FLOAT | The amount of TAO to stake | +| `--stake-all`, `--all` | | Stake all. | +| `--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. | +| `--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. | +| `--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 transfer` @@ -1557,24 +1574,26 @@ btcli stake transfer [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` | INTEGER | The netuid to transfer stake from. | -| `--dest-netuid` | INTEGER | The netuid to transfer stake to. | -| `--dest-ss58`, `--dest` | TEXT | The destination wallet name or SS58 address to transfer stake to. | -| `--amount` | FLOAT | The amount of stake to transfer. | -| `--stake-all`, `--all` | | Stake all. | -| `--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. | -| `--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` | INTEGER | The netuid to transfer stake from. | +| `--dest-netuid` | INTEGER | The netuid to transfer stake to. | +| `--dest-ss58`, `--dest` | TEXT | The destination wallet name or SS58 address to transfer stake to. | +| `--amount` | FLOAT | The amount of stake to transfer. | +| `--stake-all`, `--all` | | Stake all. | +| `--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. | +| `--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. | +| `--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 swap` @@ -1616,25 +1635,27 @@ 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. | -| `--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. | +| `--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. | ### `btcli stake wizard` @@ -1722,18 +1743,20 @@ If a claim type—`keep` or `swap`—is not provided, you'll be prompted to choo **Parameters:** -| Options | Type | Description | -| --------------------------------------------------------------------------- | ---- | ------------------------------------------------------------------------------------ | -| `--netuids`, `-n` | TEXT | Netuids to select. Supports ranges and comma-separated values, e.g., '1-5,10,20-30'. | -| `--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`, `-n` | TEXT | Netuids to select. Supports ranges and comma-separated values, e.g., '1-5,10,20-30'. | +| `--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. | +| `--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. | +| `--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 process-claim` @@ -1866,23 +1889,25 @@ alias: children **Options**: -| Option | Type | Description | -| ------------------------------------------------------------------------------------------ | ------- | ------------------------------------------------------------------------------------------------ | -| `--children`, `-c` | TEXT | Enter child hotkeys (ss58) | -| `--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 | -| `--netuid` | INTEGER | The netuid of the subnet in the network. | -| `--all-netuids`/`--no-all-netuids` | | Use all netuids. | -| `--proportions`, `--prop` | FLOAT | Enter the stake weight proportions for the child hotkeys (sum should be less than or equal to 1) | -| `--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. | -| `--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. | -| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | -| `--help` | | Show this message and exit. | +| Option | Type | Description | +| ------------------------------------------------------------------------------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| `--children`, `-c` | TEXT | Enter child hotkeys (ss58) | +| `--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 | +| `--netuid` | INTEGER | The netuid of the subnet in the network. | +| `--all-netuids`/`--no-all-netuids` | | Use all netuids. | +| `--proportions`, `--prop` | FLOAT | Enter the stake weight proportions for the child hotkeys (sum should be less than or equal to 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. | +| `--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. | +| `--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. | +| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | +| `--help` | | Show this message and exit. | #### `btcli stake child revoke` @@ -1906,21 +1931,23 @@ alias: children **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 | -| `--netuid` | INTEGER | The netuid of the subnet in the network. | -| `--all-netuids`, `--all`, `--allnetuids` | | When this flag is used it sets child hotkeys on all the subnets. | -| `--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. | -| `--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. | -| `--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 | +| `--netuid` | INTEGER | The netuid of the subnet in the network. | +| `--all-netuids`, `--all`, `--allnetuids` | | When this flag is used it sets child hotkeys on all the subnets. | +| `--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. | +| `--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. | +| `--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. | +| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | +| `--help` | | Show this message and exit. | #### `btcli stake child take` @@ -1952,23 +1979,25 @@ alias: children **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 | -| `--child-hotkey-ss58` | TEXT | The hotkey SS58 to designate as child (not specifying will use the provided wallet's hotkey) | -| `--netuid` | INTEGER | The netuid of the subnet in the network. | -| `--all-netuids`, `--all`, `--allnetuids` | | When this flag is used it sets child hotkeys on all the subnets. | -| `--take` | FLOAT | Use to set the take value for your child hotkey. When not used, the command will fetch the current take value. | -| `--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. | -| `--prompt`, `--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. | +| 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 | +| `--child-hotkey-ss58` | TEXT | The hotkey SS58 to designate as child (not specifying will use the provided wallet's hotkey) | +| `--netuid` | INTEGER | The netuid of the subnet in the network. | +| `--all-netuids`, `--all`, `--allnetuids` | | When this flag is used it sets child hotkeys on all the subnets. | +| `--take` | FLOAT | Use to set the take value for your child hotkey. When not used, the command will fetch the current take value. | +| `--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. | +| `--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. | +| `--prompt`, `--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. | ## `btcli sudo` @@ -2015,20 +2044,22 @@ btcli sudo set [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 | -| `--netuid` | INTEGER | The netuid of the subnet in the network. | -| `--param`, `--parameter` | TEXT | The subnet hyperparameter to set | -| `--value` | TEXT | Value to set the hyperparameter to. | -| `--prompt`, `--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. | +| 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 | +| `--netuid` | INTEGER | The netuid of the subnet in the network. | +| `--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. | +| `--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. | +| `--verbose` | | Enable verbose output. | +| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | +| `--help` | | Show this message and exit. | ### `btcli sudo get` @@ -2138,18 +2169,20 @@ alias: senate_vote **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 | -| `--proposal`, `--proposal-hash` | TEXT | The hash of the proposal to vote on. | -| `--prompt`, `--prompt`, `--no-prompt`, `--yes`, `--no_prompt`, `-y` | | Enable or disable interactive prompts. | -| `--quiet` | | Display only critical information on the console. | -| `--verbose` | | Enable verbose output. | -| `--vote-aye/--vote-nay` | | The vote cast on the proposal | -| `--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 | +| `--proposal`, `--proposal-hash` | TEXT | The hash of the proposal to vote on. | +| `--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. | +| `--quiet` | | Display only critical information on the console. | +| `--verbose` | | Enable verbose output. | +| `--vote-aye/--vote-nay` | | The vote cast on the proposal | +| `--help` | | Show this message and exit. | ### `btcli sudo set-take` @@ -2174,18 +2207,20 @@ alias: set_take **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 | -| `--take` | FLOAT | The new take value. | -| `--prompt`, `--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. | +| 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 | +| `--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. | +| `--take` | FLOAT | The new take value. | +| `--prompt`, `--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. | ### `btcli sudo get-take` @@ -2238,19 +2273,23 @@ btcli sudo trim [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 | -| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). | -| `--max`, `--max-uids` | INTEGER | The maximum number of allowed uids to which to trim | -| `--quiet` | | Display only critical information on the console. | -| `--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. | -| `--help` | | Show this message and exit. | +| 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 | +| `--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. | +| `--max`, `--max-uids` | INTEGER | The maximum number of allowed uids to which to trim | +| `--quiet` | | Display only critical information on the console. | +| `--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. | ## `btcli subnets` @@ -2273,6 +2312,7 @@ aliases: subnet, s - `list`: List all subnets and their detailed information. - `burn-cost`: Shows the required amount of TAO to be recycled for creating a new subnet, i.e., cost of registering a new subnet. - `create`: Registers a new subnet on the network. +- `start`: Starts a subnet's emission schedule. - `pow-register`: Register a neuron (a subnet validator or a subnet miner) using Proof of Work (POW). - `register`: Register a neuron (a subnet validator or a subnet miner) in the specified subnet by recycling some TAO. - `metagraph`: Displays detailed information about a... @@ -2357,21 +2397,23 @@ btcli subnet mechanisms set [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 | -| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). | -| `--count`, `--mech-count` | INTEGER | Number of mechanisms to set for the subnet. | -| `--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. | -| `--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. | +| `--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 | +| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). | +| `--count`, `--mech-count` | INTEGER | Number of mechanisms to set for the subnet. | +| `--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. | +| `--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. | +| `--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 subnet mechanisms emissions` @@ -2428,21 +2470,23 @@ alias: emissions-split **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 | -| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). | -| `--split` | TEXT | Comma-separated relative weights for each mechanism (normalised automatically). | -| `--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. | -| `--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. | +| `--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 | +| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). | +| `--split` | TEXT | Comma-separated relative weights for each mechanism (normalised automatically). | +| `--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. | +| `--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. | +| `--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 subnets hyperparameters` @@ -2589,25 +2633,27 @@ btcli subnets create [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 | -| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. | -| `--subnet-name` | TEXT | Name of the subnet. | -| `--github-repo`, `repo` | TEXT | The GitHub repository URL. | -| `--subnet-contact`, `--contact`, `--email` | TEXT | Contact email for subnet. | -| `--subnet-url`, `--url` | TEXT | The web URL for the subnet. | -| `--discord-handle`, `discord` | TEXT | The Discord handle for the subnet. | -| `--description` | TEXT | The description for the subnet. | -| `--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. | -| `--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 | +| `--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. | +| `--subnet-name` | TEXT | Name of the subnet. | +| `--github-repo`, `repo` | TEXT | The GitHub repository URL. | +| `--subnet-contact`, `--contact`, `--email` | TEXT | Contact email for subnet. | +| `--subnet-url`, `--url` | TEXT | The web URL for the subnet. | +| `--discord-handle`, `discord` | TEXT | The Discord handle for the subnet. | +| `--description` | TEXT | The description for the subnet. | +| `--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. | +| `--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 subnets pow-register` @@ -2687,6 +2733,8 @@ btcli subnets register [OPTIONS] | `-H`, `--hotkey`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | | `--netuid`, | INTEGER | The netuid of the subnet in the network, (e.g. 1). | | `--period`, `-era` | INTEGER | Length (in blocks) for which the transaction should be valid. Note that it is possible that if you use an era for this transaction that you may pay a different fee to register than the one stated. | +| `--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. | | `--quiet` | | Display only critical information on the console. | | `--verbose` | | Enable verbose output. | @@ -2880,25 +2928,27 @@ alias: set_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 | -| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. | -| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). | -| `--subnet-name`, `--sn-name` | TEXT | Name of the subnet | -| `--github-repo`, `repo` | TEXT | The GitHub repository URL. | -| `--subnet-contact`, `--contact`, `--email` | TEXT | Contact email for subnet. | -| `--subnet-url`, `--url` | TEXT | The web URL for the subnet. | -| `--discord-handle`, `discord` | TEXT | The Discord handle for the subnet. | -| `--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. | -| `--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 | +| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. | +| `--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. | +| `--subnet-name`, `--sn-name` | TEXT | Name of the subnet | +| `--github-repo`, `repo` | TEXT | The GitHub repository URL. | +| `--subnet-contact`, `--contact`, `--email` | TEXT | Contact email for subnet. | +| `--subnet-url`, `--url` | TEXT | The web URL for the subnet. | +| `--discord-handle`, `discord` | TEXT | The Discord handle for the subnet. | +| `--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. | +| `--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 subnets get-identity` @@ -2929,6 +2979,41 @@ alias: get_identity | `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | | `--help` | | Show this message and exit. | +### `btcli subnets start` + +Starts a subnet's emission schedule. + +The owner of the subnet must call this command to start the emission schedule. + +Example: + +```bash +btcli subnets start --netuid 1 +btcli subnets start --netuid 1 --wallet-name alice +``` + +**Usage:** + +```bash +btcli subnets start [OPTIONS] +``` + +**Parameters:** + +| Options | Type | Description | +| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| `--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. | +| `--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. | +| `--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. | +| `--quiet` | | Display only critical information on the console. | +| `--verbose` | | Enable verbose output. | +| `--help` | | Show this message and exit. | + ### `btcli subnets set-symbol` Allows the user to update their subnet symbol to a different available symbol. The full list of available symbols can be found here: @@ -2953,18 +3038,21 @@ btcli subnets set-symbol [OPTIONS] **Parameters:** -| Options | Type | Description | -| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------ | -| `--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. | -| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). | -| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | -| `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | -| `--quiet` | | Display only critical information on the console. | -| `--verbose` | | Enable verbose output. | -| `--help` | | Show this message and exit. | +| Options | Type | Description | +| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| `--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. | +| `--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. | +| `--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. | +| `--quiet` | | Display only critical information on the console. | +| `--verbose` | | Enable verbose output. | +| `--help` | | Show this message and exit. | ## `btcli weights` @@ -3005,21 +3093,23 @@ btcli weights reveal [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 | -| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. | -| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). | -| `--uids`, `-u` | TEXT | Corresponding UIDs for the specified netuid, e.g. -u 1,2,3 .. | -| `--weights`, `-w` | TEXT | Weights for the specified UIDs, e.g. `-w 0.2,0.4,0.1 ...` Must correspond to the order of the specified UIDs. | -| `--salt`, `-s` | TEXT | Corresponding salt for the hash function, e.g. -s 163,241,217 ... | -| `--prompt`, `--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. | +| 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 | +| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. | +| `--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. | +| `--uids`, `-u` | TEXT | Corresponding UIDs for the specified netuid, e.g. -u 1,2,3 .. | +| `--weights`, `-w` | TEXT | Weights for the specified UIDs, e.g. `-w 0.2,0.4,0.1 ...` Must correspond to the order of the specified UIDs. | +| `--salt`, `-s` | TEXT | Corresponding salt for the hash function, e.g. -s 163,241,217 ... | +| `--prompt`, `--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. | ### `btcli weights commit` @@ -3044,21 +3134,23 @@ btcli weights commit [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 | -| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. | -| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). | -| `--uids`, `-u` | TEXT | Corresponding UIDs for the specified netuid, e.g. -u 1,2,3 .. | -| `--weights`, `-w` | TEXT | Weights for the specified UIDs, e.g. `-w 0.2,0.4,0.1 ...` Must correspond to the order of the specified UIDs. | -| `--salt`, `-s` | TEXT | Corresponding salt for the hash function, e.g. -s 163,241,217 ... | -| `--prompt`, `--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. | +| 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 | +| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. | +| `--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. | +| `--uids`, `-u` | TEXT | Corresponding UIDs for the specified netuid, e.g. -u 1,2,3 .. | +| `--weights`, `-w` | TEXT | Weights for the specified UIDs, e.g. `-w 0.2,0.4,0.1 ...` Must correspond to the order of the specified UIDs. | +| `--salt`, `-s` | TEXT | Corresponding salt for the hash function, e.g. -s 163,241,217 ... | +| `--prompt`, `--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. | ## `btcli crowd` @@ -3123,27 +3215,29 @@ btcli crowd create [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 | -| `--deposit` | FLOAT | Initial deposit in TAO to secure the crowdloan. | -| `--min-contribution`, `--min_contribution` | FLOAT | Minimum contribution amount in TAO. | -| `--cap` | INTEGER | Maximum amount in TAO the crowdloan will raise. | -| `--duration` | INTEGER | Crowdloan duration in blocks. | -| `--target-address`, `--target` | TEXT | Optional target SS58 address to receive the raised funds (for fundraising type). | -| `--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). | -| `--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. | +| 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 | +| `--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. | +| `--deposit` | FLOAT | Initial deposit in TAO to secure the crowdloan. | +| `--min-contribution`, `--min_contribution` | FLOAT | Minimum contribution amount in TAO. | +| `--cap` | INTEGER | Maximum amount in TAO the crowdloan will raise. | +| `--duration` | INTEGER | Crowdloan duration in blocks. | +| `--target-address`, `--target` | TEXT | Optional target SS58 address to receive the raised funds (for fundraising type). | +| `--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). | +| `--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 crowd contribute` @@ -3170,21 +3264,23 @@ btcli crowd contribute [OPTIONS] **Parameters:** -| Options | Type | Description | -| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------ | -| `--crowdloan-id`, `--crowdloan_id`, `--id` | INTEGER | The ID of the crowdloan to display | -| `--amount`, `-a` | FLOAT | Amount to contribute in TAO | -| `--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 | -| `--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. | +| Options | Type | Description | +| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| `--crowdloan-id`, `--crowdloan_id`, `--id` | INTEGER | The ID of the crowdloan to display | +| `--amount`, `-a` | FLOAT | Amount to contribute in TAO | +| `--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 | +| `--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. | +| `--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 crowd withdraw` @@ -3202,20 +3298,22 @@ btcli crowd withdraw [OPTIONS] **Parameters:** -| Options | Type | Description | -| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------ | -| `--crowdloan-id`, `--crowdloan_id`, `--id` | INTEGER | The ID of the crowdloan to withdraw from | -| `--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 | -| `--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. | +| Options | Type | Description | +| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| `--crowdloan-id`, `--crowdloan_id`, `--id` | INTEGER | The ID of the crowdloan to withdraw from | +| `--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 | +| `--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. | +| `--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 crowd finalize` @@ -3234,20 +3332,22 @@ btcli crowd finalize [OPTIONS] **Parameters:** -| Options | Type | Description | -| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------ | -| `--crowdloan-id`, `--crowdloan_id`, `--id` | INTEGER | The ID of the crowdloan to finalize | -| `--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 | -| `--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. | +| Options | Type | Description | +| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| `--crowdloan-id`, `--crowdloan_id`, `--id` | INTEGER | The ID of the crowdloan to finalize | +| `--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 | +| `--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. | +| `--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 crowd update` @@ -3267,23 +3367,25 @@ btcli crowd update [OPTIONS] **Parameters:** -| Options | Type | Description | -| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------ | -| `--crowdloan-id`, `--crowdloan_id`, `--id` | INTEGER | The ID of the crowdloan to update | -| `--min-contribution`, `--min` | FLOAT | Update the minimum contribution amount (in TAO) | -| `--end`, `--end-block` | INTEGER | Update the end block number | -| `--cap` | FLOAT | Update the cap amount (in TAO) | -| `--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 | -| `--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. | +| Options | Type | Description | +| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| `--crowdloan-id`, `--crowdloan_id`, `--id` | INTEGER | The ID of the crowdloan to update | +| `--min-contribution`, `--min` | FLOAT | Update the minimum contribution amount (in TAO) | +| `--end`, `--end-block` | INTEGER | Update the end block number | +| `--cap` | FLOAT | Update the cap amount (in TAO) | +| `--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 | +| `--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. | +| `--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 crowd refund` @@ -3304,20 +3406,22 @@ btcli crowd refund [OPTIONS] **Parameters:** -| Options | Type | Description | -| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------ | -| `--crowdloan-id`, `--crowdloan_id`, `--id` | INTEGER | The ID of the crowdloan to refund | -| `--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 | -| `--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. | +| Options | Type | Description | +| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| `--crowdloan-id`, `--crowdloan_id`, `--id` | INTEGER | The ID of the crowdloan to refund | +| `--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. | +| `--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 | +| `--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 crowd dissolve` @@ -3338,20 +3442,22 @@ btcli crowd dissolve [OPTIONS] **Parameters:** -| Options | Type | Description | -| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------ | -| `--crowdloan-id`, `--crowdloan_id`, `--id` | INTEGER | The ID of the crowdloan to dissolve | -| `--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 | -| `--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. | +| Options | Type | Description | +| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| `--crowdloan-id`, `--crowdloan_id`, `--id` | INTEGER | The ID of the crowdloan to dissolve | +| `--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 | +| `--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. | +| `--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 crowd list` @@ -3456,21 +3562,23 @@ btcli liquidity add [OPTIONS] **Parameters:** -| Options | 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. | -| `--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 | -| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). | -| `--liquidity` | FLOAT | Amount of liquidity to add to the subnet. | -| `--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. | -| `--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` | TEXT | 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 | +| `--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. | +| `--liquidity` | FLOAT | Amount of liquidity to add to the subnet. | +| `--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. | +| `--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 list` @@ -3508,20 +3616,22 @@ btcli liquidity modify [OPTIONS] **Parameters:** -| Options | 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. | -| `--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 | -| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). | -| `--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. | -| `--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` | TEXT | 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 | +| `--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. | +| `--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. | +| `--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 remove` @@ -3535,20 +3645,22 @@ btcli liquidity remove [OPTIONS] **Parameters:** -| Options | 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. | -| `--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 | -| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). | -| `--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. | -| `--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` | TEXT | 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 | +| `--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. | +| `--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. | +| `--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` From 8609c1d7fc35a8968c008626a90bffc0b136536b Mon Sep 17 00:00:00 2001 From: Dera Okeke Date: Wed, 17 Dec 2025 20:06:57 +0100 Subject: [PATCH 3/3] added proxy commands --- docs/btcli/btcli.md | 240 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 240 insertions(+) diff --git a/docs/btcli/btcli.md b/docs/btcli/btcli.md index d153a57ef..c754237dc 100644 --- a/docs/btcli/btcli.md +++ b/docs/btcli/btcli.md @@ -3152,6 +3152,246 @@ btcli weights commit [OPTIONS] | `--json-output`, `--json-out` | | Outputs the result of the command as JSON. | | `--help` | | Show this message and exit. | +## `btcli proxy` + +**Usage:** + +```sh +btcli proxy [OPTIONS] COMMAND [ARGS]... + +``` + +**Options:** + +`--help`: Show this message and exit. + +**Commands:** + +- `create`: Creates a new pure proxy account. The pure proxy account is a keyless account controlled by your wallet. +- `add` : Registers an existing account as a standard proxy for the delegator. +- `remove` : Unregisters a proxy from an account. +- `kill` Permanently removes a pure proxy account. +- `execute` + +### `btcli proxy create` + +Creates a new pure proxy account. The pure proxy account is a keyless account controlled by your wallet. + +:::info +The proxy account has no private key and cannot sign transactions independently. All operations must be initiated and signed by the delegator. +::: + +**Common Examples**: + +1. Create a pure proxy account + +```bash +btcli proxy create --proxy-type Any +``` + +2. Create a delayed pure proxy account + +```bash +btcli proxy create --proxy-type Any --delay 1000 +``` + +**Usage:** + +```bash +btcli proxy create [OPTIONS] +``` + +**Parameters:** + +| Options | Type | Description | +| --------------------------------------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `--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 | +| `--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. | +| `--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. | + +--- + +### `btcli proxy add` + +Registers an existing account as a standard proxy for the delegator. + +Grants an existing account permission to execute transactions on your behalf with +specified restrictions. + +**Common Examples**: + +1. Create a standard proxy account + +```bash +btcli proxy add --delegate 5GDeleg... --proxy-type SmallTransfer +``` + +2. Create a delayed standard proxy account + +```bash +btcli proxy add --delegate 5GDeleg... --proxy-type Transfer --delay 500 +``` + +**Usage:** + +```bash +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. | + +--- + +### `btcli proxy remove` + +Unregisters a proxy from an account. + +Revokes proxy permissions previously granted to another account. This prevents the delegate account from executing any further transactions on your behalf. + +**Example**: + +Revoke proxy permissions from a single proxy account + +```bash +btcli proxy remove --delegate 5GDel... --proxy-type Transfer +``` + +**Usage:** + +```bash +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. | + +--- + +### `btcli proxy kill` + +Permanently removes a pure proxy account. + +Once killed, the pure proxy account is cleared from chain storage and cannot be recovered. + +:::warning +Killing a pure proxy permanently removes access to the account, and any funds remaining in it are lost. +::: + +**EXAMPLE** + +```bash +btcli proxy kill --height 6345834 --index 3 --proxy-type Any --spawner 5x34SPAWN... --proxy 5CCProxy... +``` + +**Usage:** + +```bash +btcli proxy kill [OPTIONS] +``` + +**Parameters:** + +| Options | Type | Description | +| --------------------------------------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `--height` | INTEGER | The block number that the proxy was created at | +| `--ext_index` | INTEGER | The extrinsic index of the Proxy.PureCreated event (btcli proxy create) | +| `--spawner` | | The SS58 of the pure proxy creator account. If omitted, the wallet's coldkeypub is used. | +| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | | The subtensor network to connect to. Default: finney. | +| `--proxy-type` | | Type of proxy | +| `--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. | +| `--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. | +| `--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. | + +--- + +### `btcli proxy execute` + +**Usage:** + +```bash +btcli proxy execute [OPTIONS] +``` + +**Parameters:** + +| Options | Type | Description | +| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| `--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. | +| `--real` | TEXT | The real account making this call. If omitted, the proxy's ss58 is used. | +| `--delegate` | TEXT | The delegate of the call. If omitted, the wallet's coldkey ss58 is used. | +| `--call_hash` | TEXT | The hash proxy call to execute | +| `--call_hex` | TEXT | The hex of the call to specify | +| `--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 | +| `--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. | + ## `btcli crowd` **Usage:**