zold 0.6 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01a2323174e903dabb35708bfd1d0f756e930035
-  data.tar.gz: a4f6582b8e645cd480ab74e374cc5cefe3698034
+  metadata.gz: 42d45258927844c4cc2c07418af8b5077787731b
+  data.tar.gz: 508255ebe906bd0c4dd9fcb88ed12dee32a1973a
 SHA512:
-  metadata.gz: 8e6c51f38a8f4d44c86c6cf1d2c02d3db2a1495504613c29676922a91bc03b325524b87d592dabdeb406fc9ca6906725de8666b805ea98731a7fe4271c950123
-  data.tar.gz: '0906447919a3f02950152613a65b19d648ca46cf480405659751ab6ab4eee1d08b01f8f1dfef2a60de4c5e55b17433913637daf37c0d7451f13e8320aa33c572'
+  metadata.gz: 4783b3ade202e80fb6b252ed58cab12176a0bcb70cc4584e67e3e6fe49f1ec9fcd2fdb1df0020f7a2d13b20e865e99c591a14604e402b8725acc9168a6365b2b
+  data.tar.gz: c8c189ee8908b4479b3b9e71f73776995ddcfc407cb2bdb6e32b15339c63bbdfc86a6f5a49845ad064bbd92cc1f50c2da557be6ae9d3a2673dbe478f4c80c0cc

data/.rubocop.yml

@@ -6,7 +6,7 @@ AllCops:
   TargetRubyVersion: 2.2
 
 Metrics/CyclomaticComplexity:
-  Max: 15
+  Max: 25
 Metrics/MethodLength:
   Enabled: false
 Layout/MultilineMethodCallIndentation:
@@ -17,13 +17,13 @@ Metrics/BlockLength:
   Max: 100
 Metrics/ClassLength:
   Max: 200
-Style/EndOfLine:
+Layout/EndOfLine:
   EnforcedStyle: lf
 Metrics/ParameterLists:
   Max: 10
 Layout/AlignParameters:
   Enabled: false
 Metrics/PerceivedComplexity:
-  Max: 15
+  Max: 25
 Metrics/LineLength:
   Max: 120

data/README.md

@@ -17,21 +17,6 @@
 **NOTICE**: It's an experiment and a very early draft! Please, feel free to
 submit your ideas or pull requests.
 
