zold 0.7 → 0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb70a77181642453c08fcda55cd1179d84ad47d3
-  data.tar.gz: 4d5c99e488c3196efcb4b98b5f698fadddd72625
+  metadata.gz: 5ea54309f6fdd147d4338a76415d536e802ffa00
+  data.tar.gz: 2cc82cfbe9c204480db65348cc551abad0817d92
 SHA512:
-  metadata.gz: b692c87274e9fe516d80cccee43ccc172f03b151732d33271bf6a256e0fd2355af8d0bce3517dc19e7f7b9842c2f778734c0501c3093e6130b561f60da2c933b
-  data.tar.gz: b0c91ee622378ebcb8b96816c8281ac463153fc6d2daca6591322f3fbd8011cf3b2df954ce5178834efa9833a0711f29f25bd09831597cd153d65d5926971503
+  metadata.gz: 64bfd2b5f86befba60e4f976cef6e4e17d3233c5a8d7d48b214dc4e4bbe787afe351a4e783355baa63f844410d1ef923feac211d6186db45215512c79fc79c8e
+  data.tar.gz: f648ceffd6b1b5c2d34fd88816cc77dc8705bf3382ae2b6a22397894fd3d1d010168736c38ce2e934196c20b50deabb41d507d6992b1c9531fc8e01a4374136a

data/README.md

@@ -93,3 +93,22 @@ $ zold node --invoice=5f96e731e48ae21f
 
 Grateful users of the system will pay "taxes" to your wallet for processing
 of their transactions.
