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.

Sign up for GitHub

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

Refactors testnetify and remove last localOsmosis Dockerfile #2795

Merged
merged 10 commits into from
Sep 22, 2022
Merged

Refactors testnetify and remove last localOsmosis Dockerfile #2795

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2c426d5
Refactor testnetify and remove Dockerfile
Sep 20, 2022
3084dbb
Manually replace new validator public key
Sep 20, 2022
bc4aa28
Improve output formatting
Sep 20, 2022
be3b6fc
Bug fixes
Sep 20, 2022
5c518b2
Add ACCOUNT_PUBKEY and ACCOUNT_ADDRESS input
Sep 20, 2022
953ab8a
Add environment variables as input and config folder check
Sep 20, 2022
439a347
Update docs, Makefile and rename folder
Sep 20, 2022
1892918
Modify CLI arguments
Sep 20, 2022
9226883
Update docker-compose.yaml defaults and print updated values
Sep 20, 2022
801f156
Invert printing logic replacing verbose with quiet
Sep 22, 2022
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
20 changes: 13 additions & 7 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,26 +363,32 @@ localnet-keys:
localnet-build:
@DOCKER_BUILDKIT=1 docker-compose -f tests/localosmosis/docker-compose.yml build

localnet-build-state-export:
@docker build -t local:osmosis-se --build-arg ID=$(ID) -f tests/localosmosis/mainnet_state/Dockerfile-stateExport .

localnet-start:
@docker-compose -f tests/localosmosis/docker-compose.yml up

localnet-startd:
@docker-compose -f tests/localosmosis/docker-compose.yml up -d

localnet-start-state-export:
@docker-compose -f tests/localosmosis/mainnet_state/docker-compose-state-export.yml up

localnet-stop:
@docker-compose -f tests/localosmosis/docker-compose.yml down

localnet-remove: localnet-stop
rm -rf $(PWD)/tests/localosmosis/.osmosisd

localnet-build-state-export:
@DOCKER_BUILDKIT=1 docker-compose -f tests/localosmosis/state_export/docker-compose.yml build

localnet-start-state-export:
@docker-compose -f tests/localosmosis/state_export/docker-compose.yml up

localnet-startd-state-export:
@docker-compose -f tests/localosmosis/state_export/docker-compose.yml up -d

localnet-stop-state-export:
@docker-compose -f tests/localosmosis/docker-compose.yml down

localnet-remove-state-export:
@docker-compose -f tests/localosmosis/mainnet_state/docker-compose-state-export.yml down
rm -rf $(PWD)/tests/localosmosis/state_export/.osmosisd
Copy link
Member

@czarcas7ic czarcas7ic Sep 20, 2022 •
edited by niccoloraspa
Loading

Choose a reason for hiding this comment

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

Are we utilizing a .osmosisd folder within the repo itself to retain data? If so, we should change this to utilize the .osmosisd folder located in the home directory.

Copy link
Member Author

@niccoloraspa niccoloraspa Sep 20, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Yes, we're using a .osmosisd folder within the repo.
Same behavior of regular localOsmosis.

Should we change both?
TBH I prefer keeping it inside the repo but it's not a problem changing it.

Copy link
Member

Choose a reason for hiding this comment

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

Can we change this on both? From personal experience (today actually), I was confused where it was pulling the data from and had to remake a testnet instead of upgrading it. With the knowledge I have now I realize I could have done the following:

  1. Move the .osmosisd repo to the home folder
  2. Checkout v12
  3. Move the .osmosisd repo back to the in repo location

This seems like a hassle when we could just keep it using .osmosisd. What are your thoughts though? Totally down to keep it this way if there is a good reason!

Copy link
Member Author

@niccoloraspa niccoloraspa Sep 21, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

The osmosis home makes more sense, to be honest.
Using the .osmosisd folder within the repo was done for simplicity.

The initialization step of both localOsmosis setups (modifying the various tomls and genesis) runs only if no .osmosisd/config folder it's found: https://github.com/osmosis-labs/osmosis/blob/main/tests/localosmosis/scripts/setup.sh#L87

The check allows the possibility to stop/restart and restart the chain without repeating the initialization step as well as persisting the data.

If we want to use the .osmosisd folder in the home, we need to handle the first run of the script ensuring that the ~/.osmosisd folder is empty otherwise the init phase won't run


.PHONY: all build-linux install format lint \
go-mod-cache draw-deps clean build build-contract-tests-hooks \
Expand Down
53 changes: 31 additions & 22 deletions tests/localosmosis/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,12 @@ You can now quickly test your changes to Osmosis with just a few commands:

## LocalOsmosis with Mainnet State

Running LocalOsmosis with mainnet state is resource intensive and can take a bit of time. It is recommended to only use this method if you are testing a new feature that must be thoroughly tested before pushing to production.
Running LocalOsmosis with mainnet state is resource intensive and can take a bit of time.
It is recommended to only use this method if you are testing a new feature that must be thoroughly tested before pushing to production.

A few things to note before getting started. The below method will only work if you are using the same version as mainnet. In other words, if mainnet is on v8.0.0 and you try to do this on a v9.0.0 tag or on main, you will run into an error when initializing the genesis. (yes, it is possible to create a state exported testnet on a upcoming release, but that is out of the scope of this tutorial)
A few things to note before getting started. The below method will only work if you are using the same version as mainnet. In other words,
if mainnet is on v8.0.0 and you try to do this on a v9.0.0 tag or on main, you will run into an error when initializing the genesis.
(yes, it is possible to create a state exported testnet on a upcoming release, but that is out of the scope of this tutorial)

Additionally, this process requires 64GB of RAM. If you do not have 64GB of RAM, you will get an OOM error.

Expand All @@ -56,57 +59,61 @@ systemctl stop osmosisd.service

```sh
cd $HOME
osmosisd export 2> testnet_genesis.json
osmosisd export 2> state_export.json
```

After a while (~15 minutes), this will create a file called `testnet_genesis.json` which is a snapshot of the current mainnet state.
After a while (~15 minutes), this will create a file called `state_export.json` which is a snapshot of the current mainnet state.

5. Copy the `testnet_genesis.json` to the localosmosis folder within the osmosis repo
5. Copy the `state_export.json` to the `localosmosis/state_export` folder within the osmosis repo

```sh
cp -r $HOME/testnet_genesis.json $HOME/osmosis/tests/localosmosis
cp $HOME/state_export.json $HOME/osmosis/tests/localosmosis/state_export/
```

6. Ensure you have docker and docker compose installed/running:
Docker
6. Ensure you have docker and docker-compose installed:


```sh
# Docker
sudo apt-get remove docker docker-engine docker.io
sudo apt-get update
sudo apt install docker.io -y
```

Docker Compose

```sh
# Docker compose
sudo apt install docker-compose -y
```

7. Compile the local:osmosis-se docker image (~15 minutes, since this process modifies the testnet genesis you provided above). You may change the exported ID to whatever you want the chain-id to be. In this example, we will use the chain-id of localosmosis.
7. Build the `local:osmosis` docker image:

```sh
cd $HOME/osmosis
export ID=local
```bash
make localnet-build-state-export
```

8. Start the local:osmosis-se docker image
8. Run the `local:osmosis` docker image

```sh
make localnet-start-state-export
```

You will then go through the genesis intialization process. This will take ~15 minutes. You will then hit the first block (not block 1, but the block number after your snapshot was taken), and then you will just see a bunch of p2p error logs with some KV store logs. **This will happen for about 1 hour**, and then you will finally hit blocks at a normal pace.
When running this command for the first time, `local:osmosis` will:

- Modify the provided `state_export.json` to create a new state suitable for a testnet
- Start the chain

You will then go through the genesis initialization process. This will take ~15 minutes.
You will then hit the first block (not block 1, but the block number after your snapshot was taken), and then you will just see a bunch of p2p error logs with some KV store logs.
**This will happen for about 1 hour**, and then you will finally hit blocks at a normal pace.

9. On your host machine, add this specific wallet which holds a large amount of osmo funds

```sh
echo "bottom loan skill merry east cradle onion journey palm apology verb edit desert impose absurd oil bubble sweet glove shallow size build burst effort" | osmosisd keys add wallet --recover --keyring-backend test
MNEMONIC="bottom loan skill merry east cradle onion journey palm apology verb edit desert impose absurd oil bubble sweet glove shallow size build burst effort"
echo $MNEMONIC | osmosisd keys add wallet --recover --keyring-backend test
```

You now are running a validator with a majority of the voting power with the same mainnet state as when you took the snapshot.
You now are running a validator with a majority of the voting power with the same state as mainnet state (at the time you took the snapshot)

10. On your host machine, you can now query the state export testnet like so:
10. On your host machine, you can now query the state-exported testnet:

```sh
osmosisd status
Expand All @@ -124,7 +131,9 @@ osmosisd tx bank send wallet osmo1nyphwl8p5yx6fxzevjwqunsfqpcxukmtk8t60m 1000000
make localnet-remove-state-export
```

Note: At some point, all the validators (except yours) will get jailed at the same block due to them being offline. When this happens, it make take a little bit of time to process. Once all validators are jailed, you will continue to hit blocks as you did before. If you are only running the validator for a short period of time (< 24 hours) you will not experience this.
Note: At some point, all the validators (except yours) will get jailed at the same block due to them being offline.
When this happens, it may take a little bit of time to process. Once all validators are jailed, you will continue to hit blocks as you did before.
If you are only running the validator for a short period of time (< 24 hours) you will not experience this.

## Accounts

Expand Down
62 changes: 0 additions & 62 deletions tests/localosmosis/mainnet_state/Dockerfile-stateExport
View file
Open in desktop

This file was deleted.

15 changes: 0 additions & 15 deletions tests/localosmosis/mainnet_state/docker-compose-state-export.yml
View file
Open in desktop

This file was deleted.

7 changes: 0 additions & 7 deletions tests/localosmosis/mainnet_state/statesync.sh
View file
Open in desktop

This file was deleted.

Loading