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

revert: bank change module to account change #20427

Merged
merged 5 commits into from
May 21, 2024
Merged

Conversation

tac0turtle
Copy link
Member

@tac0turtle tac0turtle commented May 20, 2024

Description

this pr reverts an issue with bank that was deemed as not an issue. We tried to make it work but the state machine code is treated as sudo so preventing this could lead to other issues since the limitation of the state machine is different than that of a user


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
  • confirmed ! in 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
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • 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 all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Refactor

    • Minor whitespace formatting changes for improved code readability.
    • Updated error message formatting in the NewCommitKVStoreCache function for better clarity.
  • Tests

    • Removed a redundant line in the fundAccount function within the account tests.
    • Reordered import statements in test data for better organization.
    • Removed the logic for checking specific denomination in the SendCoinsFromModuleToAccount function.

Copy link
Contributor

coderabbitai bot commented May 20, 2024

Walkthrough

Walkthrough

The recent changes involve minor formatting adjustments and the removal of specific lines of code in test functions. The logic and control flow of the code remain unaffected. Notably, a test function related to coin sending was removed, and minor import reordering was done for better organization.

Changes

Files Change Summary
store/rootmulti/store.go Minor whitespace formatting in the import section and removal of trailing whitespaces.
tests/e2e/accounts/base_account_test.go Removed a line of code within the fundAccount function.
testutil/testdata/grpc_query.go Reordered import statements related to gogoproto packages.
x/bank/keeper/keeper_test.go Removed the TestSendCoinsFromModuleToAccount_CoinSendDisabled function.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@tac0turtle tac0turtle marked this pull request as ready for review May 20, 2024 09:56
@tac0turtle tac0turtle requested a review from a team as a code owner May 20, 2024 09:56
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Out of diff range and nitpick comments (1)
tests/e2e/accounts/base_account_test.go (1)

Line range hint 63-63: Removal of error handling in fundAccount may lead to uncaught errors during tests.

Consider restoring the error check or ensuring that error handling is managed upstream to maintain robustness in testing.

Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 1f06f5b and 5f4872c.
Files selected for processing (4)
  • store/rootmulti/store.go (3 hunks)
  • tests/e2e/accounts/base_account_test.go (1 hunks)
  • testutil/testdata/grpc_query.go (1 hunks)
  • x/bank/keeper/keeper_test.go (1 hunks)
Files skipped from review due to trivial changes (3)
  • store/rootmulti/store.go
  • testutil/testdata/grpc_query.go
  • x/bank/keeper/keeper_test.go
Additional Context Used
Path-based Instructions (1)
tests/e2e/accounts/base_account_test.go (3)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.


Pattern tests/**/*: "Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

Additional comments not posted (1)
tests/e2e/accounts/base_account_test.go (1)

Line range hint 1-63: The test code conforms to the Uber Golang style guide and appears to cover relevant functionality.

However, consider the potential impact of removing error checks on the reliability of your tests.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Out of diff range and nitpick comments (1)
x/bank/keeper/keeper.go (1)

Line range hint 46-46: The logic and error handling in this file are robust and adhere well to the requirements of a banking module in a blockchain context.

However, consider using structured logging for better readability and maintenance.

- k.Logger.Error(fmt.Sprintf("Module %q attempted to mint coins %s it doesn't have permission for, error %v", moduleName, amounts, err))
+ k.Logger.Error("attempt to mint unauthorized coins", "module", moduleName, "amounts", amounts, "error", err)

This change enhances the readability and maintainability of log messages.

Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 5f4872c and 8de65ad.
Files selected for processing (2)
  • store/cache/cache.go (1 hunks)
  • x/bank/keeper/keeper.go (1 hunks)
Additional Context Used
Path-based Instructions (2)
store/cache/cache.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

x/bank/keeper/keeper.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

