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

refactor(gov)!: use collections for Proposal state management (part 1) #16171

Merged
merged 16 commits into from
May 16, 2023

Conversation

testinginprod
Copy link
Contributor

@testinginprod testinginprod commented May 16, 2023

Description

Partially Closes: #16172


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)

suite.Require().Nil(err)
suite.Require().Equal(proposal, gotProposal)
}
}

// TODO(tip): remove this
Copy link
Contributor Author

Choose a reason for hiding this comment

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

to remove

@@ -18,6 +14,7 @@ import (
"github.com/cosmos/cosmos-sdk/x/gov/types/v1beta1"
)

// TODO(tip): remove this
Copy link
Contributor Author

Choose a reason for hiding this comment

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

to remove

@testinginprod testinginprod changed the title refactor(gov)!: use collections for Proposal state management refactor(gov)!: use collections for Proposal state management (part 1) May 16, 2023
@testinginprod testinginprod marked this pull request as ready for review May 16, 2023 05:15
@testinginprod testinginprod requested a review from a team as a code owner May 16, 2023 05:15
@github-prbot github-prbot requested review from a team, JeancarloBarrios and atheeshp and removed request for a team May 16, 2023 05:16
@testinginprod testinginprod added this pull request to the merge queue May 16, 2023
Merged via the queue into main with commit 91d14c0 May 16, 2023
@testinginprod testinginprod deleted the tip/gov/coll-proposals branch May 16, 2023 09:57
@@ -60,11 +60,8 @@ func (keeper Keeper) IterateDeposits(ctx context.Context, proposalID uint64, cb
// Activates voting period when appropriate and returns true in that case, else returns false.
func (keeper Keeper) AddDeposit(ctx context.Context, proposalID uint64, depositorAddr sdk.AccAddress, depositAmount sdk.Coins) (bool, error) {
// Checks to see if proposal exists
proposal, err := keeper.GetProposal(ctx, proposalID)
proposal, err := keeper.Proposals.Get(ctx, proposalID)
if err != nil {
Copy link
Member

Choose a reason for hiding this comment

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

Do you think it isn't necessary to do a check of collections.ErrNotFound for keeping the same behavior?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think we can use the ErrNotFound of collections which is more descriptive and standardized. This breaks consensus but it does not break state compatibility so I think it should be fine, it also allowed us to remove some errors from gov which I think are a little overkill.

If you think this is not good I can revert the changes in a PR.

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.

refactor(gov): use collections for Proposal state management
3 participants