nostr 0.5.0 → 0.7.0

data/lib/nostr/key_pair.rb

@@ -38,8 +38,8 @@ module Nostr
     # @param private_key [PrivateKey] 32-bytes hex-encoded private key.
     # @param public_key [PublicKey] 32-bytes hex-encoded public key.
     #
-    # @raise ArgumentError when the private key is not a +PrivateKey+
-    # @raise ArgumentError when the public key is not a +PublicKey+
+    # @raise ArgumentError when the private key is not a {PrivateKey}
+    # @raise ArgumentError when the public key is not a {PublicKey}
     #
     def initialize(private_key:, public_key:)
       validate_keys(private_key, public_key)
@@ -48,6 +48,30 @@ module Nostr
       @public_key = public_key
     end
 
+    # Allows array destructuring of the KeyPair, enabling the extraction of +PrivateKey+ and +PublicKey+ separately
+    #
+    # @api public
+    #
+    # @example Implicit usage of `to_ary` for destructuring
+    #   keypair = Nostr::KeyPair.new(
+    #     private_key: Nostr::PrivateKey.new('7d1e4219a5e7d8342654c675085bfbdee143f0eb0f0921f5541ef1705a2b407d'),
+    #     public_key: Nostr::PublicKey.new('15678d8fbc126fa326fac536acd5a6dcb5ef64b3d939abe31d6830cba6cd26d6'),
+    #   )
+    #   # The `to_ary` method can be implicitly used for array destructuring:
+    #   private_key, public_key = keypair
+    #   # Now `private_key` and `public_key` hold the respective values.
+    #
+    # @example Explicit usage of `to_ary`
+    #   array_representation = keypair.to_ary
+    #   # array_representation is now an array: [PrivateKey, PublicKey]
+    #   # where PrivateKey and PublicKey are the respective objects.
+    #
+    # @return [Array<PrivateKey, PublicKey>] An array containing the {PrivateKey} and {PublicKey} in that order
+    #
+    def to_ary
+      [private_key, public_key]
+    end
+
     private
 
     # Validates the keys

data/lib/nostr/keygen.rb

@@ -22,7 +22,7 @@ module Nostr
     # @api public
     #
     # @example
-    #   keypair = keygen.generate_keypair
+    #   keypair = keygen.generate_key_pair
     #   keypair # #<Nostr::KeyPair:0x0000000107bd3550
     #    @private_key="893c4cc8088924796b41dc788f7e2f746734497010b1a9f005c1faad7074b900",
     #    @public_key="2d7661527d573cc8e84f665fa971dd969ba51e2526df00c149ff8e40a58f9558">

data/lib/nostr/signature.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Nostr
+  # 64-bytes lowercase hex of the signature of the sha256 hash of the serialized event data,
+  # which is the same as the "id" field
+  class Signature < String
+    # The regular expression for hexadecimal lowercase characters
+    #
+    # @return [Regexp] The regular expression for hexadecimal lowercase characters
+    #
+    FORMAT = /^[a-f0-9]+$/
+
+    # The length of the signature in hex format
+    #
+    # @return [Integer] The length of the signature in hex format
+    #
+    LENGTH = 128
+
+    # Instantiates a new Signature
+    #
+    # @api public
+    #
+    # @example Instantiating a new signature
+    #  Nostr::Signature.new(
+    #    'f418c97b50cc68227e82f4f3a79d79eb2b7a0fa517859c86e1a8fa91e3741b7f' \
+    #    '06e070c44129227b83fcbe93cecb02a346804a4080ce47685ecad60ab4f5f128'
+    #  )
+    #
+    # @param [String] hex_value Hex-encoded value of the signature
+    #
+    # @raise [SignatureValidationError]
+    #
+    def initialize(hex_value)
+      validate(hex_value)
+
+      super(hex_value)
+    end
+
+    private
+
+    # Hex-encoded value of the signature
+    #
+    # @api private
+    #
+    # @return [String] hex_value Hex-encoded value of the signature
+    #
+    attr_reader :hex_value
+
+    # Validates the hex value of the signature
+    #
+    # @api private
+    #
+    # @param [String] hex_value The signature in hex format
+    #
+    # @raise InvalidSignatureTypeError when the signature is not a string
+    # @raise InvalidSignatureLengthError when the signature's length is not 128 characters
+    # @raise InvalidSignatureFormatError when the signature is in an invalid format
+    #
+    # @return [void]
+    #
+    def validate(hex_value)
+      raise InvalidSignatureTypeError   unless hex_value.is_a?(String)
+      raise InvalidSignatureLengthError unless hex_value.size == LENGTH
+      raise InvalidSignatureFormatError unless hex_value.match(FORMAT)
+    end
+  end
+end

