NostrElixir (nostr_elixir v0.3.0)

NostrElixir: Elixir wrapper for the nostr Rust library.

Modules

NostrElixir.Keys – Key management (generation, parsing, conversions)
NostrElixir.Nip19 – NIP-19 encoding/decoding
NostrElixir.Nip19.Address – NIP-19 TLV entities (naddr, nevent, nprofile)
NostrElixir.Event – Event creation, signing, verification, helpers
NostrElixir.Filter – Filter creation and helpers
NostrElixir.Nip02 – Follow lists (NIP-02)
NostrElixir.Nip04 – Encrypted DMs (NIP-04)
NostrElixir.Nip06 – HD wallet derivation (NIP-06)
NostrElixir.Nip09 – Deletion events (NIP-09)
NostrElixir.Nip10 – Threading and text notes (NIP-10)
NostrElixir.Nip17 – Private DMs (kind 4 events)
NostrElixir.Nip23 – Long-form content (NIP-23)
NostrElixir.Nip44 – Encrypted DMs v2 (NIP-44)
NostrElixir.Nip57 – Zaps (NIP-57)
NostrElixir.Nip65 – Relay list metadata (NIP-65)
NostrElixir.Mnemonic – Mnemonic generation and seed conversion

See the documentation for each module for details and examples.

Summary

Functions

create_metadata(keys, metadata)

See NostrElixir.Event.create_metadata/2.

create_text_note(keys, content)

See NostrElixir.Event.create_text_note/2.

event_from_json_nif(_)

event_new_nif(_, _, _, _)

event_sign_nif(_, _)

event_to_json_nif(_)

event_verify_nif(_)

filter_from_json_nif(_)

filter_new_nif(_)

filter_to_json_nif(_)

generate_keypair()

See NostrElixir.Keys.generate_keypair/0.

get_user_metadata(pubkey)

See NostrElixir.Filter.get_user_metadata/1.

keys_generate_nif()

keys_parse_nif(_)

keys_public_key_bech32_nif(_)

keys_public_key_nif(_)

keys_secret_key_bech32_nif(_)

keys_secret_key_hex_nif(_)

keys_secret_key_nif(_)

new_event(pubkey, content, kind, tags)

See NostrElixir.Event.new/4.

new_filter(filter_spec)

See NostrElixir.Filter.new/1.

nip02_create_contact_list_event_nif(contacts, secret_key)

nip02_extract_contacts_nif(event_json)

nip04_decrypt_nif(_, _, _)

nip04_encrypt_nif(_, _, _)

nip06_derive_key_nif(_, _)

nip06_generate_mnemonic_nif(_)

nip06_mnemonic_to_seed_nif(_, _)

nip06_validate_mnemonic_nif(_)

nip10_create_text_note_nif(keys_json, content)

nip10_create_text_note_reply_nif(keys_json, content, reply_to_json, root_json, relay_url)

nip17_decrypt_dm_nif(_, _, _)

nip17_encrypt_dm_nif(_, _, _)

nip19_decode(bech32_string)

See NostrElixir.Nip19.decode/1.

nip19_decode_address_nif(_)

nip19_decode_map(bech32_string)

See NostrElixir.Nip19.decode_map/1.

nip19_decode_nif(_)

nip19_encode(type, data)

See NostrElixir.Nip19.encode/2.

nip19_encode_naddr_nif(_, _, _, _)

nip19_encode_nevent_nif(_, _, _)

nip19_encode_nif(_, _)

nip19_encode_nprofile_nif(_, _)

nip44_decrypt_nif(_, _, _)

nip44_encrypt_nif(_, _, _)

nip57_zap_request_nif(_, _, _, _, _, _, _, _)

nip65_create_relay_list_event_nif(relays, secret_key)

nip65_extract_relay_list_nif(event_json)

parse_keypair(secret_key)

See NostrElixir.Keys.parse_keypair/1.

parse_text_tokens(text)

parser_parse_nif(_)

recent_events()

See NostrElixir.Filter.recent_events/0.

search_hashtag(hashtag)

See NostrElixir.Filter.search_hashtag/1.

sign_event(event_json, secret_key)

See NostrElixir.Event.sign/2.

user_follow_list_filter(pubkey)

See NostrElixir.Filter.user_follow_list_filter/1.

user_notes_filter(pubkey)

See NostrElixir.Filter.user_notes_filter/1.

verify_event(event_json)

See NostrElixir.Event.verify/1.

Functions

create_metadata(keys, metadata)

See NostrElixir.Event.create_metadata/2.

create_text_note(keys, content)

See NostrElixir.Event.create_text_note/2.

event_from_json_nif(_)

event_new_nif(_, _, _, _)

event_sign_nif(_, _)

event_to_json_nif(_)

event_verify_nif(_)

filter_from_json_nif(_)

filter_new_nif(_)

filter_to_json_nif(_)

generate_keypair()

See NostrElixir.Keys.generate_keypair/0.

get_user_metadata(pubkey)

See NostrElixir.Filter.get_user_metadata/1.

keys_generate_nif()

keys_parse_nif(_)

keys_public_key_bech32_nif(_)

keys_public_key_nif(_)

keys_secret_key_bech32_nif(_)

keys_secret_key_hex_nif(_)

keys_secret_key_nif(_)

new_event(pubkey, content, kind, tags)

See NostrElixir.Event.new/4.

new_filter(filter_spec)

See NostrElixir.Filter.new/1.

nip02_create_contact_list_event_nif(contacts, secret_key)

nip02_extract_contacts_nif(event_json)

nip04_decrypt_nif(_, _, _)

nip04_encrypt_nif(_, _, _)

nip06_derive_key_nif(_, _)

nip06_generate_mnemonic_nif(_)

nip06_mnemonic_to_seed_nif(_, _)

nip06_validate_mnemonic_nif(_)

nip10_create_text_note_nif(keys_json, content)

nip10_create_text_note_reply_nif(keys_json, content, reply_to_json, root_json, relay_url)

nip17_decrypt_dm_nif(_, _, _)

nip17_encrypt_dm_nif(_, _, _)

nip19_decode(bech32_string)

See NostrElixir.Nip19.decode/1.

nip19_decode_address_nif(_)

nip19_decode_map(bech32_string)

See NostrElixir.Nip19.decode_map/1.

nip19_decode_nif(_)

nip19_encode(type, data)

See NostrElixir.Nip19.encode/2.

nip19_encode_naddr_nif(_, _, _, _)

nip19_encode_nevent_nif(_, _, _)

nip19_encode_nif(_, _)

nip19_encode_nprofile_nif(_, _)

nip44_decrypt_nif(_, _, _)

nip44_encrypt_nif(_, _, _)

nip57_zap_request_nif(_, _, _, _, _, _, _, _)

nip65_create_relay_list_event_nif(relays, secret_key)

nip65_extract_relay_list_nif(event_json)

parse_keypair(secret_key)

See NostrElixir.Keys.parse_keypair/1.

parse_text_tokens(text)

parser_parse_nif(_)

recent_events()

See NostrElixir.Filter.recent_events/0.

search_hashtag(hashtag)

See NostrElixir.Filter.search_hashtag/1.

sign_event(event_json, secret_key)

See NostrElixir.Event.sign/2.

user_follow_list_filter(pubkey)

See NostrElixir.Filter.user_follow_list_filter/1.

user_notes_filter(pubkey)

See NostrElixir.Filter.user_notes_filter/1.

verify_event(event_json)

See NostrElixir.Event.verify/1.