blockchain-lite 1.1.0 → 1.4.1

data/Rakefile

@@ -1,29 +1,30 @@
-require 'hoe'
-require './lib/blockchain-lite/version.rb'
-
-Hoe.spec 'blockchain-lite' do
-
-  self.version = BlockchainLite::VERSION
-
-  self.summary = "blockchain-lite - build your own blockchain with crypto hashes -  revolutionize the world with blockchains, blockchains, blockchains one block at a time"
-  self.description = summary
-
-  self.urls    = ['https://github.com/openblockchains/blockchain.lite.rb']
-
-  self.author  = 'Gerald Bauer'
-  self.email   = 'wwwmake@googlegroups.com'
-
-  # switch extension to .markdown for gihub formatting
-  self.readme_file  = 'README.md'
-  self.history_file = 'HISTORY.md'
-
-  self.extra_deps = [
-  ]
-
-  self.licenses = ['Public Domain']
-
-  self.spec_extras = {
-    required_ruby_version: '>= 2.3'
-  }
-
-end
+require 'hoe'
+require './lib/blockchain-lite/version.rb'
+
+Hoe.spec 'blockchain-lite' do
+
+  self.version = BlockchainLite::VERSION
+
+  self.summary = "blockchain-lite - build your own blockchain with crypto hashes -  revolutionize the world with blockchains, blockchains, blockchains one block at a time"
+  self.description = summary
+
+  self.urls    = { home: 'https://github.com/rubycoco/blockchain' }
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'wwwmake@googlegroups.com'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'CHANGELOG.md'
+
+  self.extra_deps = [
+    ['merkletree'],
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+    required_ruby_version: '>= 2.3'
+  }
+
+end

data/lib/blockchain-lite.rb

@@ -1,26 +1,11 @@
-# encoding: utf-8
-
-require 'digest'    # for hash checksum digest function SHA256
-require 'pp'        # for pp => pretty printer
-
-require 'date'
-require 'time'
-require 'json'
-require 'uri'
-
-
-
-## our own code
-require 'blockchain-lite/version'    # note: let version always go first
-
-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.)
-
-
-
-# say hello
-puts BlockchainLite.banner    if defined?($RUBYLIBS_DEBUG) && $RUBYLIBS_DEBUG
+# encoding: utf-8
+
+
+## our own code (without "top-level" shortcuts e.g. "modular version")
+require 'blockchain-lite/base'
+
+###
+#  add convenience top-level shortcut / alias
+#    "standard" default block for now block with proof of work
+Block      = BlockchainLite::ProofOfWork::Block
+Blockchain = BlockchainLite::Blockchain

data/lib/blockchain-lite/base.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require 'digest'    # for hash checksum digest function SHA256
+require 'pp'        # for pp => pretty printer
+
+require 'forwardable'
+require 'date'
+require 'time'
+require 'json'
+require 'uri'
+
+
+## 3rd party libs
+require 'merkletree'
+
+
+## our own code
+require 'blockchain-lite/version'    # note: let version always go first
+
+require 'blockchain-lite/basic/block'
+require 'blockchain-lite/proof_of_work/block'
+
+require 'blockchain-lite/blockchain'
+
+
+
+# say hello
+puts BlockchainLite.banner     ## if defined?($RUBYLIBS_DEBUG) && $RUBYLIBS_DEBUG

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

@@ -8,33 +8,55 @@ class Block
 
   attr_reader :index
   attr_reader :timestamp
-  attr_reader :data
+  attr_reader :transactions_count   # use alias - txn_count - why? why not?
+  attr_reader :transactions         # use alias - txn       - why? why not?
   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
+  def initialize(index, transactions, previous_hash, timestamp: nil)
+    @index              = index
+
+    ## note: use coordinated universal time (utc)
+    ##    auto-add timestamp for new blocks (e.g. timestamp is nil)
+    @timestamp          = timestamp ? timestamp : Time.now.utc
+
+    ## note: assumes / expects an array for transactions
+    @transactions       = transactions
+    @transactions_count = transactions.size
+
+    @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.update( @timestamp.to_s +
+                @transactions.to_s +
+                @previous_hash )
     sha.hexdigest
   end
 
 
 
-  def self.first( data='Genesis' )    # create genesis (big bang! first) block
+  def self.first( *args )    # create genesis (big bang! first) block
+    ##  note: allow/support splat-* for now for convenience (auto-wraps args into array)
+    if args.size == 1 && args[0].is_a?( Array )
+      transactions = args[0]   ## "unwrap" array in array
+    else
+      transactions = args      ## use "auto-wrapped" splat array
+    end
     ## uses index zero (0) and arbitrary previous_hash ('0')
-    Block.new( 0, data, '0' )
+    Block.new( 0, transactions, '0'  )
   end
 
-  def self.next( previous, data='Transaction Data...' )
-    Block.new( previous.index+1, data, previous.hash )
+  def self.next( previous, *args )
+    ## note: allow/support splat-* for now for convenience (auto-wraps args into array)
+    if args.size == 1 && args[0].is_a?( Array )
+      transactions = args[0]   ## "unwrap" array in array
+    else
+      transactions = args      ## use "auto-wrapped" splat array
+    end
+    Block.new( previous.index+1, transactions, previous.hash )
   end
 
 end  # class Block

data/lib/blockchain-lite/blockchain.rb

@@ -4,48 +4,49 @@
 ##
 # convenience wrapper for array holding blocks (that is, a blockchain)
 
+module BlockchainLite
+
 
 class Blockchain
+  extend Forwardable
 
-  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
+  def initialize( chain=[] )
+    @chain = chain    # "wrap" passed in blockchain (in array)
   end
 
+  ##
+  #  todo/check: can we make it work without "virtual" block_class method
+  ##    e.g. use constant lookup with singleton class or something - possible?
+  def block_class() Block; end    # if not configured; fallback to "top level" Block
+
 
-  def last() @chain.last; end     ## return last block in chain
+
+  ## delegate some methods (and operators) to chain array (for easier/shortcut access)
+  def_delegators :@chain, :[], :size, :each, :last, :empty?, :any?
 
 
   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?
+    if arg.is_a?( block_class )
       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 )
+    else
+      if arg.is_a?( Array )   ## assume its (just) data
+        data = arg
+      else  ## fallback; assume single transaction record; wrap in array - allow fallback - why? why not??
+        data = [arg]
+      end
+
+      if @chain.empty?
+        b = block_class.first( data )
+      else
+        bl = @chain.last
+        b  = block_class.next( bl, data )
+      end
     end
+
     @chain << b   ## add/append (new) block to chain
   end
 
 
-
   def broken?
     ## check for validation conventions
     ##   - start with first block?
@@ -94,3 +95,5 @@ class Blockchain
   def valid?() !broken?; end
 
 end   ## class Blockchain
+
+end   ## module BlockchainLite

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

@@ -8,36 +8,75 @@ class Block
 
   attr_reader :index
   attr_reader :timestamp
-  attr_reader :data
+  attr_reader :transactions_count   # use alias - txn_count - why? why not?
+  attr_reader :transactions         # use alias - txn       - why? why not?
+  attr_reader :transactions_hash    # use alias - merkle_root - why? why not?
   attr_reader :previous_hash
-  attr_reader :nonce        ## proof of work if hash starts with leading zeros (00)
+  attr_reader :nonce                # ("lucky" number used once) - 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
+  def initialize(index, transactions, previous_hash, timestamp: nil, nonce: nil)
+    @index = index
+
+    ## note: assumes / expects an array for transactions
+    @transactions       = transactions
+    @transactions_count = transactions.size
+
+    ## todo: add empty array check to merkletree.compute why? why not?
+    @transactions_hash  = transactions.empty? ? '0' : MerkleTree.compute_root_for( transactions )
+
     @previous_hash = previous_hash
