Nostr.Event.Deletion (Nostr Lib v0.2.1) (event) (nip09)

View Source

Event deletion request

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

Summary

Types

t()

Functions

create(events, opts \\ [])

Create a new deletion request (kind 5) event.

parse(event)

Parses a kind 5 event into a Deletion struct.

Types

t()

@type t() :: %Nostr.Event.Deletion{
  event: Nostr.Event.t(),
  kinds: [non_neg_integer()],
  reason: String.t() | nil,
  to_delete: [binary()],
  to_delete_naddr: [binary()],
  user: <<_::32, _::_*8>>
}

Functions

create(events, opts \\ [])

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

Create a new deletion request (kind 5) event.

Arguments:

  • events - list of event IDs to delete
  • opts - optional arguments:
    • :reason - text describing why events are being deleted
    • :naddrs - list of replaceable event addresses ("kind:pubkey:d-identifier")
    • :kinds - list of event kinds being deleted (SHOULD be included per NIP-09)
    • plus standard event opts (pubkey, created_at)

Examples

# Delete specific events
Nostr.Event.Deletion.create(["event_id_1", "event_id_2"], reason: "posted by mistake")

# Delete replaceable events
Nostr.Event.Deletion.create([], naddrs: ["30023:pubkey:article-1"], kinds: [30023])

parse(event)

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

Parses a kind 5 event into a Deletion struct.