Refactor x/evidence to ADR-031 #7538

amaury1093 · 2020-10-14T16:27:56Z

Description

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-14T16:34:27Z

Codecov Report

Merging #7538 into master will decrease coverage by 0.03%.
The diff coverage is 30.00%.

@@            Coverage Diff             @@
##           master    #7538      +/-   ##
==========================================
- Coverage   54.18%   54.15%   -0.04%     
==========================================
  Files         604      605       +1     
  Lines       38159    38162       +3     
==========================================
- Hits        20675    20665      -10     
- Misses      15388    15401      +13     
  Partials     2096     2096

proto/cosmos/evidence/v1beta1/tx.proto

robert-zaremba

update the return type

proto/cosmos/evidence/v1beta1/tx.proto

x/evidence/keeper/keeper.go

blushi

Pre-approving, LGTM.

proto/cosmos/evidence/v1beta1/tx.proto

Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>

aaronc · 2020-10-16T14:37:56Z

x/evidence/exported/evidence.go

 // implement in order to process submitted evidence. The concrete MsgSubmitEvidence
 // must be defined at the application-level.
-type MsgSubmitEvidence interface {
+type MsgSubmitEvidenceI interface {


Why do we still need an interface here?

And why the renaming?

Why do we still need an interface here?

basically:

MsgSubmitEvidence is the wire type

MsgSubmitEvidenceI is the domain type, which the keeper manipulates

not strictly necessary, but i also don't want to introduce too many refactors here

And why the renaming?

it's confusing to have an interface and a struct having the same name.

aaronc · 2020-10-16T14:38:58Z

x/evidence/keeper/keeper.go

 // the corresponding registered Evidence Handler. An error is returned if no
 // registered Handler exists or if the Handler fails. Otherwise, the evidence is
 // persisted.
-func (k Keeper) SubmitEvidence(ctx sdk.Context, evidence exported.Evidence) error {
+func (k Keeper) SubmitEvidenceI(ctx sdk.Context, evidence exported.Evidence) error {


Suggested change

func (k Keeper) SubmitEvidenceI(ctx sdk.Context, evidence exported.Evidence) error {

func (k Keeper) SubmitEvidence(ctx sdk.Context, evidence exported.Evidence) error {

Let's revert this. There is no EvidenceI interface.

okay, i'll add a msgServer struct then

…500-evidence

… into am-7500-evidence

fixed

* 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 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>

Refactor x/evidence to ADR-031

0e89d1b

amaury1093 added the C:x/evidence label Oct 14, 2020

aaronc added this to the v0.41 milestone Oct 14, 2020

amaury1093 commented Oct 15, 2020

View reviewed changes

proto/cosmos/evidence/v1beta1/tx.proto Outdated Show resolved Hide resolved

robert-zaremba previously requested changes Oct 15, 2020

View reviewed changes

proto/cosmos/evidence/v1beta1/tx.proto Outdated Show resolved Hide resolved

amaury1093 added 3 commits October 15, 2020 17:37

Add hash in response

301b077

Merge branch 'master' into am-7500-evidence

e638ae7

Update changelog

d4b06b2

amaury1093 marked this pull request as ready for review October 15, 2020 15:51

amaury1093 requested review from aaronc, alessio and alexanderbez as code owners October 15, 2020 15:51

amaury1093 requested review from robert-zaremba, anilcse, atheeshp and blushi October 15, 2020 15:52

amaury1093 commented Oct 15, 2020

View reviewed changes

x/evidence/keeper/keeper.go Outdated Show resolved Hide resolved

Update x/evidence/keeper/keeper.go

0869f26

blushi approved these changes Oct 16, 2020

View reviewed changes

proto/cosmos/evidence/v1beta1/tx.proto Outdated Show resolved Hide resolved

Update proto/cosmos/evidence/v1beta1/tx.proto

f434c3d

Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>

aaronc reviewed Oct 16, 2020

View reviewed changes

aaronc requested changes Oct 16, 2020

View reviewed changes

amaury1093 added 3 commits October 16, 2020 17:25

Merge branch 'master' of ssh://github.com/cosmos/cosmos-sdk into am-7…

0b269db

…500-evidence

Merge branch 'am-7500-evidence' of ssh://github.com/cosmos/cosmos-sdk…

7ddbb44

… into am-7500-evidence

Use msgServer struct

12bf8c1

amaury1093 requested a review from aaronc October 16, 2020 15:37

aaronc added the A:automerge Automatically merge PR once all prerequisites pass. label Oct 16, 2020

aaronc approved these changes Oct 16, 2020

View reviewed changes

mergify bot merged commit 58eabcb into master Oct 16, 2020

mergify bot deleted the am-7500-evidence branch October 16, 2020 16:05

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/evidence to ADR-031 #7538

Refactor x/evidence to ADR-031 #7538

amaury1093 commented Oct 14, 2020 •

edited by aaronc

Loading

codecov bot commented Oct 14, 2020 •

edited

Loading

robert-zaremba left a comment

blushi left a comment

aaronc Oct 16, 2020

aaronc Oct 16, 2020

amaury1093 Oct 16, 2020

aaronc Oct 16, 2020

amaury1093 Oct 16, 2020

	func (k Keeper) SubmitEvidenceI(ctx sdk.Context, evidence exported.Evidence) error {
	func (k Keeper) SubmitEvidence(ctx sdk.Context, evidence exported.Evidence) error {

Refactor x/evidence to ADR-031 #7538

Refactor x/evidence to ADR-031 #7538

Conversation

amaury1093 commented Oct 14, 2020 • edited by aaronc Loading

Description

codecov bot commented Oct 14, 2020 • edited Loading

Codecov Report

robert-zaremba left a comment

Choose a reason for hiding this comment

blushi left a comment

Choose a reason for hiding this comment

aaronc Oct 16, 2020

Choose a reason for hiding this comment

aaronc Oct 16, 2020

Choose a reason for hiding this comment

amaury1093 Oct 16, 2020

Choose a reason for hiding this comment

aaronc Oct 16, 2020

Choose a reason for hiding this comment

amaury1093 Oct 16, 2020

Choose a reason for hiding this comment

amaury1093 commented Oct 14, 2020 •

edited by aaronc

Loading

codecov bot commented Oct 14, 2020 •

edited

Loading