data/lib/nostr/version.rb

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

data/lib/nostr.rb

@@ -12,9 +12,12 @@ require_relative 'nostr/relay'
 require_relative 'nostr/relay_message_type'
 require_relative 'nostr/key_pair'
 require_relative 'nostr/event_kind'
+require_relative 'nostr/signature'
 require_relative 'nostr/event'
 require_relative 'nostr/events/encrypted_direct_message'
 require_relative 'nostr/client'
+require_relative 'nostr/client/logger'
+require_relative 'nostr/client/color_logger'
 require_relative 'nostr/user'
 require_relative 'nostr/key'
 require_relative 'nostr/private_key'

data/nostr.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description = 'Client and relay implementation of the Nostr protocol.'
   spec.homepage = 'https://nostr-ruby.com/'
   spec.license = 'MIT'
-  spec.required_ruby_version = '>= 3.2.0'
+  spec.required_ruby_version = '>= 3.3.0'
   spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.metadata['homepage_uri'] = spec.homepage
@@ -32,32 +32,32 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'bech32', '~> 1.4'
-  spec.add_dependency 'bip-schnorr', '~> 0.6'
+  spec.add_dependency 'bip-schnorr', '~> 0.7'
   spec.add_dependency 'ecdsa', '~> 1.2'
   spec.add_dependency 'event_emitter', '~> 0.2'
   spec.add_dependency 'faye-websocket', '~> 0.11'
-  spec.add_dependency 'json', '~> 2.6'
+  spec.add_dependency 'json', '~> 2.7'
 
   spec.add_development_dependency 'bundler-audit', '~> 0.9'
-  spec.add_development_dependency 'dotenv', '~> 2.8'
+  spec.add_development_dependency 'dotenv', '~> 3.1'
   spec.add_development_dependency 'guard', '~> 2.18'
   spec.add_development_dependency 'guard-bundler', '~> 3.0'
   spec.add_development_dependency 'guard-bundler-audit', '~> 0.1'
   spec.add_development_dependency 'guard-rspec', '~> 4.7'
   spec.add_development_dependency 'guard-rubocop', '~> 1.5'
-  spec.add_development_dependency 'overcommit', '~> 0.59'
+  spec.add_development_dependency 'overcommit', '~> 0.63'
   spec.add_development_dependency 'pry', '~> 0.14'
   spec.add_development_dependency 'puma', '~> 6.4'
   spec.add_development_dependency 'rack', '~> 3.0'
   spec.add_development_dependency 'rake', '~> 13.1'
-  spec.add_development_dependency 'rbs', '~> 3.3'
-  spec.add_development_dependency 'rspec', '~> 3.12'
-  spec.add_development_dependency 'rubocop', '~> 1.57'
+  spec.add_development_dependency 'rbs', '~> 3.4'
+  spec.add_development_dependency 'rspec', '~> 3.13'
+  spec.add_development_dependency 'rubocop', '~> 1.62'
   spec.add_development_dependency 'rubocop-rake', '~> 0.6'
-  spec.add_development_dependency 'rubocop-rspec', '2.25'
+  spec.add_development_dependency 'rubocop-rspec', '2.29'
   spec.add_development_dependency 'simplecov', '= 0.17'
   spec.add_development_dependency 'simplecov-console', '~> 0.9'
