View Source NostrBasics.RelayMessage (NostrBasics v0.0.10)

A message from a relay to a client

Specifications here:

Link to this section Summary

Functions

Converts a client message in string format to the actual related Elixir structure

Link to this section Functions

@spec parse(String.t()) ::
  {:event, String.t(), NostrBasics.Event.t()}
  | {:notice, String.t()}
  | {:end_of_stored_events, String.t()}
  | {:ok, String.t(), boolean(), String.t()}
  | {:unknown, String.t()}
  | {:json_error, String.t()}

Converts a client message in string format to the actual related Elixir structure

examples

Examples

iex> ~s(["EVENT","b9dcd5af35446678eec7fa6748eb7357",{"content":"gm nostr","created_at":1675881420,"id":"c899ed67ac6c736648f1809cf17d187ba2599a7fb2ab85359e19a78cd627a6b9","kind":1,"pubkey":"5ab9f2efb1fda6bc32696f6f3fd715e156346175b93b6382099d23627693c3f2","sig":"4868c4307638289cd2c3c56aa53eb6ff89372a3ff3b8d744e347889f06bb01e78e0a9704301ea226581e08210984212e275d98fc1d7704406fc4149fb345b19d","tags":[]}])
...> |> NostrBasics.RelayMessage.parse()
{
  :event,
  "b9dcd5af35446678eec7fa6748eb7357",
  %NostrBasics.Event{
    id: "c899ed67ac6c736648f1809cf17d187ba2599a7fb2ab85359e19a78cd627a6b9",
    pubkey: <<0x5ab9f2efb1fda6bc32696f6f3fd715e156346175b93b6382099d23627693c3f2::256>>,
    created_at: ~U[2023-02-08 18:37:00Z],
    kind: 1,
    tags: [],
    content: "gm nostr",
    sig: <<0x4868c4307638289cd2c3c56aa53eb6ff89372a3ff3b8d744e347889f06bb01e78e0a9704301ea226581e08210984212e275d98fc1d7704406fc4149fb345b19d::512>>
  }
}

iex> ~s(["NOTICE","a notice from the relay"])
...> |> NostrBasics.RelayMessage.parse()
{:notice, "a notice from the relay"}

iex> ~s(["EOSE","b9dcd5af35446678eec7fa6748eb7357"])
...> |> NostrBasics.RelayMessage.parse()
{:end_of_stored_events, "b9dcd5af35446678eec7fa6748eb7357"}

iex> ~s(["OK","3dafe573cc12c0292519cf54391bcd29135c7d313729b3e3835b0c222d31748b",true,""])
...> |> NostrBasics.RelayMessage.parse()
{:ok, "3dafe573cc12c0292519cf54391bcd29135c7d313729b3e3835b0c222d31748b",true,""}

iex> ~s(["EVENT")
...> |> NostrBasics.RelayMessage.parse()
{:json_error, "error decoding JSON at position 8: "}