Skip to content

Commit 38e7c18

Browse files
MichaelTrestmanMichaelTrestman
committed
Merge branch 'main' into cr4-updates
2 parents 82ac677 + df5f474 commit 38e7c18

File tree

246 files changed

+39983
-33370
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

246 files changed

+39983
-33370
lines changed

‎docs/btcli/btcli.md‎

Lines changed: 73 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1153,6 +1153,55 @@ btcli stake add [OPTIONS]
11531153
| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. |
11541154
| `--help` | | Show this message and exit. |
11551155

1156+
### `btcli stake auto`
1157+
1158+
Display auto-stake destinations for a wallet across all subnets.
1159+
1160+
**Usage:**
1161+
1162+
```bash
1163+
btcli stake auto [OPTIONS]
1164+
```
1165+
1166+
**Parameters:**
1167+
1168+
| Options | Type | Description |
1169+
| --------------------------------------------------------------------------- | ---- | ------------------------------------------------------------------------------------ |
1170+
| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | | The subtensor network to connect to. Default: finney. |
1171+
| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. |
1172+
| `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. |
1173+
| `--ss58`, `--coldkey_ss58`, `--coldkey.ss58_address`, `--coldkey.ss58` | | Coldkey address of the wallet |
1174+
| `--quiet` | | Display only critical information on the console. |
1175+
| `--verbose` | | Enable verbose output. |
1176+
| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. |
1177+
| `--help` | | Show this message and exit. |
1178+
1179+
### `btcli stake set-auto`
1180+
1181+
Set the auto-stake destination hotkey for a coldkey.
1182+
1183+
**Usage:**
1184+
1185+
```bash
1186+
btcli stake set-auto [OPTIONS]
1187+
```
1188+
1189+
**Parameters:**
1190+
1191+
| Options | Type | Description |
1192+
| --------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------ |
1193+
| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | | The subtensor network to connect to. Default: finney. |
1194+
| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. |
1195+
| `--wallet-path`, `-p`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. |
1196+
| `--netuid` | INTEGER | The netuid of the subnet in the network, (e.g. 1). |
1197+
| `--quiet` | | Display only critical information on the console. |
1198+
| `--verbose` | | Enable verbose output. |
1199+
| `--prompt/--no-prompt`, ` /--yes`, ` /--no_prompt`, ` /-y` | | Enable or disable interactive prompts. |
1200+
| `--wait_for_inclusion` | | If `True`, waits until the transaction is included in a block. |
1201+
| `--wait_for_finalization` | | If `True`, waits until the transaction is finalized on the blockchain. |
1202+
| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. |
1203+
| `--help` | | Show this message and exit. |
1204+
11561205
### `btcli stake remove`
11571206

11581207
Unstake TAO from one or more hotkeys and transfer them back to the user's coldkey wallet.
@@ -1322,23 +1371,23 @@ btcli stake move [OPTIONS]
13221371

13231372
**Options**:
13241373

1325-
| Option | Type | Description |
1326-
| ------------------------------------------------------------------------------------------ | ------- | ------------------------------------------------------------------------------------ |
1327-
| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. |
1328-
| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. |
1329-
| `-p`, `--wallet-path`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. |
1330-
| `-H`, `--hotkey`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey`, `--hotkey-ss58` | TEXT | Hotkey name or SS58 address of the hotkey |
1331-
| `--origin-netuid` | INTEGER | Origin netuid. |
1332-
| `--dest-netuid` | INTEGER | Destination netuid. |
1333-
| `--dest-ss58`, `--dest` | TEXT | Destination hotkey. |
1334-
| `--amount` | FLOAT | The amount of TAO to stake |
1335-
| `--stake-all`, `--all` | | Stake all. |
1336-
| `--period`, `-era` | INTEGER | Length (in blocks) for which the transaction should be valid. |
1337-
| `--prompt`, `--prompt`, `--no-prompt`, `--yes`, `--no_prompt`, `-y` | | Enable or disable interactive prompts. |
1338-
| `--quiet` | | Display only critical information on the console. |
1339-
| `--verbose` | | Enable verbose output. |
1340-
| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. |
1341-
| `--help` | | Show this message and exit. |
1374+
| Option | Type | Description |
1375+
| -------------------------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------ |
1376+
| `--network`, `--subtensor.network`, `--chain`, `--subtensor.chain_endpoint` | TEXT | The subtensor network to connect to. Default: finney. |
1377+
| `--wallet-name`, `--name`, `--wallet_name`, `--wallet.name` | TEXT | Name of the wallet. |
1378+
| `-p`, `--wallet-path`, `--wallet_path`, `--wallet.path` | TEXT | Path where the wallets are located. For example: `/Users/btuser/.bittensor/wallets`. |
1379+
| `from`, `-H`, `--hotkey`, `--wallet_hotkey`, `--wallet-hotkey`, `--wallet.hotkey`, `--hotkey-ss58` | TEXT | Validator hotkey or SS58 where the stake is currently located. |
1380+
| `--origin-netuid` | INTEGER | Origin netuid. |
1381+
| `--dest-netuid` | INTEGER | Destination netuid. |
1382+
| `to`, `--dest-ss58`, `--dest` | TEXT | Destination validator hotkey SS58. |
1383+
| `--amount` | FLOAT | The amount of TAO to stake |
1384+
| `--stake-all`, `--all` | | Stake all. |
1385+
| `--period`, `-era` | INTEGER | Length (in blocks) for which the transaction should be valid. |
1386+
| `--prompt`, `--prompt`, `--no-prompt`, `--yes`, `--no_prompt`, `-y` | | Enable or disable interactive prompts. |
1387+
| `--quiet` | | Display only critical information on the console. |
1388+
| `--verbose` | | Enable verbose output. |
1389+
| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. |
1390+
| `--help` | | Show this message and exit. |
13421391

