help

Documentation

Index

• func CloseSubscription(ctx context.Context, t *testing.T, subID messages.SubscriptionID, ...)
• func Event(t require.TestingT, opts ...EventOptions) event.Event
• func EventWithContent(t require.TestingT, content string) event.Event
• func EventWithCreatedAt(t require.TestingT, createdAt time.Time) event.Event
• func EventWithKind(t require.TestingT, kind int) event.Event
• func EventWithPTagReferenceTo(t require.TestingT, pubKey event.PubKey) event.Event
• func EventWithPrivKey(t require.TestingT, pk PrivKey) event.Event
• func EventWithTags(t require.TestingT, tags nostr.Tags) event.Event
• func GetEvent(ctx context.Context, t *testing.T, id event.ID) (event.Event, bool)
• func ListenForEventsOnSub(ctx context.Context, t *testing.T, read <-chan MsgRead, ...) chan event.Event
• func NewConnection(t *testing.T) *nostr.Relay
• func NewSocket(ctx context.Context, t require.TestingT, opts ...SocketOpts) (MsgWriter, <-chan MsgRead, Closer)
• func Publish(ctx context.Context, t require.TestingT, e event.Event, conn MsgWriter)
• func ReadEvent(ctx context.Context, t *testing.T, read <-chan MsgRead, ...) (event.Event, bool)
• func SetDefaultURI(uri string)
• func StoredEvents(t *testing.T, read <-chan MsgRead, sub messages.SubscriptionID, ...) ([]event.Event, error)
• type Closer
  • func RequestSub(ctx context.Context, t *testing.T, conn MsgWriter, filters ...messages.Filter) (messages.SubscriptionID, Closer)
• type EventOptions
  • func WithContent(content string) EventOptions
  • func WithCreatedAt(createdAt time.Time) EventOptions
  • func WithKind(kind int) EventOptions
  • func WithPrivKey(pk PrivKey) EventOptions
  • func WithTags(tags nostr.Tags) EventOptions
• type MsgRead
• type MsgWriter
  • func (w *MsgWriter) Write(ctx context.Context, typ websocket.MessageType, p []byte) error
• type PrivKey
  • func NewKeyPair(t *testing.T) (PrivKey, event.PubKey)
  • func (priv PrivKey) String() string
• type PubKey
  • func (priv PubKey) String() string
• type SocketOpts
  • func WithURI(uri string) SocketOpts

Functions

func CloseSubscription

func CloseSubscription(ctx context.Context, t *testing.T, subID messages.SubscriptionID, conn MsgWriter)

func Event

func Event(t require.TestingT, opts ...EventOptions) event.Event

func EventWithContent

func EventWithContent(t require.TestingT, content string) event.Event

func EventWithCreatedAt

func EventWithCreatedAt(t require.TestingT, createdAt time.Time) event.Event

func EventWithKind

func EventWithKind(t require.TestingT, kind int) event.Event

func EventWithPTagReferenceTo

func EventWithPTagReferenceTo(t require.TestingT, pubKey event.PubKey) event.Event

func EventWithPrivKey

func EventWithPrivKey(t require.TestingT, pk PrivKey) event.Event

func EventWithTags

func EventWithTags(t require.TestingT, tags nostr.Tags) event.Event

func GetEvent

func GetEvent(ctx context.Context, t *testing.T, id event.ID) (event.Event, bool)

func ListenForEventsOnSub

func ListenForEventsOnSub(
	ctx context.Context,
	t *testing.T,
	read <-chan MsgRead,
	sub messages.SubscriptionID) chan event.Event

func NewConnection

func NewConnection(t *testing.T) *nostr.Relay

func NewSocket

func NewSocket(ctx context.Context, t require.TestingT, opts ...SocketOpts) (MsgWriter, <-chan MsgRead, Closer)

func Publish

func Publish(ctx context.Context, t require.TestingT, e event.Event, conn MsgWriter)

func ReadEvent

func ReadEvent(ctx context.Context, t *testing.T, read <-chan MsgRead, sub messages.SubscriptionID) (event.Event, bool)

func SetDefaultURI

func SetDefaultURI(uri string)

func StoredEvents

func StoredEvents(
	t *testing.T,
	read <-chan MsgRead,
	sub messages.SubscriptionID,
	timeout time.Duration) ([]event.Event, error)

Types

type Closer

type Closer func()

func RequestSub

func RequestSub(ctx context.Context, t *testing.T, conn MsgWriter, filters ...messages.Filter) (messages.SubscriptionID, Closer)

type EventOptions

type EventOptions struct {
	PrivKey   PrivKey
	CreatedAt time.Time
	Kind      int
	Tags      nostr.Tags
	Content   string
}

func WithContent

func WithContent(content string) EventOptions

func WithCreatedAt

func WithCreatedAt(createdAt time.Time) EventOptions

func WithKind

func WithKind(kind int) EventOptions

func WithPrivKey

func WithPrivKey(pk PrivKey) EventOptions

func WithTags

func WithTags(tags nostr.Tags) EventOptions

type MsgRead

type MsgRead []byte

type MsgWriter

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

func (*MsgWriter) Write

func (w *MsgWriter) Write(ctx context.Context, typ websocket.MessageType, p []byte) error

type PrivKey

type PrivKey string

func NewKeyPair

func NewKeyPair(t *testing.T) (PrivKey, event.PubKey)

func (PrivKey) String

func (priv PrivKey) String() string

type PubKey

type PubKey string

func (PubKey) String

func (priv PubKey) String() string

type SocketOpts

type SocketOpts struct {
	URI string
}

func WithURI

func WithURI(uri string) SocketOpts