nostr 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd56d59d68235fe8fa4bceb67df4a7e83d4b6a8295ed31cc0152002800ad7d23
-  data.tar.gz: 56b70ada7f9fd6cd29be1c7bc23b7a23adc49bfe2f8d8de48300f70709626a3e
+  metadata.gz: dcfeb88b78cad383e565b6e908be58f58e6f1002083044957ee0f09cf63228f4
+  data.tar.gz: ca2229181586e8bf5f329e4d5ac60ad346076fc8e39281dd43690d57ac98fcb7
 SHA512:
-  metadata.gz: be113a67cd651739cc3bac1deb4bba30e3598cfd787e8971a764e82d58c03ad1c918d3edd14630bbb1a5e2c6504c3c344859f0449a1774df7bb7bf0d3c38f537
-  data.tar.gz: c80bbf1f4d3caa25f48e1630b650587a2319197d7edba33e824b17e93f6355d8593c41364ad1fdb86a834d8cae63ad9f15e8feacae953b0ff8d7294f09c2c765
+  metadata.gz: 4511decc634548b75429db9166433060795295aea61cda64cd7b2b2647415db3808f4def27f8a4806d77b6fbaef88b11d08788254febd66bcfb7be318059cced
+  data.tar.gz: aef568e9fad07e0b387e3ae1437a50d08c81b59485c8aadd42cd9d7a035319b3da2bd5247e7d58fc890961eec5e0284d9299e6631c674cce3df3a5c210202bf2

data/.adr-dir

@@ -0,0 +1 @@
+adr

data/.editorconfig

@@ -6,6 +6,6 @@ max_line_length = 120
 trim_trailing_whitespace = true
 
 # 2 space indentation
-[*.rb]
+[{*.rb, *.mjs}]
 indent_style = space
 indent_size = 2

data/.rubocop.yml

@@ -5,12 +5,21 @@ require:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 3.2
+  TargetRubyVersion: 3.3
   DisplayCopNames: true
   NewCops: enable
 
+# ----------------------- Gemspec -----------------------
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
 # ----------------------- Style -----------------------
 
+Style/RaiseArgs:
+  Exclude:
+    - 'lib/nostr/key.rb'
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: single_quotes
@@ -38,3 +47,17 @@ Metrics/ParameterLists:
 
 RSpec/ExampleLength:
   Enabled: false
+
+RSpec/FilePath:
+  Exclude:
+    - spec/nostr/errors/invalid_*
+
+RSpec/SpecFilePathFormat:
+  Exclude:
+    - spec/nostr/errors/invalid_*
+
+# ----------------------- Naming -----------------------
+
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - 'spec/nostr/key.rb'

data/.tool-versions

@@ -1 +1,2 @@
-ruby 3.2.0
+ruby 3.3.0
+bun 1.0.30

data/CHANGELOG.md

