From 67658ace52ed434c4d505022faf44a327e22136b Mon Sep 17 00:00:00 2001 From: leopardracer <136604165+leopardracer@users.noreply.github.com> Date: Thu, 12 Dec 2024 20:42:52 +0200 Subject: [PATCH] fix: typos in documentation files (#989) --- api/docs/disperser.md | 2 +- api/proto/disperser/disperser.proto | 2 +- disperser/dataapi/server_test.go | 2 +- test/synthetic-test/synthetic_client_test.go | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/api/docs/disperser.md b/api/docs/disperser.md index 39f01e439..7a7975e80 100644 --- a/api/docs/disperser.md +++ b/api/docs/disperser.md @@ -369,7 +369,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'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/proto/disperser/disperser.proto b/api/proto/disperser/disperser.proto index ee537ee15..d4ca1faee 100644 --- a/api/proto/disperser/disperser.proto +++ b/api/proto/disperser/disperser.proto @@ -18,7 +18,7 @@ service Disperser { rpc DisperseBlob(DisperseBlobRequest) returns (DisperseBlobReply) {} // 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/disperser/dataapi/server_test.go b/disperser/dataapi/server_test.go index 05c23efc3..50c572395 100644 --- a/disperser/dataapi/server_test.go +++ b/disperser/dataapi/server_test.go @@ -1240,7 +1240,7 @@ func TestFetchDeregisteredOperatorOnline(t *testing.T) { } func TestFetchDeregisteredOperatorsMultipleOfflineOnline(t *testing.T) { - // Skipping this test as repported being flaky but could not reproduce it locally + // Skipping this test as reported being flaky but could not reproduce it locally t.Skip("Skipping testing in CI environment") r := setUpRouter() diff --git a/test/synthetic-test/synthetic_client_test.go b/test/synthetic-test/synthetic_client_test.go index 3854a214e..4f3d1a8e9 100644 --- a/test/synthetic-test/synthetic_client_test.go +++ b/test/synthetic-test/synthetic_client_test.go @@ -297,7 +297,7 @@ func TestDisperseBlobEndToEnd(t *testing.T) { // For now log....later we can define a baseline value for this logger.Printf("Time to Disperse Blob %s", disperseBlobStopTime.String()) - // Set Confirmation DeaLine For Confirmation of Dispersed Blob + // Set Confirmation Deadline For Confirmation of Dispersed Blob // Update this to a minute over Batcher_Pull_Interval confirmationDeadline, err := time.ParseDuration(testSuite.BatcherPullInterval)