nostr 0.5.0 → 0.7.0

data/lib/nostr/client/color_logger.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Nostr
+  class Client
+    # Logs connection events, messages sent and received, errors, and connection closures in color.
+    class ColorLogger < Logger
+      # Logs connection to a relay
+      #
+      # @api private
+      #
+      # @param [Nostr::Relay] relay The relay the client connected to.
+      #
+      # @return [void]
+      #
+      def on_connect(relay)
+        puts "\u001b[32m\u001b[1mConnected to the relay\u001b[22m #{relay.name} (#{relay.url})\u001b[0m"
+      end
+
+      # Logs a message received from the relay
+      #
+      # @api private
+      #
+      # @param [String] message The message received.
+      #
+      # @return [void]
+      #
+      def on_message(message)
+        puts "\u001b[32m\u001b[1m◄-\u001b[0m #{message}"
+      end
+
+      # Logs a message sent to the relay
+      #
+      # @api private
+      #
+      # @param [String] message The message sent.
+      #
+      # @return [void]
+      #
+      def on_send(message)
+        puts "\u001b[32m\u001b[1m-►\u001b[0m #{message}"
+      end
+
+      # Logs an error message
+      #
+      # @api private
+      #
+      # @param [String] message The error message.
+      #
+      # @return [void]
+      #
+      def on_error(message)
+        puts "\u001b[31m\u001b[1mError: \u001b[22m#{message}\u001b[0m"
+      end
+
+      # Logs a closure of connection with a relay
+      #
+      # @api private
+      #
+      # @param [String] code The closure code.
+      # @param [String] reason The reason for the closure.
+      #
+      # @return [void]
+      #
+      def on_close(code, reason)
+        puts "\u001b[31m\u001b[1mConnection closed: \u001b[22m#{reason} (##{code})\u001b[0m"
+      end
+    end
+  end
+end

data/lib/nostr/client/logger.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Nostr
+  class Client
+    # Logs connection events, messages sent and received, errors, and connection closures.
+    class Logger
+      # Attaches event handlers to the specified Nostr client for logging purposes
+      #
+      # @api public
+      #
+      # @example Attaching the logger to a client
+      #   client = Nostr::Client.new
+      #   logger = Nostr::Client::Logger.new
+      #   logger.attach_to(client)
+      #
+      #   # Now, actions like connecting, sending messages, receiving messages,
+      #   # errors, and closing the connection will be logged to the console.
+      #
+      # @param [Nostr::Client] client The client to attach logging functionality to.
+      #
+      # @return [void]
+      #
+      def attach_to(client)
+        logger_instance = self
+
+        client.on(:connect) { |relay| logger_instance.on_connect(relay) }
+        client.on(:message) { |message| logger_instance.on_message(message) }
+        client.on(:send) { |message| logger_instance.on_send(message) }
+        client.on(:error) { |message| logger_instance.on_error(message) }
+        client.on(:close) { |code, reason| logger_instance.on_close(code, reason) }
+      end
+
+      # Logs connection to a relay
+      #
+      # @api private
+      #
+      # @param [Nostr::Relay] relay The relay the client connected to.
+      #
+      # @return [void]
+      #
+      def on_connect(relay); end
+
+      # Logs a message received from the relay
+      #
+      # @api private
+      #
+      # @param [String] message The message received.
+      #
+      # @return [void]
+      #
+      def on_message(message); end
+
+      # Logs a message sent to the relay
+      #
+      # @api private
+      #
+      # @param [String] message The message sent.
+      #
+      # @return [void]
+      #
+      def on_send(message); end
+
+      # Logs an error message
+      #
+      # @api private
+      #
+      # @param [String] message The error message.
+      #
+      # @return [void]
+      #
+      def on_error(message); end
+
+      # Logs a closure of connection with a relay
+      #
+      # @api private
+      #
+      # @param [String] code The closure code.
+      # @param [String] reason The reason for the closure.
+      #
+      # @return [void]
+      #
+      def on_close(code, reason); end
+    end
+  end
+end

