zold 0.5 → 0.6

data/lib/zold/score.rb

@@ -30,30 +30,93 @@ module Zold
   # Score
   class Score
     STRENGTH = 6
-    attr_reader :time, :host, :port, :strength
+    attr_reader :time, :host, :port, :invoice, :strength
     # time: UTC ISO 8601 string
-    def initialize(time, host, port, suffixes = [], strength: STRENGTH)
+    def initialize(time, host, port, invoice, suffixes = [], strength: STRENGTH)
+      raise "Invalid host name: #{host}" unless host =~ /^[a-z0-9\.-]+$/
       raise 'Time must be of type Time' unless time.is_a?(Time)
       raise 'Port must be of type Integer' unless port.is_a?(Integer)
+      raise "Invalid TCP port: #{port}" if port <= 0 || port > 65_535
+      raise "Invoice '#{invoice}' has wrong format" unless invoice =~ /^[a-zA-Z0-9]{8,32}@[a-f0-9]{16}$/
       @time = time
       @host = host
       @port = port
+      @invoice = invoice
       @suffixes = suffixes
       @strength = strength
     end
 
-    ZERO = Score.new(Time.now, 'localhost', Remotes::PORT)
+    ZERO = Score.new(
+      Time.now, 'localhost',
+      Remotes::PORT, 'NOPREFIX@ffffffffffffffff'
+    )
+
+    def self.parse_json(json)
+      raise "Time in JSON is broken: #{json}" unless json['time'] =~ /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$/
+      raise "Host is wrong: #{json}" unless json['host'] =~ /^[0-9a-z\.\-]+$/
+      raise "Port is wrong: #{json}" unless json['port'].is_a?(Integer)
+      raise "Invoice is wrong: #{json}" unless json['invoice'] =~ /^[a-zA-Z0-9]{8,32}@[a-f0-9]{16}$/
+      raise "Suffixes not array: #{json}" unless json['suffixes'].is_a?(Array)
+      Score.new(
+        Time.parse(json['time']), json['host'],
+        json['port'], json['invoice'], json['suffixes'],
+        strength: json['strength']
+      )
+    end
 
     def self.parse(text, strength: STRENGTH)
-      _, time, host, port, suffixes = text.split(' ', 5)
+      m = Regexp.new(
+        '^' + [
+          '([0-9]+:)',
+          '(?<time>[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z)',
+          '(?<host>[0-9a-z\.\-]+)',
+          '(?<port>[0-9]+)',
+          '(?<invoice>[a-zA-Z0-9]{8,32}@[a-f0-9]{16})',
+          '(?<suffixes>[a-zA-Z0-9 ]+)'
+        ].join(' ') + '$'
+      ).match(text)
+      raise "Invalid score '#{text}'" if m.nil?
+      Score.new(
+        Time.parse(m[:time]), m[:host],
+        m[:port].to_i, m[:invoice],
+        m[:suffixes].split(' '),
+        strength: strength
+      )
+    end
+
+    def self.parse_text(text, strength: STRENGTH)
+      parts = text.split(' ', 6)
       Score.new(
-        Time.parse(time), host, port.to_i,
-        suffixes.split(' '), strength: strength
+        Time.at(parts[0].hex),
+        parts[1],
+        parts[2].hex,
+        "#{parts[3]}@#{parts[4]}",
+        parts[5].split(' '),
+        strength: strength
       )
     end
 
+    def to_text
+      prefix, bnf = @invoice.split('@')
+      [
+        @time.to_i.to_s(16),
+        @host,
+        @port.to_s(16),
+        prefix,
+        bnf,
+        @suffixes.join(' ')
+      ].join(' ')
+    end
+
     def to_s
-      "#{value}: #{@time.utc.iso8601} #{@host} #{@port} #{@suffixes.join(' ')}"
+      [
+        "#{value}:",
+        @time.utc.iso8601,
+        @host,
+        @port,
+        @invoice,
+        @suffixes.join(' ')
+      ].join(' ')
     end
 
     def to_h
@@ -61,6 +124,7 @@ module Zold
         value: value,
         host: @host,
         port: @port,
+        invoice: @invoice,
         time: @time.utc.iso8601,
         suffixes: @suffixes,
         strength: @strength
