equestreum 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 165ee5b574d1d6b256e913e0fe8e17f476105f219f50473fd45051c5343fcf9d
-  data.tar.gz: e7a60c9d11f1e57afdb77f7511f0019f3b492d28709c2599e55975b9478523c7
+  metadata.gz: 9998d629961146f004cbb807abedb73aedd6ff254043c1b96cc6da40138b2e06
+  data.tar.gz: 783f92d5422997ba62cf3a4ed8293f0309f4b842130d36963cfed657d70a1a5e
 SHA512:
-  metadata.gz: f92abea21333957147a923bd16a5d42c91d8dee6f49a377ffe5acc2479fbbaeb58d890f90dc748ae16b8a1a1ea46f75cc1a62a5b965d9c057c00995456d91a2b
-  data.tar.gz: f2e1644bc5498297e54165355805a8e4bcaf8ac810c2f301811b3df927baea5198806c228255d3304ddce44ee4021612f22ce040bc3fceaac99079b78ea8d6f6
+  metadata.gz: 9fa81e145bf4357da2e737c29d85f7b92ee0351938363df5b3e881b7710674e42bdf27c5eee89c62d04fb1d0b15a78b3a54d676c88684e44302942bb22ce9fc2
+  data.tar.gz: 7bad49b5c456efe912e996791cfb33f0c33b1020f0fd775e387c6727a64bb1e5a11e008410442649b1d426e894ccf8c772545dd9be9ecd440174da1e1a02799f

data/Gemfile.lock

@@ -1,21 +1,21 @@
 PATH
   remote: .
   specs:
-    equestreum (0.1.1)
+    equestreum (0.1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.2)
-    coveralls (0.8.21)
+    coveralls (0.8.22)
       json (>= 1.8, < 3)
-      simplecov (~> 0.14.1)
+      simplecov (~> 0.16.1)
       term-ansicolor (~> 1.3)
       thor (~> 0.19.4)
       tins (~> 1.6)
     diff-lcs (1.3)
-    docile (1.1.5)
-    ffi (1.9.23)
+    docile (1.3.1)
+    ffi (1.9.25)
     formatador (0.2.5)
     guard (2.14.2)
       formatador (>= 0.2.4)
@@ -49,23 +49,23 @@ GEM
     rb-fsevent (0.10.3)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
     ruby_dep (1.5.0)
     shellany (0.0.1)
-    simplecov (0.14.1)
-      docile (~> 1.1.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)

data/README.md

