nostr 0.3.0 → 0.5.0

data/lib/nostr/bech32.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+require 'bech32'
+require 'bech32/nostr'
+require 'bech32/nostr/entity'
+
+module Nostr
+  # Bech32 encoding and decoding
+  #
+  # @api public
+  #
+  module Bech32
+    # Decodes a bech32-encoded string
+    #
+    # @api public
+    #
+    # @example
+    #   bech32_value = 'npub10elfcs4fr0l0r8af98jlmgdh9c8tcxjvz9qkw038js35mp4dma8qzvjptg'
+    #   Nostr::Bech32.decode(bech32_value) # => ['npub', '7e7e9c42a91bfef19fa929e5fda1b72e0ebc1a4c1141673e2794234d8...']
+    #
+    # @param [String] bech32_value The bech32-encoded string to decode
+    #
+    # @return [Array<String, String>] The human readable part and the data
+    #
+    def self.decode(bech32_value)
+      entity = ::Bech32::Nostr::NIP19.decode(bech32_value)
+
+      case entity
+      in ::Bech32::Nostr::BareEntity
+        [entity.hrp, entity.data]
+      in ::Bech32::Nostr::TLVEntity
+        [entity.hrp, entity.entries]
+      end
+    end
+
+    # Encodes data into a bech32 string
+    #
+    # @api public
+    #
+    # @example
+    #   Nostr::Bech32.encode(hrp: 'npub', data: '7e7e9c42a91bfef19fa929e5fda1b72e0ebc1a4c1141673e2794234d86addf4e')
+    #   # => 'npub10elfcs4fr0l0r8af98jlmgdh9c8tcxjvz9qkw038js35mp4dma8qzvjptg'
+    #
+    # @param [String] hrp The human readable part (npub, nsec, nprofile, nrelay, nevent, naddr, etc)
+    # @param [String] data The data to encode
+    #
+    # @return [String] The bech32-encoded string
+    #
+    def self.encode(hrp:, data:)
+      ::Bech32::Nostr::BareEntity.new(hrp, data).encode
+    end
+
+    # Encodes a hex-encoded public key into a bech32 string
+    #
+    # @api public
+    #
+    # @example
+    #   Nostr::Bech32.npub_encode('7e7e9c42a91bfef19fa929e5fda1b72e0ebc1a4c1141673e2794234d86addf4e')
+    #   # => 'npub10elfcs4fr0l0r8af98jlmgdh9c8tcxjvz9qkw038js35mp4dma8qzvjptg'
+    #
+    # @param [String] npub The public key to encode
+    #
+    # @see Nostr::Bech32#encode
+    # @see Nostr::PublicKey#to_bech32
+    # @see Nostr::PrivateKey#to_bech32
+    #
+    # @return [String] The bech32-encoded string
+    #
+    def self.npub_encode(npub)
+      encode(hrp: 'npub', data: npub)
+    end
+
+    # Encodes a hex-encoded private key into a bech32 string
+    #
+    # @api public
+    #
+    # @example
+    #   Nostr::Bech32.nsec_encode('7e7e9c42a91bfef19fa929e5fda1b72e0ebc1a4c1141673e2794234d86addf4e')
+    #   # => 'nsec10elfcs4fr0l0r8af98jlmgdh9c8tcxjvz9qkw038js35mp4dma8qzvjptg'
+    #
+    # @param [String] nsec The private key to encode
+    #
+    # @see Nostr::Bech32#encode
+    # @see Nostr::PrivateKey#to_bech32
+    # @see Nostr::PublicKey#to_bech32
+    #
+    # @return [String] The bech32-encoded string
+    #
+    def self.nsec_encode(nsec)
+      encode(hrp: 'nsec', data: nsec)
+    end
+
+    # Encodes an address into a bech32 string
+    #
+    # @api public
+    #
+    # @example
+    #   naddr = Nostr::Bech32.naddr_encode(
+    #     pubkey: '7e7e9c42a91bfef19fa929e5fda1b72e0ebc1a4c1141673e2794234d86addf4e',
+    #     relays: ['wss://relay.damus.io', 'wss://nos.lol'],
+    #     kind: Nostr::EventKind::TEXT_NOTE,
+    #     identifier: 'damus'
+    #   )
+    #   naddr # => 'naddr1qgs8ul5ug253hlh3n75jne0a5xmjur4urfxpzst88cnegg6ds6ka7ns...'
+    #
+    # @param [PublicKey] pubkey The public key to encode
+    # @param [Array<String>] relays The relays to encode
+    # @param [String] kind The kind of address to encode
+    # @param [String] identifier The identifier of the address to encode
+    #
+    # @return [String] The bech32-encoded string
+    #
+    def self.naddr_encode(pubkey:, relays: [], kind: nil, identifier: nil)
+      entry_relays = relays.map do |relay_url|
+        ::Bech32::Nostr::TLVEntry.new(::Bech32::Nostr::TLVEntity::TYPE_RELAY, relay_url)
+      end
+
+      pubkey_entry = ::Bech32::Nostr::TLVEntry.new(::Bech32::Nostr::TLVEntity::TYPE_AUTHOR, pubkey)
+      kind_entry = ::Bech32::Nostr::TLVEntry.new(::Bech32::Nostr::TLVEntity::TYPE_KIND, kind)
+      identifier_entry = ::Bech32::Nostr::TLVEntry.new(::Bech32::Nostr::TLVEntity::TYPE_SPECIAL, identifier)
+
+      entries = [pubkey_entry, *entry_relays, kind_entry, identifier_entry].compact
+      entity = ::Bech32::Nostr::TLVEntity.new(::Bech32::Nostr::NIP19::HRP_EVENT_COORDINATE, entries)
+      entity.encode
+    end
+
+    # Encodes an event into a bech32 string
+    #
+    # @api public
+    #
+    # @example
+    #   nevent = Nostr::Bech32.nevent_encode(
+    #     id: '0fdb90f8e234d3400edafdd26d493f12efc0d7de2c6f9f21f997847d33ad2ea3',
+    #     relays: ['wss://relay.damus.io', 'wss://nos.lol'],
+    #     kind: Nostr::EventKind::TEXT_NOTE,
+    #   )
+    #   nevent # => 'nevent1qgsqlkuslr3rf56qpmd0m5ndfyl39m7q6l0zcmuly8ue0pra...'
+    #
+    # @param [PublicKey] id The id the event to encode
+    # @param [Array<String>] relays The relays to encode
+    # @param [String] kind The kind of event to encode
+    #
+    # @return [String] The bech32-encoded string
+    #
+    def self.nevent_encode(id:, relays: [], kind: nil)
+      entry_relays = relays.map do |relay_url|
+        ::Bech32::Nostr::TLVEntry.new(::Bech32::Nostr::TLVEntity::TYPE_RELAY, relay_url)
+      end
+
+      id_entry = ::Bech32::Nostr::TLVEntry.new(::Bech32::Nostr::TLVEntity::TYPE_AUTHOR, id)
+      kind_entry = ::Bech32::Nostr::TLVEntry.new(::Bech32::Nostr::TLVEntity::TYPE_KIND, kind)
+
+      entries = [id_entry, *entry_relays, kind_entry].compact
+      entity = ::Bech32::Nostr::TLVEntity.new(::Bech32::Nostr::NIP19::HRP_EVENT, entries)
+      entity.encode
+    end
+
+    # Encodes a profile into a bech32 string
+    #
+    # @api public
+    #
+    # @example
+    #   nprofile = Nostr::Bech32.nprofile_encode(
+    #     pubkey: '7e7e9c42a91bfef19fa929e5fda1b72e0ebc1a4c1141673e2794234d86addf4e',
+    #     relays: ['wss://relay.damus.io', 'wss://nos.lol']
+    #   )
+    #
+    # @param [PublicKey] pubkey The public key to encode
+    # @param [Array<String>] relays The relays to encode
+    #
+    # @return [String] The bech32-encoded string
+    #
+    def self.nprofile_encode(pubkey:, relays: [])
+      entry_relays = relays.map do |relay_url|
+        ::Bech32::Nostr::TLVEntry.new(::Bech32::Nostr::TLVEntity::TYPE_RELAY, relay_url)
+      end
+
+      pubkey_entry = ::Bech32::Nostr::TLVEntry.new(::Bech32::Nostr::TLVEntity::TYPE_SPECIAL, pubkey)
+      entries = [pubkey_entry, *entry_relays].compact
+      entity = ::Bech32::Nostr::TLVEntity.new(::Bech32::Nostr::NIP19::HRP_PROFILE, entries)
+      entity.encode
+    end
+
+    # Encodes a relay URL into a bech32 string
+    #
+    # @api public
+    #
+    # @example
+    #   nrelay = Nostr::Bech32.nrelay_encode('wss://relay.damus.io')
+    #   nrelay # => 'nrelay1qq28wumn8ghj7un9d3shjtnyv9kh2uewd9hsc5zt2x'
+    #
+    # @param [String] relay_url The relay url to encode
+    #
+    # @return [String] The bech32-encoded string
+    #
+    def self.nrelay_encode(relay_url)
+      relay_entry = ::Bech32::Nostr::TLVEntry.new(::Bech32::Nostr::TLVEntity::TYPE_SPECIAL, relay_url)
+
+      entity = ::Bech32::Nostr::TLVEntity.new(::Bech32::Nostr::NIP19::HRP_RELAY, [relay_entry])
+      entity.encode
+    end
+  end
+end