-ZOLD principles include:
-
-  * The entire code base is open source;
-  * There is no mining, the only way to get ZOLD is to receive it from someone else;
-  * Only 2<sup>63</sup> numerals (no fractions) can technically be issued;
-  * The first wallet belongs to the issuer and may have a negative balance;
-  * A wallet is a plain text file;
-  * There is no central ledger, each wallet has its own personal ledger;
-  * Each transaction in the ledger is confirmed by [RSA](https://simple.wikipedia.org/wiki/RSA_%28algorithm%29) encryption;
-  * The network of communicating nodes maintains wallets of users;
-  * Anyone can add a node to the network.
-
-1 ZLD by convention equals to 2<sup>24</sup> (16,777,216) _zents_.
-Thus, the technical capacity of the currency is 549,755,813,888 ZLD (half a trillion).
-
 ## How to Use
 
 Install Ruby 2.2+, [Rubygems](https://rubygems.org/pages/download), and then run:
@@ -44,20 +29,9 @@ $ gem install zold
 Then, either run it as a node:
 
 ```bash
-$ zold start
+$ zold node
 ```
 
-Or do one of the following:
-
-  * `zold remote` manipulates the list off remote nodes;
-  * `zold create` creates a new wallet (you have to provide PGP keys);
-  * `zold fetch` downloads all copies of the wallet from the network;
-  * `zold merge` merges all copies of the wallet into the local one;
-  * `zold pull` first `fetch`, then `merge`;
-  * `zold show` prints out all known details of a wallet (incl. its balance);
-  * `zold pay` creates a new transaction;
-  * `zold push` pushes a wallet to the network.
-
 For more options and commands just run:
 
 ```bash
@@ -71,60 +45,6 @@ yet, you can run:
 $ ssh-keygen -t rsa -b 4096
 ```
 
-## Glossary
-
-**Node** is an HTTP server with a RESTful API, a maintainer of wallets
-and a command line Ruby gem [`zold`](https://rubygems.org/gems/zold).
-
-**Network** is a set of all nodes available online.
-
-**Score** is the amount of "hash sufficies" a node has at any given moment of time.
-
-**Wallet** is a text file with a ledger of all transactions inside.
-
-**Transaction** is a money transferring operation between two wallets.
-
-**MSS** (minimum summary score) is a summary of all scores required to trust a wallet.
-
-## Score
-
-Each node calculates its own score. First, it takes the current timestamp
-in UTC [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601),
-for example `2017-07-19T21:24:51Z ` (with a trailing space). Then, it appends
-its own host name or IP address to it, space, TCP port number, and a space.
-Then, it attempts to append any
-arbitrary text (has to match `[a-zA-Z0-9]+`) to the end of it and to calculate SHA-256 of the text
-in the hexadecimal format, for example:
-
-```
-Input: "2017-07-19T21:24:51Z b1.zold.io 4096 the-suffix"
-SHA-256: "eba36e52e1ee674d198f486e07c8496853ffc8879e7fe25329523177646a96a0"
-```
-
-The node attempts to try different sufficies until one of them produces
-SHA-256 hash that ends with `0000000` (seven zeros). For example, this
-suffix `11edb424c` works (it took 212 minutes to find it on 2.3GHz Intel Core i7):
-
-```
-Input: "2017-07-19T21:24:51Z b1.zold.io 4096 11edb424c"
-SHA-256: "34f48e0eee1ed12ad74cb39418f2f6e7442a776a7b6182697957650e00000000"
-```
-
-When the first suffix is found, the score of the node is 1. Then, to
-increase the score by one, the node has to find the next suffix, which
-can be added to the first 20 characters of the previous hash
-in order to obtain a new hash with trailing zeros, for example:
-
-```
-Input: "34f48e0eee1ed12ad74c "
-SHA-256: "..."
-```
-
-And so on.
-
-The score is valid only when the starting time point is earlier than
-current time, but not earlier than 24 hours ago.
-
 ## Operations
 
 ### Remote

data/bin/zold

@@ -41,7 +41,7 @@ Encoding.default_internal = Encoding::UTF_8
 log = Zold::Log.new
 
 args = []
-unless ENV['RACK_ENV'] == 'test'
+unless ENV['RACK_ENV'] == 'test' || ARGV.find { |a| a == '--ignore-global-config' }
   config = File.expand_path('~/.zold')
   if File.exist?(config)
     body = File.read(config)
@@ -92,6 +92,7 @@ Available options:"
       default: Dir.pwd
     o.bool '-h', '--help', 'Show these instructions'
     o.bool '--trace', 'Show full stack trace in case of a problem'
+    o.bool '--ignore-global-config', 'Don\'t read options from the ~/.zold file'
     o.on '--no-colors', 'Disable colors in the ouput' do
       Rainbow.enabled = false
     end
@@ -104,16 +105,17 @@ Available options:"
     end
   end
 
-  raise 'Try --help' if opts.arguments.empty? && !opts.help?
+  commands = opts.arguments.reject { |a| a.start_with?('-') }
+  command = commands[0]
 
-  if opts.help? && opts.arguments.empty?
+  if command.nil?
+    raise 'A command required, try --help' unless opts.help?
     log.info(opts.to_s)
     exit
   end
 
-  command = opts.arguments[0]
-
-  args = args[(args.index(command) + 1)..-1]
+  args = opts.arguments
+  args << '--help' if opts.help?
 
   wallets = Zold::Wallets.new(opts['dir'])
   remotes = Zold::Remotes.new(File.join(opts['dir'], '.zoldata/remotes'))

data/features/cli.feature

@@ -12,6 +12,6 @@ Feature: Command Line Processing
     Then Exit code is zero
 
   Scenario: Wallet can be created
-    When I run bin/zold with "--trace create --public-key=id_rsa.pub"
+    When I run bin/zold with "--trace --public-key=id_rsa.pub create"
     Then Exit code is zero
 

data/fixtures/scripts/print-helps.sh

@@ -9,5 +9,5 @@ zold --help
 declare -a commands=(node create invoice remote pay show fetch clean diff merge propagate pull push)
 for c in "${commands[@]}"
 do
-  zold --trace $c --help
+  zold --ignore-global-config --trace $c --help
 done

data/fixtures/scripts/push-and-pull.sh

@@ -3,7 +3,7 @@ set -x
 set -e
 shopt -s expand_aliases
 
-alias zold="$1"
+alias zold="$1 --ignore-global-config --trace"
 
 port=`python -c 'import socket; s=socket.socket(); s.bind(("", 0)); print(s.getsockname()[1]); s.close()'`
 
@@ -21,21 +21,21 @@ while ! nc -z localhost ${port}; do
   ((c++)) && ((c==20)) && break
 done
 
-zold --trace remote clean
-zold --trace remote add localhost ${port}
-zold --trace remote show
+zold remote clean
+zold remote add localhost ${port}
+zold remote show
 
-zold --trace create --public-key=id_rsa.pub 0000000000000000
+zold create --public-key=id_rsa.pub 0000000000000000
 target=`zold create --public-key=id_rsa.pub`
 invoice=`zold invoice ${target}`
-zold --trace pay --private-key=id_rsa 0000000000000000 ${invoice} 14.99 'To save the world!'
-zold --trace propagate 0000000000000000
-zold --trace show
-zold --trace show 0000000000000000
+zold pay --private-key=id_rsa 0000000000000000 ${invoice} 14.99 'To save the world!'
+zold propagate 0000000000000000
+zold show
+zold show 0000000000000000
 
-zold --trace remote show
-zold --trace push 0000000000000000
-zold --trace fetch 0000000000000000 --ignore-score-weakness
-zold --trace diff 0000000000000000
-zold --trace merge 0000000000000000
-zold --trace clean 0000000000000000
+zold remote show
+zold push 0000000000000000
+zold fetch 0000000000000000 --ignore-score-weakness
+zold diff 0000000000000000
+zold merge 0000000000000000
+zold clean 0000000000000000

data/lib/zold/commands/clean.rb

@@ -39,7 +39,7 @@ module Zold
     end
 
     def run(args = [])
-      opts = Slop.parse(args, help: true) do |o|
+      opts = Slop.parse(args, help: true, suppress_errors: true) do |o|
         o.banner = "Usage: zold clean [ID...] [options]
 Available options:"
         o.bool '--help', 'Print instructions'
@@ -48,8 +48,9 @@ Available options:"
         @log.info(opts.to_s)
         return
       end
-      raise 'At least one wallet ID is required' if opts.arguments.empty?
-      opts.arguments.each do |id|
+      mine = opts.arguments[1..-1]
+      raise 'At least one wallet ID is required' if mine.empty?
+      mine.each do |id|
         clean(Copies.new(File.join(@copies, id)), opts)
       end
     end

data/lib/zold/commands/create.rb

@@ -35,7 +35,7 @@ module Zold
     end
 
     def run(args = [])
-      opts = Slop.parse(args, help: true) do |o|
+      opts = Slop.parse(args, help: true, suppress_errors: true) do |o|
         o.banner = "Usage: zold create [options]
 Available options:"
         o.string '--public-key',
@@ -48,7 +48,8 @@ Available options:"
         @log.info(opts.to_s)
         return
       end
-      create(opts.arguments.empty? ? Id.new : Id.new(opts.arguments[0]), opts)
+      mine = opts.arguments[1..-1]
+      create(mine.empty? ? Id.new : Id.new(mine[0]), opts)
     end
 
     def create(id, opts)

data/lib/zold/commands/diff.rb

@@ -39,7 +39,7 @@ module Zold
     end
 
     def run(args = [])
-      opts = Slop.parse(args, help: true) do |o|
+      opts = Slop.parse(args, help: true, suppress_errors: true) do |o|
         o.banner = "Usage: zold diff [ID...] [options]
 Available options:"
         o.bool '--help', 'Print instructions'
@@ -48,9 +48,10 @@ Available options:"
         @log.info(opts.to_s)
         return
       end
-      raise 'At least one wallet ID is required' if opts.arguments.empty?
+      mine = opts.arguments[1..-1]
+      raise 'At least one wallet ID is required' if mine.empty?
       stdout = ''
-      opts.arguments.each do |id|
+      mine.each do |id|
         stdout += diff(
           @wallets.find(Id.new(id)),
           Copies.new(File.join(@copies, id)),

data/lib/zold/commands/fetch.rb

@@ -41,7 +41,7 @@ module Zold
     end
 
     def run(args = [])
-      opts = Slop.parse(args, help: true) do |o|
+      opts = Slop.parse(args, help: true, suppress_errors: true) do |o|
         o.banner = "Usage: zold fetch [ID...] [options]
 Available options:"
         o.bool '--ignore-score-weakness',
@@ -56,8 +56,9 @@ Available options:"
         @log.info(opts.to_s)
         return
       end
-      raise 'At least one wallet ID is required' if opts.arguments.empty?
-      opts.arguments.each do |id|
+      mine = opts.arguments[1..-1]
+      raise 'At least one wallet ID is required' if mine.empty?
+      mine.each do |id|
         fetch(id, Copies.new(File.join(@copies, id)), opts)
       end
     end

data/lib/zold/commands/invoice.rb

@@ -35,7 +35,7 @@ module Zold
     end
 
     def run(args = [])
-      opts = Slop.parse(args, help: true) do |o|
+      opts = Slop.parse(args, help: true, suppress_errors: true) do |o|
         o.banner = "Usage: zold invoice ID [options]
 Where:
     'ID' is the wallet ID of the money receiver
@@ -49,8 +49,9 @@ Available options:"
         @log.info(opts.to_s)
         return
       end
-      raise 'Receiver wallet ID is required' if opts.arguments[0].nil?
-      wallet = @wallets.find(Zold::Id.new(opts.arguments[0]))
+      mine = opts.arguments[1..-1]
+      raise 'Receiver wallet ID is required' if mine[0].nil?
+      wallet = @wallets.find(Zold::Id.new(mine[0]))
       raise 'Wallet doesn\'t exist, do \'fetch\' first' unless wallet.exists?
       invoice(wallet, opts)
     end

data/lib/zold/commands/merge.rb

@@ -39,7 +39,7 @@ module Zold
 
     # Returns the array of modified wallets (IDs)
     def run(args = [])
-      opts = Slop.parse(args, help: true) do |o|
+      opts = Slop.parse(args, help: true, suppress_errors: true) do |o|
         o.banner = "Usage: zold merge [ID...] [options]
 Available options:"
         o.bool '--help', 'Print instructions'
@@ -48,9 +48,10 @@ Available options:"
         @log.info(opts.to_s)
         return
       end
-      raise 'At least one wallet ID is required' if opts.arguments.empty?
+      mine = opts.arguments[1..-1]
+      raise 'At least one wallet ID is required' if mine.empty?
       modified = []
-      opts.arguments.each do |id|
+      mine.each do |id|
         wallet = @wallets.find(Id.new(id))
         next unless merge(wallet, Copies.new(File.join(@copies, id)), opts)
         modified << Id.new(id)

data/lib/zold/commands/node.rb

@@ -38,7 +38,7 @@ module Zold
     end
 
     def run(args = [])
-      opts = Slop.parse(args, help: true) do |o|
+      opts = Slop.parse(args, help: true, suppress_errors: true) do |o|
         o.banner = 'Usage: zold node [options]'
         o.string '--invoice',
           'The invoice you want to collect money to'

data/lib/zold/commands/pay.rb

@@ -34,7 +34,7 @@ module Zold
     end
 
     def run(args = [])
-      opts = Slop.parse(args, help: true) do |o|
+      opts = Slop.parse(args, help: true, suppress_errors: true) do |o|
         o.banner = "Usage: zold pay wallet invoice amount [details] [options]
 Where:
     'wallet' is the sender's wallet ID
@@ -55,14 +55,15 @@ Available options:"
         @log.info(opts.to_s)
         return
       end
-      raise 'Payer wallet ID is required' if opts.arguments[0].nil?
-      from = @wallets.find(Zold::Id.new(opts.arguments[0]))
+      mine = opts.arguments[1..-1]
+      raise 'Payer wallet ID is required as the first argument' if mine[0].nil?
+      from = @wallets.find(Zold::Id.new(mine[0]))
       raise 'Wallet doesn\'t exist, do \'fetch\' first' unless from.exists?
-      raise 'Recepient\'s invoice is required' if opts.arguments[1].nil?
-      invoice = opts.arguments[1]
-      raise 'Amount is required (in ZLD)' if opts.arguments[2].nil?
-      amount = Zold::Amount.new(zld: opts.arguments[2].to_f)
-      details = opts.arguments[3] ? opts.arguments[3] : '-'
+      raise 'Recepient\'s invoice is required as the second argument' if mine[1].nil?
+      invoice = mine[1]
+      raise 'Amount is required (in ZLD) as the third argument' if mine[2].nil?
+      amount = Zold::Amount.new(zld: mine[2].to_f)
+      details = mine[3] ? mine[3] : '-'
       pay(from, invoice, amount, details, opts)
     end
 

data/lib/zold/commands/propagate.rb

@@ -37,7 +37,7 @@ module Zold
 
     # Returns list of Wallet IDs which were affected
     def run(args = [])
-      opts = Slop.parse(args, help: true) do |o|
+      opts = Slop.parse(args, help: true, suppress_errors: true) do |o|
         o.banner = "Usage: zold propagate [ID...] [options]
 Available options:"
         o.bool '--help', 'Print instructions'
@@ -46,9 +46,10 @@ Available options:"
         @log.info(opts.to_s)
         return
       end
-      raise 'At least one wallet ID is required' if opts.arguments.empty?
+      mine = opts.arguments[1..-1]
+      raise 'At least one wallet ID is required' if mine.empty?
       modified = []
-      opts.arguments.each do |id|
+      mine.each do |id|
         modified += propagate(@wallets.find(id), opts)
       end
       modified

data/lib/zold/commands/push.rb

@@ -39,7 +39,7 @@ module Zold
     end
 
     def run(args = [])
-      opts = Slop.parse(args, help: true) do |o|
+      opts = Slop.parse(args, help: true, suppress_errors: true) do |o|
         o.banner = "Usage: zold push [ID...] [options]
 Available options:"
         o.bool '--help', 'Print instructions'
@@ -48,8 +48,9 @@ Available options:"
         @log.info(opts.to_s)
         return
       end
-      raise 'At least one wallet ID is required' if opts.arguments.empty?
-      opts.arguments.each do |id|
+      mine = opts.arguments[1..-1]
+      raise 'At least one wallet ID is required' if mine.empty?
+      mine.each do |id|
         push(@wallets.find(Id.new(id)), opts)
       end
     end

data/lib/zold/commands/remote.rb

@@ -41,7 +41,7 @@ module Zold
     end
 
     def run(args = [])
-      opts = Slop.parse(args, help: true) do |o|
+      opts = Slop.parse(args, help: true, suppress_errors: true) do |o|
         o.banner = "Usage: zold remote <command> [options]
 Available commands:
     #{Rainbow('remote show').green}
@@ -62,7 +62,12 @@ Available options:"
           default: false
         o.bool '--help', 'Print instructions'
       end
-      command = opts.arguments[0]
+      if opts.help?
+        @log.info(opts.to_s)
+        return
+      end
+      mine = opts.arguments[1..-1]
+      command = mine[0]
       case command
       when 'show'
         show
@@ -71,14 +76,14 @@ Available options:"
       when 'reset'
         reset
       when 'add'
-        add(opts.arguments[1], opts.arguments[2] ? opts.arguments[2].to_i : Remotes::PORT)
+        add(mine[1], mine[2] ? mine[2].to_i : Remotes::PORT)
       when 'remove'
-        remove(opts.arguments[1], opts.arguments[2] ? opts.arguments[2].to_i : Remotes::PORT)
+        remove(mine[1], mine[2] ? mine[2].to_i : Remotes::PORT)
       when 'update'
         update(opts)
         update(opts, false)
       else
-        @log.info(opts.to_s)
+        raise "Unknown command '#{command}'"
       end
     end
 

data/lib/zold/commands/show.rb

@@ -36,7 +36,7 @@ module Zold
     end
 
     def run(args = [])
-      opts = Slop.parse(args, help: true) do |o|
+      opts = Slop.parse(args, help: true, suppress_errors: true) do |o|
         o.banner = "Usage: zold show [ID...] [options]
 Available options:"
         o.bool '--help', 'Print instructions'
@@ -45,12 +45,13 @@ Available options:"
         @log.info(opts.to_s)
         return
       end
-      if opts.arguments.empty?
+      mine = opts.arguments[1..-1]
+      if mine.empty?
         require_relative 'list'
         List.new(wallets: @wallets, log: @log).run(args)
       else
         total = Amount::ZERO
-        opts.arguments.each do |id|
+        mine.each do |id|
           total += show(@wallets.find(Id.new(id)), opts)
         end
         total

data/lib/zold/commands/taxes.rb

@@ -41,7 +41,7 @@ module Zold
     end
 
     def run(args = [])
-      opts = Slop.parse(args, help: true) do |o|
+      opts = Slop.parse(args, help: true, suppress_errors: true) do |o|
         o.banner = "Usage: zold taxes command [options]
 Available commands:
     #{Rainbow('taxes pay').green} wallet
@@ -57,21 +57,22 @@ Available options:"
           default: '~/.ssh/id_rsa'
         o.bool '--help', 'Print instructions'
       end
-      command = opts.arguments[0]
+      mine = opts.arguments[1..-1]
+      command = mine[0]
       case command
       when 'show'
-        raise 'At least one wallet ID is required' unless opts.arguments[1]
-        opts.arguments[1..-1].each do |id|
+        raise 'At least one wallet ID is required' unless mine[1]
+        mine[1..-1].each do |id|
           show(@wallets.find(Id.new(id), opts))
         end
       when 'debt'
-        raise 'At least one wallet ID is required' unless opts.arguments[1]
-        opts.arguments[1..-1].each do |id|
+        raise 'At least one wallet ID is required' unless mine[1]
+        mine[1..-1].each do |id|
           debt(@wallets.find(Id.new(id), opts))
         end
       when 'pay'
-        raise 'At least one wallet ID is required' unless opts.arguments[1]
-        opts.arguments[1..-1].each do |id|
+        raise 'At least one wallet ID is required' unless mine[1]
+        mine[1..-1].each do |id|
           pay(@wallets.find(Id.new(id)), opts)
         end
       else

data/lib/zold/node/entrance.rb

@@ -55,10 +55,10 @@ module Zold
       copies.add(body, 'remote', Remotes::PORT, 0)
       Fetch.new(
         remotes: @remotes, copies: copies.root, log: @log
-      ).run([id.to_s, "--ignore-node=#{@address}"])
+      ).run(['fetch', id.to_s, "--ignore-node=#{@address}"])
       modified = Merge.new(
         wallets: @wallets, copies: copies.root, log: @log
-      ).run([id.to_s])
+      ).run(['merge', id.to_s])
       debt = Tax.new(@wallets.find(id)).debt
       if debt > Tax::TRIAL
         raise "Taxes are not paid, the debt is #{debt} (#{debt.to_i} zents), won't promote the wallet"
@@ -67,7 +67,7 @@ module Zold
       modified.each do |m|
         Push.new(
           wallets: @wallets, remotes: @remotes, log: @log
-        ).run([m.to_s])
+        ).run(['push', m.to_s])
       end
       modified
     end

data/lib/zold/score.rb

@@ -165,7 +165,7 @@ module Zold
       @suffixes.reduce(start) do |prefix, suffix|
         hex = Digest::SHA256.hexdigest(prefix + ' ' + suffix)
         return false unless hex.end_with?('0' * @strength)
-        hex[0, 19]
+        hex[0, 63]
       end
       true
     end

data/lib/zold/txn.rb

@@ -34,19 +34,25 @@ module Zold
     attr_reader :id, :date, :amount, :prefix, :bnf, :details, :sign
     attr_writer :sign, :amount, :bnf
     def initialize(id, date, amount, prefix, bnf, details)
+      raise 'The ID can\'t be NIL' if id.nil?
       raise "ID of transaction can't be negative: #{id}" if id < 1
       @id = id
+      raise 'The time can\'t be NIL' if date.nil?
       raise 'Time have to be of type Time' unless date.is_a?(Time)
       raise "Time can't be in the future: #{date}" if date > Time.now
       @date = date
+      raise 'The amount can\'t be NIL' if amount.nil?
       raise 'The amount has to be of type Amount' unless amount.is_a?(Amount)
       raise 'The amount can\'t be zero' if amount.zero?
       @amount = amount
+      raise 'The bnf can\'t be NIL' if bnf.nil?
       raise 'The bnf has to be of type Id' unless bnf.is_a?(Id)
       @bnf = bnf
+      raise 'Prefix can\'t be NIL' if prefix.nil?
       raise "Prefix is too short: \"#{prefix}\"" if prefix.length < 8
       raise "Prefix is too long: \"#{prefix}\"" if prefix.length > 32
       @prefix = prefix
+      raise 'Details can\'t be NIL' if details.nil?
       raise 'Details can\'t be empty' if details.empty?
       raise "Details are too long: \"#{details}\"" if details.length > 128
       raise "Details are wrong: \"#{details}\"" unless details =~ /^[a-zA-Z0-9 -\.,]{1,128}$/

data/lib/zold/version.rb

@@ -23,5 +23,5 @@
 # Copyright:: Copyright (c) 2018 Yegor Bugayenko
 # License:: MIT
 module Zold
-  VERSION = '0.6'.freeze
+  VERSION = '0.6.1'.freeze
 end

data/test/commands/test_clean.rb

@@ -35,7 +35,7 @@ class TestClean < Minitest::Test
       copies = Zold::Copies.new(File.join(dir, "copies/#{id}"))
       copies.add('a1', 'host-1', 80, 1, Time.now - 26 * 60)
       copies.add('a2', 'host-2', 80, 2, Time.now - 26 * 60)
-      Zold::Clean.new(copies: copies.root).run([id.to_s])
+      Zold::Clean.new(copies: copies.root).run(['clean', id.to_s])
       assert(copies.all.empty?)
     end
   end

data/test/commands/test_create.rb

@@ -32,7 +32,7 @@ class TestCreate < Minitest::Test
   def test_creates_wallet
     Dir.mktmpdir 'test' do |dir|
       wallet = Zold::Create.new(wallets: Zold::Wallets.new(dir)).run(
-        ['--public-key=fixtures/id_rsa.pub']
+        ['create', '--public-key=fixtures/id_rsa.pub']
       )
       assert wallet.balance.zero?
       assert(

data/test/commands/test_diff.rb

@@ -47,14 +47,14 @@ class TestDiff < Minitest::Test
       File.write(second.path, File.read(wallet.path))
       Zold::Pay.new(
         wallets: Zold::Wallets.new(dir)
-      ).run([id.to_s, second.id.to_s, '14.95', '--force', '--private-key=fixtures/id_rsa'])
+      ).run(['pay', id.to_s, second.id.to_s, '14.95', '--force', '--private-key=fixtures/id_rsa'])
       copies = Zold::Copies.new(File.join(dir, "copies/#{id}"))
       copies.add(File.read(first.path), 'host-1', 80, 5)
       copies.add(File.read(second.path), 'host-2', 80, 5)
       diff = Zold::Diff.new(
         wallets: Zold::Wallets.new(dir),
         copies: copies.root
-      ).run([id.to_s])
+      ).run(['diff', id.to_s])
       assert(diff.include?('-1;'))
     end
   end