data/lib/nostr/client/plain_logger.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Nostr
+  class Client
+    # Logs connection events, messages sent and received, errors, and connection closures.
+    class PlainLogger < Logger
+      # Logs connection to a relay
+      #
+      # @api private
+      #
+      # @param [Nostr::Relay] relay The relay the client connected to.
+      #
+      # @return [void]
+      #
+      def on_connect(relay)
+        puts "Connected to the relay #{relay.name} (#{relay.url})"
+      end
+
+      # Logs a message received from the relay
+      #
+      # @api private
+      #
+      # @param [String] message The message received.
+      #
+      # @return [void]
+      #
+      def on_message(message)
+        puts "◄- #{message}"
+      end
+
+      # Logs a message sent to the relay
+      #
+      # @api private
+      #
+      # @param [String] message The message sent.
+      #
+      # @return [void]
+      #
+      def on_send(message)
+        puts "-► #{message}"
+      end
+
+      # Logs an error message
+      #
+      # @api private
+      #
+      # @param [String] message The error message.
+      #
+      # @return [void]
+      #
+      def on_error(message)
+        puts "Error: #{message}"
+      end
+
+      # Logs a closure of connection with a relay
+      #
+      # @api private
+      #
+      # @param [String] code The closure code.
+      # @param [String] reason The reason for the closure.
+      #
+      # @return [void]
+      #
+      def on_close(code, reason)
+        puts "Connection closed: #{reason} (##{code})"
+      end
+    end
+  end
+end

data/lib/nostr/client.rb

@@ -18,11 +18,19 @@ module Nostr
     # @api public
     #
     # @example Instantiating a client that logs all the events it sends and receives
-    #   client = Nostr::Client.new(debug: true)
+    #   client = Nostr::Client.new
     #
-    def initialize
+    # @example Instantiating a client with no logging
+    #   client = Nostr::Client.new(logger: nil)
+    #
+    # @example Instantiating a client with your own logger
+    #   client = Nostr::Client.new(logger: YourLogger.new)
+    #
+    def initialize(logger: ColorLogger.new)
       @subscriptions = {}
+      @logger = logger
 
+      logger&.attach_to(self)
       initialize_channels
     end
 
@@ -40,11 +48,11 @@ module Nostr
     #
     def connect(relay)
       execute_within_an_em_thread do
-        client = Faye::WebSocket::Client.new(relay.url, [], { tls: { verify_peer: false } })
-        parent_to_child_channel.subscribe { |msg| client.send(msg) }
+        client = build_websocket_client(relay.url)
+        parent_to_child_channel.subscribe { |msg| client.send(msg) && emit(:send, msg) }
 
         client.on :open do
-          child_to_parent_channel.push(type: :open)
+          child_to_parent_channel.push(type: :open, relay:)
         end
 
         client.on :message do |event|
@@ -122,6 +130,14 @@ module Nostr
 
     private
 
+    # The logger that prints all the events that the client sends and receives
+    #
+    # @api private
+    #
+    # @return [ClientLogger]
+    #
+    attr_reader :logger
+
     # The subscriptions that the client has created
     #
     # @api private
@@ -167,11 +183,21 @@ module Nostr
       @child_to_parent_channel = EventMachine::Channel.new
 
       child_to_parent_channel.subscribe do |msg|
-        emit :connect                           if msg[:type] == :open
+        emit :connect, msg[:relay]              if msg[:type] == :open
         emit :message, msg[:data]               if msg[:type] == :message
         emit :error,   msg[:message]            if msg[:type] == :error
         emit :close,   msg[:code], msg[:reason] if msg[:type] == :close
       end
     end
+
+    # Builds a websocket client
+    #
+    # @api private
+    #
+    # @return [Faye::WebSocket::Client]
+    #
+    def build_websocket_client(relay_url)
+      Faye::WebSocket::Client.new(relay_url, [], { tls: { verify_peer: false } })
+    end
   end
 end

data/lib/nostr/crypto.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nostr
-  # Performs cryptographic operations on a +Nostr::Event+.
+  # Performs cryptographic operations.
   class Crypto
     # Numeric base of the OpenSSL big number used in an event content's encryption.
     #
@@ -90,17 +90,93 @@ module Nostr
     #
     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*')
+      signature = sign_message(event_digest, private_key)
 
       event.id = event_digest
-      event.sig = event_signature
+      event.sig = signature
 
       event
     end
 
