chore: Add script to validate gentxs (#9486)
<!-- The default pull request template is for types feat, fix, or refactor. For other templates, add one of the following parameters to the url: - template=docs.md - template=other.md --> ## Description ref: #9304 <!-- Add a description of the changes that this PR introduces and the files that are the most critical to review. --> --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [x] updated the relevant documentation or specification - [x] reviewed "Files changed" and left comments if necessary - [x] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
This commit is contained in:
Anil Kumar Kammari
GitHub
parent
3fa7bd26eb
commit
760bde3fbd
|
|
@ -1,3 +1,23 @@
|
|||
Generally we should avoid shell scripting and write tests purely in Golang.
|
||||
However, some libraries are not Goroutine-safe (e.g. app simulations cannot be run safely in parallel),
|
||||
and OS-native threading may be more efficient for many parallel simulations, so we use shell scripts here.
|
||||
|
||||
### Validate Gentxs
|
||||
A custom utility script is available to [validate gentxs](./validate-gentxs.sh). Though we have
|
||||
`ValidateBasic()` for validating gentx data, it cannot validate signatures. This custom script helps
|
||||
to validate all the gentxs by collecting them one by one and starting a local network.
|
||||
It requires the following env settings.
|
||||
```shell
|
||||
export DAEMON=gaiad
|
||||
export CHAIN_ID=cosmoshub-1
|
||||
export DENOM=uatom
|
||||
export GH_URL=https://github.com/cosmos/gaia
|
||||
export BINARY_VERSION=v1.0.0
|
||||
export GO_VERSION=1.15.2
|
||||
export PRELAUNCH_GENESIS_URL=https://raw.githubusercontent.com/cosmos/mainnet/main/cosmoshub-1/genesis-prelaunch.json
|
||||
export GENTXS_DIR=~/go/src/github.com/cosmos/mainnet/$CHAIN_ID/gentxs
|
||||
```
|
||||
|
||||
Though this script is handy for verifying the gentxs locally, it is advised to use Github Action to validate gentxs.
|
||||
An example can be found here:
|
||||
https://github.com/regen-network/mainnet/blob/0bcd387671b9574e893289e39c08a1643cac7d62/.github/workflows/validate-gentx.yml
|
||||
|
|
|
|||
|
|
@ -0,0 +1,147 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
DAEMON_HOME="/tmp/simd$(date +%s)"
|
||||
RANDOM_KEY="randomvalidatorkey"
|
||||
|
||||
echo "#############################################"
|
||||
echo "### Ensure to set the below ENV settings ###"
|
||||
echo "#############################################"
|
||||
echo "
|
||||
DAEMON= # ex: simd
|
||||
CHAIN_ID= # ex: testnet-1
|
||||
DENOM= # ex: ustake
|
||||
GH_URL= # ex: https://github.com/cosmos/cosmos-sdk
|
||||
BINARY_VERSION= # ex :v0.43.0-beta1
|
||||
GO_VERSION=1.15.2
|
||||
PRELAUNCH_GENESIS_URL= # ex: https://raw.githubusercontent.com/cosmos/cosmos-sdk/master/$CHAIN_ID/genesis-prelaunch.json
|
||||
GENTXS_DIR= # ex: $GOPATH/github.com/cosmos/mainnet/$CHAIN_ID/gentxs"
|
||||
echo
|
||||
|
||||
if [[ -z "${GH_URL}" ]]; then
|
||||
echo "GH_URL in not set, required. Ex: https://github.com/cosmos/cosmos-sdk"
|
||||
exit 0
|
||||
fi
|
||||
if [[ -z "${DAEMON}" ]]; then
|
||||
echo "DAEMON is not set, required. Ex: simd, gaiad etc"
|
||||
exit 0
|
||||
fi
|
||||
if [[ -z "${DENOM}" ]]; then
|
||||
echo "DENOM in not set, required. Ex: stake, uatom etc"
|
||||
exit 0
|
||||
fi
|
||||
if [[ -z "${GO_VERSION}" ]]; then
|
||||
echo "GO_VERSION in not set, required. Ex: 1.15.2, 1.16.6 etc."
|
||||
exit 0
|
||||
fi
|
||||
if [[ -z "${CHAIN_ID}" ]]; then
|
||||
echo "CHAIN_ID in not set, required."
|
||||
exit 0
|
||||
fi
|
||||
if [[ -z "${PRELAUNCH_GENESIS_URL}" ]]; then
|
||||
echo "PRELAUNCH_GENESIS_URL (genesis file url) in not set, required."
|
||||
exit 0
|
||||
fi
|
||||
if [[ -z "${GENTXS_DIR}" ]]; then
|
||||
echo "GENTXS_DIR in not set, required."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
command_exists () {
|
||||
type "$1" &> /dev/null ;
|
||||
}
|
||||
|
||||
if command_exists go ; then
|
||||
echo "Golang is already installed"
|
||||
else
|
||||
read -s -p "Installing go using apt. Do you want to proceed (y/n)?: " useApt
|
||||
|
||||
if [ "$useApt" != "y" ]; then
|
||||
echo
|
||||
echo "Install go manually and execute this script"
|
||||
exit 0;
|
||||
fi
|
||||
|
||||
sudo apt update
|
||||
sudo apt install build-essential -y
|
||||
|
||||
wget https://dl.google.com/go/go$GO_VERSION.linux-amd64.tar.gz
|
||||
tar -xvf go$GO_VERSION.linux-amd64.tar.gz
|
||||
sudo mv go /usr/local
|
||||
|
||||
echo "" >> ~/.profile
|
||||
echo 'export GOPATH=$HOME/go' >> ~/.profile
|
||||
echo 'export GOROOT=/usr/local/go' >> ~/.profile
|
||||
echo 'export GOBIN=$GOPATH/bin' >> ~/.profile
|
||||
echo 'export PATH=$PATH:/usr/local/go/bin:$GOBIN' >> ~/.profile
|
||||
|
||||
. ~/.profile
|
||||
|
||||
go version
|
||||
fi
|
||||
|
||||
if [ "$(ls -A $GENTXS_DIR)" ]; then
|
||||
echo "Install $DAEMON"
|
||||
git clone $GH_URL $DAEMON
|
||||
cd $DAEMON
|
||||
git fetch && git checkout $BINARY_VERSION
|
||||
make install
|
||||
$DAEMON version
|
||||
|
||||
for GENTX_FILE in $GENTXS_DIR/*.json; do
|
||||
if [ -f "$GENTX_FILE" ]; then
|
||||
set -e
|
||||
|
||||
echo "GentxFile::::"
|
||||
echo $GENTX_FILE
|
||||
|
||||
echo "...........Init a testnet.............."
|
||||
$DAEMON init --chain-id $CHAIN_ID validator --home $DAEMON_HOME
|
||||
|
||||
$DAEMON keys add $RANDOM_KEY --keyring-backend test --home $DAEMON_HOME
|
||||
|
||||
echo "..........Fetching genesis......."
|
||||
curl -s $PRELAUNCH_GENESIS_URL > $DAEMON_HOME/config/genesis.json
|
||||
|
||||
# this genesis time is different from original genesis time, just for validating gentx.
|
||||
sed -i '/genesis_time/c\ \"genesis_time\" : \"2021-01-01T00:00:00Z\",' $DAEMON_HOME/config/genesis.json
|
||||
|
||||
GENACC=$(cat $GENTX_FILE | sed -n 's|.*"delegator_address":"\([^"]*\)".*|\1|p')
|
||||
denomquery=$(jq -r '.body.messages[0].value.denom' $GENTX_FILE)
|
||||
amountquery=$(jq -r '.body.messages[0].value.amount' $GENTX_FILE)
|
||||
|
||||
# only allow $DENOM tokens to be bonded
|
||||
if [ $denomquery != $DENOM ]; then
|
||||
echo "invalid denomination"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
$DAEMON add-genesis-account $RANDOM_KEY 1000000000000000$DENOM --home $DAEMON_HOME \
|
||||
--keyring-backend test
|
||||
|
||||
$DAEMON gentx $RANDOM_KEY 900000000000000$DENOM --home $DAEMON_HOME \
|
||||
--keyring-backend test --chain-id $CHAIN_ID
|
||||
|
||||
cp $GENTX_FILE $DAEMON_HOME/config/gentx/
|
||||
|
||||
echo "..........Collecting gentxs......."
|
||||
$DAEMON collect-gentxs --home $DAEMON_HOME
|
||||
$DAEMON validate-genesis --home $DAEMON_HOME
|
||||
|
||||
echo "..........Starting node......."
|
||||
$DAEMON start --home $DAEMON_HOME &
|
||||
|
||||
sleep 10s
|
||||
|
||||
echo "...checking network status.."
|
||||
echo "if this fails, most probably the gentx with address $GENACC is invalid"
|
||||
$DAEMON status --node http://localhost:26657
|
||||
|
||||
echo "...Cleaning the stuff..."
|
||||
killall $DAEMON >/dev/null 2>&1
|
||||
sleep 2s
|
||||
rm -rf $DAEMON_HOME
|
||||
fi
|
||||
done
|
||||
else
|
||||
echo "$GENTXS_DIR is empty, nothing to validate"
|
||||
fi
|
||||
Loading…
Reference in New Issue