nostr 0.4.0 → 0.5.0

data/lib/nostr/keygen.rb

@@ -44,10 +44,11 @@ module Nostr
     #   private_key = keygen.generate_private_key
     #   private_key # => '893c4cc8088924796b41dc788f7e2f746734497010b1a9f005c1faad7074b900'
     #
-    # @return [String] A 32-bytes hex-encoded private key.
+    # @return [PrivateKey] A 32-bytes hex-encoded private key.
     #
     def generate_private_key
-      (SecureRandom.random_number(group.order - 1) + 1).to_s(16)
+      hex_value = (SecureRandom.random_number(group.order - 1) + 1).to_s(16).rjust(64, '0')
+      PrivateKey.new(hex_value)
     end
 
     # Extracts a public key from a private key
@@ -59,10 +60,36 @@ module Nostr
     #   public_key = keygen.extract_public_key(private_key)
     #   public_key # => '2d7661527d573cc8e84f665fa971dd969ba51e2526df00c149ff8e40a58f9558'
     #
-    # @return [String] A 32-bytes hex-encoded public key.
+    # @param [PrivateKey] private_key A 32-bytes hex-encoded private key.
+    #
+    # @raise [ArgumentError] if the private key is not an instance of +PrivateKey+
+    #
+    # @return [PublicKey] 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).rjust(64, '0')
+      validate_private_key(private_key)
+      hex_value = group.generator.multiply_by_scalar(private_key.to_i(16)).x.to_s(16).rjust(64, '0')
+      PublicKey.new(hex_value)
+    end
+
+    # Builds a key pair from an existing private key
+    #
+    # @api public
+    #
+    # @example
+    #   private_key = Nostr::PrivateKey.new('893c4cc8088924796b41dc788f7e2f746734497010b1a9f005c1faad7074b900')
+    #   keygen.get_key_pair_from_private_key(private_key)
+    #
+    # @param private_key [PrivateKey] 32-bytes hex-encoded private key.
+    #
+    # @raise [ArgumentError] if the private key is not an instance of +PrivateKey+
+    #
+    # @return [Nostr::KeyPair]
+    #
+    def get_key_pair_from_private_key(private_key)
+      validate_private_key(private_key)
+      public_key = extract_public_key(private_key)
+      KeyPair.new(private_key:, public_key:)
     end
 
     private
@@ -74,5 +101,17 @@ module Nostr
     # @return [ECDSA::Group]
     #
     attr_reader :group
+
+    # Validates that the private key is an instance of +PrivateKey+
+    #
+    # @api private
+    #
+    # @raise [ArgumentError] if the private key is not an instance of +PrivateKey+
+    #
+    # @return [void]
+    #
+    def validate_private_key(private_key)
+      raise ArgumentError, 'private_key is not an instance of PrivateKey' unless private_key.is_a?(Nostr::PrivateKey)
+    end
   end
 end

data/lib/nostr/private_key.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Nostr
+  # 32-bytes lowercase hex-encoded private key
+  class PrivateKey < Key
+    # Human-readable part of the Bech32 encoded address
+    #
+    # @api private
+    #
+    # @return [String] The human-readable part of the Bech32 encoded address
+    #
+    def self.hrp
+      'nsec'
+    end
+
+    private
+
+    # Validates the hex value of the private key
+    #
+    # @api private
+    #
+    # @param [String] hex_value The private key in hex format
+    #
+    # @raise InvalidKeyTypeError when the private key is not a string
+    # @raise InvalidKeyLengthError when the private key's length is not 64 characters
+    # @raise InvalidKeyFormatError when the private key is in an invalid format
+    #
+    # @return [void]
+    #
+    def validate_hex_value(hex_value)
+      raise InvalidKeyTypeError, 'private'   unless hex_value.is_a?(String)
+      raise InvalidKeyLengthError, 'private' unless hex_value.size == Key::LENGTH
+      raise InvalidKeyFormatError, 'private' unless hex_value.match(Key::FORMAT)
+    end
+  end
+end

