From ed776ba235d5333af9689dcd11f9744ac7a9876d Mon Sep 17 00:00:00 2001 From: latentvector Date: Sat, 8 Jun 2024 17:47:17 -0400 Subject: [PATCH] refactored docs --- docs/{blockchain => basics/subspace}/miner.md | 0 .../subspace}/register.md | 0 .../subspace}/staking.md | 14 +++++++------ .../{blockchain => basics/subspace}/subnet.md | 0 .../subspace}/transfer.md | 0 .../subspace}/validator.md | 0 docs/blackpaper/module_filesystem.md | 20 ------------------- 7 files changed, 8 insertions(+), 26 deletions(-) rename docs/{blockchain => basics/subspace}/miner.md (100%) rename docs/{blockchain => basics/subspace}/register.md (100%) rename docs/{blockchain => basics/subspace}/staking.md (96%) rename docs/{blockchain => basics/subspace}/subnet.md (100%) rename docs/{blockchain => basics/subspace}/transfer.md (100%) rename docs/{blockchain => basics/subspace}/validator.md (100%) delete mode 100644 docs/blackpaper/module_filesystem.md diff --git a/docs/blockchain/miner.md b/docs/basics/subspace/miner.md similarity index 100% rename from docs/blockchain/miner.md rename to docs/basics/subspace/miner.md diff --git a/docs/blockchain/register.md b/docs/basics/subspace/register.md similarity index 100% rename from docs/blockchain/register.md rename to docs/basics/subspace/register.md diff --git a/docs/blockchain/staking.md b/docs/basics/subspace/staking.md similarity index 96% rename from docs/blockchain/staking.md rename to docs/basics/subspace/staking.md index 987e05d45..9e4391f25 100644 --- a/docs/blockchain/staking.md +++ b/docs/basics/subspace/staking.md @@ -1,10 +1,11 @@ # Staking + ## Stake Tokens To stake on a module, you can use the following commands: ``` -c.stake(module=5HYnok8FmBEx9AekVUPzff9kW7ymyp9mrucQTeqTLfJoHu1S, amount=100, key='module') +c.stake(module=5HYnok8FmBEx9AekVUPzff9kW7ymyp9mrucQTeqTLfJoHu1S, amount=100, key='module', netuid=0) ``` ## Unstake Tokens @@ -54,12 +55,17 @@ or if you want to specify the same amount, just do the amounts as an integer ```bash c.stake_many(modules=[model1,model2], amounts=10) ``` +## Stake Transfer + +```bash +c stake_transfer vali.text.truthqa::commie1 vali::project_management amount=0.01 # default netuid=0 +``` ## List Your Staked Modules -c staked search=vali netuid=1 +c staked netuid=1 dividends stake_from delegation_fee stake vote_staleness 11 vali.text.truthqa::commie1 0.016297 836737 5 1543452 49 @@ -71,7 +77,3 @@ c staked search=vali netuid=1 Transfer stake from one module to another, if you dont specify the amount, the default is the entire stake towards the module -```bash -c stake_transfer vali.text.truthqa::commie1 vali::project_management amount=0.01 # default netuid=0 -``` - diff --git a/docs/blockchain/subnet.md b/docs/basics/subspace/subnet.md similarity index 100% rename from docs/blockchain/subnet.md rename to docs/basics/subspace/subnet.md diff --git a/docs/blockchain/transfer.md b/docs/basics/subspace/transfer.md similarity index 100% rename from docs/blockchain/transfer.md rename to docs/basics/subspace/transfer.md diff --git a/docs/blockchain/validator.md b/docs/basics/subspace/validator.md similarity index 100% rename from docs/blockchain/validator.md rename to docs/basics/subspace/validator.md diff --git a/docs/blackpaper/module_filesystem.md b/docs/blackpaper/module_filesystem.md deleted file mode 100644 index c2da0b1a8..000000000 --- a/docs/blackpaper/module_filesystem.md +++ /dev/null @@ -1,20 +0,0 @@ -The module filesystem helps organize where the location of modules are automatically - - -you have a folder - - -commune/ - - -Inside you have a folder you have the modules. Modules can be any python class that you want to use. -The modules are automatically loaded into the system and can be accessed by the system. - -Naming rules: -- The module name must be the same as the file name -- The module name must be unique -- The module name must be a valid python class name -- The module name must be a valid python file name - - -