nostr 0.4.0 → 0.6.0

data/lib/nostr/errors/invalid_signature_format_error.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Nostr
+  # Raised when the signature is in an invalid format
+  #
+  # @api public
+  #
+  class InvalidSignatureFormatError < SignatureValidationError
+    # Initializes the error
+    #
+    # @example
+    #   InvalidSignatureFormatError.new
+    #
+    def initialize
+      super('Only lowercase hexadecimal characters are allowed in signatures.')
+    end
+  end
+end

data/lib/nostr/errors/invalid_signature_length_error.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Nostr
+  # Raised when the signature's length is not 128 characters
+  #
+  # @api public
+  #
+  class InvalidSignatureLengthError < SignatureValidationError
+    # Initializes the error
+    #
+    # @example
+    #   InvalidSignatureLengthError.new
+    #
+    def initialize
+      super('Invalid signature length. It should have 128 characters.')
+    end
+  end
+end

data/lib/nostr/errors/invalid_signature_type_error.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Nostr
+  # Raised when the signature is not a string
+  #
+  # @api public
+  #
+  class InvalidSignatureTypeError < SignatureValidationError
+    # Initializes the error
+    #
+    # @example
+    #   InvalidSignatureTypeError.new
+    #
+    def initialize = super('Invalid signature type')
+  end
+end

data/lib/nostr/errors/key_validation_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Nostr
+  # Base class for all key validation errors
+  class KeyValidationError < Error; end
+end

data/lib/nostr/errors/signature_validation_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Nostr
+  # Base class for all signature validation errors
+  class SignatureValidationError < Error; end
+end

data/lib/nostr/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'errors/error'
+require_relative 'errors/key_validation_error'
+require_relative 'errors/invalid_hrp_error'
+require_relative 'errors/invalid_key_type_error'
+require_relative 'errors/invalid_key_length_error'
+require_relative 'errors/invalid_key_format_error'
+require_relative 'errors/signature_validation_error'
+require_relative 'errors/invalid_signature_type_error'
+require_relative 'errors/invalid_signature_length_error'
+require_relative 'errors/invalid_signature_format_error'

data/lib/nostr/event.rb

@@ -100,15 +100,15 @@ module Nostr
     #
     # @example Instantiating a new event
     #   Nostr::Event.new(
-    #    id: 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460',
-    #    pubkey: '48df4af6e240ac5f7c5de89bf5941b249880be0e87d03685b178ccb1a315f52e',
-    #    created_at: 1230981305,
-    #    kind: 1,
-    #    tags: [],
-    #    content: 'Your feedback is appreciated, now pay $8',
-    #    sig: '123ac2923b792ce730b3da34f16155470ab13c8f97f9c53eaeb334f1fb3a5dc9a7f643
-    #          937c6d6e9855477638f5655c5d89c9aa5501ea9b578a66aced4f1cd7b3'
-    # )
+    #     id: 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460',
+    #     pubkey: '48df4af6e240ac5f7c5de89bf5941b249880be0e87d03685b178ccb1a315f52e',
+    #     created_at: 1230981305,
+    #     kind: 1,
+    #     tags: [],
+    #     content: 'Your feedback is appreciated, now pay $8',
+    #     sig: '123ac2923b792ce730b3da34f16155470ab13c8f97f9c53eaeb334f1fb3a5dc9a7f643
+    #           937c6d6e9855477638f5655c5d89c9aa5501ea9b578a66aced4f1cd7b3'
+    #   )
     #
     # @param id [String|nil] 32-bytes sha256 of the the serialized event data.
     # @param sig [String|nil] 64-bytes signature of the sha256 hash of the serialized event data, which is
@@ -128,7 +128,6 @@ module Nostr
       id: nil,
       sig: nil
     )
-
       @id = id
       @sig = sig
       @pubkey = pubkey
@@ -160,11 +159,11 @@ module Nostr
     #   pubkey = '48df4af6e240ac5f7c5de89bf5941b249880be0e87d03685b178ccb1a315f52e'
     #   event.add_pubkey_reference(pubkey)
     #
-    # @param pubkey [String] 32-bytes hex-encoded public key.
+    # @param pubkey [PublicKey] 32-bytes hex-encoded public key.
     #
     # @return [Array<String>] The event's updated list of tags
     #
-    def add_pubkey_reference(pubkey) = tags.push(['p', pubkey])
+    def add_pubkey_reference(pubkey) = tags.push(['p', pubkey.to_s])
 
     # Signs an event with the user's private key
     #
@@ -173,7 +172,7 @@ module Nostr
     # @example Signing an event
     #   event.sign(private_key)
     #
-    # @param private_key [String] 32-bytes hex-encoded private key.
+    # @param private_key [PrivateKey] 32-bytes hex-encoded private key.
     #
     # @return [Event] A signed event.
     #
@@ -182,6 +181,34 @@ module Nostr
       crypto.sign_event(self, private_key)
     end
 
+    # Verifies if the signature of the event is valid. A valid signature means that the event was signed by the owner
+    #
+    # @api public
+    #
+    # @example Verifying the signature of an event
+    #   event = Nostr::Event.new(
+    #     id: '90b75b78daf883ae57fbcc414d43faa028560b3211ee58e4ea82bf395bb82042',
+    #     pubkey: Nostr::PublicKey.new('2d7661527d573cc8e84f665fa971dd969ba51e2526df00c149ff8e40a58f9558'),
+    #     created_at: 1667422587,
+    #     kind: Nostr::EventKind::TEXT_NOTE,
+    #     content: 'Your feedback is appreciated, now pay $8',
+    #     sig: '32f18adebe942e19b171c1c7d2fb27ce794dfea4155e289dca7952b43ed1ec39' \
+    #       '1d3dc198ba2761bc6d40c737a6eaf4edcc8963acabd3bfcebd04f16637025bdc'
+    #   )
+    #
+    #   event.verify_signature # => true
+    #
+    # @return [Boolean] Whether the signature is valid or not.
+    #
+    def verify_signature
+      crypto = Crypto.new
+
+      return false if id.nil? || pubkey.nil?
+      return false if sig.nil? # FIXME: See https://github.com/soutaro/steep/issues/1079
+
+      crypto.valid_sig?(id, pubkey, sig)
+    end
+
     # Serializes the event, to obtain a SHA256 digest of it
     #
     # @api public

data/lib/nostr/event_kind.rb

@@ -21,6 +21,7 @@ module Nostr
     # The content is set to the URL (e.g., wss://somerelay.com) of a relay the event creator wants to
     # recommend to its followers.
     #
+    # @deprecated This event kind was removed in https://github.com/nostr-protocol/nips/pull/703/files#diff-39307f1617417657ee9874be314f13aabdc74401b124d0afe8217f2919c9c7d8L105
     # @return [Integer]
     #
     RECOMMEND_SERVER = 2

data/lib/nostr/events/encrypted_direct_message.rb

@@ -11,23 +11,24 @@ module Nostr
       # @api public
       #
       # @example Instantiating a new encrypted direct message
-      #   Nostr::Events::EncryptedDirectMessage.new(
+      #  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(
+      #  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 sender_private_key [PrivateKey] 32-bytes hex-encoded private key of the message's author.
+      # @param recipient_public_key [PublicKey] 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
@@ -43,7 +44,7 @@ module Nostr
           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

data/lib/nostr/filter.rb

@@ -3,7 +3,7 @@
 module Nostr
   # A filter determines what events will be sent in a subscription.
   class Filter
-    # A list of event ids or prefixes
+    # A list of event ids
     #
     # @api public
     #
@@ -14,7 +14,7 @@ module Nostr
     #
     attr_reader :ids
 
-    # A list of pubkeys or prefixes, the pubkey of an event must be one of these
+    # A list of pubkeys, the pubkey of an event must be one of these
     #
     # @api public
     #
@@ -107,8 +107,8 @@ module Nostr
     #   )
     #
     # @param kwargs [Hash]
-    # @option kwargs [Array<String>, nil] ids A list of event ids or prefixes
-    # @option kwargs [Array<String>, nil] authors A list of pubkeys or prefixes, the pubkey of an event must be one
+    # @option kwargs [Array<String>, nil] ids A list of event ids
+    # @option kwargs [Array<String>, nil] authors A list of pubkeys, the pubkey of an event must be one
     # of these
     # @option kwargs [Array<Integer>, nil] kinds A list of a kind numbers
     # @option kwargs [Array<String>, nil] e A list of event ids that are referenced in an "e" tag
@@ -133,13 +133,16 @@ module Nostr
     # @api public
     #
     # @example
-    #   filter.to_h # => {:ids=>["c24881c305c5cfb7c1168be7e9b0e150"],
-    #    :authors=>["000000001c5c45196786e79f83d21fe801549fdc98e2c26f96dcef068a5dbcd7"],
-    #    :kinds=>[0, 1, 2],
-    #    :"#e"=>["7bdb422f254194ae4bb86d354c0bd5a888fce233ffc77dceb3e844ceec1fcfb2"],
-    #    :"#p"=>["000000001c5c45196786e79f83d21fe801549fdc98e2c26f96dcef068a5dbcd7"],
-    #    :since=>1230981305,
-    #    :until=>1292190341}
+    #   filter.to_h # =>
+    #   {
+    #      ids: ['c24881c305c5cfb7c1168be7e9b0e150'],
+    #      authors: ['000000001c5c45196786e79f83d21fe801549fdc98e2c26f96dcef068a5dbcd7'],
+    #      kinds: [0, 1, 2],
+    #      '#e': ['7bdb422f254194ae4bb86d354c0bd5a888fce233ffc77dceb3e844ceec1fcfb2'],
+    #      '#p': ['000000001c5c45196786e79f83d21fe801549fdc98e2c26f96dcef068a5dbcd7'],
+    #      since: 1230981305,
+    #      until: 1292190341
+    #   }
     #
     # @return [Hash] The filter as a hash.
     #

