Nostr v0.1.3

View Source Nostr.RelaySocket (Nostr v0.1.3)

Link to this section Summary

Functions

child_spec(opts)
send_event(pid, event)
start_link(list)

Creates a socket to a relay

subscribe_contacts(pid, pubkey, limit \\ 10)
subscribe_deletions(pid, pubkeys, limit \\ 10)
subscribe_encrypted_direct_messages(pid, pubkey, limit \\ 10)
subscribe_note(pid, note_id)
subscribe_notes(pid, pubkeys, limit \\ 10)
subscribe_profile(pid, pubkey)
subscribe_reactions(pid, pubkeys, limit \\ 10)
subscribe_reposts(pid, pubkeys, limit \\ 10)
subscriptions(pid)
unsubscribe(pid, subscription_id)

Revokes a subscription from a relay

Link to this section Functions

Link to this function

child_spec(opts)

View Source
Link to this function

send_event(pid, event)

View Source
Link to this function

start_link(list)

View Source 
@spec start_link(list()) :: GenServer.on_start()

Creates a socket to a relay

examples

 Examples

iex> Nostr.RelaySocket.start_link("wss://relay.nostr.pro")

Link to this function

subscribe_contacts(pid, pubkey, limit \\ 10)

View Source
Link to this function

subscribe_deletions(pid, pubkeys, limit \\ 10)

View Source 
@spec subscribe_deletions(pid(), [K256.Schnorr.verifying_key()], integer()) :: atom()
Link to this function

subscribe_encrypted_direct_messages(pid, pubkey, limit \\ 10)

View Source 
@spec subscribe_encrypted_direct_messages(
  pid(),
  K256.Schnorr.verifying_key(),
  integer()
) :: atom()
Link to this function

subscribe_note(pid, note_id)

View Source 
@spec subscribe_note(pid(), <<_::256>>) :: atom()
Link to this function

subscribe_notes(pid, pubkeys, limit \\ 10)

View Source 
@spec subscribe_notes(pid(), [K256.Schnorr.verifying_key()], integer()) :: atom()
Link to this function

subscribe_profile(pid, pubkey)

View Source
Link to this function

subscribe_reactions(pid, pubkeys, limit \\ 10)

View Source 
@spec subscribe_reactions(pid(), [K256.Schnorr.verifying_key()], integer()) :: atom()
Link to this function

subscribe_reposts(pid, pubkeys, limit \\ 10)

View Source 
@spec subscribe_reposts(pid(), [K256.Schnorr.verifying_key()], integer()) :: atom()
Link to this function

subscriptions(pid)

View Source
Link to this function

unsubscribe(pid, subscription_id)

View Source 
@spec unsubscribe(pid(), atom()) :: :ok

Revokes a subscription from a relay