@@ -1,9 +1,75 @@
 # Changelog
 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/)
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.1.1/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.6.0] 2024-03-15
+
+### Added
+
+- Added Architecture Decision Records (ADRs) to document architectural decisions
+- Added the `Signature` class to fix the primitive obsession with signatures and to make it easier to work with them
+- Added `valid_sig?` and `check_sig!` to the `Crypto` class to verify whether an event's signature is valid
+- Added `sign_message` to the `Crypto` class to sign a message
+- Added `verify_signature?` to the `Event` class to verify whether an event's signature is valid
+- Added `#to_ary` to the `KeyPair` class to enable keypair destructuring
+- Added RBS types for `schnorr`
+
+### Changed
+
+- Updated the required Ruby version to `3.3.0` (was `3.2.0`)
+- Updated the gem `dotenv` to version `3.1` (was `2.8`)
+- Updated the gem `bip-schnorr` to version `0.7` (was `0.6`)
+- Updated the gem `overcommit` to version `0.63` (was `0.59`)
+- Updated the gem `rbs` to version `3.4` (was `3.3`)
+- Updated the gem `rspec` to version `3.13` (was `3.12`)
+- Updated the gem `rspec-rubocop` to version `2.27` (was `2.25`)
+- Updated the gem `rubocop` to version `1.62` (was `1.57`)
+
+## Fixed
+
+- Fixed a typo in the README (`generate_keypair` -> `generate_key_pair`)
+- Fixed a typo in the YARD documentation of `Nostr::Key#initialize` (`ValidationError` -> `KeyValidationError`)
+
+### Fixed
+
+- Fixed YARD example rendering issues in `InvalidKeyFormatError#initialize`, `InvalidKeyLengthError#initialize`,
+`InvalidKeyTypeError#initialize`, `Event#initialize`, `EncryptedDirectMessage#initialize` and `Filter#to_h`
+
+## [0.5.0] 2023-11-20
+
+### Added
+
+- Added relay message type enums `Nostr::RelayMessageType`
+- Compliance with [NIP-19](https://github.com/nostr-protocol/nips/blob/master/19.md) - bech32-formatted strings
+- Added `Nostr::PrivateKey` and `Nostr::PublicKey` to represent private and public keys, respectively
+- Added a validation of private and public keys
+- Added an ability to convert keys to and from Bech32 format
+- Added RBS types for `faye-websocket` and `bech32`
+
+### Changed
+
+- Set the gem's homepage to [`https://nostr-ruby.com/`](https://nostr-ruby.com/)
+- Updated the filter's documentation to reflect the removal of prefix matching
+- Updated the subscription's id documentation to reflect the changes in the protocol definition
+- Updated `Nostr::PrivateKey` and `Nostr::PublicKey` internally, instead of Strings
+- Updated the gem `bip-schnorr` to version `0.6` (was `0.4`)
+- Updated the gem `puma` to version `6.4` (was `6.3`)
+- Updated the gem `rake` to version `13.1` (was `13.0`)
+- Updated the gem `rbs` to version `3.3` (was `2.8`)
+- Updated the gem `rubocop` to version `1.57` (was `1.42`)
+- Updated the gem `rubocop-rspec` to version `2.25` (was `2.16`)
+- Updated the gem `steep` to version `1.6` (was `1.4`)
+
+## Fixed
+
+- Fixed the RBS type of the constant `Nostr::Crypto::BN_BASE`
+- Fixed the return type of `Nostr::Crypto#decrypt_text` when given an invalid ciphertext
+- Fixed the RBS type of `Nostr::Filter#to_h`, `Nostr::Filter#e` and `Nostr::Filter#p`
+- Fixed the RBS types of `EventEmitter` and `EventMachine::Channel`
+- Fixed the generation of private keys
+
 ## [0.4.0] - 2023-02-25
 
 ### Removed
@@ -49,6 +115,9 @@ principles of immutability and was a major source of internal complexity as I ne
 
 - Initial release
 
+[0.6.0]: https://github.com/wilsonsilva/nostr/compare/v0.5.0...v0.6.0
+[0.5.0]: https://github.com/wilsonsilva/nostr/compare/v0.4.0...v0.5.0
+[0.4.0]: https://github.com/wilsonsilva/nostr/compare/v0.3.0...v0.4.0
 [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

@@ -1,34 +1,34 @@
 # Nostr
 
 [![Gem Version](https://badge.fury.io/rb/nostr.svg)](https://badge.fury.io/rb/nostr)
+![Build](https://github.com/wilsonsilva/nostr/actions/workflows/main.yml/badge.svg)
 [![Maintainability](https://api.codeclimate.com/v1/badges/c7633eb2c89eb95ee7f2/maintainability)](https://codeclimate.com/github/wilsonsilva/nostr/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/c7633eb2c89eb95ee7f2/test_coverage)](https://codeclimate.com/github/wilsonsilva/nostr/test_coverage)
 
-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.
+Asynchronous Nostr client for Rubyists.
 
 ## 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)
+- [Key features](#-key-features)
+- [Installation](#-installation)
+- [Quickstart](#-quickstart)
+- [Documentation](#-documentation)
+- [Implemented NIPs](#-implemented-nips)
+- [Development](#-development)
   * [Type checking](#type-checking)
-- [Contributing](#contributing)
-- [License](#license)
-- [Code of Conduct](#code-of-conduct)
+- [Contributing](#-contributing)
+- [License](#-license)
+- [Code of Conduct](#-code-of-conduct)
 
-## Installation
+## 🔑 Key features
+
+- Asynchronous
+- Easy to use
+- Fully documented
+- Fully tested
+- Fully typed
+
+## 📦 Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
@@ -38,243 +38,103 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install nostr
 
-## Usage
+## ⚡️ Quickstart
 
-### Requiring the gem
-
-All examples below assume that the gem has been required.
+Here is a quick example of how to use the gem. For more detailed documentation, please check the
+[documentation website](https://nostr-ruby.com).
 
 ```ruby
+# Require the gem
 require 'nostr'
-```
-
-### Generating a keypair
-
-```ruby
-keygen  = Nostr::Keygen.new
-keypair = keygen.generate_key_pair
-
-keypair.private_key
-keypair.public_key
-```
-
-### Generating a private key and a public key
 
-```ruby
-keygen  = Nostr::Keygen.new
+# Instantiate a client
+client = Nostr::Client.new
 
-private_key = keygen.generate_private_key
-public_key  = keygen.extract_public_key(private_key)
-```
+# a) Use an existing keypair
+keypair = Nostr::KeyPair.new(
+  private_key: Nostr::PrivateKey.new('add-your-hex-private-key-here'),
+  public_key: Nostr::PublicKey.new('add-your-hex-public-key-here'),
+)
 
-### Connecting to a Relay
+# b) Or build a keypair from a private key
+keygen = Nostr::Keygen.new
+keypair = keygen.get_key_pair_from_private_key(
+  Nostr::PrivateKey.new('add-your-hex-private-key-here')
+)
 
-Clients can connect to multiple Relays. In this version, a Client can only connect to a single Relay at a time.
+# c) Or create a new keypair
+keygen = Nostr::Keygen.new
+keypair = keygen.generate_key_pair
 
-You may instantiate multiple Clients and multiple Relays.
+# Create a user with the keypair
+user = Nostr::User.new(keypair: keypair)
 
-```ruby
-client = Nostr::Client.new
-relay  = Nostr::Relay.new(url: 'wss://relay.damus.io', name: 'Damus')
+# Create a signed event
+text_note_event = user.create_event(
+  kind: Nostr::EventKind::TEXT_NOTE,
+  content: 'Your feedback is appreciated, now pay $8'
+)
 
+# Connect asynchronously to a relay
+relay = Nostr::Relay.new(url: 'wss://nostr.wine', name: 'Wine')
 client.connect(relay)
-```
-
-### WebSocket events
-
-All communication between clients and relays happen in WebSockets.
-
-The `:connect` event is fired when a connection with a WebSocket is opened. You must call `Nostr::Client#connect` first.
 
-```ruby
+# Listen asynchronously for the connect event
 client.on :connect do
-  # all the code goes here
-end
-```
-
-The `:close` event is fired when a connection with a WebSocket has been closed because of an error.
-
-```ruby
-client.on :error do |error_message|
-  puts error_message
-end
-
-# > Network error: wss://rsslay.fiatjaf.com: Unable to verify the server certificate for 'rsslay.fiatjaf.com'
-```
-
-The `:message` event is fired when data is received through a WebSocket.
-
-```ruby
-client.on :message do |message|
-  puts message
-end
-
-# [
-#   "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.
-
-```ruby
-client.on :close do |code, reason|
-  # you may attempt to reconnect
-
-  client.connect(relay)
-end
-```
-
-### Requesting for events / creating a subscription
-
-A client can request events and subscribe to new updates after it has established a connection with the Relay.
+  # Send the event to the Relay
+  client.publish(text_note_event)
 
-You may use a `Nostr::Filter` instance with as many attributes as you wish:
-
-```ruby
-client.on :connect do
+  # Create a filter to receive the first 20 text notes
+  # and encrypted direct messages from the relay that
+  # were created in the previous hour
   filter = Nostr::Filter.new(
-    ids: ['8535d5e2d7b9dc07567f676fbe70428133c9884857e1915f5b1cc6514c2fdff8'],
-    authors: ['ae00f88a885ce76afad5cbb2459ef0dcf0df0907adc6e4dac16e1bfbd7074577'],
-    kinds: [Nostr::EventKind::TEXT_NOTE],
-    e: ["f111593a72cc52a7f0978de5ecf29b4653d0cf539f1fa50d2168fc1dc8280e52"],
-    p: ["f1f9b0996d4ff1bf75e79e4cc8577c89eb633e68415c7faf74cf17a07bf80bd8"],
-    since: 1230981305,
-    until: 1292190341,
-    limit: 420,
+    kinds: [
+      Nostr::EventKind::TEXT_NOTE,
+      Nostr::EventKind::ENCRYPTED_DIRECT_MESSAGE
+    ],
+    since: Time.now.to_i - 3600, # 1 hour ago
+    until: Time.now.to_i,
+    limit: 20,
   )
 
-  subscription = client.subscribe('a_random_subscription_id', filter)
-end
-```
-
-With just a few:
+  # Subscribe to events matching conditions of a filter
+  subscription = client.subscribe(filter: filter)
 
-```ruby
-client.on :connect do
-  filter = Nostr::Filter.new(kinds: [Nostr::EventKind::TEXT_NOTE])
-  subscription = client.subscribe('a_random_subscription_id', filter)
+  # Unsubscribe from events matching the filter above
+  client.unsubscribe(subscription.id)
 end
-```
-
-Or omit the filter:
 
-```ruby
-client.on :connect do
-  subscription = client.subscribe('a_random_subscription_id')
+# Listen for incoming messages and print them
+client.on :message do |message|
+  puts message
 end
-```
 
-Or even omit the subscription id:
-
-```ruby
-client.on :connect do
-  subscription = client.subscribe('a_random_subscription_id')
+# Listen for error messages
+client.on :error do |error_message|
+  # Handle the error
 end
-```
-
-### Stop previous subscriptions
-
-You can stop receiving messages from a subscription by calling `#unsubscribe`:
-
-```ruby
-client.unsubscribe('your_subscription_id')
-```
-
-### Publishing an event
 
-To publish an event you need a keypair.
-
-```ruby
-# Set up the private key
-private_key = 'a630b06e2f883378d0aa335b9adaf7734603e00433350b684fe53e184f08c58f'
-user = Nostr::User.new(private_key)
-
-# Create a signed event
-event = user.create_event(
-  created_at: 1667422587, # optional, defaults to the current time
-  kind: Nostr::EventKind::TEXT_NOTE,
-  tags: [], # optional, defaults to []
-  content: 'Your feedback is appreciated, now pay $8'
-)
-
-# Send it to the Relay
-client.publish(event)
-```
-
-### 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)
+# Listen for the close event
+client.on :close do |code, reason|
+  # You may attempt to reconnect to the relay here
+end
 ```
 
-### Sending an encrypted direct message
+## 📚 Documentation
 
-```ruby
-sender_private_key = '3185a47e3802f956ca5a2b4ea606c1d51c7610f239617e8f0f218d55bdf2b757'
+I made a detailed documentation for this gem and it's usage. The code is also fully documented using YARD.
 
-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"]]>
+- [Guide documentation](https://nostr-ruby.com)
+- [YARD documentation](https://rubydoc.info/gems/nostr)
 
-# Send it to the Relay
-client.publish(encrypted_direct_message)
-````
+## ✅ Implemented NIPs
 
-## Implemented NIPs
+- [x] [NIP-01 - Basic protocol flow description](https://github.com/nostr-protocol/nips/blob/master/01.md)
+- [x] [NIP-02 - Contact List and Petnames](https://github.com/nostr-protocol/nips/blob/master/02.md)
+- [x] [NIP-04 - Encrypted Direct Message](https://github.com/nostr-protocol/nips/blob/master/04.md)
+- [x] [NIP-19 - Bech32-encoded entities](https://github.com/nostr-protocol/nips/blob/master/19.md)
 
-- [x] [NIP-01 - Client](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
+## 🔨 Development
 
 After checking out the repo, run `bin/setup` to install dependencies.
 
@@ -318,17 +178,22 @@ used to provide type checking and autocompletion in your editor. Run `bundle exe
 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
+## 🐞 Issues & Bugs
+
+If you find any issues or bugs, please report them [here](https://github.com/wilsonsilva/nostr/issues), I will be happy
+to have a look at them and fix them as soon as possible.
+
+## 🤝 Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/wilsonsilva/nostr.
 This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere
 to the [code of conduct](https://github.com/wilsonsilva/nostr/blob/main/CODE_OF_CONDUCT.md).
 
-## License
+## 📜 License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## Code of Conduct
+## 👔 Code of Conduct
 
 Everyone interacting in the Nostr project's codebases, issue trackers, chat rooms and mailing lists is expected
 to follow the [code of conduct](https://github.com/wilsonsilva/nostr/blob/main/CODE_OF_CONDUCT.md).

data/adr/0001-record-architecture-decisions.md

@@ -0,0 +1,19 @@
+# 1. Record architecture decisions
+
+Date: 2024-03-13
+
+## Status
+
+Accepted
+
+## Context
+
+We need to record the architectural decisions made on this project.
+
+## Decision
+
+We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
+
+## Consequences
+
+See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).

data/adr/0002-introduction-of-signature-class.md

@@ -0,0 +1,27 @@
+# 2. introduction-of-signature-class
+
+Date: 2024-03-14
+
+## Status
+
+Accepted
+
+## Context
+
+I noticed significant overuse of primitive strings for signatures, which led to widespread and repetitive validation logic, increasing the potential for errors and making the system harder to manage and maintain.
+
+## Decision
+
+I introduced the Nostr::Signature class, choosing to subclass String to leverage string-like behavior while embedding specific validation rules for signatures. This move was aimed at streamlining validation, ensuring consistency, and maintaining the usability of strings.
+
+## Consequences
+
+### Positive
+
+- This design choice has made the codebase cleaner and more robust, reducing the chances of errors related to signature handling. It ensures that all signature instances are valid at creation, leveraging the familiarity and flexibility of string operations without sacrificing the integrity of the data. Moreover, it sets a strong foundation for extending signature-related functionality in the future.
+
+### Negative
+
+- __Performance Concerns:__ Subclassing String might introduce slight performance overheads due to the additional validation logic executed upon instantiation of a Signature object.
+- __Integration Challenges:__ Integrating this class into existing systems where strings were used indiscriminately for signatures requires careful refactoring to ensure compatibility. There's also the potential for issues when passing Nostr::Signature objects to libraries or APIs expecting plain strings without the additional constraints.
+- __Learning Curve:__ For new team members or contributors, understanding the necessity and functionality of the Nostr::Signature class adds to the learning curve, potentially slowing down initial development efforts as they familiarize themselves with the custom implementation.

data/docs/.gitignore

@@ -0,0 +1,4 @@
+/node_modules/
+.vitepress/dist
+.vitepress/temp
+.vitepress/cache