Nostr.Event.StarterPacks (Nostr Lib v0.2.1) (event) (nip51)

Starter Packs (Kind 39089)

A named set of profiles to be shared around with the goal of being followed together. This is an addressable event with a d tag identifier.

Starter packs help new users discover interesting accounts to follow as a group.

Sets can have optional metadata: title, image, and description.

Defined in NIP 51 https://github.com/nostr-protocol/nips/blob/master/51.md

Summary

Types

t()

Functions

create(identifier, pubkeys, opts \\ [])

Creates a new starter pack (kind 39089).

parse(event)

Parses a kind 39089 event into a StarterPacks struct.

Types

t()

@type t() :: %Nostr.Event.StarterPacks{
  description: binary() | nil,
  event: Nostr.Event.t(),
  identifier: binary(),
  image: binary() | nil,
  pubkeys: [binary()],
  title: binary() | nil
}

Functions

create(identifier, pubkeys, opts \\ [])

@spec create(binary(), [binary()], Keyword.t()) :: t()

Creates a new starter pack (kind 39089).

Arguments

identifier - Unique identifier for this starter pack
pubkeys - List of pubkeys to include in the pack
opts - Optional event arguments and set metadata

Options

:title - Starter pack title for display
:image - Starter pack image URL
:description - Starter pack description
:pubkey - Event author pubkey
:created_at - Event timestamp

Example

StarterPacks.create("nostr-devs", [
  "pubkey1",
  "pubkey2",
  "pubkey3"
],
  title: "Nostr Developers",
  description: "Follow all the top Nostr protocol developers"
)

parse(event)

@spec parse(Nostr.Event.t()) :: t()

Parses a kind 39089 event into a StarterPacks struct.