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

feat!: have tx gov submit-proposal accept either new or legacy syntax #378

Merged
merged 2 commits into from
Feb 9, 2024

Conversation

JimLarson
Copy link

@JimLarson JimLarson commented Feb 8, 2024

Have submit-legacy-proposal be an alias for submit-proposal. Invocations of the legacy syntax should either upgrade to the new syntax, or explicitly use submit-legacy-proposal. When all legacy usages have so migrated, this change can be dropped. See Agoric/agoric-sdk#8871.

Description

Refs: cosmos#8871

Alter the tx gov submit-proposal command so that it works either with the new or legacy syntax, and also alias it as submit-legacy-proposal. Users of the legacy command will continue to work as-is, but over time they should either explicitly use submit-legacy-proposal, or upgrade to the new syntax. When all call sites have done one or the other of these choices, we can drop our modification to this command.

The slight limitation of this approach is that you cannot name the new-syntax JSON file the same as one of the legacy subcommands.


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)

Have submit-legacy-proposal be an alias for submit-proposal.
Invocations of the legacy syntax should either upgrade to the
new syntax, or explicitly use submit-legacy-proposal. When
all legacy usages have so migrated, this change can be dropped.
See Agoric/agoric-sdk#8871.
@JimLarson JimLarson added enhancement New feature or request agoric-cosmos Agoric tags for cosmos labels Feb 8, 2024
@JimLarson JimLarson self-assigned this Feb 8, 2024
@JimLarson
Copy link
Author

No new tests since this is meant to be backward-compatible.

mhofman added a commit to Agoric/agoric-sdk that referenced this pull request Feb 8, 2024
Copy link

@dckc dckc left a comment

Choose a reason for hiding this comment

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

It would take me a while to study this enough to give an "I understand this well enough to help maintain it" review.

If there's some urgency and an "I don't see any problems" approval is useful, LMK.

@JimLarson
Copy link
Author

The golangci-lint failure is expected.

Copy link
Collaborator

@michaelfig michaelfig left a comment

Choose a reason for hiding this comment

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

LGTM! Well done.

@JimLarson JimLarson merged commit b0baff1 into Agoric Feb 9, 2024
38 of 39 checks passed
@JimLarson JimLarson deleted the 8871-submit-proposal branch February 9, 2024 23:51
mhofman added a commit to Agoric/agoric-sdk that referenced this pull request Feb 12, 2024
mhofman added a commit to Agoric/agoric-sdk that referenced this pull request Feb 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
agoric-cosmos Agoric tags for cosmos C:CLI C:x/gov enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants