Skip to content

Commit

Permalink
docs(blob): update godoc comments to better match what Get and GetPro…
Browse files Browse the repository at this point in the history
…of actually do (#3530)

Co-authored-by: Vlad <[email protected]>
  • Loading branch information
ramin and walldiss authored Jul 5, 2024
1 parent 4d116a8 commit 1828f78
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions blob/service.go
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,10 @@ func (s *Service) Submit(ctx context.Context, blobs []*Blob, txConfig *SubmitOpt
return uint64(resp.Height), nil
}

// Get retrieves all the blobs for given namespaces at the given height by commitment.
// Get collects all namespaced data from the EDS, constructs blobs
// and compares commitments. `ErrBlobNotFound` can be returned in case blob was not found.
// Get retrieves a blob in a given namespace at the given height by commitment.
// Get collects all namespaced data from the EDS, construct the blob
// and compares the commitment argument.
// `ErrBlobNotFound` can be returned in case blob was not found.
func (s *Service) Get(
ctx context.Context,
height uint64,
Expand All @@ -110,9 +111,9 @@ func (s *Service) Get(
return
}

// GetProof retrieves all blobs in the given namespaces at the given height by commitment
// and returns their Proof. It collects all namespaced data from the EDS, constructs blobs
// and compares commitments.
// GetProof returns an NMT inclusion proof for a specified namespace to the respective row roots
// on which the blob spans on at the given height, using the given commitment.
// It employs the same algorithm as service.Get() internally.
func (s *Service) GetProof(
ctx context.Context,
height uint64,
Expand Down

0 comments on commit 1828f78

Please sign in to comment.