nostr 0.2.0 → 0.4.0

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

@@ -50,43 +50,15 @@ module Nostr
     # @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 2.
+    # @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.
     #
     # @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.2.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/nostr.gemspec

@@ -50,12 +50,15 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'puma', '~> 5.6'
   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 'rubocop-rake', '~> 0.6'
   spec.add_development_dependency 'rubocop-rspec', '2.16'
   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 'typeprof', '~> 0.21'
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'yard-junk', '~> 0.0.9'
   spec.add_development_dependency 'yardstick', '~> 0.9'

data/sig/nostr/client.rbs

@@ -0,0 +1,20 @@
+module Nostr
+  class Client
+    include EventEmitter
+
+    def initialize: -> void
+    def connect: (Relay relay) -> Thread
+    def subscribe: (?subscription_id: String, ?filter: Filter) -> Subscription
+    def unsubscribe: (String subscription_id) -> untyped
+    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
+
+    def execute_within_an_em_thread: { -> untyped } -> Thread
+    def initialize_channels: -> untyped
+  end
+end

data/sig/nostr/client_message_type.rbs

@@ -0,0 +1,7 @@
+module Nostr
+  module ClientMessageType
+    EVENT: String
+    REQ: String
+    CLOSE: String
+  end
+end

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

@@ -0,0 +1,39 @@
+module Nostr
+  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: (
+      pubkey: String,
+      kind: Integer,
+      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?|nil,
+      pubkey: String,
+      created_at: Integer,
+      kind: Integer,
+      tags: Array[Array[String]],
+      content: 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

@@ -0,0 +1,9 @@
+module Nostr
+  module EventKind
+    SET_METADATA: Integer
+    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/filter.rbs

@@ -0,0 +1,25 @@
+module Nostr
+  class Filter
+    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 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 ==: (Filter other) -> bool
+  end
+end

data/sig/nostr/key_pair.rbs

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

data/sig/nostr/keygen.rbs

@@ -0,0 +1,13 @@
+# Classes
+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
+
+    private
+
+    attr_reader group: untyped
+  end
+end

data/sig/nostr/relay.rbs

@@ -0,0 +1,9 @@
+# Classes
+module Nostr
+  class Relay
+    attr_reader url: String
+    attr_reader name: String
+
+    def initialize: (url: String, name: String) -> void
+  end
+end

data/sig/nostr/subscription.rbs

@@ -0,0 +1,9 @@
+module Nostr
+  class Subscription
+    attr_reader id: String
+    attr_reader filter: Filter
+
+    def initialize: (filter: Filter, ?id: String) -> void
+    def ==: (Subscription other) -> bool
+  end
+end

data/sig/nostr/user.rbs

@@ -0,0 +1,22 @@
+# Classes
+module Nostr
+  class User
+    attr_reader keypair: KeyPair
+
+    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,
+      }
+    ) -> Event
+
+    private
+
+    def sign: (String event_sha256) -> String
+  end
+end

data/sig/vendor/ecsda/group/secp256k1.rbs

@@ -0,0 +1,6 @@
+# Added only to satisfy the Steep requirements. Not 100% reliable.
+module ECDSA
+  class Group
+    Secp256k1: Group
+  end
+end

data/sig/vendor/event_emitter.rbs

@@ -0,0 +1,9 @@
+# Added only to satisfy the Steep requirements. Not 100% reliable.
+module EventEmitter
+  def add_listener: (untyped `type`, ?{once: true} params) -> Integer
+  alias on add_listener
+
+  def remove_listener: (untyped id_or_type) -> Array[untyped]?
+  def emit: (untyped `type`, *untyped data) -> Array[untyped]
+  def once: (untyped `type`) -> Integer
+end

data/sig/vendor/event_machine/channel.rbs

@@ -0,0 +1,18 @@
+# Added only to satisfy the Steep requirements. Not 100% reliable.
+module EventMachine
+  class Channel
+    @subs: Hash[untyped, untyped]
+    @uid: Integer
+
+    def initialize: -> void
+    def num_subscribers: -> Integer
+    def subscribe: (*untyped a) ?{ -> untyped } -> Integer
+    def unsubscribe: (untyped name) -> untyped
+    def push: (*untyped items) -> untyped
+    alias << push
+    def pop: (*untyped a) -> untyped
+
+    private
+    def gen_id: -> Integer
+  end
+end

data/sig/vendor/event_machine.rbs

@@ -0,0 +1,69 @@
+# Added only to satisfy the Steep requirements. Not 100% reliable.
+module EventMachine
+  ERRNOS: Hash[untyped, untyped]
+  P: untyped
+  self.@next_tick_mutex: Thread::Mutex
+  self.@reactor_running: bool
+  self.@next_tick_queue: Array[^-> untyped]
+  self.@tails: Array[nil]
+  self.@resultqueue: (Array[untyped] | Thread::Queue)?
+  self.@threadqueue: Thread::Queue?
+  self.@threadpool: Array[untyped]?
+  self.@all_threads_spawned: bool
+  self.@reactor_pid: Integer
+  self.@conns: Hash[untyped, untyped]
+  self.@acceptors: Hash[untyped, Array[(Array[untyped] | Integer)?]]
+  self.@timers: Hash[untyped, Integer | ^-> untyped | false]
+  self.@wrapped_exception: Exception?
+  self.@reactor_thread: Thread?
+  self.@threadpool_size: bot
+  self.@error_handler: bot
+
+  def self.run: (?untyped blk, ?nil tail) ?{ -> untyped } -> nil
+  def self.run_block: -> nil
+  def self.reactor_thread?: -> bool
+  def self.schedule: (*untyped a) -> nil
+  def self.fork_reactor: -> Integer?
+  def self.cleanup_machine: -> Array[untyped]
+  def self.add_shutdown_hook: -> Array[nil]
+  def self.add_timer: (*Integer | ^-> untyped args) ?{ -> untyped } -> nil
+  def self.add_periodic_timer: (*untyped args) -> untyped
+  def self.cancel_timer: (untyped timer_or_sig) -> false?
+  def self.stop_event_loop: -> untyped
+  def self.start_server: (untyped server, ?nil port, ?nil handler, *untyped args) -> untyped
+  def self.attach_server: (untyped sock, ?nil handler, *untyped args) -> untyped
+  def self.stop_server: (untyped signature) -> untyped
+  def self.start_unix_domain_server: (untyped filename, *untyped args) -> untyped
+  def self.connect: (untyped server, ?nil port, ?nil handler, *untyped args) -> untyped
+  def self.bind_connect: (nil bind_addr, nil bind_port, untyped server, ?nil port, ?nil handler, *untyped args) -> untyped
+  def self.watch: (untyped io, ?nil handler, *untyped args) -> untyped
+  def self.attach: (untyped io, ?nil handler, *untyped args) -> untyped
+  def self.attach_io: (untyped io, bool watch_mode, ?nil handler, *untyped args) -> untyped
+  def self.reconnect: (untyped server, untyped port, untyped handler) -> untyped
+  def self.connect_unix_domain: (untyped socketname, *untyped args) -> untyped
+  def self.open_datagram_socket: (untyped address, untyped port, ?nil handler, *untyped args) -> untyped
+  def self.set_quantum: (untyped mills) -> untyped
+  def self.set_max_timers: (untyped ct) -> untyped
+  def self.get_max_timers: -> untyped
+  def self.connection_count: -> untyped
+  def self.run_deferred_callbacks: -> Integer
+  def self.defer: (?nil op, ?nil callback, ?nil errback) -> untyped
+  def self.spawn_threadpool: -> true
+  def self.defers_finished?: -> bool
+  def self.next_tick: (?nil pr) { -> nil } -> nil
+  def self.set_effective_user: (untyped username) -> untyped
+  def self.set_descriptor_table_size: (?nil n_descriptors) -> untyped
+  def self.popen: (untyped cmd, ?nil handler, *untyped args) -> untyped
+  def self.reactor_running?: -> bool
+  def self.open_keyboard: (?nil handler, *untyped args) -> untyped
+  def self.watch_file: (untyped filename, ?nil handler, *untyped args) -> untyped
+  def self.watch_process: (untyped pid, ?nil handler, *untyped args) -> untyped
+  def self.error_handler: (?nil cb) -> nil
+  def self.enable_proxy: (untyped from, untyped to, ?Integer bufsize, ?Integer length) -> untyped
+  def self.disable_proxy: (untyped from) -> untyped
+  def self.heartbeat_interval: -> untyped
+  def self.heartbeat_interval=: (untyped time) -> untyped
+  def self.event_callback: (untyped conn_binding, untyped opcode, untyped data) -> Integer?
+  def self._open_file_for_writing: (untyped filename, ?nil handler) -> untyped
+  def self.klass_from_handler: (?untyped klass, ?Integer? handler, *nil args) -> Integer
+end

data/sig/vendor/schnorr.rbs

@@ -0,0 +1,4 @@
+# Added only to satisfy the Steep requirements. Not 100% reliable.
+module Schnorr
+  def self.sign: (String message, String private_key, ?String aux_rand) -> untyped
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nostr
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Wilson Silva
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-12 00:00:00.000000000 Z
+date: 2023-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bech32
@@ -262,6 +262,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -346,6 +360,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: steep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: typeprof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -409,12 +451,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - 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
@@ -424,6 +468,23 @@ files:
 - lib/nostr/version.rb
 - nostr.gemspec
 - sig/nostr.rbs
+- sig/nostr/client.rbs
+- sig/nostr/client_message_type.rbs
+- sig/nostr/crypto.rbs
+- sig/nostr/event.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
+- sig/nostr/relay.rbs
+- sig/nostr/subscription.rbs
+- sig/nostr/user.rbs
+- sig/vendor/ecsda/group/secp256k1.rbs
+- sig/vendor/event_emitter.rbs
+- sig/vendor/event_machine.rbs
+- sig/vendor/event_machine/channel.rbs
+- sig/vendor/schnorr.rbs
 homepage: https://github.com/wilsonsilva/nostr
 licenses:
 - MIT
@@ -447,7 +508,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: Client and relay implementation of the Nostr protocol.