-  spec.add_development_dependency 'steep', '~> 1.6'
+  spec.add_development_dependency 'steep', '~> 1.7.dev3'
   spec.add_development_dependency 'typeprof', '~> 0.21'
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'yard-junk', '~> 0.0.9'

data/sig/nostr/client/color_logger.rbs

@@ -0,0 +1,6 @@
+module Nostr
+  class Client
+    class ColorLogger < Logger
+    end
+  end
+end

data/sig/nostr/client/logger.rbs

@@ -0,0 +1,12 @@
+module Nostr
+  class Client
+    class Logger
+      def attach_to: (Client client) -> void
+      def on_connect: (Relay relay) -> void
+      def on_message: (String message) -> void
+      def on_send: (String message) -> void
+      def on_error: (String message) -> void
+      def on_close: (String code, String reason) -> void
+    end
+  end
+end

data/sig/nostr/client/plain_logger.rbs

@@ -0,0 +1,6 @@
+module Nostr
+  class Client
+    class PlainLogger < Logger
+    end
+  end
+end

data/sig/nostr/client.rbs

@@ -10,11 +10,13 @@ module Nostr
 
     private
 
+    attr_reader logger: Logger
     attr_reader subscriptions: Hash[String, Subscription]
     attr_reader parent_to_child_channel: EventMachine::Channel
     attr_reader child_to_parent_channel: EventMachine::Channel
 
     def execute_within_an_em_thread: { -> void } -> Thread
     def initialize_channels: -> void
+    def build_websocket_client: (String relay_name) -> Faye::WebSocket::Client
   end
 end

data/sig/nostr/crypto.rbs

@@ -7,6 +7,9 @@ module Nostr
     def encrypt_text: (PrivateKey, PublicKey, String) -> String
     def decrypt_text: (PrivateKey, PublicKey, String) -> String
     def sign_event: (Event, PrivateKey) -> Event
+    def sign_message: (String, PrivateKey) -> Signature
+    def valid_sig?: (String, PublicKey, Signature) -> bool
+    def check_sig!: (String, PublicKey, Signature) -> bool
 
     private
 

data/sig/nostr/errors/invalid_signature_format_error.rbs

@@ -0,0 +1,5 @@
+module Nostr
+  class InvalidSignatureFormatError < SignatureValidationError
+    def initialize: -> void
+  end
+end

data/sig/nostr/errors/invalid_signature_length_error.rbs

@@ -0,0 +1,5 @@
+module Nostr
+  class InvalidSignatureLengthError < SignatureValidationError
+    def initialize: -> void
+  end
+end

data/sig/nostr/errors/invalid_signature_type_error.rbs

@@ -0,0 +1,5 @@
+module Nostr
+  class InvalidSignatureTypeError < SignatureValidationError
+    def initialize: -> void
+  end
+end

data/sig/nostr/errors/signature_validation_error.rbs

@@ -0,0 +1,4 @@
+module Nostr
+  class SignatureValidationError < Error
+  end
+end

data/sig/nostr/event.rbs

@@ -5,8 +5,8 @@ module Nostr
     attr_reader kind: Integer
     attr_reader tags: Array[Array[String]]
     attr_reader content: String
-    attr_accessor id: String?|nil
-    attr_accessor sig: String?|nil
+    attr_accessor id: String?
+    attr_accessor sig: Signature?
 
     def initialize: (
       pubkey: PublicKey,
@@ -14,24 +14,25 @@ module Nostr
       content: String,
       ?created_at: Integer,
       ?tags: Array[Array[String]],
-      ?id: String|nil,
-      ?sig: String|nil
+      ?id: String?,
+      ?sig: Signature?
     ) -> void
 
     def serialize: -> [Integer, String, Integer, Integer, Array[Array[String]], String]
 
     def to_h: -> {
-      id: String?|nil,
+      id: String?,
       pubkey: String,
       created_at: Integer,
       kind: Integer,
       tags: Array[Array[String]],
       content: String,
-      sig: String?|nil
+      sig: String?
     }
     def ==: (Event other) -> bool
 
     def sign:(PrivateKey) -> Event