data/test/commands/test_fetch.rb

@@ -58,7 +58,7 @@ class TestFetch < Minitest::Test
       remotes.add('fake-2', 80)
       copies = Zold::Copies.new(File.join(dir, "copies/#{id}"))
       Zold::Fetch.new(copies: copies.root, remotes: remotes).run(
-        ['--ignore-score-weakness', id.to_s]
+        ['fetch', '--ignore-score-weakness', id.to_s]
       )
       assert_equal(copies.all[0][:name], '1')
       assert_equal(copies.all[0][:score], 0)
@@ -79,7 +79,7 @@ class TestFetch < Minitest::Test
       )
       remotes.add('fake-1', 80)
       copies = Zold::Copies.new(File.join(dir, "copies/#{id}"))
-      Zold::Fetch.new(copies: copies.root, remotes: remotes).run([id.to_s])
+      Zold::Fetch.new(copies: copies.root, remotes: remotes).run(['fetch', id.to_s])
       assert_equal(copies.all[0][:name], '1')
       assert_equal(copies.all[0][:score], 0)
     end

data/test/commands/test_invoice.rb

@@ -38,7 +38,7 @@ class TestInvoice < Minitest::Test
       source = wallets.find(id)
       source.init(id, Zold::Key.new(file: 'fixtures/id_rsa.pub'))
       invoice = Zold::Invoice.new(wallets: wallets).run(
-        [id.to_s, '--length=16']
+        ['invoice', id.to_s, '--length=16']
       )
       assert_equal(33, invoice.length)
     end

