NostrElixir

A complete Elixir wrapper for the nostr Rust library, built with Rustler for high performance.

Modular API Structure

NostrElixir is organized into logical modules for clarity and maintainability:

• NostrElixir.Keys – Key management (generation, parsing, conversions)
• NostrElixir.Nip19 – NIP-19 encoding/decoding
• NostrElixir.Event – Event creation, signing, verification, helpers
• NostrElixir.Filter – Filter creation and helpers

The root NostrElixir module provides a facade for common operations, but direct use of submodules is recommended for clarity and maintainability.

Usage Examples

Key Management

alias NostrElixir.Keys

# Generate a new keypair
keys = Keys.generate_keypair()
# %{public_key: ..., secret_key: ..., npub: ..., nsec: ...}

# Parse a secret key
parsed = Keys.parse_keypair(keys.nsec)

# Convert keys
npub = Keys.public_key_to_bech32(parsed.public_key)
nsec = Keys.secret_key_to_bech32(parsed.secret_key)

NIP-19 Encoding/Decoding

alias NostrElixir.Nip19

npub = Nip19.encode("npub", "eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619")
result = Nip19.decode_map(npub)
# %{data_type: "npub", data: ...}

Event Creation, Signing, and Verification

alias NostrElixir.{Keys, Event}

keys = Keys.generate_keypair()
event_json = Event.new(keys.public_key, "Hello, Nostr!", 1, [])
signed_event_json = Event.sign(event_json, keys.secret_key)
verified = Event.verify(signed_event_json) # true

Filter Creation and Helpers

alias NostrElixir.Filter

# Create a filter for fetching text notes (kind 1) by a user
filter_json = Filter.user_notes_filter("eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619")
filter = Jason.decode!(filter_json)
# filter["authors"] == ["..."]

# Create a filter for fetching a user's follow list (kind 3)
follow_list_filter_json = Filter.user_follow_list_filter("eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619")
follow_list_filter = Jason.decode!(follow_list_filter_json)
# follow_list_filter["kinds"] == [3]

# Hashtag search
filter_json = Filter.search_hashtag("nostr")

Backward Compatibility

The root NostrElixir module still provides delegates for the most common operations, so existing code will continue to work. However, for new code, it is recommended to use the submodules directly.

Features

• Key Management: Generate, parse, and convert keys
• NIP-19: Encode/decode bech32 addresses
• Event Management: Create, sign, verify, and serialize events
• Filter Management: Create filters for querying events
• Idiomatic, modular Elixir API
• High performance via Rust NIFs

Roadmap

• Async event signing support (if/when needed)
• Full event verification implementation (if nostr Rust API changes)
• Relay connection management
• Event subscription handling
• More convenience functions for common nostr operations

License

MIT