chore: update 07-tendermint GetConsensusState to return bool over error #1180
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
damiannolan
requested review from
colin-axner,
fedekunze and
AdityaSripal
as code owners
|
Happy to leave this on the back burner until the higher priority PRs are merged. Should minimise disruptions with merge conflicts..etc |
colin-axner
reviewed
Mar 28, 2022
seantking
approved these changes
Mar 28, 2022
damiannolan
commented
Mar 28, 2022
houshengbo
reviewed
Mar 28, 2022
colin-axner
reviewed
Mar 29, 2022
modules/light-clients/07-tendermint/types/misbehaviour_handle.go
Outdated
Show resolved
Hide resolved
modules/light-clients/07-tendermint/types/misbehaviour_handle.go
Outdated
Show resolved
Hide resolved
modules/light-clients/07-tendermint/types/misbehaviour_handle.go
Outdated
Show resolved
Hide resolved
| @@ -59,29 +58,14 @@ func SetConsensusState(clientStore sdk.KVStore, cdc codec.BinaryCodec, consensus | |||
|
|
|||
| // GetConsensusState retrieves the consensus state from the client prefixed | |||
| // store. An error is returned if the consensus state does not exist. | |||
There was a problem hiding this comment.
godoc needs to be updated. Should we make this function private?
There was a problem hiding this comment.
Making private makes a bit more awkward for testing. We would actually need to remove the test function for this.
getConsensusState will still get coverage from a number of other tests but testing the panic scenarios then isn't really possible.
What do you think? I don't really have any strong feelings about making it public/private
Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>
Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>
seunlanlege
pushed a commit
to ComposableFi/ibc-go
that referenced
this pull request
Aug 9, 2022
…or (cosmos#1180) * updating 07-tendermint GetConsensusState to return bool over error * panic on unmarshal and type assertion failure, update tests * updating to use MustUnmarshalConsensusState directly * Update modules/light-clients/07-tendermint/types/misbehaviour_handle.go Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> * Update modules/light-clients/07-tendermint/types/misbehaviour_handle.go Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> * removing comments and updating godoc Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>
CosmosCar
pushed a commit
to caelus-labs/ibc-go
that referenced
this pull request
Nov 6, 2023
<!-- 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 Closes: cosmos#1180 <!-- 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. --> - [x] New and updated code has appropriate documentation - [x] New and updated code has new and/or updated testing - [x] Required CI checks are passing - [ ] Visual proof for any user facing features like CLI or documentation updates - [x] Linked issues closed with keywords
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
07-tenderminthelperGetConsensusStateto return(*ConsensusState, bool)in favour of(*ConsensusState, error)closes: #1140
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