update core IBC docs #7560
Merged
update core IBC docs #7560
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
Codecov Report
@@ Coverage Diff @@
## master #7560 +/- ##
=======================================
Coverage 54.12% 54.12%
=======================================
Files 611 611
Lines 38601 38601
=======================================
Hits 20892 20892
Misses 15576 15576
Partials 2133 2133 |
|
@AdityaSripal could you do the capabilities section in a follow up 🙏 ? |
…nto colin/6134-core-docs
colin-axner
requested review from
aaronc,
alessio and
alexanderbez
as code owners
|
updated everything except capabilities |
fedekunze
reviewed
Oct 26, 2020
| client specific parameters like `TrustLevel` which must be considered valid in relation | ||
| to the `Header`. | ||
|
|
||
| Clients may be upgraded. The upgrade should be verified using `VerifyUpgrade`. It is not |
There was a problem hiding this comment.
I think it's also relevant to mention how to upgrade the client if one of the chains halts/panics vs if the upgrade is planned
There was a problem hiding this comment.
This should go at client specific docs IMO since it could be implemented in a multitude of ways depending on the client
There was a problem hiding this comment.
ah yes. Although I think it's still relevant to add that as a comment (i.e that it is up to the light client implementation).
Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>
…nto colin/6134-core-docs
cwgoes
approved these changes
Oct 26, 2020
x/ibc/core/spec/01_concepts.md
Outdated
| transfers will unmarshal the data into proto definitions representing | ||
| a token transfer. | ||
|
|
||
| Future optimizations may allow for storage cleanup of stored packet |
There was a problem hiding this comment.
Packet commitments are cleaned-up when acknowledgements are processed
Co-authored-by: Christopher Goes <cwgoes@pluranimity.org>
…nto colin/6134-core-docs
fedekunze
approved these changes
Oct 27, 2020
fedekunze
added
the
A:automerge
clevinson
pushed a commit
that referenced
this pull request
Oct 29, 2020
* update state * add empty concept fields, update callbacks and messages * update client creation, update and upgrade section * add packet lifecycle concepts * add host and proof section * add connection handshake section * add channel handshakes * state transitions * self review fixes * Apply suggestions from code review Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * apply @fedekunze review suggestions * packet data section * Apply suggestions from code review Co-authored-by: Christopher Goes <cwgoes@pluranimity.org> * add @cwgoes and @fedekunze review suggestions * fix typos Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> Co-authored-by: Christopher Goes <cwgoes@pluranimity.org> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
45 tasks
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: #6134
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