lapidar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d024f24e254ae420266eb80b779cdca010785af1
+  data.tar.gz: 8012ac6e40bfcd0be7644d9b4b002466a63cd841
+SHA512:
+  metadata.gz: c6ee55f3749e40f80d361be1d8ddbde43bdb9c1abdbbd572c4fa6845320006e3ac800a4a80f2ac35a3ab04b6378829f4ec5005633ef2e368b45bd666ffe8cfb0
+  data.tar.gz: 7cc94309a33288b6d48d89ac6dd1a45ff5cd83fe1d21e39d69de32940b4e72dbc8c600e0a990fcd167f1855f9855877f823b59da71f37741eb96d418f4f46744

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+Gemfile.lock
+.rspec_status

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.3.8

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+cache: bundler
+script: bin/check

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in lapidar.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Josua Schmid
+
+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,38 @@
+# Lapidar
+
+Carve it in stone. Only that these stones are easy to move across the internet.
+This is a multi purpose blockchain on which you can build some custom business logic.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lapidar'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lapidar
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lapidar.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/check

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+set -e
+
+bundle exec standardrb --fix
+bundle exec rspec
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lapidar"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/run

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require "bundler"
+Bundler.setup(:default)
+
+require_relative '../lib/lapidar'
+
+puts 'Starting experiment…'
+
+[
+  Thread.new { Lapidar.start_mining(port: 9999, neighbors: [{ host: 'localhost', port: 9995 }]) },
+  Thread.new { Lapidar.start_mining(port: 9998, neighbors: [{ host: 'localhost', port: 9996 }]) },
+  Thread.new { Lapidar.start_mining(port: 9997, neighbors: [{ host: 'localhost', port: 9997 }]) },
+  Thread.new { Lapidar.start_mining(port: 9996, neighbors: [{ host: 'localhost', port: 9998 }]) },
+  Thread.new { Lapidar.start_mining(port: 9995, neighbors: [{ host: 'localhost', port: 9999 }]) }
+].each(&:join)
+

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lapidar.gemspec

@@ -0,0 +1,40 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "lapidar/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "lapidar"
+  spec.version = Lapidar::VERSION
+  spec.authors = ["Josua Schmid"]
+  spec.email = ["josua.schmid@renuo.ch"]
+
+  spec.summary = 'Carve it in stone. Only that these stones are easy to move across the internet.
+This is a multi purpose blockchain on which you can build some custom business logic.'
+  spec.description = 'This is a custom blockchain with a working network layer. It just mines and receives blocks
+and evaluates block order and correctness. Build any distributed business logic on top of it.'
+  spec.homepage = "https://github.com/renuo/lapidar"
+  spec.license = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/renuo/lapidar"
+  spec.metadata["changelog_uri"] = "https://github.com/renuo/lapidar/blob/master/CHANGELOG.md"
+
+  # 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.required_ruby_version = ">= 2.3.0"
+
+  spec.add_dependency "buschtelefon", "~> 0.2"
+  spec.add_development_dependency "bundler", ">= 1.17"
+  spec.add_development_dependency "factory_bot", "~> 5.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "simplecov", "~> 0.17"
+  spec.add_development_dependency "standard", "> 0"
+end

data/lib/lapidar/assessment.rb

@@ -0,0 +1,23 @@
+module Lapidar
+  class Assessment
+    def self.valid_link?(previous_block, block)
+      hash(previous_block&.hash, block.nonce, block.data) == block.hash
+    end
+
+    def self.meets_difficulty?(block)
+      block.hash.start_with?("0000")
+    end
+
+    def self.genesis?(block)
+      first?(block) && valid_link?(nil, block)
+    end
+
+    def self.first?(block)
+      block.number.zero?
+    end
+
+    def self.hash(previous_hash, nonce, data)
+      Digest::SHA256.hexdigest("#{previous_hash}-#{nonce}-#{data}")
+    end
+  end
+end

data/lib/lapidar/block.rb

@@ -0,0 +1,23 @@
+module Lapidar
+  class Block
+    attr_reader :number, :hash, :data, :nonce, :created_at
+
+    def initialize(number:, hash:, nonce:, data: nil, created_at: Time.now)
+      @number = number
+      @hash = hash
+      @nonce = nonce
+      @data = data
+      @created_at = created_at
+    end
+
+    def to_h
+      {
+        number: @number,
+        hash: @hash,
+        nonce: @nonce,
+        data: @data,
+        created_at: @created_at,
+      }
+    end
+  end
+end

data/lib/lapidar/chain.rb

