nostrbase 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4252ebff99188df89893e516ba40d718e8a99baaba91612c1e23a3c07bd77c54
+  data.tar.gz: 3ab947cbfdf72ff1f9a0ed773b5cb37a91dd9f93f64798cbc9b234728db87e9e
+SHA512:
+  metadata.gz: 878e1eddc9932fc90afff2c0936f8b86ba2adbb0b751d5d313f75bf96bad92d8c13f1597b7bce3dd615eb78343598895d61376d5999fd2f47ce8b18a1f9935ab
+  data.tar.gz: dd3400c561d7945e038a03c84fdc80880ce087091814753ccd9352ac5e90e2046a7173a05d93a7654f58df027ce8db4874e6dd5012dc2548e734a1625852e7ee

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 3.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-11-27
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Viktor Vsk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,23 @@
+# Nostrbase
+
+TODO:
+
+## Installation
+
+TODO:
+
+## Usage
+
+TODO:
+
+## Development
+
+TODO:
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nostrbase.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/nostrbase/event.rb

@@ -0,0 +1,92 @@
+module Nostrbase
+  class Event
+    attr_reader :id, :pubkey, :created_at, :kind, :tags, :content, :sig, :errors
+
+    def self.sign_keys
+      @keys ||= Keys.new
+    end
+
+    def self.sign_secret=(secret_hex)
+      @keys = Keys.new(secret_hex)
+    end
+
+    def initialize(hash_or_json_payload)
+      payload = hash_or_json_payload.is_a?(Hash) ? hash_or_json_payload.map { |key, v| [key.to_s, v] }.to_h : JSON.parse(hash_or_json_payload)
+
+      @id = payload["id"]
+      @pubkey = payload["pubkey"]
+      @created_at = payload["created_at"]
+      @kind = payload["kind"]
+      @tags = payload["tags"]
+      @content = payload["content"]
+      @sig = payload["sig"]
+
+      @raw_payload = hash_or_json_payload
+      @errors = []
+    end
+
+    def signed?
+      sig.to_s.length.positive? && id.to_s.length.positive? && pubkey.to_s.length.positive?
+    end
+
+    def sign(allow_resign: false, keys: nil)
+      return false if signed? && !allow_resign
+
+      keys = self.class.sign_keys if keys.nil?
+
+      @pubkey = keys.public
+      @id = Digest::SHA256.hexdigest(JSON.dump(to_nostr_serialized))
+      @sig = keys.sign(id)
+    end
+
+    def sign!(keys: nil)
+      raise AlreadySigned, "Can't signed event that already has sig, id or pubkey present" if signed?
+      sign(keys: keys)
+    end
+
+    def resign(keys: nil)
+      sign(allow_resign: true, keys: keys)
+    end
+
+    def valid_schema?
+      @errors = NostrEventSchema.validate(@raw_payload)
+      @errors.size.negative?
+    end
+
+    def valid_id?
+      Digest::SHA256.hexdigest(JSON.dump(to_nostr_serialized)) === id
+    end
+
+    def valid_signature?
+      schnorr_sig = Secp256k1::SchnorrSignature.from_data([sig].pack("H*"))
+      schnorr_pubkey = Secp256k1::XOnlyPublicKey.from_data([pubkey].pack("H*"))
+
+      schnorr_sig.verify([id].pack("H*"), schnorr_pubkey)
+    rescue Secp256k1::DeserializationError
+      false
+    end
+
+    def to_nostr_serialized
+      [
+        0,
+        pubkey,
+        created_at.to_i,
+        kind.to_i,
+        tags,
+        content.to_s
+      ]
+    end
+
+    def as_json
+      {
+        id:,
+        pubkey:,
+        created_at:,
+        kind:,
+        tags:,
+        content:,
+        sig:
+      }
+    end
+  end
+end

data/lib/nostrbase/keys.rb

@@ -0,0 +1,20 @@
+module Nostrbase
+  class Keys
+    attr_reader :secret, :public
+
+    CONTEXT = Secp256k1::Context.create
+
+    def initialize(secret_hex = nil)
+      private_key_data = secret_hex ? Secp256k1::Util.hex_to_bin(secret_hex) : SecureRandom.random_bytes(32)
+      @secret = Secp256k1::Util.bin_to_hex(Secp256k1::PrivateKey.from_data(private_key_data).data)
+      @key_pair = CONTEXT.key_pair_from_private_key(private_key_data)
+
+      # Nostr ignores first byte of pubkey, more details here https://bips.xyz/340
+      @public = Secp256k1::Util.bin_to_hex(@key_pair.public_key.compressed)[2..]
+    end
+
+    def sign(message)
+      CONTEXT.sign_schnorr(@key_pair, [message].pack("H*")).serialized.unpack1("H*")
+    end
+  end
+end

data/lib/nostrbase/nostr_event_schema.rb

@@ -0,0 +1,68 @@
+module Nostrbase
+  class NostrEventSchema
+    SCHEMA = JSONSchemer.schema({
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      id: "nostr/nips/01/commands/client/EVENT/event/",
+      type: "object",
+      required: %w[content created_at id kind pubkey sig tags],
+      properties: {
+        content: {
+          type: "string",
+          id: "content"
+        },
+        created_at: {
+          type: "intger",
+          id: "created_at",
+          minimum: 0
+        },
+        id: {
+          type: "string",
+          id: "id",
+          minLength: 64,
+          maxLength: 64
+        },
+        kind: {
+          type: "integer",
+          id: "kind",
+          minimum: 0,
+          maxumum: 65535
+        },
+        pubkey: {
+          type: "string",
+          id: "pubkey",
+          minLength: 64,
+          maxLength: 64
+        },
+        sig: {
+          type: "string",
+          id: "sig",
+          minLength: 128,
+          maxLength: 128
+        },
+        tags: {
+          type: "array",
+          id: "tags/",
+          items: [
+            {
+              type: "array",
+              prefixItems: {
+                type: "string",
+                minLength: 1
+              },
+              minLength: 1
+            }
+          ]
+        }
+      }
+
+    }.to_json)
+
+    def self.validate(payload)
+      errors = []
+
+      SCHEMA.validate(payload).each { |error| errors.push(key: error["data_pointer"], value: JSONSchemer::Errors.pretty(error)) }
+
+      errors
+    end
+  end
+end

data/lib/nostrbase/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Nostrbase
+  VERSION = "0.1.0"
+end

data/lib/nostrbase.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "json"
+require "digest"
+require "json_schemer"
+require "rbsecp256k1"
+
+require_relative "nostrbase/version"
+
+require_relative "nostrbase/nostr_event_schema"
+require_relative "nostrbase/event"
+require_relative "nostrbase/keys"
+
+module Nostrbase
+  class AlreadySigned < StandardError; end
+end

data/sig/nostrbase.rbs

@@ -0,0 +1,4 @@
+module Nostrbase
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: nostrbase
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Viktor Vsk
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rbsecp256k1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: json_schemer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Create private and public keys, sign events and validate their signature
+  and schema
+email:
+- me@viktorvsk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nostrbase.rb
+- lib/nostrbase/event.rb
+- lib/nostrbase/keys.rb
+- lib/nostrbase/nostr_event_schema.rb
+- lib/nostrbase/version.rb
+- sig/nostrbase.rbs
+homepage: https://saltivka.org
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://saltivka.org
+  source_code_uri: https://saltivka.org
+  changelog_uri: https://saltivka.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.0.dev
+signing_key:
+specification_version: 4
+summary: Simple Nostr keys and events management
+test_files: []