+    def verify_signature: -> bool
 
     def add_event_reference: (String) -> Array[Array[String]]
     def add_pubkey_reference: (PublicKey) -> Array[Array[String]]

data/sig/nostr/key_pair.rbs

@@ -5,6 +5,7 @@ module Nostr
     attr_reader public_key: PublicKey
 
     def initialize: (private_key: PrivateKey, public_key: PublicKey) -> void
+    def to_ary: -> [PrivateKey, PublicKey]
 
     private
 

data/sig/nostr/signature.rbs

@@ -0,0 +1,14 @@
+module Nostr
+  class Signature < String
+    FORMAT: Regexp
+    LENGTH: int
+
+    def initialize: (String) -> void
+
+    private
+
+    attr_reader hex_value: String
+
+    def validate: (String) -> nil
+  end
+end

data/sig/vendor/event_emitter.rbs

@@ -1,16 +1,14 @@
 # Added only to satisfy the Steep requirements. Not 100% reliable.
 module EventEmitter
-  interface _Event
-    def data: -> String
-    def message: -> String
-    def code: -> Integer
-    def reason: -> String
-  end
+  def self.included: (Module) -> void
+  def self.apply: (untyped) -> void
 
-  def add_listener: (Symbol event_name) { (_Event event) -> void } -> void
+  def __events: () -> Array[untyped]
+
+  def add_listener: (Symbol | String type, ?Hash[untyped, untyped] params) { (*untyped) -> void } -> Integer
   alias on add_listener
+  alias once add_listener
 
-  def remove_listener: (untyped id_or_type) -> Array[untyped]?
-  def emit: (Symbol `type`, *untyped data) -> Array[untyped]
-  def once: (Symbol `type`) -> Integer
+  def remove_listener: (Integer | Symbol | String id_or_type) -> void
+  def emit: (Symbol | String type, *untyped data) -> void
 end

data/sig/vendor/schnorr/signature.rbs

@@ -0,0 +1,16 @@
+# Added only to satisfy the Steep requirements. Not 100% reliable.
+module Schnorr
+  class InvalidSignatureError < StandardError
+  end
+
+  class Signature
+    attr_reader r: Integer
+    attr_reader s: Integer
+
+    def self.decode: (String string) -> Signature
+
+    def initialize: (Integer r, Integer s) -> void
+    def encode: -> String
+    def ==: (untyped other) -> bool
+  end
+end

data/sig/vendor/schnorr.rbs

@@ -1,4 +1,6 @@
 # Added only to satisfy the Steep requirements. Not 100% reliable.
 module Schnorr
-  def self.sign: (String message, String private_key, ?String aux_rand) -> untyped
+  def self.sign: (String message, String private_key, ?String aux_rand) -> Signature
+  def self.valid_sig?: (String message, String public_key, String signature) -> bool
+  def self.check_sig!: (String message, String public_key, String signature) -> bool
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nostr
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Wilson Silva
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-20 00:00:00.000000000 Z
+date: 2024-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bech32
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: ecdsa
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -198,14 +198,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: '0.63'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: '0.63'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -268,42 +268,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.57'
+        version: '1.62'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.57'
+        version: '1.62'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -324,14 +324,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '2.25'
+        version: '2.29'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '2.25'
+        version: '2.29'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -366,14 +366,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.7.dev3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 1.7.dev3
 - !ruby/object:Gem::Dependency
   name: typeprof
   requirement: !ruby/object:Gem::Requirement
@@ -437,6 +437,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".adr-dir"
 - ".editorconfig"
 - ".overcommit.yml"
 - ".rspec"
@@ -452,12 +453,20 @@ files:
 - README.md
 - Rakefile
 - Steepfile
