relayer

package module

v1.2.3 Latest Latest Go to latest Published: Feb 17, 2022 License: Unlicense Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

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.

This section is empty.

View Source

var Log = log

View Source

var Router = mux.NewRouter()

func GetListeningFilters() nostr.EventFilters

func Start(relay Relay)

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

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

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

type Relay interface {
	Name() string
	Init() error
	SaveEvent(*nostr.Event) error
	QueryEvents(*nostr.EventFilter) ([]nostr.Event, error)
}

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

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

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

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

Path	Synopsis
basic