data/test/commands/test_merge.rb

@@ -24,6 +24,7 @@ require 'json'
 require 'time'
 require 'webmock/minitest'
 require_relative '../../lib/zold/wallet'
+require_relative '../../lib/zold/wallets'
 require_relative '../../lib/zold/id'
 require_relative '../../lib/zold/copies'
 require_relative '../../lib/zold/key'
@@ -49,14 +50,14 @@ class TestMerge < Minitest::Test
       File.write(second.path, File.read(wallet.path))
       Zold::Pay.new(
         wallets: Zold::Wallets.new(dir)
-      ).run([id.to_s, second.id.to_s, '14.95', '--force', '--private-key=fixtures/id_rsa'])
+      ).run(['pay', id.to_s, second.id.to_s, '14.95', '--force', '--private-key=fixtures/id_rsa'])
       copies = Zold::Copies.new(File.join(dir, "copies/#{id}"))
       copies.add(File.read(first.path), 'host-1', 80, 5)
       copies.add(File.read(second.path), 'host-2', 80, 5)
       modified = Zold::Merge.new(
         wallets: Zold::Wallets.new(dir),
         copies: copies.root
-      ).run([id.to_s])
+      ).run(['merge', id.to_s])
       assert(1, modified.count)
       assert(id, modified[0])
     end
