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.

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

docs: update ADR 063 and 057 to describe modular runtimes and module semver #15963

Merged
merged 6 commits into from
May 8, 2023

Conversation

aaronc
Copy link
Member

@aaronc aaronc commented Apr 26, 2023

Description

This PR describes how the SDK will be structured in the future to:

  • support modular consensus including different versions of comet or other consensus engines
  • standalone SDK go modules should be semantically versioned

In the short-term, I am thinking to start implementing ADR 033 functionality (#9238) in cosmossdk.io/runtime/common as described in this document to start moving in this direction. (I have a draft branch of this in addition to #13519).


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 API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building 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

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 ! 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)

@aaronc aaronc marked this pull request as ready for review April 26, 2023 21:13
@aaronc aaronc requested a review from a team as a code owner April 26, 2023 21:13
@github-prbot github-prbot requested review from a team, kocubinski and samricotta and removed request for a team April 26, 2023 21:14
Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

this is a good high level description of direction, once we get to the point we can start this work another adr will be written and discussed

@tac0turtle tac0turtle added this pull request to the merge queue May 8, 2023
Merged via the queue into main with commit 12923c3 May 8, 2023
@tac0turtle tac0turtle deleted the aaronc/adr-063-runtime-updates branch May 8, 2023 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants