nostr 0.3.0 → 0.5.0

data/sig/nostr/event.rbs

@@ -1,24 +1,39 @@
 module Nostr
-  class Event < EventFragment
-    attr_reader id: String
-    attr_reader sig: String
+  class Event
+    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
 
-    def initialize: (id: String, sig: String,
-      created_at: Integer,
+    def initialize: (
+      pubkey: PublicKey,
       kind: Integer,
-      tags: Array[String],
       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,
+      id: String?|nil,
       pubkey: String,
       created_at: Integer,
       kind: Integer,
-      tags: Array[String],
+      tags: Array[Array[String]],
       content: String,
-      sig: String
+      sig: String?|nil
     }
     def ==: (Event other) -> bool
+
+    def sign:(PrivateKey) -> Event
+
+    def add_event_reference: (String) -> Array[Array[String]]
+    def add_pubkey_reference: (PublicKey) -> Array[Array[String]]
   end
 end

data/sig/nostr/event_kind.rbs

@@ -4,5 +4,6 @@ module Nostr
     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: PrivateKey,
+          recipient_public_key: PublicKey,
+          ?previous_direct_message: String|nil
+        ) -> void
+    end
+  end
+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,16 +5,10 @@ module Nostr
 
     def initialize: (?keypair: KeyPair | nil, ?keygen: Keygen) -> void
     def create_event: (
-      {
-        id: String,
-        pubkey: String,
-        created_at: Integer,
-        kind: Integer,
-        tags: Array[String],
-        content: String,
-        created_at: Integer,
-        sig: String
-      }
+      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

data/sig/vendor/event_emitter.rbs

@@ -1,9 +1,16 @@
 # Added only to satisfy the Steep requirements. Not 100% reliable.
 module EventEmitter
-  def add_listener: (untyped `type`, ?{once: true} params) -> Integer
+  interface _Event
+    def data: -> String
+    def message: -> String
+    def code: -> Integer
+    def reason: -> String
+  end
+
+  def add_listener: (Symbol event_name) { (_Event event) -> void } -> void
   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
+  def emit: (Symbol `type`, *untyped data) -> Array[untyped]
+  def once: (Symbol `type`) -> Integer
 end

data/sig/vendor/event_machine/channel.rbs

@@ -6,7 +6,7 @@ module EventMachine
 
     def initialize: -> void
     def num_subscribers: -> Integer
-    def subscribe: (*untyped a) ?{ -> untyped } -> Integer
+    def subscribe: (*untyped a) ?{ (untyped) -> untyped } -> Integer
     def unsubscribe: (untyped name) -> untyped
     def push: (*untyped items) -> untyped
     alias << push

data/sig/vendor/faye/websocket/api.rbs

@@ -0,0 +1,45 @@
+# Added only to satisfy the Steep requirements. Not 100% reliable.
+module Faye
+  class WebSocket
+    module API
+      CONNECTING: Integer
+      OPEN: Integer
+      CLOSING: Integer
+      CLOSED: Integer
+      CLOSE_TIMEOUT: Integer
+
+      @driver: untyped
+      @ping: nil
+      @ping_id: Integer
+      @stream: nil
+      @proxy: nil
+      @ping_timer: nil
+      @close_timer: nil
+      @close_params: [String, Integer]?
+      @onerror: nil
+      @onclose: nil
+      @onmessage: nil
+      @onopen: nil
+
+      attr_reader url: untyped
+      attr_reader ready_state: Integer
+      attr_reader buffered_amount: Integer
+
+      def initialize: (?Hash[untyped, untyped] options) -> void
+      def write: (untyped data) -> untyped
+      def send: (untyped message) -> false
+      def ping: (?String message) -> false
+      def close: (?nil code, ?nil reason) -> untyped
+      def protocol: -> String
+
+      private
+
+      def open: -> nil
+      def receive_message: (untyped data) -> nil
+      def emit_error: (untyped message) -> nil
+      def begin_close: (String reason, Integer code, ?Hash[untyped, untyped] options) -> nil
+      def finalize_close: -> nil
+      def parse: (untyped data) -> untyped
+    end
+  end
+end

data/sig/vendor/faye/websocket/client.rbs

@@ -0,0 +1,43 @@
+# Added only to satisfy the Steep requirements. Not 100% reliable.
+module Faye
+  class WebSocket
+    class Client
+      DEFAULT_PORTS: Hash[String, Integer]
+      SECURE_PROTOCOLS: [String, String]
+
+      include EventEmitter
+      include API
+
+      @url: untyped
+      @endpoint: untyped
+      @origin_tls: Hash[untyped, untyped]
+      @socket_tls: Hash[untyped, untyped]
+      @driver: bot
+      @proxy: nil
+      @ssl_verifier: untyped
+      @stream: untyped
+
+      def initialize: (untyped url, ?Array[String] protocols, ?Hash[untyped, untyped] options) -> void
+
+      private
+
+      def configure_proxy: (Hash[untyped, untyped] proxy) -> nil
+      def start_tls: (untyped uri, Hash[untyped, untyped] options) -> nil
+      def on_connect: (untyped stream) -> untyped
+      def on_network_error: (nil error) -> untyped
+      def ssl_verify_peer: (untyped cert) -> untyped
+      def ssl_handshake_completed: -> untyped
+
+      module Connection
+        attr_accessor parent: bot
+
+        def connection_completed: -> untyped
+        def ssl_verify_peer: (untyped cert) -> untyped
+        def ssl_handshake_completed: -> untyped
+        def receive_data: (untyped data) -> untyped
+        def unbind: (?nil error) -> untyped
+        def write: (untyped data) -> nil
+      end
+    end
+  end
+end

data/sig/vendor/faye/websocket.rbs

@@ -0,0 +1,30 @@
+# Added only to satisfy the Steep requirements. Not 100% reliable.
+module Faye
+  class WebSocket
+    ADAPTERS: Hash[String, :Goliath | :Rainbows | :Thin]
+
+    @url: String
+    @driver_started: false
+    @stream: Stream
+    @driver: bot
+
+    def self.determine_url: (untyped env, ?[String, String] schemes) -> String
+    def self.ensure_reactor_running: -> nil
+    def self.load_adapter: (untyped backend) -> bool?
+    def self.secure_request?: (untyped env) -> bool
+    def self.websocket?: (untyped env) -> untyped
+
+    attr_reader env: untyped
+
+    def initialize: (untyped env, ?nil protocols, ?Hash[untyped, untyped] options) -> void
+    def start_driver: -> nil
+    def rack_response: -> [Integer, Hash[untyped, untyped], Array[untyped]]
+
+    class Stream
+      @socket_object: bot
+
+      def fail: -> untyped
+      def receive: (untyped data) -> untyped
+    end
+  end
+end