nostr 0.4.0 → 0.6.0

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/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.6.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,17 @@ 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/signature'
 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,9 +10,9 @@ 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.required_ruby_version = '>= 3.3.0'
   spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.metadata['homepage_uri'] = spec.homepage
@@ -31,33 +31,33 @@ 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.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_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', '~> 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 'rspec', '~> 3.12'
-  spec.add_development_dependency 'rubocop', '~> 1.42'
+  spec.add_development_dependency 'rake', '~> 13.1'
+  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.16'
+  spec.add_development_dependency 'rubocop-rspec', '2.27'
   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,19 @@
 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
+    def sign_message: (String, PrivateKey) -> Signature
+    def valid_sig?: (String, PublicKey, Signature) -> bool
+    def check_sig!: (String, PublicKey, Signature) -> bool
 
     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/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/key_validation_error.rbs

@@ -0,0 +1,4 @@
+module Nostr
+  class KeyValidationError < Error
+  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

@@ -1,39 +1,40 @@
 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]]
     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: String,
+      pubkey: PublicKey,
       kind: Integer,
       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:(String) -> Event
+    def sign:(PrivateKey) -> Event
+    def verify_signature: -> bool
 
     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,14 @@
 # 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
+    def to_ary: -> [PrivateKey, PublicKey]
+
+    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/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/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

data/sig/vendor/bech32.rbs

@@ -0,0 +1,25 @@
+# Added only to satisfy the Steep requirements. Not 100% reliable.
+module Bech32
+  SEPARATOR: String
+  BECH32M_CONST: Integer
+
+  def encode: (untyped hrp, untyped data, untyped spec) -> untyped
+  def self.encode: (untyped hrp, untyped data, untyped spec) -> untyped
+  def decode: (untyped bech, ?Integer max_length) -> [untyped, untyped, Integer]?
+  def self.decode: (untyped bech, ?Integer max_length) -> [untyped, untyped, Integer]?
+  def create_checksum: (untyped hrp, untyped data, untyped spec) -> Array[Integer]
+  def self.create_checksum: (untyped hrp, untyped data, untyped spec) -> Array[Integer]
+  def verify_checksum: (untyped hrp, untyped data) -> Integer?
+  def self.verify_checksum: (untyped hrp, untyped data) -> Integer?
+  def expand_hrp: (untyped hrp) -> untyped
+  def self.expand_hrp: (untyped hrp) -> untyped
+  def convert_bits: (untyped data, untyped from, untyped to, ?true padding) -> Array[Integer]?
+  def self.convert_bits: (untyped data, untyped from, untyped to, ?true padding) -> Array[Integer]?
+  def polymod: (untyped values) -> Integer
+  def self.polymod: (untyped values) -> Integer
+
+  module Encoding
+    BECH32: Integer
+    BECH32M: Integer
+  end
+end