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

Added README files in v2 proto directories. #812

Merged
merged 3 commits into from
Oct 21, 2024
Merged

Added README files in v2 proto directories. #812

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2f299ad
Added README files in v2 proto directories.
cody-littley Oct 16, 2024
35d9400
Made suggested changes.
cody-littley Oct 17, 2024
17c9f4b
Made suggested changes.
cody-littley Oct 18, 2024
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
14 changes: 14 additions & 0 deletions api/proto/disperser/v2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Should I use the v2 API?

No. The v2 API is currently under active development, and is not yet deployed to any environment.

# Is the v2 API stable?

No, although it is becoming more stable as the v2 design matures.

# What is "v2"?

The EigenDA v2 Architecture is a fundamental redesign of the disperser, and by extension systems that interact
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: ... redesign of the protocol...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wording updated

with the disperser. The v2 Architecture is an important stepping stone towards reducing centralization and for
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: The v2 architecture improves robustness, efficiency, and compatibility with upcoming features such as permissionless disperser and data availability sampling.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wording updated

enabling data availability sampling. We intend on publishing a more detailed roadmap and design overview in the near
future, stay tuned!
7 changes: 7 additions & 0 deletions api/proto/lightnode/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Should I use the light node API?

No. Light nodes are currently under development and are not yet deployed to any environment.

# Is the light node API stable?

No, although it is becoming more stable as the design matures.
14 changes: 14 additions & 0 deletions api/proto/node/v2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Should I use the v2 API?

No. The v2 API is currently under active development, and is not yet deployed to any environment.

# Is the v2 API stable?

No, although it is becoming more stable as the v2 design matures.

# What is "v2"?

The EigenDA v2 Architecture is a fundamental redesign of the disperser, and by extension systems that interact
with the disperser. The v2 Architecture is an important stepping stone towards reducing centralization and for
enabling data availability sampling. We intend on publishing a more detailed roadmap and design overview in the near
future, stay tuned!
18 changes: 18 additions & 0 deletions api/proto/relay/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Is the relay considered part of the v2 architecture?

Yes.

# Should I use the v2 API?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's no indication api/proto/relay is part of v2. Maybe this README should be specific to relay or say something like relay is only applicable with v2 architecture?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a note that the code in the relay directory is experimental.


No. The v2 API is currently under active development, and is not yet deployed to any environment.

# Is the v2 API stable?

No, although it is becoming more stable as the v2 design matures.

# What is "v2"?

The EigenDA v2 Architecture is a fundamental redesign of the disperser, and by extension systems that interact
with the disperser. The v2 Architecture is an important stepping stone towards reducing centralization and for
enabling data availability sampling. We intend on publishing a more detailed roadmap and design overview in the near
future, stay tuned!
Loading