nanocurrency 0.1.0

data/lib/nano/hash.rb

@@ -0,0 +1,43 @@
+require "blake2b"
+require_relative "./conversion"
+require_relative "./utils"
+
+module Nano
+  ##
+  # The Hash module is responsible for producing a block hash given a
+  # Block object.
+  module Hash
+    extend self
+
+    STATE_BLOCK_PREAMBLE_BITS = Nano::Utils.bytes_to_bin(
+      Array.new(32) {|i| i == 31 ? 6 : 0}
+    ).freeze
+
+    ##
+    # This method will produce a hash for the given block
+    #
+    # @param block [Nano::Block] The block to derive a hash from
+    #
+    # @return [String] The hash in a hexadecimal formatted string.
+    def hash_block(block)
+      account_bits = Nano::Utils.hex_to_bin(
+        Nano::Key.derive_public_key(block.account)
+      )
+      previous_bits = Nano::Utils.hex_to_bin(
+        block.previous
+      )
+      representative_bits = Nano::Utils.hex_to_bin(
+        Nano::Key.derive_public_key(block.representative)
+      )
+      balance_bits = Nano::Utils.hex_to_bin(
+        Nano::Unit.convert(block.balance, :raw, :hex)
+      )
+      link_bits = Nano::Utils.hex_to_bin(
+        block.link
+      )
+      bits = STATE_BLOCK_PREAMBLE_BITS + account_bits + previous_bits +
+             representative_bits + balance_bits + link_bits;
+      Blake2b.hex(bits).upcase
+    end
+  end
+end

data/lib/nano/key.rb

@@ -0,0 +1,69 @@
+require "securerandom"
+require "blake2b"
+require "nanocurrency_ext"
+require_relative "./account"
+require_relative "./check"
+
+module Nano
+  ##
+  # The key module is responsible for handling the key and seed based
+  # operations in the Nano module.
+  module Key
+    extend self
+
+    ##
+    # Generates a 32 byte seed as a hexidecimal string. Cryptographically
+    # secure.
+    # return [String] A 64 length string of hexidecimal.
+    def generate_seed
+      SecureRandom.hex(32)
+    end
+
+    ##
+    # Derive a secret key from a seed, given an index.
+    # @param seed [String] The seed to generate the secret key from,
+    #   in hexadecimal format
+    # @param index [Integer] The index to generate the secret key from
+    def derive_secret_key(seed, index)
+      raise(
+        ArgumentError, "Seed is invalid"
+      ) unless Nano::Check.is_seed_valid?(seed)
+      raise(
+        ArgumentError, "Index is invalid"
+      ) unless Nano::Check.is_index_valid?(index)
+
+      seed_bin = Nano::Utils.hex_to_bin(seed)
+      Blake2b.hex(seed_bin + [index].pack('L>'), Blake2b::Key.none, 32).upcase
+    end
+
+    def derive_public_key(input)
+      is_secret_key = Nano::Check.is_key?(input)
+      account = Nano::Account.from_address(input)
+      is_address = !account.nil?
+      raise ArgumentError, "Incorrect input" unless is_secret_key || is_address
+
+      if is_secret_key
+        res = NanocurrencyExt.public_key(Nano::Utils.hex_to_bin(input))
+        Nano::Utils.bin_to_hex(res).upcase
+      else
+        account.public_key
+      end
+    end
+
+    def derive_address(public_key, prefix = "nano_")
+      is_public_key = Nano::Check.is_key?(public_key)
+      raise ArgumentError, "Incorrect key type" unless is_public_key
+
+      is_valid_prefix = prefix == "nano_" || prefix == "xrb_"
+      raise ArgumentError, "Invalid prefix" unless is_valid_prefix
+
+      public_key_bytes = Nano::Utils.hex_to_bytes public_key
+      public_key_enc = Nano::Base32.encode public_key_bytes
+      pk_bin = Nano::Utils.hex_to_bin(public_key)
+      checksum = Blake2b.hex(pk_bin, Blake2b::Key.none, 5)
+      checksum_bytes = Nano::Utils.hex_to_bytes(checksum).reverse
+      enc_chk = Nano::Base32.encode(checksum_bytes)
+      "#{prefix}#{public_key_enc}#{enc_chk}"
+    end
+  end
+end

data/lib/nano/utils.rb

@@ -0,0 +1,45 @@
+module Nano
+  module Utils
+    extend self
+
+    ##
+    # Converts a byte array into hexidecimal string
+    # @param bytes [Array<Int8>] An array of integers representing bytes.
+    # @return [String] A hexidecimal byte string.
+    def bytes_to_hex(bytes)
+      bytes.map { |x| "%02X" % x }.join
+    end
+
+    ##
+    # Converts a hexidecimal string into a byte array.
+    # @param hex [String] A hexidecimal string of arbitrary length.
+    # @return [Array<Int8>] An array of integers representing the hex string.
+    def hex_to_bytes(hex)
+      hex.scan(/../).map { |x| x.hex }
+    end
+
+    ##
+    # Converts a hex string into a binary.
+    # @param hex [String] A hexidecimal string of arbitrary length.
+    # @return [Binary] A binary representing the hex string
+    def hex_to_bin(hex)
+      bytes_to_bin(hex_to_bytes(hex))
+    end
+
+    ##
+    # Converts a binary into a hexidecimal string
+    # @param bin [Binary] The binary value.
+    # @return [String] The hexidecimal string representing the binary value.
+    def bin_to_hex(bin)
+      bin.unpack('H*').first
+    end
+
+    ##
+    # Converts a byte array into a binary value.
+    # @param bytes [Array<Int8>] The byte array of integers.
+    # @return [Binary] The binary value representing the byte array.
+    def bytes_to_bin(bytes)
+      bytes.pack("C*")
+    end
+  end
+end

data/lib/nano/work.rb

@@ -0,0 +1,51 @@
+require "blake2b"
+require "nanocurrency_ext"
+require_relative "./check"
+
+module Nano
+
+  ##
+  # This module is responsible for generating and validating the proof
+  # of work for a block hash
+  module Work
+    extend self
+
+    ##
+    # The maximum value a nonce can be
+    MAX_NONCE = 0xffffffffffffffff
+
+    ##
+    # The minimum threshold a proof of work needs to meet to be valid.
+    WORK_THRESHOLD = Integer(0xffffffc000000000)
+
+    ##
+    # Compute the proof of work for the hash.
+    # @param hash [String] the previous block hash to compute the work for.
+    # @return [String] the computed work as an 8 byte hex string.
+    def compute_work(hash)
+      NanocurrencyExt.compute_work(hash)
+    end
+
+    ##
+    # Checks if a proof of work is valid for the hash
+    # @param hash [String] The block hash the work was calculated for.
+    # @param work [String] The block work that was calculated for the hash.
+    # @return [Boolean] true if the work is valid and fits for the block hash.
+    def is_work_valid?(hash, work)
+      hash_valid = Nano::Check.is_hash_valid?(hash)
+      work_valid = Nano::Check.is_work_valid?(work)
+      throw ArgumentError, "Invalid block hash" unless hash_valid
+      throw ArgumentError, "Invalid work" unless work_valid
+
+      hash_bin = Nano::Utils.hex_to_bin(hash)
+      work_bin = Nano::Utils.hex_to_bin(work).reverse
+
+      input = work_bin + hash_bin
+      output_hex = Nano::Utils.bytes_to_hex(
+        Blake2b.bytes(input, Blake2b::Key.none, 8).reverse
+      )
+
+      output_hex.to_i(16) >= WORK_THRESHOLD
+    end
+  end
+end

data/lib/nanocurrency.rb

@@ -0,0 +1,7 @@
+require "nanocurrency/version"
+require "nano/base32"
+require "nano/block"
+require "nano/check"
+require "nano/conversion"
+require "nano/key"
+require "nano/work"

data/lib/nanocurrency/version.rb

@@ -0,0 +1,3 @@
+module Nanocurrency
+  VERSION = "0.1.0"
+end

data/nanocurrency.gemspec

