Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/roosoft/nostr
Connect to the nostr network with Elixir
https://github.com/roosoft/nostr
nostr social-network
Last synced: about 2 months ago
JSON representation
Connect to the nostr network with Elixir
- Host: GitHub
- URL: https://github.com/roosoft/nostr
- Owner: RooSoft
- License: unlicense
- Created: 2022-12-21T18:56:37.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-24T12:23:02.000Z (about 1 year ago)
- Last Synced: 2024-04-25T02:25:20.700Z (9 months ago)
- Topics: nostr, social-network
- Language: Elixir
- Homepage:
- Size: 413 KB
- Stars: 32
- Watchers: 3
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# nostr
Communicate with any participant, be it relays or clients, with elixir
## DISCLAMER
This library is in the process of being built in the wild. It should at the moment be considered
alpha quality. Function names and what they return will most probably be improved in the near future, so
don't expect to write production code on top of it just yet. This is for education purposes only.
The current goal is to get feature complete with the most common NIPs, and will then be refined so it's
as easy to use as can be.
## Installation
```elixir
def deps do
[
{:nostr, "~> 0.2.0"}
]
end
```
## Create a private key
```bash
iex -S mix
```
```elixir
NostrBasics.Keys.PrivateKey.create()
```
## Use the example app
In the lib/examples, there is a NostrApp ready to be used. It connects to a relay and
retrieves your own notes and stuff. The easiest way to use it is to create a `.iex.local.exs`
file and paste that in
```elixir
relays = [
"wss://relay.nostr.bg",
"wss://relay.nostr.pro"
]
private_key = NostrBasics.Keys.PrivateKey.create
NostrApp.start_link(relays, private_key)
```
and start iex
```bash
iex -S mix
```
## Now what?
### Edit your profile
```elixir
%NostrBasics.Models.Profile{
about: "Instance of https://github.com/RooSoft/nostr being tested in the wild",
name: "roosoft_test_bot",
picture: "https://nostr.build/i/p/5158p.jpg"
}
|> NostrApp.update_profile()
```
### Subscribe to your profile... will send the current version and any subsequent changes
```elixir
NostrApp.profile
```
### Subscribe to a timeline
```elixir
NostrBasics.Keys.PublicKey.from_private_key(private_key)
|> NostrApp.timeline()
```
You'll receive past and live events from all your followed contacts into the console,
and are now able to send messages with that identity.
### Send a message
```elixir
NostrApp.send_note("aren't you entertained?")
```
### Repost a message
```elixir
NostrApp.repost("note14n5txr742qzq4awx0mmd2x36tul9lrlrgfjvjpr6ev8h82z6yzqs5msdq7")
```
### Delete a message
```elixir
NostrApp.delete("note14n5txr742qzq4awx0mmd2x36tul9lrlrgfjvjpr6ev8h82z6yzqs5msdq7")
```
### Follow someone
This is a bit rough around the edges still, but will be simplified soon
```elixir
NostrApp.follow("npub1s5yq6wadwrxde4lhfs56gn64hwzuhnfa6r9mj476r5s4hkunzgzqrs6q7z")
```
### Unfollow someone
```elixir
NostrApp.unfollow("npub1s5yq6wadwrxde4lhfs56gn64hwzuhnfa6r9mj476r5s4hkunzgzqrs6q7z")
```
### See who someone is currently following
Could be yourself or anybody...
```elixir
NostrApp.contacts("npub1s5yq6wadwrxde4lhfs56gn64hwzuhnfa6r9mj476r5s4hkunzgzqrs6q7z")
```
### Subscribe to incoming encrypted direct messages
```elixir
NostrApp.encrypted_direct_messages
```
### Send an encrypted direct message to someone
```elixir
NostrApp.send_encrypted_direct_messages("npub1s5yq6wadwrxde4lhfs56gn64hwzuhnfa6r9mj476r5s4hkunzgzqrs6q7z", "Howdy?")
```