Update proto docs (#993)

Layr-Labs · Dec 12, 2024 · 2897477 · 2897477
1 parent 67658ac
commit 2897477
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/api/docs/disperser.html b/api/docs/disperser.html
@@ -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.

diff --git a/api/docs/eigenda-protos.html b/api/docs/eigenda-protos.html
@@ -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.

diff --git a/api/docs/eigenda-protos.md b/api/docs/eigenda-protos.md
@@ -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. |
 

diff --git a/api/grpc/disperser/disperser_grpc.pb.go b/api/grpc/disperser/disperser_grpc.pb.go