@@ -74,14 +75,14 @@ class TestMerge < Minitest::Test
       File.write(second.path, File.read(wallet.path))
       Zold::Pay.new(
         wallets: Zold::Wallets.new(dir)
-      ).run([id.to_s, second.id.to_s, '14.95', '--force', '--private-key=fixtures/id_rsa'])
+      ).run(['pay', id.to_s, second.id.to_s, '14.95', '--force', '--private-key=fixtures/id_rsa'])
       copies = Zold::Copies.new(File.join(dir, "copies/#{id}"))
       copies.add(File.read(first.path), 'host-1', 80, 5)
       copies.add(File.read(second.path), 'host-2', 80, 5)
       modified = Zold::Merge.new(
         wallets: Zold::Wallets.new(dir),
         copies: copies.root
-      ).run([id.to_s])
+      ).run(['merge', id.to_s])
       assert(1, modified.count)
       assert(id, modified[0])
     end

data/test/commands/test_node.rb

@@ -46,8 +46,8 @@ class TestNode < Minitest::Test
         remotes = Zold::Remotes.new(File.join(dir, 'remotes.csv'))
         remotes.clean
         remotes.add('localhost', port)
-        Zold::Push.new(wallet: wallet, remotes: remotes).run
-        Zold::Fetch.new(wallet: wallet, copies: copies, remotes: remotes).run
+        Zold::Push.new(wallet: wallet, remotes: remotes).run(['push'])
+        Zold::Fetch.new(wallet: wallet, copies: copies, remotes: remotes).run(['fetch'])
         assert_equal(copies.all[0][:name], '1')
         assert_equal(copies.all[0][:score], 0)
       end

