zold 0.22.3 → 0.22.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5be8d7043de82577c3705e6e9fd22bef60745a8f08e08080f6449592f9dcbac4
-  data.tar.gz: 85390c7ab1d44af1a78c8bd51e08bf57b778e0f46eec912d03514eda2c6cc653
+  metadata.gz: ad91826d6e1a3e8d2b8b55ccdbf662ed3462098ad9ac97a638ca3a315ca16bf0
+  data.tar.gz: 139cd5314e6dd0dac0a10f20f0933e5e1d826820f4a3386eb3f7c643b49d8acc
 SHA512:
-  metadata.gz: 1ce589ed9cb20513c176bd3ddc3146c0a8803fb7362b18fbd8cbe97539cd93367fa07e3afba617e0f87ae340dcfd4d7aea4a6ec9ee0c02264c021c09c4985f5c
-  data.tar.gz: 8d9f92fb127a19192249748531fe19fccb782f7f7243950ae16348c43a3edbeb6f422c3c2556bc5fde7e783913b19c2046470a978c740d8b7ec88a5e6b37f5e8
+  metadata.gz: 3004779c370ec2ce966c89cbfa4e004c5b8644e164da6ab7a6dfb3be0eb64020853979eb6cf9ab2b8a980f0d6b0b8b610dfa44a47cdb351bd25c3d7b95341702
+  data.tar.gz: e9901486c5cb9f653723687091a25a4902e30818757a4cd56d71c7dced8a83c5dfbefd8de77b73b5053c3e91836e6edd33dbf1169edb914e10d2e6691f35a5b5

data/.rubocop.yml

@@ -18,7 +18,7 @@ Metrics/AbcSize:
 Metrics/BlockNesting:
   Max: 4
 Metrics/BlockLength:
-  Max: 120
+  Max: 130
 Metrics/ClassLength:
   Max: 450
 Layout/EndOfLine:

data/Dockerfile

@@ -0,0 +1,14 @@
+FROM ruby:2.6
+
+RUN gem install zold
+EXPOSE 4096
+
+RUN echo "#!/bin/bash" > node.sh
+RUN echo "zold node --nohup \044\100" >> node.sh
+RUN echo "tail -f zold.log" >> node.sh
+RUN chmod +x /node.sh
+
+RUN mkdir /zold
+WORKDIR /zold
+
+CMD ["/node.sh"]

data/README.md

