feat(x/gov): constitution amendments can update the constitution #25
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Use unified diff notation to define amendments so that how the constitution is modified is encoded in a more compact way which is also more readable
giunatale
force-pushed
the
amendments-edit-constitution
branch
from
75823c0
to
c460b81
Compare
tbruyelle
reviewed
Sep 24, 2024
tbruyelle
reviewed
Sep 24, 2024
tbruyelle
reviewed
Sep 24, 2024
tbruyelle
approved these changes
Sep 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
ProposeConstitutionAmendmentmsg that is used for constitution amendment proposals now contains anamendmentfield, that needs to be in unified diff format (the output ofdiff -u) and will trigger an updateof the constitution.
The choice of using a unified diff format instead of requiring to overwrite the constitution with an entirely new string is for a couple reasons:
The choice of the unified diff format was deemed the best tradeoff to achieve both results.
A cli command in the txs called
generate-constitution-amendmentis also provided that fetches the current constitution and generates the amendment message that needs to go in the proposal, but the patching mechanism accepts standard unified diffs generated from any source. Putting it into the txs seemed the best place.The code that checks and applies the diffs does not rely on any external library, conversely the CLI utility to generate the diff does make use of
github.com/hexops/gotextdiff.