From a9164e3e14e8157d147cea07122346e39d97f52e Mon Sep 17 00:00:00 2001 From: Oleg Kovalov Date: Mon, 27 May 2024 10:50:20 +0200 Subject: [PATCH] docs: document trusted header in Verify --- verify.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/verify.go b/verify.go index 0c1f3e9e..fe0c0568 100644 --- a/verify.go +++ b/verify.go @@ -11,8 +11,9 @@ import ( const DefaultHeightThreshold uint64 = 80000 // ~ 14 days of 15 second headers // Verify verifies untrusted Header against trusted following general Header checks and -// custom user-specific checks defined in Header.Verify +// custom user-specific checks defined in Header.Verify. // +// If trusted header is zero, no error is returned. // If heightThreshold is zero, uses DefaultHeightThreshold. // Always returns VerifyError. func Verify[H Header[H]](trstd, untrstd H, heightThreshold uint64) error {