@@ -68,7 +132,10 @@ module Zold
     end
 
     def reduced(max = 4)
-      Score.new(@time, @host, @port, @suffixes[0..max - 1], strength: @strength)
+      Score.new(
+        @time, @host, @port, @invoice,
+        @suffixes[0..max - 1], strength: @strength
+      )
     end
 
     def next
@@ -77,7 +144,7 @@ module Zold
       loop do
         suffix = idx.to_s(16)
         score = Score.new(
-          @time, @host, @port, @suffixes + [suffix],
+          @time, @host, @port, @invoice, @suffixes + [suffix],
           strength: @strength
         )
         return score if score.valid?
@@ -85,8 +152,16 @@ module Zold
       end
     end
 
+    def age_hours
+      (Time.now - @time) / 60
+    end
+
+    def expired?
+      @time < Time.now - 24 * 60
+    end
+
     def valid?
-      start = "#{@time.utc.iso8601} #{@host} #{@port}"
+      start = "#{@time.utc.iso8601} #{@host} #{@port} #{@invoice}"
       @suffixes.reduce(start) do |prefix, suffix|
         hex = Digest::SHA256.hexdigest(prefix + ' ' + suffix)
         return false unless hex.end_with?('0' * @strength)

data/lib/zold/signature.rb

@@ -18,7 +18,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require 'time'
+require 'digest'
 require_relative 'key'
 require_relative 'id'
 require_relative 'amount'
@@ -31,18 +31,18 @@ require_relative 'amount'
 module Zold
   # A signature
   class Signature
-    def sign(pvt, t)
-      pvt.sign(block(t))
+    def sign(pvt, id, t)
+      pvt.sign(body(id, t))
     end
 
-    def valid?(pub, t)
-      pub.verify(t.sign, block(t))
+    def valid?(pub, id, t)
+      pub.verify(t.sign, body(id, t))
     end
 
     private
 
-    def block(t)
-      [t.id, t.amount.to_i, t.prefix, t.bnf, t.details].join(';')
+    def body(id, t)
+      [id, t.id, t.amount.to_i, t.prefix, t.bnf, t.details].join(' ')
     end
   end
 end

data/lib/zold/tax.rb

@@ -0,0 +1,79 @@
+# 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 'digest'
+require_relative 'key'
+require_relative 'id'
+require_relative 'amount'
+
+# Tax transaction.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2018 Yegor Bugayenko
+# License:: MIT
+module Zold
+  # A single tax payment
+  class Tax
+    # The minimum score a wallet can buy in order to pay taxes.
+    MIN_SCORE = 16
+
+    # This is how much we charge per one transaction per hour
+    # of storage. A wallet of 4096 transactions will pay
+    # approximately 16ZLD per year.
+    FEE_TXN_HOUR = Amount.new(zld: 16.0 / (365 * 24) / 4096)
+
+    # The maximum debt we can tolerate at the wallet. If the debt
+    # is bigger than this threshold, nodes must stop accepting PUSH.
+    TRIAL = Amount.new(zld: 1.0)
+
+    # For how many days to pay at once.
+    DAYS_INCREMENT = 32
+
+    def initialize(wallet)
+      @wallet = wallet
+    end
+
+    def pay(pvt, best)
+      fee = Tax::FEE * @wallet.txns.count * Tax::DAYS_INCREMENT * 24
+      @wallet.sub(fee, best.invoice, pvt, "TAXES #{best.to_text}")
+    end
+
+    def debt
+      txns = @wallet.txns
+      return Amount::ZERO if txns.empty?
+      paid = txns.map do |t|
+        pfx, body = t.details.split(' ')
+        if pfx != 'TAXES' || body.nil?
+          Amount::ZERO
+        else
+          score = Score.parse_text(body)
+          if score.valid? && score.value >= MIN_SCORE
+            t.amount
+          else
+            Amount::ZERO
+          end
+        end
+      end.inject(&:+) * -1
+      age_hours = (Time.now - txns.sort_by(&:date)[0].date) / 60
+      owned = Tax::FEE_TXN_HOUR * txns.count * age_hours
+      owned - paid
+    end
+  end
+end