+
+## How to Contribute
+
+It is a Ruby command line gem. First, install
+[Ruby](https://www.ruby-lang.org/en/documentation/installation/) 2.3+,
+[Rubygems](https://rubygems.org/pages/download),
+and
+[Bundler](https://bundler.io/).
+Then:
+
+```bash
+$ bundle update
+$ rake
+```
+
+The build has to be clean. If it's not, [submit an issue](https://github.com/zerocracy/zold/issues).
+
+Then, make your changes, make sure the build is still clean,
+and [submit a pull request](https://www.yegor256.com/2014/04/15/github-guidelines.html).

data/lib/zold/commands/list.rb

@@ -19,6 +19,7 @@
 # SOFTWARE.
 
 require_relative '../log'
+require_relative '../wallet'
 
 # LIST command.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
@@ -35,7 +36,9 @@ module Zold
     def run(_ = [])
       @wallets.all.each do |id|
         wallet = Wallet.new(File.join(@wallets.path, id))
-        @log.info("#{id}: #{wallet.balance}")
+        msg = "#{id}: #{wallet.balance}"
+        msg += " (net:#{wallet.network})" if wallet.network != Wallet::MAIN_NETWORK
+        @log.info(msg)
       end
     end
   end

data/lib/zold/commands/propagate.rb

@@ -64,9 +64,13 @@ Available options:"
           @log.debug("#{t.amount * -1} to #{t.bnf}: wallet is absent")
           next
         end
+        unless target.network == wallet.network
+          @log.error("#{t.amount * -1} to #{t.bnf}: network mismatch, '#{target.network}'!='#{wallet.network}'")
+          next
+        end
         next if target.has?(t.id, me)
         unless Prefixes.new(target).valid?(t.prefix)
-          @log.info("#{t.amount * -1} to #{t.bnf}: wrong prefix")
+          @log.error("#{t.amount * -1} to #{t.bnf}: wrong prefix")
           next
         end
         target.add(t.inverse(me))

data/lib/zold/commands/show.rb

@@ -24,6 +24,7 @@ require_relative 'args'
 require_relative '../log'
 require_relative '../id'
 require_relative '../amount'
+require_relative '../wallet'
 
 # SHOW command.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
@@ -61,7 +62,9 @@ Available options:"
       wallet.txns.each do |t|
         @log.info(t.to_text)
       end
-      @log.info("The balance of #{wallet}: #{balance}")
+      msg = "The balance of #{wallet}: #{balance}"
+      msg += " (net:#{wallet.network})" if wallet.network != Wallet::MAIN_NETWORK
+      @log.info(msg)
       balance
     end
   end

data/lib/zold/node/emission.rb

@@ -0,0 +1,58 @@
+# 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 'concurrent'
+require 'tempfile'
+require_relative '../log'
+require_relative '../remotes'
+require_relative '../copies'
+require_relative '../tax'
+require_relative '../commands/merge'
+require_relative '../commands/fetch'
+require_relative '../commands/push'
+
+# The emission control point.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2018 Yegor Bugayenko
+# License:: MIT
+module Zold
+  # The emission control poine
+  class Emission
+    def initialize(root)
+      @root = root
+    end
+
+    def quota
+      2**(-2048 / @root.age)
+    end
+
+    def limit
+      max = 2**63
+      Amount.new(coins: (max * quota).to_i)
+    end
+
+    def check
+      return unless @root.root?
+      allowed = limit
+      balance = @root.balance
+      raise "The balance #{balance} of the root wallet is too low (max allowed: #{allowed})" if balance < allowed
+    end
+  end
+end

data/lib/zold/node/entrance.rb

@@ -19,6 +19,8 @@
 # SOFTWARE.
 
 require 'concurrent'
+require 'tempfile'
+require_relative 'emission'
 require_relative '../log'
 require_relative '../remotes'
 require_relative '../copies'
@@ -44,12 +46,28 @@ module Zold
     end
 
     def push(id, body)
+      check(body)
       @semaphores.put_if_absent(id, Mutex.new)
       @semaphores.get(id).synchronize do
         push_unsafe(id, body)
       end
     end
 
+    def check(body)
+      Tempfile.open do |f|
+        File.write(f.path, body)
+        wallet = Wallet.new(f)
+        break unless wallet.network == Wallet::MAIN_NETWORK
+        balance = wallet.balance
+        raise "The balance #{balance} is negative and it's not a root wallet" if balance.negative? && !wallet.root?
+        Emission.new(wallet).check
+        debt = Tax.new(wallet).debt
+        if debt > Tax::TRIAL
+          raise "Taxes are not paid, the debt is #{debt} (#{debt.to_i} zents), won't promote the wallet"
+        end
+      end
+    end
+
     def push_unsafe(id, body)
       copies = Copies.new(File.join(@copies, id.to_s))
       copies.add(body, 'remote', Remotes::PORT, 0)
@@ -59,10 +77,6 @@ module Zold
       modified = Merge.new(
         wallets: @wallets, copies: copies.root, log: @log
       ).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"
-      end
       copies.remove('remote', Remotes::PORT)
       modified.each do |m|
         Push.new(

data/lib/zold/tax.rb

@@ -69,8 +69,7 @@ module Zold
         score
       end.reject(&:nil?).uniq(&:hash)
       paid = scores.empty? ? Amount::ZERO : scores.map(&:amount).inject(&:+) * -1
-      age_hours = txns.empty? ? 0 : (Time.now - txns.sort_by(&:date)[0].date) / 60
-      owned = Tax::FEE_TXN_HOUR * txns.count * age_hours
+      owned = Tax::FEE_TXN_HOUR * txns.count * @wallet.age
       owned - paid
     end
   end

data/lib/zold/version.rb

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

data/lib/zold/wallet.rb

@@ -38,6 +38,10 @@ require_relative 'signature'
 module Zold
   # A single wallet
   class Wallet
+    # The name of the main production network. All other networks
+    # must have different names.
+    MAIN_NETWORK = 'zold'.freeze
+
     def initialize(file)
       @file = file
     end
@@ -127,6 +131,12 @@ module Zold
       end
     end
 
+    # Age of wallet in hours
+    def age
+      list = txns
+      list.empty? ? 0 : (Time.now - list.sort_by(&:date)[0].date) / 60
+    end
+
     def txns
       lines.drop(5)
         .each_with_index

data/test/node/test_emission.rb

@@ -0,0 +1,46 @@
+# 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 'minitest/autorun'
+require 'tmpdir'
+require_relative '../test__helper'
+require_relative '../../lib/zold/node/emission'
+require_relative '../../lib/zold/amount'
+
+class EmissionTest < Minitest::Test
+  def test_emission
+    (1..10).each do |year|
+      Dir.mktmpdir 'test' do |dir|
+        id = Zold::Id.new
+        wallet = Zold::Wallet.new(File.join(dir, id.to_s))
+        wallet.init(id, Zold::Key.new(file: 'fixtures/id_rsa.pub'))
+        wallet.add(
+          Zold::Txn.new(
+            1, Time.now - 24 * 365 * year,
+            Zold::Amount.new(zld: 39.99),
+            'NOPREFIX', Zold::Id::ROOT, '-'
+          )
+        )
+        $log.info("Year: #{year}, Quota: #{(Zold::Emission.new(wallet).quota * 100).round(2)}%, \
+Limit: #{Zold::Emission.new(wallet).limit}")
+      end
+    end
+  end
+end

data/test/node/test_entrance.rb

@@ -0,0 +1,29 @@
+# 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 'minitest/autorun'
+require_relative '../../lib/zold/node/entrance'
+require_relative '../../lib/zold/amount'
+
+class EntranceTest < Minitest::Test
+  def test_something
+    # tbd...
+  end
+end

data/test/test__helper.rb

@@ -31,6 +31,7 @@ end
 
 require_relative '../lib/zold/log'
 $log = Zold::Log::Quiet.new
+# $log = Zold::Log::Verbose.new
 
 require 'minitest/autorun'
 require_relative '../lib/zold'

data/test/test_zold.rb

@@ -21,6 +21,7 @@
 require 'minitest/autorun'
 require 'tmpdir'
 require 'English'
+require_relative 'test__helper'
 
 # Zold main module test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
@@ -37,10 +38,8 @@ class TestZold < Minitest::Test
         bin = File.join(Dir.pwd, 'bin/zold')
         Dir.chdir(dir) do
           stdout = `/bin/bash #{f} #{bin} 2>&1`
-          unless $CHILD_STATUS.exitstatus.zero?
-            $log.info(stdout)
-            assert_equal($CHILD_STATUS.exitstatus, 0)
-          end
+          $log.info(stdout)
+          assert_equal(0, $CHILD_STATUS.exitstatus)
         end
       end
     end

data/wp/wp.tex

@@ -5,6 +5,7 @@
 \usepackage{microtype}
 \usepackage{mathpazo} % Palantino font
 \usepackage{mdframed}
+\usepackage{pgfplots}
 \usepackage{minted}
   \setminted{fontsize=\small}
   \setminted{breaklines}
@@ -92,11 +93,12 @@ One ZLD by convention equals to $2^{24}$ \emph{zents} (16,777,216).
 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 \dd{0x00} ID belongs to the
-issuer and may have a negative balance. All other wallets
-may only have positive balances.
+\textbf{Root Wallet}.
+Zold is a pre-mined currency.
+The only way to get ZLD is to receive it from someone else.
+The root wallet belongs to the issuer and may have a negative balance,
+which can grow according to a pre-defined restrictive formula.
+All other wallets may only have positive balances.
 
 \colorbox{yellow}{Let's compare each of these principles with other currencies and highlight similarities.}
 
@@ -268,6 +270,51 @@ Each transaction takes 900 symbols at most.
 The maximum amount of transactions in one wallet is 65536.
 Thus, a single wallet may be as big as a 59Mb text file, at most.
 
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\section{Mining Formula}
+
+The only way to get ZLD is to receive it from the \emph{root} wallet \dd{0000000000000000}.
+This wallet is the only one that may have a negative ballance.
+However, to prevent an uncontrolled emission of ZLD, the balance
+of this wallet must satisfy the formula:
+
+$$x = \frac{2048}{h};\quad z = 2^{63 - x}.$$
+
+Here $h$ is the age of the root wallet in hours and $z$ is the maximum
+amount of zents it can issue at that moment. The first
+six years will look like this:
+
+\vspace{\parskip}\begin{center}\begin{tabular}{lrr}
+\hline
+Year & ZLD & Share \\
+\hline
+1st & 32m & 0.01\% \\
+2nd & 4b & 0.77\% \\
+3rd & 21b & 4\%\\
+4th & 48b & 9\% \\
+5th & 78b & 14\% \\
+6th & 108b & 20\% \\
+\hline
+\end{tabular}\end{center}
+
+On a large perspective of 25 years total emission of ZLD will look
+like this:
+
+\vspace{\parskip}\begin{center}\begin{tikzpicture}
+\begin{axis}[
+  axis lines=middle,
+  width=12cm,height=5cm,
+  xlabel={Age, in years},
+  ylabel={Billions of ZLD},
+]
+\addplot[domain=-0:25, samples=25]{2^(39-2048/(x*24*365)) / 1000000000};
+\end{axis}
+\end{tikzpicture}\end{center}
+
+The limitation is hardwired in Zold software and can't be eliminated.
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zold
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: '0.8'
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -298,6 +298,7 @@ files:
 - lib/zold/id.rb
 - lib/zold/key.rb
 - lib/zold/log.rb
+- lib/zold/node/emission.rb
 - lib/zold/node/entrance.rb
 - lib/zold/node/farm.rb
 - lib/zold/node/front.rb
@@ -327,6 +328,8 @@ files:
 - test/commands/test_show.rb
 - test/commands/test_taxes.rb
 - test/node/fake_node.rb
+- test/node/test_emission.rb
+- test/node/test_entrance.rb
 - test/node/test_farm.rb
 - test/node/test_front.rb
 - test/test__helper.rb
@@ -396,6 +399,8 @@ test_files:
 - test/commands/test_show.rb
 - test/commands/test_taxes.rb
 - test/node/fake_node.rb
+- test/node/test_emission.rb
+- test/node/test_entrance.rb
 - test/node/test_farm.rb
 - test/node/test_front.rb
 - test/test__helper.rb