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

Feature Request: Include the slashed amount in slash event #9138

Closed
4 tasks
calvinlauyh opened this issue Apr 19, 2021 · 2 comments · Fixed by #9458
Closed
4 tasks

Feature Request: Include the slashed amount in slash event #9138

calvinlauyh opened this issue Apr 19, 2021 · 2 comments · Fixed by #9458
Assignees
@technicallyty

Comments

@calvinlauyh
Copy link
Contributor

calvinlauyh commented Apr 19, 2021 •
edited
Loading

Summary

Right now the slash event returns only the address, current power and reason for slashing. However, it does not cover how much is slashed.

Problem Definition

I am working on an chain data indexer, and I am unable to get the slashed amount unless I port the logic and calcuate. However, doing my own calculation may introduce inaccuracy and inconsistent with the Cosmos SDK.

Proposal

I would like to request adding a new key-value pair to the slash event:

burned

  • which is the token burn from the slashing

In the current implementation, the Slash method of StakingKeeper is called after slash event is emitted

cosmos-sdk/x/slashing/keeper/keeper.go

Line 70 in b219c54

types.EventTypeSlash,

If we can update the slash keeper's Slash method to return the slashed token, then it can be included in the event.

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@calvinaco calvinaco mentioned this issue May 21, 2021
Closed
4 tasks
@alexanderbez
Copy link
Contributor

ACK 👍

@technicallyty technicallyty self-assigned this May 27, 2021
@technicallyty technicallyty mentioned this issue Jun 3, 2021
Merged
19 tasks
@technicallyty
Copy link
Contributor

this has been implemented in #9458 and will be merged after v043 is released

@mergify mergify bot closed this as completed in #9458 Jul 5, 2021
mergify bot pushed a commit that referenced this issue Jul 5, 2021
@technicallyty
feat: add coins burned to slash event (#9458)
2188dd0 
<!--
The default pull request template is for types feat, fix, or refactor.
For other templates, add one of the following parameters to the url:
- template=docs.md
- template=other.md
-->

## Description

Adds the amount of coins slashed from the validator to the `Slash` event. Additionally, before this PR, the jail/slash events were emitted **BEFORE** the slash/jail functions were even ran, which could result in a false positive event if an error occurred in these functions. ~~These events were moved to the end of the functions that implement the logic for them instead.~~ This PR moves the events to be emitted after the logic is executed. 

Closes: #9138 

<!-- Add a description of the changes that this PR introduces and the files that
are the most critical to review. -->

- +Add `amount_slashed` to slash event
- +Slash now returns the amount of tokens burned
- +Events moved to be emitted after the logic is executed
- +Add test to test the slash return amount
~~- +Add EventType `Jail` to separate it from the `Slash` event~~
~~- +Move slash/jail events into the functions that execute the logic for it~~
~~- -Remove `Reason` attribute from slash event (didn't appear to be consistent with what was happening in code)~~

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

- [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [x] added `!` to the type prefix if API or client breaking change
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [x] provided a link to the relevant issue or specification
- [x] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [x] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [x] updated the relevant documentation or specification
- [x] reviewed "Files changed" and left comments if necessary
- [x] 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...

- [x] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - @ryanchristo 
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [x] reviewed state machine logic - not applicable
- [x] reviewed API design and naming - @ryanchristo 
- [x] reviewed documentation is accurate - @ryanchristo 
- [x] reviewed tests and test coverage - @ryanchristo 
- [ ] manually tested (if applicable)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@technicallyty technicallyty

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: add coins burned to slash event cosmos/cosmos-sdk
5 participants
@clevinson @amaury1093 @alexanderbez @calvinlauyh @technicallyty