+    # Signs a message using the Schnorr signature algorithm
+    #
+    # @api public
+    #
+    # @example Signing a message
+    #   crypto = Nostr::Crypto.new
+    #   message = 'Viva la libertad carajo'
+    #   private_key = Nostr::PrivateKey.new('7d1e4219a5e7d8342654c675085bfbdee143f0eb0f0921f5541ef1705a2b407d')
+    #   signature = crypto.sign_message(message, private_key)
+    #   signature # => 'b2115694a576f5bdcebf8c0951a3c7adcfbdb17b11cb9e6d6b7017691138bc6' \
+    #     '38fee642a7bd26f71b313a7057181294198900a9770d1435e43f182acf3d34c26'
+    #
+    # @param [String] message The message to be signed
+    # @param [PrivateKey] private_key The private key used for signing
+    #
+    # @return [Signature] A signature object containing the signature as a 64-byte hexadecimal string.
+    #
+    def sign_message(message, private_key)
+      hex_private_key = Array(private_key).pack('H*')
+      hex_message     = Array(message).pack('H*')
+      hex_signature   = Schnorr.sign(hex_message, hex_private_key).encode.unpack1('H*')
+
+      Signature.new(hex_signature.to_s)
+    end
+
+    # Verifies the given {Signature} and returns true if it is valid
+    #
+    # @api public
+    #
+    # @example Checking a signature
+    #   public_key = Nostr::PublicKey.new('15678d8fbc126fa326fac536acd5a6dcb5ef64b3d939abe31d6830cba6cd26d6')
+    #   private_key = Nostr::PrivateKey.new('7d1e4219a5e7d8342654c675085bfbdee143f0eb0f0921f5541ef1705a2b407d')
+    #   message = 'Viva la libertad carajo'
+    #   crypto = Nostr::Crypto.new
+    #   signature = crypto.sign_message(message, private_key)
+    #   valid = crypto.valid_sig?(message, public_key, signature)
+    #   valid # => true
+    #
+    # @see #check_sig!
+    #
+    # @param [String] message A message to be signed with binary format.
+    # @param [PublicKey] public_key The public key with binary format.
+    # @param [Signature] signature The signature with binary format.
+    #
+    # @return [Boolean] whether signature is valid.
+    #
+    def valid_sig?(message, public_key, signature)
+      signature = Schnorr::Signature.decode([signature].pack('H*'))
+      Schnorr.valid_sig?([message].pack('H*'), [public_key].pack('H*'), signature.encode)
+    end
+
+    # Verifies the given {Signature} and raises an +Schnorr::InvalidSignatureError+ if it is invalid
+    #
+    # @api public
+    #
+    # @example Checking a signature
+    #   public_key = Nostr::PublicKey.new('15678d8fbc126fa326fac536acd5a6dcb5ef64b3d939abe31d6830cba6cd26d6')
+    #   private_key = Nostr::PrivateKey.new('7d1e4219a5e7d8342654c675085bfbdee143f0eb0f0921f5541ef1705a2b407d')
+    #   message = 'Viva la libertad carajo'
+    #   crypto = Nostr::Crypto.new
+    #   signature = crypto.sign_message(message, private_key)
+    #   valid = crypto.valid_sig?(message, public_key, signature)
+    #   valid # => true
+    #
+    # @see #valid_sig?
+    #
+    # @param [String] message A message to be signed with binary format.
+    # @param [PublicKey] public_key The public key with binary format.
+    # @param [Signature] signature The signature with binary format.
+    #
+    # @raise [Schnorr::InvalidSignatureError] if the signature is invalid.
+    #
+    # @return [Boolean] whether signature is valid.
+    #
+    def check_sig!(message, public_key, signature)
+      signature = Schnorr::Signature.decode([signature].pack('H*'))
+      Schnorr.check_sig!([message].pack('H*'), [public_key].pack('H*'), signature.encode)
+    end
+
     private
 
     # Finds a shared key between two keys

data/lib/nostr/errors/invalid_key_format_error.rb

@@ -9,7 +9,7 @@ module Nostr
     # Initializes the error
     #
     # @example
-    #   InvalidKeyFormatError.new('private'')
+    #   InvalidKeyFormatError.new('private')
     #
     # @param [String] key_kind The kind of key that is invalid (public or private)
     #

data/lib/nostr/errors/invalid_key_length_error.rb

@@ -9,7 +9,7 @@ module Nostr
     # Initializes the error
     #
     # @example
-    #   InvalidKeyLengthError.new('private'')
+    #   InvalidKeyLengthError.new('private')
     #
     # @param [String] key_kind The kind of key that is invalid (public or private)
     #

data/lib/nostr/errors/invalid_key_type_error.rb

@@ -9,7 +9,7 @@ module Nostr
     # Initializes the error
     #
     # @example
-    #   InvalidKeyTypeError.new('private'')
+    #   InvalidKeyTypeError.new('private')
     #
     # @param [String] key_kind The kind of key that is invalid (public or private)
     #

data/lib/nostr/errors/invalid_signature_format_error.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Nostr
+  # Raised when the signature is in an invalid format
+  #
+  # @api public
+  #
+  class InvalidSignatureFormatError < SignatureValidationError
+    # Initializes the error
+    #
+    # @example
+    #   InvalidSignatureFormatError.new
+    #
+    def initialize
+      super('Only lowercase hexadecimal characters are allowed in signatures.')
+    end
+  end
+end

data/lib/nostr/errors/invalid_signature_length_error.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Nostr
+  # Raised when the signature's length is not 128 characters
+  #
+  # @api public
+  #
+  class InvalidSignatureLengthError < SignatureValidationError
+    # Initializes the error
+    #
+    # @example
+    #   InvalidSignatureLengthError.new
+    #
+    def initialize
+      super('Invalid signature length. It should have 128 characters.')
+    end
+  end
+end

data/lib/nostr/errors/invalid_signature_type_error.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Nostr
+  # Raised when the signature is not a string
+  #
+  # @api public
+  #
+  class InvalidSignatureTypeError < SignatureValidationError
+    # Initializes the error
+    #
+    # @example
+    #   InvalidSignatureTypeError.new
+    #
+    def initialize = super('Invalid signature type. It must be a string with lowercase hexadecimal characters.')
+  end
+end

data/lib/nostr/errors/signature_validation_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Nostr
+  # Base class for all signature validation errors
+  class SignatureValidationError < Error; end
+end

data/lib/nostr/errors.rb

@@ -6,3 +6,7 @@ require_relative 'errors/invalid_hrp_error'
 require_relative 'errors/invalid_key_type_error'
 require_relative 'errors/invalid_key_length_error'
 require_relative 'errors/invalid_key_format_error'
+require_relative 'errors/signature_validation_error'
+require_relative 'errors/invalid_signature_type_error'
+require_relative 'errors/invalid_signature_length_error'
+require_relative 'errors/invalid_signature_format_error'

data/lib/nostr/event.rb

@@ -100,15 +100,15 @@ module Nostr
     #
     # @example Instantiating a new event
     #   Nostr::Event.new(
-    #    id: 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460',
-    #    pubkey: '48df4af6e240ac5f7c5de89bf5941b249880be0e87d03685b178ccb1a315f52e',
-    #    created_at: 1230981305,
-    #    kind: 1,
-    #    tags: [],
-    #    content: 'Your feedback is appreciated, now pay $8',
-    #    sig: '123ac2923b792ce730b3da34f16155470ab13c8f97f9c53eaeb334f1fb3a5dc9a7f643
-    #          937c6d6e9855477638f5655c5d89c9aa5501ea9b578a66aced4f1cd7b3'
-    # )
+    #     id: 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460',
+    #     pubkey: '48df4af6e240ac5f7c5de89bf5941b249880be0e87d03685b178ccb1a315f52e',
+    #     created_at: 1230981305,
+    #     kind: 1,
+    #     tags: [],
+    #     content: 'Your feedback is appreciated, now pay $8',
+    #     sig: '123ac2923b792ce730b3da34f16155470ab13c8f97f9c53eaeb334f1fb3a5dc9a7f643
+    #           937c6d6e9855477638f5655c5d89c9aa5501ea9b578a66aced4f1cd7b3'
+    #   )
     #
     # @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
@@ -181,6 +181,33 @@ module Nostr
       crypto.sign_event(self, private_key)
     end
 
