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

docs: Create adr-005-cryptographic-equivocation-verification.md #909

Merged
merged 5 commits into from
Aug 14, 2023

Conversation

jtremback
Copy link
Contributor

@jtremback jtremback commented May 1, 2023

Description

Add ADR-005 which outlines the cryptographic equivocation verification feature

Closes #1124


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
  • Added ! to 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
  • Followed the guidelines for building SDK modules
  • Included the necessary unit and integration tests
  • Added a changelog entry to CHANGELOG.md
  • Included comments for documenting Go code
  • Updated the relevant documentation or specification
  • Reviewed "Files changed" and left comments if necessary
  • 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 ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage

@jtremback jtremback changed the title Create adr-005-cryptographic-equivocation-verification.md Documentation: Create adr-005-cryptographic-equivocation-verification.md May 1, 2023
@mpoke mpoke changed the title Documentation: Create adr-005-cryptographic-equivocation-verification.md docs: Create adr-005-cryptographic-equivocation-verification.md May 2, 2023
@jtremback jtremback marked this pull request as ready for review May 9, 2023 20:15
@jtremback jtremback requested a review from a team as a code owner May 9, 2023 20:15
@mpoke mpoke mentioned this pull request May 16, 2023
12 tasks
@mpoke mpoke requested a review from ancazamfir May 16, 2023 08:18
Current limitations:

- This only handles light client attacks, not double signing. In the future, we will add the code to also verify double signing.
- Since a special endpoint must be used to submit the evidence, the evidence is not automatically submitted by Hermes. In the future, we may make Hermes submit the evidence, or use a hook provided by IBC to run the code automatically when evidence is submitted to the IBC client. In the current state, someone will need to submit the evidence manually in the 3 weeks after a light client attack has occured.
Copy link
Contributor

@ancazamfir ancazamfir May 17, 2023

Choose a reason for hiding this comment

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

I don't understand this limitation. The whole point of adding that HandleConsumerMisbehaviour was for Hermes to submit the HandleConsumerMisbehaviour message automatically.


- This only handles light client attacks, not double signing. In the future, we will add the code to also verify double signing.
- Since a special endpoint must be used to submit the evidence, the evidence is not automatically submitted by Hermes. In the future, we may make Hermes submit the evidence, or use a hook provided by IBC to run the code automatically when evidence is submitted to the IBC client. In the current state, someone will need to submit the evidence manually in the 3 weeks after a light client attack has occured.
- We currently can't derive an infraction height from the evidence, so it is only possible to tombstone validators, not actually slash them.
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you clarify why this is?


Current limitations:

- This only handles light client attacks, not double signing. In the future, we will add the code to also verify double signing.
Copy link
Contributor

@ancazamfir ancazamfir May 17, 2023

Choose a reason for hiding this comment

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

Why don't we implement the double signing evidence handling from the start? Is there a tight deadline or technical reasons?

* save first gist

* add first draft

* Update docs/docs/adrs/adr-005-cryptographic-equivocation-verification.md

Co-authored-by: Marius Poke <marius.poke@posteo.de>

---------

Co-authored-by: Marius Poke <marius.poke@posteo.de>
sainoe and others added 3 commits August 14, 2023 23:15
* add first draft

* udpate refs

* update

* Update docs/docs/adrs/adr-005-cryptographic-equivocation-verification.md

Co-authored-by: Marius Poke <marius.poke@posteo.de>

* Update docs/docs/adrs/adr-005-cryptographic-equivocation-verification.md

Co-authored-by: Marius Poke <marius.poke@posteo.de>

* Update docs/docs/adrs/adr-005-cryptographic-equivocation-verification.md

Co-authored-by: Marius Poke <marius.poke@posteo.de>

* Update docs/docs/adrs/adr-005-cryptographic-equivocation-verification.md

Co-authored-by: Marius Poke <marius.poke@posteo.de>

* Update docs/docs/adrs/adr-005-cryptographic-equivocation-verification.md

Co-authored-by: Marius Poke <marius.poke@posteo.de>

* Update docs/docs/adrs/adr-005-cryptographic-equivocation-verification.md

Co-authored-by: Marius Poke <marius.poke@posteo.de>

* Update docs/docs/adrs/adr-005-cryptographic-equivocation-verification.md

Co-authored-by: Marius Poke <marius.poke@posteo.de>

* Update docs/docs/adrs/adr-005-cryptographic-equivocation-verification.md

Co-authored-by: Marius Poke <marius.poke@posteo.de>

* Update docs/docs/adrs/adr-005-cryptographic-equivocation-verification.md

Co-authored-by: Marius Poke <marius.poke@posteo.de>

* Update docs/docs/adrs/adr-005-cryptographic-equivocation-verification.md

Co-authored-by: Marius Poke <marius.poke@posteo.de>

* Update docs/docs/adrs/adr-005-cryptographic-equivocation-verification.md

Co-authored-by: Marius Poke <marius.poke@posteo.de>

* Update docs/docs/adrs/adr-005-cryptographic-equivocation-verification.md

Co-authored-by: Marius Poke <marius.poke@posteo.de>

* add little changes

* address comments

* fix todos

* Update docs/docs/adrs/adr-005-cryptographic-equivocation-verification.md

Co-authored-by: Anca Zamfir <ancazamfir@users.noreply.github.com>

* Update docs/docs/adrs/adr-005-cryptographic-equivocation-verification.md

Co-authored-by: Anca Zamfir <ancazamfir@users.noreply.github.com>

* Update docs/docs/adrs/adr-005-cryptographic-equivocation-verification.md

* apply review suggestions

* Update docs/docs/adrs/adr-005-cryptographic-equivocation-verification.md

---------

Co-authored-by: Marius Poke <marius.poke@posteo.de>
Co-authored-by: Anca Zamfir <ancazamfir@users.noreply.github.com>
@mpoke mpoke merged commit f636cfc into main Aug 14, 2023
8 of 9 checks passed
@mpoke mpoke deleted the jtremback-adr-005 branch August 14, 2023 21:22
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.

Create ADR for Cryptographic Verification of Equivocation
4 participants