data/lib/zold/txn.rb

@@ -49,6 +49,7 @@ module Zold
       @prefix = prefix
       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}$/
       @details = details
     end
 
@@ -68,30 +69,34 @@ module Zold
       ].join(';')
     end
 
+    def to_text
+      "##{@id} #{@date.utc.iso8601} #{@amount} #{@bnf} #{@details}"
+    end
+
     def inverse(bnf)
       t = clone
-      t.amount = amount.mul(-1)
+      t.amount = amount * -1
       t.bnf = bnf
       t
     end
 
-    def signed(pvt)
+    def signed(pvt, id)
       t = clone
-      t.sign = Signature.new.sign(pvt, self)
+      t.sign = Signature.new.sign(pvt, id, self)
       t
     end
 
-    def self.parse(line, idx)
+    def self.parse(line, idx = 0)
       regex = Regexp.new(
-        [
+        '^' + [
           '([0-9]+)',
           '([0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z)',
           '(-?[0-9]+)',
           '([A-Za-z0-9]{8,32})',
           '([a-f0-9]{16})',
-          '([a-zA-Z0-9 -.]{1,128})',
+          '([a-zA-Z0-9 -\.,]{1,128})',
           '([A-Za-z0-9+/]+={0,3})?'
-        ].join(';')
+        ].join(';') + '$'
       )
       clean = line.strip
       raise "Invalid line ##{idx}: #{line.inspect}" unless regex.match(clean)

data/lib/zold/version.rb

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

data/lib/zold/wallet.rb

@@ -82,12 +82,12 @@ module Zold
       txn = Txn.new(
         max + 1,
         Time.now,
-        amount.mul(-1),
+        amount * -1,
         prefix,
         Id.new(target),
         details
       )
-      txn = txn.signed(pvt)
+      txn = txn.signed(pvt, self)
       add(txn)
       txn
     end

data/test/commands/test_create.rb

@@ -31,10 +31,9 @@ require_relative '../../lib/zold/commands/create'
 class TestCreate < Minitest::Test
   def test_creates_wallet
     Dir.mktmpdir 'test' do |dir|
