https://github.com/fiatjaf/eventstore

a collection of databases specifically designed for storing nostr events
https://github.com/fiatjaf/eventstore

nostr

Last synced: 2 days ago
JSON representation

a collection of databases specifically designed for storing nostr events

• Host: GitHub
• URL: https://github.com/fiatjaf/eventstore
• Owner: fiatjaf
• License: unlicense
• Created: 2023-10-31T18:39:29.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-12-25T16:03:13.000Z (9 days ago)
• Last Synced: 2024-12-25T17:17:43.462Z (9 days ago)
• Topics: nostr
• Language: Go
• Homepage:
• Size: 465 KB
• Stars: 32
• Watchers: 4
• Forks: 18
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eventstore

A collection of reusable database connectors, wrappers and schemas that store Nostr events and expose a simple Go interface:

```go

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()

	// QueryEvents is invoked upon a client's REQ as described in NIP-01.

	// it 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)

	// DeleteEvent is used to handle deletion events, as per NIP-09.

	DeleteEvent(context.Context, *nostr.Event) error

	// SaveEvent is called once Relay.AcceptEvent reports true.

	SaveEvent(context.Context, *nostr.Event) error

}

```

[![Go Reference](https://pkg.go.dev/badge/github.com/fiatjaf/eventstore.svg)](https://pkg.go.dev/github.com/fiatjaf/eventstore) [![Run Tests](https://github.com/fiatjaf/eventstore/actions/workflows/test.yml/badge.svg)](https://github.com/fiatjaf/eventstore/actions/workflows/test.yml)

## command-line tool

There is an [`eventstore` command-line tool](cmd/eventstore) that can be used to query these databases directly.