@@ -43,7 +43,7 @@ type (
func NewCommitKVStoreCache(store types.CommitKVStore, size uint) *CommitKVStoreCache {
cache, err := lru.NewARC(int(size))
if err != nil {
panic(fmt.Errorf("failed to create KVStore cache: %s", err))
panic(fmt.Errorf("failed to create KVStore cache: %w", err))
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider replacing panic with error handling to improve robustness.

- panic(fmt.Errorf("failed to create KVStore cache: %w", err))
+ return nil, fmt.Errorf("failed to create KVStore cache: %w", err)

This change requires updating the function signature to return an error and handling this error in all calling functions.

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.

We need to revert the changelog addition as well

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Out of diff range and nitpick comments (2)
x/bank/CHANGELOG.md (2)

Line range hint 35-35: Correct verb agreement in the description.

- methods now returns an error instead of panicking if any module accounts does not exist or unauthorized.
+ methods now return an error instead of panicking if any module accounts do not exist or are unauthorized.

Line range hint 40-43: Fix unordered list indentation.

-    * Changed `NewInput`, `NewOutput`, `NewQueryBalanceRequest`, `NewQueryAllBalancesRequest`, `NewQuerySpendableBalancesRequest` to accept a string instead of an `AccAddress`.
-    * Added an address codec as an argument to `NewSendAuthorization`.
-    * Added an address codec as an argument to `SanitizeGenesisBalances` which also returns an error.
-    * (simulation) `RandomGenesisBalances` also returns an error.
+  * Changed `NewInput`, `NewOutput`, `NewQueryBalanceRequest`, `NewQueryAllBalancesRequest`, `NewQuerySpendableBalancesRequest` to accept a string instead of an `AccAddress`.
+  * Added an address codec as an argument to `NewSendAuthorization`.
+  * Added an address codec as an argument to `SanitizeGenesisBalances` which also returns an error.
+  * (simulation) `RandomGenesisBalances` also returns an error.
Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 8de65ad and 469023d.
Files selected for processing (1)
  • x/bank/CHANGELOG.md (1 hunks)
Additional Context Used
LanguageTool (2)
x/bank/CHANGELOG.md (2)

Near line 35: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...MintCoins and BurnCoins methods now returns an error instead of panicking if any mo...


Near line 35: The verb form ‘does’ does not seem to match the subject ‘accounts’.
Context: ...ead of panicking if any module accounts does not exist or unauthorized. ### API Bre...

Path-based Instructions (1)
x/bank/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

@julienrbrt julienrbrt added this pull request to the merge queue May 21, 2024
Merged via the queue into main with commit c2f6c19 May 21, 2024
67 checks passed
@julienrbrt julienrbrt deleted the marko/revert_bank_change branch May 21, 2024 08:06
alpe added a commit that referenced this pull request May 23, 2024
* main: (95 commits)
  fix(x/accounts): check for overflows in multisig weights and votes (#20384)
  docs(x/account/auth): Improve error handling and comments in fee.go (#20426)
  docs: fix some markdown syntax (#20432)
  revert: bank change module to account change (#20427)
  fix: nil pointer panic when store don't exists in historical version (#20425)
  fix(store/v2): Remove should not error on miss (#20423)
  chore: upstream more changes from v2 (#20387)
  docs(x/auth/ante): fixed typo  in TxWithTimeoutHeight interface name (#20418)
  fix: avoid default sendenabled for module accounts (#20419)
  docs(x/auth): fixed typo in command example for multisign transaction (#20417)
  build(deps): Bump bufbuild/buf-setup-action from 1.31.0 to 1.32.0 (#20413)
  build(deps): Bump github.com/hashicorp/go-plugin from 1.6.0 to 1.6.1 in /store (#20414)
  feat(x/accounts): Add schema caching feature and corresponding test case (#20055)
  refactor(runtime/v2): remove dependency on sdk (#20389)
  refactor!: turn MsgsV2 into ReflectMessages to make it less confusing (#19839)
  docs: Enhanced the ParsePagination method documentation (#20385)
  refactor(runtime,core): split router service (#20401)
  chore: fix spelling errors (#20400)
  docs: Documented error handling in OfferSnapshot method (#20380)
  build(deps): Bump google.golang.org/grpc from 1.63.2 to 1.64.0 (#20390)
  ...
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