testnets/README.md

256 lines
8.0 KiB
Markdown
Raw Normal View History

2018-04-23 09:35:03 -07:00
# Deploy a Testnet
2018-04-23 08:48:33 -07:00
2018-04-27 13:53:11 -07:00
## Setup
If you're running a full node validator we recommend you to comply with the necessary [technical requirements](https://github.com/cosmos/cosmos/blob/master/VALIDATORS_FAQ.md#technical-requirements). You can check more information regarding validators in our [website](https://cosmos.network/validators) or in the [validator FAQ](https://cosmos.network/resources/validator-faq).
### Install the SDK on a Cloud Server
2018-04-28 10:13:03 -07:00
You can set up a cloud server of your choice to run a **non-validator** full node.
2018-04-27 13:53:11 -07:00
#### Digital Ocean Droplet
Follow these commands to install the SDK on a Digital Ocean [Droplet](https://www.digitalocean.com/products/droplets/):
2018-04-23 09:46:14 -07:00
```
export PATH=$PATH:/usr/lib/go-1.10/bin
export PATH=$PATH:/root/go/bin
bash <(curl -s https://gist.github.com/melekes/1bd57c73646de97c8f6cbe1b780eb822/raw/2447b0fbf95775852c93a91ed3e12631c7ceb648/install.sh)
nohup ./build/gaiad start &
```
2018-04-27 13:53:11 -07:00
### Software Setup (Manual Installation)
2018-04-23 09:46:14 -07:00
2018-04-27 13:53:11 -07:00
#### Install [GNU Wget](https://www.gnu.org/software/wget/)
2018-04-23 09:46:14 -07:00
**MacOS**
```
brew install wget
```
**Linux**
```
sudo apt-get install wget
```
Note: You can check other available options for downloading `wget` [here](https://www.gnu.org/software/wget/faq.html#download).
2018-04-27 13:53:11 -07:00
#### Install binaries
2018-04-23 09:46:14 -07:00
2018-04-27 13:53:11 -07:00
Cosmos SDK can be installed to `$GOPATH/src/github.com/cosmos/cosmos-sdk` like a normal Go program:
2018-04-23 09:46:14 -07:00
```
2018-04-27 13:53:11 -07:00
go get github.com/cosmos/cosmos-sdk
2018-04-24 17:43:53 -07:00
cd $GOPATH/src/github.com/cosmos/cosmos-sdk
2018-04-23 10:23:57 -07:00
git fetch --all
2018-04-28 10:13:03 -07:00
git checkout d613c2b9
2018-04-23 09:46:14 -07:00
make get_tools // run $ make update_tools if already installed
make get_vendor_deps
make install
```
2018-04-27 13:53:11 -07:00
This will install `gaiad` and `gaiacli` and four example binaries: `basecoind`, `basecli`, `democoind`, and `democli`. Verify that everything is OK by running:
2018-04-23 09:46:14 -07:00
```
gaiad version
gaiacli version
```
2018-04-27 13:53:11 -07:00
You should see in both cases:
2018-04-23 09:46:14 -07:00
```
2018-04-28 10:13:03 -07:00
0.15.0-rc0-d613c2b9
2018-04-23 09:46:14 -07:00
```
2018-04-27 13:53:11 -07:00
### Genesis Setup
2018-04-23 09:46:14 -07:00
2018-04-27 13:53:11 -07:00
Now that we have completed the basic SDK setup, we can start working on the genesis configuration for the chain we want to connect to. Initiliaze `gaiad` :
2018-04-23 09:46:14 -07:00
```
gaiad init
```
2018-04-27 13:53:11 -07:00
You can find the corresponding genesis files [here](https://github.com/cosmos/testnets). Then replace the `genesis.json` and `config.toml` files:
2018-04-23 09:46:14 -07:00
```
2018-04-23 11:41:18 -07:00
wget -O $HOME/.gaiad/config/genesis.json https://raw.githubusercontent.com/cosmos/testnet/master/gaia-4000/genesis.json
2018-04-23 09:46:14 -07:00
2018-04-23 11:41:18 -07:00
wget -O $HOME/.gaiad/config/config.toml https://raw.githubusercontent.com/cosmos/testnet/master/gaia-4000/config.toml
2018-04-23 09:46:14 -07:00
```
2018-04-27 13:53:11 -07:00
Lastly change the `moniker` string in the `config.toml` to identify your node.
2018-04-23 09:46:14 -07:00
```
# A custom human readable name for this node
moniker = "<your_custom_name>"
```
2018-04-27 13:53:11 -07:00
## Running a Full Node
2018-04-23 08:48:33 -07:00
2018-04-23 09:35:03 -07:00
Start the full node:
2018-04-23 08:48:33 -07:00
```
2018-04-23 09:35:03 -07:00
gaiad start
2018-04-23 08:48:33 -07:00
```
2018-04-23 09:35:03 -07:00
Check the everything is running smoothly:
2018-04-23 08:48:33 -07:00
```
2018-04-23 09:35:03 -07:00
gaiacli status
2018-04-23 08:48:33 -07:00
```
2018-04-27 13:53:11 -07:00
### Generate keys
2018-04-23 09:35:03 -07:00
You'll need a private and public key pair \(a.k.a. `sk, pk` respectively\) to be able to receive funds, send txs, bond tx, etc.
2018-04-24 09:46:34 -07:00
To generate your a new key \(default _ed25519_ elliptic curve\):
2018-04-23 08:48:33 -07:00
```
2018-04-23 09:35:03 -07:00
KEYNAME=<set_a_name_for_your_new_key>
gaiacli keys add $KEYNAME
2018-04-23 08:48:33 -07:00
```
2018-04-23 09:35:03 -07:00
2018-04-27 13:53:11 -07:00
Next, you will have to enter a passphrase for your `$KEYNAME` key twice. Save the _seed_ _phrase_ in a safe place in case you forget the password.
2018-04-23 09:35:03 -07:00
2018-04-28 10:13:03 -07:00
Now if you check your private keys you will see the `$KEYNAME` key among them:
2018-04-23 08:48:33 -07:00
```
2018-04-23 09:35:03 -07:00
gaiacli keys show $KEYNAME
2018-04-23 08:48:33 -07:00
```
2018-04-27 13:53:11 -07:00
You can see all your other available keys by typing:
2018-04-23 08:48:33 -07:00
```
2018-04-23 09:35:03 -07:00
gaiacli keys list
2018-04-23 08:48:33 -07:00
```
2018-04-28 10:13:03 -07:00
The validator pubkey from your node should be the same as the one printed with the command:
2018-04-27 13:53:11 -07:00
```
gaiad show_validator
```
2018-04-28 10:13:03 -07:00
Finally, save your address and pubkey into a variable to use them afterwards.
2018-04-23 08:48:33 -07:00
```
2018-04-23 09:35:03 -07:00
MYADDR=<your_newly_generated_address>
MYPUBKEY=<your_newly_generated_public_key>
2018-04-23 08:48:33 -07:00
```
2018-04-24 09:46:34 -07:00
**IMPORTANT:** We strongly recommend to **NOT** use the same passphrase for your different keys. The Tendermint team and the Interchain Foundation will not be responsible for the lost of funds.
2018-04-23 08:48:33 -07:00
2018-04-27 13:53:11 -07:00
### Getting coins
2018-04-23 09:35:03 -07:00
Go to the faucet in [http://atomexplorer.com/](http://atomexplorer.com/) and claim some coins for your testnet by typing the address of your key, as printed out above.
2018-04-23 08:48:33 -07:00
2018-04-27 13:53:11 -07:00
### Send tokens
2018-04-23 08:48:33 -07:00
```
2018-04-28 10:13:03 -07:00
gaiacli send --amount=1000fermion --chain-id=<name_of_testnet_chain> --sequence=1 --name=$KEYNAME --to=<destination_address>
2018-04-23 09:35:03 -07:00
```
The `--amount` flag defines the corresponding amount of the coin in the format `--amount=<value|coin_name>`
The `--sequence` flag corresponds to the sequence number to sign the tx.
2018-04-23 08:48:33 -07:00
2018-04-23 09:35:03 -07:00
Now check the destination account and your own account to check the updated balances \(by default the latest block\):
2018-04-23 08:48:33 -07:00
```
2018-04-23 09:35:03 -07:00
gaiacli account <destination_address>
gaiacli account $MYADDR
```
2018-04-23 08:48:33 -07:00
2018-04-23 09:35:03 -07:00
You can also check your balance at a given block by using the `--block` flag:
2018-04-23 08:48:33 -07:00
2018-04-23 09:35:03 -07:00
```
gaiacli account $MYADDR --block=<block_height>
2018-04-23 08:48:33 -07:00
```
2018-04-23 09:35:03 -07:00
##### Custom fee \(coming soon\)
2018-04-23 08:48:33 -07:00
2018-04-23 09:35:03 -07:00
You can also define a custom fee on the transaction by adding the `--fee` flag using the same format:
2018-04-23 08:48:33 -07:00
2018-04-23 09:35:03 -07:00
```
gaiacli send --from=$MYADDR --amount=1000fermion --fee=1fermion --chain-id=<name_of_testnet_chain> --sequence=1 --name=$KEYNAME --to=<destination_address>
```
### Transfer tokens to other chain
2018-04-27 13:53:11 -07:00
The command to `transfer` tokens to other chain is the same as `send`, we just need to add the `--chain` flag:
2018-04-23 08:48:33 -07:00
```
2018-04-27 13:53:11 -07:00
gaiacli transfer --amount=20fermion --chain-id=<name_of_testnet_chain> --chain=<destination_chain> --sequence=1 --name=$KEYNAME --to=<sidechain_destination_address>
2018-04-23 08:48:33 -07:00
```
2018-04-27 13:53:11 -07:00
## Become a Validator
2018-04-23 08:48:33 -07:00
2018-04-28 10:13:03 -07:00
[Validators](https://cosmos.network/validators) are the actors from the network that are responsible from commiting new blocks to the blockchain by submitting their votes.
Your `$PUBKEY` can be used to create a new validator candidate by staking some tokens:
```
gaiacli declare-candidacy --amount=500fermions --pubkey=$PUBKEY --address-candidate=$MYADDR --moniker=satoshi --chain-id=<name_of_the_testnet_chain> --sequence=1 --name=$KEYNAME
```
You can add more information of the validator candidate such as`--website`, `--keybase-sig `or additional `--details`. If you want to edit the candidate info:
```
gaiacli edit-candidacy --details="To the cosmos !" --website="https://cosmos.network"
```
Finally, you can check all the candidate information by typing:
```
gaiacli candidate --address-candidate=$MYADDR --chain-id=<name_of_the_testnet_chain>
```
2018-04-23 09:35:03 -07:00
To check that the validator is active you can find it on the validator set list:
```
2018-04-23 10:23:57 -07:00
gaiacli validatorset
2018-04-23 09:35:03 -07:00
```
2018-04-23 08:48:33 -07:00
2018-04-24 09:46:34 -07:00
**Note:** Remember that to be in the validator set you need to have more total power than the Xnd validator, where X is the assigned size for the validator set \(by default _`X = 100`_\).
2018-04-23 08:48:33 -07:00
2018-04-28 10:13:03 -07:00
## Delegate your tokens
2018-04-23 08:48:33 -07:00
2018-04-28 10:13:03 -07:00
You can delegate \(i.e. bind\) **Atoms** to a validator to become a [delegator](https://cosmos.network/resources/delegators) and obtain a part of its fee revenue in **Photons**. For more information about the Cosmos Token Model, refer to our [whitepaper](https://github.com/cosmos/cosmos/raw/master/Cosmos_Token_Model.pdf).
### Bonding to a validator
Bond your tokens to a validator candidate with the following command:
2018-04-23 08:48:33 -07:00
```
2018-04-28 10:13:03 -07:00
gaiacli delegate --amount=10fermion --address-delegator=$MYADDR --address-candidate=<bonded_validator_address> --name=$KEYNAME --chain-id=<name_of_testnet_chain> --sequence=1
2018-04-23 09:35:03 -07:00
```
2018-04-28 10:13:03 -07:00
### Unbonding
2018-04-23 09:35:03 -07:00
If for any reason the validator misbehaves or you just want to unbond a certain amount of the bonded tokens:
```
2018-04-28 10:13:03 -07:00
gaiacli unbond --address-delegator=$MYADDR --address-candidate=<bonded_validator_address> --shares=MAX --name=$KEYNAME --chain-id=<name_of_testnet_chain> --sequence=1
2018-04-23 09:35:03 -07:00
```
2018-04-28 10:13:03 -07:00
You can unbond a specific amount of`shares`\(eg:`12.1`\) or all of them \(`MAX`\).
You should now see the unbonded tokens reflected in your balance and in your delegator bond:
2018-04-23 09:35:03 -07:00
```
gaiacli account $MYADDR
2018-04-28 10:13:03 -07:00
gaiacli delegator-bond --address-delegator=$MYADDR --address-candidate=<bonded_validator_address> --chain-id=<name_of_testnet_chain>
2018-04-23 08:48:33 -07:00
```
2018-04-23 09:35:03 -07:00
#### Relaying
2018-04-23 08:48:33 -07:00
2018-04-23 09:35:03 -07:00
Relaying is key to enable interoperability in the Cosmos Ecosystem. It allows IBC packets of data to be sent from one chain to another.
2018-04-23 08:48:33 -07:00
2018-04-23 09:35:03 -07:00
The command to relay packets is the following:
2018-04-23 08:48:33 -07:00
```
2018-04-23 09:35:03 -07:00
gaiacli relay --from-chain-id=<name_of_testnet_chain> --to-chain-id=<destination_chain_name> --from-chain-node=<host>:<port> --to-chain-node=<host>:<port> --name=$KEYNAME --sequence=1
2018-04-23 08:48:33 -07:00
```