@@ -0,0 +1,44 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nanocurrency/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nanocurrency"
+  spec.version       = Nanocurrency::VERSION
+  spec.authors       = ["Elliott Minns"]
+  spec.email         = ["elliott@nanotify.io"]
+
+  spec.summary       = "A toolkit for the Nano cryptocurrency, allowing you to derive keys, generate seeds, hashes, signatures, proofs of work and blocks."
+  spec.description   = "A toolkit for the Nano cryptocurrency, allowing you to derive keys, generate seeds, hashes, signatures, proofs of work and blocks."
+  spec.homepage      = "https://github.com/nanotify/nanocurrency"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/nanotify/nanocurrency.git"
+    spec.metadata["changelog_uri"] = "https://github.com/nanotify/nanocurrency"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "blake2b"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rake-compiler", "~> 1.0"
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: nanocurrency
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elliott Minns
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: blake2b
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A toolkit for the Nano cryptocurrency, allowing you to derive keys, generate
+  seeds, hashes, signatures, proofs of work and blocks.
+email:
+- elliott@nanotify.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/.DS_Store
+- ext/nanocurrency_ext/blake2-config.h
+- ext/nanocurrency_ext/blake2-impl.h
+- ext/nanocurrency_ext/blake2.h
+- ext/nanocurrency_ext/blake2b-load-sse2.h
+- ext/nanocurrency_ext/blake2b-load-sse41.h
+- ext/nanocurrency_ext/blake2b-ref.c
+- ext/nanocurrency_ext/blake2b-round.h
+- ext/nanocurrency_ext/curve25519-donna-32bit.h
+- ext/nanocurrency_ext/curve25519-donna-64bit.h
+- ext/nanocurrency_ext/curve25519-donna-helpers.h
+- ext/nanocurrency_ext/curve25519-donna-sse2.h
+- ext/nanocurrency_ext/ed25519-donna-32bit-sse2.h
+- ext/nanocurrency_ext/ed25519-donna-32bit-tables.h
+- ext/nanocurrency_ext/ed25519-donna-64bit-sse2.h
+- ext/nanocurrency_ext/ed25519-donna-64bit-tables.h
+- ext/nanocurrency_ext/ed25519-donna-64bit-x86-32bit.h
+- ext/nanocurrency_ext/ed25519-donna-64bit-x86.h
+- ext/nanocurrency_ext/ed25519-donna-basepoint-table.h
+- ext/nanocurrency_ext/ed25519-donna-batchverify.h
+- ext/nanocurrency_ext/ed25519-donna-impl-base.h
+- ext/nanocurrency_ext/ed25519-donna-impl-sse2.h
+- ext/nanocurrency_ext/ed25519-donna-portable-identify.h
+- ext/nanocurrency_ext/ed25519-donna-portable.h
+- ext/nanocurrency_ext/ed25519-donna.h
+- ext/nanocurrency_ext/ed25519-hash-custom.c
+- ext/nanocurrency_ext/ed25519-hash-custom.h
+- ext/nanocurrency_ext/ed25519-hash.h
+- ext/nanocurrency_ext/ed25519-randombytes-custom.h
+- ext/nanocurrency_ext/ed25519-randombytes.h
+- ext/nanocurrency_ext/ed25519.c
+- ext/nanocurrency_ext/ed25519.h
+- ext/nanocurrency_ext/extconf.rb
+- ext/nanocurrency_ext/fuzz/README.md
+- ext/nanocurrency_ext/fuzz/build-nix.php
+- ext/nanocurrency_ext/fuzz/curve25519-ref10.c
+- ext/nanocurrency_ext/fuzz/curve25519-ref10.h
+- ext/nanocurrency_ext/fuzz/ed25519-donna-sse2.c
+- ext/nanocurrency_ext/fuzz/ed25519-donna.c
+- ext/nanocurrency_ext/fuzz/ed25519-donna.h
+- ext/nanocurrency_ext/fuzz/ed25519-ref10.c
+- ext/nanocurrency_ext/fuzz/ed25519-ref10.h
+- ext/nanocurrency_ext/fuzz/fuzz-curve25519.c
+- ext/nanocurrency_ext/fuzz/fuzz-ed25519.c
+- ext/nanocurrency_ext/modm-donna-32bit.h
+- ext/nanocurrency_ext/modm-donna-64bit.h
+- ext/nanocurrency_ext/rbext.c
+- ext/nanocurrency_ext/regression.h
+- lib/nano/account.rb
+- lib/nano/base32.rb
+- lib/nano/block.rb
+- lib/nano/check.rb
+- lib/nano/conversion.rb
+- lib/nano/hash.rb
+- lib/nano/key.rb
+- lib/nano/utils.rb
+- lib/nano/work.rb
+- lib/nanocurrency.rb
+- lib/nanocurrency/version.rb
+- lib/nanocurrency_ext.bundle
+- nanocurrency.gemspec
+homepage: https://github.com/nanotify/nanocurrency
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/nanotify/nanocurrency
+  source_code_uri: https://github.com/nanotify/nanocurrency.git
+  changelog_uri: https://github.com/nanotify/nanocurrency
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: A toolkit for the Nano cryptocurrency, allowing you to derive keys, generate
+  seeds, hashes, signatures, proofs of work and blocks.
+test_files: []