data/lib/nostr/client.rb

@@ -74,7 +74,8 @@ module Nostr
     # @example Subscribing to all events created after a certain time
     #   subscription = client.subscribe(filter: Nostr::Filter.new(since: 1230981305))
     #
-    # @param subscription_id [String] The subscription id. A random string.
+    # @param subscription_id [String] The subscription id. An arbitrary, non-empty string of max length 64
+    #   chars used to represent a subscription.
     # @param filter [Filter] A set of attributes that represent the events that the client is interested in.
     #
     # @return [Subscription] The subscription object

data/lib/nostr/crypto.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+module Nostr
+  # Performs cryptographic operations on a +Nostr::Event+.
+  class Crypto
+    # Numeric base of the OpenSSL big number used in an event content's encryption.
+    #
+    # @return [Integer]
+    #
+    BN_BASE = 16
+
+    # Name of the cipher curve used in an event content's encryption.
+    #
+    # @return [String]
+    #
+    CIPHER_CURVE = 'secp256k1'
+
+    # Name of the cipher algorithm used in an event content's encryption.
+    #
+    # @return [String]
+    #
+    CIPHER_ALGORITHM = 'aes-256-cbc'
+
+    # Encrypts a piece of text
+    #
+    # @api public
+    #
+    # @example Encrypting an event's content
+    #   crypto = Nostr::Crypto.new
+    #   encrypted = crypto.encrypt_text(sender_private_key, recipient_public_key, 'Feedback appreciated. Now pay $8')
+    #   encrypted # => "wrYQaHDfpOEvyJELSCg1vzsywmlJTz8NqH03eFW44s8iQs869jtSb26Lr4s23gmY?iv=v38vAJ3LlJAGZxbmWU4qAg=="
+    #
+    # @param sender_private_key [PrivateKey] 32-bytes hex-encoded private key of the creator.
+    # @param recipient_public_key [PublicKey] 32-bytes hex-encoded public key of the recipient.
+    # @param plain_text [String] The text to be encrypted
+    #
+    # @return [String] Encrypted text.
+    #
+    def encrypt_text(sender_private_key, recipient_public_key, plain_text)
+      cipher = OpenSSL::Cipher.new(CIPHER_ALGORITHM).encrypt
+      cipher.iv = iv = cipher.random_iv
+      cipher.key = compute_shared_key(sender_private_key, recipient_public_key)
+      encrypted_text = cipher.update(plain_text) + cipher.final
+      encrypted_text = "#{Base64.encode64(encrypted_text)}?iv=#{Base64.encode64(iv)}"
+      encrypted_text.gsub("\n", '')
+    end
+
+    # Decrypts a piece of text
+    #
+    # @api public
+    #
+    # @example Encrypting an event's content
+    #   crypto = Nostr::Crypto.new
+    #   encrypted # => "wrYQaHDfpOEvyJELSCg1vzsywmlJTz8NqH03eFW44s8iQs869jtSb26Lr4s23gmY?iv=v38vAJ3LlJAGZxbmWU4qAg=="
+    #   decrypted = crypto.decrypt_text(recipient_private_key, sender_public_key, encrypted)
+    #
+    # @param sender_public_key [PublicKey] 32-bytes hex-encoded public key of the message creator.
+    # @param recipient_private_key [PrivateKey] 32-bytes hex-encoded public key of the recipient.
+    # @param encrypted_text [String] The text to be decrypted
+    #
+    # @return [String] Decrypted text.
+    #
+    def decrypt_text(recipient_private_key, sender_public_key, encrypted_text)
+      base64_encoded_text, iv = encrypted_text.split('?iv=')
+
+      # Ensure iv and base64_encoded_text are not nil
+      return '' unless iv && base64_encoded_text
+
+      cipher = OpenSSL::Cipher.new(CIPHER_ALGORITHM).decrypt
+      cipher.iv = Base64.decode64(iv)
+      cipher.key = compute_shared_key(recipient_private_key, sender_public_key)
+      plain_text = cipher.update(Base64.decode64(base64_encoded_text)) + cipher.final
+      plain_text.force_encoding('UTF-8')
+    end
+
+    # Uses the private key to generate an event id and sign the event
+    #
+    # @api public
+    #
+    # @example Signing an event
+    #   crypto = Nostr::Crypto.new
+    #   crypto.sign(event, private_key)
+    #   event.id # => an id
+    #   event.sig # => a signature
+    #
+    # @param event [Event] The event to be signed
+    # @param private_key [PrivateKey] 32-bytes hex-encoded private key.
+    #
+    # @return [Event] An unsigned event.
+    #
+    def sign_event(event, private_key)
+      event_digest = hash_event(event)
+
+      hex_private_key = Array(private_key).pack('H*')
+      hex_message     = Array(event_digest).pack('H*')
+      event_signature = Schnorr.sign(hex_message, hex_private_key).encode.unpack1('H*')
+
+      event.id = event_digest
+      event.sig = event_signature
+
+      event
+    end
+
+    private
+
+    # Finds a shared key between two keys
+    #
+    # @api private
+    #
+    # @param private_key [PrivateKey] 32-bytes hex-encoded private key.
+    # @param public_key [PublicKey] 32-bytes hex-encoded public key.
+    #
+    # @return [String] A shared key used in the event's content encryption and decryption.
+    #
+    def compute_shared_key(private_key, public_key)
+      group = OpenSSL::PKey::EC::Group.new(CIPHER_CURVE)
+
+      private_key_bn   = OpenSSL::BN.new(private_key, BN_BASE)
+      public_key_bn    = OpenSSL::BN.new("02#{public_key}", BN_BASE)
+      public_key_point = OpenSSL::PKey::EC::Point.new(group, public_key_bn)
+
+      asn1 = OpenSSL::ASN1::Sequence(
+        [
+          OpenSSL::ASN1::Integer.new(1),
+          OpenSSL::ASN1::OctetString(private_key_bn.to_s(2)),
+          OpenSSL::ASN1::ObjectId(CIPHER_CURVE, 0, :EXPLICIT),
+          OpenSSL::ASN1::BitString(public_key_point.to_octet_string(:uncompressed), 1, :EXPLICIT)
+        ]
+      )
+
+      pkey = OpenSSL::PKey::EC.new(asn1.to_der)
+      pkey.dh_compute_key(public_key_point)
+    end
+
+    # Generates a SHA256 hash of a +Nostr::Event+
+    #
+    # @api private
+    #
+    # @param event [Event] The event to be hashed
+    #
+    # @return [String] A SHA256 digest of the event
+    #
+    def hash_event(event)
+      Digest::SHA256.hexdigest(JSON.dump(event.serialize))
+    end
+  end
+end

