diff --git a/commune/vali/vali.yaml b/commune/vali/vali.yaml index d489ddf5..29109a31 100644 --- a/commune/vali/vali.yaml +++ b/commune/vali/vali.yaml @@ -17,9 +17,8 @@ worker_fn_name: worker # voting vote: True min_stake: 1 -vote_interval: 10 -vote_timeout: 50 -min_count_before_vote: 100 +vote_interval: 100 # the interval to vote (in blocks (8 seconds per block)) +vote_timeout: 50 # the timeout for the vote (in blocks) voting_networks: ['subspace', 'bittensor'] # stats @@ -31,7 +30,6 @@ latency_score_weight: 0.2 alpha: 0.5 # the ma average vote_tag : null - # workers mode: thread batch_size: 32 # the batch size for the worker @@ -50,6 +48,3 @@ clone_suffix : clone - - - diff --git a/commune/vali/vali_docs.md b/commune/vali/vali_docs.md deleted file mode 100644 index 5e0e1d57..00000000 --- a/commune/vali/vali_docs.md +++ /dev/null @@ -1,91 +0,0 @@ - - -## Deploying a Validator Tutorial - -In this tutorial, you will learn how to deploy a validator on the network and perform various tasks related to staking, registration, and validation. - - - -### Step 1: Registering a Validator - -To register a validator with a specific tag, use the following CLI command: - -```bash -c vali register tag=whadup -``` - -```python -c.module('vali').register(tag='whadup') -``` - -This creates a key with "vali::whadup". - -You can also serve it and register it with the following commands: - - ```bash - c serve vali::whadup - c register vali::whadup -``` - - -### Step 2A: Staking Your Validator - -Ensure that you have staked your validator by following these steps: - -1. Stake your validator with another key using the CLI command: - - ```bash - c stake vali::whadup {amount} - ``` - - The default amount to be staked is your entire balance. If you don't have a balance, you'll need to unstake. - -2. If needed, you can unstake by using the following command: - - ```bash - c unstake {amount} - ``` - - -### Step 2B: Staking to Multiple Validators - -You can stake to multiple validators by using the following command: - - -Stake 100 form your balance to vali::whadup and vali::whadup2 - -```bash -c stake_many amount=100 modules=["vali::whadup","vali::whadup2"] -``` - - -### Step 2C: Stake Spread - -You can stake to multiple validators by using the following command: - - -Stake 100 form your balance to vali::whadup and vali::whadup2 - -```bash -c stake_spread whadup amount=100 -``` - - - -## Getting Your Validator's Status - -To get your validator's status, use the following command: - -```bash -c vstats -``` - -```python -c.vstats() -``` - -![Alt text](image.png) -output - - - diff --git a/docs/subspace/mining/miner.md b/docs/subspace/mining/miner.md index a15c2523..1538a1ae 100644 --- a/docs/subspace/mining/miner.md +++ b/docs/subspace/mining/miner.md @@ -10,8 +10,11 @@ To register a validator with a specific tag, use the following CLI command: INPUT ```bash -c serve model.openai::whadup # -c register model.openai::whadup subnet=commune +c serve model.openai::whadup # defaults to (netuid=0 subnet=commune key=model.openai::whadup) +c register vali::whadup # defaults to (netuid=0 subnet=commune key=module) +``` + + ``` ```python diff --git a/docs/subspace/mining/validator.md b/docs/subspace/mining/validator.md index d63cb4c6..040920f5 100644 --- a/docs/subspace/mining/validator.md +++ b/docs/subspace/mining/validator.md @@ -11,16 +11,54 @@ To register a validator with a specific tag, use the following CLI command: ```bash c vali register tag=whadup subnet=commune or -c serve vali::whadup netuid=0 subnet=commune -c register vali::whadup subnet=commune +c serve vali::whadup # defaults to (netuid=0 subnet=commune key=vali::whadup) +c register vali::whadup # defaults to (netuid=0 subnet=commune key=module) ``` -```python -vali = c.module('vali') -v.serve(tag='whadup', subnet=commune) -v.register(tag='whadup', subnet=commune) +If you want to register with another key + +```bash +c vali register tag=sup subnet=commune key=vali::whadup +``` + + +To check the status of the validator, use the following command: + +```bash +c call vali/module_info +# or +c s/get_module vali # or the module name +``` + +```python ``` + +```bash +{ + 'key': '5GN545yeaTEuzDEoD6EXPi4qFqQCABKNnsUyJfDHFYWzfmQi', + 'name': 'vali', + 'address': '135.180.26.167:50141', + 'emission': 6.440794074, + 'incentive': 0.0, + 'dividends': 0.005676356145571069, + 'last_update': 377547, + 'stake_from': [ + ['5GN545yeaTEuzDEoD6EXPi4qFqQCABKNnsUyJfDHFYWzfmQi', 48.812576334], + ['5CaWWhTk4D7fphZvjFHKyuaCerqe7uJm3EGNrynGzKczSBNP', 592.049591244], + ['5ESGbQnTo9RnHEdDpuCYcYDXAAVwHST6dZZ4b5c9JbVr2T3B', 107.994213725], + ['5EZtFXi8nT6cy55oqCsnsd2Za59PLBVSP9BSjzQEAgh3Pz8M', 0.188784108], + ['5GZBhMZZRMWCiqgqdDGZCGo16Kg5aUQUcpuUGWwSgHn9HbRC', 403642.241103174], + ['5EU6rPCkVbPkDJrDhgTmqzu5fpXXKjAdahUYjxKXWZ2U6Q8C', 2.27846803], + ['5F4sToiPYnbWkg795ryvY5iAVrgDKrpPZv53gaYWEVHHeuKC', 0.002085575], + ['5CPRaN54kf2cdFauG76kFepE4PeYTc2ttkF4VzF2GCxGaehb', 22322.431257368] + ], + 'delegation_fee': 50, + 'stake': 426715.998079558 +} + + +``` This creates a key with "vali::whadup". You can also serve it and register it with the following commands: @@ -45,12 +83,15 @@ vali.get_key('whadup') ``` -### Step 2: Staking Your Validator +or + +```bash +c get_key vali::whadup +``` -Ensure that you have staked your validator by following these steps: -### Step 2: Staking Your Validator +### Staking Your Validator Ensure that you have staked your validator by following these steps: