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

Update proto docs #993

Merged
merged 1 commit into from
Dec 12, 2024
+5 −5
Merged

Update proto docs #993

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion api/docs/disperser.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1009,7 +1009,7 @@ <h3 id="disperser.Disperser">Disperser</h3>
<td><a href="#disperser.AuthenticatedRequest">AuthenticatedRequest</a> stream</td>
<td><a href="#disperser.AuthenticatedReply">AuthenticatedReply</a> stream</td>
<td><p>DisperseBlobAuthenticated is similar to DisperseBlob, except that it requires the
client to authenticate itself via the AuthenticationData message. The protoco is as follows:
client to authenticate itself via the AuthenticationData message. The protocol is as follows:
1. The client sends a DisperseBlobAuthenticated request with the DisperseBlobRequest message
2. The Disperser sends back a BlobAuthHeader message containing information for the client to
verify and sign.
Expand Down
2 changes: 1 addition & 1 deletion api/docs/eigenda-protos.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1891,7 +1891,7 @@ <h3 id="disperser.Disperser">Disperser</h3>
<td><a href="#disperser.AuthenticatedRequest">AuthenticatedRequest</a> stream</td>
<td><a href="#disperser.AuthenticatedReply">AuthenticatedReply</a> stream</td>
<td><p>DisperseBlobAuthenticated is similar to DisperseBlob, except that it requires the
client to authenticate itself via the AuthenticationData message. The protoco is as follows:
client to authenticate itself via the AuthenticationData message. The protocol is as follows:
1. The client sends a DisperseBlobAuthenticated request with the DisperseBlobRequest message
2. The Disperser sends back a BlobAuthHeader message containing information for the client to
verify and sign.
Expand Down
2 changes: 1 addition & 1 deletion api/docs/eigenda-protos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -721,7 +721,7 @@ Disperser defines the public APIs for dispersing blobs.
| DisperseBlob | [DisperseBlobRequest](#disperser-DisperseBlobRequest) | [DisperseBlobReply](#disperser-DisperseBlobReply) | DisperseBlob accepts a single blob to be dispersed. This executes the dispersal async, i.e. it returns once the request is accepted. The client should use GetBlobStatus() API to poll the processing status of the blob.

If DisperseBlob returns the following error codes: INVALID_ARGUMENT (400): request is invalid for a reason specified in the error msg. RESOURCE_EXHAUSTED (429): request is rate limited for the quorum specified in the error msg. user should retry after the specified duration. INTERNAL (500): serious error, user should NOT retry. |
| DisperseBlobAuthenticated | [AuthenticatedRequest](#disperser-AuthenticatedRequest) stream | [AuthenticatedReply](#disperser-AuthenticatedReply) stream | DisperseBlobAuthenticated is similar to DisperseBlob, except that it requires the client to authenticate itself via the AuthenticationData message. The protoco is as follows: 1. The client sends a DisperseBlobAuthenticated request with the DisperseBlobRequest message 2. The Disperser sends back a BlobAuthHeader message containing information for the client to verify and sign. 3. The client verifies the BlobAuthHeader and sends back the signed BlobAuthHeader in an AuthenticationData message. 4. The Disperser verifies the signature and returns a DisperseBlobReply message. |
| DisperseBlobAuthenticated | [AuthenticatedRequest](#disperser-AuthenticatedRequest) stream | [AuthenticatedReply](#disperser-AuthenticatedReply) stream | DisperseBlobAuthenticated is similar to DisperseBlob, except that it requires the client to authenticate itself via the AuthenticationData message. The protocol is as follows: 1. The client sends a DisperseBlobAuthenticated request with the DisperseBlobRequest message 2. The Disperser sends back a BlobAuthHeader message containing information for the client to verify and sign. 3. The client verifies the BlobAuthHeader and sends back the signed BlobAuthHeader in an AuthenticationData message. 4. The Disperser verifies the signature and returns a DisperseBlobReply message. |
| GetBlobStatus | [BlobStatusRequest](#disperser-BlobStatusRequest) | [BlobStatusReply](#disperser-BlobStatusReply) | This API is meant to be polled for the blob status. |
| RetrieveBlob | [RetrieveBlobRequest](#disperser-RetrieveBlobRequest) | [RetrieveBlobReply](#disperser-RetrieveBlobReply) | This retrieves the requested blob from the Disperser&#39;s backend. This is a more efficient way to retrieve blobs than directly retrieving from the DA Nodes (see detail about this approach in api/proto/retriever/retriever.proto). The blob should have been initially dispersed via this Disperser service for this API to work. |

Expand Down
4 changes: 2 additions & 2 deletions api/grpc/disperser/disperser_grpc.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading