lapidar 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7550a6712aa1a4ec73b55dd89292c037e9d7c518
-  data.tar.gz: 157f2757955b82097def09ccd07e8d34e6bd49e2
+SHA256:
+  metadata.gz: 893cdddb939ffc0972e0ada67525b73216fb9b9a42cd8fa8afca7d9cb1d8103f
+  data.tar.gz: 30db59b22f248986db3ad80151adebb007ec19246dcabe8f08720341d682e929
 SHA512:
-  metadata.gz: 2d7af0295583b6e07a2a329c9a93f478c1ec61f33d140262768dd2f384fd7cf341e5bac0a0efd10255399f60eab826baf527c78dceef95a7d5b42757013fa910
-  data.tar.gz: a1b80a2db11d67d29c80a03113040ab8309e679961e71476282bdc4c64315865fb7dcb2bdd45da0a096fb127c89e5df1bc087e062b72ce4fe3f643a162ea7d3b
+  metadata.gz: fa71fb1f0e0ee6073d3e58fb104aa8f3f48bcd69bee01d2b381f9711606023f5760b86dfcfd887cea40b0dca484e2b51f054ca2ef1ff1bad58474d6ab7e41f88
+  data.tar.gz: 694f8dbf8bb41375f4c926ad0a7858bc72c0720139b8414478fa9797d736069c978b81385108d664544083264bfd9bb3710112c89a6cdf8ddad6e66008d1c223

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.3.0
+
+* Buschtelefon remote endpoints are now connected via the local endpoint's outbound port
+* `Chain` now queues up unconsolidated (future or invalid) blocks for future use.
+* `Runner` now loads main chain into Buschtelefon on start.
+* The miner thread now passes on thread execution after mining to make sure
+  that the produced block can be digested by the queue (otherwise we may mine blocks twice).
+* We can now inquire all remote neighbors manually via `Runner#inquire_all_neighbors`
+
 ## 0.2.0
 
 * Better threading

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/renuo/lapidar.svg?branch=master)](https://travis-ci.org/renuo/lapidar)
+
 # Lapidar
 
 Carve it in stone. Only that these stones are easy to move across the internet.
@@ -21,7 +23,7 @@ Or install it yourself as:
 
 ## Usage
 
-Have a look at `bin/run`. You'll see that 5 nodes spin up and connect to each other
+Have a look at [`bin/run`](./bin/run). You'll see that 5 nodes spin up and connect to each other
 via [buschtelefon](https://github.com/renuo/lapidar) and contest each other
 in a race which looks like this:
 

data/bin/run

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# $DEBUG = true
 Thread.abort_on_exception = true
 
 require "paint"
@@ -10,22 +11,15 @@ require_relative "../lib/lapidar"
 puts "Starting experiment…"
 
 runners = [
-  Lapidar.runner(port: 9999, neighbors: [
-    { host: "localhost", port: 9995 },
-    { host: "localhost", port: 9996 },
-    { host: "localhost", port: 9997 },
-    { host: "localhost", port: 9998 },
-  ]),
-  Lapidar.runner(port: 9998, neighbors: [{ host: "localhost", port: 9996 }]),
-  Lapidar.runner(port: 9997, neighbors: [{ host: "localhost", port: 9997 }]),
-  Lapidar.runner(port: 9996, neighbors: [{ host: "localhost", port: 9998 }]),
-  Lapidar.runner(port: 9995, neighbors: [{ host: "localhost", port: 9999 }])
+  Lapidar.runner(port: 9999, neighbors: [{ host: "127.0.0.1", port: 9998 }]),
+  Lapidar.runner(port: 9998, neighbors: [{ host: "127.0.0.1", port: 9997 }]),
+  Lapidar.runner(port: 9997, neighbors: [{ host: "127.0.0.1", port: 9999 }])
 ]
 
-threads = runners.map do |runner|
+threads = runners.map.with_index(2) do |runner, i|
   [
-    Thread.new { runner.start },
-    Thread.new { loop { runner.punch_queue << rand.to_s } }
+    Thread.new { sleep(i); runner.start },
+    Thread.new { loop { runner.punch_queue << "#{runner.buschtelefon_endpoint.port} #{rand}" } }
   ]
 end.flatten
 
@@ -35,7 +29,7 @@ logger_thread = Thread.new do
   loop do
     system("clear")
     puts(runners.map do |runner|
-      "Runner on port #{runner.network_endpoint.port}:\n#{runner.chain.to_colorful_string(5)}"
+      "Runner on port #{runner.buschtelefon_endpoint.port}:\n#{runner.chain.to_colorful_string(5)}"
     end.join("\n"))
     sleep(1)
   end
@@ -47,5 +41,12 @@ trap "SIGINT" do
   logger_thread.exit
 end
 
+sleep(5)
+puts 'All inquire their neighbors manually'
+runners.reverse.each do |runner|
+  sleep(1)
+  runner.buschtelefon_endpoint.inquire_remote_neighbors
+end
+
 threads.each(&:join)
 logger_thread.join

data/lapidar.gemspec

@@ -22,7 +22,7 @@ and evaluates block order and correctness. Build any distributed business logic
   # 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)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|docs)/}) }
   end
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -30,13 +30,13 @@ and evaluates block order and correctness. Build any distributed business logic
 
   spec.required_ruby_version = ">= 2.3.0"
 
-  spec.add_dependency "buschtelefon", "~> 0.3"
-  spec.add_dependency "oj", ">= 1.0"
-  spec.add_development_dependency "bundler", ">= 1.17"
+  spec.add_dependency "buschtelefon", "~> 0.4"
+  spec.add_dependency "oj", ">= 1.0", "< 4"
+  spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "factory_bot", "~> 5.0"
   spec.add_development_dependency "paint", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.8"
   spec.add_development_dependency "simplecov", "~> 0.17"
-  spec.add_development_dependency "standard", "> 0"
+  spec.add_development_dependency "standard", "~> 0.1"
 end

data/lib/lapidar/block.rb

@@ -19,5 +19,9 @@ module Lapidar
         created_at: @created_at,
       }
     end
+
+    def ==(other)
+      to_h == other.to_h
+    end
   end
 end

data/lib/lapidar/chain.rb

@@ -4,22 +4,20 @@ module Lapidar
 
     def initialize
       @block_stacks = []
+      @unconsolidated_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 > @block_stacks.count
-      raise "invalid block" unless valid?(block)
-
-      @block_stacks[block.number] ||= []
-      @block_stacks[block.number].push(block) unless @block_stacks[block.number].map(&:hash).include?(block.hash)
-
-      # Rebalance if second to last block has more than one candidate
-      rebalance if !contested?(block.number) && contested?(block.number - 1)
+      if valid?(block)
+        connect(block)
+        consolidate_successors(block)
+      else
+        queue_unconsolidated(block)
+      end
     end
 
-    # For each positition in the chain the candidate positioned first is considered the valid one
+    # For each position in the chain the candidate positioned first is considered the valid one
     def blocks
       @block_stacks.map { |candidates| candidates&.first }
     end
@@ -44,10 +42,19 @@ module Lapidar
 
     private
 
+    def connect(block)
+      @block_stacks[block.number] ||= []
+      @block_stacks[block.number].push(block) unless @block_stacks[block.number].map(&:hash).include?(block.hash)
+
+      # Rebalance if second to last block has more than one candidate
+      rebalance if !contested?(block.number) && contested?(block.number - 1)
+    end
+
     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
+      return false if block.number > @block_stacks.count # early invalid if future block
 
       # Check if there's an existing parent
       @block_stacks[block.number - 1].any? do |previous_block|
@@ -75,5 +82,23 @@ module Lapidar
     def contested?(block_number)
       @block_stacks[block_number].count > 1
     end
+
+    def queue_unconsolidated(block)
+      return if @unconsolidated_blocks.include?(block)
+      @unconsolidated_blocks.push(block)
+      @unconsolidated_blocks.sort_by!(&:number)
+    end
+
+    # Check if queued up unconsolidated blocks can be added to the chain after the currently added block
+    def consolidate_successors(head_block)
+      @unconsolidated_blocks
+        .select { |unconsolidated_block| unconsolidated_block.number > head_block.number }
+        .each do |possible_successor|
+          if valid?(possible_successor)
+            connect(possible_successor)
+            @unconsolidated_blocks.delete(possible_successor)
+          end
+        end
+    end
   end
 end

data/lib/lapidar/persistence.rb

@@ -6,12 +6,12 @@ module Lapidar
 
     def self.save_chain(filename, chain)
       Dir.mkdir(CONFIG_DIR) unless File.exist?(CONFIG_DIR)
-      File.write(File.join(CONFIG_DIR, filename), Oj.dump(chain))
+      File.write(File.join(CONFIG_DIR, filename), Oj.dump(chain, {}))
     end
 
     def self.load_chain(filename)
-      Oj.load(File.read(File.join(CONFIG_DIR, filename)))
-    rescue
+      Oj.load(File.read(File.join(CONFIG_DIR, filename)), {})
+    rescue Errno::ENOENT
       nil
     end
   end

data/lib/lapidar/runner.rb

@@ -2,16 +2,21 @@ require "logger"
 
 module Lapidar
   class Runner
-    attr_reader :chain, :punch_queue, :network_endpoint, :logger
+    attr_reader :chain, :punch_queue, :buschtelefon_endpoint, :logger
 
-    def initialize(network_endpoint)
+    def initialize(buschtelefon_endpoint)
       @logger = Logger.new(StringIO.new)
-      @network_endpoint = network_endpoint
-      @chain = Persistence.load_chain("#{@network_endpoint.port}.json") || Chain.new
+      @buschtelefon_endpoint = buschtelefon_endpoint
+      @chain = Persistence.load_chain("#{@buschtelefon_endpoint.port}.json") || Chain.new
       @incoming_blocks = Queue.new
       @punch_queue = SizedQueue.new(1)
       @should_stop = nil
       @threads = []
+
+      # Reload currently strongest chain into buschtelefon_endpoint
+      if @chain.blocks.any?
+        @buschtelefon_endpoint.load_messages(@chain.blocks.map(&:to_h).map(&:to_json))
+      end
     end
 
     def start
@@ -24,7 +29,7 @@ module Lapidar
     def stop
       @should_stop = true
       Thread.pass
-      Persistence.save_chain("#{@network_endpoint.port}.json", @chain)
+      Persistence.save_chain("#{@buschtelefon_endpoint.port}.json", @chain)
       @threads.each(&:exit)
     end
 
@@ -50,8 +55,13 @@ module Lapidar
         until @should_stop
           begin
             new_block = miner.mine(@chain.blocks.last, @punch_queue.pop)
-            @network_endpoint.feed(Buschtelefon::Gossip.new(new_block.to_h.to_json))
             @incoming_blocks << new_block
+
+            # We need to let the consumer digest the block, otherwise we maybe mine the same block twice.
+            # Notice that we feed the block into the network soon because adoption is also important.
+            Thread.pass
+
+            @buschtelefon_endpoint.feed(Buschtelefon::Gossip.new(new_block.to_h.to_json))
             @logger.info("local_producer") { "!" }
           rescue => e
             @logger.debug("local_producer") { "Mint block isn't valid: #{e.message}" }
@@ -63,7 +73,7 @@ module Lapidar
 
     def network_producer
       Thread.new do
-        @network_endpoint.listen do |gossip|
+        @buschtelefon_endpoint.listen do |gossip, gossip_source|
           break if @should_stop
 
           begin

data/lib/lapidar/version.rb

@@ -1,3 +1,3 @@
 module Lapidar
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/lapidar.rb

@@ -11,10 +11,12 @@ require_relative "lapidar/version"
 
 module Lapidar
   def self.runner(port:, neighbors:)
-    network_endpoint = Buschtelefon::NetTattler.new(port: port)
-    neighbors.map! { |neighbor_location| Buschtelefon::RemoteTattler.new(neighbor_location) }
-    neighbors.each { |neighbor| network_endpoint.connect(neighbor) }
+    buschtelefon_endpoint = Buschtelefon::NetTattler.new(port: port)
 
-    Runner.new(network_endpoint)
+    neighbors.each do |neighbor_location|
+      buschtelefon_endpoint.connect_remote(neighbor_location)
+    end
+
+    Runner.new(buschtelefon_endpoint)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lapidar
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Josua Schmid
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-11 00:00:00.000000000 Z
+date: 2019-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: buschtelefon
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -31,6 +31,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,20 +41,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -126,16 +132,16 @@ dependencies:
   name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 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.
@@ -158,7 +164,6 @@ files:
 - bin/console
 - bin/run
 - bin/setup
-- docs/visualization.png
 - lapidar.gemspec
 - lib/lapidar.rb
 - lib/lapidar/assessment.rb
@@ -190,8 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Carve it in stone. Only that these stones are easy to move across the internet.