nostr 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90770e269f0c966f76013797314b9e3b4b0743fa57f5b84f2460371b413bc5f1
-  data.tar.gz: 7a4a908a6c1b086781d26dc6f45c289a85859e12e1e854451a0e9f8e75f5fa06
+  metadata.gz: cd56d59d68235fe8fa4bceb67df4a7e83d4b6a8295ed31cc0152002800ad7d23
+  data.tar.gz: 56b70ada7f9fd6cd29be1c7bc23b7a23adc49bfe2f8d8de48300f70709626a3e
 SHA512:
-  metadata.gz: 35a4401f078587bed79d6063f4051cca3f8dc170c074c552a202fee7872b75668eb8204a5f6db09f810ed0c5bb84026438d7e942f48a4825d63ba64552d032c7
-  data.tar.gz: b9400efc3228dea17e23e40803e2e7b94ce9966e6a729fcf5ea0b79ffcea07b7e51f7fd9703d01af1d287ffdaf85b6b8d49d325813b8e32518a0be240537e86e
+  metadata.gz: be113a67cd651739cc3bac1deb4bba30e3598cfd787e8971a764e82d58c03ad1c918d3edd14630bbb1a5e2c6504c3c344859f0449a1774df7bb7bf0d3c38f537
+  data.tar.gz: c80bbf1f4d3caa25f48e1630b650587a2319197d7edba33e824b17e93f6355d8593c41364ad1fdb86a834d8cae63ad9f15e8feacae953b0ff8d7294f09c2c765

data/.rubocop.yml

@@ -31,6 +31,9 @@ Metrics/BlockLength:
     - '**/*_spec.rb'
     - nostr.gemspec
 
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
 # ----------------------- RSpec -----------------------
 
 RSpec/ExampleLength:

data/CHANGELOG.md

