update godoc for VerifyClientMessage #1281
Merged
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
Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
damiannolan
approved these changes
Apr 22, 2022
Yup great idea! |
crodriguezvega
approved these changes
Apr 25, 2022
9 tasks
seantking
approved these changes
Apr 25, 2022
modules/core/exported/client.go
Outdated
| // UpdateState updates and stores as necessary any associated information for an IBC client, such as the ClientState and corresponding ConsensusState. | ||
| // An error is returned if ClientMessage is of type Misbehaviour | ||
| // An error is returned if ClientMessage is of type Misbehaviour. It assumes the ClientMessage has already been verified. | ||
| UpdateState(sdk.Context, codec.BinaryCodec, sdk.KVStore, ClientMessage) error |
There was a problem hiding this comment.
Sorry if we've discussed this point already. Why can't CheckForMisbehaviour be in UpdateState?
Is it to make the check explicit for light client developers?
There was a problem hiding this comment.
Is it to make the check explicit for light client developers?
It's two fold:
- make the check explicit to light client developers
- not doing it would require the API to return that misbehaviour has been detected and the client frozen (since we emit different events)
…to colin/1185-update-godoc
3 tasks
oshorefueled
pushed a commit
to ComposableFi/ibc-go
that referenced
this pull request
Aug 9, 2022
* update godoc * Update modules/core/exported/client.go Co-authored-by: Carlos Rodriguez <carlos@interchain.io> * update UpdateState godoc * reorganize interface functions logically Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
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
closes: #1185
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