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

refactor(bank): use collections for state management #15293

Merged
merged 16 commits into from
Mar 9, 2023
Merged

refactor(bank): use collections for state management #15293

merged 16 commits into from
Mar 9, 2023

Conversation

testinginprod
Copy link
Contributor

@testinginprod testinginprod commented Mar 7, 2023 •
edited
Loading

Description

Partially Closes: #15315

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)

@yihuang
Copy link
Collaborator

yihuang commented Mar 7, 2023 •
edited
Loading

cool, is this the first example to refactor existing module in a non-breaking way? and will it be possible to backport to 0.46 if it's not breaking?

@testinginprod
Copy link
Contributor Author

testinginprod commented Mar 7, 2023 •
edited
Loading

cool, is this the first example to refactor existing module in a non-breaking way? and will it be possible to backport to 0.46 if it's not breaking?

Yes!

As for 0.46 backport: this is not state breaking but it might be state machine breaking (collections returning error and also different gas semantics, usually more efficient gas wise as it allows for better granularity)

@yihuang
Copy link
Collaborator

yihuang commented Mar 7, 2023

cool, is this the first example to refactor existing module in a non-breaking way? and will it be possible to backport to 0.46 if it's not breaking?

Yes!

awesome!

As for 0.46 backport: this is not state breaking but it might be state machine breaking (collections returning error and also different gas semantics, usually more efficient gas wise as it allows for better granularity)

I see, thanks.

testinginprod
testinginprod commented Mar 8, 2023
View reviewed changes
x/bank/keeper/view.go
ak: ak,
Supply: collections.NewMap(sb, types.SupplyKey, "supply", collections.StringKey, sdk.IntValue),
DenomMetadata: collections.NewMap(sb, types.DenomMetadataPrefix, "denom_metadata", collections.StringKey, codec.CollValue[types.Metadata](cdc)),
SendEnabled: collections.NewMap(sb, types.SendEnabledPrefix, "send_enabled", collections.StringKey, codec.BoolValue), // NOTE: we use a bool value which uses protobuf to retain state backwards compat
Copy link
Contributor Author

Choose a reason for hiding this comment

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

In order to keep state backwards compatibility we use a special handler for bool value.

BoolValues in the SDK are stored as a protobuf wellknown BoolValue. If we didn't add this type then a migration would be required for send enabled state.

@testinginprod testinginprod marked this pull request as ready for review March 8, 2023 19:26
@testinginprod testinginprod requested a review from a team as a code owner March 8, 2023 19:26
@github-prbot github-prbot requested review from a team, amaury1093 and likhita-809 and removed request for a team March 8, 2023 19:27
tac0turtle
tac0turtle reviewed Mar 8, 2023
View reviewed changes
go.mod Show resolved Hide resolved
tac0turtle
tac0turtle reviewed Mar 8, 2023
View reviewed changes
codec/collections.go Outdated Show resolved Hide resolved
tac0turtle
tac0turtle approved these changes Mar 8, 2023
View reviewed changes
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.

utACK, can we get a change log entry

likhita-809
likhita-809 approved these changes Mar 9, 2023
View reviewed changes
Copy link
Contributor

@likhita-809 likhita-809 left a comment

Choose a reason for hiding this comment

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

same comments from marko, otherwise lgtm

@testinginprod testinginprod enabled auto-merge (squash) March 9, 2023 11:02
julienrbrt
julienrbrt approved these changes Mar 9, 2023
View reviewed changes
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

🚀

@testinginprod testinginprod merged commit 2b7a110 into main Mar 9, 2023
@testinginprod testinginprod deleted the tip/bank_coll1 branch March 9, 2023 11:36
@faddat faddat mentioned this pull request Mar 28, 2023
Closed
19 tasks
larry0x pushed a commit to larry0x/cosmos-sdk that referenced this pull request May 22, 2023
@testinginprod
refactor(bank): use collections for state management (cosmos#15293)
6320da9 
Co-authored-by: testinginprod <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@likhita-809 likhita-809 likhita-809 approved these changes

@julienrbrt julienrbrt julienrbrt approved these changes

@tac0turtle tac0turtle tac0turtle approved these changes

@amaury1093 amaury1093 Awaiting requested review from amaury1093

Assignees

@samricotta samricotta

@likhita-809 likhita-809

Labels
C:x/bank
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Migrate bank to use collections.
6 participants
@testinginprod @yihuang @tac0turtle @julienrbrt @likhita-809 @samricotta