Skip to content

Commit

Permalink
chore: update docs (#294)
Browse files Browse the repository at this point in the history
* chore: update docs

* chore: update changelog

* chore: update validator docs

* chore: format docs
  • Loading branch information
shreyasbhat0 authored Oct 11, 2024
1 parent 25c18f0 commit b9658d5
Show file tree
Hide file tree
Showing 8 changed files with 697 additions and 4 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Contains all the PRs that improved the code without changing the behaviors.
- New accounts to handle rewards
- New Params to Arkeo Module
- Update validator distribution of rewards
- Testnet Genesis File

## Changed
- Removed unused module account
Expand All @@ -59,6 +60,7 @@ Contains all the PRs that improved the code without changing the behaviors.
- update module to implement APPModuleBasic and AppModule
- Updated Tests on arkeo module keeper
- version issue on begin blocker
- Fixed Genesis Url

# v1.0.0-Prerelease

Expand Down
2 changes: 1 addition & 1 deletion docs/TESTNET.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
## Download Genesis File
```bash
curl -s http://seed.innovationtheory.com:26657/genesis | jq '.result.genesis' > $HOME/.arkeo/config/genesis.json
curl -s http://seed31.innovationtheory.com:26657/genesis | jq '.result.genesis' > $HOME/.arkeo/config/genesis.json
```
---
Expand Down
26 changes: 23 additions & 3 deletions docs/VALIDATOR.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,32 @@ Becoming a validator involves running node and staking arkeo tokens to participa
```shell
arkeod keys add <your-wallet-name>
```
> For the new account balances wont be there if you're running a testnet validator please request tokens from the faucet
### Request Tokens From Faucet
To receive test tokens, follow these steps:

1. **Join the Discord Server**:
- Navigate to the official [Discord server](https://discord.com/invite/BfEHpm6uFc) for the testnet.

2. **Find the Faucet Channel**:
- In the Discord server, go to the **TESTNET** branch and select the **faucet** channel.

3. **Request Tokens**:
- In the **faucet** channel, type the following command:
```
$request <YOUR_WALLET_ADDRESS>
```
- Replace `<YOUR_WALLET_ADDRESS>` with the address you created in the previous step.
![Faucet](../docs/img/faucet.png "Faucet")
The faucet will send tokens to your wallet for use on the testnet.
### Check the balances
```shell
arkeod query bank balances $(arkeod keys show <your-wallet-name> -a)
```
> For the new account balances wont be there if you're running a testnet validator please request tokens from the faucet

## Create A Validator
> Don’t change anything if you don’t understand what you’re doing.
Expand Down Expand Up @@ -76,12 +96,12 @@ arkeod tx staking delegate YOUR_VALOPER_ADDRESS <token amount to stake>uarkeo --
Active validators list

```shell
arkeod query staking validators -o json | jq -r '.validators[] | select(.status=="BOND_STATUS_BONDED") | [.operator_address, .status, (.tokens|tonumber / pow(10; 6)), .description.moniker] | @csv' | column -t -s"," | sort -k3 -n -r
arkeod query staking validators -o json | jq -r '.validators[] | select(.status=="BOND_STATUS_BONDED") | [.operator_address, .status, (.tokens|tonumber / pow(10; 8)), .description.moniker] | @csv' | column -t -s"," | sort -k3 -n -r
```
Inactive validators list

```shell
arkeod query staking validators -o json | jq -r '.validators[] | select(.status=="BOND_STATUS_UNBONDED") | [.operator_address, .status, (.tokens|tonumber / pow(10; 6)), .description.moniker] | @csv' | column -t -s"," | sort -k3 -n -r
arkeod query staking validators -o json | jq -r '.validators[] | select(.status=="BOND_STATUS_UNBONDED") | [.operator_address, .status, (.tokens|tonumber / pow(10; 8)), .description.moniker] | @csv' | column -t -s"," | sort -k3 -n -r
```

## Remove Node:
Expand Down
Binary file added docs/img/faucet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
Loading

0 comments on commit b9658d5

Please sign in to comment.