Refactor x/bank according to ADR 031 #7520

aaronc · 2020-10-12T16:57:45Z

add sdk.WrapServiceResult for refactoring of handlers according to ADR 031
disable the RPC_REQUEST_STANDARD_NAME buf linter as per ADR 031
create bank Msg protobuf service
implements generated MsgServer and refactor most of x/bank/handler.go into MsgServer impl

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

Targeted PR against correct branch (see CONTRIBUTING.md)
Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
Code follows the module structure standards.
Wrote unit and integration tests
Updated relevant documentation (docs/) or specification (x/<module>/spec/)
Added relevant godoc comments.
Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
Re-reviewed Files changed in the Github PR explorer
Review Codecov Report in the comment section below once CI passes

codecov · 2020-10-12T17:07:52Z

Codecov Report

Merging #7520 into master will decrease coverage by 0.06%.
The diff coverage is 26.15%.

@@            Coverage Diff             @@
##           master    #7520      +/-   ##
==========================================
- Coverage   56.01%   55.95%   -0.07%     
==========================================
  Files         593      594       +1     
  Lines       37246    37266      +20     
==========================================
- Hits        20865    20853      -12     
- Misses      14263    14301      +38     
+ Partials     2118     2112       -6

amaury1093

nice!

amaury1093 · 2020-10-13T09:52:26Z

x/bank/keeper/msg_server.go

+	return &msgServer{Keeper: keeper}
+}
+
+var _ types.MsgServer = msgServer{}


Why implement MsgServer on a separate struct, and not on Keeper itself?

Because of the weird way bank has a keeper interface. Other modules should do what you're saying. And we should refactor bank in the near future anyway.

^ cc @atheeshp

I think in few cases we still needed this implementation,
https://github.com/cosmos/cosmos-sdk/pull/7524/files#diff-825d33eeaa8e743955334330c753008b9af67e55c61d03b348556a246b9b4bddR94
in this scenario few of the keeper functions are colliding with the msg sever functions. wdyt @amaurymartiny, @aaronc ?

Just use a separate struct wrapping the keeper then

* Refactor x/bank according to ADR 031 * Add comment * Update comment * Add comment * Add tests, address edge cases * Imports Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

