nostr_ruby 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19e9c9f2d37d02877b0f4cdc83faeb46d09d707ee7b54d4ec938ee448fefc5bb
-  data.tar.gz: c01abc356c5bab165b6534eef10163c40be8c73632c2ce8b657c3ceb3e0cd1c3
+  metadata.gz: 9d7328ea01464a11df3e360e02656d1cc2d94fbeb4b3e08bac3890f9f30d07d9
+  data.tar.gz: 024f4c4db11d3b11235578e26248847b04995233d6c1547e999dffd36625e850
 SHA512:
-  metadata.gz: 2021a0b34822aeb9eaa071fa96a6c48b8c3eb982eabbb2646daae076ddfc39957383dad49ecbde208e129d81af7a0489031afdd91ddfb8a69a011bba88178baa
-  data.tar.gz: 1959f99e9d18ca5fbe7fb0f5c41943f1981a980716c4871d94d9e23eb7d5c1e39cd0d0665f1bf51d2e21bd9f7b41c7630f7b15fcab583fa336cb4d0ab7d54adc
+  metadata.gz: 4f00bbfb3a37da161802217ecd3706ad10f800e39368601a40ce594efcca83357f798a8162c94c169947fe38fe5c31f68344f248b23c201b7d305dd5086628d4
+  data.tar.gz: af802073aa09d07f26df6bb0a3ff028f80a02d844a16072acc5f59c7f96360361a77104e3a1cdd06f2d65f85efe35ee28743d56ec6f306482ac2fdc2f97fece8

data/Gemfile.lock

@@ -3,31 +3,33 @@ PATH
   specs:
     nostr_ruby (0.2.0)
       base64 (~> 0.1.1)
-      bech32 (~> 1.3.0)
+      bech32 (~> 1.4.0)
       bip-schnorr (~> 0.4.0)
+      faye-websocket (~> 0.11)
       json (~> 2.6.2)
       unicode-emoji (~> 3.3.1)