data/lib/nostr/public_key.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Nostr
+  # 32-bytes lowercase hex-encoded public key
+  class PublicKey < Key
+    # Human-readable part of the Bech32 encoded address
+    #
+    # @api private
+    #
+    # @return [String] The human-readable part of the Bech32 encoded address
+    #
+    def self.hrp
+      'npub'
+    end
+
+    private
+
+    # Validates the hex value of the public key
+    #
+    # @api private
+    #
+    # @param [String] hex_value The public key in hex format
+    #
+    # @raise InvalidKeyTypeError when the public key is not a string
+    # @raise InvalidKeyLengthError when the public key's length is not 64 characters
+    # @raise InvalidKeyFormatError when the public key is in an invalid format
+    #
+    # @return [void]
+    #
+    def validate_hex_value(hex_value)
+      raise InvalidKeyTypeError, 'public' unless hex_value.is_a?(String)
+      raise InvalidKeyLengthError, 'public' unless hex_value.size == Key::LENGTH
+      raise InvalidKeyFormatError, 'public' unless hex_value.match(Key::FORMAT)
+    end
+  end
+end

data/lib/nostr/relay_message_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Nostr
+  # Clients can send 4 types of messages, which must be JSON arrays
+  module RelayMessageType
+    # @return [String] Used to notify clients all stored events have been sent
+    EOSE = 'EOSE'
+
+    # @return [String] Used to send events requested to clients
+    EVENT = 'EVENT'
+
+    # @return [String] Used to send human-readable messages to clients
+    NOTICE = 'NOTICE'
+
+    # @return [String] Used to notify clients if an EVENT was successful
+    OK = 'OK'
+  end
+end

data/lib/nostr/subscription.rb

@@ -5,7 +5,7 @@ require 'securerandom'
 module Nostr
   # A subscription the result of a request to receive events from a relay
   class Subscription
-    # A random string that should be used to represent a subscription
+    # An arbitrary, non-empty string of max length 64 chars used to represent a subscription
     #
     # @api public
     #
@@ -41,7 +41,7 @@ module Nostr
     # @example Subscribing to all events created after a certain time
     #   subscription = Nostr::Subscription.new(filter: Nostr::Filter.new(since: 1230981305))
     #
-    # @param id [String] A random string that should be used to represent a subscription
+    # @param id [String] An arbitrary, non-empty string of max length 64 chars used to represent a subscription
     # @param filter [Filter] An object that determines what events will be sent in that subscription
     #
     def initialize(filter:, id: SecureRandom.hex)

data/lib/nostr/user.rb

@@ -47,17 +47,26 @@ module Nostr
     #     content: 'Your feedback is appreciated, now pay $8'
     #   )
     #
-    # @param event_attributes [Hash]
-    # @option event_attributes [String] :pubkey 32-bytes hex-encoded public key of the event creator.
-    # @option event_attributes [Integer] :created_at Date of the creation of the vent. A UNIX timestamp, in seconds.
-    # @option event_attributes [Integer] :kind The kind of the event. An integer from 0 to 3.
-    # @option event_attributes [Array<Array>] :tags  An array of tags. Each tag is an array of strings.
-    # @option event_attributes [String] :content Arbitrary string.
+    # @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.
     #
     # @return [Event]
     #
-    def create_event(event_attributes)
-      event = Event.new(**event_attributes.merge(pubkey: keypair.public_key))
+    def create_event(
+      kind:,
+      content:,
+      created_at: Time.now.to_i,
+      tags: []
+    )
+      event = Event.new(
+        pubkey: keypair.public_key,
+        kind:,
+        content:,
+        created_at:,
+        tags:
+      )
       event.sign(keypair.private_key)
     end
   end

data/lib/nostr/version.rb

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

data/lib/nostr.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'nostr/errors'
+require_relative 'nostr/bech32'
 require_relative 'nostr/crypto'
 require_relative 'nostr/version'
 require_relative 'nostr/keygen'
@@ -7,12 +9,16 @@ require_relative 'nostr/client_message_type'
 require_relative 'nostr/filter'
 require_relative 'nostr/subscription'
 require_relative 'nostr/relay'
+require_relative 'nostr/relay_message_type'
 require_relative 'nostr/key_pair'
 require_relative 'nostr/event_kind'
 require_relative 'nostr/event'
 require_relative 'nostr/events/encrypted_direct_message'
 require_relative 'nostr/client'
 require_relative 'nostr/user'
+require_relative 'nostr/key'
+require_relative 'nostr/private_key'
+require_relative 'nostr/public_key'
 
 # Encapsulates all the gem's logic
 module Nostr

