zold 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2005a5319083f1a638f7c4764776cf02c22fec87
-  data.tar.gz: 9ffb162b8a5c5daa797b0c1402283d49a81f5d26
+  metadata.gz: 1a13c84bf909f10c8a8bd34f48c944609b5b5bfe
+  data.tar.gz: e713cdd2f5b956c880cf55236d740d923a19aa22
 SHA512:
-  metadata.gz: 39f357589c34b08f98d405b8ee8307a8044c5809e51fce67a00e87ce53d713be7179ba2098ee548e4b7b9788aa276e9b40ebe271c4ade47cc7917d859a08079a
-  data.tar.gz: 18edefa475f83289160649fbfdd07df40e7c494722f5c5352650d3ae1e16d945ea269d430294a9e61e8f6f4d202c1f3efe7c66b4f72b0657dac7a9434e73e2ea
+  metadata.gz: 5ae863d2f4fb67e945b6cab6a02db1919ee60c89f9daeb1828c0e2204ae00c18f01cd2dce35b271860ea55d8f87ae26944095c739b85749494ab974396469038
+  data.tar.gz: 00ced2cb1e217024213035cc6f6f2d4c79f7d2ca165e0367ea4c51f8d9682b95c656a46a084ab9a89b0cbf87efe7800f8315c56614f222b6e2dcf773860f7810

data/README.md

@@ -17,6 +17,10 @@
 **NOTICE**: It's an experiment and a very early draft! Please, feel free to
 submit your ideas or pull requests.
 