data/test/commands/test_pay.rb

@@ -41,7 +41,7 @@ class TestPay < Minitest::Test
       amount = Zold::Amount.new(zld: 14.95)
       Zold::Pay.new(wallets: wallets).run(
         [
-          '--force', '--private-key=fixtures/id_rsa',
+          'pay', '--force', '--private-key=fixtures/id_rsa',
           id.to_s, target.to_s, amount.to_zld, 'For the car'
         ]
       )

data/test/commands/test_remote.rb

@@ -57,11 +57,11 @@ class TestRemote < Minitest::Test
         status: 404
       )
       cmd = Zold::Remote.new(remotes: remotes)
-      cmd.run(['clean'])
-      cmd.run(['add', zero.host, zero.port.to_s])
-      cmd.run(%w[add localhost 2])
+      cmd.run(%w[remote clean])
+      cmd.run(['remote', 'add', zero.host, zero.port.to_s])
+      cmd.run(%w[remote add localhost 2])
       assert_equal(2, remotes.all.count)
-      cmd.run(['update', '--ignore-score-weakness'])
+      cmd.run(['remote', 'update', '--ignore-score-weakness'])
       assert_equal(1, remotes.all.count)
     end
   end

data/test/commands/test_show.rb

@@ -37,7 +37,7 @@ class TestShow < Minitest::Test
       wallets = Zold::Wallets.new(dir)
       wallet = wallets.find(id)
       wallet.init(Zold::Id.new, Zold::Key.new(file: 'fixtures/id_rsa.pub'))
