docs: add section on creating a testnets from mainnet exports #19475

tac0turtle · 2024-02-19T12:50:24Z

Description

This pr adds documentation on how to create testnets from mainnet state. This avoids the need to export state modify the json and import it.

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...

included the correct type prefix in the PR title
confirmed ! in the type prefix if API or client breaking change
targeted the correct branch (see PR Targeting)
provided a link to the relevant issue or specification
reviewed "Files changed" and left comments if necessary
included the necessary unit and integration tests
added a changelog entry to CHANGELOG.md
updated the relevant documentation or specification, including comments for documenting Go code
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 in the PR title
confirmed all author checklist items have been addressed
reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

Documentation
- Enhanced the guide for setting up Application Testnets with detailed steps on migrating mainnet state, creating new accounts, and running the testnet.
- Expanded instructions to cover optional custom module adjustments.
- Provided guidance on updating distribution records, setting validator signing info, and scheduling upgrades.

coderabbitai · 2024-02-19T12:50:50Z

Walkthrough

The update provides a detailed overview of initiating Application Testnets using the Cosmos SDK. It guides users through the process of creating a testnet from mainnet state, including crucial steps like migrating validator sets, updating distribution records, configuring validator signing information, creating new accounts, and managing upgrades. Additionally, it delves into optional modifications for custom modules and offers advice on effectively operating the testnet.

Changes

File Path	Change Summary
`docs/build/building-apps/05-app-testnet.md`	Introduces Application Testnets in the Cosmos SDK, detailing the setup of a testnet from mainnet state. Covers tasks such as migrating validator sets, updating distribution records, configuring validator signing info, creating accounts, and scheduling upgrades. Explores optional adjustments for custom modules and provides guidance on running the testnet effectively.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit-tests for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit tests for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit tests.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
The JSON schema for the configuration file is available here.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

coderabbitai

Review Status

Actionable comments generated: 8

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 4db9838 and 4d1ee7c.

Files selected for processing (1)

docs/build/building-apps/05-app-testnet.md (1 hunks)

Additional comments: 2

docs/build/building-apps/05-app-testnet.md (2)

7-9: The introduction provides a clear overview of the purpose and utility of creating testnets from mainnet exports. It sets the right context for the reader, explaining why this process is beneficial for developers. This section is well-written and requires no changes.

15-19: The code snippet introduces a function InitMerlinAppForTestnet with a detailed comment explaining the purpose of the function and the distinction between required and optional changes. This is a good practice as it helps developers understand the scope and implications of the changes they might need to make. However, ensure that the actual implementation details (...) are filled in or explained elsewhere in the document to avoid confusion.

docs/build/building-apps/05-app-testnet.md

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 4d1ee7c and 8d2a749.

Files selected for processing (1)

docs/build/building-apps/05-app-testnet.md (1 hunks)

Files skipped from review as they are similar to previous changes (1)

docs/build/building-apps/05-app-testnet.md

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 8d2a749 and 78f05b632b8a0f5afcae5129603df3b4f7a432ab.

Files selected for processing (1)

docs/build/building-apps/05-app-testnet.md (1 hunks)

Files skipped from review as they are similar to previous changes (1)

docs/build/building-apps/05-app-testnet.md

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 8d2a749 and fcbbf76.

Files selected for processing (1)

docs/build/building-apps/05-app-testnet.md (1 hunks)

Files skipped from review as they are similar to previous changes (1)

docs/build/building-apps/05-app-testnet.md

julienrbrt

utACK

testinginprod

LGTM!

(cherry picked from commit 89bba66) # Conflicts: # docs/docs/build/building-apps/05-app-testnet.md

#19475) (#19648) Co-authored-by: Marko <marbar3778@yahoo.com>