* Refactor RegisterQueryServices -> RegisterServices (#7518) * Refactor RegisterQueryServices -> RegisterServices * Fix tests * Add ADR 031 BaseApp and codec infrastructure (#7519) * Refactor RegisterQueryServices -> RegisterServices * Cleaner proto files * Fix tests * Add MsgServer * Fix lint * Remove MsgServer from configurator for now * Remove useless file * Fix build * typo * Add router * Fix test * WIP * Add router * Remove test helper * Add beginning of test * Move test to simapp? * ServiceMsg implement sdk.Msg * Add handler by MsgServiceRouter * Correct signature * Add full test * use TxEncoder * Update baseapp/msg_service_router.go Co-authored-by: Aaron Craelius <aaron@regen.network> * Push changes * WIP on ServiceMsg unpacking * Make TestMsgService test pass * Fix tests * Tidying up * Tidying up * Tidying up * Add JSON test * Add comments * Tidying * Lint * Register MsgRequest interface * Rename * Fix tests * RegisterCustomTypeURL * Add changelog entries * Put in features * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update baseapp/msg_service_router.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Address review comments * Address nit * Fix lint * Update codec/types/interface_registry.go Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> * godoc Co-authored-by: Aaron Craelius <aaronc@users.noreply.github.com> Co-authored-by: Aaron Craelius <aaron@regen.network> Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> * Refactor x/bank according to ADR 031 (#7520) * Refactor x/bank according to ADR 031 * Add comment * Update comment * Add comment * Add tests, address edge cases * Imports Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Refactor x/{gov, crisis} according to ADR 031 (#7533) * Refactor x/gov according to ADR 31 * fix tests * Refactor x/crisis according to ADR 031 * fix lint * lint * lint * review changes * lint * review change * fic doc Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Refactor x/distribution according to ADR 031 (#7524) * Refactor x/distribution according to ADR 31 * lint * removed unused * Apply suggestions from code review Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> Co-authored-by: Aaron Craelius <aaron@regen.network> Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * [x/slashing] Implement Protobuf Msg Services (#7557) * Update x/slashing to use proto msg service * Fix proto-gen Co-authored-by: Aaron Craelius <aaron@regen.network> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Refactor x/auth/vesting to use ADR-031 (#7551) * update auth/vesting module to use proto msg services * rm accidental tmp files * Update x/auth/vesting/msg_server.go Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> * golangci-lint fix Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> Co-authored-by: Aaron Craelius <aaron@regen.network> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Refactor x/staking according to ADR 031 (#7556) * Refactor x/staking according to ADR 031 * lint * review changes * review changes * review changes Co-authored-by: Aaron Craelius <aaron@regen.network> * Add MsgServer to Configurator for ADR 031 wiring (#7584) * Add MsgServer to Configurator for ADR 031 wiring * Add docs, wire up evidence & staking * Add integration test * Add comments * Doc strings * Update types/module/configurator.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Update types/module/configurator.go Co-authored-by: Cory <cjlevinson@gmail.com> * Wire up vesting * Update CHANGELOG.md Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com> Co-authored-by: Cory <cjlevinson@gmail.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Refactor x/evidence to ADR-031 (#7538) * Refactor x/evidence to ADR-031 * Add hash in response * Update changelog * Update x/evidence/keeper/keeper.go * Update proto/cosmos/evidence/v1beta1/tx.proto Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> * Use msgServer struct Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> * Refactor x/ibc to ADR 031 (#7576) * WIP: Refactor x/ibc to ADR 031 * updated handler * removed unsued * fix * Add proto service for ibc/transfer * lint * remove old upgrade handler * added doc * review changes * fix tests * formatter * Add MsgServer wiring in RegisterServices Co-authored-by: Aaron Craelius <aaronc@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * add changelog entries for non-nil Result.Data fields in message responses Co-authored-by: Aaron Craelius <aaron@regen.network> Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com> Co-authored-by: Aaron Craelius <aaronc@users.noreply.github.com> Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: atheeshp <59333759+atheeshp@users.noreply.github.com>

aaronc added 2 commits October 12, 2020 12:54

Refactor x/bank according to ADR 031

2df86c3

Add comment

3208fd1

aaronc mentioned this pull request Oct 12, 2020

Implement ADR 031: Protobuf Msg Services #7500

Closed

16 tasks

aaronc added 2 commits October 12, 2020 13:00

Update comment

107b871

Add comment

67a5419

aaronc marked this pull request as ready for review October 12, 2020 17:02

aaronc requested review from alessio and alexanderbez as code owners October 12, 2020 17:02

aaronc added A:automerge Automatically merge PR once all prerequisites pass. C:x/bank labels Oct 12, 2020

aaronc requested review from anilcse, clevinson, amaury1093, blushi and robert-zaremba October 12, 2020 17:02

aaronc added 2 commits October 12, 2020 13:17

Add tests, address edge cases

34db518

Imports

b07ab39

amaury1093 approved these changes Oct 13, 2020

View reviewed changes

anilcse approved these changes Oct 13, 2020

View reviewed changes

Merge branch 'master' into aaronc/7500-x-bank

8ac9c22

mergify bot merged commit 9be15a4 into master Oct 13, 2020

mergify bot deleted the aaronc/7500-x-bank branch October 13, 2020 09:05

amaury1093 reviewed Oct 13, 2020

View reviewed changes

clevinson mentioned this pull request Oct 19, 2020

Implement Protobuf Msg Services #7540

Closed

16 tasks

clevinson mentioned this pull request Oct 19, 2020

[backport/v0.40.x] Implement ADR031 #7599

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor x/bank according to ADR 031 #7520

Refactor x/bank according to ADR 031 #7520

aaronc commented Oct 12, 2020 •

edited

Loading

codecov bot commented Oct 12, 2020 •

edited

Loading

amaury1093 left a comment

amaury1093 Oct 13, 2020

aaronc Oct 13, 2020

amaury1093 Oct 13, 2020

atheeshp Oct 13, 2020

aaronc Oct 13, 2020

Refactor x/bank according to ADR 031 #7520

Refactor x/bank according to ADR 031 #7520

Conversation

aaronc commented Oct 12, 2020 • edited Loading

codecov bot commented Oct 12, 2020 • edited Loading

Codecov Report

amaury1093 left a comment

Choose a reason for hiding this comment

amaury1093 Oct 13, 2020

Choose a reason for hiding this comment

aaronc Oct 13, 2020

Choose a reason for hiding this comment

amaury1093 Oct 13, 2020

Choose a reason for hiding this comment

atheeshp Oct 13, 2020

Choose a reason for hiding this comment

aaronc Oct 13, 2020

Choose a reason for hiding this comment

aaronc commented Oct 12, 2020 •

edited

Loading

codecov bot commented Oct 12, 2020 •

edited

Loading