data/lib/nostr/key.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Nostr
+  # Abstract class for all keys
+  #
+  # @api private
+  #
+  class Key < 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 key in hex format
+    #
+    # @return [Integer] The length of the key in hex format
+    #
+    LENGTH = 64
+
+    # Instantiates a new key. Can't be used directly because this is an abstract class. Raises a +KeyValidationError+
+    #
+    # @see Nostr::PrivateKey
+    # @see Nostr::PublicKey
+    #
+    # @param [String] hex_value Hex-encoded value of the key
+    #
+    # @raise [KeyValidationError]
+    #
+    def initialize(hex_value)
+      validate_hex_value(hex_value)
+
+      super(hex_value)
+    end
+
+    # Instantiates a key from a bech32 string
+    #
+    # @api public
+    #
+    # @example
+    #   bech32_key = 'nsec1vl029mgpspedva04g90vltkh6fvh240zqtv9k0t9af8935ke9laqsnlfe5'
+    #   bech32_key.to_key # => #<Nostr::PublicKey:0x000000010601e3c8 @hex_value="...">
+    #
+    # @raise [Nostr::InvalidHRPError] if the bech32 string is invalid.
+    #
+    # @param [String] bech32_value The bech32 string representation of the key.
+    #
+    # @return [Key] the key.
+    #
+    def self.from_bech32(bech32_value)
+      type, data = Bech32.decode(bech32_value)
+
+      raise InvalidHRPError.new(type, hrp) unless type == hrp
+
+      new(data)
+    end
+
+    # Abstract method to be implemented by subclasses to provide the HRP (npub, nsec)
+    #
+    # @api private
+    #
+    # @return [String] The HRP
+    #
+    def self.hrp
+      raise 'Subclasses must implement this method'
+    end
+
+    # Converts the key to a bech32 string representation
+    #
+    # @api public
+    #
+    # @example Converting a private key to a bech32 string
+    #   public_key = Nostr::PrivateKey.new('67dea2ed018072d675f5415ecfaed7d2597555e202d85b3d65ea4e58d2d92ffa')
+    #   public_key.to_bech32 # => 'nsec1vl029mgpspedva04g90vltkh6fvh240zqtv9k0t9af8935ke9laqsnlfe5'
+    #
+    # @example Converting a public key to a bech32 string
+    #   public_key = Nostr::PublicKey.new('7e7e9c42a91bfef19fa929e5fda1b72e0ebc1a4c1141673e2794234d86addf4e')
+    #   public_key.to_bech32 # => 'npub10elfcs4fr0l0r8af98jlmgdh9c8tcxjvz9qkw038js35mp4dma8qzvjptg'
+    #
+    # @return [String] The bech32 string representation of the key
+    #
+    def to_bech32 = Bech32.encode(hrp: self.class.hrp, data: self)
+
+    protected
+
+    # Validates the hex value during initialization
+    #
+    # @api private
+    #
+    # @param [String] _hex_value The hex value of the key
+    #
+    # @raise [KeyValidationError] When the hex value is invalid
+    #
+    # @return [void]
+    #
+    def validate_hex_value(_hex_value)
+      raise 'Subclasses must implement this method'
+    end
+  end
+end

data/lib/nostr/key_pair.rb

@@ -10,7 +10,7 @@ module Nostr
     # @example
     #   keypair.private_key # => '893c4cc8088924796b41dc788f7e2f746734497010b1a9f005c1faad7074b900'
     #
-    # @return [String]
+    # @return [PrivateKey]
     #
     attr_reader :private_key
 
@@ -21,7 +21,7 @@ module Nostr
     # @example
     #   keypair.public_key # => '2d7661527d573cc8e84f665fa971dd969ba51e2526df00c149ff8e40a58f9558'
     #
-    # @return [String]
+    # @return [PublicKey]
     #
     attr_reader :public_key
 
@@ -31,16 +31,64 @@ module Nostr
     #
     # @example
     #   keypair = Nostr::KeyPair.new(
-    #     private_key: '893c4cc8088924796b41dc788f7e2f746734497010b1a9f005c1faad7074b900',
-    #     public_key: '2d7661527d573cc8e84f665fa971dd969ba51e2526df00c149ff8e40a58f9558',
+    #     private_key: Nostr::PrivateKey.new('893c4cc8088924796b41dc788f7e2f746734497010b1a9f005c1faad7074b900'),
+    #     public_key: Nostr::PublicKey.new('2d7661527d573cc8e84f665fa971dd969ba51e2526df00c149ff8e40a58f9558'),
     #   )
     #
-    # @param private_key [String] 32-bytes hex-encoded private key.
-    # @param public_key [String] 32-bytes hex-encoded public key.
+    # @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}
     #
     def initialize(private_key:, public_key:)
+      validate_keys(private_key, public_key)
+
       @private_key = private_key
       @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
+    #
+    # @api private
+    #
+    # @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+
+    #
+    # @return [void]
+    #
+    def validate_keys(private_key, public_key)
+      raise ArgumentError, 'private_key is not an instance of PrivateKey' unless private_key.is_a?(Nostr::PrivateKey)
+      raise ArgumentError, 'public_key is not an instance of PublicKey' unless public_key.is_a?(Nostr::PublicKey)
+    end
   end
 end

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">
@@ -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