…0.50.5 * fix: in-place-testnet edgecases (backport cosmos#19516) (cosmos#19526) Co-authored-by: Adam Tucker <adam@osmosis.team> * fix(simapp): typo in GetStoreKeys (cosmos#19544) * build(deps): Bump cosmossdk.io/math from 1.2.0 to 1.3.0 (cosmos#19562) * fix(depinject): Authtx was not accepting custom signers (backport cosmos#19549) (cosmos#19551) Co-authored-by: Devon Bear <itsdevbear@berachain.com> Co-authored-by: Qt <golang.chen@gmail.com> Co-authored-by: Julien Robert <julien@rbrt.fr> * build(deps): Bump github.com/cosmos/cosmos-db from 1.0.0 to 1.0.2 (cosmos#19566) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Julien Robert <julien@rbrt.fr> * Merge pull request from GHSA-86h5-xcpx-cfqc * fix slashing hole with test * release notes + changelog * word * date * updates --------- Co-authored-by: Julien Robert <julien@rbrt.fr> * ci: run test pipeline on merge v0.50 branch (cosmos#19582) * fix(staking): fix impossible conditions (cosmos#19621) * docs: add section on creating a testnets from mainnet exports (backport cosmos#19475) (cosmos#19648) Co-authored-by: Marko <marbar3778@yahoo.com> * build(deps): Bump cosmossdk.io/x/tx from 0.13.0 to 0.13.1 (cosmos#19665) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> * feat(client/v2): marshal enum as string (cosmos#19653) * refactor(x/auth): allow empty public keys for GetSignBytesAdapter (backport cosmos#19651) (cosmos#19675) Co-authored-by: mmsqe <mavis@crypto.com> Co-authored-by: Julien Robert <julien@rbrt.fr> * fix(types): check for HasABCIGenesis in CoreAppModuleBasicAdaptor (cosmos#19709) * build(deps): Bump deps (backport cosmos#19655) (cosmos#19711) Co-authored-by: Julien Robert <julien@rbrt.fr> * Merge pull request from GHSA-95rx-m9m5-m94v * validate ExtendedCommit against LastCommit test cases * account for core.comet types * logging * linting * cherry-pick staking fix * nits * linting fix * run tests --------- Co-authored-by: Marko <marbar3778@yahoo.com> Co-authored-by: Marko Baricevic <markobaricevic3778@gmail.com> * feat(baseapp): add option to disable block gas meter (cosmos#19626) * feat(x/distribution): add rewards-by-validator autocli config (backport cosmos#19707) (cosmos#19714) Co-authored-by: Julien Robert <julien@rbrt.fr> * fix(x/gov): grpc query tally for failed proposal (backport cosmos#19725) (cosmos#19727) Co-authored-by: David Tumcharoen <david@alleslabs.com> Co-authored-by: Julien Robert <julien@rbrt.fr> * chore: prepare v0.50.5 (cosmos#19715) --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Adam Tucker <adam@osmosis.team> Co-authored-by: yihuang <huang@crypto.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Devon Bear <itsdevbear@berachain.com> Co-authored-by: Qt <golang.chen@gmail.com> Co-authored-by: Julien Robert <julien@rbrt.fr> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: khanh <50263489+catShaark@users.noreply.github.com> Co-authored-by: Tom <54514587+GAtom22@users.noreply.github.com> Co-authored-by: Marko <marbar3778@yahoo.com> Co-authored-by: mmsqe <mavis@crypto.com> Co-authored-by: Nikhil Vasan <97126437+nivasan1@users.noreply.github.com> Co-authored-by: Marko Baricevic <markobaricevic3778@gmail.com> Co-authored-by: David Tumcharoen <david@alleslabs.com>

add section on creating a testnets from mainnet exports

4d1ee7c

tac0turtle marked this pull request as ready for review February 19, 2024 12:50

tac0turtle requested a review from a team as a code owner February 19, 2024 12:50

tac0turtle assigned julienrbrt and samricotta Feb 19, 2024

coderabbitai bot reviewed Feb 19, 2024

View reviewed changes

tac0turtle assigned alexanderbez and unassigned samricotta Feb 20, 2024

julienrbrt reviewed Feb 20, 2024

View reviewed changes

julienrbrt added the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label Feb 20, 2024

julienrbrt changed the title ~~chore(docs):add section on creating a testnets from mainnet exports~~ docs: add section on creating a testnets from mainnet exports Feb 20, 2024

comments

8d2a749

coderabbitai bot reviewed Feb 23, 2024

View reviewed changes

tac0turtle requested a review from julienrbrt February 23, 2024 09:46

tac0turtle assigned facundomedica Feb 23, 2024

migrate what is possible to collections

fcbbf76

tac0turtle force-pushed the marko/testnet_creation branch from 78f05b6 to fcbbf76 Compare February 26, 2024 11:10

coderabbitai bot reviewed Feb 26, 2024

View reviewed changes

julienrbrt approved these changes Feb 27, 2024

View reviewed changes

testinginprod approved these changes Mar 5, 2024

View reviewed changes

Merge branch 'main' into marko/testnet_creation

9bca498

tac0turtle enabled auto-merge March 5, 2024 09:40

tac0turtle added this pull request to the merge queue Mar 5, 2024

Merged via the queue into main with commit 89bba66 Mar 5, 2024
53 of 55 checks passed

tac0turtle deleted the marko/testnet_creation branch March 5, 2024 09:47

mergify bot pushed a commit that referenced this pull request Mar 5, 2024

docs: add section on creating a testnets from mainnet exports (#19475)

f4756f8

(cherry picked from commit 89bba66) # Conflicts: # docs/docs/build/building-apps/05-app-testnet.md

mergify bot mentioned this pull request Mar 5, 2024

docs: add section on creating a testnets from mainnet exports (backport #19475) #19648

Merged

tac0turtle added a commit that referenced this pull request Mar 5, 2024

docs: add section on creating a testnets from mainnet exports (backport

515bd8d

#19475) (#19648) Co-authored-by: Marko <marbar3778@yahoo.com>

faddat mentioned this pull request Nov 8, 2024

faddat/many times #22476

Closed

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add section on creating a testnets from mainnet exports #19475

docs: add section on creating a testnets from mainnet exports #19475

tac0turtle commented Feb 19, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 19, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

julienrbrt left a comment

testinginprod left a comment

docs: add section on creating a testnets from mainnet exports #19475

docs: add section on creating a testnets from mainnet exports #19475

Conversation

tac0turtle commented Feb 19, 2024 • edited by coderabbitai bot Loading

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

coderabbitai bot commented Feb 19, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

julienrbrt left a comment

Choose a reason for hiding this comment

testinginprod left a comment

Choose a reason for hiding this comment

tac0turtle commented Feb 19, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 19, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)