+Here is the [White Paper](https://latexonline.cc/compile?git=https%3A%2F%2Fgithub.com%2Fyegor256%2Fzold&target=wp%2Fwp.tex&command=pdflatex&trackId=1520158941887).
+
+The license is [MIT](https://github.com/zerocracy/zold/blob/master/LICENSE.txt).
+
 ## How to Use
 
 Install Ruby 2.2+, [Rubygems](https://rubygems.org/pages/download), and then run:
@@ -38,139 +42,54 @@ For more options and commands just run:
 $ zold --help
 ```
 
-You will need PGP keys in `~/.ssh`. To generate them, if you don't have them
-yet, you can run:
+You will need PGP keys in `~/.ssh`. To generate them (if you don't have them yet):
 
 ```bash
 $ ssh-keygen -t rsa -b 4096
 ```
 
-### Remote
-
-Each node maintains a list of visible "remote" nodes.
-The gem is shipped together with a hard-coded list of a few of them.
-
-  * `remote update` goes through the list of all remote nodes,
-    checks their availability, and either removes them from the list or
-    adds new nodes to the list.
-
-  * `remote add <IP>` adds a new remote node to the list.
-
-  * `remote remove <IP>` removes a remote node.
-
-  * `remote show` prints the entire list of remote nodes.
-
-The node always tries to make sure the summary of all scores in the
-list of remote nodes is right above the MSS, but not more.
-
-### Fetch
-
-The node attempts to pull the wallet from the first remote.
-The remote returns the wallet, if it exists. Otherwise, rejects the request
-and returns the list of all remotes known to it.
-
-The node stores the content of the wallet and the score of the remote
-to the local storage.
-The local storage doesn't keep all remote copies, but only their unique
-versions and summary scores for each version.
-
-Fetching stops when:
-
-  * Total score is above MSS _or_
-  * There is only one version and the total score is above ½ MSS.
-
-If not, the node attempts the next remote in the list.
-
-### Merge
-
-The remote copy is accepted "as is" without verifications if:
-
-  * All remote copies are identical _and_
-  * Their summary score is above the MSS.
-
-Otherwise, the node goes through the entire list of transactions visible in all
-remote copies and merges them one by one into the "head" copy.
-The decision is made per each transaction.
-
-If a transaction exists in the head, it remains there.
-
-Otherwise, if it's a positive transaction that increases the balance of the head copy,
-the signature is validated (in the paying wallet, which is pulled first)
-and it goes into the head. The transaction gets a new ID.
-
-If it's a negative transaction, the decision is made between all copies.
-The one with the largest score goes first, if the balance of the wallet
-is big enough. Then, the next one in the line and so on. The transactions
-that negate the balance are rejected.
-
-### Pay
-
-The node pulls both wallets. Then, say, the user makes a payment
-from the wallet `0123456789abcdef` to the wallet `4567456745674567`:
+First, create a wallet (instead of `5f96e731e48ae21f` there will be your
+person wallet number, use it everywhere below):
 
 ```bash
-zold send 0123456789abcdef 4567456745674567 5
-```
-
-The content of both files get changed. An outgoing transaction with a negative
-amount gets added to the end of the paying wallet `0123456789abcdef`:
-
-```text
-500;2017-07-19T22:18:43Z;-83886080;4567456745674567;-;b6SKMPrVjLx...
+$ zold create
+5f96e731e48ae21f
 ```
 
-The incoming transaction gets appended to the end of the receiving wallet
-`4567456745674567`:
+Then, give its number to your friend, who is going to pay you.
+When the payment is sent, ask him or her for the number of the wallet
+the payment has been sent from and then fetch that wallet
+(let's say it is `5555444433332222`):
 
-```text
-500;2017-07-19T22:18:43Z;83886080;0123456789abcdef;-
+```bash
+$ zold fetch 5555444433332222
+5.00 ZLD added to 5f96e731e48ae21f: To my friend!
 ```
 
-### Push
-
-The node sends a package of a few wallets to the biggest remote available
-(with the highest score).
-The package must also include a fee to the wallet that belongs to the
-remote.
-
-The remote stores them as remote copies and performs _pull_.
-
-The remote sends "pull requests" to all available nodes.
-They must pull from the node for free, if their scores are lower or equal
-to the score of the node.
-
-## RESTful API
-
-The full list of RESTful resources:
+Now, you have the money in your wallet!
 
-  * `/` (GET): status page of the node, in JSON
+Next, you can pay your friend back:
 
-  * `/remotes` (GET): load all known remotes in JSON
-
-  * `/wallet/<ID>` (GET): fetch wallet in JSON
-
-  * `/wallet/<ID>` (PUT): push wallet
-
-Each HTTP response contains `Content-type` header.
-
-## Files
+```bash
+$ zold pay 5f96e731e48ae21f 5555444433332222 2.50 'Here is a refund'
+-2.50 ZLD added to 5f96e731e48ae21f: Here is a refund
+```
 
+Finally, you have to push your wallet to the network so that your friend
+knows about the payment:
 
-`.zold/remotes` is a comma-separated file with a list of remote nodes with
-these columns:
+```bash
+$ zold push 5f96e731e48ae21f
+```
 
-  * Address or IP;
-  * TCP port (usually 4096);
-  * Score (positive integer);
-  * Time of score update, ISO 8601.
+That's it.
 
-`.zold/copies` is a directory of directories, named after wallet IDs,
-each of which contains copies of wallets, named like `1`, `2`, `3`, etc. Also,
-each sub-directory contains a comma-separated file `scores` with these columns:
+You also can contribute to Zold by running a node on your server.
+In order to do that just run:
 
-  * The name of the copy, e.g. `1`;
-  * The address of the remote (host name or IP);
-  * The TCP port number of the remote;
-  * The score (positive integer);
-  * The time of fetching, in ISO 8601.
+```bash
+$ zold node --invoice=5f96e731e48ae21f
+```
 
+Grateful users of the system will pay "taxes" to your wallet for processing
+of their transactions.

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

@@ -3,7 +3,7 @@ set -x
 set -e
 shopt -s expand_aliases
 
-alias zold="$1 --ignore-global-config --trace"
+alias zold="$1 --ignore-global-config --trace --ignore-this-stupid-option"
 
 port=`python -c 'import socket; s=socket.socket(); s.bind(("", 0)); print(s.getsockname()[1]); s.close()'`
 
@@ -25,7 +25,7 @@ zold remote clean
 zold remote add localhost ${port}
 zold remote show
 
-zold create --public-key=id_rsa.pub 0000000000000000
+zold --public-key=id_rsa.pub create 0000000000000000
 target=`zold create --public-key=id_rsa.pub`
 invoice=`zold invoice ${target}`
 zold pay --private-key=id_rsa 0000000000000000 ${invoice} 14.99 'To save the world!'

data/lib/zold/amount.rb

@@ -28,10 +28,15 @@ module Zold
   # Amount
   class Amount
     def initialize(coins: nil, zld: nil)
-      raise 'You can\'t specify both coints and zld' if !coins.nil? && !zld.nil?
-      raise "Integer is required, while #{coins.class} provided: #{coins}" unless coins.nil? || coins.is_a?(Integer)
-      @coins = coins unless coins.nil?
-      @coins = (zld * 2**24).to_i unless zld.nil?
+      if !coins.nil?
+        raise "Integer is required, while #{coins.class} provided: #{coins}" unless coins.is_a?(Integer)
+        @coins = coins
+      elsif !zld.nil?
+        raise "Float is required, while #{zld.class} provided: #{zld}" unless zld.is_a?(Float)
+        @coins = (zld * 2**24).to_i
+      else
+        raise 'You can\'t specify both coints and zld'
+      end
     end
 
     ZERO = Amount.new(coins: 0)

data/lib/zold/commands/args.rb

@@ -0,0 +1,50 @@
+# Copyright (c) 2018 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'slop'
+require 'json'
+require 'net/http'
+require_relative '../log'
+require_relative '../id'
+require_relative '../http'
+
+# Args.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2018 Yegor Bugayenko
+# License:: MIT
+module Zold
+  # Command line args
+  class Args
+    def initialize(opts, log)
+      @opts = opts
+      @log = log
+    end
+
+    def take
+      if @opts.help?
+        @log.info(@opts.to_s)
+        return
+      end
+      args = @opts.arguments.reject { |a| a.start_with?('-') }
+      raise 'Try --help' if args.empty?
+      args[1..-1]
+    end
+  end
+end

data/lib/zold/commands/clean.rb

@@ -21,6 +21,9 @@
 require 'uri'
 require 'json'
 require 'time'
+require 'slop'
+require 'rainbow'
+require_relative 'args'
 require_relative '../log'
 require_relative '../http'
 require_relative '../score'
@@ -44,12 +47,8 @@ module Zold
 Available options:"
         o.bool '--help', 'Print instructions'
       end
-      if opts.help?
-        @log.info(opts.to_s)
-        return
-      end
-      mine = opts.arguments[1..-1]
-      raise 'At least one wallet ID is required' if mine.empty?
+      mine = Args.new(opts, @log).take || return
+      mine = @wallets.all if mine.empty?
       mine.each do |id|
         clean(Copies.new(File.join(@copies, id)), opts)
       end

data/lib/zold/commands/create.rb

@@ -18,6 +18,9 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+require 'slop'
+require 'rainbow'
+require_relative 'args'
 require_relative '../wallet'
 require_relative '../log'
 require_relative '../id'
@@ -44,11 +47,7 @@ Available options:"
           default: '~/.ssh/id_rsa.pub'
         o.bool '--help', 'Print instructions'
       end
-      if opts.help?
-        @log.info(opts.to_s)
-        return
-      end
-      mine = opts.arguments[1..-1]
+      mine = Args.new(opts, @log).take || return
       create(mine.empty? ? Id.new : Id.new(mine[0]), opts)
     end
 

data/lib/zold/commands/diff.rb

@@ -21,6 +21,8 @@
 require 'tempfile'
 require 'slop'
 require 'diffy'
+require 'rainbow'
+require_relative 'args'
 require_relative '../log'
 require_relative '../patch'
 require_relative '../wallet'
@@ -44,11 +46,7 @@ module Zold
 Available options:"
         o.bool '--help', 'Print instructions'
       end
-      if opts.help?
-        @log.info(opts.to_s)
-        return
-      end
-      mine = opts.arguments[1..-1]
+      mine = Args.new(opts, @log).take || return
       raise 'At least one wallet ID is required' if mine.empty?
       stdout = ''
       mine.each do |id|

data/lib/zold/commands/fetch.rb

@@ -22,6 +22,8 @@ require 'uri'
 require 'json'
 require 'time'
 require 'slop'
+require 'rainbow'
+require_relative 'args'
 require_relative '../log'
 require_relative '../http'
 require_relative '../score'
@@ -52,12 +54,8 @@ Available options:"
           default: []
         o.bool '--help', 'Print instructions'
       end
-      if opts.help?
-        @log.info(opts.to_s)
-        return
-      end
-      mine = opts.arguments[1..-1]
-      raise 'At least one wallet ID is required' if mine.empty?
+      mine = Args.new(opts, @log).take || return
+      mine = @wallets.all if mine.empty?
       mine.each do |id|
         fetch(id, Copies.new(File.join(@copies, id)), opts)
       end

data/lib/zold/commands/invoice.rb

@@ -19,6 +19,7 @@
 # SOFTWARE.
 
 require 'slop'
+require_relative 'args'
 require_relative '../log'
 require_relative '../prefixes'
 
@@ -45,11 +46,7 @@ Available options:"
           default: 8
         o.bool '--help', 'Print instructions'
       end
-      if opts.help?
-        @log.info(opts.to_s)
-        return
-      end
-      mine = opts.arguments[1..-1]
+      mine = Args.new(opts, @log).take || return
       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?

data/lib/zold/commands/merge.rb

@@ -19,6 +19,8 @@
 # SOFTWARE.
 
 require 'slop'
+require 'rainbow'
+require_relative 'args'
 require_relative '../log'
 require_relative '../id'
 require_relative '../wallet'
@@ -44,12 +46,8 @@ module Zold
 Available options:"
         o.bool '--help', 'Print instructions'
       end
-      if opts.help?
-        @log.info(opts.to_s)
-        return
-      end
-      mine = opts.arguments[1..-1]
-      raise 'At least one wallet ID is required' if mine.empty?
+      mine = Args.new(opts, @log).take || return
+      mine = @wallets.all if mine.empty?
       modified = []
       mine.each do |id|
         wallet = @wallets.find(Id.new(id))

data/lib/zold/commands/node.rb

@@ -41,7 +41,7 @@ module Zold
       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'
+          'The invoice you want to collect money to or the wallet ID'
         o.integer '--port',
           "TCP port to open for the Net (default: #{Remotes::PORT})",
           default: Remotes::PORT
@@ -94,9 +94,15 @@ module Zold
         :entrance, Entrance.new(wallets, remotes, copies, address, log: @log)
       )
       Zold::Front.set(:port, opts['bind-port'])
-      farm = Farm.new(opts[:invoice], log: @log)
+      invoice = opts[:invoice]
+      unless invoice.include?('@')
+        require_relative 'invoice'
+        invoice = Invoice.new(wallets: @wallets, log: @log).run(['invoice', invoice])
+      end
+      farm = Farm.new(invoice, log: @log)
       farm.start(
-        opts[:host], opts[:port],
+        opts[:host],
+        opts[:port],
         threads: opts[:threads], strength: opts[:strength]
       )
       Zold::Front.set(:farm, farm)

data/lib/zold/commands/pay.rb

@@ -19,6 +19,8 @@
 # SOFTWARE.
 
 require 'slop'
+require 'rainbow'
+require_relative 'args'
 require_relative '../log'
 
 # PAY command.
@@ -35,10 +37,10 @@ module Zold
 
     def run(args = [])
       opts = Slop.parse(args, help: true, suppress_errors: true) do |o|
-        o.banner = "Usage: zold pay wallet invoice amount [details] [options]
+        o.banner = "Usage: zold pay wallet target amount [details] [options]
 Where:
     'wallet' is the sender's wallet ID
-    'invoice' is the beneficiary's invoice number, generated by 'zold invoice'
+    'target' is the beneficiary (either wallet ID or invoice number)'
     'amount' is the amount to pay, in ZLD, for example '14.95'
     'details' is the optional text to attach to the payment
 Available options:"
@@ -51,16 +53,16 @@ Available options:"
           default: false
         o.bool '--help', 'Print instructions'
       end
-      if opts.help?
-        @log.info(opts.to_s)
-        return
-      end
-      mine = opts.arguments[1..-1]
+      mine = Args.new(opts, @log).take || return
       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 as the second argument' if mine[1].nil?
+      raise 'Recepient\'s invoice or wallet ID is required as the second argument' if mine[1].nil?
       invoice = mine[1]
+      unless invoice.include?('@')
+        require_relative 'invoice'
+        invoice = Invoice.new(wallets: @wallets, log: @log).run(['invoice', invoice])
+      end
       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] : '-'

data/lib/zold/commands/propagate.rb

@@ -18,6 +18,9 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+require 'slop'
+require 'rainbow'
+require_relative 'args'
 require_relative '../log'
 require_relative '../wallet'
 require_relative '../wallets'
@@ -42,12 +45,8 @@ module Zold
 Available options:"
         o.bool '--help', 'Print instructions'
       end
-      if opts.help?
-        @log.info(opts.to_s)
-        return
-      end
-      mine = opts.arguments[1..-1]
-      raise 'At least one wallet ID is required' if mine.empty?
+      mine = Args.new(opts, @log).take || return
+      mine = @wallets.all if mine.empty?
       modified = []
       mine.each do |id|
         modified += propagate(@wallets.find(id), opts)

data/lib/zold/commands/push.rb

@@ -18,9 +18,11 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+require 'rainbow'
 require 'slop'
 require 'json'
 require 'net/http'
+require_relative 'args'
 require_relative '../log'
 require_relative '../id'
 require_relative '../http'
@@ -44,12 +46,8 @@ module Zold
 Available options:"
         o.bool '--help', 'Print instructions'
       end
-      if opts.help?
-        @log.info(opts.to_s)
-        return
-      end
-      mine = opts.arguments[1..-1]
-      raise 'At least one wallet ID is required' if mine.empty?
+      mine = Args.new(opts, @log).take || return
+      mine = @wallets.all if mine.empty?
       mine.each do |id|
         push(@wallets.find(Id.new(id)), opts)
       end

data/lib/zold/commands/remote.rb

@@ -23,6 +23,7 @@ require 'rainbow'
 require 'net/http'
 require 'json'
 require 'time'
+require_relative 'args'
 require_relative '../log'
 require_relative '../http'
 require_relative '../remotes'
@@ -62,11 +63,7 @@ Available options:"
           default: false
         o.bool '--help', 'Print instructions'
       end
-      if opts.help?
-        @log.info(opts.to_s)
-        return
-      end
-      mine = opts.arguments[1..-1]
+      mine = Args.new(opts, @log).take || return
       command = mine[0]
       case command
       when 'show'

data/lib/zold/commands/show.rb

@@ -19,6 +19,8 @@
 # SOFTWARE.
 
 require 'slop'
+require 'rainbow'
+require_relative 'args'
 require_relative '../log'
 require_relative '../id'
 require_relative '../amount'
@@ -41,11 +43,7 @@ module Zold
 Available options:"
         o.bool '--help', 'Print instructions'
       end
-      if opts.help?
-        @log.info(opts.to_s)
-        return
-      end
-      mine = opts.arguments[1..-1]
+      mine = Args.new(opts, @log).take || return
       if mine.empty?
         require_relative 'list'
         List.new(wallets: @wallets, log: @log).run(args)

data/lib/zold/commands/taxes.rb

@@ -20,6 +20,8 @@
 
 require 'slop'
 require 'json'
+require 'rainbow'
+require_relative 'args'
 require_relative 'pay'
 require_relative '../log'
 require_relative '../score'
@@ -57,7 +59,7 @@ Available options:"
           default: '~/.ssh/id_rsa'
         o.bool '--help', 'Print instructions'
       end
-      mine = opts.arguments[1..-1]
+      mine = Args.new(opts, @log).take || return
       command = mine[0]
       case command
       when 'show'

data/lib/zold/hexnum.rb

@@ -0,0 +1,51 @@
+# Copyright (c) 2018 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# Hex num.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2018 Yegor Bugayenko
+# License:: MIT
+module Zold
+  # A hex num
+  class Hexnum
+    def initialize(num, length)
+      @num = num
+      @length = length
+    end
+
+    def to_i
+      @num
+    end
+
+    def to_s
+      format("%0#{@length}x", @num).gsub(/^\.{2}/, 'ff')
+    end
+
+    def self.parse(txt)
+      n = Integer("0x#{txt}", 16)
+      if txt.start_with?('f')
+        max = Integer("0x#{'f' * txt.length}", 16)
+        n = n - max - 1
+      end
+      Hexnum.new(n, txt.length)
+    end
+  end
+end