relayer

README

Nostr Relay Framework -- use it to implement your own custom relay.

There is an example/reference implementation at basic. Binaries for that are also available under Releases.

Documentation

Index

• Variables
• func AddEvent(relay Relay, evt nostr.Event) (accepted bool, message string)
• func GetListeningFilters() nostr.Filters
• func Start(relay Relay)
• type AdvancedDeleter
• type AdvancedQuerier
• type AdvancedSaver
• type CustomWebSocketHandler
• type Informationer
• type Injector
• type Listener
• type Notice
• type Relay
• type Settings
• type Storage
• type WebSocket
  • func (ws *WebSocket) WriteJSON(any interface{}) error
  • func (ws *WebSocket) WriteMessage(t int, b []byte) error

Variables

var Log = log

var Router = mux.NewRouter()

Functions

func AddEvent

func AddEvent(relay Relay, evt nostr.Event) (accepted bool, message string)

func GetListeningFilters

func GetListeningFilters() nostr.Filters

func Start

func Start(relay Relay)

Types

type AdvancedDeleter

type AdvancedDeleter interface {
	BeforeDelete(id string, pubkey string)
	AfterDelete(id string, pubkey string)
}

type AdvancedQuerier

type AdvancedQuerier interface {
	BeforeQuery(*nostr.Filter)
	AfterQuery([]nostr.Event, *nostr.Filter)
}

type AdvancedSaver

type AdvancedSaver interface {
	BeforeSave(*nostr.Event)
	AfterSave(*nostr.Event)
}

type CustomWebSocketHandler

type CustomWebSocketHandler interface {
	HandleUnknownType(ws *WebSocket, typ string, request []json.RawMessage)
}

type Informationer

type Informationer interface {
	GetNIP11InformationDocument() nip11.RelayInformationDocument
}

type Injector

type Injector interface {
	InjectEvents() chan nostr.Event
}

type Listener

type Listener struct {
	// contains filtered or unexported fields
}

type Notice

type Notice struct {
	Kind    string `json:"kind"`
	Message string `json:"message"`
}

type Relay

type Relay interface {
	Name() string
	Init() error
	OnInitialized()
	AcceptEvent(*nostr.Event) bool
	Storage() Storage
}

relay

type Settings

type Settings struct {
	Host string `envconfig:"HOST" default:"0.0.0.0"`
	Port string `envconfig:"PORT" default:"7447"`
}

type Storage

type Storage interface {
	Init() error

	QueryEvents(filter *nostr.Filter) (events []nostr.Event, err error)
	DeleteEvent(id string, pubkey string) error
	SaveEvent(event *nostr.Event) error
}

storage

type WebSocket

type WebSocket struct {
	// contains filtered or unexported fields
}

func (*WebSocket) WriteJSON

func (ws *WebSocket) WriteJSON(any interface{}) error

func (*WebSocket) WriteMessage

func (ws *WebSocket) WriteMessage(t int, b []byte) error