forked from atomone-hub/atomone-validator-community
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add AtomOne node instructions and best practices (atomone-hub#3)
* chore: add atomone-1 node instructions * chore(ci): add github actions for gentx checking * chore: update commission rate params * chore: remove ci, will be a different PR * chore: update commission text * chore(docs): mention the git checkout version * fix: typos * Update atomone-1/README.md Co-authored-by: Giuseppe Natale <12249307+giunatale@users.noreply.github.com> * Update atomone-1/README.md Co-authored-by: Giuseppe Natale <12249307+giunatale@users.noreply.github.com> * Update atomone-1/README.md Co-authored-by: Giuseppe Natale <12249307+giunatale@users.noreply.github.com> * fix: Giussepe reviews suggestion --------- Co-authored-by: Giuseppe Natale <12249307+giunatale@users.noreply.github.com>
- Loading branch information
Showing
4 changed files
with
75 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
# 🔗 `atomone-1` | ||
|
||
 | ||
 | ||
<!--  --> | ||
|
||
## Proposed base genesis file | ||
|
||
The candidate base genesis file resulting from the currently on-chain govgen proposals [1](https://app.govgen.io/proposals/1) and [3](https://app.govgen.io/proposals/3) is available at https://atomone.fra1.digitaloceanspaces.com/genesis.json | ||
|
||
This genesis file is of course missing the validators gentxs, which will need to be collected and added to the genesis to be able to launch the chain. | ||
|
||
For more information on how the genesis was built please also look [here](https://github.com/atomone-hub/govbox/blob/master/PROP-001.md). | ||
|
||
## Register in the Genesis | ||
|
||
To register your validator node in the `genesis.json` you will need to provide a signed `gentx` with an initial delegation of at least `1000000uatone`. | ||
To create your own genesis transaction (`gentx`) you will have to choose the following parameters for your validator: `commission-rate` (>=0.05), `commission-max-rate`, `commission-max-change-rate`, `min-self-delegation` (>=1), `website` (optional), `details` (optional), `identity` ([keybase](https://keybase.io) key hash, used to get validator logos in block explorers - optional), `security-contact` (email - optional). | ||
|
||
The `commission-rate`, `commission-max-rate`, `commission-max-change-rate` are free to set to the value you want, this values are just for example, note that 0.05 is 5%. | ||
|
||
```sh | ||
# Create the gentx | ||
atomoned genesis gentx your-key-name 1000000uatone \ | ||
--node-id $(atomoned tendermint show-node-id) \ | ||
--chain-id atomone-1 \ | ||
--commission-rate 0.05 \ | ||
--commission-max-rate 0.1 \ | ||
--commission-max-change-rate 0.05 \ | ||
--min-self-delegation 1 \ | ||
--website "https://foo.network" \ | ||
--details "My validator" \ | ||
--identity "id-from-keybase" \ | ||
--security-contact "security@foo.network" | ||
``` | ||
|
||
## Operate the node | ||
|
||
### Install the binary | ||
|
||
- You can install the proposed chain binary from github release page | ||
|
||
https://github.com/atomone-hub/atomone/releases/tag/v1.0.0 | ||
|
||
- Build from the source | ||
|
||
You need to have [go](https://go.dev/doc/install) installed | ||
|
||
```sh | ||
$ git clone https://github.com/atomone-hub/atomone.git | ||
$ cd atomone | ||
$ git checkout v1.0.0 | ||
$ make install | ||
``` | ||
|
||
### Recommendations | ||
|
||
| minimum-gas-prices | 0.001uatone | | ||
|--------------------|------------------------------------------------------| | ||
| seeds | see [./seeds.txt](./seeds.txt) | | ||
| persistent_peers | see [./persistent_peers.txt](./persistent_peers.txt) | | ||
|
||
|
||
## Hardware recommendation | ||
|
||
AtomOne is a relatively simple and vanilla Cosmos SDK chain with minor modifications. The recommended minimum hardware requirements should be enough to comfortably be able to run a validator node. | ||
|
||
- 4 Cores | ||
- 8 GB RAM | ||
- 512 GB disk space (could increase over time, will need to monitor disk usage) | ||
|
||
|
||
## Network informations | ||
|
||
You can get a list of public Explorers, RPCs, seed node, persistent_peers... on [cosmos.directory/atomone](https://cosmos.directory/atomone) |
Empty file.
Empty file.
Empty file.