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

Jump to bottom

feat!: enable standalone consumers to reuse existing clients for ICS #2400

Draft
wants to merge 14 commits into
base: main
Choose a base branch
from
Draft

feat!: enable standalone consumers to reuse existing clients for ICS #2400

wants to merge 14 commits into from

Conversation

mpoke
Copy link
Contributor

@mpoke mpoke commented Nov 13, 2024 •
edited
Loading

Description

Closes: #894

  • Remove code from app/consumer-democracy/app.go

  • Add genesis transformation for compatibility with older consumer versions

  • Update docs -- changeover guidelines

  • Add e2e tests for standalone to consumer changeover

    • Start standalone chain and provider chain
    • Create transfer channel to provider
    • Create consumer chain on provider with valid connection ID
    • Upgrade standalone chain to use consumer module with the genesis from the provider
    • Verify that the genesis from the provider doesn't contain a client state or a consensus state
    • Create CCV channel and check that the underlying client matches the one for transfer

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
  • Added ! to the type prefix if the change is state-machine breaking
  • Confirmed this PR does not introduce changes requiring state migrations, OR migration code has been added to consumer and/or provider modules
  • Targeted the correct branch (see PR Targeting)
  • Provided a link to the relevant issue or specification
  • Followed the guidelines for building SDK modules
  • Included the necessary unit and integration tests
  • Added a changelog entry to CHANGELOG.md
  • Included comments for documenting Go code
  • Updated the relevant documentation or specification
  • Reviewed "Files changed" and left comments if necessary
  • Confirmed all CI checks have passed
  • If this PR is library API breaking, bump the go.mod version string of the repo, and follow through on a new major release

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 ! the type prefix if the change is state-machine breaking
  • confirmed this PR does not introduce changes requiring state migrations, OR confirmed migration code has been added to consumer and/or provider modules
  • 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

@github-actions github-actions bot added C:x/consumer Assigned automatically by the PR labeler C:x/provider Assigned automatically by the PR labeler C:x/types Assigned automatically by the PR labeler labels Nov 13, 2024
@github-actions github-actions bot added the C:Docs Assigned automatically by the PR labeler label Nov 13, 2024
@github-actions github-actions bot added the C:Testing Assigned automatically by the PR labeler label Nov 13, 2024
mpoke
mpoke commented Nov 13, 2024
View reviewed changes
app/consumer-democracy/app.go
@@ -677,6 +677,7 @@ func New(
}
}

// TODO: remove this code
Copy link
Contributor Author

Choose a reason for hiding this comment

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

TODO: is any of the code below needed?

Copy link
Contributor

Choose a reason for hiding this comment

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

That's how the changeover is done. The chain needs to read the new validator set from somewhere.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure I understand. Why are we calling InitGenesis. This should be automatically called when adding a new module to the chain.

@mpoke mpoke changed the title feat: enable standalone consumers to reuse existing clients for ICS feat!: enable standalone consumers to reuse existing clients for ICS Nov 13, 2024
MSalopek
MSalopek reviewed Nov 13, 2024
View reviewed changes
proto/interchain_security/ccv/v1/shared_consumer.proto
// genesis state will default to false
bool new_chain = 3;
// Flag indicating whether the consumer CCV module starts in pre-CCV state
bool preCCV = 4;
Copy link
Contributor

@MSalopek MSalopek Nov 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

A little problematic to understand why there's new_chain and preCCV, but I get it.

Nit: Maybe consider uniform snakecase/camelcase usage. (I don't have strong feelings, feel free to ignore).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

preCCV is already a field in the consumer genesis, so I cannot change the name without breaking compatibility.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MSalopek MSalopek MSalopek left review comments

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
C:Docs Assigned automatically by the PR labeler C:Testing Assigned automatically by the PR labeler C:x/consumer Assigned automatically by the PR labeler C:x/provider Assigned automatically by the PR labeler C:x/types Assigned automatically by the PR labeler
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

consumer GenesisState.preCCV is hardcoded
2 participants
@mpoke @MSalopek