liability-proof 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 977147c8250bb363215bad2fd155bc13aec6269f
-  data.tar.gz: c84794a53390071cb9800bf692eff4c0e2bf2b0d
+  metadata.gz: 4797e8b0a6476b62e63295f314d67be4d6e38720
+  data.tar.gz: 62cae3a120745d3cd0c374ce6090f14061dbc3c8
 SHA512:
-  metadata.gz: 662738943559c4e770f91d11de77a39af291418c775b8a0b7a774aa710bf5d51e3f5a60e26a887c4486676c815df9eb1615314391ce65e2d82861eac84dbae89
-  data.tar.gz: e5e98a75e127860b41ed67cc102a8bc370c0ffdea3b6960daf59b9599ea346e7e5fec3311307d8ec2a7d6a9683949f6ea64f9d0a3104bb75f1cfd19035e2f395
+  metadata.gz: b2377f8e93174f8ada47fa7bc3a4eac28c6d657253e4726de973011a7bb3bb74e5c2cd78ee9c78ca764506d2e8c9f4de5f8d604abb9928ba28c77b766eb6da11
+  data.tar.gz: fc588a9d2eb4c957c18c85d9fc754460f068f635eec771787eb860bd21f4ff5a88d6c86e8f83f4bec8c7e2d6bba789accfd431bd061fde2c66999f5812d6a042

data/README.markdown

@@ -21,10 +21,18 @@ As command line tool:
     # https://github.com/olalonde/blind-liability-proof#serialized-data-formats-work-in-progress--draft
     lproof generate -f accounts.json
 
-    # verify specified partial tree is valid, i.e. the root node calculated from
+    # Use -F switch to save numbers as Float instead of String. Save numbers as
+    # String preserve precision well, but some other verification tools doesn't
+    # work well with it, so -F is provided for compatibility only.
+    lproof generate -f accounts.json -F
+
+    # Verify specified partial tree is valid, i.e. the root node calculated from
     # from the partial tree matches the root node in root.json
     lproof verify -r root.json -f partial_trees/jan.json
 
+    # Pretty print a partial tree or any other json file
+    lproof pp -f partial_trees/jan.json
+
 As library: check `LiabilityProof::Generator` and `LiabilityProof::Verifier` for example.
 
 ### License ###

data/bin/lproof

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
+$:.unshift File.expand_path('../../lib', __FILE__)
 require 'liability-proof'
 require 'optparse'
 
@@ -9,12 +10,13 @@ opt_parser = OptionParser.new do |opt|
   opt.banner = "Usage: #{$0} COMMAND [OPTIONS]"
   opt.separator ""
   opt.separator "Commands"
-  opt.separator "    generate: generate json of root node and partial trees"
-  opt.separator "    verify: verify specified partial tree is valid (matches root node)"
+  opt.separator "    generate    (g):  generate json of root node and partial trees"
+  opt.separator "    verify      (v):  verify specified partial tree is valid (matches root node)"
+  opt.separator "    prettyprint (pp): pretty print generated json"
   opt.separator ""
   opt.separator "Options"
 
-  opt.on("-f", "--file source.json", "Specify source file. For generate command, it should contain accounts data; for verify command, it should contain the partial tree.") do |f|
+  opt.on("-f", "--file source.json", "Specify source file. For generate command, it should contain accounts data; for verify command, it should contain the partial tree; for prettyprint command it specify the json to print.") do |f|
     options[:file] = f
   end
 
@@ -26,15 +28,32 @@ opt_parser = OptionParser.new do |opt|
   opt.on("--partial-trees-dir DIR", "Specify the directory to store generated partial tree json files, default to 'partial_trees'.") do |d|
     options[:partial_trees_dir] = d
   end
+
+  options[:use_float] = false
+  opt.on("-F", "--use-float", "Print numbers as Float number instead of String in json files. This option is only provided to generating data in compatible format with some verification tools, don't use it unless neccessary. Default to false.") do |f|
+    options[:use_float] = true
+  end
+
+  options[:float_nonce] = false
+  opt.on("--float-nonce", "Use float number as nonce. This option is only provided for compatibility with some verification tools. Default to false.") do |f|
+    options[:float_nonce] = true
+  end
+
+  opt.on("-b", "--blp-format", "Generate json in blind-liability-proof format. Default to false.") do |f|
+    options[:use_float]   = true
+    options[:float_nonce] = true
+  end
 end
 
 opt_parser.parse!
 
 case ARGV[0]
-when 'generate'
+when 'generate', 'g'
   LiabilityProof::Generator.new(options).write!
-when 'verify'
+when 'verify', 'v'
   LiabilityProof::Verifier.new(options).verify!
+when 'prettyprint', 'pp'
+  LiabilityProof::PrettyPrinter.new(options).print
 else
   puts opt_parser
 end

data/lib/liability-proof/generator.rb

