Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: testnet 5 documentation for Babylon validators #369

Open
wants to merge 22 commits into
base: main
Choose a base branch
from

Conversation

samricotta
Copy link

@samricotta samricotta commented Oct 26, 2024

Summary

With testnet 5 coming up we need information for developers to join the network. This doc explains the validator setup

Here are the required materials:

  • in the confluence page

Questions for reviewer:

For the following do I need to elaborate on this?
Explainer of the epoching mechanism and when you should expect to see your validator online.

@samricotta samricotta marked this pull request as draft October 26, 2024 11:42
@samricotta samricotta changed the title docs: testnet documentation for Babylon validators docs: testnet 5 documentation for Babylon validators Oct 26, 2024
Copy link
Member

@vitsalis vitsalis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First parsing mainly containing comments on the structure of the document

bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
Copy link
Member

@vitsalis vitsalis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2nd round focusing a little bit more on the text

bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
filippos47
filippos47 previously approved these changes Nov 8, 2024
Copy link
Member

@filippos47 filippos47 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice work Sam! Like the consolidated version!

bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
@samricotta samricotta marked this pull request as ready for review November 11, 2024 11:39
- `start`: This is the command to start the Babylon node.
- `--chain-id bbn-test-5`: Specifies the ID of the blockchain network you're connecting to.
- `--home=./nodeDir`: Sets the directory for the node's data and configuration files and is dependant on where the files were generated for you from the initialization. In this case, it's using a directory named "nodeDir" in the current path.
- `--minimum-gas-prices=0.005ubbn`: This flag sets the minimum gas price for transactions the node will accept. This can also be manually set in the `app.toml`
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

--x-crisis-skip-assert-invariants - add this

bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Show resolved Hide resolved
bbn-test-5/babylon-node/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-node/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-node/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-node/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-node/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
```shell
cat > <path>/config/validator.json << EOF
{
"pubkey": $(cat pubkey.json),

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where can I find the pubkey.json?
Looks like it's generated from babylond tendermint show-validator command

--gas-adjustment 1.5 \
--gas-prices "0.005ubbn" \
--from <your-key-name>
```

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to add the --keyring-backend test here?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@maiquanghiep we would if we are using keys no?

bbn-test-5/babylon-node/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-node/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-node/README.md Outdated Show resolved Hide resolved
Comment on lines +64 to +69
If the `babylond` command isn't found, ensure `$GOPATH/bin` is in your shell's
`$PATH`. Add it with:

```shell
echo 'export PATH=$HOME/go/bin:$PATH' >> ~/.profile
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a cross-platform command?

bbn-test-5/babylon-node/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-node/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-node/README.md Show resolved Hide resolved
## Setup the required keys for operating a validator
### Keys for a CometBFT validator

>Note: if you already have set up a key, you can skip this section.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we bring the keyring setup section in this doc, we won't have to duplicate this info.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you elaborate on this?

bbn-test-5/babylon-validators/README.md Outdated Show resolved Hide resolved
bbn-test-5/babylon-validators/README.md Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants