-
Notifications
You must be signed in to change notification settings - Fork 176
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
Added README files in v2 proto directories. #812
Conversation
Signed-off-by: Cody Littley <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! thanks for this. would personally like to have a README in api/proto/README.md
to describe v1 vs v2. Like an entrypoint README, that could link to the others.
api/proto/disperser/v2/README.md
Outdated
|
||
# What is "v2"? | ||
|
||
The EigenDA v2 Architecture is a fundamental redesign of the disperser, and by extension systems that interact |
There was a problem hiding this comment.
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
...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
wording updated
api/proto/disperser/v2/README.md
Outdated
# 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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
wording updated
I added a readme to the |
Signed-off-by: Cody Littley <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel like having one README at api/proto
is sufficient, but I'll leave it up to you
api/proto/relay/README.md
Outdated
@@ -0,0 +1,15 @@ | |||
# Should I use the v2 API? |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
Signed-off-by: Cody Littley <[email protected]>
I've collapsed these README files into a single file. |
Why are these changes needed?
Adds README files in directories containing API not yet in use.
Checks