data/lib/nostr/errors/error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Nostr
+  # Base error class
+  class Error < StandardError
+  end
+end

data/lib/nostr/errors/invalid_hrp_error.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Nostr
+  # Raised when the human readable part of a Bech32 string is invalid
+  #
+  # @api public
+  #
+  class InvalidHRPError < KeyValidationError
+    # Initializes the error
+    #
+    # @example
+    #   InvalidHRPError.new('example wrong hrp', 'nsec')
+    #
+    # @param given_hrp [String] The given human readable part of the Bech32 string
+    # @param allowed_hrp [String] The allowed human readable part of the Bech32 string
+    #
+    def initialize(given_hrp, allowed_hrp)
+      super("Invalid hrp: #{given_hrp}. The allowed hrp value for this kind of entity is '#{allowed_hrp}'.")
+    end
+  end
+end

data/lib/nostr/errors/invalid_key_format_error.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Nostr
+  # Raised when the private key is in an invalid format
+  #
+  # @api public
+  #
+  class InvalidKeyFormatError < KeyValidationError
+    # Initializes the error
+    #
+    # @example
+    #   InvalidKeyFormatError.new('private'')
+    #
+    # @param [String] key_kind The kind of key that is invalid (public or private)
+    #
+    def initialize(key_kind)
+      super("Only lowercase hexadecimal characters are allowed in #{key_kind} keys.")
+    end
+  end
+end

