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

docs(blob): update godoc comments to better match what Get and GetProof actually do #3530

Merged
merged 6 commits into from
Jul 5, 2024
Merged

docs(blob): update godoc comments to better match what Get and GetProof actually do #3530

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
364a012
update godoc comments to better match what Get and GetProof actually do
ramin Jun 26, 2024
a0c3fbf
Update blob/service.go
ramin Jul 1, 2024
9e47a4e
Merge branch 'main' into docs/ramin/blob-comment
ramin Jul 4, 2024
087b493
Merge branch 'main' into docs/ramin/blob-comment
ramin Jul 4, 2024
8e45c17
update comment with @vgonkivs edit
ramin Jul 4, 2024
56ef6a0
Merge branch 'main' into docs/ramin/blob-comment
renaynay Jul 5, 2024
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
13 changes: 7 additions & 6 deletions blob/service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,10 @@ func (s *Service) Submit(ctx context.Context, blobs []*Blob, gasPrice GasPrice)
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 @@ -136,9 +137,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 retrieves a blob in the given namespace at the given height by commitment
// and returns their Proof. It collects all namespaced data from the EDS, constructs the blob
// and compares the commitment argument.
ramin marked this conversation as resolved.
Show resolved Hide resolved
ramin marked this conversation as resolved.
Show resolved Hide resolved
func (s *Service) GetProof(
ctx context.Context,
height uint64,
Expand Down
Loading