-
-
Notifications
You must be signed in to change notification settings - Fork 410
docs: finalize SSZ usage documentation for TypeScript devs (Issue #5045) #8078
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
Open
lolosaisa
wants to merge
83
commits into
ChainSafe:unstable
Choose a base branch
from
lolosaisa:ssz-docs-ts-5045
base: unstable
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,513
−0
Open
Changes from 2 commits
Commits
Show all changes
83 commits
Select commit
Hold shift + click to select a range
6fe4db2
set up initial SSZ documentation structure, and Created the initial f…
lolosaisa ad72dc3
labelled the types file
lolosaisa f644b08
updated the paths of the files ssz-quickstart.md and ssz-views-and-pr…
lolosaisa 225793d
added the defination of SSZ in the ssz quickstart quide
lolosaisa 45ab4bc
defined what serialization , deserialization and merklezation means …
lolosaisa 5326854
added a simple explanation of the terms
lolosaisa 050ca33
added the defination of the two different layers of components
lolosaisa 30c1347
Added the typing system logic on ssz , the different kind of types an…
lolosaisa 04437bf
docs(ssz-quickstard.md): Finished the typing system section of the co…
lolosaisa 57d29d6
docs: Added a link to the lodestar types repository if the developers…
lolosaisa 9600ad4
docs: Fixed the typing errors
lolosaisa e1e4e01
docs: fized the number of columns in a table that was causing a rende…
lolosaisa 52fb152
docs(ssz-quickstart.md): Added the description of Fork -Specific Shem…
lolosaisa 175078f
docs(ssz-quickstart.md): Added the default values section, defined wh…
lolosaisa 0d2cd0b
docs: Fixing a table issue
lolosaisa 152a05d
docs(ssz-quickstart.md): Added how to use default value section, with…
lolosaisa 241dfc8
docs(ssz-quickstart.md): Setting Fiels in your zeroed /default object
lolosaisa 4668cfe
docs(ssz-quickstart.md): How to modify primitive values
lolosaisa 3f0966b
docs(ssz-quickstart.md): How Lodestar enhances Typescript Safety
lolosaisa 71b1c00
docs(ssz-quickstart.md):Added real life examples of how typescript sa…
lolosaisa 3b4e013
docs(ssz-quickstart.md): Added a table that explain Lodestar SSZ TYpe…
lolosaisa 4a0eb4a
docs: Removed the fork-specific folders and the files
lolosaisa 02077ff
docs(ssz-quickstart.md): Added the serialization and deserialization …
lolosaisa f84bb46
docs(ssz-quickstart.md): Changed up the defination to avoid repetition
lolosaisa f7084ac
docs(ssz-quickstart.md): Added the deserialization section and an exm…
lolosaisa 0c6f950
docs(ssz-quickstart.md): Added code example of the whole process
lolosaisa 74b311d
docs(ssz-quickstart.md): Fixing prettier issues
lolosaisa f997ec5
docs(ssz-quickstart.md): Finalized the seerialization and deserializa…
lolosaisa da4d816
Update SSZ quickstart documentation
lolosaisa 15b857a
docs: Added the Hashing aspect on the ssz-quickstart.md with example
lolosaisa 866d838
docs(5045): Added the merkleization part with examples
lolosaisa e844180
docs(5045): JSON Conversion in ssz, added how to encode data to json …
lolosaisa 2533aff
docs(5045): Added how to decode from JSON back to ssz object
lolosaisa 356323a
docs(5045): add detailed README mapping docs and examples for SSZ
lolosaisa 3b46c21
docs(5045): FInished the quickstart file and now moving forward to th…
lolosaisa 1aa39ef
docs(5045): Added the defination of views and why they are needed per…
lolosaisa 13a7192
docs(5045): Polished the defination for views to be doc friendly
lolosaisa b069272
docs(5045): Added the views vs values section and the outline for the…
lolosaisa dcc6281
docs(5045): Added the difference between a plain object and a view in…
lolosaisa 18e16fe
docs(5045): Added the description of Tree Views
lolosaisa e10ae03
docs(5045): Added the defination for tree view and code on how they o…
lolosaisa a655090
docs(5045): Deleted the tree backed views after mismatching the defin…
lolosaisa 1e3cb61
docs(5045): Added the defination of tree backed views and the two mai…
lolosaisa cc5805d
docs(5045): Tree views as a wrapper around a tree and a type that pro…
lolosaisa 1407820
docs(5045): Added an example of how to create an attestation view, mo…
lolosaisa 2dfc4d5
docs(5045): added a more detailed exampls that includes the property …
lolosaisa 764bd87
docs(5045): Added subview behaviour for views code included
lolosaisa 4028627
docs(5045): Added the defination for TRee ViewDU
lolosaisa 73bde8b
docs(5045): Added a code example of the treeviewDU
lolosaisa 82aab6f
docs(5045): Added the key features of the treeviewDU
lolosaisa 8c12202
docs(5045): Fixed the structure/prettie heading
lolosaisa e0f44ae
docs(5045): Added the subview behaviour of a viewDU
lolosaisa fd6b57e
docs(5045): Added the code example for subview difference
lolosaisa b8788f7
docs(5045): Added the section for common operations with views so the…
lolosaisa 51671f7
docs(5045): Added more examples of operations
lolosaisa 927fef5
docs(5045): Fixed some prettier typos
lolosaisa a0bf5ca
docs(5045): Added the defination of proofs
lolosaisa b9a9f2c
docs(5045): How the proofs are built
lolosaisa 6ba7480
docs(5045): Described how the proofs works and the methods that enabl…
lolosaisa d26dd45
docs(5045): Added the code to show how proofs are created
lolosaisa 85b2b76
docs(5045): Added the how to reconstruct from proofs and the anatomy …
lolosaisa a726ef4
docs(5045): How to verify proofs
lolosaisa 34f0e5a
docs(5045): Added te section for tips fr the typescript developers
lolosaisa b2290d6
docs(5045):Added resources for more studies
lolosaisa 904b034
docs(5045): Added the generalized incies section
lolosaisa ce7e739
docs(5045): how are generalized Indices used
lolosaisa ba88193
docs(5045): Added the common pitfals and how to debug them if it happems
lolosaisa e5bc948
docs(5045): Added best practices when working with ssz
lolosaisa 06a9d5e
Fixing typos and adding missing elements in the quickstart.md
lolosaisa 345446f
docs(5045): Added the table of content in the SSZ quickstart.md
lolosaisa 73d3b4e
docs(5045): Restructured the ssz components upto the fork specific s…
lolosaisa a4c076b
docs(5045): Fixed the structure for the core ssz types made transitio…
lolosaisa 1755b8f
docs(5045): Fixed the typos and changed the code to typescript
lolosaisa 59317cc
docs(5045): Finished making the changes on ssz quickstart md
lolosaisa 082606d
docs(5045): Added a table of content in the views and proofs file and…
lolosaisa aa6d3b5
docs(5045): Instead of having a folder with different files for examp…
lolosaisa 1981d47
docs(5045): Added the examples for developers
lolosaisa ba4ffd3
docs(5045): Added all the the explanation for each code and the conce…
lolosaisa 08e083b
docs(5045): Deleted some repetion , polished all the finals for the f…
lolosaisa f583522
docs: finalize SSZ documentation and examples overview
lolosaisa c692f6c
fixed the typos and grammar issues in the README file
lolosaisa 7dc43ee
deleted the grammar errors and fixed typos
lolosaisa 084242e
fixes: Fixed the typos in the ssz views and proofs
lolosaisa File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # Lodestar Types Documentation | ||
|
|
||
| This folder contains reference and usage documentation for the Lodestar `@lodestar/types` package. | ||
|
|
||
| It is structured to help contributors and developers understand how to use and interact with the SSZ (Simple Serialize) types used throughout Ethereum consensus clients, particularly within Lodestar. | ||
|
|
||
| ## 📁 Structure Overview | ||
|
|
||
| - **`ssz-quickstart.md`**: A beginner-friendly introduction to working with SSZ — how to serialize, deserialize, and compute `hashTreeRoot`. | ||
| - **`ssz-views-and-proofs.md`**: Details advanced usage of SSZ views, how to generate Merkle proofs, and common caveats when accessing nested data. | ||
| - **`phase0/`, `altair/`, `bellatrix/`**: Each fork folder documents important SSZ types defined in that Ethereum consensus phase. Inside are brief summaries and usage tips for critical types like `BeaconBlock`, `Attestation`, `ExecutionPayload`, etc. It also explains what is type is and how it works. | ||
|
|
||
| --- | ||
|
|
||
| This documentation is intended as a quick reference and learning tool for new contributors, client developers, and researchers working with Lodestar’s type system. | ||
| It is detailed description of the method's purpose, includes working code examples that users can run and tutorials on how to use them. | ||
|
|
||
| ## 📘 Learn More | ||
|
|
||
| - [SSZ Quickstart](./docs/ssz-quickstart.md) | ||
| - [Working with SSZ Views & Proofs](./docs/ssz-views-and-proofs.md) | ||
|
|
||
| ```bash | ||
| docs/ | ||
| ├── ssz-quickstart.md # Guide to basic SSZ usage | ||
| ├── ssz-views-and-proofs.md # Advanced SSZ features | ||
| ├── phase0/ # Phase0-specific types | ||
| ├── altair/ # Altair-specific types | ||
| ├── bellatrix/ # Bellatrix-specific types | ||
| ├── ... | ||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| //doc for type SyncCOmmittee |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| /ExecutionPayload |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| attestation |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| BeaconBlock |
Empty file.
Empty file.
Empty file.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.