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 GetListeningFilters() nostr.Filters
• func Start(relay Relay)
• type Injector
• type Listener
• type Notice
• type Relay
• type Settings
• 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 GetListeningFilters

func GetListeningFilters() nostr.Filters

func Start

func Start(relay Relay)

Types

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
	SaveEvent(*nostr.Event) error
	QueryEvents(*nostr.Filter) ([]nostr.Event, error)
}

type Settings

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

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