@@ -4,6 +4,41 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.4.0] - 2023-02-25
+
+### Removed
+
+- Removed `EventFragment` class. The `Event` class is no longer a Value Object. In other words, it is no longer
+immutable and it may be invalid by not having attributes `id` or `sig`. The `EventFragment` abstraction, along with the
+principles of immutability and was a major source of internal complexity as I needed to scale the codebase.
+
+### Added
+
+- Client compliance with [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md) (encrypted direct messages)
+- Extracted the cryptographic concerns into a `Crypto` class.
+- Added the setters `Event#id=` and `Event#sig=`
+- Added a method on the event class to sign events (`Event#sign`)
+- Added a missing test for `EventKind::CONTACT_LIST`
+- Added two convenience methods to append event and pubkey references to an event's tags `add_event_reference` and
+`add_pubkey_reference`
+
+### Fixed
+
+- Fixed the generation of public keys
+- Fixed the RBS signature of `User#create_event`
+
+## [0.3.0] - 2023-02-15
+
+### Added
+
+- Client compliance wth [NIP-02](https://github.com/nostr-protocol/nips/blob/master/02.md) (manage contact lists)
+- RBS type checking using Steep and TypeProf
+
+## Fixed
+
+- Fixed a documentation typo
+- Fixed a documentation error regarding the receiving of messages via websockets
+
 ## [0.2.0] - 2023-01-12
 
 ### Added
@@ -14,5 +49,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Initial release
 
+[0.3.0]: https://github.com/wilsonsilva/nostr/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/wilsonsilva/nostr/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/wilsonsilva/nostr/compare/7fded5...v0.1.0

data/README.md

@@ -7,6 +7,27 @@
 Asynchronous Nostr client. Please note that the API is likely to change as the gem is still in development and
 has not yet reached a stable release. Use with caution.
 
+## Table of contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+  * [Requiring the gem](#requiring-the-gem)
+  * [Generating a keypair](#generating-a-keypair)
+  * [Generating a private key and a public key](#generating-a-private-key-and-a-public-key)
+  * [Connecting to a Relay](#connecting-to-a-relay)
+  * [WebSocket events](#websocket-events)
+  * [Requesting for events / creating a subscription](#requesting-for-events--creating-a-subscription)
+  * [Stop previous subscriptions](#stop-previous-subscriptions)
+  * [Publishing an event](#publishing-an-event)
+  * [Creating/updating your contact list](#creatingupdating-your-contact-list)
+  * [Sending an encrypted direct message](#sending-an-encrypted-direct-message)
+- [Implemented NIPs](#implemented-nips)
+- [Development](#development)
+  * [Type checking](#type-checking)
+- [Contributing](#contributing)
+- [License](#license)
+- [Code of Conduct](#code-of-conduct)
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -27,12 +48,11 @@ All examples below assume that the gem has been required.
 require 'nostr'
 ```
 
-
 ### Generating a keypair
 
 ```ruby
 keygen  = Nostr::Keygen.new
-keypair = keygen.generate_keypair
+keypair = keygen.generate_key_pair
 
 keypair.private_key
 keypair.public_key
@@ -55,7 +75,7 @@ You may instantiate multiple Clients and multiple Relays.
 
 ```ruby
 client = Nostr::Client.new
-relay = Nostr::Relay.new(url: 'wss://relay.damus.io', name: 'Damus')
+relay  = Nostr::Relay.new(url: 'wss://relay.damus.io', name: 'Damus')
 
 client.connect(relay)
 ```
@@ -82,14 +102,28 @@ end
 # > Network error: wss://rsslay.fiatjaf.com: Unable to verify the server certificate for 'rsslay.fiatjaf.com'
 ```
 
-The `:message` event is fired whenwhen data is received through a WebSocket.
+The `:message` event is fired when data is received through a WebSocket.
 
 ```ruby
 client.on :message do |message|
   puts message
 end
 
-# > Network error: wss://rsslay.fiatjaf.com: Unable to verify the server certificate for 'rsslay.fiatjaf.com'
+# [
+#   "EVENT",
+#   "d34107357089bfc9882146d3bfab0386",
+#   {
+#     "content":"",
+#     "created_at":1676456512,
+#     "id":"18f63550da74454c5df7caa2a349edc5b2a6175ea4c5367fa4b4212781e5b310",
+#     "kind":3,
+#     "pubkey":"117a121fa41dc2caa0b3d6c5b9f42f90d114f1301d39f9ee96b646ebfee75e36",
+#     "sig":"d171420bd62cf981e8f86f2dd8f8f86737ea2bbe2d98da88db092991d125535860d982139a3c4be39886188613a9912ef380be017686a0a8b74231dc6e0b03cb",
+#     "tags":[
+#       ["p","1cc821cc2d47191b15fcfc0f73afed39a86ac6fb34fbfa7993ee3e0f0186ef7c"]
+#     ]
+#   }
+# ]
 ```
 
 The `:close` event is fired when a connection with a WebSocket is closed.
@@ -179,10 +213,66 @@ event = user.create_event(
 client.publish(event)
 ```
 
-## NIPS
+### Creating/updating your contact list
+
+Every new contact list that gets published overwrites the past ones, so it should contain all entries.
+
+```ruby
+# Creating a contact list event with 2 contacts
+update_contacts_event = user.create_event(
+  kind: Nostr::EventKind::CONTACT_LIST,
+  tags: [
+    [
+      "p", # mandatory
+      "32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245", # public key of the user to add to the contacts
+      "wss://alicerelay.com/", # can be an empty string or can be omitted
+      "alice" # can be an empty string or can be omitted
+    ],
+    [
+      "p", # mandatory
+      "3efdaebb1d8923ebd99c9e7ace3b4194ab45512e2be79c1b7d68d9243e0d2681", # public key of the user to add to the contacts
+      "wss://bobrelay.com/nostr", # can be an empty string or can be omitted
+      "bob" # can be an empty string or can be omitted
+    ],
+  ],
+)
+
+# Send it to the Relay
+client.publish(update_contacts_event)
+```
+
+### Sending an encrypted direct message
+
+```ruby
+sender_private_key = '3185a47e3802f956ca5a2b4ea606c1d51c7610f239617e8f0f218d55bdf2b757'
+
+encrypted_direct_message = Nostr::Events::EncryptedDirectMessage.new(
+   sender_private_key: sender_private_key,
+   recipient_public_key: '6c31422248998e300a1a457167565da7d15d0da96651296ee2791c29c11b6aa0',
+   plain_text: 'Your feedback is appreciated, now pay $8',
+   previous_direct_message: 'ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460' # optional
+)
+
+encrypted_direct_message.sign(sender_private_key)
+
+# #<Nostr::Events::EncryptedDirectMessage:0x0000000104c9fa68
+# @content="mjIFNo1sSP3KROE6QqhWnPSGAZRCuK7Np9X+88HSVSwwtFyiZ35msmEVoFgRpKx4?iv=YckChfS2oWCGpMt1uQ4GbQ==",
+#   @created_at=1676456512,
+#   @id="daac98826d5eb29f7c013b6160986c4baf4fe6d4b995df67c1b480fab1839a9b",
+#   @kind=4,
+#   @pubkey="8a9d69c56e3c691bec8f9565e4dcbe38ae1d88fffeec3ce66b9f47558a3aa8ca",
+#   @sig="028bb5f5bab0396e2065000c84a4bcce99e68b1a79bb1b91a84311546f49c5b67570b48d4a328a1827e7a8419d74451347d4f55011a196e71edab31aa3d6bdac",
+#   @tags=[["p", "6c31422248998e300a1a457167565da7d15d0da96651296ee2791c29c11b6aa0"], ["e", "ccf9fdf3e1466d7c20969c71ec98defcf5f54aee088513e1b73ccb7bd770d460"]]>
+
+# Send it to the Relay
+client.publish(encrypted_direct_message)
+````
+
+## Implemented NIPs
 
 - [x] [NIP-01 - Client](https://github.com/nostr-protocol/nips/blob/master/01.md)
-- [ ] [NIP-01 - Relay](https://github.com/nostr-protocol/nips/blob/master/01.md)
+- [x] [NIP-02 - Client](https://github.com/nostr-protocol/nips/blob/master/02.md)
+- [x] [NIP-04 - Client](https://github.com/nostr-protocol/nips/blob/master/04.md)
 
 ## Development
 
@@ -200,17 +290,34 @@ The health and maintainability of the codebase is ensured through a set of
 Rake tasks to test, lint and audit the gem for security vulnerabilities and documentation:
 
 ```
-rake bundle:audit          # Checks for vulnerable versions of gems
-rake qa                    # Test, lint and perform security and documentation audits
-rake rubocop               # Lint the codebase with RuboCop
-rake rubocop:auto_correct  # Auto-correct RuboCop offenses
-rake spec                  # Run RSpec code examples
-rake verify_measurements   # Verify that yardstick coverage is at least 100%
-rake yard                  # Generate YARD Documentation
-rake yard:junk             # Check the junk in your YARD Documentation
-rake yardstick_measure     # Measure docs in lib/**/*.rb with yardstick
+rake build                    # Build nostr.gem into the pkg directory
+rake build:checksum           # Generate SHA512 checksum if nostr.gem into the checksums directory
+rake bundle:audit:check       # Checks the Gemfile.lock for insecure dependencies
+rake bundle:audit:update      # Updates the bundler-audit vulnerability database
+rake clean                    # Remove any temporary products
+rake clobber                  # Remove any generated files
+rake coverage                 # Run spec with coverage
+rake install                  # Build and install nostr.gem into system gems
+rake install:local            # Build and install nostr.gem into system gems without network access
+rake qa                       # Test, lint and perform security and documentation audits
+rake release[remote]          # Create a tag, build and push nostr.gem to rubygems.org
+rake rubocop                  # Run RuboCop
+rake rubocop:autocorrect      # Autocorrect RuboCop offenses (only when it's safe)
+rake rubocop:autocorrect_all  # Autocorrect RuboCop offenses (safe and unsafe)
+rake spec                     # Run RSpec code examples
+rake verify_measurements      # Verify that yardstick coverage is at least 100%
+rake yard                     # Generate YARD Documentation
+rake yard:junk                # Check the junk in your YARD Documentation
+rake yardstick_measure        # Measure docs in lib/**/*.rb with yardstick
 ```
 
+### Type checking
+
+This gem leverages [RBS](https://github.com/ruby/rbs), a language to describe the structure of Ruby programs. It is
+used to provide type checking and autocompletion in your editor. Run `bundle exec typeprof FILENAME` to generate
+an RBS definition for the given Ruby file. And validate all definitions using [Steep](https://github.com/soutaro/steep)
+with the command `bundle exec steep check`.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/wilsonsilva/nostr.

data/Steepfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+target :lib do
+  signature 'sig'
+
+  check 'lib'
+
+  # Core libraries
+  library 'base64'
+  library 'digest'
+  library 'openssl'
+  library 'securerandom'
+
+  # Gems
+  library 'json'
+end

data/lib/nostr/crypto.rb

@@ -0,0 +1,143 @@
+# 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 [String] 32-bytes hex-encoded private key of the creator.
+    # @param recipient_public_key [String] 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 [String] 32-bytes hex-encoded public key of the message creator.
+    # @param recipient_private_key [String] 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=')
+      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 [String] 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 [String] 32-bytes hex-encoded private key.
+    # @param public_key [String] 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/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,96 @@ 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 [String] 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])
+
+    # Signs an event with the user's private key
+    #
+    # @api public
+    #
+    # @example Signing an event
+    #   event.sign(private_key)
+    #
+    # @param private_key [String] 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

@@ -24,5 +24,20 @@ module Nostr
     # @return [Integer]
     #
     RECOMMEND_SERVER = 2
+
+    # A special event with kind 3, meaning "contact list" is defined as having a list of p tags, one for each of
+    # the followed/known profiles one is following.
+    #
+    # @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