data/lib/nostr/errors/invalid_key_length_error.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Nostr
+  # Raised when the private key's length is not 64 characters
+  #
+  # @api public
+  #
+  class InvalidKeyLengthError < KeyValidationError
+    # Initializes the error
+    #
+    # @example
+    #   InvalidKeyLengthError.new('private'')
+    #
+    # @param [String] key_kind The kind of key that is invalid (public or private)
+    #
+    def initialize(key_kind)
+      super("Invalid #{key_kind} key length. It should have 64 characters.")
+    end
+  end
+end

data/lib/nostr/errors/invalid_key_type_error.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Nostr
+  # Raised when the private key is not a string
+  #
+  # @api public
+  #
+  class InvalidKeyTypeError < KeyValidationError
+    # Initializes the error
+    #
+    # @example
+    #   InvalidKeyTypeError.new('private'')
+    #
+    # @param [String] key_kind The kind of key that is invalid (public or private)
+    #
+    def initialize(key_kind) = super("Invalid #{key_kind} key 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.rb

@@ -0,0 +1,8 @@
+# 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'

data/lib/nostr/event.rb

@@ -2,7 +2,65 @@
 
 module Nostr
   # The only object type that exists in Nostr is an event. Events are immutable.
-  class Event < EventFragment
+  class Event
+    # 32-bytes hex-encoded public key of the event creator
+    #
+    # @api public
+    #
+    # @example
+    #   event.pubkey # => '48df4af6e240ac5f7c5de89bf5941b249880be0e87d03685b178ccb1a315f52e'
+    #
+    # @return [String]
+    #
+    attr_reader :pubkey
+
+    # Date of the creation of the vent. A UNIX timestamp, in seconds
+    #
+    # @api public
+    #
+    # @example
+    #   event.created_at # => 1230981305
+    #
+    # @return [Integer]
+    #
+    attr_reader :created_at
+
+    # The kind of the event. An integer from 0 to 3
+    #
+    # @api public
+    #
+    # @example
+    #   event.kind # => 1
+    #
+    # @return [Integer]
+    #
+    attr_reader :kind
+
+    # An array of tags. Each tag is an array of strings
+    #
+    # @api public
+    #
+    # @example Tags referencing an event
+    #  event.tags #=> [["e", "event_id", "relay URL"]]
+    #
+    # @example Tags referencing a key
+    #  event.tags #=> [["p", "event_id", "relay URL"]]
+    #
+    # @return [Array<Array>]
+    #
+    attr_reader :tags
+
+    # An arbitrary string
+    #
+    # @api public
+    #
+    # @example
+    #  event.content # => 'Your feedback is appreciated, now pay $8'
+    #
+    # @return [String]
+    #
+    attr_reader :content
+
     # 32-bytes sha256 of the the serialized event data.
     # To obtain the event.id, we sha256 the serialized event. The serialization is done over the UTF-8 JSON-serialized
     # string (with no white space or line breaks)
@@ -12,9 +70,13 @@ module Nostr
     # @example Getting the event id
     #   event.id # => 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460'
     #
-    # @return [String]
+    # @example Setting the event id
+    #   event.id = 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460'
+    #   event.id # => 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460'
+    #
+    # @return [String|nil]
     #
-    attr_reader :id
+    attr_accessor :id
 
     # 64-bytes signature of the sha256 hash of the serialized event data, which is
     # the same as the "id" field
@@ -24,9 +86,13 @@ module Nostr
     # @example Getting the event signature
     #   event.sig # => ''
     #
-    # @return [String]
+    # @example Setting the event signature
+    #   event.sig = '058613f8d34c053294cc28b7f9e1f8f0e80fd1ac94fb20f2da6ca514e7360b39'
+    #   event.sig # => '058613f8d34c053294cc28b7f9e1f8f0e80fd1ac94fb20f2da6ca514e7360b39'
+    #
+    # @return [String|nil]
     #
-    attr_reader :sig
+    attr_accessor :sig
 
     # Instantiates a new Event
     #
@@ -44,16 +110,95 @@ module Nostr
     #          937c6d6e9855477638f5655c5d89c9aa5501ea9b578a66aced4f1cd7b3'
     # )
     #
-    #
-    # @param id [String] 32-bytes sha256 of the the serialized event data.
-    # @param sig [String] 64-bytes signature of the sha256 hash of the serialized event data, which is
+    # @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
     # the same as the "id" field
-    #
-    def initialize(id:, sig:, **kwargs)
-      super(**kwargs)
-
+    # @param pubkey [String] 32-bytes hex-encoded public key of the event creator.
+    # @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.
+    #
+    def initialize(
+      pubkey:,
+      kind:,
+      content:,
+      created_at: Time.now.to_i,
+      tags: [],
+      id: nil,
+      sig: nil
+    )
       @id = id
       @sig = sig
+      @pubkey = pubkey
+      @created_at = created_at
+      @kind = kind
+      @tags = tags
+      @content = content
+    end
+
+    # Adds a reference to an event id as an 'e' tag
+    #
+    # @api public
+    #
+    # @example Adding a reference to a pubkey
+    #   event_id = '189df012cfff8a075785b884bd702025f4a7a37710f581c4ac9d33e24b585408'
+    #   event.add_event_reference(event_id)
+    #
+    # @param event_id [String] 32-bytes hex-encoded event id.
+    #
+    # @return [Array<String>] The event's updated list of tags
+    #
+    def add_event_reference(event_id) = tags.push(['e', event_id])
+
+    # Adds a reference to a pubkey as a 'p' tag
+    #
+    # @api public
+    #
+    # @example Adding a reference to a pubkey
+    #   pubkey = '48df4af6e240ac5f7c5de89bf5941b249880be0e87d03685b178ccb1a315f52e'
+    #   event.add_pubkey_reference(pubkey)
+    #
+    # @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.to_s])
+
+    # Signs an event with the user's private key
+    #
+    # @api public
+    #
+    # @example Signing an event
+    #   event.sign(private_key)
+    #
+    # @param private_key [PrivateKey] 32-bytes hex-encoded private key.
+    #
+    # @return [Event] A signed event.
+    #
+    def sign(private_key)
+      crypto = Crypto.new
+      crypto.sign_event(self, private_key)
+    end
+
+    # Serializes the event, to obtain a SHA256 digest of it
+    #
+    # @api public
+    #
+    # @example Converting the event to a digest
+    #   event.serialize
+    #
+    # @return [Array] The event as an array.
+    #
+    def serialize
+      [
+        0,
+        pubkey,
+        created_at,
+        kind,
+        tags,
+        content
+      ]
     end
 
     # Converts the event to a hash

data/lib/nostr/event_kind.rb

@@ -31,5 +31,13 @@ module Nostr
     # @return [Integer]
     #
     CONTACT_LIST = 3
+
+    # A special event with kind 4, meaning "encrypted direct message". An event of this kind has its +content+
+    # equal to the base64-encoded, aes-256-cbc encrypted string of anything a user wants to write, encrypted using a
+    # shared cipher generated by combining the recipient's public-key with the sender's private-key.
+    #
+    # @return [Integer]
+    #
+    ENCRYPTED_DIRECT_MESSAGE = 4
   end
 end