Nostr.Event.DraftWrap (Nostr Lib v0.2.1) (event) (nip37)

View Source

Draft Wraps (Kind 31234)

Encrypted storage for unsigned draft events. The draft is JSON-stringified, NIP-44 encrypted to the signer's own public key, and stored in content.

Examples

# Create a draft wrap for a note
draft = %{kind: 1, content: "My draft note", tags: []}
{:ok, wrap} = DraftWrap.create(draft, seckey, identifier: "my-draft")

# Decrypt a draft wrap
{:ok, decrypted} = DraftWrap.decrypt(wrap, seckey)
decrypted.draft  # => %{kind: 1, content: "My draft note", tags: []}

# Create a deletion (blanked content)
{:ok, deletion} = DraftWrap.delete("my-draft", pubkey: pubkey)

See: https://github.com/nostr-protocol/nips/blob/master/37.md

Summary

Types

t()

Functions

create(draft, seckey, opts \\ [])

Creates a draft wrap event.

decrypt(wrap, seckey)

Decrypts a draft wrap and returns it with the draft field populated.

delete(identifier, opts)

Creates a draft deletion event (blanked content).

deleted?(arg1)

Checks if this draft wrap represents a deletion (blanked content).

parse(event)

Parses a kind 31234 event into a DraftWrap struct.

Types

t()

@type t() :: %Nostr.Event.DraftWrap{
  draft: map() | nil,
  draft_kind: non_neg_integer() | nil,
  event: Nostr.Event.t(),
  expiration: non_neg_integer() | nil,
  identifier: binary()
}

Functions

create(draft, seckey, opts \\ [])

@spec create(
  draft :: map() | Nostr.Event.t(),
  seckey :: binary(),
  opts :: Keyword.t()
) :: {:ok, t()}

Creates a draft wrap event.

The draft is JSON-stringified and NIP-44 encrypted to the signer's public key.

Arguments

  • draft - Map or Event struct representing the unsigned draft event
  • seckey - Hex-encoded secret key for signing and encryption
  • opts - Options

Options

  • :identifier - The d tag identifier (default: random UUID)
  • :expiration - Unix timestamp when the draft expires
  • :pubkey - Override pubkey (derived from seckey if not provided)
  • :created_at - Override created_at timestamp

Returns

  • {:ok, draft_wrap} - The created draft wrap (with draft field populated)

decrypt(wrap, seckey)

@spec decrypt(t(), binary()) :: {:ok, t()} | {:error, atom()}

Decrypts a draft wrap and returns it with the draft field populated.

Arguments

  • wrap - The DraftWrap struct to decrypt
  • seckey - Hex-encoded secret key for decryption

Returns

  • {:ok, draft_wrap} - The wrap with draft field populated
  • {:error, reason} - On decryption failure

delete(identifier, opts)

@spec delete(binary(), Keyword.t()) :: {:ok, t()}

Creates a draft deletion event (blanked content).

A blanked content field signals that the draft has been deleted.

Arguments

  • identifier - The d tag identifier of the draft to delete
  • opts - Options (requires :pubkey or :seckey)

Options

  • :pubkey - Author's public key (required if seckey not provided)
  • :seckey - Secret key to derive pubkey and sign
  • :draft_kind - Optional kind of the original draft
  • :created_at - Override created_at timestamp

Returns

  • {:ok, draft_wrap} - The deletion wrap (unsigned unless seckey provided)

deleted?(arg1)

@spec deleted?(t()) :: boolean()

Checks if this draft wrap represents a deletion (blanked content).

parse(event)

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

Parses a kind 31234 event into a DraftWrap struct.

The draft field will be nil until decrypt/2 is called.