-      balance = Zold::Show.new(wallets: wallets).run([id.to_s])
+      balance = Zold::Show.new(wallets: wallets).run(['show', id.to_s])
       assert_equal(Zold::Amount::ZERO, balance)
     end
   end

data/test/commands/test_taxes.rb

@@ -59,7 +59,7 @@ class TestTaxes < Minitest::Test
       )
       Zold::Taxes.new(
         wallets: wallets, remotes: remotes
-      ).run(['pay', '--private-key=fixtures/id_rsa', id.to_s])
+      ).run(['taxes', '--private-key=fixtures/id_rsa', id.to_s])
       assert_equal(Zold::Amount.new(coins: 335_376_547), wallet.balance)
     end
   end

data/wp/Makefile

@@ -0,0 +1,8 @@
+OPTS=-shell-escape -halt-on-error -interaction=errorstopmode -output-directory=.
+
+wp.pdf: wp.tex
+	pdflatex ${OPTS} wp.tex
+
+clean:
+	rm -rf wp.log wp.pdf wp.out wp.aux
+

data/wp/wp.tex

@@ -1,37 +1,141 @@
 \documentclass[11pt,oneside]{article}
 \usepackage[utf8]{inputenc}
 \usepackage[american]{babel}
-\usepackage[
-  paperwidth=6in, paperheight=9in,
-  bindingoffset=0.25in, left=0.75in, right=0.75in, top=0.75in, bottom=1.25in
-]{geometry}
+% \usepackage[
+%   paperwidth=6in, paperheight=9in,
+%   bindingoffset=0.25in, left=0.75in, right=0.75in, top=0.75in, bottom=1.25in
+% ]{geometry}
 \usepackage{setspace}
-\usepackage{indentfirst}
-
-\pagestyle{empty}
-\setlength{\topskip}{6pt}
-\setlength{\parindent}{0pt} % indent first line
-\setlength{\parskip}{0pt} % before par
-\interfootnotelinepenalty=10000
-\setstretch{1.1}
-
+\usepackage{microtype}
 \usepackage{mathpazo} % Palantino font
-
+\usepackage{minted}
+  \setminted{fontsize=\footnotesize}
+  \setminted{breaklines}
+  \usemintedstyle{bw}
 \usepackage{hyperref}
