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.

Sign up for GitHub

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

Jump to bottom

Document 08-wasm ethereum light client #146

Open
gjermundgaraba opened this issue Dec 4, 2024 · 0 comments
Open

Document 08-wasm ethereum light client #146

gjermundgaraba opened this issue Dec 4, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation ethereum-light-client Issues related to the 08-wasm ethereum light client

Comments

@gjermundgaraba
Copy link
Contributor

gjermundgaraba commented Dec 4, 2024 •
edited
Loading

We want to make sure the 08-wasm ethereum light client is properly documented.

Definition of done

  • All public APIs are documented
    • Linter enforcing this (also in CI)
  • README.md (TBD if this should be in the main README.md or a separate programs/08-wasm-eth/README.md). Not necessarily in order, what to cover:
    • Introduction and purpose
    • High-level architecture
    • How it works from ethereum consensus POV (slots, execution, etc)
    • How to use
    • How to build (build (including (cargo run-script build-08-wasm-eth), test and cosmwasm-check)
    • Attribution and links to union
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation ethereum-light-client Issues related to the 08-wasm ethereum light client
Projects
IBC-GO Eureka
Status: Backlog
Milestone
No milestone
Development

No branches or pull requests
1 participant
@gjermundgaraba