chore: rename 07-tendermint type Misbehaviour to ConflictingHeaders #1090
Conversation
colin-axner
requested review from
fedekunze,
AdityaSripal,
crodriguezvega,
seantking,
charleenfei and
damiannolan
as code owners
| message Misbehaviour { | ||
| // ConflictingHeaders is a wrapper over two conflicting Headers | ||
| // that implements Header interface expected by ICS-02 | ||
| message ConflictingHeaders { |
There was a problem hiding this comment.
@AdityaSripal thoughts on the naming here?
We could potentially leave this as Misbehaviour?
I'm still have some concerns about merging the Misbehaviour and Header interface, mostly around naming. It'd be nice if we could align with the spec as well
We know a normal Header can lead to a valid client update, or be evidence of misbehaviour. We also know there can be another structure which can show misbehaviour (in this case duplicate header), but I imagine a light client could have multiple of these structures. My main concern is that Header is usually associated with the header produced by a blockchain, but the interface we are using expects potentially one or more headers to be passed in to update the IBC client (either to a valid state or to freeze it)
There was a problem hiding this comment.
We can just leave this as misbehavior in my opinion.
Yes this is odd naming, especially given that it conflicts with the semantic definition of Header in the regular blockchain case.
I would prefer we give a different name to the superset interface that encompasses the regular headers, batched headers, and misbehaviour.
Perhaps something generic like ClientMessage
There was a problem hiding this comment.
Oh that's great. I'm in favor!
|
Leaving as misbehaviour as @AdityaSripal suggests |
<!-- Please read and fill out this form before submitting your PR. Please make sure you have reviewed our contributors guide before submitting your first PR. --> ## Overview <!-- Please provide an explanation of the PR, including the appropriate context, background, goal, and rationale. If there is an issue with this information, please provide a tl;dr and link the issue. --> ## Checklist <!-- Please complete the checklist to ensure that the PR is ready to be reviewed. IMPORTANT: PRs should be left in Draft until the below checklist is completed. --> - [ ] New and updated code has appropriate documentation - [ ] New and updated code has new and/or updated testing - [ ] Required CI checks are passing - [ ] Visual proof for any user facing features like CLI or documentation updates - [ ] Linked issues closed with keywords Co-authored-by: Ganesha Upadhyaya <gupadhyaya@Ganeshas-MacBook-Pro-2.local>
Description
ref: #879
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.
docs/) or specification (x/<module>/spec/)godoccomments.Unreleasedsection inCHANGELOG.mdFiles changedin the Github PR explorerCodecov Reportin the comment section below once CI passes