nip29

package

v0.0.0-...-7fac766 Latest Latest Go to latest Published: May 16, 2024 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/MuseTechnology/go-nostr

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type Group
- func NewGroup(gadstr string) (Group, error)
type GroupAddress
- func ParseGroupAddress(raw string) (GroupAddress, error)
type KindRange
- func (kr KindRange) Includes(kind int) bool
type Permission
type Role

Constants ¶

View Source

const JoinRequestKind = nostr.KindSimpleGroupJoinRequest

Variables ¶

View Source

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

View Source

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

Functions ¶

This section is empty.

Types ¶

type Group ¶

type Group struct {
	Address GroupAddress

	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(gadstr string) (Group, error)

NewGroup takes a group address in the form "<id>'<relay-hostname>"

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 GroupAddress ¶

type GroupAddress struct {
	Relay string
	ID    string
}

func ParseGroupAddress ¶

func ParseGroupAddress(raw string) (GroupAddress, error)

func (GroupAddress) Equals ¶

func (gid GroupAddress) Equals(gid2 GroupAddress) bool

func (GroupAddress) IsValid ¶

func (gid GroupAddress) IsValid() bool

func (GroupAddress) String ¶

func (gid GroupAddress) String() string

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:  {},
	}
)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
relay

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