data/nostr.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 
   spec.summary = 'Client and relay implementation of the Nostr protocol.'
   spec.description = 'Client and relay implementation of the Nostr protocol.'
-  spec.homepage = 'https://github.com/wilsonsilva/nostr'
+  spec.homepage = 'https://nostr-ruby.com/'
   spec.license = 'MIT'
   spec.required_ruby_version = '>= 3.2.0'
   spec.metadata['rubygems_mfa_required'] = 'true'
@@ -31,8 +31,8 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'bech32', '~> 1.3'
-  spec.add_dependency 'bip-schnorr', '~> 0.4'
+  spec.add_dependency 'bech32', '~> 1.4'
+  spec.add_dependency 'bip-schnorr', '~> 0.6'
   spec.add_dependency 'ecdsa', '~> 1.2'
   spec.add_dependency 'event_emitter', '~> 0.2'
   spec.add_dependency 'faye-websocket', '~> 0.11'
@@ -47,17 +47,17 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-rubocop', '~> 1.5'
   spec.add_development_dependency 'overcommit', '~> 0.59'
   spec.add_development_dependency 'pry', '~> 0.14'
-  spec.add_development_dependency 'puma', '~> 5.6'
+  spec.add_development_dependency 'puma', '~> 6.4'
   spec.add_development_dependency 'rack', '~> 3.0'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rbs', '~> 2.8'
+  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.42'
+  spec.add_development_dependency 'rubocop', '~> 1.57'
   spec.add_development_dependency 'rubocop-rake', '~> 0.6'
-  spec.add_development_dependency 'rubocop-rspec', '2.16'
+  spec.add_development_dependency 'rubocop-rspec', '2.25'
   spec.add_development_dependency 'simplecov', '= 0.17'
   spec.add_development_dependency 'simplecov-console', '~> 0.9'
-  spec.add_development_dependency 'steep', '~> 1.3'
+  spec.add_development_dependency 'steep', '~> 1.6'
   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/bech32.rbs

@@ -0,0 +1,14 @@
+module Nostr
+  module Bech32
+    # Perhaps a bug in RBS/Steep. +decode+ and +encode+ are not recognized as public class methods.
+    def self?.decode: (String data) -> [String, String]
+    def self?.encode: (hrp: String, data: String) -> String
+
+    def naddr_encode: (pubkey: PublicKey, ?relays: Array[String], ?kind: Integer, ?identifier: String) -> String
+    def nevent_encode: (id: PublicKey, ?relays: Array[String], ?kind: Integer) -> String
+    def nprofile_encode: (pubkey: PublicKey, ?relays: Array[String]) -> String
+    def npub_encode: (String npub) -> String
+    def nrelay_encode: (String nrelay) -> String
+    def nsec_encode: (String nsec) -> String
+  end
+end

data/sig/nostr/client.rbs

@@ -5,16 +5,16 @@ module Nostr
     def initialize: -> void
     def connect: (Relay relay) -> Thread
     def subscribe: (?subscription_id: String, ?filter: Filter) -> Subscription
-    def unsubscribe: (String subscription_id) -> untyped
+    def unsubscribe: (String subscription_id) -> void
     def publish: (Event event) -> untyped
 
     private
 
     attr_reader subscriptions: Hash[String, Subscription]
-    attr_reader parent_to_child_channel: untyped
-    attr_reader child_to_parent_channel: untyped
+    attr_reader parent_to_child_channel: EventMachine::Channel
+    attr_reader child_to_parent_channel: EventMachine::Channel
 
-    def execute_within_an_em_thread: { -> untyped } -> Thread
-    def initialize_channels: -> untyped
+    def execute_within_an_em_thread: { -> void } -> Thread
+    def initialize_channels: -> void
   end
 end

data/sig/nostr/crypto.rbs

@@ -1,16 +1,16 @@
 module Nostr
   class Crypto
-    BN_BASE: Integer
+    BN_BASE: 0 | 2 | 10 | 16
     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
+    def encrypt_text: (PrivateKey, PublicKey, String) -> String
+    def decrypt_text: (PrivateKey, PublicKey, String) -> String
+    def sign_event: (Event, PrivateKey) -> Event
 
     private
 
-    def compute_shared_key: (String, String) -> String
+    def compute_shared_key: (PrivateKey, PublicKey) -> String
     def hash_event:(Event) -> String
   end
 end