@@ -1,6 +1,55 @@
+[![Build Status](http://img.shields.io/travis/hat-festival/equestreum.svg?style=flat-square)](https://travis-ci.org/hat-festival/equestreum)
 [![Coverage Status](http://img.shields.io/coveralls/hat-festival/equestreum.svg?style=flat-square)](https://coveralls.io/r/hat-festival/equestreum)
-[![Code Climate](http://img.shields.io/codeclimate/github/hat-festival/equestreum.svg?style=flat-square)](https://codeclimate.com/github/hat-festival/equestreum)
 [![Gem Version](http://img.shields.io/gem/v/equestreum.svg?style=flat-square)](https://rubygems.org/gems/equestreum)
 [![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://hat-festival.mit-license.org)
 
 # Equestreum
+
+## A blockchain for the [Voting Machine](//github.com/hat-festival/voting-machine)
+
+We're trying to answer [one of the fundamental questions](//www.quora.com/Would-you-rather-fight-100-duck-sized-horses-or-one-horse-sized-duck), and we'd like to store the votes somewhere secure and stable. Unfortunately we don't have access to anything like that, so we built a blockchain instead
+
+Starting with [this excellent tutorial](https://yukimotopress.github.io/programming-blockchains-step-by-step), this is about the simplest implementation of a blockchain that I could come up with
+
+## How do I use it?
+
+    irb(main):001:0> require 'equestreum'
+    => true
+    irb(main):002:0> chain = Equestreum::Chain.new do |c|
+    irb(main):003:1*   c.path = '/tmp/shonky.chain'
+    irb(main):004:1> end
+    => [#<Equestreum::Block:0x00007fd33d978660 @difficulty=3, @data="genesis block", @prev="0000000000000000000000000000000000000000000000000000000000000000", @time=1533992533, @nonce=9792, @hash="000a17e993e50496da998aabb67a5d88963979fc6f7c8ce552edb36f3fb2efea">]
+    irb(main):005:0> chain.first.data
+    => "genesis block"
+    irb(main):006:0> chain.grow 'store this data'
+    => [#<Equestreum::Block:0x00007fd33d978660 @difficulty=3, @data="genesis block", @prev="0000000000000000000000000000000000000000000000000000000000000000", @time=1533992533, @nonce=9792, @hash="000a17e993e50496da998aabb67a5d88963979fc6f7c8ce552edb36f3fb2efea">, #<Equestreum::Block:0x00007fd33d21fb48 @difficulty=3, @data="store this data", @prev="000a17e993e50496da998aabb67a5d88963979fc6f7c8ce552edb36f3fb2efea", @time=1533992533, @nonce=9525, @hash="0006d5dd01dc826a9f89446b3de097dabf5cb0fcf830ed32e25b9ee92696e16a">]
+    irb(main):007:0> chain.count
+    => 2
+    irb(main):008:0> chain.verified?
+    => true
+    irb(main):009:0> chain.difficulty
+    => 3
+    irb(main):010:0> chain.difficulty = 4
+    => 4
+    irb(main):011:0> chain.grow 'store some more data at a higher difficulty'
+    => [#<Equestreum::Block:0x00007fd33d978660 @difficulty=3, @data="genesis block", @prev="0000000000000000000000000000000000000000000000000000000000000000", @time=1533992533, @nonce=9792, @hash="000a17e993e50496da998aabb67a5d88963979fc6f7c8ce552edb36f3fb2efea">, #<Equestreum::Block:0x00007fd33d21fb48 @difficulty=3, @data="store this data", @prev="000a17e993e50496da998aabb67a5d88963979fc6f7c8ce552edb36f3fb2efea", @time=1533992533, @nonce=9525, @hash="0006d5dd01dc826a9f89446b3de097dabf5cb0fcf830ed32e25b9ee92696e16a">, #<Equestreum::Block:0x00007fd33f019950 @difficulty=4, @data="store some more data at a higher difficulty", @prev="0006d5dd01dc826a9f89446b3de097dabf5cb0fcf830ed32e25b9ee92696e16a", @time=1533992534, @nonce=6484, @hash="0000bb78110c6d5d4404140fa5b64786a856485c4a98ebe0b3ff108f3c6111c8">]
+    irb(main):012:0> chain.save
+    => 614
+    irb(main):013:0> c = Equestreum::Chain.revive
+    => [#<Equestreum::Block:0x00007fd33d1a6900 @difficulty=3, @data="genesis block", @prev="0000000000000000000000000000000000000000000000000000000000000000", @time=1533992533, @nonce=9792, @hash="000a17e993e50496da998aabb67a5d88963979fc6f7c8ce552edb36f3fb2efea">, #<Equestreum::Block:0x00007fd33d1a64c8 @difficulty=3, @data="store this data", @prev="000a17e993e50496da998aabb67a5d88963979fc6f7c8ce552edb36f3fb2efea", @time=1533992533, @nonce=9525, @hash="0006d5dd01dc826a9f89446b3de097dabf5cb0fcf830ed32e25b9ee92696e16a">, #<Equestreum::Block:0x00007fd33d1a63b0 @difficulty=4, @data="store some more data at a higher difficulty", @prev="0006d5dd01dc826a9f89446b3de097dabf5cb0fcf830ed32e25b9ee92696e16a", @time=1533992534, @nonce=6484, @hash="0000bb78110c6d5d4404140fa5b64786a856485c4a98ebe0b3ff108f3c6111c8">]
+    irb(main):014:0> c.map { |b| b.data }
+    => ["genesis block", "store this data", "store some more data at a higher difficulty"]
+    irb(main):015:0> c[1].data = 'this should be immutable'
+    => "this should be immutable"
+    irb(main):016:0> begin
+    irb(main):017:1>   c.verified?
+    irb(main):018:1> rescue Equestreum::EquestreumException => e
+    irb(main):019:1>   puts e.text
+    irb(main):020:1> end
+    Block at 1 tampered with
+    => nil
+    irb(main):021:0>
+
+## Should I use it?
+
+Fuck no

data/config/equestreum.yaml

@@ -1 +1 @@
-chain_path: tmp/equestreum.chain
+chain_path: /usr/local/etc/equestreum.chain

data/config/equestreum.yml

@@ -0,0 +1 @@
+chain_path: /usr/local/etc/equestreum.chain

data/lib/config.rb

@@ -0,0 +1,20 @@
+module Equestreum
+  class Config
+    include Singleton
+
+    def initialize
+      @config = fetch_yaml File.join(File.dirname(__FILE__), '..', '..', 'config/equestreum.yml')
+      @config.merge! fetch_yaml "#{ENV['HOME']}/.equestreum/config.yaml"
+    end
+
+    def config
+      @config
+    end
+
+    def fetch_yaml file
+      YAML.load_file file
+    rescue Errno::ENOENT
+      {}
+    end
+  end
+end

data/lib/equestreum/block.rb

@@ -13,7 +13,7 @@ module Equestreum
       @time = Time.now.to_i
       @nonce = 0
       loop do
-        @hash = Equestreum.hash @nonce, @difficulty, @prev, @data
+        @hash = Equestreum.hash @nonce, @time, @difficulty, @prev, @data
         if Equestreum.difficulty_attained hash, @difficulty
           break
         else
@@ -21,5 +21,20 @@ module Equestreum
         end
       end
     end
+
+    def to_h
+      h = {}
+      [
+        :data,
+        :time,
+        :hash,
+        :prev,
+        :nonce,
+        :difficulty
+      ].each do |key|
+        h[key] = self.send(key)
+      end
+      h
+    end
   end
 end

data/lib/equestreum/chain.rb

@@ -1,23 +1,82 @@
 module Equestreum
   class Chain < Array
     private :push, :append, :<<
+    attr_accessor :genesis_data, :difficulty, :path
 
-    def initialize genesis
-      push genesis
+    def initialize
+      @genesis_data = 'genesis block'
+      @difficulty = 3
+      @path = Config.instance.config['chain_path']
+      yield self if block_given?
+
+      grow @genesis_data,
+        prev: '0000000000000000000000000000000000000000000000000000000000000000'
+    end
+
+    def path= path
+      Config.instance.config['chain_path'] = path
+    end
+
+    def self.difficulty= diff
+      c = self.revive
+      c.difficulty = diff
+      c.save
+    end
+
+    def self.difficulty
+      self.revive.difficulty
     end
 
-    def grow data
+    def self.init difficulty: 3
+      diff = Config.instance.config['difficulty'] ? Config.instance.config['difficulty'] : difficulty
+      unless File.exists? Config.instance.config['chain_path']
+        chain = Chain.new do |c|
+          c.difficulty = diff
+        end
+        chain.save
+      end
+    end
+
+    def grow data, prev: nil
       block = Block.new do |b|
         b.data = data
-        b.prev = self.last.hash
-        b.difficulty = self.last.difficulty
+        b.prev = prev ? prev : self.last.hash
+        b.difficulty = @difficulty
       end
 
       block.mine
-
       push block
     end
 
+    def self.grow data
+      chain = self.revive
+      chain.grow data
+      chain.save
+
+      chain
+    end
+
+    def data with_genesis: false
+      data = self.map do |b|
+        {
+          datetime: Time.at(b.time).iso8601,
+          data: b.data
+        }
+      end
+
+      data.shift unless with_genesis
+
+      data
+    end
+
+    def self.aggregate
+      h = Hash.new 0
+      Chain.revive[1..-1].each do |block|
+        h[block.data] += 1
+      end
+      h
+    end
+
     def hash_ok? index
       block = self[index]
 
@@ -32,7 +91,9 @@ module Equestreum
 
     def hashes_ok?
       self.length.times do |index|
-        raise EquestreumException.new "Block at #{index} tampered with" unless hash_ok? index
+        unless hash_ok? index
+          raise EquestreumException.new "Block at #{index} tampered with"
+        end
       end
       true
     end
@@ -67,7 +128,7 @@ module Equestreum
       return true if index == 0
       block = self[index]
       previous = self[index - 1]
-      block.time > previous.time
+      block.time >= previous.time
     end
 
     def blocks_get_newer?
@@ -77,14 +138,23 @@ module Equestreum
       true
     end
 
+    def verified?
+      hashes_ok? && proofs_of_work_ok? && previous_hashes_ok? && blocks_get_newer?
+    end
+
     def save
+      FileUtils.mkdir_p File.dirname Config.instance.config['chain_path']
       File.open Config.instance.config['chain_path'], 'w' do |f|
         f.write Marshal.dump self
       end
     end
 
     def self.revive
-      Marshal.load File.read Config.instance.config['chain_path']
+      begin
+        Marshal.load File.read Config.instance.config['chain_path']
+      rescue Errno::ENOENT
+        raise EquestreumException.new "no chain found at #{Config.instance.config['chain_path']}"
+      end
     end
   end
 end

data/lib/equestreum/config.rb

@@ -2,9 +2,9 @@ module Equestreum
   class Config
     include Singleton
 
-    def initialize custom = "#{ENV['HOME']}/.equestreum/config.yaml"
-      @config = fetch_yaml File.join(File.dirname(__FILE__), '..', '..', 'config/equestreum.yaml')
-      @config.merge! fetch_yaml custom
+    def initialize
+      @config = fetch_yaml File.join(File.dirname(__FILE__), '..', '..', 'config/equestreum.yml')
+      @config.merge! fetch_yaml 'config/equestreum.yml' if File.exists? 'config/equestreum.yml'
     end
 
     def config
@@ -12,9 +12,7 @@ module Equestreum
     end
 
     def fetch_yaml file
-      YAML.load File.open file
-    rescue Errno::ENOENT
-      {}
+      YAML.load_file file
     end
   end
 end

data/lib/equestreum/version.rb

@@ -1,3 +1,3 @@
 module Equestreum
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/equestreum.rb

@@ -1,4 +1,6 @@
 require 'digest'
+require 'singleton'
+require 'yaml'
 
 require 'equestreum/version'
 require 'equestreum/config'
@@ -6,10 +8,10 @@ require 'equestreum/block'
 require 'equestreum/chain'
 
 module Equestreum
-  def self.hash nonce, difficulty, prev, data
+  def self.hash nonce, time, difficulty, prev, data
     string = '%s%s%s%s%s' % [
       nonce,
-      Time.now.to_i,
+      time,
       '0' * difficulty,
       prev,
       data

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: equestreum
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - pikesley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-28 00:00:00.000000000 Z
+date: 2018-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,7 +114,9 @@ files:
 - bin/console
 - bin/setup
 - config/equestreum.yaml
+- config/equestreum.yml
 - equestreum.gemspec
+- lib/config.rb
 - lib/equestreum.rb
 - lib/equestreum/block.rb
 - lib/equestreum/chain.rb