relay

Documentation

Index

• type AdvancedDeleter
• type AdvancedSaver
• type Authenticator
• type B
• type Ctx
• type E
• type EventCounter
• type I
• type Informationer
• type Injector
• type Logger
• type N
• type ReqAcceptor
• type S
• type ShutdownAware
• type WebSocketHandler

Types

type AdvancedDeleter

type AdvancedDeleter interface {
	BeforeDelete(ctx Ctx, id, pubkey B)
	AfterDelete(id, pubkey B)
}

AdvancedDeleter methods are called before and after [Storage.DeleteEvent].

type AdvancedSaver

type AdvancedSaver interface {
	BeforeSave(Ctx, *event.T)
	AfterSave(*event.T)
}

AdvancedSaver methods are called before and after [Storage.SaveEvent].

type Authenticator

type Authenticator interface {
	AuthEnabled() bool
	ServiceUrl(r *http.Request) S
}

Authenticator is the interface for implementing NIP-42. ServiceURL() returns the URL used to verify the "AUTH" event from clients.

type B

type B = []byte

type Ctx

type Ctx = context.T

type E

type E = error

type EventCounter

type EventCounter interface {
	CountEvents(c Ctx, f *filter.T) (count N, approx bool, err E)
}

type I

type I interface {
	// Name is used as the "name" field in NIP-11 and as a prefix in default Server logging.
	// For other NIP-11 fields, see [Informationer].
	Name() S
	// Init is called at the very beginning by [Server.Start], allowing a realy
	// to initialize its internal resources.
	// Also see [eventstore.I.Init].
	Init() E
	// AcceptEvent is called for every nostr event received by the server.
	//
	// If the returned value is true, the event is passed on to [Storage.SaveEvent].
	// Otherwise, the server responds with a negative and "blocked" message as described
	// in NIP-20.
	//
	// Moderation via follow/mute lists of moderator npubs should deny events from
	// npubs listed in moderator mute lists. Events submitted by users not on the
	// moderator follow lists but submitting events containing p tags for direct
	// messages, that are not on the mute list, that do not yet have a reply, should accept
	// direct and group message events until there is three and thereafter will be restricted
	// until the user adds them to their follow list.
	AcceptEvent(c Ctx, ev *event.T, hr *http.Request, origin S, authedPubkey B) bool
	// Storage returns the realy storage implementation.
	Storage(Ctx) store.I
}

I is the main interface for implementing a nostr

type Informationer

type Informationer interface {
	GetNIP11InformationDocument() *relayinfo.T
}

Informationer is called to compose NIP-11 response to an HTTP request with application/nostr+json mime type. See also [I.Name].

type Injector

type Injector interface {
	InjectEvents() event.C
}

type Logger

type Logger interface {
	Infof(format S, v ...any)
	Warningf(format S, v ...any)
	Errorf(format S, v ...any)
}

Logger is what [Server] uses to log messages.

type N

type N = int

type ReqAcceptor

type ReqAcceptor interface {
	// AcceptReq is called for every nostr request filters received by the
	// server. If the returned value is true, the filters is passed on to
	// [Storage.QueryEvent].
	//
	// If moderation of access by follow/mute list of moderator npubs is enabled,
	// only users in the follow lists of mods are allowed read access (accepting
	// requests), all others should receive an OK,false,restricted response if
	// authed and if not authed CLOSED,restricted.
	//
	// If a user is not whitelisted by follow and not blacklisted by mute and the
	// request is for a message that contains their npub in a `p` tag that are
	// direct or group chat messages they also can be accepted, enabling full
	// support for in/outbox access.
	AcceptReq(ctx Ctx, hr *http.Request, id B, ff *filters.T, authedPubkey B) bool
}

ReqAcceptor is the main interface for implementing a nostr

type S

type S = string

type ShutdownAware

type ShutdownAware interface {
	OnShutdown(Ctx)
}

ShutdownAware is called during the server shutdown. See [Server.Shutdown] for details.

type WebSocketHandler

type WebSocketHandler interface {
	HandleUnknownType(ws *web.Socket, t S, request B)
}

WebSocketHandler is passed nostr message types unrecognized by the server. The server handles "EVENT", "REQ" and "CLOSE" messages, as described in NIP-01.