Skip to content
Open
Show file tree
Hide file tree
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 Jul 23, 2025
ad72dc3
labelled the types file
lolosaisa Jul 23, 2025
f644b08
updated the paths of the files ssz-quickstart.md and ssz-views-and-pr…
lolosaisa Jul 24, 2025
225793d
added the defination of SSZ in the ssz quickstart quide
lolosaisa Jul 26, 2025
45ab4bc
defined what serialization , deserialization and merklezation means …
lolosaisa Jul 26, 2025
5326854
added a simple explanation of the terms
lolosaisa Jul 26, 2025
050ca33
added the defination of the two different layers of components
lolosaisa Jul 31, 2025
30c1347
Added the typing system logic on ssz , the different kind of types an…
lolosaisa Aug 6, 2025
04437bf
docs(ssz-quickstard.md): Finished the typing system section of the co…
lolosaisa Aug 6, 2025
57d29d6
docs: Added a link to the lodestar types repository if the developers…
lolosaisa Aug 6, 2025
9600ad4
docs: Fixed the typing errors
lolosaisa Aug 6, 2025
e1e4e01
docs: fized the number of columns in a table that was causing a rende…
lolosaisa Aug 6, 2025
52fb152
docs(ssz-quickstart.md): Added the description of Fork -Specific Shem…
lolosaisa Aug 6, 2025
175078f
docs(ssz-quickstart.md): Added the default values section, defined wh…
lolosaisa Aug 7, 2025
0d2cd0b
docs: Fixing a table issue
lolosaisa Aug 7, 2025
152a05d
docs(ssz-quickstart.md): Added how to use default value section, with…
lolosaisa Aug 11, 2025
241dfc8
docs(ssz-quickstart.md): Setting Fiels in your zeroed /default object
lolosaisa Aug 11, 2025
4668cfe
docs(ssz-quickstart.md): How to modify primitive values
lolosaisa Aug 11, 2025
3f0966b
docs(ssz-quickstart.md): How Lodestar enhances Typescript Safety
lolosaisa Aug 11, 2025
71b1c00
docs(ssz-quickstart.md):Added real life examples of how typescript sa…
lolosaisa Aug 11, 2025
3b4e013
docs(ssz-quickstart.md): Added a table that explain Lodestar SSZ TYpe…
lolosaisa Aug 11, 2025
4a0eb4a
docs: Removed the fork-specific folders and the files
lolosaisa Aug 11, 2025
02077ff
docs(ssz-quickstart.md): Added the serialization and deserialization …
lolosaisa Aug 12, 2025
f84bb46
docs(ssz-quickstart.md): Changed up the defination to avoid repetition
lolosaisa Aug 12, 2025
f7084ac
docs(ssz-quickstart.md): Added the deserialization section and an exm…
lolosaisa Aug 12, 2025
0c6f950
docs(ssz-quickstart.md): Added code example of the whole process
lolosaisa Aug 12, 2025
74b311d
docs(ssz-quickstart.md): Fixing prettier issues
lolosaisa Aug 12, 2025
f997ec5
docs(ssz-quickstart.md): Finalized the seerialization and deserializa…
lolosaisa Aug 12, 2025
da4d816
Update SSZ quickstart documentation
lolosaisa Sep 19, 2025
15b857a
docs: Added the Hashing aspect on the ssz-quickstart.md with example
lolosaisa Sep 26, 2025
866d838
docs(5045): Added the merkleization part with examples
lolosaisa Sep 26, 2025
e844180
docs(5045): JSON Conversion in ssz, added how to encode data to json …
lolosaisa Sep 26, 2025
2533aff
docs(5045): Added how to decode from JSON back to ssz object
lolosaisa Sep 26, 2025
356323a
docs(5045): add detailed README mapping docs and examples for SSZ
lolosaisa Sep 26, 2025
3b46c21
docs(5045): FInished the quickstart file and now moving forward to th…
lolosaisa Oct 1, 2025
1aa39ef
docs(5045): Added the defination of views and why they are needed per…
lolosaisa Oct 1, 2025
13a7192
docs(5045): Polished the defination for views to be doc friendly
lolosaisa Oct 1, 2025
b069272
docs(5045): Added the views vs values section and the outline for the…
lolosaisa Oct 2, 2025
dcc6281
docs(5045): Added the difference between a plain object and a view in…
lolosaisa Oct 2, 2025
18e16fe
docs(5045): Added the description of Tree Views
lolosaisa Oct 3, 2025
e10ae03
docs(5045): Added the defination for tree view and code on how they o…
lolosaisa Oct 4, 2025
a655090
docs(5045): Deleted the tree backed views after mismatching the defin…
lolosaisa Oct 4, 2025
1e3cb61
docs(5045): Added the defination of tree backed views and the two mai…
lolosaisa Oct 4, 2025
cc5805d
docs(5045): Tree views as a wrapper around a tree and a type that pro…
lolosaisa Oct 4, 2025
1407820
docs(5045): Added an example of how to create an attestation view, mo…
lolosaisa Oct 4, 2025
2dfc4d5
docs(5045): added a more detailed exampls that includes the property …
lolosaisa Oct 4, 2025
764bd87
docs(5045): Added subview behaviour for views code included
lolosaisa Oct 4, 2025
4028627
docs(5045): Added the defination for TRee ViewDU
lolosaisa Oct 4, 2025
73bde8b
docs(5045): Added a code example of the treeviewDU
lolosaisa Oct 5, 2025
82aab6f
docs(5045): Added the key features of the treeviewDU
lolosaisa Oct 5, 2025
8c12202
docs(5045): Fixed the structure/prettie heading
lolosaisa Oct 5, 2025
e0f44ae
docs(5045): Added the subview behaviour of a viewDU
lolosaisa Oct 5, 2025
fd6b57e
docs(5045): Added the code example for subview difference
lolosaisa Oct 5, 2025
b8788f7
docs(5045): Added the section for common operations with views so the…
lolosaisa Oct 6, 2025
51671f7
docs(5045): Added more examples of operations
lolosaisa Oct 6, 2025
927fef5
docs(5045): Fixed some prettier typos
lolosaisa Oct 6, 2025
a0bf5ca
docs(5045): Added the defination of proofs
lolosaisa Oct 7, 2025
b9a9f2c
docs(5045): How the proofs are built
lolosaisa Oct 7, 2025
6ba7480
docs(5045): Described how the proofs works and the methods that enabl…
lolosaisa Oct 7, 2025
d26dd45
docs(5045): Added the code to show how proofs are created
lolosaisa Oct 7, 2025
85b2b76
docs(5045): Added the how to reconstruct from proofs and the anatomy …
lolosaisa Oct 7, 2025
a726ef4
docs(5045): How to verify proofs
lolosaisa Oct 7, 2025
34f0e5a
docs(5045): Added te section for tips fr the typescript developers
lolosaisa Oct 7, 2025
b2290d6
docs(5045):Added resources for more studies
lolosaisa Oct 8, 2025
904b034
docs(5045): Added the generalized incies section
lolosaisa Oct 8, 2025
ce7e739
docs(5045): how are generalized Indices used
lolosaisa Oct 8, 2025
ba88193
docs(5045): Added the common pitfals and how to debug them if it happems
lolosaisa Oct 8, 2025
e5bc948
docs(5045): Added best practices when working with ssz
lolosaisa Oct 8, 2025
06a9d5e
Fixing typos and adding missing elements in the quickstart.md
lolosaisa Oct 9, 2025
345446f
docs(5045): Added the table of content in the SSZ quickstart.md
lolosaisa Oct 9, 2025
73d3b4e
docs(5045): Restructured the ssz components upto the fork specific s…
lolosaisa Oct 9, 2025
a4c076b
docs(5045): Fixed the structure for the core ssz types made transitio…
lolosaisa Oct 9, 2025
1755b8f
docs(5045): Fixed the typos and changed the code to typescript
lolosaisa Oct 9, 2025
59317cc
docs(5045): Finished making the changes on ssz quickstart md
lolosaisa Oct 9, 2025
082606d
docs(5045): Added a table of content in the views and proofs file and…
lolosaisa Oct 10, 2025
aa6d3b5
docs(5045): Instead of having a folder with different files for examp…
lolosaisa Oct 10, 2025
1981d47
docs(5045): Added the examples for developers
lolosaisa Oct 10, 2025
ba4ffd3
docs(5045): Added all the the explanation for each code and the conce…
lolosaisa Oct 10, 2025
08e083b
docs(5045): Deleted some repetion , polished all the finals for the f…
lolosaisa Oct 10, 2025
f583522
docs: finalize SSZ documentation and examples overview
lolosaisa Oct 10, 2025
c692f6c
fixed the typos and grammar issues in the README file
lolosaisa Oct 21, 2025
7dc43ee
deleted the grammar errors and fixed typos
lolosaisa Oct 21, 2025
084242e
fixes: Fixed the typos in the ssz views and proofs
lolosaisa Oct 21, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions packages/types/ssz-docs/README.md
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
├── ...
1 change: 1 addition & 0 deletions packages/types/ssz-docs/altair/SyncCommittee.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
//doc for type SyncCOmmittee
1 change: 1 addition & 0 deletions packages/types/ssz-docs/bellatrix/ExecutionPayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/ExecutionPayload
1 change: 1 addition & 0 deletions packages/types/ssz-docs/phase0/Attestation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
attestation
1 change: 1 addition & 0 deletions packages/types/ssz-docs/phase0/BeaconBlock.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
BeaconBlock
Empty file.
Empty file.
Empty file.
Loading