@@ -1,4 +1,3 @@
-require 'json'
 require 'fileutils'
 
 module LiabilityProof
@@ -12,17 +11,7 @@ module LiabilityProof
       FileUtils.mkdir @partial_trees_dir unless File.exists?(@partial_trees_dir)
 
       accounts = JSON.parse File.read(@accounts_path)
-      @tree    = LiabilityProof::Tree.new accounts
-    end
-
-    def root_json
-      { 'root' => {
-          'hash'  => @tree.root.hash,
-          'value' => @tree.root.value_string }}
-    end
-
-    def partial_tree_json(user)
-      { 'partial_tree' => @tree.partial(user) }
+      @tree    = LiabilityProof::Tree.new accounts, options
     end
 
     def write!
@@ -34,13 +23,13 @@ module LiabilityProof
 
     def write_root_json
       File.open(@root_path, 'w') do |f|
-        f.write JSON.dump(root_json)
+        f.write JSON.dump(@tree.root_json)
       end
     end
 
     def write_partial_tree(user)
       File.open(File.join(@partial_trees_dir, "#{user}.json"), 'w') do |f|
-        f.write JSON.dump(partial_tree_json(user))
+        f.write JSON.dump(@tree.partial_json(user))
       end
     end
 

data/lib/liability-proof/pretty_printer.rb

@@ -0,0 +1,49 @@
+module LiabilityProof
+  class PrettyPrinter
+
+    def initialize(options)
+      @json_path = options.delete(:file)
+      raise ArgumentError, "file to print unspecified" unless @json_path
+
+      @json = JSON.parse File.read(@json_path)
+    end
+
+    def print
+      if Hash === @json && @json.keys.first == 'partial_tree'
+        print_tree @json['partial_tree']
+      else
+        ap @json
+      end
+    end
+
+    private
+
+    def print_tree(node, depth=0)
+      print_node node, depth
+
+      if node.has_key?('left') && node.has_key?('right')
+        print_tree node['left'],  depth+1
+        print_tree node['right'], depth+1
+      else # leaf
+      end
+    end
+
+    def print_node(node, depth)
+      tab = " |"*depth + "_ "
+      text = lable node
+      puts "#{tab}#{text}"
+    end
+
+    def lable(node)
+      if data = node['data']
+        if data['user']
+          "#{data['user']}, #{data['nonce']}, #{data['value']}"
+        else
+          "#{data['value']}, #{data['hash']}"
+        end
+      else
+        ''
+      end
+    end
+  end
+end

data/lib/liability-proof/tree/leaf_node.rb

@@ -4,25 +4,19 @@ module LiabilityProof
     class LeafNode < Struct.new(:user, :value, :nonce, :hash)
       include ::LiabilityProof::Tree::Node
 
-      def initialize(account)
-        value = BigDecimal.new(account['value'] || account['balance'])
-        super(account['user'], value)
+      def initialize(user, value, nonce, hash=nil)
+        raise ArgumentError, "value must be BigDecimal" unless value.is_a?(BigDecimal)
 
-        self.nonce = account['nonce'] || generate_nonce
-        self.hash  = account['hash']  || generate_hash
+        super(user, value, nonce)
+        self.hash  = hash || generate_hash
 
-        if account['user'] && account['hash'] && account['nonce']
-          raise ArgumentError, "Hash doesn't match" if generate_hash != account['hash']
+        if user && hash && nonce
+          raise ArgumentError, "Hash doesn't match" if generate_hash != hash
         end
       end
 
       private
 
-      # a 16 bytes random string encoded in 32 hex digits
-      def generate_nonce
-        OpenSSL::Random.random_bytes(16).unpack("H*").first
-      end
-
       # a sha256 hash encoded in 64 hex digits
       def generate_hash
         LiabilityProof.sha256_base64 "#{user}|#{value_string}|#{nonce}"

data/lib/liability-proof/tree/node.rb

@@ -3,14 +3,18 @@ module LiabilityProof
 
     module Node
 
-      def as_json
-        { 'value' => value_string, 'hash' => hash }
+      def as_json(use_float=false)
+        { 'value' => formatted_value(use_float), 'hash' => hash }
       end
 
       def value_string
         value.to_s('F')
       end
 
+      def formatted_value(use_float)
+        use_float ? value.to_f : value_string
+      end
+
     end
 
   end

data/lib/liability-proof/tree.rb

@@ -1,5 +1,4 @@
 require 'base64'
-require 'bigdecimal'
 require 'openssl'
 
 module LiabilityProof
@@ -11,12 +10,21 @@ module LiabilityProof
 
     attr :root, :indices
 
-    def initialize(accounts)
+    def initialize(accounts, options={})
       raise ArgumentError, 'accounts is empty' unless accounts && accounts.size > 0
 
