Coracle/nostrlib
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docstrings for many functions.

Browse Source
This commit is contained in:
fiatjaf
2025-03-04 11:08:31 -03:00
parent a82780e82e
commit 5bfaed2740
22 changed files with 293 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
sdk/specific_event.go
View File

@@ -11,12 +11,19 @@ import (
"github.com/nbd-wtf/go-nostr/sdk/hints"
)
// FetchSpecificEventParameters contains options for fetching specific events.
type FetchSpecificEventParameters struct {
WithRelays bool
// WithRelays indicates whether to include relay information in the response
// (this causes the request to take longer as it will wait for all relays to respond).
WithRelays bool
// SkipLocalStore indicates whether to skip checking the local store for the event
// and storing the result in the local store.
SkipLocalStore bool
}
// FetchSpecificEventFromInput tries to get a specific event from a NIP-19 code using whatever means necessary.
// FetchSpecificEventFromInput tries to get a specific event from a NIP-19 code or event ID.
// It supports nevent, naddr, and note NIP-19 codes, as well as raw event IDs.
func (sys *System) FetchSpecificEventFromInput(
ctx context.Context,
input string,
@@ -47,7 +54,9 @@ func (sys *System) FetchSpecificEventFromInput(
return sys.FetchSpecificEvent(ctx, pointer, params)
}
// FetchSpecificEvent tries to get a specific event from a NIP-19 code using whatever means necessary.
// FetchSpecificEvent tries to get a specific event using a Pointer (EventPointer or EntityPointer).
// It first checks the local store, then queries relays associated with the event or author,
// and finally falls back to general-purpose relays.
func (sys *System) FetchSpecificEvent(
ctx context.Context,
pointer nostr.Pointer,