@@ -127,6 +127,19 @@ If you are lost, run this:
 $ zold node --help
 ```
 
+You can run a node in a docker container also.
+
+```bash
+docker run -d -p 4096:4096 zold/zold:latest /node.sh --host=<your host IP> --invoice=5f96e731e48ae21f
+```
+
+To store zold data between container restarts create a volume or bind a directory from host
+
+```bash
+docker volume create zold 
+docker run -d -p 4096:4096 -v zold:/zold zold/zold:latest /node.sh --host=<your host IP> --invoice=5f96e731e48ae21f
+```
+
 ## Frequently Asked Questions
 
 > Where are my RSA private/public keys?

data/bin/zold

@@ -276,14 +276,13 @@ else
   code = cmd.call
 end
 
+Zold::Hands.stop
+
 log.debug("Memory footprint at the end is #{Zold::Size.new(GetProcessMem.new.bytes.to_i)}")
 if code.zero?
-  log.debug("Failed in in #{Zold::Age.new(start)}")
-  exit(code)
-else
   log.debug("Successfully finished in #{Zold::Age.new(start)}")
+else
+  log.debug("Failed in #{Zold::Age.new(start)}")
+  exit(code)
 end
 
-Zold::Hands.stop
-
-abort # We need this in case some threads are still alive

data/fixtures/scripts/redeploy-on-upgrade.sh

@@ -6,7 +6,7 @@ function start_node {
   zold remote clean
   zold node $3 --nohup --nohup-command='touch restarted' --nohup-log=log --nohup-max-cycles=0 --nohup-log-truncate=10240 \
     --expose-version=$2 --save-pid=pid --routine-immediately --tolerate-edges --tolerate-quorum=1 \
-    --verbose --trace --invoice=REDEPLOY@ffffffffffffffff \
+    --verbose --trace --invoice=REDEPLOY@ffffffffffffffff --ignore-empty-remotes \
     --host=127.0.0.1 --port=$1 --bind-port=$1 --threads=1 --strength=20 > /dev/null 2>&1
   wait_for_port $1
   cat pid

data/lib/zold/commands/fetch.rb

@@ -170,8 +170,8 @@ run 'zold remote update' or use --tolerate-quorum=1"
             end
             copy = cps.add(IO.read(f), score.host, score.port, score.value, master: r.master?)
             @log.info("#{r} returned #{wallet.mnemo} #{Age.new(json['mtime'])}/#{json['copies']}c \
-  as copy ##{copy}/#{cps.all.count} in #{Age.new(start, limit: 4)}: \
-  #{Rainbow(score.value).green} (#{json['version']})")
+as copy ##{copy}/#{cps.all.count} in #{Age.new(start, limit: 4)}: \
+#{Rainbow(score.value).green} (#{json['version']})")
           end
         end
         score.value
@@ -183,6 +183,7 @@ run 'zold remote update' or use --tolerate-quorum=1"
       begin
         uri = "/wallet/#{id}"
         head = r.http(uri).get
+        raise "The wallet #{id} doesn't exist at #{r}" if head.status == 404
         r.assert_code(200, head)
         json = JsonPage.new(head.body, uri).to_hash
         score = Score.parse_json(json['score'])

data/lib/zold/commands/node.rb

@@ -145,6 +145,9 @@ module Zold
         o.bool '--allow-spam',
           'Don\'t filter the incoming spam via PUT requests (duplicate wallets)',
           default: false
+        o.bool '--ignore-empty-remotes',
+          'Don\'t fail if the list of remotes is empty (for testing mostly)',
+          default: false
         o.bool '--skip-oom',
           'Skip Out Of Memory check and never exit, no matter how much RAM is consumed',
           default: false
@@ -197,6 +200,10 @@ module Zold
       end
       raise '--invoice is mandatory' unless opts['invoice']
       if opts['nohup']
+        if @remotes.all.empty? && !opts['standalone'] && !opts['ignore-empty-remotes']
+          raise 'There are no remote nodes in the list and you are not running in --standalone mode;
+the node won\'t connect to the network like that; try to do "zold remote reset" first'
+        end
         pid = nohup(opts)
         IO.write(opts['save-pid'], pid) if opts['save-pid']
         @log.debug("Process ID #{pid} saved into \"#{opts['save-pid']}\"")

data/lib/zold/commands/remote.rb

@@ -323,7 +323,7 @@ Available options:"
       rescue JsonPage::CantParse, Score::CantParse, RemoteNode::CantAssert => e
         attempt += 1
         if attempt < opts['retry']
-          @log.error("#{r} failed to read #{id}, trying again (attempt no.#{attempt}): #{e.message}")
+          @log.error("#{r} failed to read, trying again (attempt no.#{attempt}): #{e.message}")
           retry
         end
         raise e

data/lib/zold/head.rb

@@ -44,7 +44,7 @@ module Zold
       raise "Wallet file '#{@file}' is absent" unless File.exist?(@file)
       lines = []
       File.open(@file) do |f|
-        lines << f.readline while lines.count < 4 && !f.eof?
+        lines << f.readline.strip while lines.count < 4 && !f.eof?
       end
       raise CantParse, "Not enough lines in #{@file}, just #{lines.count}" if lines.count < 4
       lines

data/lib/zold/key.rb

@@ -54,6 +54,10 @@ module Zold
     # Public key of the root wallet
     ROOT = Key.new(file: File.expand_path(File.join(File.dirname(__FILE__), '../../resources/root.pub')))
 
+    def root?
+      to_s == ROOT.to_s
+    end
+
     def ==(other)
       to_s == other.to_s
     end

data/lib/zold/node/front.rb

@@ -246,6 +246,7 @@ this is not a normal behavior, you may want to report a bug to our GitHub reposi
           id: wallet.id.to_s,
           score: score.to_h,
           mtime: wallet.mtime.utc.iso8601,
+          age: wallet.age.to_s,
           size: wallet.size,
           digest: wallet.digest,
           copies: Copies.new(File.join(settings.copies, wallet.id)).all.count,
@@ -454,7 +455,7 @@ time to stop; use --skip-oom to never quit")
       settings.zache.get(:total_mem, lifetime: settings.opts['no-cache'] ? 0 : 60) do
         Total::Mem.new.bytes
       rescue Total::CantDetect => e
-        @log.error(e.message)
+        settings.log.error(e.message)
         0
       end
     end

data/lib/zold/signature.rb

@@ -56,7 +56,7 @@ module Zold
       raise 'pub must be of type Key' unless pub.is_a?(Key)
       raise 'id must be of type Id' unless id.is_a?(Id)
       raise 'txn must be of type Txn' unless txn.is_a?(Txn)
-      pub.verify(txn.sign, body(id, txn)) && (@network != Wallet::MAINET || id != Id::ROOT || pub == Key::ROOT)
+      pub.verify(txn.sign, body(id, txn)) && (@network != Wallet::MAINET || !id.root? || pub.root?)
     end
 
     private

data/lib/zold/version.rb

@@ -25,7 +25,7 @@
 # Copyright:: Copyright (c) 2018 Yegor Bugayenko
 # License:: MIT
 module Zold
-  VERSION = '0.22.3'
+  VERSION = '0.22.4'
   PROTOCOL = 2
   REPO = 'zold-io/zold'
 end

data/lib/zold/wallet.rb

@@ -54,6 +54,9 @@ module Zold
     # The extension of the wallet files
     EXT = '.z'
 
+    # The constructor of the wallet, from the file. The file may be
+    # absent at the time of creating the object. Later, don't forget to
+    # call init() in order to initialize the wallet, if it's absent.
     def initialize(file)
       unless file.end_with?(Wallet::EXT, Copies::EXT)
         raise "Wallet file must end with #{Wallet::EXT} or #{Copies::EXT}: #{file}"
@@ -71,55 +74,67 @@ module Zold
       id.to_s
     end
 
+    # Returns a convenient printable mnemo code of the wallet (mostly
+    # useful for logs).
     def mnemo
       "#{id}/#{balance.to_zld(4)}/#{txns.count}t/#{digest[0, 6]}/#{Size.new(size)}"
     end
 
+    # Convert the content of the wallet to the text.
     def to_text
       (@head.fetch + [''] + @txns.fetch.map(&:to_text)).join("\n")
     end
 
+    # Returns the network ID of the wallet.
     def network
-      n = @head.fetch[0].strip
+      n = @head.fetch[0]
       raise "Invalid network name '#{n}'" unless n =~ /^[a-z]{4,16}$/
       n
     end
 
+    # Returns the protocol ID of the wallet file.
     def protocol
-      v = @head.fetch[1].strip
+      v = @head.fetch[1]
       raise "Invalid protocol version name '#{v}'" unless v =~ /^[0-9]+$/
       v.to_i
     end
 
+    # Returns TRUE if the wallet file exists.
     def exists?
-      File.exist?(@file)
+      File.exist?(path)
     end
 
+    # Returns the absolute path of the wallet file (it may be absent).
     def path
       @file
     end
 
+    # Creates an empty wallet with the specified ID and public key.
     def init(id, pubkey, overwrite: false, network: 'test')
-      raise "File '#{@file}' already exists" if File.exist?(@file) && !overwrite
+      raise "File '#{path}' already exists" if File.exist?(path) && !overwrite
       raise "Invalid network name '#{network}'" unless network =~ /^[a-z]{4,16}$/
-      FileUtils.mkdir_p(File.dirname(@file))
-      IO.write(@file, "#{network}\n#{PROTOCOL}\n#{id}\n#{pubkey.to_pub}\n\n")
+      FileUtils.mkdir_p(File.dirname(path))
+      IO.write(path, "#{network}\n#{PROTOCOL}\n#{id}\n#{pubkey.to_pub}\n\n")
       @txns.flush
       @head.flush
     end
 
+    # Returns TRUE if it's a root wallet.
     def root?
       id == Id::ROOT
     end
 
+    # Returns the wallet ID.
     def id
-      Id.new(@head.fetch[2].strip)
+      Id.new(@head.fetch[2])
     end
 
+    # Returns current wallet balance.
     def balance
       txns.inject(Amount::ZERO) { |sum, t| sum + t.amount }
     end
 
+    # Add a payment transaction to the wallet.
     def sub(amount, invoice, pvt, details = '-', time: Time.now)
       raise 'The amount has to be of type Amount' unless amount.is_a?(Amount)
       raise "The amount can't be negative: #{amount}" if amount.negative?
@@ -141,6 +156,7 @@ module Zold
       txn
     end
 
+    # Add a transaction to the wallet.
     def add(txn)
       raise 'The txn has to be of type Txn' unless txn.is_a?(Txn)
       raise "Wallet #{id} can't pay itself: #{txn}" if txn.bnf == id
@@ -152,66 +168,75 @@ module Zold
         raise "Positive transaction with the same ID #{txn.id} and BNF #{txn.bnf} already exists in #{id}"
       end
       raise "The tax payment already exists in #{id}: #{txn}" if Tax.new(self).exists?(txn.details)
-      File.open(@file, 'a') { |f| f.print "#{txn}\n" }
+      File.open(path, 'a') { |f| f.print "#{txn}\n" }
       @txns.flush
     end
 
+    # Returns TRUE if the wallet contains a payment sent with the specified
+    # ID, which was sent to the specified beneficiary.
     def includes_negative?(id, bnf = nil)
       raise 'The txn ID has to be of type Integer' unless id.is_a?(Integer)
       !txns.find { |t| t.id == id && (bnf.nil? || t.bnf == bnf) && t.amount.negative? }.nil?
     end
 
+    # Returns TRUE if the wallet contains a payment received with the specified
+    # ID, which was sent by the specified beneficiary.
     def includes_positive?(id, bnf)
       raise 'The txn ID has to be of type Integer' unless id.is_a?(Integer)
       raise 'The bnf has to be of type Id' unless bnf.is_a?(Id)
       !txns.find { |t| t.id == id && t.bnf == bnf && !t.amount.negative? }.nil?
     end
 
+    # Returns TRUE if the public key of the wallet includes this payment
+    # prefix of the invoice.
     def prefix?(prefix)
       key.to_pub.include?(prefix)
     end
 
+    # Returns the public key of the wallet.
     def key
-      Key.new(text: @head.fetch[3].strip)
-    end
-
-    def income
-      txns.each do |t|
-        yield t unless t.amount.negative?
-      end
+      Key.new(text: @head.fetch[3])
     end
 
+    # Returns the time of when the wallet file was recently modified.
     def mtime
-      File.mtime(@file)
+      File.mtime(path)
     end
 
+    # Returns a pseudo-unique hexadecimal digest of the wallet content.
     def digest
-      OpenSSL::Digest::SHA256.file(@file).hexdigest
+      OpenSSL::Digest::SHA256.file(path).hexdigest
     end
 
-    # Age of wallet in hours
+    # Age of wallet in hours.
     def age
       list = txns
       list.empty? ? 0 : (Time.now - list.min_by(&:date).date) / (60 * 60)
     end
 
-    # Size of the wallet file in bytes
+    # Size of the wallet file in bytes. If the file doesn't exist
+    # an exception will be raised.
     def size
+      raise "The wallet file #{path} doesn't exist" unless File.exist?(path)
       File.size(path)
     end
 
+    # Retrieve the total list of all transactions.
     def txns
       @txns.fetch
     end
 
+    # Resaves the content of the wallet to the disc in the right format. All
+    # unnecessary space and EOL-s are removed. This operation is required
+    # in order to make sure two wallets with the same content are identical,
+    # no matter whether they were formatted differently.
     def refurbish
-      IO.write(
-        @file,
-        "#{network}\n#{protocol}\n#{id}\n#{key.to_pub}\n\n#{txns.map { |t| t.to_s + "\n" }.join}"
-      )
+      IO.write(path, (@head.fetch + [''] + @txns.fetch.map(&:to_s)).join("\n") + "\n")
       @txns.flush
     end
 
+    # Flush the in-memory cache and force the object to load all data from
+    # the disc again.
     def flush
       @head.flush
       @txns.flush
@@ -219,6 +244,9 @@ module Zold
 
     private
 
+    # Calculate the maximum transaction ID visible currently in the wallet.
+    # We go through them all and find the largest number. If there are
+    # no transactions, zero is returned.
     def max
       negative = txns.select { |t| t.amount.negative? }
       negative.empty? ? 0 : negative.max_by(&:id).id

data/test/fake_home.rb

@@ -45,7 +45,9 @@ class FakeHome
   def run
     Dir.mktmpdir do |dir|
       FileUtils.copy(File.expand_path(File.join(__dir__, '../fixtures/id_rsa')), File.join(dir, 'id_rsa'))
-      yield FakeHome.new(dir, log: @log)
+      result = yield FakeHome.new(dir, log: @log)
+      sleep 0.1 # It's a workaround against a bug (without it tests fail sporadically)
+      result
     end
   end
 

data/test/test__helper.rb

@@ -52,7 +52,7 @@ module Zold
     # to wait can be increased, but try to make it as little as possible,
     # in order to catch problems ealier.
     def around
-      Timeout.timeout(120) do
+      Timeout.timeout(180) do
         Thread.current.name = 'test'
         super
       end

data/test/test_hungry_wallets.rb

@@ -47,7 +47,7 @@ class TestHungryWallets < Zold::Test
       )
       wallets.acq(id) { |w| assert(!w.exists?) }
       pool.join(2)
-      assert_requested(get, times: 2)
+      assert_requested(get, times: 1)
     end
   end
 end

data/test/test_wallet.rb

@@ -257,8 +257,8 @@ class TestWallet < Zold::Test
         )
       )
       sum = Zold::Amount::ZERO
-      wallet.income do |t|
-        sum += t.amount
+      wallet.txns.each do |t|
+        sum += t.amount unless t.amount.negative?
       end
       assert(
         sum == Zold::Amount.new(zents: 235_965_503_242),

data/test/test_zold.rb

@@ -57,7 +57,7 @@ class TestZold < Zold::Test
             assert_equal(0, code, "#{f}\n#{out.join}")
           end
         end
-        sleep 0.2
+        sleep 1 # It's a workaround, I can't fix the bug (tests crash sporadically)
       end
       test_log.info("\n\n#{f} done in #{Zold::Age.new(start)}")
     end

data/zold.gemspec

@@ -77,7 +77,7 @@ and suggests a different architecture for digital wallet maintenance.'
   s.add_runtime_dependency 'sys-proctable', '1.2.1'
   s.add_runtime_dependency 'thin', '1.7.2'
   s.add_runtime_dependency 'threads', '>=0.3'
-  s.add_runtime_dependency 'total', '>=0.2'
+  s.add_runtime_dependency 'total', '>=0.3'
   s.add_runtime_dependency 'typhoeus', '1.3.1'
   s.add_runtime_dependency 'usagewatch_ext', '0.2.1'
   s.add_runtime_dependency 'zache', '>=0.7'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zold
 version: !ruby/object:Gem::Version
-  version: 0.22.3
+  version: 0.22.4
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-19 00:00:00.000000000 Z
+date: 2019-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -240,14 +240,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -545,6 +545,7 @@ files:
 - ".rultor.yml"
 - ".simplecov"
 - ".travis.yml"
+- Dockerfile
 - Gemfile
 - Guardfile
 - INSTALL.md
@@ -746,7 +747,7 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: |-
-  Thanks for installing Zold 0.22.3!
+  Thanks for installing Zold 0.22.4!
     Study our White Paper: https://papers.zold.io/wp.pdf
     Read our blog posts: https://blog.zold.io
     Try ZLD online wallet at: https://wts.zold.io