blockchain-lite 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4528df65cc381241f985fcaa31158a9c6d8fa2fb
-  data.tar.gz: 0137ac165fbed0c12ce1f2a0ff48715534eb99f4
+  metadata.gz: e7543889414d4d92f12f6f5bfe9d708ba12c0093
+  data.tar.gz: 96017ba92283640a77ed3be91d52721f1e245791
 SHA512:
-  metadata.gz: 102058d79a195de46583f908947631bc501f39db84443d2b5e8c6b4c10be888629c3f4b9fe7d09b482dd8627923e9d000c0f932cf816d3d954306110202fa469
-  data.tar.gz: 283e8943ef57eefe0d6b6820106557fc3e0beadb7c50b8dac7c1afd64ef4007203383d48d474d1f2c4050817a93bcde9febdf1cc50221e44f79f0f5f81cd202d
+  metadata.gz: 9648bcb18e39173799709aef395c346f63ff4fe6fdff824199cc0934b3b2ade710e5ef6e11e1a802d7d435cdb2ee3d905bc4bf28efbcafe64e94c3b154198d10
+  data.tar.gz: 9b0ca66ac0656b65bc3179387ba7b9818313f94ec7e6d7f25b6ac2cb54ed57a492be7a2a37a13a813a7c6ca9550b7e50c22e3bb0268d8a4c2284d62847079b0d

data/Manifest.txt

@@ -4,7 +4,14 @@ Manifest.txt
 README.md
 Rakefile
 lib/blockchain-lite.rb
+lib/blockchain-lite/basic/block.rb
+lib/blockchain-lite/bitcoin/block.rb
 lib/blockchain-lite/block.rb
+lib/blockchain-lite/blockchain.rb
+lib/blockchain-lite/proof_of_work/block.rb
 lib/blockchain-lite/version.rb
 test/helper.rb
-test/test_version.rb
+test/test_block.rb
+test/test_block_basic.rb
+test/test_block_proof_of_work.rb
+test/test_blockchain.rb

data/README.md

@@ -1,6 +1,6 @@
 # Blockchain Lite (Ruby Edition)
 
