Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add spec directory for each IBC client implementation #56

Closed
5 of 9 tasks
colin-axner opened this issue Aug 20, 2020 · 3 comments
Closed
5 of 9 tasks

Add spec directory for each IBC client implementation #56

colin-axner opened this issue Aug 20, 2020 · 3 comments
Labels
docs Improvements or additions to documentation

Comments

@colin-axner
Copy link
Contributor

Summary

Add a spec directory for each IBC client implementation.

  • solo machine
  • tendermint
  • localhost

Problem Definition

Clients can be very complex in verification logic and our IBC implementation can very in small details from the ICS spec while still being valid. We should be clearly documenting in words the behaviour of each client.

Proposal

Add a spec directory for each client (tendermint, localhost, solo machine). This can be done now or as we move clients in a light-clients directory.

Some specific things to be mentioned:

Tendermint (TODO: add from previous prs - validator set hash change, removal of signed header)

Localhost


For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@fedekunze fedekunze changed the title Add spec directory for each IBC client implementation Add spec directory for each IBC client implementation Aug 20, 2020
@colin-axner colin-axner self-assigned this Oct 9, 2020
@colin-axner
Copy link
Contributor Author

I'll be working on solo machine docs next week

@colin-axner
Copy link
Contributor Author

Moved from cosmos/cosmos-sdk#6134: Document how to connect to localhost client to relay and test messages

@colin-axner colin-axner removed their assignment Oct 19, 2020
@colin-axner colin-axner transferred this issue from cosmos/cosmos-sdk Mar 5, 2021
@colin-axner colin-axner added the docs Improvements or additions to documentation label Apr 21, 2021
@colin-axner
Copy link
Contributor Author

The spec should be moved to docs as per #135

There should be 07-tendermint docs, but that should be a separate issue and isn't high priority (light client dev guide would be higher priority)

faddat referenced this issue in notional-labs/ibc-go Feb 23, 2022
Modified url and fixed query contract
faddat referenced this issue in notional-labs/ibc-go Mar 1, 2022
* Update README.md

* Update README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant