nostr 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 371ed11c0474fd944cc55a054d553945623f7439f67c55f3eadc564805d2fb11
-  data.tar.gz: f7fbe86119bd7816e7066ea3603263dee7327b06daeb4b92f9e90977f52ef8ae
+  metadata.gz: cd56d59d68235fe8fa4bceb67df4a7e83d4b6a8295ed31cc0152002800ad7d23
+  data.tar.gz: 56b70ada7f9fd6cd29be1c7bc23b7a23adc49bfe2f8d8de48300f70709626a3e
 SHA512:
-  metadata.gz: fa602354304ce9e77377b80cab60146f51ac8943b1399070a87ce81a5e44582f0a23b50f1736fafd9d7d0f13042b8b7292b9d29684077ad878e2439ddf7970ef
-  data.tar.gz: 83fc3d535a1e35438522779ef7dc3e101b4fea3a3f9874db9457b4f6c61d74469ded6ba973923d731789d3c50d7aa66b1c0770d62451794d45b52720c7928ebf
+  metadata.gz: be113a67cd651739cc3bac1deb4bba30e3598cfd787e8971a764e82d58c03ad1c918d3edd14630bbb1a5e2c6504c3c344859f0449a1774df7bb7bf0d3c38f537
+  data.tar.gz: c80bbf1f4d3caa25f48e1630b650587a2319197d7edba33e824b17e93f6355d8593c41364ad1fdb86a834d8cae63ad9f15e8feacae953b0ff8d7294f09c2c765

data/.rubocop.yml

@@ -31,6 +31,9 @@ Metrics/BlockLength:
     - '**/*_spec.rb'
     - nostr.gemspec
 
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
 # ----------------------- RSpec -----------------------
 
 RSpec/ExampleLength:

data/CHANGELOG.md

@@ -4,11 +4,40 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.4.0] - 2023-02-25
+
+### Removed
+
+- Removed `EventFragment` class. The `Event` class is no longer a Value Object. In other words, it is no longer
+immutable and it may be invalid by not having attributes `id` or `sig`. The `EventFragment` abstraction, along with the
+principles of immutability and was a major source of internal complexity as I needed to scale the codebase.
+
+### Added
+
+- Client compliance with [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md) (encrypted direct messages)
+- Extracted the cryptographic concerns into a `Crypto` class.
+- Added the setters `Event#id=` and `Event#sig=`
+- Added a method on the event class to sign events (`Event#sign`)
+- Added a missing test for `EventKind::CONTACT_LIST`
+- Added two convenience methods to append event and pubkey references to an event's tags `add_event_reference` and
+`add_pubkey_reference`
+
+### Fixed
+
+- Fixed the generation of public keys
+- Fixed the RBS signature of `User#create_event`
+
 ## [0.3.0] - 2023-02-15
 
 ### Added
 
 - Client compliance wth [NIP-02](https://github.com/nostr-protocol/nips/blob/master/02.md) (manage contact lists)
+- RBS type checking using Steep and TypeProf
+
+## Fixed
+
+- Fixed a documentation typo
+- Fixed a documentation error regarding the receiving of messages via websockets
 
 ## [0.2.0] - 2023-01-12
 

data/README.md

@@ -7,6 +7,27 @@
 Asynchronous Nostr client. Please note that the API is likely to change as the gem is still in development and
 has not yet reached a stable release. Use with caution.
 
+## Table of contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+  * [Requiring the gem](#requiring-the-gem)
+  * [Generating a keypair](#generating-a-keypair)
+  * [Generating a private key and a public key](#generating-a-private-key-and-a-public-key)
+  * [Connecting to a Relay](#connecting-to-a-relay)
+  * [WebSocket events](#websocket-events)
+  * [Requesting for events / creating a subscription](#requesting-for-events--creating-a-subscription)
+  * [Stop previous subscriptions](#stop-previous-subscriptions)
+  * [Publishing an event](#publishing-an-event)
+  * [Creating/updating your contact list](#creatingupdating-your-contact-list)
+  * [Sending an encrypted direct message](#sending-an-encrypted-direct-message)
+- [Implemented NIPs](#implemented-nips)
+- [Development](#development)
+  * [Type checking](#type-checking)
+- [Contributing](#contributing)
+- [License](#license)
+- [Code of Conduct](#code-of-conduct)
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -31,7 +52,7 @@ require 'nostr'
 
 ```ruby
 keygen  = Nostr::Keygen.new
-keypair = keygen.generate_keypair
+keypair = keygen.generate_key_pair
 
 keypair.private_key
 keypair.public_key
@@ -220,10 +241,38 @@ update_contacts_event = user.create_event(
 client.publish(update_contacts_event)
 ```
 
-## NIPS
+### Sending an encrypted direct message
+
+```ruby
+sender_private_key = '3185a47e3802f956ca5a2b4ea606c1d51c7610f239617e8f0f218d55bdf2b757'
+
+encrypted_direct_message = Nostr::Events::EncryptedDirectMessage.new(
+   sender_private_key: sender_private_key,
+   recipient_public_key: '6c31422248998e300a1a457167565da7d15d0da96651296ee2791c29c11b6aa0',
+   plain_text: 'Your feedback is appreciated, now pay $8',
+   previous_direct_message: 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460' # optional
+)
+
+encrypted_direct_message.sign(sender_private_key)
+
+# #<Nostr::Events::EncryptedDirectMessage:0x0000000104c9fa68
+# @content="mjIFNo1sSP3KROE6QqhWnPSGAZRCuK7Np9X+88HSVSwwtFyiZ35msmEVoFgRpKx4?iv=YckChfS2oWCGpMt1uQ4GbQ==",
+#   @created_at=1676456512,
+#   @id="daac98826d5eb29f7c013b6160986c4baf4fe6d4b995df67c1b480fab1839a9b",
+#   @kind=4,
+#   @pubkey="8a9d69c56e3c691bec8f9565e4dcbe38ae1d88fffeec3ce66b9f47558a3aa8ca",
+#   @sig="028bb5f5bab0396e2065000c84a4bcce99e68b1a79bb1b91a84311546f49c5b67570b48d4a328a1827e7a8419d74451347d4f55011a196e71edab31aa3d6bdac",
+#   @tags=[["p", "6c31422248998e300a1a457167565da7d15d0da96651296ee2791c29c11b6aa0"], ["e", "ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460"]]>
+
+# Send it to the Relay
+client.publish(encrypted_direct_message)
+````
+
+## Implemented NIPs
 
 - [x] [NIP-01 - Client](https://github.com/nostr-protocol/nips/blob/master/01.md)
 - [x] [NIP-02 - Client](https://github.com/nostr-protocol/nips/blob/master/02.md)
+- [x] [NIP-04 - Client](https://github.com/nostr-protocol/nips/blob/master/04.md)
 
 ## Development
 

data/Steepfile

@@ -6,7 +6,9 @@ target :lib do
   check 'lib'
 
   # Core libraries
+  library 'base64'
   library 'digest'
+  library 'openssl'
   library 'securerandom'
 
   # Gems

data/lib/nostr/crypto.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module Nostr
+  # Performs cryptographic operations on a +Nostr::Event+.
+  class Crypto
+    # Numeric base of the OpenSSL big number used in an event content's encryption.
+    #
+    # @return [Integer]
+    #
+    BN_BASE = 16
+
+    # Name of the cipher curve used in an event content's encryption.
+    #
+    # @return [String]
+    #
+    CIPHER_CURVE = 'secp256k1'
+
+    # Name of the cipher algorithm used in an event content's encryption.
+    #
+    # @return [String]
+    #
+    CIPHER_ALGORITHM = 'aes-256-cbc'
+
+    # Encrypts a piece of text
+    #
+    # @api public
+    #
+    # @example Encrypting an event's content
+    #   crypto = Nostr::Crypto.new
+    #   encrypted = crypto.encrypt_text(sender_private_key, recipient_public_key, 'Feedback appreciated. Now pay $8')
+    #   encrypted # => "wrYQaHDfpOEvyJELSCg1vzsywmlJTz8NqH03eFW44s8iQs869jtSb26Lr4s23gmY?iv=v38vAJ3LlJAGZxbmWU4qAg=="
+    #
+    # @param sender_private_key [String] 32-bytes hex-encoded private key of the creator.
+    # @param recipient_public_key [String] 32-bytes hex-encoded public key of the recipient.
+    # @param plain_text [String] The text to be encrypted
+    #
+    # @return [String] Encrypted text.
+    #
+    def encrypt_text(sender_private_key, recipient_public_key, plain_text)
+      cipher = OpenSSL::Cipher.new(CIPHER_ALGORITHM).encrypt
+      cipher.iv = iv = cipher.random_iv
+      cipher.key = compute_shared_key(sender_private_key, recipient_public_key)
+      encrypted_text = cipher.update(plain_text) + cipher.final
+      encrypted_text = "#{Base64.encode64(encrypted_text)}?iv=#{Base64.encode64(iv)}"
+      encrypted_text.gsub("\n", '')
+    end
+
+    # Decrypts a piece of text
+    #
+    # @api public
+    #
+    # @example Encrypting an event's content
+    #   crypto = Nostr::Crypto.new
+    #   encrypted # => "wrYQaHDfpOEvyJELSCg1vzsywmlJTz8NqH03eFW44s8iQs869jtSb26Lr4s23gmY?iv=v38vAJ3LlJAGZxbmWU4qAg=="
+    #   decrypted = crypto.decrypt_text(recipient_private_key, sender_public_key, encrypted)
+    #
+    # @param sender_public_key [String] 32-bytes hex-encoded public key of the message creator.
+    # @param recipient_private_key [String] 32-bytes hex-encoded public key of the recipient.
+    # @param encrypted_text [String] The text to be decrypted
+    #
+    # @return [String] Decrypted text.
+    #
+    def decrypt_text(recipient_private_key, sender_public_key, encrypted_text)
+      base64_encoded_text, iv = encrypted_text.split('?iv=')
+      cipher = OpenSSL::Cipher.new(CIPHER_ALGORITHM).decrypt
+      cipher.iv = Base64.decode64(iv)
+      cipher.key = compute_shared_key(recipient_private_key, sender_public_key)
+      plain_text = cipher.update(Base64.decode64(base64_encoded_text)) + cipher.final
+      plain_text.force_encoding('UTF-8')
+    end
+
+    # Uses the private key to generate an event id and sign the event
+    #
+    # @api public
+    #
+    # @example Signing an event
+    #   crypto = Nostr::Crypto.new
+    #   crypto.sign(event, private_key)
+    #   event.id # => an id
+    #   event.sig # => a signature
+    #
+    # @param event [Event] The event to be signed
+    # @param private_key [String] 32-bytes hex-encoded private key.
+    #
+    # @return [Event] An unsigned event.
+    #
+    def sign_event(event, private_key)
+      event_digest = hash_event(event)
+
+      hex_private_key = Array(private_key).pack('H*')
+      hex_message     = Array(event_digest).pack('H*')
+      event_signature = Schnorr.sign(hex_message, hex_private_key).encode.unpack1('H*')
+
+      event.id = event_digest
+      event.sig = event_signature
+
+      event
+    end
+
+    private
+
+    # Finds a shared key between two keys
+    #
+    # @api private
+    #
+    # @param private_key [String] 32-bytes hex-encoded private key.
+    # @param public_key [String] 32-bytes hex-encoded public key.
+    #
+    # @return [String] A shared key used in the event's content encryption and decryption.
+    #
+    def compute_shared_key(private_key, public_key)
+      group = OpenSSL::PKey::EC::Group.new(CIPHER_CURVE)
+
+      private_key_bn   = OpenSSL::BN.new(private_key, BN_BASE)
+      public_key_bn    = OpenSSL::BN.new("02#{public_key}", BN_BASE)
+      public_key_point = OpenSSL::PKey::EC::Point.new(group, public_key_bn)
+
+      asn1 = OpenSSL::ASN1::Sequence(
+        [
+          OpenSSL::ASN1::Integer.new(1),
+          OpenSSL::ASN1::OctetString(private_key_bn.to_s(2)),
+          OpenSSL::ASN1::ObjectId(CIPHER_CURVE, 0, :EXPLICIT),
+          OpenSSL::ASN1::BitString(public_key_point.to_octet_string(:uncompressed), 1, :EXPLICIT)
+        ]
+      )
+
+      pkey = OpenSSL::PKey::EC.new(asn1.to_der)
+      pkey.dh_compute_key(public_key_point)
+    end
+
+    # Generates a SHA256 hash of a +Nostr::Event+
+    #
+    # @api private
+    #
+    # @param event [Event] The event to be hashed
+    #
+    # @return [String] A SHA256 digest of the event
+    #
+    def hash_event(event)
+      Digest::SHA256.hexdigest(JSON.dump(event.serialize))
+    end
+  end
+end

data/lib/nostr/event.rb

@@ -2,7 +2,65 @@
 
 module Nostr
   # The only object type that exists in Nostr is an event. Events are immutable.
-  class Event < EventFragment
+  class Event
+    # 32-bytes hex-encoded public key of the event creator
+    #
+    # @api public
+    #
+    # @example
+    #   event.pubkey # => '48df4af6e240ac5f7c5de89bf5941b249880be0e87d03685b178ccb1a315f52e'
+    #
+    # @return [String]
+    #
+    attr_reader :pubkey
+
+    # Date of the creation of the vent. A UNIX timestamp, in seconds
+    #
+    # @api public
+    #
+    # @example
+    #   event.created_at # => 1230981305
+    #
+    # @return [Integer]
+    #
+    attr_reader :created_at
+
+    # The kind of the event. An integer from 0 to 3
+    #
+    # @api public
+    #
+    # @example
+    #   event.kind # => 1
+    #
+    # @return [Integer]
+    #
+    attr_reader :kind
+
+    # An array of tags. Each tag is an array of strings
+    #
+    # @api public
+    #
+    # @example Tags referencing an event
+    #  event.tags #=> [["e", "event_id", "relay URL"]]
+    #
+    # @example Tags referencing a key
+    #  event.tags #=> [["p", "event_id", "relay URL"]]
+    #
+    # @return [Array<Array>]
+    #
+    attr_reader :tags
+
+    # An arbitrary string
+    #
+    # @api public
+    #
+    # @example
+    #  event.content # => 'Your feedback is appreciated, now pay $8'
+    #
+    # @return [String]
+    #
+    attr_reader :content
+
     # 32-bytes sha256 of the the serialized event data.
     # To obtain the event.id, we sha256 the serialized event. The serialization is done over the UTF-8 JSON-serialized
     # string (with no white space or line breaks)
@@ -12,9 +70,13 @@ module Nostr
     # @example Getting the event id
     #   event.id # => 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460'
     #
-    # @return [String]
+    # @example Setting the event id
+    #   event.id = 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460'
+    #   event.id # => 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460'
+    #
+    # @return [String|nil]
     #
-    attr_reader :id
+    attr_accessor :id
 
     # 64-bytes signature of the sha256 hash of the serialized event data, which is
     # the same as the "id" field
@@ -24,9 +86,13 @@ module Nostr
     # @example Getting the event signature
     #   event.sig # => ''
     #
-    # @return [String]
+    # @example Setting the event signature
+    #   event.sig = '058613f8d34c053294cc28b7f9e1f8f0e80fd1ac94fb20f2da6ca514e7360b39'
+    #   event.sig # => '058613f8d34c053294cc28b7f9e1f8f0e80fd1ac94fb20f2da6ca514e7360b39'
+    #
+    # @return [String|nil]
     #
-    attr_reader :sig
+    attr_accessor :sig
 
     # Instantiates a new Event
     #
@@ -44,16 +110,96 @@ module Nostr
     #          937c6d6e9855477638f5655c5d89c9aa5501ea9b578a66aced4f1cd7b3'
     # )
     #
-    #
-    # @param id [String] 32-bytes sha256 of the the serialized event data.
-    # @param sig [String] 64-bytes signature of the sha256 hash of the serialized event data, which is
+    # @param id [String|nil] 32-bytes sha256 of the the serialized event data.
+    # @param sig [String|nil] 64-bytes signature of the sha256 hash of the serialized event data, which is
     # the same as the "id" field
-    #
-    def initialize(id:, sig:, **kwargs)
-      super(**kwargs)
+    # @param pubkey [String] 32-bytes hex-encoded public key of the event creator.
+    # @param created_at [Integer] Date of the creation of the vent. A UNIX timestamp, in seconds.
+    # @param kind [Integer] The kind of the event. An integer from 0 to 3.
+    # @param tags [Array<Array>] An array of tags. Each tag is an array of strings.
+    # @param content [String] Arbitrary string.
+    #
+    def initialize(
+      pubkey:,
+      kind:,
+      content:,
+      created_at: Time.now.to_i,
+      tags: [],
+      id: nil,
+      sig: nil
+    )
 
       @id = id
       @sig = sig
+      @pubkey = pubkey
+      @created_at = created_at
+      @kind = kind
+      @tags = tags
+      @content = content
+    end
+
+    # Adds a reference to an event id as an 'e' tag
+    #
+    # @api public
+    #
+    # @example Adding a reference to a pubkey
+    #   event_id = '189df012cfff8a075785b884bd702025f4a7a37710f581c4ac9d33e24b585408'
+    #   event.add_event_reference(event_id)
+    #
+    # @param event_id [String] 32-bytes hex-encoded event id.
+    #
+    # @return [Array<String>] The event's updated list of tags
+    #
+    def add_event_reference(event_id) = tags.push(['e', event_id])
+
+    # Adds a reference to a pubkey as a 'p' tag
+    #
+    # @api public
+    #
+    # @example Adding a reference to a pubkey
+    #   pubkey = '48df4af6e240ac5f7c5de89bf5941b249880be0e87d03685b178ccb1a315f52e'
+    #   event.add_pubkey_reference(pubkey)
+    #
+    # @param pubkey [String] 32-bytes hex-encoded public key.
+    #
+    # @return [Array<String>] The event's updated list of tags
+    #
+    def add_pubkey_reference(pubkey) = tags.push(['p', pubkey])
+
+    # Signs an event with the user's private key
+    #
+    # @api public
+    #
+    # @example Signing an event
+    #   event.sign(private_key)
+    #
+    # @param private_key [String] 32-bytes hex-encoded private key.
+    #
+    # @return [Event] A signed event.
+    #
+    def sign(private_key)
+      crypto = Crypto.new
+      crypto.sign_event(self, private_key)
+    end
+
+    # Serializes the event, to obtain a SHA256 digest of it
+    #
+    # @api public
+    #
+    # @example Converting the event to a digest
+    #   event.serialize
+    #
+    # @return [Array] The event as an array.
+    #
+    def serialize
+      [
+        0,
+        pubkey,
+        created_at,
+        kind,
+        tags,
+        content
+      ]
     end
 
     # Converts the event to a hash

data/lib/nostr/event_kind.rb

@@ -31,5 +31,13 @@ module Nostr
     # @return [Integer]
     #
     CONTACT_LIST = 3
+
+    # A special event with kind 4, meaning "encrypted direct message". An event of this kind has its +content+
+    # equal to the base64-encoded, aes-256-cbc encrypted string of anything a user wants to write, encrypted using a
+    # shared cipher generated by combining the recipient's public-key with the sender's private-key.
+    #
+    # @return [Integer]
+    #
+    ENCRYPTED_DIRECT_MESSAGE = 4
   end
 end

data/lib/nostr/events/encrypted_direct_message.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Nostr
+  # Classes of event kinds.
+  module Events
+    # An event whose +content+ is encrypted. It can only be decrypted by the owner of the private key that pairs
+    # the event's +pubkey+.
+    class EncryptedDirectMessage < Event
+      # Instantiates a new encrypted direct message
+      #
+      # @api public
+      #
+      # @example Instantiating a new encrypted direct message
+      #   Nostr::Events::EncryptedDirectMessage.new(
+      #    sender_private_key: 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460',
+      #    recipient_public_key: '48df4af6e240ac5f7c5de89bf5941b249880be0e87d03685b178ccb1a315f52e',
+      #    plain_text: 'Your feedback is appreciated, now pay $8',
+      # )
+      #
+      # @example Instantiating a new encrypted direct message that references a previous direct message
+      #   Nostr::Events::EncryptedDirectMessage.new(
+      #    sender_private_key: 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460',
+      #    recipient_public_key: '48df4af6e240ac5f7c5de89bf5941b249880be0e87d03685b178ccb1a315f52e',
+      #    plain_text: 'Your feedback is appreciated, now pay $8',
+      #    previous_direct_message: 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460'
+      # )
+      #
+      # @param plain_text [String] The +content+ of the encrypted message.
+      # @param sender_private_key [String] 32-bytes hex-encoded private key of the message's author.
+      # @param recipient_public_key [String] 32-bytes hex-encoded public key of the recipient of the encrypted message.
+      # @param previous_direct_message [String] 32-bytes hex-encoded id identifying the previous message in a
+      # conversation or a message we are explicitly replying to (such that contextual, more organized conversations
+      # may happen
+      #
+      def initialize(plain_text:, sender_private_key:, recipient_public_key:, previous_direct_message: nil)
+        crypto = Crypto.new
+        keygen = Keygen.new
+
+        encrypted_content = crypto.encrypt_text(sender_private_key, recipient_public_key, plain_text)
+        sender_public_key = keygen.extract_public_key(sender_private_key)
+
+        super(
+          pubkey: sender_public_key,
+          kind: Nostr::EventKind::ENCRYPTED_DIRECT_MESSAGE,
+          content: encrypted_content,
+          )
+
+        add_pubkey_reference(recipient_public_key)
+        add_event_reference(previous_direct_message) if previous_direct_message
+      end
+    end
+  end
+end

data/lib/nostr/keygen.rb

@@ -62,7 +62,7 @@ module Nostr
     # @return [String] A 32-bytes hex-encoded public key.
     #
     def extract_public_key(private_key)
-      group.generator.multiply_by_scalar(private_key.to_i(16)).x.to_s(16)
+      group.generator.multiply_by_scalar(private_key.to_i(16)).x.to_s(16).rjust(64, '0')
     end
 
     private

data/lib/nostr/user.rb

@@ -57,36 +57,8 @@ module Nostr
     # @return [Event]
     #
     def create_event(event_attributes)
-      event_fragment = EventFragment.new(**event_attributes.merge(pubkey: keypair.public_key))
-      event_sha256 = Digest::SHA256.hexdigest(JSON.dump(event_fragment.serialize))
-
-      signature = sign(event_sha256)
-
-      Event.new(
-        id: event_sha256,
-        pubkey: event_fragment.pubkey,
-        created_at: event_fragment.created_at,
-        kind: event_fragment.kind,
-        tags: event_fragment.tags,
-        content: event_fragment.content,
-        sig: signature
-      )
-    end
-
-    private
-
-    # Signs an event with the user's private key
-    #
-    # @api private
-    #
-    # @param event_sha256 [String] The SHA256 hash of the event.
-    #
-    # @return [String] The signature of the event.
-    #
-    def sign(event_sha256)
-      hex_private_key = Array(keypair.private_key).pack('H*')
-      hex_message = Array(event_sha256).pack('H*')
-      Schnorr.sign(hex_message, hex_private_key).encode.unpack1('H*')
+      event = Event.new(**event_attributes.merge(pubkey: keypair.public_key))
+      event.sign(keypair.private_key)
     end
   end
 end

data/lib/nostr/version.rb

@@ -2,5 +2,5 @@
 
 module Nostr
   # The version of the gem
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/nostr.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'nostr/crypto'
 require_relative 'nostr/version'
 require_relative 'nostr/keygen'
 require_relative 'nostr/client_message_type'
@@ -8,8 +9,8 @@ require_relative 'nostr/subscription'
 require_relative 'nostr/relay'
 require_relative 'nostr/key_pair'
 require_relative 'nostr/event_kind'
-require_relative 'nostr/event_fragment'
 require_relative 'nostr/event'
+require_relative 'nostr/events/encrypted_direct_message'
 require_relative 'nostr/client'
 require_relative 'nostr/user'
 

data/sig/nostr/crypto.rbs

@@ -0,0 +1,16 @@
+module Nostr
+  class Crypto
+    BN_BASE: Integer
+    CIPHER_CURVE: String
+    CIPHER_ALGORITHM: String
+
+    def encrypt_text: (String, String, String) -> String
+    def decrypt_text: (String, String, String) -> String
+    def sign_event: (Event, String) -> Event
+
+    private
+
+    def compute_shared_key: (String, String) -> String
+    def hash_event:(Event) -> String
+  end
+end

data/sig/nostr/event.rbs

@@ -1,24 +1,39 @@
 module Nostr
-  class Event < EventFragment
-    attr_reader id: String
-    attr_reader sig: String
+  class Event
+    attr_reader pubkey: String
+    attr_reader created_at: Integer
+    attr_reader kind: Integer
+    attr_reader tags: Array[Array[String]]
+    attr_reader content: String
+    attr_accessor id: String?|nil
+    attr_accessor sig: String?|nil
 
-    def initialize: (id: String, sig: String,
-      created_at: Integer,
+    def initialize: (
+      pubkey: String,
       kind: Integer,
-      tags: Array[String],
       content: String,
+      ?created_at: Integer,
+      ?tags: Array[Array[String]],
+      ?id: String|nil,
+      ?sig: String|nil
     ) -> void
 
+    def serialize: -> [Integer, String, Integer, Integer, Array[Array[String]], String]
+
     def to_h: -> {
-      id: String,
+      id: String?|nil,
       pubkey: String,
       created_at: Integer,
       kind: Integer,
-      tags: Array[String],
+      tags: Array[Array[String]],
       content: String,
-      sig: String
+      sig: String?|nil
     }
     def ==: (Event other) -> bool
+
+    def sign:(String) -> Event
+
+    def add_event_reference: (String) -> Array[Array[String]]
+    def add_pubkey_reference: (String) -> Array[Array[String]]
   end
 end

data/sig/nostr/event_kind.rbs

@@ -4,5 +4,6 @@ module Nostr
     TEXT_NOTE: Integer
     RECOMMEND_SERVER: Integer
     CONTACT_LIST: Integer
+    ENCRYPTED_DIRECT_MESSAGE: Integer
   end
 end

data/sig/nostr/events/encrypted_direct_message.rbs

@@ -0,0 +1,12 @@
+module Nostr
+  module Events
+    class EncryptedDirectMessage < Event
+      def initialize: (
+          plain_text: String,
+          sender_private_key: String,
+          recipient_public_key: String,
+          ?previous_direct_message: String|nil
+        ) -> void
+    end
+  end
+end

data/sig/nostr/user.rbs

@@ -6,14 +6,12 @@ module Nostr
     def initialize: (?keypair: KeyPair | nil, ?keygen: Keygen) -> void
     def create_event: (
       {
-        id: String,
         pubkey: String,
         created_at: Integer,
         kind: Integer,
         tags: Array[String],
         content: String,
         created_at: Integer,
-        sig: String
       }
     ) -> Event
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nostr
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Wilson Silva
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-15 00:00:00.000000000 Z
+date: 2023-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bech32
@@ -455,9 +455,10 @@ files:
 - lib/nostr.rb
 - lib/nostr/client.rb
 - lib/nostr/client_message_type.rb
+- lib/nostr/crypto.rb
 - lib/nostr/event.rb
-- lib/nostr/event_fragment.rb
 - lib/nostr/event_kind.rb
+- lib/nostr/events/encrypted_direct_message.rb
 - lib/nostr/filter.rb
 - lib/nostr/key_pair.rb
 - lib/nostr/keygen.rb
@@ -469,9 +470,10 @@ files:
 - sig/nostr.rbs
 - sig/nostr/client.rbs
 - sig/nostr/client_message_type.rbs
+- sig/nostr/crypto.rbs
 - sig/nostr/event.rbs
-- sig/nostr/event_fragment.rbs
 - sig/nostr/event_kind.rbs
+- sig/nostr/events/encrypted_direct_message.rbs
 - sig/nostr/filter.rbs
 - sig/nostr/key_pair.rbs
 - sig/nostr/keygen.rbs
@@ -506,7 +508,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.4
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: Client and relay implementation of the Nostr protocol.

data/lib/nostr/event_fragment.rb

@@ -1,111 +0,0 @@
-# frozen_string_literal: true
-
-module Nostr
-  # Part of an +Event+. A complete +Event+ must have an +id+ and a +sig+.
-  class EventFragment
-    # 32-bytes hex-encoded public key of the event creator
-    #
-    # @api public
-    #
-    # @example
-    #   event.pubkey # => '48df4af6e240ac5f7c5de89bf5941b249880be0e87d03685b178ccb1a315f52e'
-    #
-    # @return [String]
-    #
-    attr_reader :pubkey
-
-    # Date of the creation of the vent. A UNIX timestamp, in seconds
-    #
-    # @api public
-    #
-    # @example
-    #   event.created_at # => 1230981305
-    #
-    # @return [Integer]
-    #
-    attr_reader :created_at
-
-    # The kind of the event. An integer from 0 to 3
-    #
-    # @api public
-    #
-    # @example
-    #   event.kind # => 1
-    #
-    # @return [Integer]
-    #
-    attr_reader :kind
-
-    # An array of tags. Each tag is an array of strings
-    #
-    # @api public
-    #
-    # @example Tags referencing an event
-    #  event.tags #=> [["e", "event_id", "relay URL"]]
-    #
-    # @example Tags referencing a key
-    #  event.tags #=> [["p", "event_id", "relay URL"]]
-    #
-    # @return [Array<Array>]
-    #
-    attr_reader :tags
-
-    # An arbitrary string
-    #
-    # @api public
-    #
-    # @example
-    #  event.content # => 'Your feedback is appreciated, now pay $8'
-    #
-    # @return [String]
-    #
-    attr_reader :content
-
-    # Instantiates a new EventFragment
-    #
-    # @api public
-    #
-    # @example
-    #   Nostr::EventFragment.new(
-    #     pubkey: 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460',
-    #     created_at: 1230981305,
-    #     kind: 1,
-    #     tags: [['e', '189df012cfff8a075785b884bd702025f4a7a37710f581c4ac9d33e24b585408']],
-    #     content: 'Your feedback is appreciated, now pay $8'
-    #   )
-    #
-    # @param pubkey [String] 32-bytes hex-encoded public key of the event creator.
-    # @param created_at [Integer] Date of the creation of the vent. A UNIX timestamp, in seconds.
-    # @param kind [Integer] The kind of the event. An integer from 0 to 3.
-    # @param tags [Array<Array>] An array of tags. Each tag is an array of strings.
-    # @param content [String] Arbitrary string.
-    #
-    def initialize(pubkey:, kind:, content:, created_at: Time.now.to_i, tags: [])
-      @pubkey = pubkey
-      @created_at = created_at
-      @kind = kind
-      @tags = tags
-      @content = content
-    end
-
-    # Serializes the event fragment, to obtain a SHA256 hash of it
-    #
-    # @api public
-    #
-    # @example Converting the event to a hash
-    #   event_fragment.serialize
-    #
-    # @return [Array] The event fragment as an array.
-    #
-    def serialize
-      [
-        0,
-        pubkey,
-        created_at,
-        kind,
-        tags,
-        content
-      ]
-    end
-  end
-end

data/sig/nostr/event_fragment.rbs

@@ -1,12 +0,0 @@
-module Nostr
-  class EventFragment
-    attr_reader pubkey: String
-    attr_reader created_at: Integer
-    attr_reader kind: Integer
-    attr_reader tags: Array[String]
-    attr_reader content: String
-
-    def initialize: (pubkey: String, kind: Integer, content: String, ?created_at: Integer, ?tags: Array[String]) -> void
-    def serialize: -> [Integer, String, Integer, Integer, Array[String], String]
-  end
-end