-      @accounts = accounts
-      @root     = generate
-      @indices  = Hash[index_leaves(@root)]
+      @use_float   = options.delete(:use_float)
+      @float_nonce = options.delete(:float_nonce)
+
+      @accounts    = accounts
+      @root        = generate
+      @indices     = Hash[index_leaves(@root)]
+    end
+
+    def root_json
+      { 'root' => {
+          'hash'  => root.hash,
+          'value' => root.formatted_value(@use_float) }}
     end
 
     def partial(user)
@@ -25,11 +33,15 @@ module LiabilityProof
       h
     end
 
+    def partial_json(user)
+      { 'partial_tree' => partial(user) }
+    end
+
     private
 
     def _partial(user, node, index, acc)
       if node.is_a?(LeafNode)
-        acc['data'] = node.as_json
+        acc['data'] = node.as_json(@use_float)
 
         if node.user == user
           acc['data'].merge!({
@@ -43,17 +55,33 @@ module LiabilityProof
         follow_child     = node.send follow_direction
         other_child      = node.send other_direction
 
-        acc[other_direction.to_s]  = { 'data' => other_child.as_json }
+        acc[other_direction.to_s]  = { 'data' => other_child.as_json(@use_float) }
         acc[follow_direction.to_s] = { 'data' => nil }
         _partial user, follow_child, index, acc[follow_direction.to_s]
       end
     end
 
     def generate
-      leaves = @accounts.map {|a| LeafNode.new(a) }
+      leaves = @accounts.map do |a|
+        user  = a['user']
+        value = ::BigDecimal.new a['balance']
+        nonce = a['nonce'] || generate_nonce
+        LeafNode.new(user, value, nonce)
+      end
+
       combine leaves
     end
 
+    def generate_nonce
+      if @float_nonce
+        # a float number like 0.123456789, for compatibility with blp
+        rand
+      else
+        # a 16 bytes random string encoded in 32 hex digits
+        OpenSSL::Random.random_bytes(16).unpack("H*").first
+      end
+    end
+
     def combine(nodes)
       return nodes.first if nodes.size <= 1
 

data/lib/liability-proof/verifier.rb

@@ -1,5 +1,3 @@
-require 'json'
-
 module LiabilityProof
   class Verifier
 
@@ -22,7 +20,11 @@ module LiabilityProof
 
     def match?
       partial_tree = partial_tree_json['partial_tree']
-      reduce(partial_tree).as_json == expect_root
+
+      use_float = expect_root['value'].is_a?(Float)
+      @reduced_root = reduce(partial_tree).as_json(use_float)
+
+      @reduced_root == expect_root
     end
 
     def verify!
@@ -31,18 +33,28 @@ module LiabilityProof
         puts "User: #{@user_node.user}"
         puts "Balance: #{@user_node.value_string}"
       else
-        raise "Mismatch! Expected root: #{expect_root.inspect}"
+        raise "Mismatch! Expected root: #{expect_root.inspect}, calculated root: #{@reduced_root.inspect}"
       end
     rescue
       puts "INVALID partial tree!"
       puts "ERROR: #{$!}"
+      puts "Expected root:"
+      ap expect_root
+      if @reduced_root
+        puts "Calculated root:"
+        ap @reduced_root
+      end
     end
 
     private
 
     def reduce(node)
       if node['data']
-        leaf = Tree::LeafNode.new node['data']
+        user  = node['data']['user']
+        value = ::BigDecimal.new node['data']['value'].to_s
+        nonce = node['data']['nonce']
+        hash  = node['data']['hash']
+        leaf = Tree::LeafNode.new user, value, nonce, hash
         @user_node = leaf if leaf.user
         leaf
       else

data/lib/liability-proof/version.rb

@@ -1,3 +1,3 @@
 module LiabilityProof
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/liability-proof.rb

@@ -1,8 +1,13 @@
+require 'json'
+require 'bigdecimal'
+require 'awesome_print'
+
 module LiabilityProof
 
-  autoload :Tree,      'liability-proof/tree'
-  autoload :Generator, 'liability-proof/generator'
-  autoload :Verifier,  'liability-proof/verifier'
+  autoload :Tree,          'liability-proof/tree'
+  autoload :Generator,     'liability-proof/generator'
+  autoload :Verifier,      'liability-proof/verifier'
+  autoload :PrettyPrinter, 'liability-proof/pretty_printer'
 
   module_function
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: liability-proof
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Peatio Opensource
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-17 00:00:00.000000000 Z
-dependencies: []
+date: 2014-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Check https://iwilcox.me.uk/2014/proving-bitcoin-reserves for more details.
 email:
 - community@peatio.com
@@ -22,6 +36,7 @@ files:
 - bin/lproof
 - lib/liability-proof.rb
 - lib/liability-proof/generator.rb
+- lib/liability-proof/pretty_printer.rb
 - lib/liability-proof/tree.rb
 - lib/liability-proof/tree/interior_node.rb
 - lib/liability-proof/tree/leaf_node.rb