nip29

Documentation

Index

• Constants
• Variables
• type Group
  • func NewGroup(id string) Group
  • func (group *Group) MergeInAdminsEvent(evt *nostr.Event) error
  • func (group *Group) MergeInMembersEvent(evt *nostr.Event) error
  • func (group *Group) MergeInMetadataEvent(evt *nostr.Event) error
  • func (group Group) ToAdminsEvent() *nostr.Event
  • func (group Group) ToMembersEvent() *nostr.Event
  • func (group Group) ToMetadataEvent() *nostr.Event
• type KindRange
  • func (kr KindRange) Includes(kind int) bool
• type Permission
• type Role

Constants

const JoinRequestKind = nostr.KindSimpleGroupJoinRequest

Variables

var MetadataEventKinds = KindRange{
	nostr.KindSimpleGroupMetadata,
	nostr.KindSimpleGroupAdmins,
	nostr.KindSimpleGroupMembers,
}

var ModerationEventKinds = KindRange{
	nostr.KindSimpleGroupAddUser,
	nostr.KindSimpleGroupRemoveUser,
	nostr.KindSimpleGroupEditMetadata,
	nostr.KindSimpleGroupAddPermission,
	nostr.KindSimpleGroupRemovePermission,
	nostr.KindSimpleGroupDeleteEvent,
	nostr.KindSimpleGroupEditGroupStatus,
}

Types

type Group

type Group struct {
	ID      string
	Name    string
	Picture string
	About   string
	Members map[string]*Role
	Private bool
	Closed  bool

	LastMetadataUpdate nostr.Timestamp
	LastAdminsUpdate   nostr.Timestamp
	LastMembersUpdate  nostr.Timestamp
}

func NewGroup

func NewGroup(id string) Group

func (*Group) MergeInAdminsEvent

func (group *Group) MergeInAdminsEvent(evt *nostr.Event) error

func (*Group) MergeInMembersEvent

func (group *Group) MergeInMembersEvent(evt *nostr.Event) error

func (*Group) MergeInMetadataEvent

func (group *Group) MergeInMetadataEvent(evt *nostr.Event) error

func (Group) ToAdminsEvent

func (group Group) ToAdminsEvent() *nostr.Event

func (Group) ToMembersEvent

func (group Group) ToMembersEvent() *nostr.Event

func (Group) ToMetadataEvent

func (group Group) ToMetadataEvent() *nostr.Event

type KindRange

type KindRange []int

func (KindRange) Includes

func (kr KindRange) Includes(kind int) bool

type Permission

type Permission string

const (
	PermAddUser          Permission = "add-user"
	PermEditMetadata     Permission = "edit-metadata"
	PermDeleteEvent      Permission = "delete-event"
	PermRemoveUser       Permission = "remove-user"
	PermAddPermission    Permission = "add-permission"
	PermRemovePermission Permission = "remove-permission"
	PermEditGroupStatus  Permission = "edit-group-status"
)

type Role

type Role struct {
	Name        string
	Permissions map[Permission]struct{}
}

var (
	// used for normal members without admin powers
	EmptyRole *Role = nil

	PermissionsMap = map[Permission]struct{}{
		PermAddUser:          {},
		PermEditMetadata:     {},
		PermDeleteEvent:      {},
		PermRemoveUser:       {},
		PermAddPermission:    {},
		PermRemovePermission: {},
		PermEditGroupStatus:  {},
	}
)