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

Improvise in-place-testnet docs #8805

Merged
merged 4 commits into from
Nov 13, 2024
Merged

Improvise in-place-testnet docs #8805

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a105f2a
Improvise lo docs
mattverse Nov 6, 2024
f3f78bf
Add more docs
mattverse Nov 7, 2024
e569564
Alex comment
mattverse Nov 13, 2024
c2e074f
Merge branch 'main' into mattverse/docs-s
mattverse Nov 13, 2024
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
25 changes: 21 additions & 4 deletions tests/localosmosis/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ make localnet-clean

Running an osmosis network with mainnet state is now as easy as setting up a stateless localnet.

1. Set up a mainnet node and stop it at whatever height you want to fork the network at.
1. Set up a mainnet node, allowing it to start and sync a few blocks. Then, stop it at the desired height where you want to fork the network.

2. There are now two options you can choose from:

Expand All @@ -98,13 +98,15 @@ Running an osmosis network with mainnet state is now as easy as setting up a sta

- **Mainnet is on version X, and you want to create a testnet on version X+1.**

On version X, run:
On version X, build binary and run:

```bash
osmosisd in-place-testnet localosmosis osmo12smx2wdlyttvyzvzg54y2vnqwq2qjateuf7thj --trigger-testnet-upgrade
osmosisd in-place-testnet localosmosis osmo12smx2wdlyttvyzvzg54y2vnqwq2qjateuf7thj --trigger-testnet-upgrade=vXX
```

Where the first input is the desired chain-id of the new network and the second input is the desired validator operator address (where you vote from).
where vXX indicates the next version that mainnet needs to be upgraded to. For example when current mainnet state is at v26, the flag value should be `--trigger-testnet-upgrade=v27`.

The first input is the desired chain-id of the new network and the second input is the desired validator operator address (where you vote from).
The address provided above is included in the localosmosis keyring under the name 'val'.

The network will start and hit 10 blocks, at which point the upgrade will trigger and the network will halt.
Expand All @@ -117,6 +119,21 @@ Running an osmosis network with mainnet state is now as easy as setting up a sta

You now have a network you own with the mainnet state on version X+1.

### Removing unnecessary log lines
Running in-place-testnet would be resulting in noise in the log lines that looks something like this.
```
{"level": "info", "module": "server", "module": "consensus", "err": "cannot find validator 122 in valSet of size 1: invalid valid ator index", "time": "2024-10-21T21:34:30Z" ,"message": "failed attempting to add vote"} {"level": "error" , "module": "server", "module":" consensus" ,"height" :22731539, "round" :0, "peer": "27e14df66c9e4cd6b176b@dcabadfa 96750f911", "msg_type": "*consensus. VoteMessage", "err": "error adding vote", "time": "2024-10-21T21:34:307","message":"failed to process message"} {"level": "info" ,"module": "server"
', "module": "consensus", "err": "cannot find validator 107 in valSet of size 1: invalid valid
ator index", "time": "2024-10-21T21:34:30Z", "message": "failed attempting to add vote"}
```

To remove the noise, remove existing addrbook.json from config folder, and replace it with an empty json.

### Changing In Place Testnet Parameters

The settings for in place testnet are done in https://github.com/osmosis-labs/osmosis/blob/bb7a94e2561cc63b60ee76ec71a3e04e9688b22c/app/app.go#L773. Modify the parameters in `InitOsmosisAppForTestnet` to modify in place testnet parameters. For example, if you were to modify epoch hours, you would be modifying https://github.com/osmosis-labs/osmosis/blob/bb7a94e2561cc63b60ee76ec71a3e04e9688b22c/app/app.go#L942-L967 .

Comment on lines +133 to +135
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Improve documentation links for long-term maintainability.

The current implementation uses bare URLs and links to a specific commit hash, which could become outdated. Additionally, the links should be properly formatted for markdown.

Consider this revision:

-The settings for in place testnet are done in https://github.com/osmosis-labs/osmosis/blob/bb7a94e2561cc63b60ee76ec71a3e04e9688b22c/app/app.go#L773. Modify the parameters in `InitOsmosisAppForTestnet` to modify in place testnet parameters. For example, if you were to modify epoch hours, you would be modifying https://github.com/osmosis-labs/osmosis/blob/bb7a94e2561cc63b60ee76ec71a3e04e9688b22c/app/app.go#L942-L967 .
+The settings for in-place testnet are configured in the [`InitOsmosisAppForTestnet`](../../app/app.go) function. You can modify various testnet parameters in this function. For example, epoch hours can be adjusted in the `epochs` section of the same file.

This change:

  1. Uses relative links that are more maintainable
  2. Removes dependency on specific line numbers that might change
  3. Follows proper markdown link syntax
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
The settings for in place testnet are done in https://github.com/osmosis-labs/osmosis/blob/bb7a94e2561cc63b60ee76ec71a3e04e9688b22c/app/app.go#L773. Modify the parameters in `InitOsmosisAppForTestnet` to modify in place testnet parameters. For example, if you were to modify epoch hours, you would be modifying https://github.com/osmosis-labs/osmosis/blob/bb7a94e2561cc63b60ee76ec71a3e04e9688b22c/app/app.go#L942-L967 .
The settings for in-place testnet are configured in the [`InitOsmosisAppForTestnet`](../../app/app.go) function. You can modify various testnet parameters in this function. For example, epoch hours can be adjusted in the `epochs` section of the same file.
🧰 Tools
🪛 Markdownlint

123-123: null
Bare URL used

(MD034, no-bare-urls)

123-123: null
Bare URL used

(MD034, no-bare-urls)


## LocalOsmosis Accounts and Keys

LocalOsmosis is pre-configured with one validator and 9 accounts with ION and OSMO balances.
Expand Down