data/sig/nostr/errors/error.rbs

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

data/sig/nostr/errors/invalid_hrb_error.rbs

@@ -0,0 +1,6 @@
+module Nostr
+  class InvalidHRPError < KeyValidationError
+    def initialize: (String, String) -> void
+  end
+end
+

data/sig/nostr/errors/invalid_key_format_error.rbs

@@ -0,0 +1,5 @@
+module Nostr
+  class InvalidKeyFormatError < KeyValidationError
+    def initialize: (String) -> void
+  end
+end

data/sig/nostr/errors/invalid_key_length_error.rbs

@@ -0,0 +1,5 @@
+module Nostr
+  class InvalidKeyLengthError < KeyValidationError
+    def initialize: (String) -> void
+  end
+end

data/sig/nostr/errors/invalid_key_type_error.rbs

@@ -0,0 +1,5 @@
+module Nostr
+  class InvalidKeyTypeError < KeyValidationError
+    def initialize: (String) -> void
+  end
+end

data/sig/nostr/errors/key_validation_error.rbs

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

data/sig/nostr/event.rbs

@@ -1,6 +1,6 @@
 module Nostr
   class Event
-    attr_reader pubkey: String
+    attr_reader pubkey: PublicKey
     attr_reader created_at: Integer
     attr_reader kind: Integer
     attr_reader tags: Array[Array[String]]
@@ -9,7 +9,7 @@ module Nostr
     attr_accessor sig: String?|nil
 
     def initialize: (
-      pubkey: String,
+      pubkey: PublicKey,
       kind: Integer,
       content: String,
       ?created_at: Integer,
@@ -31,9 +31,9 @@ module Nostr
     }
     def ==: (Event other) -> bool
 
-    def sign:(String) -> Event
+    def sign:(PrivateKey) -> Event
 
     def add_event_reference: (String) -> Array[Array[String]]
-    def add_pubkey_reference: (String) -> Array[Array[String]]
+    def add_pubkey_reference: (PublicKey) -> Array[Array[String]]
   end
 end

data/sig/nostr/events/encrypted_direct_message.rbs

@@ -3,8 +3,8 @@ module Nostr
     class EncryptedDirectMessage < Event
       def initialize: (
           plain_text: String,
-          sender_private_key: String,
-          recipient_public_key: String,
+          sender_private_key: PrivateKey,
+          recipient_public_key: PublicKey,
           ?previous_direct_message: String|nil
         ) -> void
     end

data/sig/nostr/filter.rbs

@@ -3,23 +3,14 @@ module Nostr
     attr_reader ids: Array[String]
     attr_reader authors: Array[String]
     attr_reader kinds: Array[Integer]
-    attr_reader e: String
-    attr_reader p: String
+    attr_reader e: Array[String]
+    attr_reader p: Array[String]
     attr_reader since: Integer
     attr_reader until: Integer
     attr_reader limit: Integer
 
     def initialize: (**untyped) -> void
-    def to_h: -> {
-      ids: Array[String],
-      authors: Array[String],
-      kinds: Array[Integer],
-      e: String,
-      p: String,
-      since: Integer,
-      until: Integer,
-      limit: Integer
-    }
+    def to_h: -> Hash[::Symbol, (::Array[::String] | ::Array[::Integer] | ::Integer)]
     def ==: (Filter other) -> bool
   end
 end

data/sig/nostr/key.rbs

@@ -0,0 +1,16 @@
+module Nostr
+  class Key < String
+    FORMAT: Regexp
+    LENGTH: int
+
+    def self.from_bech32: (String) -> Key
+    def self.hrp: -> String
+
+    def initialize: (String) -> void
+    def to_bech32: -> String
+
+    private
+
+    def validate_hex_value: (String) -> nil
+  end
+end

data/sig/nostr/key_pair.rbs

@@ -1,9 +1,13 @@
 # Classes
 module Nostr
   class KeyPair
-    attr_reader private_key: String
-    attr_reader public_key: String
+    attr_reader private_key: PrivateKey
+    attr_reader public_key: PublicKey
 
-    def initialize: (private_key: String, public_key: String) -> void
+    def initialize: (private_key: PrivateKey, public_key: PublicKey) -> void
+
+    private
+
+    def validate_keys: (PrivateKey, PublicKey) -> void
   end
 end