+    # Verifies if the signature of the event is valid. A valid signature means that the event was signed by the owner
+    #
+    # @api public
+    #
+    # @example Verifying the signature of an event
+    #   event = Nostr::Event.new(
+    #     id: '90b75b78daf883ae57fbcc414d43faa028560b3211ee58e4ea82bf395bb82042',
+    #     pubkey: Nostr::PublicKey.new('2d7661527d573cc8e84f665fa971dd969ba51e2526df00c149ff8e40a58f9558'),
+    #     created_at: 1667422587,
+    #     kind: Nostr::EventKind::TEXT_NOTE,
+    #     content: 'Your feedback is appreciated, now pay $8',
+    #     sig: '32f18adebe942e19b171c1c7d2fb27ce794dfea4155e289dca7952b43ed1ec39' \
+    #       '1d3dc198ba2761bc6d40c737a6eaf4edcc8963acabd3bfcebd04f16637025bdc'
+    #   )
+    #
+    #   event.verify_signature # => true
+    #
+    # @return [Boolean] Whether the signature is valid or not.
+    #
+    def verify_signature
+      crypto = Crypto.new
+
+      return false if id.nil? || pubkey.nil? || sig.nil?
+
+      crypto.valid_sig?(id, pubkey, sig)
+    end
+
     # Serializes the event, to obtain a SHA256 digest of it
     #
     # @api public

data/lib/nostr/event_kind.rb

@@ -21,6 +21,7 @@ module Nostr
     # The content is set to the URL (e.g., wss://somerelay.com) of a relay the event creator wants to
     # recommend to its followers.
     #
+    # @deprecated This event kind was removed in https://github.com/nostr-protocol/nips/pull/703/files#diff-39307f1617417657ee9874be314f13aabdc74401b124d0afe8217f2919c9c7d8L105
     # @return [Integer]
     #
     RECOMMEND_SERVER = 2

data/lib/nostr/events/encrypted_direct_message.rb

@@ -11,19 +11,19 @@ module Nostr
       # @api public
       #
       # @example Instantiating a new encrypted direct message
-      #   Nostr::Events::EncryptedDirectMessage.new(
+      #  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(
+      #  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 [PrivateKey] 32-bytes hex-encoded private key of the message's author.

data/lib/nostr/filter.rb

@@ -133,13 +133,16 @@ module Nostr
     # @api public
     #
     # @example
-    #   filter.to_h # => {:ids=>["c24881c305c5cfb7c1168be7e9b0e150"],
-    #    :authors=>["000000001c5c45196786e79f83d21fe801549fdc98e2c26f96dcef068a5dbcd7"],
-    #    :kinds=>[0, 1, 2],
-    #    :"#e"=>["7bdb422f254194ae4bb86d354c0bd5a888fce233ffc77dceb3e844ceec1fcfb2"],
-    #    :"#p"=>["000000001c5c45196786e79f83d21fe801549fdc98e2c26f96dcef068a5dbcd7"],
-    #    :since=>1230981305,
-    #    :until=>1292190341}
+    #   filter.to_h # =>
+    #   {
+    #      ids: ['c24881c305c5cfb7c1168be7e9b0e150'],
+    #      authors: ['000000001c5c45196786e79f83d21fe801549fdc98e2c26f96dcef068a5dbcd7'],
+    #      kinds: [0, 1, 2],
+    #      '#e': ['7bdb422f254194ae4bb86d354c0bd5a888fce233ffc77dceb3e844ceec1fcfb2'],
+    #      '#p': ['000000001c5c45196786e79f83d21fe801549fdc98e2c26f96dcef068a5dbcd7'],
+    #      since: 1230981305,
+    #      until: 1292190341
+    #   }
     #
     # @return [Hash] The filter as a hash.
     #

data/lib/nostr/key.rb

@@ -18,14 +18,14 @@ module Nostr
     #
     LENGTH = 64
 
-    # Instantiates a new key. Can't be used directly because this is an abstract class. Raises a +ValidationError+
+    # Instantiates a new key. Can't be used directly because this is an abstract class. Raises a +KeyValidationError+
     #
     # @see Nostr::PrivateKey
     # @see Nostr::PublicKey
     #
     # @param [String] hex_value Hex-encoded value of the key
     #
-    # @raise [ValidationError]
+    # @raise [KeyValidationError]
     #
     def initialize(hex_value)
       validate_hex_value(hex_value)