realy

README

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

There is an example/reference implementation at basic.

Documentation

Index

• Constants
• type Listener
• type Server
  • func NewServer(sp ServerParams, opts ...options.O) (*Server, er)
  • func (s *Server) AuthFail(w http.ResponseWriter)
  • func (s *Server) HTTPAuth(r *http.Request) (authed bo)
  • func (s *Server) HandleAdmin(w http.ResponseWriter, r *http.Request)
  • func (s *Server) HandleNIP11(w http.ResponseWriter, r *http.Request)
  • func (s *Server) HandleWebsocket(w http.ResponseWriter, r *http.Request)
  • func (s *Server) Router() *http.ServeMux
  • func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (s *Server) Shutdown()
  • func (s *Server) Start(host st, port int, started ...chan bo) er
• type ServerParams

Constants

const (
	ChallengeHRP = "nchal"

	ChallengeLength = 16
)

Types

type Listener

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

type Server

type Server struct {
	Ctx    cx
	Cancel context.F

	Addr st
	// contains filtered or unexported fields
}

func NewServer

func NewServer(sp ServerParams, opts ...options.O) (*Server, er)

func (*Server) AuthFail

func (s *Server) AuthFail(w http.ResponseWriter)

func (*Server) HTTPAuth

func (s *Server) HTTPAuth(r *http.Request) (authed bo)

func (*Server) HandleAdmin

func (s *Server) HandleAdmin(w http.ResponseWriter, r *http.Request)

func (*Server) HandleNIP11

func (s *Server) HandleNIP11(w http.ResponseWriter, r *http.Request)

func (*Server) HandleWebsocket

func (s *Server) HandleWebsocket(w http.ResponseWriter, r *http.Request)

func (*Server) Router

func (s *Server) Router() *http.ServeMux

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*Server) Shutdown

func (s *Server) Shutdown()

func (*Server) Start

func (s *Server) Start(host st, port int, started ...chan bo) er

type ServerParams

type ServerParams struct {
	Ctx                  cx
	Cancel               context.F
	Rl                   relay.I
	DbPath               st
	MaxLimit             no
	AdminUser, AdminPass st
}