+- adr/0001-record-architecture-decisions.md
+- adr/0002-introduction-of-signature-class.md
+- adr/0003-logging-methods-vs-logger-class.md
+- adr/0004-default-logging-activation.md
+- adr/0005-logger-types.md
 - docs/.gitignore
 - docs/.vitepress/config.mjs
 - docs/README.md
 - docs/api-examples.md
 - docs/bun.lockb
 - docs/common-use-cases/bech32-encoding-and-decoding-(NIP-19).md
+- docs/common-use-cases/logging-and-debugging.md
+- docs/common-use-cases/signing-and-verifying-events.md
+- docs/common-use-cases/signing-and-verifying-messages.md
 - docs/core/client.md
 - docs/core/keys.md
 - docs/core/user.md
@@ -483,6 +492,9 @@ files:
 - lib/nostr.rb
 - lib/nostr/bech32.rb
 - lib/nostr/client.rb
+- lib/nostr/client/color_logger.rb
+- lib/nostr/client/logger.rb
+- lib/nostr/client/plain_logger.rb
 - lib/nostr/client_message_type.rb
 - lib/nostr/crypto.rb
 - lib/nostr/errors.rb
@@ -491,7 +503,11 @@ files:
 - lib/nostr/errors/invalid_key_format_error.rb
 - lib/nostr/errors/invalid_key_length_error.rb
 - lib/nostr/errors/invalid_key_type_error.rb
+- lib/nostr/errors/invalid_signature_format_error.rb
+- lib/nostr/errors/invalid_signature_length_error.rb
+- lib/nostr/errors/invalid_signature_type_error.rb
 - lib/nostr/errors/key_validation_error.rb
+- lib/nostr/errors/signature_validation_error.rb
 - lib/nostr/event.rb
 - lib/nostr/event_kind.rb
 - lib/nostr/events/encrypted_direct_message.rb
@@ -503,6 +519,7 @@ files:
 - lib/nostr/public_key.rb
 - lib/nostr/relay.rb
 - lib/nostr/relay_message_type.rb
+- lib/nostr/signature.rb
 - lib/nostr/subscription.rb
 - lib/nostr/user.rb
 - lib/nostr/version.rb
@@ -510,6 +527,9 @@ files:
 - sig/nostr.rbs
 - sig/nostr/bech32.rbs
 - sig/nostr/client.rbs
+- sig/nostr/client/color_logger.rbs
+- sig/nostr/client/logger.rbs
+- sig/nostr/client/plain_logger.rbs
 - sig/nostr/client_message_type.rbs
 - sig/nostr/crypto.rbs
 - sig/nostr/errors/error.rbs
@@ -517,7 +537,11 @@ files:
 - sig/nostr/errors/invalid_key_format_error.rbs
 - sig/nostr/errors/invalid_key_length_error.rbs
 - sig/nostr/errors/invalid_key_type_error.rbs
+- sig/nostr/errors/invalid_signature_format_error.rbs
+- sig/nostr/errors/invalid_signature_length_error.rbs
+- sig/nostr/errors/invalid_signature_type_error.rbs
 - sig/nostr/errors/key_validation_error.rbs
+- sig/nostr/errors/signature_validation_error.rbs
 - sig/nostr/event.rbs
 - sig/nostr/event_kind.rbs
 - sig/nostr/events/encrypted_direct_message.rbs
@@ -529,6 +553,7 @@ files:
 - sig/nostr/public_key.rbs
 - sig/nostr/relay.rbs
 - sig/nostr/relay_message_type.rbs
+- sig/nostr/signature.rbs
 - sig/nostr/subscription.rbs
 - sig/nostr/user.rbs
 - sig/vendor/bech32.rbs
@@ -543,6 +568,7 @@ files:
 - sig/vendor/faye/websocket/api.rbs
 - sig/vendor/faye/websocket/client.rbs
 - sig/vendor/schnorr.rbs
+- sig/vendor/schnorr/signature.rbs
 homepage: https://nostr-ruby.com/
 licenses:
 - MIT
@@ -559,14 +585,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Client and relay implementation of the Nostr protocol.