Skip to content

Commit

Permalink
style: fix PutBlob's docstring comment wrt finalization status
Browse files Browse the repository at this point in the history
  • Loading branch information
samlaf committed Oct 18, 2024
1 parent 839ffbb commit 4c8a2d7
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions api/clients/eigenda_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,9 @@ func (m EigenDAClient) GetBlob(ctx context.Context, batchHeaderHash []byte, blob
return decodedData, nil
}

// PutBlob encodes and writes a blob to EigenDA, waiting for it to be finalized
// before returning. This function is resilient to transient failures and
// timeouts.
// PutBlob encodes and writes a blob to EigenDA, waiting for a desired blob status
// to be reached (guarded by WaitForFinalization config param) before returning.
// This function is resilient to transient failures and timeouts.
// TODO: should we use a pointer receiver instead, to prevent unnecessary copying of the EigenDAClient struct?
func (m EigenDAClient) PutBlob(ctx context.Context, data []byte) (*grpcdisperser.BlobInfo, error) {
resultChan, errorChan := m.PutBlobAsync(ctx, data)
Expand Down

0 comments on commit 4c8a2d7

Please sign in to comment.