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

R4R: Tags Cleanup & Docs #3137

Merged
merged 15 commits into from
Dec 20, 2018
Merged

R4R: Tags Cleanup & Docs #3137

merged 15 commits into from
Dec 20, 2018

Conversation

alexanderbez
Copy link
Contributor

@alexanderbez alexanderbez commented Dec 17, 2018

  • Fixed certain tag values (not using Amino to marshal because clients should not have to do this!)
  • Updated slashing modules tags
  • Added a tags doc for each module to provide details on key expected event/tag for both handlers and begin/end blockers

  • 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.

  • Wrote tests

  • Updated relevant documentation (docs/)

  • Added entries in PENDING.md with issue #

  • rereviewed Files changed in the github PR explorer


For Admin Use:

  • Added appropriate labels to PR (ex. wip, ready-for-review, docs)
  • Reviewers Assigned
  • Squashed all commits, uses message "Merge pull request #XYZ: [title]" (coding standards)

@codecov
Copy link

codecov bot commented Dec 17, 2018

Codecov Report

Merging #3137 into develop will increase coverage by 0.04%.
The diff coverage is 96.77%.

@@             Coverage Diff             @@
##           develop    #3137      +/-   ##
===========================================
+ Coverage    55.03%   55.07%   +0.04%     
===========================================
  Files          133      133              
  Lines         9438     9443       +5     
===========================================
+ Hits          5194     5201       +7     
+ Misses        3924     3922       -2     
  Partials       320      320

@alexanderbez alexanderbez changed the title WIP: Quick-n-Dirty Events R4R: Tags Cleanup & Docs Dec 19, 2018
@alexanderbez alexanderbez mentioned this pull request Dec 19, 2018
5 tasks
@alexanderbez
Copy link
Contributor Author

alexanderbez commented Dec 19, 2018

@cwgoes I decided to address #2448 into two PRs in the spirit of trying to keep our PRs small and tidy.

Namely, this PR simply does some cleanup and more importantly creates tags/events documentation for each module. A second PR, #3171, will be to actually implement a simple event manager.

So this is R4R.


| Key | Value |
|-----------|---------------------------|
| delegator | {delegatorAccountAddress} |
Copy link
Member

Choose a reason for hiding this comment

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

Is there a reason why we don't tag every message with it's type? Or do we and that isn't mentioned here?

Copy link
Contributor Author

@alexanderbez alexanderbez Dec 19, 2018

Choose a reason for hiding this comment

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

We do:

# baseapp.go#L:624
tags = append(tags, sdk.MakeTag(sdk.TagAction, []byte(msg.Type())))

I will be changing this in #3171 to be message-type instead of action so I'd rather do that in the aforementioned PR (i.e have this merged first).


The governance module emits the following events/tags:

## EndBlocker
Copy link
Member

Choose a reason for hiding this comment

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

What does this mean? All governance events are tagged with these?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Exactly.

Copy link
Member

@jackzampolin jackzampolin left a comment

Choose a reason for hiding this comment

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

A couple of small questions, but looks good to me!

Copy link
Contributor

@cwgoes cwgoes left a comment

Choose a reason for hiding this comment

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

Tested ACK

@jackzampolin jackzampolin merged commit 5a13e75 into develop Dec 20, 2018
@jackzampolin jackzampolin deleted the bez/2448-quick-n-dirty-events branch December 20, 2018 03:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants