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

Jump to bottom

fix(docs): fix GetVerifiedRange doc #2826

Merged
merged 1 commit into from
Oct 9, 2023
Merged

fix(docs): fix GetVerifiedRange doc #2826

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/adr/adr-009-public-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ GetByHeight(ctx context.Context, height uint64) (*header.ExtendedHeader, error)
// WaitForHeight blocks until the header at the given height has been processed
// by the node's header store or until context deadline is exceeded.
WaitForHeight(ctx context.Context, height uint64) (*header.ExtendedHeader, error)
// GetVerifiedRangeByHeight returns the given range [from:to) of ExtendedHeaders
// GetVerifiedRangeByHeight returns the given range (from:to) of ExtendedHeaders
// from the node's header store and verifies that the returned headers are
// adjacent to each other.
GetVerifiedRangeByHeight(ctx context.Context, from, to uint64) ([]*ExtendedHeader, error)
Expand Down
2 changes: 1 addition & 1 deletion nodebuilder/header/header.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ type Module interface {

// GetByHash returns the header of the given hash from the node's header store.
GetByHash(ctx context.Context, hash libhead.Hash) (*header.ExtendedHeader, error)
// GetVerifiedRangeByHeight returns the given range [from:to) of ExtendedHeaders
// GetVerifiedRangeByHeight returns the given range (from:to) of ExtendedHeaders
// from the node's header store and verifies that the returned headers are
// adjacent to each other.
GetVerifiedRangeByHeight(
Expand Down
Loading