@@ -0,0 +1,59 @@
+module Lapidar
+  class Chain
+    def initialize
+      @blocks = []
+    end
+
+    # TODO: Queue up future blocks for later use
+    # TODO: Check for duplicates and dont add them to the chains
+    def add(block)
+      raise "future block?" if block.number > @blocks.count
+      raise "invalid block" unless valid?(block)
+
+      @blocks[block.number] ||= []
+      @blocks[block.number].push(block)
+
+      # Rebalance if second to last block has more than one candidate
+      rebalance if !contested?(block.number) && contested?(block.number - 1)
+    end
+
+    # For each positition in the chain the candidate positioned first is considered the valid one
+    def blocks
+      @blocks.map { |candidates| candidates&.first }
+    end
+
+    private
+
+    def valid?(block)
+      return true if Assessment.genesis?(block) # early valid if genesis
+      return false if Assessment.first?(block) # early invalid if fake genesis
+      return false unless Assessment.meets_difficulty?(block) # early invalid if difficulty not met
+
+      # Check if there's an existing parent
+      @blocks[block.number - 1].any? do |previous_block|
+        Assessment.valid_link?(previous_block, block)
+      end
+    end
+
+    # If a new last block comes in, we realign the first blocks to build the longest chain
+    def rebalance
+      winning_block = @blocks.last.first
+      parent_position = @blocks.count - 2
+
+      while contested?(parent_position)
+        # TODO: Is there's a smarter way to persistently select a winner than sorting the competition
+        @blocks[parent_position].sort_by! do |previous_block|
+          Assessment.valid_link?(previous_block, winning_block) ? 0 : 1
+        end
+
+        winning_block = @blocks[parent_position].first
+        parent_position -= 1
+      end
+    end
+
+    # Contested evaluates to true if there blocks are competing for the same position in the blockchain
+    def contested?(block_number)
+      @blocks[block_number].count > 1
+    end
+  end
+end

data/lib/lapidar/miner.rb

@@ -0,0 +1,31 @@
+require "digest"
+
+module Lapidar
+  class Miner
+    def initialize
+      @stomach = Digest::SHA2.new(256)
+    end
+
+    def mine(base_block, data = "")
+      base_block ||= god
+      nonce = 0
+      nonce += 1 until meets_difficulty?(digest(base_block, nonce, data))
+      Block.new(number: base_block.number + 1, hash: digest(base_block, nonce, data), nonce: nonce, data: data)
+    end
+
+    private
+
+    def digest(base_block, nonce, data)
+      @stomach.hexdigest("#{base_block.hash}-#{nonce}-#{data}")
+    end
+
+    def meets_difficulty?(digest)
+      digest.start_with?("0000")
+    end
+
+    def god
+      # Virtual block descending from Heaven to create the genesis block
+      Block.new(number: -1, hash: nil, nonce: nil)
+    end
+  end
+end

data/lib/lapidar/version.rb

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

data/lib/lapidar.rb

@@ -0,0 +1,81 @@
+require_relative "lapidar/assessment"
+require_relative "lapidar/block"
+require_relative "lapidar/chain"
+require_relative "lapidar/miner"
+require_relative "lapidar/version"
+
+require "json"
+require "buschtelefon"
+
+module Lapidar
+  def self.start_mining(port:, neighbors:)
+    chain = Chain.new
+    miner = Miner.new
+    incoming_blocks = Queue.new
+
+    me = Buschtelefon::NetTattler.new(port: port)
+    neighbors.map! { |neighbor_location| Buschtelefon::RemoteTattler.new(neighbor_location) }
+    neighbors.each { |neighbor| me.connect(neighbor) }
+
+    Thread.abort_on_exception = true
+
+    consumer = Thread.new {
+      until_shutdown do
+        begin
+          chain.add(incoming_blocks.pop)
+          print "+"
+        rescue
+          puts "Consumer error"
+        end
+      end
+    }
+
+    network_producer = Thread.new {
+      until_shutdown do
+        me.listen do |message|
+          begin
+            incoming_json = JSON.parse(message, symbolize_names: true)
+
+            incoming_blocks << Block.new(
+              number: incoming_json[:number].to_i,
+              hash: incoming_json[:hash].to_s,
+              nonce: incoming_json[:none].to_i,
+              data: incoming_json[:data].to_s,
+              created_at: Time.parse(incoming_json[:created_at])
+            )
+          rescue JSON::ParserError, ArgumentError => e
+            puts "Incoming block isn't valid: #{e.message}"
+          end
+        end
+      end
+    }
+
+    local_producer = Thread.new {
+      until_shutdown do
+        new_block = miner.mine(chain.blocks.last)
+
+        me.feed(Buschtelefon::Gossip.new(new_block.to_h.to_json))
+        incoming_blocks << new_block
+
+        print "⚒ "
+      end
+    }
+
+    local_producer.join
+    network_producer.join
+    consumer.join
+
+    puts "\nShutting down…"
+  end
+
+  def self.until_shutdown
+    trap "SIGINT" do
+      puts "\nshutting down"
+      exit
+    end
+
+    loop do
+      yield
+    end
+  end
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: lapidar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josua Schmid
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: buschtelefon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  This is a custom blockchain with a working network layer. It just mines and receives blocks
+  and evaluates block order and correctness. Build any distributed business logic on top of it.
+email:
+- josua.schmid@renuo.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/check
+- bin/console
+- bin/run
+- bin/setup
+- lapidar.gemspec
+- lib/lapidar.rb
+- lib/lapidar/assessment.rb
+- lib/lapidar/block.rb
+- lib/lapidar/chain.rb
+- lib/lapidar/miner.rb
+- lib/lapidar/version.rb
+homepage: https://github.com/renuo/lapidar
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/renuo/lapidar
+  source_code_uri: https://github.com/renuo/lapidar
+  changelog_uri: https://github.com/renuo/lapidar/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Carve it in stone. Only that these stones are easy to move across the internet.
+  This is a multi purpose blockchain on which you can build some custom business logic.
+test_files: []