-\usepackage[style=authoryear,sorting=nyt,backend=biber,
-  hyperref=true,abbreviate=true,
-  maxcitenames=1,maxbibnames=1]{biblatex}
-  \addbibresource{main.bib}
+\pagestyle{empty}
+\setstretch{1.2}
 
 \title{Zold, Lightweight Crypto Currency}
-\author{Yegor Bugayenko\\
-CEO of Zerocracy, Inc.\\
-555 Bryant, Ste 470, Palo Alto, CA 94301\\
-\texttt{yegor@zerocracy.com}\\
-408.692.4742}
-\begin{document}
+\author{Yegor Bugayenko\\\texttt{yegor@zold.io}}
 
+\begin{document}
 \raggedbottom
+\maketitle
+\begin{abstract}
+Works for you?
+\end{abstract}
+
+\section{Motivation}
+
+Bitcoin, the first decentralized digital currency, was released in
+January 2009. Since then a number of similar Blockchain-based products have been
+created, including Etherium, Litecoin, and others.
+
+Zold is also a decentralized digital currency that maintains its transactions
+in an unpredicable amount of zero-trust server nodes, trying to guarantee
+data consistency. However, the architecture of Zold is not based on Blockchain
+principles. The development of Zold was motivated by the desire to overcome
+a few obvious disadvantages of existing solutions.
+
+First, the speed of transaction processing is rather low.
+
+Second, mining commissions are high.
+
+Third, the technology is too complex.
+
+Zold was created as an attempt to resolve these mentioned problems
+of existing digital currencies.
+
+\section{Principles}
+
+\textbf{Open source}.
+Zold is a command line tool. Its entire code base is open source.
+
+\textbf{Capacity}.
+One currency unit is called ZLD.
+One ZLD by convention equals to $2^24$ (16,777,216) \emph{zents}.
+All amounts are stored as signed 64-bit integers.
+Thus, the technical capacity of the currency is 549,755,813,888 ZLD (half a trillion).
+
+\textbf{Zero wallet}.
+There is no mining, the only way to get ZLD is to receive it from someone else.
+The wallet with the \texttt{0x00} ID belongs to the
+issuer and may have a negative balance. All other wallets
+may have only positive balances.
+
+\textbf{No general ledger}.
+There is no central ledger, each wallet has its own personal ledger.
+Each transaction in the ledger is confirmed by RSA signature;
+
+\textbf{No trust}.
+The network of communicating nodes maintains wallets of users.
+Anyone can add a node to the network.
+It is assumed that any node may contain corrupted data, either by mistake or intentionally.
+
+\section{Proof of Work}
+
+Each node calculates its own score.
+First, it builds the initial text body, which consists of four parts,
+separated by spaces:
+
+\begin{itemize}
+\item The current timestamp in UTC ISO 8601,
+\item The host name or IP address, e.g. \texttf{b2.zold.io},
+\item The TCP port number,
+\item The invoice.
+\end{itemize}
+
+For example, the body may look like this:
+
+\begin{minted}{text}
+2017-07-19T21:24:51Z b2.zold.io 4096 Yt0lOy6Rgf@0000000000000000
+\end{minted}
+
+Then, it attempts to append any
+arbitrary text (has to match \texttt{[a-zA-Z0-9]+} regular expression)
+to the end of it and to calculate SHA-256 of the text
+in the hexadecimal format. For example, this would be the body
+with \texttt{abcdef} suffix:
+
+\begin{minted}{text}
+2017-07-19T21:24:51Z b2.zold.io 4096 Yt0lOy6Rgf@0000000000000000 abcdef
+\end{minted}
+
+The SHA-256 of this body will be:
+
+\begin{minted}{text}
+2017-07-19T21:24:51Z b2.zold.io 4096 Yt0lOy6Rgf@0000000000000000 abcdef
+\end{minted}
+
+The node attempts to try different sufficies until one of them produces
+SHA-256 hash that ends with \texttt{000000} (six zeros). For example, this
+suffix \texttt{...} works
+(it took about an hour to find it on 2.3GHz Intel Core i7):
+
+When the first suffix is found, the score is 1. Then, to
+increase the score by one, the next suffix has to be found, which
+can be added to the first 64 characters of the previous hash
+in order to obtain a new hash with trailing zeros, for example:
+
+\begin{minted}{text}
+2017-07-19T21:24:51Z b2.zold.io 4096 Yt0lOy6Rgf@0000000000000000 abcdef abcdef
+\end{minted}
+
+And so on.
+
+The score is valid only when the starting time point is earlier than
+current time, but not earlier than 24 hours ago. The strength of the score
+is the amount of the trailing zeros in the hash. In the example above the
+strength was equal to six.
+
+\section{Wallets}
+
+\section{Push}
+
+\section{Fetch and Merge}
+
+\section{Threats Analysis}
 
 how are you?
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zold
 version: !ruby/object:Gem::Version
-  version: '0.6'
+  version: 0.6.1
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -340,6 +340,7 @@ files:
 - test/test_wallets.rb
 - test/test_zold.rb
 - wp/.gitignore
+- wp/Makefile
 - wp/wp.tex
 - zold.gemspec
 homepage: http://github.com/zerocracy/zold