-      wallet = Zold::Create.new(
-        wallets: Zold::Wallets.new(dir),
-        pubkey: Zold::Key.new(file: 'fixtures/id_rsa.pub')
-      ).run
+      wallet = Zold::Create.new(wallets: Zold::Wallets.new(dir)).run(
+        ['--public-key=fixtures/id_rsa.pub']
+      )
       assert wallet.balance.zero?
       assert(
         File.exist?(File.join(dir, wallet.id.to_s)),

data/test/commands/test_diff.rb

@@ -46,9 +46,8 @@ class TestDiff < Minitest::Test
       second = Zold::Wallet.new(File.join(dir, 'copy-2'))
       File.write(second.path, File.read(wallet.path))
       Zold::Pay.new(
-        wallets: Zold::Wallets.new(dir),
-        pvtkey: Zold::Key.new(file: 'fixtures/id_rsa')
-      ).run([id.to_s, second.id.to_s, '14.95', '--force'])
+        wallets: Zold::Wallets.new(dir)
+      ).run([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)

data/test/commands/test_merge.rb

@@ -48,9 +48,8 @@ class TestMerge < Minitest::Test
       second = Zold::Wallet.new(File.join(dir, 'copy-2'))
       File.write(second.path, File.read(wallet.path))
       Zold::Pay.new(
-        wallets: Zold::Wallets.new(dir),
-        pvtkey: Zold::Key.new(file: 'fixtures/id_rsa')
-      ).run([id.to_s, second.id.to_s, '14.95', '--force'])
+        wallets: Zold::Wallets.new(dir)
+      ).run([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)
@@ -74,9 +73,8 @@ class TestMerge < Minitest::Test
       second = Zold::Wallet.new(File.join(dir, 'copy-2'))
       File.write(second.path, File.read(wallet.path))
       Zold::Pay.new(
-        wallets: Zold::Wallets.new(dir),
-        pvtkey: Zold::Key.new(file: 'fixtures/id_rsa')
-      ).run([id.to_s, second.id.to_s, '14.95', '--force'])
+        wallets: Zold::Wallets.new(dir)
+      ).run([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)

data/test/commands/test_pay.rb

@@ -39,11 +39,13 @@ class TestPay < Minitest::Test
       source.init(id, Zold::Key.new(file: 'fixtures/id_rsa.pub'))
       target = Zold::Id.new
       amount = Zold::Amount.new(zld: 14.95)
-      Zold::Pay.new(
-        wallets: wallets,
-        pvtkey: Zold::Key.new(file: 'fixtures/id_rsa')
-      ).run(['--force', id.to_s, target.to_s, amount.to_zld, 'For the car'])
-      assert_equal(amount.mul(-1), source.balance)
+      Zold::Pay.new(wallets: wallets).run(
+        [
+          '--force', '--private-key=fixtures/id_rsa',
+          id.to_s, target.to_s, amount.to_zld, 'For the car'
+        ]
+      )
+      assert_equal(amount * -1, source.balance)
     end
   end
 end

data/test/commands/test_remote.rb

@@ -24,6 +24,7 @@ require 'webmock/minitest'
 require_relative '../../lib/zold/wallets'
 require_relative '../../lib/zold/remotes'
 require_relative '../../lib/zold/key'
+require_relative '../../lib/zold/log'
 require_relative '../../lib/zold/score'
 require_relative '../../lib/zold/commands/remote'
 
@@ -35,10 +36,11 @@ class TestRemote < Minitest::Test
   def test_updates_remote
     Dir.mktmpdir 'test' do |dir|
       remotes = Zold::Remotes.new(File.join(dir, 'a/b/c/remotes'))
-      stub_request(:get, 'http://localhost:1/remotes').to_return(
+      zero = Zold::Score::ZERO
+      stub_request(:get, "http://#{zero.host}:#{zero.port}/remotes").to_return(
         status: 200,
         body: {
-          score: Zold::Score::ZERO.to_h,
+          score: zero.to_h,
           all: [
             { host: 'localhost', port: 888 },
             { host: 'localhost', port: 999 }
@@ -56,7 +58,7 @@ class TestRemote < Minitest::Test
       )
       cmd = Zold::Remote.new(remotes: remotes)
       cmd.run(['clean'])
-      cmd.run(%w[add localhost 1])
+      cmd.run(['add', zero.host, zero.port.to_s])
       cmd.run(%w[add localhost 2])
       assert_equal(2, remotes.all.count)
       cmd.run(['update', '--ignore-score-weakness'])

data/test/commands/test_taxes.rb

@@ -0,0 +1,66 @@
+# 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 'webmock/minitest'
+require_relative '../../lib/zold/wallets'
+require_relative '../../lib/zold/amount'
+require_relative '../../lib/zold/key'
+require_relative '../../lib/zold/log'
+require_relative '../../lib/zold/id'
+require_relative '../../lib/zold/commands/taxes'
+
+# TAXES test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2018 Yegor Bugayenko
+# License:: MIT
+class TestTaxes < Minitest::Test
+  def test_pays_taxes
+    Dir.mktmpdir 'test' do |dir|
+      id = Zold::Id.new
+      wallets = Zold::Wallets.new(dir)
+      wallet = wallets.find(id)
+      wallet.init(id, Zold::Key.new(file: 'fixtures/id_rsa.pub'))
+      wallet.add(
+        Zold::Txn.new(
+          1,
+          Time.now - 24 * 60 * 365 * 20,
+          Zold::Amount.new(zld: 19.99),
+          'NOPREFIX', Zold::Id.new, '-'
+        )
+      )
+      remotes = Zold::Remotes.new(File.join(dir, 'a/remotes'))
+      remotes.clean
+      zero = Zold::Score::ZERO
+      remotes.add(zero.host, zero.port)
+      stub_request(:get, "http://#{zero.host}:#{zero.port}/").to_return(
+        status: 200,
+        body: {
+          score: zero.to_h
+        }.to_json
+      )
+      Zold::Taxes.new(
+        wallets: wallets, remotes: remotes
+      ).run(['pay', '--private-key=fixtures/id_rsa', id.to_s])
+      assert_equal(Zold::Amount.new(coins: 335_376_547), wallet.balance)
+    end
+  end
+end