Nostr v0.1.3

View Source Nostr.Event.Id (Nostr v0.1.3)

Event id conversion functions

Link to this section Summary

Functions

from_bech32(bech32_event_id)

Converts a bech32 event id into its binary format

from_bech32!(bech32_id)

Converts a bech32 event id into its binary format

to_bech32(event_id, hrp)

Converts an event binary id into a bech32 format

to_hex(event_id)

Converts any type of event id into a hex format

to_hex!(bech32_id)

Converts a bech32 event id into a hex string format

Link to this section Functions

Link to this function

from_bech32(bech32_event_id)

View Source 
@spec from_bech32(binary()) :: {:ok, binary(), binary()} | {:error, atom()}

Converts a bech32 event id into its binary format

examples

 Examples 

iex> "note19e93faw4ffqepsqsrwrnstd3ee00nmzakwwuyfjm43dankgummfqms4p6q"
...> |> Nostr.Event.Id.from_bech32
{:ok, "note", <<0x2e4b14f5d54a4190c0101b87382db1ce5ef9ec5db39dc2265bac5bd9d91cded2::256>>}
Link to this function

from_bech32!(bech32_id)

View Source 
@spec from_bech32!(binary()) :: <<_::256>>

Converts a bech32 event id into its binary format

examples

 Examples 

iex> "note19e93faw4ffqepsqsrwrnstd3ee00nmzakwwuyfjm43dankgummfqms4p6q"
...> |> Nostr.Event.Id.from_bech32!
<<0x2e4b14f5d54a4190c0101b87382db1ce5ef9ec5db39dc2265bac5bd9d91cded2::256>>
Link to this function

to_bech32(event_id, hrp)

View Source 
@spec to_bech32(<<_::256>> | String.t(), String.t()) :: String.t()

Converts an event binary id into a bech32 format

examples

 Examples 

iex> <<0x2e4b14f5d54a4190c0101b87382db1ce5ef9ec5db39dc2265bac5bd9d91cded2::256>>
...> |> Nostr.Event.Id.to_bech32("note")
"note19e93faw4ffqepsqsrwrnstd3ee00nmzakwwuyfjm43dankgummfqms4p6q"

iex> "2e4b14f5d54a4190c0101b87382db1ce5ef9ec5db39dc2265bac5bd9d91cded2"
...> |> Nostr.Event.Id.to_bech32("note")
"note19e93faw4ffqepsqsrwrnstd3ee00nmzakwwuyfjm43dankgummfqms4p6q"
Link to this function

to_hex(event_id)

View Source 
@spec to_hex(<<_::256>> | binary()) :: {:ok, binary(), <<_::512>>} | {:error, atom()}

Converts any type of event id into a hex format

examples

 Examples 

iex> <<0x2e4b14f5d54a4190c0101b87382db1ce5ef9ec5db39dc2265bac5bd9d91cded2::256>>
...> |> Nostr.Event.Id.to_hex()
{:ok, nil, "2e4b14f5d54a4190c0101b87382db1ce5ef9ec5db39dc2265bac5bd9d91cded2"}

iex> "note19e93faw4ffqepsqsrwrnstd3ee00nmzakwwuyfjm43dankgummfqms4p6q"
...> |> Nostr.Event.Id.to_hex
{:ok, "note", "2e4b14f5d54a4190c0101b87382db1ce5ef9ec5db39dc2265bac5bd9d91cded2"}
Link to this function

to_hex!(bech32_id)

View Source 
@spec to_hex!(binary()) :: <<_::512>>

Converts a bech32 event id into a hex string format

examples

 Examples 

iex> "note19e93faw4ffqepsqsrwrnstd3ee00nmzakwwuyfjm43dankgummfqms4p6q"
...> |> Nostr.Event.Id.to_hex!
"2e4b14f5d54a4190c0101b87382db1ce5ef9ec5db39dc2265bac5bd9d91cded2"