well-goknown/vendor/github.com/fiatjaf/eventstore/store.go

33 lines
1.1 KiB
Go
Raw Normal View History

package eventstore
import (
"context"
"github.com/nbd-wtf/go-nostr"
)
// Store is a persistence layer for nostr events handled by a relay.
type Store interface {
// Init is called at the very beginning by [Server.Start], after [Relay.Init],
// allowing a storage to initialize its internal resources.
Init() error
// Close must be called after you're done using the store, to free up resources and so on.
Close()
2024-11-11 19:56:01 +00:00
// QueryEvents should return a channel with the events as they're recovered from a database.
// the channel should be closed after the events are all delivered.
QueryEvents(context.Context, nostr.Filter) (chan *nostr.Event, error)
2024-11-11 19:56:01 +00:00
// DeleteEvent just deletes an event, no side-effects.
DeleteEvent(context.Context, *nostr.Event) error
2024-11-11 19:56:01 +00:00
// SaveEvent just saves an event, no side-effects.
SaveEvent(context.Context, *nostr.Event) error
2025-01-14 04:43:49 +00:00
// ReplaceEvent atomically replaces a replaceable or addressable event.
// Conceptually it is like a Query->Delete->Save, but streamlined.
ReplaceEvent(context.Context, *nostr.Event) error
2024-11-29 19:44:33 +00:00
}
type Counter interface {
CountEvents(context.Context, nostr.Filter) (int64, error)
}