-    @nonce, @hash  = compute_hash_with_proof_of_work
+
+    ## note: use coordinated universal time (utc)
+    @timestamp = timestamp ? timestamp : Time.now.utc
+
+    if nonce     ## restore pre-computed/mined block (from disk/cache/db/etc.)
+       ## todo: check timestamp MUST NOT be nil
+       @nonce = nonce
+       @hash  = calc_hash
+    else   ## new block  (mine! e.g. find nonce - "lucky" number used once)
+       @nonce, @hash = compute_hash_with_proof_of_work
+    end
   end
 
   def calc_hash
-    sha = Digest::SHA256.new
-    sha.update( @nonce.to_s + @index.to_s + @timestamp.to_s + @data + @previous_hash )
-    sha.hexdigest
+    calc_hash_with_nonce( @nonce )
   end
 
 
-  def self.first( data='Genesis' )    # create genesis (big bang! first) block
+
+  def self.first( *args, **opts )    # create genesis (big bang! first) block
+    ##  note: allow/support splat-* for now for convenience (auto-wraps args into array)
+    if args.size == 1 && args[0].is_a?( Array )
+      transactions = args[0]   ## "unwrap" array in array
+    else
+      transactions = args      ## use "auto-wrapped" splat array
+    end
     ## uses index zero (0) and arbitrary previous_hash ('0')
-    Block.new( 0, data, '0' )
+    ##  note: pass along (optional) custom timestamp (e.g. used for 1637 etc.)
+    Block.new( 0, transactions, '0', timestamp: opts[:timestamp] )
   end
 
-  def self.next( previous, data='Transaction Data...' )
-    Block.new( previous.index+1, data, previous.hash )
+  def self.next( previous, *args, **opts )
+    ## note: allow/support splat-* for now for convenience (auto-wraps args into array)
+    if args.size == 1 && args[0].is_a?( Array )
+      transactions = args[0]   ## "unwrap" array in array
+    else
+      transactions = args      ## use "auto-wrapped" splat array
+    end
+    Block.new( previous.index+1, transactions, previous.hash, timestamp: opts[:timestamp] )
   end
 
+
 private
+  def calc_hash_with_nonce( nonce=0 )
+    sha = Digest::SHA256.new
+    sha.update( nonce.to_s +
+                @timestamp.to_s +
+                @transactions_hash +
+                @previous_hash )
+    sha.hexdigest
+  end
 
   def compute_hash_with_proof_of_work( difficulty='00' )
     nonce = 0
@@ -51,12 +90,6 @@ private
     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
 
 

data/lib/blockchain-lite/version.rb

@@ -1,23 +1,23 @@
-# encoding: utf-8
-
-
-module BlockchainLite
-
-  MAJOR = 1
-  MINOR = 1
-  PATCH = 0
-  VERSION = [MAJOR,MINOR,PATCH].join('.')
-
-  def self.version
-    VERSION
-  end
-
-  def self.banner
-    "blockchain-lite/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
-  end
-
-  def self.root
-    "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"
-  end
-
-end # module BlockchainLite
+# encoding: utf-8
+
+
+module BlockchainLite
+
+  MAJOR = 1
+  MINOR = 4
+  PATCH = 1
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "blockchain-lite/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}] in (#{root})"
+  end
+
+  def self.root
+    File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )
+  end
+
+end # module BlockchainLite

data/test/helper.rb

@@ -1,10 +1,28 @@
-## $:.unshift(File.dirname(__FILE__))
-
-## minitest setup
-
-require 'minitest/autorun'
-
-
-## our own code
-
-require 'blockchain-lite'
+## $:.unshift(File.dirname(__FILE__))
+
+## minitest setup
+
+require 'minitest/autorun'
+
+
+## our own code
+
+require 'blockchain-lite/base'    ## note: use "modular" version without "top-level" Block constant
+
+
+module Basic
+  Block = BlockchainLite::Basic::Block    ## convenience shortcut
+
+  class Blockchain < BlockchainLite::Blockchain
+    def block_class() Block; end
+  end
+end # module Basic
+
+
+module ProofOfWork
+  Block = BlockchainLite::ProofOfWork::Block    ## convenience shortcut
+
+  class Blockchain < BlockchainLite::Blockchain
+    def block_class() Block; end
+  end
+end  # module ProofOfWork