Skip to content

Commit f694ac1

Browse files
chideraaochideraao
committed
btcli doc updates
1 parent 0ae7622 commit f694ac1

File tree

2 files changed

+130
-4
lines changed

2 files changed

+130
-4
lines changed

‎docs/btcli.md‎

Lines changed: 129 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ btcli [OPTIONS] COMMAND [ARGS]...
3838
- `subnets`: Subnets commands, alias: `s`, `subnet`
3939
- `weights`: Weights commands, aliases: `wt`, `weight`
4040
- `utils`
41-
- `view`
41+
- `view`: HTML view commands
42+
- `liquidity`: Liquidity commands, aliases: `l`
4243

4344
## `btcli config`
4445

@@ -2322,6 +2323,131 @@ btcli utils convert [OPTIONS]
23222323
| `--tao` | FLOAT | Convert amount from Tao |
23232324
| `--help` | | Show this message and exit. |
23242325

2325-
---
2326+
## `btcli liquidity`
2327+
2328+
**Usage:**
2329+
2330+
```sh
2331+
btcli liquidity [OPTIONS] COMMAND [ARGS]...
2332+
2333+
alias: l
2334+
```
2335+
2336+
Options:
2337+
2338+
`--help`: Show this message and exit.
2339+
2340+
Commands:
2341+
2342+
- `add`: Add liquidity to the swap (as a combination of TAO + Alpha).
2343+
- `list`: Displays liquidity positions in given subnet.
2344+
- `modify`: Modifies the liquidity position for the given subnet.
2345+
- `remove`: Remove liquidity from the swap (as a combination of TAO + Alpha).
2346+
2347+
### `btcli liquidity add`
2348+
2349+
Add liquidity to the swap (as a combination of TAO + Alpha).
2350+
2351+
**Usage:**
2352+
2353+
```bash
2354+
btcli liquidity add [OPTIONS]
2355+
```
2356+
2357+
**Parameters:**
2358+
2359+
| Options | Type | Description |
2360+
| ---------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------ |
2361+
| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. |
2362+
| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. |
2363+
| `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. |
2364+
| `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet |
2365+
| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). |
2366+
| `--liquidity` | FLOAT | Amount of liquidity to add to the subnet. |
2367+
| `--price-low`, `--price_low`, `--liquidity-price-low`, `--liquidity_price_low` | FLOAT | Low price for the adding liquidity position. |
2368+
| `--price-high`, `--price_high`, `--liquidity-price-high`, `--liquidity_price_high` | FLOAT | High price for the adding liquidity position. |
2369+
| `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. |
2370+
| `--quiet` | | Display only critical information on the console. |
2371+
| `--verbose` | | Enable verbose output. |
2372+
| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. |
2373+
| `--help` | | Show this message and exit. |
2374+
2375+
### `btcli liquidity list`
2376+
2377+
Displays liquidity positions in given subnet.
2378+
2379+
**Usage:**
2380+
2381+
```bash
2382+
btcli liquidity list [OPTIONS]
2383+
```
2384+
2385+
**Parameters:**
2386+
2387+
| Options | Type | Description |
2388+
| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------ |
2389+
| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. |
2390+
| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. |
2391+
| `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. |
2392+
| `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet |
2393+
| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). |
2394+
| `--quiet` | | Display only critical information on the console. |
2395+
| `--verbose` | | Enable verbose output. |
2396+
| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. |
2397+
| `--help` | | Show this message and exit. |
2398+
2399+
### `btcli liquidity modify`
2400+
2401+
Modifies the liquidity position for the given subnet.
2402+
2403+
**Usage:**
2404+
2405+
```bash
2406+
btcli liquidity modify [OPTIONS]
2407+
```
2408+
2409+
**Parameters:**
2410+
2411+
| Options | Type | Description |
2412+
| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------ |
2413+
| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. |
2414+
| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. |
2415+
| `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. |
2416+
| `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet |
2417+
| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). |
2418+
| `--position-id`, `--position_id` | INTEGER | Position ID for modification or removing. |
2419+
| `--liquidity-delta`, `--liquidity_delta` | FLOAT | Liquidity amount for modification. |
2420+
| `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. |
2421+
| `--quiet` | | Display only critical information on the console. |
2422+
| `--verbose` | | Enable verbose output. |
2423+
| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. |
2424+
| `--help` | | Show this message and exit. |
23262425

2327-
Made with :heart: by The Openτensor Foundaτion
2426+
### `btcli liquidity remove`
2427+
2428+
Remove liquidity from the swap (as a combination of TAO + Alpha).
2429+
2430+
**Usage:**
2431+
2432+
```bash
2433+
btcli liquidity remove [OPTIONS]
2434+
```
2435+
2436+
**Parameters:**
2437+
2438+
| Options | Type | Description |
2439+
| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------ |
2440+
| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. |
2441+
| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. |
2442+
| `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. |
2443+
| `--hotkey`, `-H`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey` | TEXT | Hotkey of the wallet |
2444+
| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). |
2445+
| `--position-id`, `--position_id` | INTEGER | Position ID for modification or removal. |
2446+
| `--all`, `--a` | | Whether to remove all liquidity positions for given subnet. |
2447+
| `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. |
2448+
| `--quiet` | | Display only critical information on the console. |
2449+
| `--verbose` | | Enable verbose output. |
2450+
| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. |
2451+
| `--help` | | Show this message and exit. |
2452+
2453+
---

‎docs/emissions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Each block, liquidity is also set aside to be emitted to participants (validator
102102
At the end of each tempo (360 blocks), the quantity of alpha accumulated over each block of the tempo is extracted by network participants in the following proportions:
103103

104104
1. 18% by subnet owner
105-
1. 41% of emissions go to miners. The allocation to particular miners is determined by [Yuma Consensus: Miner emissions#miner-emissions](./yuma-consensus).
105+
1. 41% of emissions go to miners. The allocation to particular miners is determined by [Yuma Consensus: Miner emissions#miner-emissions](../yuma-consensus).
106106
1. 41% by validators and their stakers.
107107

108108
1. First, the allocation to validators miners is determined by [Yuma Consensus: Validator Emissions](./yuma-consensus#validator-emissions).

0 commit comments

Comments
 (0)