From 849a74710c0f9c6ee5bd782ac5498b89c8ebd258 Mon Sep 17 00:00:00 2001 From: Dera Okeke Date: Tue, 16 Dec 2025 20:22:03 +0100 Subject: [PATCH 1/5] 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/5] 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/5] 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:** From 2ce92b52d443b4b8df3e2c3b3915ab0a527d9978 Mon Sep 17 00:00:00 2001 From: Dera Okeke Date: Tue, 30 Dec 2025 14:17:20 +0100 Subject: [PATCH 4/5] fixes --- docs/btcli/btcli.md | 60 ++++++++++++++++++++++----------------------- 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/docs/btcli/btcli.md b/docs/btcli/btcli.md index c754237dc..ae6c9e7e9 100644 --- a/docs/btcli/btcli.md +++ b/docs/btcli/btcli.md @@ -1306,8 +1306,8 @@ btcli stake set-auto [OPTIONS] | `--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. | +| `--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. | @@ -2407,8 +2407,8 @@ btcli subnet mechanisms set [OPTIONS] | `--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. | +| `--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. | @@ -2480,8 +2480,8 @@ alias: emissions-split | `--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. | +| `--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. | @@ -3213,8 +3213,8 @@ btcli proxy create [OPTIONS] | `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | | `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | | `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | -| `--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. | +| `--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. | @@ -3262,8 +3262,8 @@ btcli proxy add [OPTIONS] | `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | | `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | | `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | -| `--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. | +| `--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. | @@ -3304,8 +3304,8 @@ btcli proxy remove [OPTIONS] | `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | | `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | | `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | -| `--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. | +| `--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. | @@ -3352,8 +3352,8 @@ btcli proxy kill [OPTIONS] | `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | | `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | | `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | -| `--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. | +| `--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. | @@ -3384,8 +3384,8 @@ btcli proxy execute [OPTIONS] | `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | | `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | | `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | -| `--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. | +| `--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. | @@ -3472,8 +3472,8 @@ btcli crowd create [OPTIONS] | `--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. | +| `--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. | @@ -3515,8 +3515,8 @@ btcli crowd contribute [OPTIONS] | `--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. | +| `--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. | @@ -3548,8 +3548,8 @@ btcli crowd withdraw [OPTIONS] | `--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. | +| `--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. | @@ -3582,8 +3582,8 @@ btcli crowd finalize [OPTIONS] | `--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. | +| `--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. | @@ -3620,8 +3620,8 @@ btcli crowd update [OPTIONS] | `--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. | +| `--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. | @@ -3656,8 +3656,8 @@ btcli crowd refund [OPTIONS] | `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. | | `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet | | `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. | -| `--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. | +| `--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. | @@ -3692,8 +3692,8 @@ btcli crowd dissolve [OPTIONS] | `--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. | +| `--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. | From b3f32cbf7ae41aa586de4e8fa6e26706145dcba5 Mon Sep 17 00:00:00 2001 From: Dera Okeke Date: Mon, 5 Jan 2026 21:39:20 +0100 Subject: [PATCH 5/5] update proxy docs --- docs/keys/proxies/working-with-proxies.md | 122 ++++++++++------------ 1 file changed, 53 insertions(+), 69 deletions(-) diff --git a/docs/keys/proxies/working-with-proxies.md b/docs/keys/proxies/working-with-proxies.md index ce03b39e0..e80726a26 100644 --- a/docs/keys/proxies/working-with-proxies.md +++ b/docs/keys/proxies/working-with-proxies.md @@ -1,10 +1,11 @@ --- title: "Working with Proxies" +# toc_max_heading_level: 2 --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import { SdkVersion } from "../../sdk/_sdk-version.mdx"; +import { SdkVersion } from "../../sdk/\_sdk-version.mdx"; # Working with Proxies @@ -16,6 +17,7 @@ This page covers each step in the use of proxy wallets as a security feature for - Removing proxy relationships See: + - [Proxies: Overview](./index.md) - [Staking with a Proxy](./staking-with-proxy.md) @@ -23,9 +25,9 @@ See: ### Security Considerations -Proxy wallets are a powerful security feature, but to get the full benefits, it is critical to observe good key security. When one wallet serves as proxy for another (the 'safe wallet'), both the safe wallet and the proxy wallet have their own full coldkey keypair (the public key which goes into the wallet's address, and the private key, which is recoverable using the seed phrase), and must be handled with proper care. +Proxy wallets are a powerful security feature, but to get the full benefits, it is critical to observe good key security. When one wallet serves as proxy for another (the 'safe wallet'), both the safe wallet and the proxy wallet have their own full coldkey keypair (the public key which goes into the wallet's address, and the private key, which is recoverable using the seed phrase), and must be handled with proper care. -Generally, the safe wallet should be given the maximum security possible, whereas the proxy wallet (if it is carefully limited in its permissions), can be handled in a more convenient, less secure way. For example, a proxy might be loaded into a less trusted compute runtime, whereas the safe wallet's coldkey private key/seed phrase should *never* be loaded into any but the most absolutely secure device). However, depending on the proxy's configuration, compromise of a proxy wallet's coldkey can still be disastrous. For example, a proxy with `ProxyType`:`any` and `delay`:`0` can immediately perform any operation on behalf of the safe wallet, so leaking such a proxy key is just as bad as leaking the safe wallet key. +Generally, the safe wallet should be given the maximum security possible, whereas the proxy wallet (if it is carefully limited in its permissions), can be handled in a more convenient, less secure way. For example, a proxy might be loaded into a less trusted compute runtime, whereas the safe wallet's coldkey private key/seed phrase should _never_ be loaded into any but the most absolutely secure device). However, depending on the proxy's configuration, compromise of a proxy wallet's coldkey can still be disastrous. For example, a proxy with `ProxyType`:`any` and `delay`:`0` can immediately perform any operation on behalf of the safe wallet, so leaking such a proxy key is just as bad as leaking the safe wallet key. Before executing any operations with any coldkeys holding TAO on Bittensor main network, carefully think through the desired end result and the steps required to achieve it. @@ -35,7 +37,7 @@ See: [Coldkey and Hotkey Workstation Security](../coldkey-hotkey-security). #### Practice/Dev -To follow along with the below examples for practice, you have two options: +To follow along with the below examples for practice, you have two options: - [Run a Local Bittensor Blockchain Instance](../../local-build/deploy). - Follow along on test network, if you have some test TAO. @@ -65,7 +67,6 @@ For any wallet with real-value TAO (i.e. TAO on Bittensor's main network, `finne See: [Coldkey and Hotkey Workstation Security](../coldkey-hotkey-security). ::: - :::info Multiple proxy relationships can exist between a pair of wallets, as long as each proxy entry uses a different `ProxyType`. Attempting to register a duplicate entry with the same delegate and `ProxyType` will result in a `proxy.Duplicate` error. ::: @@ -77,7 +78,7 @@ Multiple proxy relationships can exist between a pair of wallets, as long as eac Run `btcli proxy add` to create a proxy relationship between existing wallets on-chain. -Note that `--wallet.name` specifies the *safe wallet*, since the private key must be loaded in for the safe wallet, not the proxy. This makes sense because it is the safe wallet that is *delegating* the authority to order transactions to the proxy wallet, so it must be authenticated with the private key using its encryption password. +Note that `--wallet.name` specifies the _safe wallet_, since the private key must be loaded in for the safe wallet, not the proxy. This makes sense because it is the safe wallet that is _delegating_ the authority to order transactions to the proxy wallet, so it must be authenticated with the private key using its encryption password. ```bash btcli proxy add \ @@ -87,19 +88,18 @@ btcli proxy add \ ``` **Parameters:** + - `--wallet.name`: Your wallet name (the real account that will authorize the proxy) - `--delegate`: The SS58 address of the proxy (i.e. the delegate of transaction power) - `--proxy-type`: The type of proxy relationship (e.g., `Staking`, `Transfer`, `Any`, etc.) - `--delay`: Optional delay in blocks (0 for immediate execution) - For our example, we'll use two wallets called `PracticeSafeWallet` and `PracticeProxy`. To follow along, create two new wallets with these names and substitute their coldkey ss58 addresses: -- PracticeSafeWallet: `5CS9x5NsPHpb2THeS92zBYCSSk4MFoQjjx76DB8bEzeJTTSt` -- PracticeProxy: `5CZmB94iEG4Ld7JkejAWToAw7NKEfV3YZHX7FYaqPGh7isXe` +- **`PracticeSafeWallet`**: `5CS9x5NsPHpb2THeS92zBYCSSk4MFoQjjx76DB8bEzeJTTSt` +- **`PracticeProxy`**: `5CZmB94iEG4Ld7JkejAWToAw7NKEfV3YZHX7FYaqPGh7isXe` - -To give PracticeProxy the ability to order small transfers from PracticeSafeWallet's balance immediately (with 0 delay), we'll use the following comand: +To give the `PracticeProxy` account the ability to order small transfers from the `PracticeSafeWallet` wallet's balance immediately (with 0 delay), we'll use the following comand: ```bash btcli proxy add \ @@ -118,22 +118,21 @@ Would you like to add this to your address book? [y/n]: y ### BTCLI's proxy address book - Use ` btcli config add-proxy` to configure your local BTCLI with a proxy relationship. Make sure to follow the instructions carefully depending on whether: + 1. You are using a proxy relationship between pre-existing wallets, as described on this page. This covers most use cases for proxies. 1. You are using a pure proxy. See [pure proxies](./pure-proxies). -View all saved proxies with: +View all saved proxies with: ```bash btcli config proxies ``` - ```console Name Address Spawner/Delegator Proxy Type Delay Note ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── - practice-proxying 5CngkPSSnhK7ot6zFv3Q… 5GrwvaEF5zXb26Fz9rcQ… Any 0 always be awesome + practice-proxying 5CngkPSSnhK7ot6zFv3Q… 5GrwvaEF5zXb26Fz9rcQ… Any 0 always be awesome practice-small-transfers 5GrwvaEF5zXb26Fz9rcQ… 5FLSigC9HGRKVhB9FiEo… SmallTransfer 0 small transfers only ``` @@ -182,7 +181,6 @@ The proxy type can be provided either by importing and using the `ProxyType` enu - ### Check an Account’s Proxies You can check which proxies are associated with an account to see their delegate addresses, proxy types, and any configured delays. To do this: @@ -229,13 +227,12 @@ This returns all the proxies associated to the account and their information—` - ## Execute a 0-Delay Proxy Call -A proxy wallet that is set up with a delay of 0 can execute transactions allowed by its proxy type simply by declaring which real account they are acting as proxy for. +A proxy wallet that is set up with a delay of 0 can execute transactions allowed by its proxy type simply by declaring which real account they are acting as proxy for. :::note consider security! -This operation will be run in a coldkey workstation that is set up for the *proxy wallet*, not the *safe wallet/real account*. For main network (`finney`) wallets, the safe wallet's coldkey private key should *never* be loaded onto the proxy workstation, otherwise we undermine the security advantage of the proxy relationship. The safe wallet's coldkey private key/seed phrase should be kept in cold storage as muchas possible, and should only be loaded into dedicated, highly secure, code environments provisioned specifically for that purpose. +This operation will be run in a coldkey workstation that is set up for the _proxy wallet_, not the _safe wallet/real account_. For main network (`finney`) wallets, the safe wallet's coldkey private key should _never_ be loaded onto the proxy workstation, otherwise we undermine the security advantage of the proxy relationship. The safe wallet's coldkey private key/seed phrase should be kept in cold storage as muchas possible, and should only be loaded into dedicated, highly secure, code environments provisioned specifically for that purpose. ::: @@ -245,11 +242,11 @@ This operation will be run in a coldkey workstation that is set up for the *prox Many `btcli` commands support the `--proxy` flag to proxy an operation on behalf of another wallet. :::note terminology and parameter names -The language here may be counter-intuitive, in that the `--proxy` flag specifies the wallet *being* proxied. +The language here may be counter-intuitive, in that the `--proxy` flag specifies the wallet _being_ proxied. -The wallet specified by `--wallet.name` is actually the wallet we normally call "the proxy", and `--proxy` specifies the safe wallet or 'real account'. It makes more sense if you think of the `--proxy` flag as specifying that the operation is being called *by* proxy for the wallet that follows, i.e., the safe wallet. +The wallet specified by `--wallet.name` is actually the wallet we normally call "the proxy", and `--proxy` specifies the safe wallet or 'real account'. It makes more sense if you think of the `--proxy` flag as specifying that the operation is being called _by_ proxy for the wallet that follows, i.e., the safe wallet. -More to the point, we can logically infer that it *must* be the case that `--wallet.name` refers to the proxy, and the ss58 supplied (in the `--proxy` field) must refer to the safe wallet, since this command is meant to be run by the proxy, protecting the safe wallet. Therefore, the proxy's private key must be present and unlocked, not the safe wallet's, which should remain in cold storage. +More to the point, we can logically infer that it _must_ be the case that `--wallet.name` refers to the proxy, and the ss58 supplied (in the `--proxy` field) must refer to the safe wallet, since this command is meant to be run by the proxy, protecting the safe wallet. Therefore, the proxy's private key must be present and unlocked, not the safe wallet's, which should remain in cold storage. ::: This command will transfer 18 TAO from PracticeSafeWallet to a third wallet, Miner. @@ -264,7 +261,9 @@ btcli wallet transfer \ --network test ``` + **Proxy params:** + - `--wallet.name`: The proxy wallet that signs the transaction on behalf of the real account. - `--proxy`: The real account's SS58 address (or proxy name from address book) @@ -285,9 +284,8 @@ Balance: 98.7739 τ ➡ 98.4409 τ ``` - :::tip Using saved proxies -If you saved a proxy to your address book with `btcli config add-proxy`, you can reference it by name: +If you haved a proxy relationship saved to your BTCLI address book, you can reference it by name as shown: ```bash btcli wallet transfer \ @@ -297,6 +295,7 @@ btcli wallet transfer \ --amount 0.333 \ --network test ``` + ::: @@ -400,6 +399,7 @@ btcli proxy remove \ ``` **Parameters:** + - `--wallet.name`: Your wallet name (the real account that authorized the proxy) - `--delegate`: The SS58 address of the delegate account to remove - `--proxy-type`: Must match the proxy type used when adding @@ -420,6 +420,7 @@ This will remove a proxy of type SmallTransfer for delegate 5CZmB94iEG4Ld7JkejAW to proceed? [y/n]: y ✅Success! ``` + :::info Removal is immediate Unlike delayed execution, removing a proxy takes effect immediately, regardless of any delay configured on the proxy. ::: @@ -517,7 +518,7 @@ else: If a proxy wallet has been given proxy powers to make a transaction with a delay, they must announce the call beforehand, and then wait the delay interval (specified by the `delay` parameter when the proxy relationship is created). -For example, the following command gives PracticeProxy the ability to make large transfers, but only after an announcement-delay period of 100 blocks: +For example, the following snippets give the `PracticeProxy` wallet the ability to make large transfers, but only after an announcement-delay period of 100 blocks: @@ -550,7 +551,7 @@ delegate_address = "DELEGATE_ADDRESS" # Your delegate wallet address response = subtensor.add_proxy( wallet=real_account, delegate_ss58=delegate_address, - proxy_type=ProxyType.Any, + proxy_type=ProxyType.Transfer, delay=100, # optional delay in blocks ) @@ -558,11 +559,9 @@ print(response) ``` - - ### Generate call hash Announcing a delayed proxy call requires the hash of the call that you intend to execute. Therefore, you must first generate the call hash of the transaction you want to carry out. To generate the call hash: @@ -571,8 +570,7 @@ Announcing a delayed proxy call requires the hash of the call that you intend to -When using `--announce-only`, BTCLI automatically generates and stores the call hash for you. You don't need to manually generate it. - +When you run a BTCLI command with the `--announce-only` flag, BTCLI automatically generates and adds the call hash to your `ProxyAnnouncements` address book. @@ -616,8 +614,7 @@ Do not submit the transaction after entering the parameters. Only copy the encod - - +--- ### Announce a proxy call Announcing a proxy call publishes the hash of a proxy-call that will be made in the future. To announce a delayed call: @@ -626,7 +623,7 @@ Announcing a proxy call publishes the hash of a proxy-call that will be made in -For delayed proxies, first announce the call using the `--announce-only` flag: +To announce a delayed proxy call via BTCLI, include the `--announce-only` flag when submitting the transaction, as shown: ```bash # The call hash is automatically generated and saved @@ -638,8 +635,11 @@ btcli wallet transfer \ --network test \ --announce-only - + ``` + +
+ Show sample output ```console Do you want to transfer: amount: 0.3330 τ @@ -650,24 +650,27 @@ Transferring is not the same as staking. To instead stake, use btcli stake add i Proceed with transfer? [y/n]: y Enter your password: Decrypting... -Added entry b'D\x99-\x9d\xa2:BqnQ\xb7\xb6\x99M\xc8\xe1\xd6;\xb2\x810\x15\x82y\xb3XLD\x90#\xd92' at block 5953000 to your -ProxyAnnouncements address book. +Added entry 1ca5322e23ea9e36e8c8f1b912c817b89ef1fdcaaf25cacb57c173147ca3abbd at block 5953000 to your +ProxyAnnouncements address book. You can execute this with +btcli proxy execute --call-hash 1ca5322e23ea9e36e8c8f1b912c817b89ef1fdcaaf25cacb57c173147ca3abbd + ✅ Finalized Block Hash: 0x1c6378ee38b8c27f161b646125ec301f1aa52bffd63b090ec0c0876c9cc56ba5 Balance: - 98.4409 τ ➡ 98.4409 τ -``` - +98.4409 τ ➡ 98.4409 τ +```` +
**What this does:** + - Creates and announces the call on-chain - Saves the announcement details to your local database - Does NOT execute the operation immediately -- The real account can reject it during the delay period **After announcing:** + 1. Wait for the configured delay period (in blocks) to pass -2. The real account has the option to reject the announcement +2. The real account has the option to reject the announcement during the delay period 3. Execute the call after the delay expires (see next step) @@ -710,7 +713,7 @@ response = subtensor.announce_proxy( print(response) # Save the call_hash - you'll need it to execute after the delay -``` +```` :::info Next, wait for the duration of the configured delay before executing the call. During the waiting period, the delegate can cancel the announcement—`subtensor.remove_proxy_announcement()`, while the real account retains final authority to reject it—`subtensor.reject_proxy_announcement()`. @@ -745,39 +748,24 @@ After the delay period has passed, execute the announced call: btcli proxy execute \ --wallet.name PracticeProxy \ --proxy 5CS9x5NsPHpb2THeS92zBYCSSk4MFoQjjx76DB8bEzeJTTSt \ - --real 5CS9x5NsPHpb2THeS92zBYCSSk4MFoQjjx76DB8bEzeJTTSt - --network test - - btcli wallet transfer \ - --wallet.name PracticeProxy \ - --proxy 5CS9x5NsPHpb2THeS92zBYCSSk4MFoQjjx76DB8bEzeJTTSt \ - --destination 5DA7UsaYbk1UnhhtTxqpwdqjuxhQ2rW7D6GTN1S1S5tC2NRV \ - --amount 0.333 \ - --network test \ - --announce-only + --real 5CS9x5NsPHpb2THeS92zBYCSSk4MFoQjjx76DB8bEzeJTTSt \ + --call-hash 1ca5322e23ea9e36e8c8f1b912c817b89ef1fdcaaf25cacb57c173147ca3abbd \ + --network test ``` **How it works:** + - Retrieves the previously announced call from your local database - Verifies the delay period has passed - Executes the call on-chain - Clears the announcement -**Manual execution:** -If you need to specify call details manually: +BTCLI automatically tracks announcements you make with `--announce-only` in a local database, making execution easier. This allows you to execute a delayed proxy by using the `--call-hash` flag. -```bash -btcli proxy execute \ - --wallet.name PracticeProxy \ - --proxy 5CS9x5NsPHpb2THeS92zBYCSSk4MFoQjjx76DB8bEzeJTTSt \ - --real 5CS9x5NsPHpb2THeS92zBYCSSk4MFoQjjx76DB8bEzeJTTSt \ - --delegate 5CZmB94iEG4Ld7JkejAWToAw7NKEfV3YZHX7FYaqPGh7isXe \ - --call-hash 0x1c6378ee38b8c27f161b646125ec301f1aa52bffd63b090ec0c0876c9cc56ba5 \ - --network test -``` +:::warning +Using the `--call-hash` flag attempts to resolve the call from the proxy announcements address book. Use this flag only if you made the proxy announcement via BTCLI. -:::tip Automatic tracking -BTCLI automatically tracks announcements you make with `--announce-only` in a local database, making execution easier. +If the proxy call was announced through a different method, you must provide the encoded hex for the call using the `--call-hex` flag or rebuild the call explicitly via the command prompts. ::: @@ -847,16 +835,12 @@ The call you execute **must have the exact same parameters** as the call you ann - :::info - The call details on the executed proxy must exactly match the original announcement. Any change to the call or call hash will result in a `proxy.Unannounced` error. - Once a delayed proxy call is executed, its announcement is cleared. To execute another proxy with the same details, you must create a new announcement and wait for the waiting period to pass. ::: - - - ## Troubleshooting - `proxy.Duplicate`: A proxy with the same configuration already exists on the real account. See [source code: `Duplicate` error](https://github.com/opentensor/subtensor/blob/main/pallets/proxy/src/lib.rs#L739).