-blockchainlite gem / library - build your own blockchain with crypto hashes -  revolutionize the world with blockchains, blockchains, blockchains one block at a time
+blockchain-lite library / gem - build your own blockchain with crypto hashes - revolutionize the world with blockchains, blockchains, blockchains one block at a time
 
 * home  :: [github.com/openblockchains/blockchain.lite.rb](https://github.com/openblockchains/blockchain.lite.rb)
 * bugs  :: [github.com/openblockchains/blockchain.lite.rb/issues](https://github.com/openblockchains/blockchain.lite.rb/issues)
@@ -23,14 +23,13 @@ See the [Awesome Blockchains](https://github.com/openblockchains/awesome-blockch
 Let's get started.  Build your own blockchain one block at a time.
 Example:
 
-
 ``` ruby
 require 'blockchain-lite'
 
-b0 = Block.first( "Genesis" )
-b1 = Block.next( b0, "Transaction Data..." )
-b2 = Block.next( b1, "Transaction Data......" )
-b3 = Block.next( b2, "More Transaction Data..." )
+b0 = Block.first( 'Genesis' )
+b1 = Block.next( b0, 'Transaction Data...' )
+b2 = Block.next( b1, 'Transaction Data......' )
+b3 = Block.next( b2, 'More Transaction Data...' )
 
 blockchain = [b0, b1, b2, b3]
 
@@ -65,12 +64,129 @@ pp blockchain
 #   @previous_hash = "be50017ee4bbcb33844b3dc2b7c4e476d46569b5df5762d14ceba9355f0a85f4">]
 ```
 
+### Blocks
+
+[Basic](#basic)
+[Proof-of-Work](#proof-of-work)
+
+Supported block types / classes for now include:
+
+#### Basic
+
+``` ruby
+class Block
+
+  attr_reader :index
+  attr_reader :timestamp
+  attr_reader :data
+  attr_reader :previous_hash
+  attr_reader :hash
+
+  def initialize(index, data, previous_hash)
+    @index         = index
+    @timestamp     = Time.now.utc    ## note: use coordinated universal time (utc)
+    @data          = data
+    @previous_hash = previous_hash
+    @hash          = calc_hash
+  end
+
+  def calc_hash
+    sha = Digest::SHA256.new
+    sha.update( @index.to_s + @timestamp.to_s + @data + @previous_hash )
+    sha.hexdigest
+  end
+  ...
+end
+```
+
+(Source: [basic/block.rb](lib/blockchain-lite/basic/block.rb))
+
+
+#### Proof-of-Work
+
+``` ruby
+class Block
+
+  attr_reader :index
+  attr_reader :timestamp
+  attr_reader :data
+  attr_reader :previous_hash
+  attr_reader :nonce        ## proof of work if hash starts with leading zeros (00)
+  attr_reader :hash
+
+  def initialize(index, data, previous_hash)
+    @index         = index
+    @timestamp     = Time.now.utc    ## note: use coordinated universal time (utc)
+    @data          = data
+    @previous_hash = previous_hash
+    @nonce, @hash  = compute_hash_with_proof_of_work
+  end
+
+  def calc_hash
+    sha = Digest::SHA256.new
+    sha.update( @nonce.to_s + @index.to_s + @timestamp.to_s + @data + @previous_hash )
+    sha.hexdigest
+  end
+  ...
+end
+```
+
+(Source: [proof_of_work/block.rb](lib/blockchain-lite/proof_of_work/block.rb))
+
+
+
+### Blockchain Helper / Convenience Wrapper
+
+The `Blockchain` class offers some convenience helpers
+for building and checking blockchains. Example:
+
+``` ruby
+b = Blockchain.new       # note: will (auto-) add the first (genesis) block
+
+b << 'Transaction Data...'
+b << 'Transaction Data......'
+b << 'More Transaction Data...'
+
+pp b
+```
+
+Check for broken chain links. Example:
+
+``` ruby
+
+b.broken?
+# => false      ## blockchain OK
+```
+
+or use the `Blockchain` class as a wrapper (pass in the blockchain array):
+
+``` ruby
+b0 = Block.first( 'Genesis' )
+b1 = Block.next( b0, 'Transaction Data...' )
+b2 = Block.next( b1, 'Transaction Data......' )
+b3 = Block.next( b2, 'More Transaction Data...' )
+
+blockchain = [b0, b1, b2, b3]
+
+
+b = Blockchain.new( blockchain )
+
+b.broken?
+# => false      ## blockchain OK
+```
+
+and so on.
+
+
+
 
 ## Install
 
 Just install the gem:
 
-    $ gem install blockchain-lite
+```
+$ gem install blockchain-lite
+```
 
 
 ## License

data/lib/blockchain-lite.rb

@@ -12,7 +12,13 @@ require 'uri'
 
 ## our own code
 require 'blockchain-lite/version'    # note: let version always go first
-require 'blockchain-lite/block'
+
+require 'blockchain-lite/basic/block'
+require 'blockchain-lite/proof_of_work/block'
+
+require 'blockchain-lite/blockchain'
+
+require 'blockchain-lite/block'       ## configure "standard" default block (e.g. basic, proof-of-work, etc.)
 
 
 

data/lib/blockchain-lite/basic/block.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+module BlockchainLite
+  module Basic
+
+
+class Block
+
+  attr_reader :index
+  attr_reader :timestamp
+  attr_reader :data
+  attr_reader :previous_hash
+  attr_reader :hash
+
+  def initialize(index, data, previous_hash)
+    @index         = index
+    @timestamp     = Time.now.utc    ## note: use coordinated universal time (utc)
+    @data          = data
+    @previous_hash = previous_hash
+    @hash          = calc_hash
+  end
+
+  def calc_hash
+    sha = Digest::SHA256.new
+    sha.update( @index.to_s + @timestamp.to_s + @data + @previous_hash )
+    sha.hexdigest
+  end
+
+
+
+  def self.first( data='Genesis' )    # create genesis (big bang! first) block
+    ## uses index zero (0) and arbitrary previous_hash ('0')
+    Block.new( 0, data, '0' )
+  end
+
+  def self.next( previous, data='Transaction Data...' )
+    Block.new( previous.index+1, data, previous.hash )
+  end
+
+end  # class Block
+
+
+end  ##  module Basic
+end  ##  module BlockchainLite

data/lib/blockchain-lite/bitcoin/block.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+##
+##  Note: Work in Progress
+##    -- under construction!!!!!!
+##    do NOT yet use this class
+
+module BlockchainLite
+  module Bitcoin
+
+
+## bitcoin-compatible block
+##  note: work-in-progress
+
+class Block
+
+
+  class Header
+
+    attr_reader :index
+    attr_reader :timestamp
+    attr_reader :data
+    attr_reader :previous_hash
+    attr_reader :hash
+
+    def initialize(index, data, previous_hash)
+      @index         = index
+      @timestamp     = Time.now.utc    ## note: use coordinated universal time (utc)
+      @data          = data
+      @previous_hash = previous_hash
+      @hash          = calc_hash
+    end
+
+  private
+
+    def calc_hash
+      sha = Digest::SHA256.new
+      sha.update( @index.to_s + @timestamp.to_s + @data + @previous_hash )
+      sha.hexdigest
+    end
+  end  # class Header
+
+
+  def self.first( data='Genesis' )    # create genesis (big bang! first) block
+      ## uses index zero (0) and arbitrary previous_hash ('0')
+      Block.new( 0, data, '0' )
+  end
+
+  def self.next( previous, data='Transaction Data...' )
+    Block.new( previous.index+1, data, previous.hash )
+  end
+
+end  # class Block
+
+
+end  ##  module Bitcoin
+end  ##  module BlockchainLite

data/lib/blockchain-lite/block.rb

@@ -1,37 +1,5 @@
 # encoding: utf-8
 
 
-class Block
-
-  attr_reader :index
-  attr_reader :timestamp
-  attr_reader :data
-  attr_reader :previous_hash
-  attr_reader :hash
-
-  def initialize(index, timestamp, data, previous_hash)
-    @index         = index
-    @timestamp     = timestamp
-    @data          = data
-    @previous_hash = previous_hash
-    @hash          = calc_hash
-  end
-
-  def self.first( data="Genesis" )    # create genesis (big bang! first) block
-    ## uses index zero and arbitrary previous_hash
-    Block.new( 0, Time.now, data, "0" )
-  end
-
-  def self.next( previous, data="Transaction Data..." )
-    Block.new( previous.index+1, Time.now, data, previous.hash )
-  end
-
-private
-
-  def calc_hash
-    sha = Digest::SHA256.new
-    sha.update @index.to_s + @timestamp.to_s + @data.to_s + @previous_hash.to_s
-    sha.hexdigest
-  end
-
-end  # class Block
+## "standard" default block for now block with proof of work
+Block = BlockchainLite::ProofOfWork::Block

data/lib/blockchain-lite/blockchain.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+
+
+##
+# convenience wrapper for array holding blocks (that is, a blockchain)
+
+
+class Blockchain
+
+  def initialize( chain=nil, block_class: nil )
+    if chain.nil?
+      @block_class = block_class || BlockchainLite::ProofOfWork::Block
+      b0 = @block_class.first( 'Genesis' )
+      @chain = [b0]
+    else
+      @chain = chain    # "wrap" passed in blockchain (in array)
+      if block_class          # configure block class ("factory")
+        @block_class = block_class
+      else
+        ### no block class configured; use class of first block
+        ##  todo/fix: throw except if chain is empty (no class configured) - why? why not??
+        @block_class = @chain.first.class    if @chain.first
+      end
+    end
+  end
+
+
+  def last() @chain.last; end     ## return last block in chain
+
+
+  def <<( arg )
+    if arg.is_a? String   ## assume its (just) data
+      data = arg
+      bl   = @chain.last
+      b    = @block_class.next( bl, data )
+    elsif arg.class.respond_to?( :first ) &&       ## check if respond_to? Block.first? and Block.next? - assume it's a block
+          arg.class.respond_to?( :next )           ##  check/todo: use is_a? @block_class why? why not?
+      b = arg
+    else  ## fallback; assume its (just) data (not a block)
+      data = arg.to_s    ## note: always convert arg to string!!  - why? why not??
+      bl   = @chain.last
+      b    = @block_class.next( bl, data )
+    end
+    @chain << b   ## add/append (new) block to chain
+  end
+
+
+
+  def broken?
+    ## check for validation conventions
+    ##   - start with first block?
+    ##   - or start with last block (reversve)? -why? why not??
+
+    @chain.size.times do |i|
+      ###puts "checking block #{i+1}/#{@chain.size}..."
+
+      current = @chain[i]
+
+      if i==0   ### special case for first (genesis) block; has no previous/parent block
+        if current.index != 0
+          ## raise error -- invalid index!!!
+          return true
+        end
+        if current.previous_hash != '0'
+          ## raise error -- invalid previous hash (hash checksums MUST match)
+          return true
+        end
+      else
+        previous = @chain[i-1]
+
+        if current.index != previous.index+1
+          ## raise error -- invalid index!!!
+          puts "!!! blockchain corrupt - block ##{current.index}: index must be a sequence (with +1 steps)"
+          return true
+        end
+
+        if current.previous_hash != previous.hash
+          ## raise error -- invalid previous hash (hash checksums MUST match)
+          puts "!!! blockchain corrupt - block ##{current.index}: previous_hash and hash in previous block must match"
+          return true
+        end
+      end
+
+      if current.hash != current.calc_hash    ## (re)calc / double-check hash
+        ## raise error -- invalid hash (hash checksums MUST match)
+        puts "!!! blockchain corrupt - block ##{current.index}: calc_hash and hash must match; block corrupt - cannot recalculate hash"
+        return true
+      end
+    end # loop times
+
+    false   ## chain OK -- chain is NOT broken if we get here
+  end  # method broken?
+
+  def valid?() !broken?; end
+
+end   ## class Blockchain

data/lib/blockchain-lite/proof_of_work/block.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+module BlockchainLite
+  module ProofOfWork
+
+
+class Block
+
+  attr_reader :index
+  attr_reader :timestamp
+  attr_reader :data
+  attr_reader :previous_hash
+  attr_reader :nonce        ## proof of work if hash starts with leading zeros (00)
+  attr_reader :hash
+
+  def initialize(index, data, previous_hash)
+    @index         = index
+    @timestamp     = Time.now.utc    ## note: use coordinated universal time (utc)
+    @data          = data
+    @previous_hash = previous_hash
+    @nonce, @hash  = compute_hash_with_proof_of_work
+  end
+
+  def calc_hash
+    sha = Digest::SHA256.new
+    sha.update( @nonce.to_s + @index.to_s + @timestamp.to_s + @data + @previous_hash )
+    sha.hexdigest
+  end
+
+
+  def self.first( data='Genesis' )    # create genesis (big bang! first) block
+    ## uses index zero (0) and arbitrary previous_hash ('0')
+    Block.new( 0, data, '0' )
+  end
+
+  def self.next( previous, data='Transaction Data...' )
+    Block.new( previous.index+1, data, previous.hash )
+  end
+
+private
+
+  def compute_hash_with_proof_of_work( difficulty='00' )
+    nonce = 0
+    loop do
+      hash = calc_hash_with_nonce( nonce )
+      if hash.start_with?( difficulty )
+        return [nonce,hash]    ## bingo! proof of work if hash starts with leading zeros (00)
+      else
+        nonce += 1             ## keep trying (and trying and trying)
+      end
+    end
+  end
+
+  def calc_hash_with_nonce( nonce=0 )
+    sha = Digest::SHA256.new
+    sha.update( nonce.to_s + @index.to_s + @timestamp.to_s + @data + @previous_hash )
+    sha.hexdigest
+  end
+
+end  # class Block
+
+
+end  ##  module ProofOfWork
+end  ##  module BlockchainLite

data/lib/blockchain-lite/version.rb

@@ -3,7 +3,7 @@
 
 module BlockchainLite
 
-  MAJOR = 0
+  MAJOR = 1
   MINOR = 1
   PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')

data/test/test_block.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_block.rb
+
+
+require 'helper'
+
+
+class TestBlock < MiniTest::Test
+
+def test_version
+   pp BlockchainLite.version
+   pp BlockchainLite.banner
+   pp BlockchainLite.root
+
+   assert true  ## (for now) everything ok if we get here
+end
+
+def test_example
+
+  b0 = Block.first( 'Genesis' )
+  b1 = Block.next( b0, 'Transaction Data...' )
+  b2 = Block.next( b1, 'Transaction Data......' )
+  b3 = Block.next( b2, 'More Transaction Data...' )
+
+  blockchain = [b0, b1, b2, b3]
+
+  pp blockchain
+
+  assert true  ## (for now) everything ok if we get here
+end
+
+end  # class TestBlock

data/test/test_block_basic.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_block_basic.rb
+
+
+require 'helper'
+
+
+class TestBlockBasic < MiniTest::Test
+
+def test_example
+
+  block_class = BlockchainLite::Basic::Block
+
+  b0 = block_class.first( 'Genesis' )
+  b1 = block_class.next( b0, 'Transaction Data...' )
+  b2 = block_class.next( b1, 'Transaction Data......' )
+  b3 = block_class.next( b2, 'More Transaction Data...' )
+
+  blockchain = [b0, b1, b2, b3]
+
+  pp blockchain
+
+  assert true  ## (for now) everything ok if we get here
+end
+
+end  # class TestBlockBasic

data/test/test_block_proof_of_work.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_block_proof_of_work.rb
+
+
+require 'helper'
+
+
+class TestBlockProofOfWork < MiniTest::Test
+
+def test_example
+
+  block_class = BlockchainLite::ProofOfWork::Block
+
+  b0 = block_class.first( 'Genesis' )
+  b1 = block_class.next( b0, 'Transaction Data...' )
+  b2 = block_class.next( b1, 'Transaction Data......' )
+  b3 = block_class.next( b2, 'More Transaction Data...' )
+
+  blockchain = [b0, b1, b2, b3]
+
+  pp blockchain
+
+  assert true  ## (for now) everything ok if we get here
+end
+
+end  # class TestBlockProofOfWork

data/test/test_blockchain.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_blockchain.rb
+
+require 'helper'
+
+
+class TestBlockchain < MiniTest::Test
+
+def test_new
+
+  b = Blockchain.new
+
+  b << 'Transaction Data...'
+
+  ## add do-it-yourself built block
+  b << Block.next( b.last, 'Transaction Data......' )
+
+  b << 'More Transaction Data...'
+
+  pp b
+
+  assert true  ## (for now) everything ok if we get here
+end
+
+
+def test_with_block_class
+
+  b = Blockchain.new( block_class: BlockchainLite::Basic::Block )
+
+  b << 'Transaction Data...'
+  b << 'Transaction Data......'
+  b << 'More Transaction Data...'
+
+  pp b
+
+  assert true  ## (for now) everything ok if we get here
+end
+
+
+def test_wrap
+
+  b0 = Block.first( 'Genesis' )
+  b1 = Block.next( b0, 'Transaction Data...' )
+  b2 = Block.next( b1, 'Transaction Data......' )
+  b3 = Block.next( b2, 'More Transaction Data...' )
+  blockchain = [b0, b1, b2, b3]
+
+  b = Blockchain.new( blockchain )
+  puts "broken? #{b.broken?}"
+  puts "valid?  #{b.valid?}"
+
+  pp b
+
+  assert_equal false, b.broken?
+  assert_equal true,  b.valid?
+
+  ## corrupt data in block in chain
+  b2.instance_eval %{ @data='XXXXXXX' }
+
+  assert_equal true,   b.broken?
+  assert_equal false,  b.valid?
+
+  pp b
+end
+
+
+end  # class TestBlockchain

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blockchain-lite
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Gerald Bauer
@@ -55,10 +55,17 @@ files:
 - README.md
 - Rakefile
 - lib/blockchain-lite.rb
+- lib/blockchain-lite/basic/block.rb
+- lib/blockchain-lite/bitcoin/block.rb
 - lib/blockchain-lite/block.rb
+- lib/blockchain-lite/blockchain.rb
+- lib/blockchain-lite/proof_of_work/block.rb
 - lib/blockchain-lite/version.rb
 - test/helper.rb
-- test/test_version.rb
+- test/test_block.rb
+- test/test_block_basic.rb
+- test/test_block_proof_of_work.rb
+- test/test_blockchain.rb
 homepage: https://github.com/openblockchains/blockchain.lite.rb
 licenses:
 - Public Domain

data/test/test_version.rb

@@ -1,29 +0,0 @@
-
-require 'helper'
-
-
-class TestVersion < MiniTest::Test
-
-def test_version
-   pp BlockchainLite.version
-   pp BlockchainLite.banner
-   pp BlockchainLite.root
-
-   assert true  ## (for now) everything ok if we get here
-end
-
-def test_example
-
-  b0 = Block.first( "Genesis" )
-  b1 = Block.next( b0, "Transaction Data..." )
-  b2 = Block.next( b1, "Transaction Data......" )
-  b3 = Block.next( b2, "More Transaction Data..." )
-
-  blockchain = [b0, b1, b2, b3]
-
-  pp blockchain
-
-  assert true  ## (for now) everything ok if we get here
-end
-
-end  # class TestVersion