relay29

package module

Go to main page

Versions in this module

v0

v0.5.0

Nov 12, 2024

Changes in this version

+ func IsInternalCall(ctx context.Context) bool

type Action

+ Name func() string

type CreateGroup

+ func (_ CreateGroup) Name() string

type DeleteEvent

+ func (_ DeleteEvent) Name() string

type DeleteGroup

+ func (_ DeleteGroup) Name() string

type EditMetadata

+ ClosedValue *bool

+ PrivateValue *bool

+ func (_ EditMetadata) Name() string

type Options

+ DefaultRoles []*nip29.Role

+ GroupCreatorDefaultRole *nip29.Role

+ type PubKeyRoles struct

+ PubKey string

+ RoleNames []string

+ type PutUser struct

+ Targets []PubKeyRoles

+ When nostr.Timestamp

+ func (_ PutUser) Name() string

+ func (a PutUser) Apply(group *nip29.Group)

type RemoveUser

+ func (_ RemoveUser) Name() string

type State

+ AllowAction func(ctx context.Context, group nip29.Group, role *nip29.Role, action Action) bool

+ func (s *State) CreateGroup(ctx context.Context, groupId string, creator string, defs EditMetadata) error

+ func (s *State) DeleteEvent(ctx context.Context, groupId string, eventId string) error

+ func (s *State) PutUser(ctx context.Context, groupId string, pubkey string, roles ...string) error

+ func (s *State) RemoveUserFromGroup(ctx context.Context, groupId string, pubkey string) error

+ func (s *State) RolesQueryHandler(ctx context.Context, filter nostr.Filter) (chan *nostr.Event, error)

v0.4.0

Sep 12, 2024

Changes in this version

+ var PTagNotValidPublicKey = fmt.Errorf("'p' tag value is not a valid public key")

+ type Action interface

+ Apply func(group *nip29.Group)

+ PermissionName func() nip29.Permission

+ func PrepareModerationAction(evt *nostr.Event) (Action, error)

+ type AddPermission struct

+ Initiator string

+ Permissions []nip29.Permission

+ Targets []string

+ When nostr.Timestamp

+ func (AddPermission) PermissionName() nip29.Permission

+ func (a AddPermission) Apply(group *nip29.Group)

+ type AddUser struct

+ Targets []string

+ When nostr.Timestamp

+ func (AddUser) PermissionName() nip29.Permission

+ func (a AddUser) Apply(group *nip29.Group)

+ type CreateGroup struct

+ Creator string

+ When nostr.Timestamp

+ func (CreateGroup) PermissionName() nip29.Permission

+ func (a CreateGroup) Apply(group *nip29.Group)

+ type DeleteEvent struct

+ Targets []string

+ func (DeleteEvent) PermissionName() nip29.Permission

+ func (a DeleteEvent) Apply(group *nip29.Group)

+ type DeleteGroup struct

+ When nostr.Timestamp

+ func (DeleteGroup) PermissionName() nip29.Permission

+ func (a DeleteGroup) Apply(group *nip29.Group)

+ type EditGroupStatus struct

+ Closed bool

+ Open bool

+ Private bool

+ Public bool

+ When nostr.Timestamp

+ func (EditGroupStatus) PermissionName() nip29.Permission

+ func (a EditGroupStatus) Apply(group *nip29.Group)

+ type EditMetadata struct

+ AboutValue string

+ NameValue string

+ PictureValue string

+ When nostr.Timestamp

+ func (EditMetadata) PermissionName() nip29.Permission

+ func (a EditMetadata) Apply(group *nip29.Group)

+ type RemovePermission struct

+ Permissions []nip29.Permission

+ Targets []string

+ When nostr.Timestamp

+ func (RemovePermission) PermissionName() nip29.Permission

+ func (a RemovePermission) Apply(group *nip29.Group)

+ type RemoveUser struct

+ Targets []string

+ When nostr.Timestamp

+ func (RemoveUser) PermissionName() nip29.Permission

+ func (a RemoveUser) Apply(group *nip29.Group)

type State

+ AllowPrivateGroups bool

+ func (s *State) ReactToLeaveRequest(ctx context.Context, event *nostr.Event)

v0.3.0

Jul 30, 2024

Changes in this version

type State

+ GetAuthed func(context.Context) string

+ func New(opts Options) *State

+ func (s *State) AdminsQueryHandler(ctx context.Context, filter nostr.Filter) (chan *nostr.Event, error)

+ func (s *State) ApplyModerationAction(ctx context.Context, event *nostr.Event)

+ func (s *State) MembersQueryHandler(ctx context.Context, filter nostr.Filter) (chan *nostr.Event, error)

+ func (s *State) MetadataQueryHandler(ctx context.Context, filter nostr.Filter) (chan *nostr.Event, error)

+ func (s *State) NormalEventQuery(ctx context.Context, filter nostr.Filter) (chan *nostr.Event, error)

+ func (s *State) PreventWritingOfEventsJustDeleted(ctx context.Context, event *nostr.Event) (reject bool, msg string)

+ func (s *State) ReactToJoinRequest(ctx context.Context, event *nostr.Event)

+ func (s *State) RequireHTagForExistingGroup(ctx context.Context, event *nostr.Event) (reject bool, msg string)

+ func (s *State) RequireKindAndSingleGroupIDOrSpecificEventReference(ctx context.Context, filter nostr.Filter) (reject bool, msg string)

+ func (s *State) RequireModerationEventsToBeRecent(ctx context.Context, event *nostr.Event) (reject bool, msg string)

+ func (s *State) RestrictInvalidModerationActions(ctx context.Context, event *nostr.Event) (reject bool, msg string)

+ func (s *State) RestrictWritesBasedOnGroupRules(ctx context.Context, event *nostr.Event) (reject bool, msg string)

v0.2.1

Jul 12, 2024

v0.2.0

Jul 10, 2024

v0.1.1

Jul 5, 2024

v0.1.0

Jul 5, 2024

Changes in this version

+ func GetGroupIDFromEvent(event *nostr.Event) string

+ type Group struct

+ type Options struct

+ DB eventstore.Store

+ Domain string

+ SecretKey string

+ type State struct

+ DB eventstore.Store

+ Domain string

+ Groups *xsync.MapOf[string, *Group]

+ Relay *khatru.Relay

+ func Init(opts Options) *State

+ func (s *State) GetGroupFromEvent(event *nostr.Event) *Group

+ func (s *State) NewGroup(id string) *Group

v0.0.2

Jul 4, 2024

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL