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(validators): onboarding guides for testnets+mainnet #4177

Merged
merged 1 commit into from
Oct 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions docs/docs/developer-guides/composable-cosmos-mainnet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Composable Cosmos chain mainnet: centauri-1

## Hardware recommendation
```
Quad core or larger amd64 CPU
64GB+ RAM
1TB+ NVMe Storage
```
## Binary

Mainnet launch version: v2.3.5, precompiled binary for linux-amd64 could be found here: https://github.com/notional-labs/composable-centauri/releases/tag/v2.3.5

```
git clone https://github.com/notional-labs/composable-centauri
cd composable-centauri
git checkout v5.2.2
make install
```
:::note
Ensure you are running the latest release, head to the [repository](https://github.com/notional-labs/composable-centauri) for the Composable Cosmos chain for assurance.
:::

## Genesis
Final mainnet genesis: https://raw.githubusercontent.com/notional-labs/composable-networks/main/mainnet/genesis.json
```
banksyd tendermint unsafe-reset-all
wget -O ~/.banksy/config/genesis.json https://raw.githubusercontent.com/notional-labs/composable-networks/main/mainnet/genesis.json
```

## P2P connection
You can set the peers/seeds in `config.toml`:
```
sed -i.bak -E "s|^(seeds[[:space:]]+=[[:space:]]+).*$|\1"'"[email protected]:2635"'"|" ~/.banksy/config/config.toml
```

*Seeds:*
```
[email protected]:2635
```

*Persistent peers:*
```
[email protected]:2630,[email protected]:53656
```

## Explorer

Nodestake: https://explorer.nodestake.top/composable/

Ping Pub: https://ping.pub/composable

## Snapshots
Fresh state synced snapshots and other mainnet materials could be found here: https://polkachu.com/networks/composable
Thanks to Polkachu.

## Creating the Validator

After getting your node synced and token ready, submit this transaction to create your validator:
```
centaurid tx staking create-validator --pubkey=$(centaurid tendermint show-validator) --moniker VAL_NAME --details="XXXX" --identity XXXX --security-contact XXXX --website XXXX --commission-max-rate 0.1 --commission-max-change-rate 0.05 --commission-rate 0.05 --min-self-delegation 1 --from YOUR_KEY --amount=1000000000000ppica --chain-id centauri-1
```

:::caution
Remember to back up your `priv_validator_key.json` in ~/.centauri/config/ alongside with the seed phrases to your wallet.
:::
43 changes: 43 additions & 0 deletions docs/docs/developer-guides/testnet-3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Composable Cosmos chain: Testnet 3


## Syncing materials

### Binary and config

Testnet-3 launch version: v2.3.5, precompiled binary for linux could be found here: https://github.com/notional-labs/composable-testnet/releases/tag/v2.3.5

```
cd ~/composable-testnet
git fetch --all
git checkout v2.3.5
make install
banksyd tendermint unsafe-reset-all
```

:::note
Ensure you are running the latest release, head to the [repository](https://github.com/notional-labs/composable-centauri) for the latest testnet releases.
:::

### Peers & seeds:
You can set the peers/seeds in `config.toml` or run the node with `--p2p.seeds="" --p2p.persistent_peers=""`

Feel free to PR your peers/seeds on the respective repository:

*Seeds:*
```
[email protected]:21500,
[email protected]:37656
```

### Download the genesis and start:
```
wget -O ~/.banksy/config/genesis.json https://raw.githubusercontent.com/notional-labs/composable-networks/main/banksy-testnet-3/genesis.json
banksyd start --p2p.seeds [email protected]:21500
```

## Explorer

Nodestake: https://explorer.nodestake.top/composable-testnet

Ping Pub: https://testnet.ping.pub/centauritestnet
94 changes: 94 additions & 0 deletions docs/docs/developer-guides/testnet-4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# Composable Cosmos Chain Testnet 4

## Information
- Network information: https://github.com/notional-labs/composable-networks/tree/main/banksy-testnet-4
- Chain ID: banksy-testnet-4
- Genesis: https://raw.githubusercontent.com/notional-labs/composable-networks/main/banksy-testnet-4/genesis.json
- Binary: https://github.com/notional-labs/composable-centauri/releases/tag/v5.2.4-testnet4
- Current version: v5.2.4-testnet4
- Peers: [email protected]:2260
- Public Notional endpoints:
- RPC: https://rpc-banksy4.notional.ventures:443
- API: https://api-banksy4.notional.ventures:443
- gRPC: http://168.119.91.22:2263
- Block Explorer: Coming soon

## Setup Instruction

**1. Building the binary**

There are two ways of setting up the `centaurid` binary, building from source or installing from binary URL, which is mentioned in the install script in the next section.

To build the binary from source, run these commands:

```
#mkdir $HOME/go/bin # ignore this command if you already have $HOME/go/bin folder
export PATH=$PATH:$HOME/go/bin
cd $HOME
git clone https://github.com/notional-labs/composable-centauri
cd composable-centauri
git checkout v5.2.4-testnet4 # Using v5.2.4-testnet4
make install
centaurid version # v5.2.4-testnet4
```

**2. Joining testnet**

Here is a full script to install `centaurid binary` and run the node with state sync. This script should be run with administration privileges by running `sudo script.sh`:

```
# script.sh
centaurid init <moniker> --chain-id banksy-testnet-4
wget https://raw.githubusercontent.com/notional-labs/composable-networks/main/banksy-testnet-4/genesis.json -O $HOME/.banksy/config/genesis.json


# state sync
SNAP_RPC="https://rpc-banksy4.notional.ventures:443"
LATEST_HEIGHT=$(curl -s $SNAP_RPC/block | jq -r .result.block.header.height); \
BLOCK_HEIGHT=$((LATEST_HEIGHT - 2000)); \
TRUST_HASH=$(curl -s "$SNAP_RPC/block?height=$BLOCK_HEIGHT" | jq -r .result.block_id.hash)
sed -i.bak -E "s|^(enable[[:space:]]+=[[:space:]]+).*$|\1true| ; \
s|^(rpc_servers[[:space:]]+=[[:space:]]+).*$|\1\"$SNAP_RPC,$SNAP_RPC\"| ; \
s|^(trust_height[[:space:]]+=[[:space:]]+).*$|\1$BLOCK_HEIGHT| ; \
s|^(trust_hash[[:space:]]+=[[:space:]]+).*$|\1\"$TRUST_HASH\"|" $HOME/.banksy/config/config.toml

# run node
centaurid start --p2p.seeds [email protected]:2260
```

**3. Join testnet as a validator**
To join `banksy-testnet-4` as a validator, you should setup a running node as in step 1 above and wait for it to be fully synced, and then setup validator:

- Create a key:
```
centaurid keys add <validator-key> # generate a new key, or use `--recover` to recover an existed key with mnemonic
```

- For testnet tokens, head to ethibc-testnet-faucet channel on the Composable discord and send the following message with your address included:

```
$request <address> composable
```

- To see the current balance of the address, run the following command:

```
$balance <address> composable
```

- Create validator:
```
centaurid tx staking create-validator --amount=1000000000000ppica --moniker="<validator-name>" --chain-id=banksy-testnet-4 --commission-rate="0.05" --commission-max-change-rate="0.01" --commission-max-rate="0.20" --from=<validator-key> --node=https://rpc-banksy4.notional.ventures:443 --gas=auto --min-self-delegation 10 --pubkey=$(centaurid tendermint show-validator)
```

To add validator info:

```
centaurid tx staking edit-validator \
--website="" \ # URL to validator website
--identity="" \ # keybase.io identity
--details="" \ # Additional detail
--security-contact="" \ # security email
--from=<validator-key> \
--node="https://rpc-banksy4.notional.ventures:443"
```
4 changes: 4 additions & 0 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,10 @@
"developer-guides/oracle-set-up-guide",
"developer-guides/collator-guide",
"developer-guides/local-picasso-guide",
"developer-guides/composable-cosmos-mainnet",
"developer-guides/testnet-3",
"developer-guides/testnet-4",

],
ecosystem: [
{
Expand Down
Loading