-      websocket-client-simple (~> 0.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     base64 (0.1.1)
-    bech32 (1.3.0)
+    bech32 (1.4.2)
       thor (>= 1.1.0)
     bip-schnorr (0.4.0)
       ecdsa (~> 1.2.0)
     ecdsa (1.2.0)
-    event_emitter (0.2.6)
+    eventmachine (1.2.7)
+    faye-websocket (0.11.3)
+      eventmachine (>= 0.12.0)
+      websocket-driver (>= 0.5.1)
     json (2.6.3)
     thor (1.2.1)
     unicode-emoji (3.3.1)
       unicode-version (~> 1.0)
     unicode-version (1.3.0)
-    websocket (1.2.9)
-    websocket-client-simple (0.6.0)
-      event_emitter
-      websocket
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
 
 PLATFORMS
   arm64-darwin-21

data/README.md

@@ -2,212 +2,337 @@
 
 A ruby library to interact with the [Nostr Protocol](https://github.com/nostr-protocol/nostr).
 
----
+> [!Warning]
+> This version in work in progress and breaks the v0.2.0 API
 
-**Note**: this is a first proof of concept version, the API will probably change in the near future.
 
----
+## Installation
 
-## Installation 
+Add this line to your application's Gemfile:
 
+```ruby
+# Gemfile
+gem 'nostr_ruby'
+```
+
+And then execute:
+
+```shell
+$ bundle
 ```
-gem install nostr_ruby
+
+Or install it yourself as:
+```shell
+$ gem install nostr_ruby
 ```
+
 ## Usage
-### Manage the keys
+
+### Manage keys
+
 ```ruby
 require "nostr_ruby"
 
-n = Nostr.new({private_key: "964b29795d621cdacf05fd94fb23206c88742db1fa50b34d7545f3a2221d8124"})
-# <Nostr:0x00000001063ffa28 @private_key="964b29795d621cdacf05fd94fb23206c88742db1fa50b34d7545f3a2221d8124" @public_key="da15317263858ad496a21c79c6dc5f5cf9af880adf3a6794dbbf2883186c9d81">
+sk = Nostr::Key.generate_private_key
+# => "8090fb3fe26e27d539ee349d70890d338c5e2e8b459e04c8e97658f03d2f9f33"
+
+pk = Nostr::Key.get_public_key(sk)
+# => "e7ded9bd42e7c74fcc6465962b919b7efcd5774ac6bea2ae6b81b2caa9d4d2e6"
+```
+
+### Decode entities
 
-n.bech32_keys
-# => {:public_key=>"npub1mg2nzunrsk9df94zr3uudhzltnu6lzq2muax09xmhu5gxxrvnkqsvpjg3p", :private_key=>"nsec1je9jj72avgwd4nc9lk20kgeqdjy8gtd3lfgtxnt4ghe6ygsasyjq7kh6c4"}
+```ruby
+
+puplic_key = Nostr::Bech32.decode(npub)
+# => {:hrp=>"npub", :data=>"e7ded9bd42e7c74fcc6465962b919b7efcd5774ac6bea2ae6b81b2caa9d4d2e6"}
+
+nprofile_data = Nostr::Bech32.decode("nprofile1qqs8hhhhhc3dmrje73squpz255ape7t448w86f7ltqemca7m0p99spgprpmhxue69uhkgar0dehkutnwdaehgu339e3k7mf06ras84")
+# => {:hrp=>"nprofile", :data=>{:pubkey=>["7bdef7be22dd8e59f4600e044aa53a1cf975a9dc7d27df5833bc77db784a5805"], :relay=>["wss://dtonon.nostr1.com/"]}}
 
-n = Nostr.new({private_key: "nsec1je9jj72avgwd4nc9lk20kgeqdjy8gtd3lfgtxnt4ghe6ygsasyjq7kh6c4"})
-# => #<Nostr:0x00000001060952c0 @private_key="964b29795d621cdacf05fd94fb23206c88742db1fa50b34d7545f3a2221d8124", @public_key="da15317263858ad496a21c79c6dc5f5cf9af880adf3a6794dbbf2883186c9d81">
+note_data = Nostr::Bech32.decode("note1xzce08egncw3mcm8l8edas6rrhgfj9l5uwwv2hz03zym0m9eg5hsxuyajp")
+# => {:hrp=>"note", :data=>"30b1979f289e1d1de367f9f2dec3431dd09917f4e39cc55c4f8889b7ecb9452f"}
 
-n.keys
-# => {:public_key=>"da15317263858ad496a21c79c6dc5f5cf9af880adf3a6794dbbf2883186c9d81", :private_key=>"964b29795d621cdacf05fd94fb23206c88742db1fa50b34d7545f3a2221d8124"}
+nevent_data = Nostr::Bech32.decode("nevent1qqsrpvvhnu5fu8gaudnlnuk7cdp3m5yezl6w88x9t38c3zdhaju52tcpzpmhxue69uhkztnwdaejumr0dshsz9nhwden5te0vfjhvmewdehhxarjxyhxxmmd9uq3wamnwvaz7tmzd96xxmmfdejhytnnda3kjctv9ulrdeva")
+# => {:hrp=>"nevent", :data=> {:id=>["30b1979f289e1d1de367f9f2dec3431dd09917f4e39cc55c4f8889b7ecb9452f"], :relay=>["wss://a.nos.lol/", "wss://bevo.nostr1.com/", "wss://bitcoiner.social/"]}}
+
+naddr_data = Nostr::Bech32.decode("naddr1qvzqqqr4gupzq77777lz9hvwt86xqrsyf2jn588ewk5aclf8mavr80rhmduy5kq9qqdkc6t5w3kx2ttvdamx2ttxdaez6mr0denj6en0wfkkzaqxq5r99")
+# => => {:hrp=>"naddr", :data=>{:kind=>[30023], :author=>["7bdef7be22dd8e59f4600e044aa53a1cf975a9dc7d27df5833bc77db784a5805"], :identifier=>["little-love-for-long-format"]}}
 ```
 
-### Set the user metadata
+### Encode entities
+
 ```ruby
-metadata = n.build_metadata_event("Mr Robot", "I walk around the city", "https://upload.wikimedia.org/wikipedia/commons/3/35/Mr_robot_photo.jpg", "mrrobot@mrrobot.com")
-#["EVENT",
-# {:pubkey=>"9be59510fa12b77340bb57e555bac716455fedf46d1a354185d4e72bd0340b6f",
-#  :created_at=>1671546067,
-#  :kind=>0,
-#  :tags=>[],
-#  :content=>"{\"name\":\"Mr Robot\",\"about\":\"I walk around the city\",\"picture\":\"https://upload.wikimedia.org/wikipedia/commons/3/35/Mr_robot_photo.jpg\",\"nip05\":\"mrrobot@mrrobot.com\"}",
-#  "id"=>"3bd77596ea999dde26689c24370dc4adfa66c33abf1b4c23bf863a516106cda2",
-#  "sig"=>"2ff752e9f3ed824e7677c41c73728315f0532f3437857774d7a50a577563f391785afd1f84bef3e3574939b14cf096380d4790375953c793504ffcf2f0467d69"}]
+
+nsec = Nostr::Bech32.encode_nsec(sk)
+# => "nsec1szg0k0lzdcna2w0wxjwhpzgdxwx9ut5tgk0qfj8fwev0q0f0nuessml5ur"
+
+npub = Nostr::Bech32.encode_npub(pk)
+# => "npub1ul0dn02zulr5lnryvktzhyvm0m7d2a62c6l29tntsxev42w56tnqksrtfu"
+
+nprofile = Nostr::Bech32.encode_nprofile(
+  pubkey: "7bdef7be22dd8e59f4600e044aa53a1cf975a9dc7d27df5833bc77db784a5805",
+  relays: ["wss://dtonon.nostr1.com"],
+)
+# => "nprofile1qqs8hhhhhc3dmrje73squpz255ape7t448w86f7ltqemca7m0p99spgpzamhxue69uhkgar0dehkutnwdaehgu339e3k7mg60me8x"
+
+note = Nostr::Bech32.encode_note("30b1979f289e1d1de367f9f2dec3431dd09917f4e39cc55c4f8889b7ecb9452f")
+# => "note1xzce08egncw3mcm8l8edas6rrhgfj9l5uwwv2hz03zym0m9eg5hsxuyajp"
+
+nevent = Nostr::Bech32.encode_nevent(
+  id: "30b1979f289e1d1de367f9f2dec3431dd09917f4e39cc55c4f8889b7ecb9452f",
+  relays: ["wss://nos.lol"],
+)
+# => "nevent1qqsrpvvhnu5fu8gaudnlnuk7cdp3m5yezl6w88x9t38c3zdhaju52tcpp4mhxue69uhkummn9ekx7mqrqsqqqqqpux7e9q"
+
+naddr = Nostr::Bech32.encode_naddr(
+  author: "7bdef7be22dd8e59f4600e044aa53a1cf975a9dc7d27df5833bc77db784a5805",
+  identifier: "little-love-for-long-format",
+  kind: 30023
+)
+# => "naddr1qgs8hhhhhc3dmrje73squpz255ape7t448w86f7ltqemca7m0p99spgrqsqqqa28qqdkc6t5w3kx2ttvdamx2ttxdaez6mr0denj6en0wfkkzaqn2tjdj"
 ```
 
-### Create a post
+### Initialize Client
+
 ```ruby
-note = n.build_note_event("Hello Nostr!")
-# =>
-# ["EVENT",
-#  {:pubkey=>"da15317263858ad496a21c79c6dc5f5cf9af880adf3a6794dbbf2883186c9d81",
-#   :created_at=>1671406583,
-#   :kind=>1,
-#   :tags=>[],
-#   :content=>"Hello Nostr!",
-#   "id"=>"23411895658d374ec922adf774a70172290b2c738ae67815bd8945e5d8fff3bb",
-#   "sig"=>"871177b77840bdf092dabacf98c47690647fd6ceb3cc79dd7af7e98c6aded0b808abd5566e2864bd438364cea2f17bd6f9d55091b3c5136839cf160beca42b63"}]
+require "nostr_ruby"
+
+# Detailed version
+s = Nostr::Signer.new(private_key: Nostr::Key.generate_private_key)
+c = Nostr::Client.new(signer: s)
+
+# Compact version, under the hood Client creates a Signer
+c = Nostr::Client.new(private_key: Nostr::Key.generate_private_key)
+
+c.private_key
+# => "7402b4b1ee09fb37b64ec2a958f1b7815d904c6dd44227bdef7912ef201af97d"
+
+c.public_key
+# => "a19f3c16b6e857d2b673c67eea293431fc175895513ca2f687a717152a5da466"
+
+c.nsec
+# => "nsec1wsptfv0wp8an0djwc2543udhs9weqnrd63pz00000yfw7gq6l97snckpdq"
+
+c.npub
+# => "npub15x0nc94kapta9dnncelw52f5x87pwky42y729a585ut322ja53nq72yrcr"
 ```
 
-### Create a channel post
+### Create, sign and send an event
+
 ```ruby
-channel_note = n.build_note_event("Welcome on my channel :)", "136b0b99eff742e0939799417d04d8b48049672beb6d8110ce6b0fc978cd67a1")
-# =>
-# ["EVENT",
-#  {:pubkey=>"da15317263858ad496a21c79c6dc5f5cf9af880adf3a6794dbbf2883186c9d81",
-#   :created_at=>1671406522,
-#   :kind=>42,
-#   :tags=>[["e", "136b0b99eff742e0939799417d04d8b48049672beb6d8110ce6b0fc978cd67a1"]],
-#   :content=>"Welcome on my channel :)",
-#   "id"=>"96ac317516e9cc3bae8238cf11a95a2f12d1bd2f6553c0867d47f3165ca3483b",
-#   "sig"=>"ccb6cbfa5c3cfac7b7f48dd9cda25d6a2493cbf8df91fa8f9fee2559a20c92613326a319f5b76aff9fef85278e04ce0ee78e636afb4ef2bb000ee8a6fdf418d2"}]
+# Initialize a client, under the hood Client creates a Signer
+c = Nostr::Client.new(
+  private_key: "7402b4b1ee09fb37b64ec2a958f1b7815d904c6dd44227bdef7912ef201af97d",
+  relay: "wss://nos.lol"
+)
+
+# Initialize an event
+e = Nostr::Event.new(
+  kind: ...,
+  pubkey: ...,
+  created_at: ...,
+  tags: ...,
+  content: ...,
+  pow: ...,
+  delegation: ...,
+)
+
+# Sign the event
+e = c.sign(e)
+
+# - - - - - - - - - - - - - -
+# Full async mode
+
+# Set the open callback
+c.on :connect do |event|
+  puts 'Publish event...'
+end
+
+# Set the response callback
+c.on :ok do |event|
+  puts "Event id: #{event.id}"
+  puts "Accepted: #{event.success}"
+  puts "Message: #{event.message}"
+end
+
+# Connect and send the event
+c.connect
+c.publish(e)
+# Do more things
+c.close
+
+# - - - - - - - - - - - - - -
+# Compact sync mode
+
+c.connect
+c.publish_and_wait(e)
+c.close
+
 ```
 
-### Recommend a relay
+### Set the profile
+
 ```ruby
-recommendation = n.build_recommended_relay_event("wss://relay.damus.io")
-# =>
-# ["EVENT",
-#  {:pubkey=>"d0fbe5e40469bba810ecb9e1b0b6c13370592df161655e81497c2eb69d0d5bef",
-#   :created_at=>1672079256,
-#   :kind=>2,
-#   :tags=>[],
-#   :content=>"wss://relay.damus.io",
-#   "id"=>"1842c9feb3bf2ad7095c8a51238f598fa028116d4fd919af22ad2c63ba3b7d69",
-#   "sig"=>"9c2f158f379b2d234fd0d363b46a7f90c25392f9296111b6cc04224df8aec69817fa62d7225c12b90fdc31eb89c7afaa427b18147cc8ad6cd411b47dda1331b6"}]
+metadata = {
+  name: "Mr Robot",
+  about: "I walk around the city",
+  picture: "https://upload.wikimedia.org/wikipedia/commons/3/35/Mr_robot_photo.jpg",
+  nip05: "mrrobot@mrrobot.com"
+}
+
+e = Nostr::Event.new(
+  kind: Nostr::Kind::METADATA,
+  pubkey: c.public_key,
+  content: metadata.to_json,
+)
+```
+
+### Post a note
+```ruby
+e = Nostr::Event.new(
+  kind: Nostr::Kind::SHORT_NOTE,
+  pubkey: c.public_key,
+  content: "Hello Nostr!",
+)
 ```
 
 ### Share a contact list
 ```ruby
-contact_list = n.build_contact_list_event(
-  [["54399b6d8200813bfc53177ad4f13d6ab712b6b23f91aefbf5da45aeb5c96b08", "wss://alicerelay.com/", "alice"],
+contact_list = [
+  ["54399b6d8200813bfc53177ad4f13d6ab712b6b23f91aefbf5da45aeb5c96b08", "wss://alicerelay.com/", "alice"],
   ["850708b7099215bf9a1356d242c2354939e9a844c1359d3b5209592a0b420452", "wss://bobrelay.com/nostr", "bob"],
-  ["f7f4b0072368460a09138bf3966fb1c59d0bdadfc3aff4e59e6896194594a82a", "ws://carolrelay.com/ws", "carol"]]
+  ["f7f4b0072368460a09138bf3966fb1c59d0bdadfc3aff4e59e6896194594a82a", "ws://carolrelay.com/ws", "carol"]
+]
+
+e = Nostr::Event.new(
+  kind: Nostr::Kind::CONTACT_LIST,
+  pubkey: c.public_key,
+  tags: contact_list.map { |c| ['p'] + c },
 )
-# =>
-# ["EVENT",
-#  {:pubkey=>"d0fbe5e40469bba810ecb9e1b0b6c13370592df161655e81497c2eb69d0d5bef",
-#   :created_at=>1672079733,
-#   :kind=>3,
-#   :tags=>
-#    [["p", "54399b6d8200813bfc53177ad4f13d6ab712b6b23f91aefbf5da45aeb5c96b08", "wss://alicerelay.com/", "alice"],
-#     ["p", "850708b7099215bf9a1356d242c2354939e9a844c1359d3b5209592a0b420452", "wss://bobrelay.com/nostr", "bob"],
-#     ["p", "f7f4b0072368460a09138bf3966fb1c59d0bdadfc3aff4e59e6896194594a82a", "ws://carolrelay.com/ws", "carol"]],
-#   :content=>"",
-#   "id"=>"3cdc1b5fa9d29aaa6b068cfb66cfd95f79784792beaec6cbb2645187b1c632e9",
-#   "sig"=>"e560e0d1a42261900c8ec32bf2d2016b95c3291adb45c7bf82ef94061beb44a45d6a768d9be773ec48ba9f54d05b4505bda0c1f21805e2be681c7436b3d39791"}]
 ```
 
-### Create a private message
+### Delete an event
 ```ruby
-private_message = n.build_dm_event("Hello!", "da15317263858ad496a21c79c6dc5f5cf9af880adf3a6794dbbf2883186c9d81") # To myself
-# =>
-# ["EVENT",
-#  {:pubkey=>"da15317263858ad496a21c79c6dc5f5cf9af880adf3a6794dbbf2883186c9d81",
-#   :created_at=>1671406025,
-#   :kind=>4,
-#   :tags=>[["p", "da15317263858ad496a21c79c6dc5f5cf9af880adf3a6794dbbf2883186c9d81"]],
-#   :content=>"AIZ7vomEJEFgB934gWzlNA==?iv=mwKLb6lZSG5X1y1BNYv6dg==",
-#   "id"=>"6a3efcf47a31bb05aeca0b13bf1f9b9e91b126e0a67e783253fb3bae20f0dc63",
-#   "sig"=>"0e390bb3c783157b3e32c3f6641fb40df9f62e326ac8a3448a70c94103b909e80292a2c4530562298f2c3935899111843a43548185abf09abf583bc3e6e3ddde"}]
+event_to_delete = "b91b3fb40128112c38dc54168b9f601c22bf8fcae6e70bb2a5f53e7f3ae44388"
+e = Nostr::Event.new(
+  kind: Nostr::Kind::DELETION,
+  pubkey: c.public_key,
+  tags: [["e", event_to_delete]],
+)
 ```
 
-### Decrypt a private message
+### React to an event
 ```ruby
-# Get the reply from the relay
-reply
-# => ["EVENT","0.27631406274260906",{"tags":[["p","da15317263858ad496a21c79c6dc5f5cf9af880adf3a6794dbbf2883186c9d81"]],"content":"vWATHf2l/KI7RSyVlbxpvufZc+Lui/0oDysTyfEG5vs=?iv=G4SG7ArMGkglX0UJbJBDUA==","sig":"fe816b86579f5d13ab23c88410364442a9b4393ac0d74f4642cd51a1887f04908ff57ef60409d529a6939c50d77b048320417005460b0353c8f990d1b35c3661","id":"5a0274f33cdb064136c1423ac4b096d7f1e3fb36f60404ef2449ee44331de03f","kind":4,"pubkey":"da15317263858ad496a21c79c6dc5f5cf9af880adf3a6794dbbf2883186c9d81","created_at":1671407520}]
+e = Nostr::Event.new(
+  kind: Nostr::Kind::REACTION,
+  pubkey: c.public_key,
+  content: "+",
+  tags: [["e", target_event]],
+)
 
-n.decrypt_dm(reply)
-# => "Nice to meet you!"
+# You can also use emoji
+e2 = Nostr::Event.new(
+  kind: Nostr::Kind::REACTION,
+  pubkey: c.public_key,
+  content: "🔥",
+  tags: [["e", target_event]],
+)
 ```
 
-### Delete an event
+### Create events with a PoW difficulty
 ```ruby
-deletion = n.build_deletion_event(["23411895658d374ec922adf774a70172290b2c738ae67815bd8945e5d8fff3bb"], "Duplicate")
-# =>
-# ["EVENT",
-#  {:pubkey=>"d0fbe5e40469bba810ecb9e1b0b6c13370592df161655e81497c2eb69d0d5bef",
-#   :created_at=>1672080450,
-#   :kind=>5,
-#   :tags=>[["e", "23411895658d374ec922adf774a70172290b2c738ae67815bd8945e5d8fff3bb"]],
-#   :content=>"Duplicate",
-#   "id"=>"e4a8556da9dc35da54dff747593073a90ac1de55131ca0deef6a5fd3b402d5fd",
-#   "sig"=>"95ccb5e965c1a6ba36b919a00cd7d3b65286435f93f49a2ebb846dc791a61179e55d544ebf00d4f8eeb53b0a75a97c072287c7458dfbaccb70b4aef6b0acf766"
+# Just add the `pow` argument 
+e = Nostr::Event.new(
+  kind: Nostr::Kind::SHORT_NOTE,
+  pubkey: c.public_key,
+  content: "Hello Nostr!",
+  pow: 15,
+)
 ```
 
-### React to an event
+### Create an event with a NIP-26 delegation
+```ruby
+delegator = Nostr::Client.new(private_key: delegator_key)
+
+delegatee = "b1d8dfd69fe8795042dbbc4d3f85938a01d4740c54d2daf11088c75c50ff19d9"
+conditions = "kind=1&created_at>#{Time.now.to_i}&created_at<#{(Time.now + 60*60).to_i}"
+delegation_tag = delegator.generate_delegation_tag(
+  to: delegatee,
+  conditions: conditions
+)
+
+# The `delegation_tag` is given to the delegatee so it can use it
+
+delegatee = Nostr::Client.new(private_key: delegatee_key)
+
+e = Nostr::Event.new(
+  kind: Nostr::Kind::SHORT_NOTE,
+  pubkey: delegatee.public_key,
+  content: "Hello Nostr!",
+  delegation: delegation_tag,
+)
+
+delegatee.sign(e)
+```
+### Send a direct message
+Warning: This uses NIP-04, that will be deprecated in favor of NIP-17
 ```ruby
-reaction = n.build_reaction_event("🔥", "23411895658d374ec922adf774a70172290b2c738ae67815bd8945e5d8fff3bb", "d0fbe5e40469bba810ecb9e1b0b6c13370592df161655e81497c2eb69d0d5bef")
-# =>
-# ["EVENT",
-#  {:pubkey=>"d0fbe5e40469bba810ecb9e1b0b6c13370592df161655e81497c2eb69d0d5bef",
-#   :created_at=>1672080671,
-#   :kind=>7,
-#   :tags=>[["e", "23411895658d374ec922adf774a70172290b2c738ae67815bd8945e5d8fff3bb"], ["p", "d0fbe5e40469bba810ecb9e1b0b6c13370592df161655e81497c2eb69d0d5bef"]],
-#   :content=>"🔥",
-#   "id"=>"f267c8ee24989b633b261efaa3892b07cdc90af80cedfd007b24a5c6232fc631",
-#   "sig"=>"84f2fc213337c6d2c26a4638b1db4e39f788811acd5bce5b9141b7ef56a9aa80768fbbd1109a7783a0d3033732675e231de286c6c745e62436865f4f15b838b6"}]
+
+e = Nostr::Event.new(
+  kind: Nostr::Kind::DIRECT_MESSAGE,
+  pubkey: c.public_key,
+  tags: [["p", Nostr::Bech32.decode(recipient)[:data]]],
+  content: "Hello Alice!"
+)
 ```
 
-### Create events with a PoW difficulty
+### Decrypt a direct message
+Warning: This uses NIP-04, that will be deprecated in favor of NIP-17
 ```ruby
-n.set_pow_difficulty(16)
-note = n.build_note_event("Hello Nostr!")
-# =>
-# ["EVENT",
-#  {:pubkey=>"d0fbe5e40469bba810ecb9e1b0b6c13370592df161655e81497c2eb69d0d5bef",
-#   :created_at=>1672095162,
-#   :kind=>42,
-#   :tags=>[["e", "d0fbe5e40469bba810ecb9e1b0b6c13370592df161655e81497c2eb69d0d5bef"], ["nonce", "232735", "16"]],
-#   :content=>"Hello Nostr!",
-#   "id"=>"0000fb0c4563274e742e56d7d6de08684a2a25dfb52b79cccdb49c649dccbf45",
-#   "sig"=>"838a1457c75084319e4723fbd9cbcf4c3311c466daf3908ffa114682094140e3b188996a73ae9fd3d3c6dbf08beecf9081b8d2bf0e60163b07cdf36a50dea1c0"}]
-```
-
-### Create events with a NIP-26 delegation
-```ruby
-from = Time.now.to_i
-to = (Time.now + 60*60).to_i
-delegatee_pubkey = "b1d8dfd69fe8795042dbbc4d3f85938a01d4740c54d2daf11088c75c50ff19d9"
-conditions = "kind=1&created_at>#{from}&created_at<#{to}"
-tag = n.get_delegation_tag(delegatee_pubkey, conditions)
-n.set_delegation(tag)
-n.build_note_event("I delegate someone to post this!")
-#=>
-#["EVENT",
-# {:pubkey=>"1ed41a3ce33edfc580102abfbdc01d922f8c7697beee3e395aa7dcd7115a3372",
-#  :created_at=>1681503318,
-#  :kind=>1,
-#  :tags=>
-#   [["delegation",
-#     "1ed41a3ce33edfc580102abfbdc01d922f8c7697beee3e395aa7dcd7115a3372",
-#     "kind=1&created_at>1681503305&created_at<1681506905",
-#     "dbbdc7074a5c2d2a53ee174c43afb0bb03106ced866e0dfa7996fe2553a54aaa9af6affe915ec2e688e26357681bfcf0445d607ed85eca2217f79fb51094d816"]],
-#  :content=>"I delegate someone to post this!",
-#  "id"=>"f6fd20535db6748e0529052310c47dc788616b03f8cef20260ca6a2dfb5dedaf",
-#  "sig"=>"826d7bd1f369f6ab8330746c236437610f13205809d12bc94af287b7ceec180443a3a750267d5152323329a1b2d02d0702364fa3ee8228bab57016b39975e449"}]
-```
-
-### Verify a NIP-26 delegation
-```ruby
-delegatee_pubkey = "b1d8dfd69fe8795042dbbc4d3f85938a01d4740c54d2daf11088c75c50ff19d9"
-tag = ["delegation", delegator_pubkey, conditions, signature]
-Nostr.verify_delegation_signature(delegatee_pubkey, tag)
-#=> true
-```
-
-### Reset the NIP-26 delegation
-```ruby
-n.reset_delegation
-#=> nil
+payload = {
+  :kind=>4,
+  :pubkey=>"a19f3c16b6e857d2b673c67eea293431fc175895513ca2f687a717152a5da466",
+  :created_at=>1725387307,
+  :tags=>[["p", "e7ded9bd42e7c74fcc6465962b919b7efcd5774ac6bea2ae6b81b2caa9d4d2e6"]],
+  :content=>"Nd7n/wId1oiprUCC4WWwNw==?iv=7gIRExcyO1xystretLIPnQ==",
+  :id=>"b91b3fb40128112c38dc54168b9f601c22bf8fcae6e70bb2a5f53e7f3ae44388",
+  :sig=>"73edf5a6acbefdd3d76f28ba90faaabe348a24c798f8fa33797eec29e2404c33a455815a59472ecd023441df38d815f83d81b95b8cb2f2c88a52982c8f7301e9"
+}
+e = Nostr::Event.new(**payload)
+
+c.decrypt(e)
+puts e.content
+=> "Hello Alice!"
+```
+
+### Create a subscribtion to receive events
+
+```ruby
+filter = Nostr::Filter.new(
+  kinds: [1],
+  authors: ["a19f3c16b6e857d2b673c67eea293431fc175895513ca2f687a717152a5da466"],
+  since: Time.now - (60*60*24), # 24 hours ago
+  limit: 10
+)
+
+c.on :connect do |message|
+  puts "Connected!"
+end
+
+c.on :event do |message|
+  puts ">> #{message.content}"
+end
+
+c.on :eose do |message|
+  puts "Finished subscription #{message.subscription_id}"
+  c.close
+end
+
+c.on :close do |message|
+  puts "Connection closed"
+end
+
+c.subscribe(filter: filter)
+c.connect
 ```

data/lib/bech32.rb

@@ -0,0 +1,84 @@
+require 'bech32'
+require 'bech32/nostr'
+require 'bech32/nostr/entity'
+
+module Nostr
+  class Bech32
+
+    def self.decode(bech32_entity)
+      e = ::Bech32::Nostr::NIP19.decode(bech32_entity)
+
+      case e
+      in ::Bech32::Nostr::BareEntity
+        { hrp: e.hrp, data: e.data }
+      in ::Bech32::Nostr::TLVEntity
+        { hrp: e.hrp, data: transform_entries(e.entries) }
+      end
+    end
+
+    def self.encode(hrp, data)
+      ::Bech32::Nostr::BareEntity.new(hrp, data).encode
+    end
+
+    def self.encode_npub(data)
+      encode("npub", data)
+    end
+
+    def self.encode_nsec(data)
+      encode("nsec", data)
+    end
+
+    def self.encode_nprofile(pubkey:, relays: [])
+      entry_relays = relays.map do |relay_url|
+        ::Bech32::Nostr::TLVEntry.new(::Bech32::Nostr::TLVEntity::TYPE_RELAY, relay_url)
+      end
+
+      pubkey_entry = ::Bech32::Nostr::TLVEntry.new(::Bech32::Nostr::TLVEntity::TYPE_SPECIAL, pubkey)
+      entries = [pubkey_entry, *entry_relays].compact
+      ::Bech32::Nostr::TLVEntity.new(::Bech32::Nostr::NIP19::HRP_PROFILE, entries).encode
+    end
+
+    def self.encode_note(data)
+      encode("note", data)
+    end
+
+    def self.encode_nevent(id:, relays: [], kind: nil)
+      entry_relays = relays.map do |r|
+        ::Bech32::Nostr::TLVEntry.new(::Bech32::Nostr::TLVEntity::TYPE_RELAY, r)
+      end
+
+      entry_id = ::Bech32::Nostr::TLVEntry.new(::Bech32::Nostr::TLVEntity::TYPE_SPECIAL, id)
+      entry_kind = kind ? ::Bech32::Nostr::TLVEntry.new(::Bech32::Nostr::TLVEntity::TYPE_KIND, kind) : nil
+
+      entries = [entry_id, *entry_relays, entry_kind].compact
+      ::Bech32::Nostr::TLVEntity.new(::Bech32::Nostr::NIP19::HRP_EVENT, entries).encode
+    end
+
+    def self.encode_naddr(author:, relays: [], kind: nil, identifier: nil)
+      entry_relays = relays.map do |r|
+        ::Bech32::Nostr::TLVEntry.new(::Bech32::Nostr::TLVEntity::TYPE_RELAY, r)
+      end
+
+      entry_author = ::Bech32::Nostr::TLVEntry.new(::Bech32::Nostr::TLVEntity::TYPE_AUTHOR, author)
+      entry_kind = ::Bech32::Nostr::TLVEntry.new(::Bech32::Nostr::TLVEntity::TYPE_KIND, kind)
+      entry_identifier = ::Bech32::Nostr::TLVEntry.new(::Bech32::Nostr::TLVEntity::TYPE_SPECIAL, identifier)
+
+      entries = [entry_author, *entry_relays, entry_kind, entry_identifier].compact
+      ::Bech32::Nostr::TLVEntity.new(::Bech32::Nostr::NIP19::HRP_EVENT_COORDINATE, entries).encode
+    end
+
+  private
+
+    # Helper method to transform entries into a hash
+    def self.transform_entries(entries)
+      entries.each_with_object({}) do |entry, hash|
+        label = entry.instance_variable_get(:@label).to_sym
+        value = entry.instance_variable_get(:@value)
+
+        hash[label] ||= []
+        hash[label] << value
+      end
+    end
+
+  end
+end