13431392
### `btcli stake transfer`
13441393

@@ -1971,7 +2020,7 @@ alias: mech
19712020
- `count`: Display how many mechanisms are registered under a subnet.
19722021
- `set`: Configure how many mechanisms are registered for a subnet.
19732022
- `emissions`: Display the current emission split across mechanisms for a subnet.
1974-
- `emissions-split`: Update the emission split across mechanisms for a subnet.
2023+
- `split-emissions`: Update the emission split across mechanisms for a subnet.
19752024

19762025
#### `btcli subnet mechanisms count`
19772026

@@ -2067,7 +2116,7 @@ btcli subnet mechanisms emissions [OPTIONS]
20672116
| `--json-output`, `--json-out` | | Outputs the result of the command as JSON. |
20682117
| `--help` | | Show this message and exit. |
20692118

2070-
#### `btcli subnet mechanisms emissions-split`
2119+
#### `btcli subnet mechanisms split-emissions`
20712120

20722121
Update the emission split across mechanisms for a subnet.
20732122

@@ -2078,19 +2127,21 @@ Common Examples:
20782127
1. Configure the split interactively:
20792128

20802129
```bash
2081-
btcli subnet mechanisms emissions-split --netuid 12
2130+
btcli subnet mechanisms split-emissions --netuid 12
20822131
```
20832132

20842133
2. Apply a 70/30 distribution in one command:
20852134

20862135
```bash
2087-
btcli subnet mechanisms emissions-split --netuid 12 --split 70,30 --wallet.name my_wallet --wallet.hotkey admin
2136+
btcli subnet mechanisms split-emissions --netuid 12 --split 70,30 --wallet.name my_wallet --wallet.hotkey admin
20882137
```
20892138

20902139
**Usage:**
20912140

20922141
```bash
2093-
btcli subnet mechanisms emissions-split [OPTIONS]
2142+
btcli subnet mechanisms split-emissions [OPTIONS]
2143+
2144+
alias: emissions-split
20942145
```
20952146

20962147
**Parameters:**

‎docs/evm-tutorials/bridge-vtao.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: "Token Bridging"
3+
---
4+
5+
# Token Bridging
6+
7+
This guide provides an overview of two related topics:
8+
- how to moves TAO between Substrate-style wallets (SS58) and the Etherum style wallets on Bittensor EVM
9+
- how to use vTAO as a token bridge between Bittensor EVM and other EVM chains.
10+
11+
:::info
12+
Bittensor EVM smart contracts are executed solely on the **Bittensor blockchain, _not_ on the Ethereum blockchain.**
13+
:::
14+
15+
## Transferring liquidity between Substrate and EVM Wallets on Bittensor Chain
16+
17+
**TAO** is the native token of the Bittensor network it exists on Subtensor, Bittensor's blockchain, which is built on top of Substrate. Hence, TAO is normally held in Substrate-style, ss58-format wallets, which can be used to execute Subtensor blockchain extrinsics, including through the Bittensor Python SDK and BTCLI.
18+
19+
See [Wallets, Coldkeys and Hotkeys in Bittensor](../keys/wallets)
20+
21+
If TAO is transferred to an Ethereum-style h160 wallet, it can be used in Bittensor's EVM layer. This is the same token, just represented in a different account format.
22+
23+
You can move TAO back and forth between Substrate and EVM wallets several ways:
24+
Use example scripts:
25+
- [Transfer TAO from H160 to SS58](./convert-h160-to-ss58)
26+
- [Transfer TAO from SS58 to H160](./transfer-from-metamask-to-ss58)
27+
- Using [`tao.app/bridge`](https://tao.app/bridge).
28+
29+
- Using OTF's EVM Bridge: [`bridge.bittensor.com/`](https://bridge.bittensor.com/)
30+
31+
## Bridge to other EVM Chains with vTAO
32+
33+
vTAO is a liquid-staked TAO token on the Subtensor EVM, available through ['tao.app/bridge'](https://tao.app/bridge).
34+
35+
- vTAO is minted by depositing TAO into a staking contract, the vTAO can later be redeemed for an amount of TAO depending on the exchange rate.
36+
- Your wallet balance in vTAO stays the same, but the underlying TAO locked in the contract increases with staking rewards.
37+
- vTAO can be bridged between supported EVM chains.
38+
39+
:::tip
40+
vTAO conceptually similar to [Lido's wstETH](https://docs.lido.fi/contracts/wsteth/).
41+
:::
42+
43+

‎docs/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ You can participate in an existing subnet as either a subnet validator or a subn
9797
body='Get ready to mine on Bittensor subnets' />
9898
<ResponsiveCard
9999
icon={GiArchiveRegister}
100-
title='Mining in Bittensor'
100+
title='Validating in Bittensor'
101101
link='./validators'
102102
body='Get ready to validate on Bittensor subnets' />
103103
<ResponsiveCard

‎docs/keys/_security-warning.mdx‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
/*
2+
Security Warning Partial
3+
*/
4+
5+
import Admonition from '@theme/Admonition';
6+
7+
export const SecurityWarning = () => (
8+
<Admonition type="danger" title="danger">
9+
<p>
10+
Neither the Opentensor Foundation nor Latent Holdings has the technical or legal ability to intervene if your tokens are lost due to theft, scam, or accidental loss of your keys. If you believe you have been the victim of a crime, contact your local law enforcement.
11+
</p>
12+
</Admonition>
13+
);

0 commit comments

Comments
 (0)