Tendermint Light Client Documentation #6801
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
AdityaSripal
requested review from
colin-axner,
crodriguezvega,
damiannolan,
chatton,
DimitrisJim and
srdtrk
as code owners
damiannolan
approved these changes
Jul 15, 2024
There was a problem hiding this comment.
Great start to these docs! 🙏🏻 Thanks @AdityaSripal!
I agree we can add more and polish them as necessary. I added a couple of suggestions in the PR but feel free to apply them or wait til later and we can add/adjust them post-merge 💅🏻
|
|
||
| ### Updates | ||
|
|
||
| Once the initial client state and consensus state are submitted, future consensus states can be added to the client by submitting IBC Headers. These headers contain all necessary information to run the Comet BFT Light Client protocol. For detailed information on the Comet BFT Light Client protocol and its safety properties please refer to the Comet BFT paper. |
There was a problem hiding this comment.
should we add a link to the paper?
srdtrk
approved these changes
Jul 16, 2024
There was a problem hiding this comment.
Are there more files coming? If not maybe this should be broken down to different files?
There was a problem hiding this comment.
Not from myself. but future tendermint docs can come in and be in new files
Co-authored-by: Damian Nolan <damiannolan@gmail.com>
…o into aditya/tm-light-client-docs
3 tasks
crodriguezvega
approved these changes
Aug 15, 2024
There was a problem hiding this comment.
Excellent start for the client's documentation! Thanks a lot, @AdityaSripal!
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
This is a start for having documentation on the tendermint light client as we have with localhost and wasm. I give a brief explanation of the main mechanisms of the light client. In the misbehaviour section, I go into detail on the security model embedded in the tendermint light client implementation.
We should flush this out more, but I believe that can be done in subsequent PRs
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/).godoccomments.Files changedin the GitHub PR explorer.SonarCloud Reportin the comment section below once CI passes.