data/sig/nostr/keygen.rbs

@@ -3,11 +3,14 @@ module Nostr
   class Keygen
     def initialize: -> void
     def generate_key_pair: -> KeyPair
-    def generate_private_key: -> String
-    def extract_public_key: (String private_key) -> String
+    def generate_private_key: -> PrivateKey
+    def extract_public_key: (PrivateKey private_key) -> PublicKey
+    def get_key_pair_from_private_key: (PrivateKey private_key) -> KeyPair
 
     private
 
     attr_reader group: untyped
+
+    def validate_private_key: (PrivateKey private_key) -> void
   end
 end

data/sig/nostr/private_key.rbs

@@ -0,0 +1,4 @@
+module Nostr
+  class PrivateKey < Key
+  end
+end

data/sig/nostr/public_key.rbs

@@ -0,0 +1,4 @@
+module Nostr
+  class PublicKey < Key
+  end
+end

data/sig/nostr/relay_message_type.rbs

@@ -0,0 +1,8 @@
+module Nostr
+  module RelayMessageType
+    EOSE: String
+    EVENT: String
+    NOTICE: String
+    OK: String
+  end
+end

data/sig/nostr/user.rbs

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

data/sig/vendor/bech32/nostr/entity.rbs

@@ -0,0 +1,41 @@
+# Added only to satisfy the Steep requirements. Not 100% reliable.
+module Bech32
+  module Nostr
+    class BareEntity
+      attr_reader hrp: untyped
+      attr_reader data: untyped
+
+      def initialize: (untyped hrp, untyped data) -> void
+      def encode: -> untyped
+    end
+
+    class TLVEntry
+      attr_reader type: (Float | Integer | String)?
+      attr_reader label: String?
+      attr_reader value: (Float | Integer | String)?
+
+      def initialize: ((Float | Integer | String)? `type`, (Float | Integer | String)? value, ?String? label) -> void
+      def to_payload: -> String
+      def to_s: -> String
+
+      private
+
+      def hex_string?: ((Float | Integer | String)? str) -> bool
+    end
+
+    class TLVEntity
+      TYPE_SPECIAL: Integer
+      TYPE_RELAY: Integer
+      TYPE_AUTHOR: Integer
+      TYPE_KIND: Integer
+      TYPES: [Integer, Integer, Integer, Integer]
+
+      attr_reader hrp: untyped
+      attr_reader entries: Array[TLVEntry]
+
+      def initialize: (untyped hrp, Array[TLVEntry] entries) -> void
+      def self.parse: (untyped hrp, untyped data) -> TLVEntity
+      def encode: -> untyped
+    end
+  end
+end

data/sig/vendor/bech32/nostr/nip19.rbs

@@ -0,0 +1,20 @@
+# Added only to satisfy the Steep requirements. Not 100% reliable.
+module Bech32
+  module Nostr
+    module NIP19
+      HRP_PUBKEY: String
+      HRP_PRIVATE_KEY: String
+      HRP_NOTE_ID: String
+      HRP_PROFILE: String
+      HRP_EVENT: String
+      HRP_RELAY: String
+      HRP_EVENT_COORDINATE: String
+      BARE_PREFIXES: [String, String, String]
+      TLV_PREFIXES: [String, String, String, String]
+      ALL_PREFIXES: Array[String]
+
+      def decode: (untyped string) -> untyped
+      def self.decode: (untyped string) -> untyped
+    end
+  end
+end

data/sig/vendor/bech32/segwit_addr.rbs

@@ -0,0 +1,21 @@
+# Added only to satisfy the Steep requirements. Not 100% reliable.
+module Bech32
+  class SegwitAddr
+    HRP_MAINNET: String
+    HRP_TESTNET: String
+    HRP_REGTEST: String
+
+    attr_accessor hrp: String
+    attr_accessor ver: (Float | Integer | String)?
+    attr_accessor prog: Array[(Float | Integer | String)?]
+
+    def initialize: (?nil addr) -> void
+    def to_script_pubkey: -> ((Float | Integer | String)?)
+    def script_pubkey=: (untyped script_pubkey) -> (Array[(Float | Integer | String)?])
+    def addr: -> untyped
+
+    private
+
+    def parse_addr: (untyped addr) -> nil
+  end
+end