zold 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a7e5d899910c588ba9fff4987a7341ecb245dad
-  data.tar.gz: d1c940ba9d95d8d57e588fb1a6675f9117e86a4b
+  metadata.gz: 5306e5717fd5e9e5e42148d1e46446895b24b48d
+  data.tar.gz: a47d42f9786ed85e65a35026ccca2f0f292bd9e3
 SHA512:
-  metadata.gz: ca614449c84d77fe0b5bce135e33168955bf4f71ee62172a6d01e88cb72890ee04e0128ec86f8f98590d943c5eb325f0db1daa26f2d795002f04b31aae7e7600
-  data.tar.gz: 12cbff8839076e9314eee7805f3c75d09f3f22ed64516a1ad964d2018ef637cc0ebd249495eca8b86c48530d031704d3d8f299c03b201e91496371e9c2e7ef7d
+  metadata.gz: 2c93b3dd2db0fb07b521c0920112f743dff5574219ac6c19f9ebc5ec73126b3f671bb9ca71a53a9128c43455e558c6e4293e3c507efeb468202765783935e1e6
+  data.tar.gz: 89a74ea62a573ba9f3eff0481083780a41fe212e5c2cea9b325a3d343168df4b264f8152600290fdcca70e76129653b19c80a7dffaf1255efcc8809e32e8fbed

data/README.md

@@ -36,7 +36,7 @@ ZOLD principles include:
   * 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 an XML file
+  * A wallet is an 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
@@ -84,40 +84,36 @@ A **transaction** is a money transferring operation between two wallets.
 
 A wallet may look like this:
 
-```xml
-<wallet>
-  <id>123456</id>
-  <pkey><!-- public RSA key, 256 bytes --></pkey>
-  <ledger>
-    [...]
-    <txn id="35">
-      <date>2017-07-19T21:24:51.136Z</date>
-      <beneficiary>927284</beneficiary>
-      <amount>-560</amount>
-      <sign><!-- RSA signature of the payer --></sign>
-    </txn>
-  </ledger>
-</wallet>
+```text
+12345678abcdef
+AAAAB3NzaC1yc2EAAAADAQABAAABAQCuLuVr4Tl2sXoN5Zb7b6SKMPrVjLxb...
+
+35;2017-07-19T21:24:51.136Z;98bb82c81735c4ee;-560;SKMPrVjLxbM5oDm0IhniQQy3shF...
 ```
 
-Wallet `<id>` is an unsigned 32-bit integer.
+Lines are separated by either CR or CRLF, doesn't matter.
+
+The fist line is wallet ID, a 64-bit unsigned integer.
+
+The second line is a public RSA key of the wallet owner.
+
+The third line is empty.
+
+Each next line is a transaction and it has four or five fields separated by a semi-colon.
+
+The first field is transaction ID, an unsigned 16-bit integer.
 
-Transaction `id` is an unsigned 16-bit integer.
+The second field is its date, in ISO 8601 format.
 
-Transaction `date` is an unsigned 32-bit integer, meaning
-milliseconds since
-[epoch](https://en.wikipedia.org/wiki/Epoch_%28reference_date%29).
+The third field is the wallet ID of the beneficiary.
 
-All amounts are signed 64-bit integers, where 1ZLD by convention equals to
-2<sup>24</sup> (16,777,216). Thus, the technical capacity
-of the currency is 549,755,813,888 (half a trillion).
+The forth field is the amount.
 
-The `<sign>` exists only in transactions with negative `amount`.
-It contains an RSA signature of a data block, created by the wallet owner:
-`date`, `amount`, `beneficiary` and
-64 bytes of [salt](https://en.wikipedia.org/wiki/Salt_%28cryptography%29).
+The fifth field is an RSA signature of "ID;beneficiary;amount" text.
 
-The list of a few backbone nodes is hard-coded in this Git repository.
+1ZLD by convention equals to 2<sup>24</sup> (16,777,216).
+Thus, the technical capacity of the currency is
+549,755,813,888 (half a trillion).
 
 ## Architecture
 

data/lib/zold/key.rb

@@ -34,13 +34,22 @@ module Zold
         raise "Can't find RSA key at #{file} (#{path})" unless File.exist?(path)
         @body = File.read(path)
       end
-      @body = text unless text.nil?
+      return if text.nil?
+      @body = [
+        '-----BEGIN PUBLIC KEY-----',
+        text.gsub(/(?<=\G.{64})/, "\n"),
+        '-----END PUBLIC KEY-----'
+      ].join("\n")
     end
 
     def to_s
       rsa.to_s.strip
     end
 
+    def to_pub
+      to_s.delete("\n").gsub(/-{5}[ A-Z]+-{5}/, '')
+    end
+
     def sign(text)
       Base64.encode64(rsa.sign(OpenSSL::Digest::SHA256.new, text)).delete("\n")
     end
@@ -56,7 +65,11 @@ module Zold
       unless text.start_with?('-----BEGIN')
         text = OpenSSHKeyConverter.decode_pubkey(text.split[1])
       end
-      OpenSSL::PKey::RSA.new(text)
+      begin
+        OpenSSL::PKey::RSA.new(text)
+      rescue OpenSSL::PKey::RSAError => e
+        raise "Can't read RSA key (#{e.message}): #{text}"
+      end
     end
   end
 end

data/lib/zold/version.rb

@@ -23,5 +23,5 @@
 # Copyright:: Copyright (c) 2018 Zerocracy, Inc.
 # License:: MIT
 module Zold
-  VERSION = '0.0.7'.freeze
+  VERSION = '0.0.8'.freeze
 end

data/lib/zold/wallet.rb

@@ -18,7 +18,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require 'nokogiri'
 require 'time'
 
 # The wallet.
@@ -33,7 +32,7 @@ module Zold
     end
 
     def to_s
-      id
+      id.to_s
     end
 
     def exists?
@@ -46,30 +45,12 @@ module Zold
 
     def init(id, pubkey)
       raise "File '#{@file}' already exists" if File.exist?(@file)
-      File.write(
-        @file,
-        valid(
-          Nokogiri::XML::Builder.new do |xml|
-            xml.wallet do
-              xml.id_ id.to_s
-              xml.pkey pubkey.to_s
-              xml.ledger {}
-            end
-          end.doc
-        )
-      )
+      File.write(@file, "#{id}\n#{pubkey.to_pub}\n\n")
     end
 
     def version
-      xml = load
-      ver = 0
-      unless xml.xpath('/wallet/ledger[txn]').empty?
-        ver = xml.xpath('/wallet/ledger/txn/@id')
-          .map(&:to_s)
-          .map(&:to_i)
-          .max
-      end
-      ver
+      all = txns
+      all.empty? ? 0 : all.map { |t| t[0] }.map(&:to_i).max
     end
 
     def root?
@@ -77,67 +58,63 @@ module Zold
     end
 
     def id
-      Id.new(load.xpath('/wallet/id/text()').to_s)
+      Id.new(lines[0])
     end
 
     def balance
       Amount.new(
-        coins: load.xpath('/wallet/ledger/txn/amount/text()')
-          .map(&:to_s)
-          .map(&:to_i)
-          .inject(0) { |sum, n| sum + n }
+        coins: txns.map { |t| t[2] }.map(&:to_i).inject(0) { |sum, n| sum + n }
       )
     end
 
     def sub(amount, target, pvtkey)
-      xml = load
       date = Time.now
       txn = version + 1
-      t = xml.xpath('/wallet/ledger')[0].add_child('<txn/>')[0]
-      t['id'] = txn
-      t.add_child('<date/>')[0].content = date.iso8601
-      t.add_child('<amount/>')[0].content = -amount.to_i
-      t.add_child('<beneficiary/>')[0].content = target
-      t.add_child('<sign/>')[0].content = pvtkey.sign(
-        "#{txn} #{amount.to_i} #{target}"
-      )
-      save(xml)
-      { id: txn, date: date, amount: amount, beneficiary: id }
+      line = [
+        txn,
+        date.iso8601,
+        -amount.to_i,
+        target,
+        pvtkey.sign("#{txn};#{amount.to_i};#{target}")
+      ].join(';') + "\n"
+      File.write(@file, (lines << line).join(''))
+      {
+        id: txn,
+        date: date,
+        amount: amount,
+        beneficiary: id
+      }
     end
 
     def add(txn)
-      xml = load
-      t = xml.xpath('/wallet/ledger')[0].add_child('<txn/>')[0]
-      t['id'] = "/#{txn[:id]}"
-      t.add_child('<date/>')[0].content = txn[:date].iso8601
-      t.add_child('<amount/>')[0].content = txn[:amount].to_i
-      t.add_child('<beneficiary/>')[0].content = txn[:beneficiary]
-      save(xml).to_s
+      line = [
+        "/#{txn[:id]}",
+        txn[:date].iso8601,
+        txn[:amount].to_i,
+        txn[:beneficiary]
+      ].join(';') + "\n"
+      File.write(@file, (lines << line).join(''))
     end
 
     def check(id, amount, beneficiary)
-      xml = load
-      txn = xml.xpath("/wallet/ledger/txn[@id='#{id}']")[0]
-      xamount = Amount.new(
-        coins: txn.xpath('amount/text()')[0].to_s.to_i
-      ).mul(-1)
+      txn = txns.find { |t| t[0].to_i == id }
+      raise "Transaction ##{id} not found" if txn.nil?
+      xamount = Amount.new(coins: txn[2].to_i).mul(-1)
       raise "#{xamount} != #{amount}" if xamount != amount
-      xbeneficiary = Id.new(txn.xpath('beneficiary/text()')[0].to_s)
+      xbeneficiary = Id.new(txn[3].to_s)
       raise "#{xbeneficiary} != #{beneficiary}" if xbeneficiary != beneficiary
-      data = "#{id} #{amount.to_i} #{beneficiary}"
-      valid = Key.new(text: xml.xpath('/wallet/pkey/text()')[0].to_s).verify(
-        txn.xpath('sign/text()')[0].to_s, data
-      )
+      data = "#{id};#{amount.to_i};#{beneficiary}"
+      valid = Key.new(text: lines[1].strip).verify(txn[4], data)
       raise "Signature is not confirming this data: '#{data}'" unless valid
       true
     end
 
     def income
-      load.xpath('/wallet/ledger/txn[amount > 0]').each do |txn|
+      txns.select { |t| t[2].to_i > 0 }.each do |t|
         hash = {
-          id: txn['id'][1..-1].to_i,
-          beneficiary: Id.new(txn.xpath('beneficiary/text()')[0].to_s),
-          amount: Amount.new(coins: txn.xpath('amount/text()')[0].to_s.to_i)
+          id: t[0][1..-1].to_i,
+          beneficiary: Id.new(t[3]),
+          amount: Amount.new(coins: t[2].to_i)
         }
         yield hash
       end
@@ -145,33 +122,13 @@ module Zold
 
     private
 
-    def load
-      raise "File '#{@file}' is absent" unless File.exist?(@file)
-      valid(Nokogiri::XML(File.read(@file)))
-    end
-
-    def save(xml)
-      File.write(@file, valid(xml).to_s)
+    def txns
+      lines.drop(3).map { |t| t.split(';') }
     end
 
-    def valid(xml)
-      xsd = Nokogiri::XML::Schema(
-        File.open(
-          File.join(
-            File.dirname(__FILE__),
-            '../../assets/wallet.xsd'
-          )
-        )
-      )
-      errors = xsd.validate(xml)
-      unless errors.empty?
-        errors.each do |error|
-          puts "#{p} #{error.line}: #{error.message}"
-        end
-        puts xml
-        raise 'XML is not valid'
-      end
-      xml
+    def lines
+      raise "File '#{@file}' is absent" unless File.exist?(@file)
+      File.readlines(@file)
     end
   end
 end

data/lib/zold/wallets.rb

@@ -40,7 +40,7 @@ module Zold
     end
 
     def find(id)
-      Zold::Wallet.new(File.join(@dir, "z-#{id}.xml"))
+      Zold::Wallet.new(File.join(@dir, id.to_s))
     end
   end
 end

data/test/commands/test_create.rb

@@ -37,8 +37,8 @@ class TestCreate < Minitest::Test
       ).run
       assert wallet.balance.zero?
       assert(
-        File.exist?(File.join(dir, "z-#{wallet.id}.xml")),
-        "Wallet file not found: #{wallet.id}.xml"
+        File.exist?(File.join(dir, wallet.id.to_s)),
+        "Wallet file not found: #{wallet.id}"
       )
     end
   end

data/test/test_key.rb

@@ -29,14 +29,16 @@ require_relative '../lib/zold/key.rb'
 class TestKey < Minitest::Test
   def test_reads_public_rsa
     key = Zold::Key.new(file: 'fixtures/id_rsa.pub')
-    assert key.to_s.start_with?("-----BEGIN PUBLIC KEY-----\nMIICI")
-    assert key.to_s.end_with?("EAAQ==\n-----END PUBLIC KEY-----")
+    assert key.to_pub.start_with?('MIICI')
+    assert key.to_pub.end_with?('EAAQ==')
+    assert !key.to_pub.include?("\n")
+    assert Zold::Key.new(text: key.to_pub).to_pub.start_with?('MIICI')
   end
 
   def test_reads_private_rsa
     key = Zold::Key.new(file: 'fixtures/id_rsa')
-    assert key.to_s.start_with?("-----BEGIN RSA PRIVATE KEY-----\nMIIJJ")
-    assert key.to_s.end_with?("Sg==\n-----END RSA PRIVATE KEY-----")
+    assert key.to_pub.start_with?('MIIJJ')
+    assert key.to_pub.end_with?('Sg==')
   end
 
   def test_signs_and_verifies
@@ -48,11 +50,16 @@ class TestKey < Minitest::Test
   end
 
   def test_signs_and_verifies_with_random_key
-    key = OpenSSL::PKey::RSA.new(2048)
-    pub = Zold::Key.new(text: key.public_key.to_s)
-    pvt = Zold::Key.new(text: key.to_s)
-    text = 'How are you doing, dude?'
-    signature = pvt.sign(text)
-    assert pub.verify(signature, text)
+    Dir.mktmpdir 'test' do |dir|
+      key = OpenSSL::PKey::RSA.new(2048)
+      file = File.join(dir, 'temp')
+      File.write(file, key.public_key.to_s)
+      pub = Zold::Key.new(file: file)
+      File.write(file, key.to_s)
+      pvt = Zold::Key.new(file: file)
+      text = 'How are you doing, dude?'
+      signature = pvt.sign(text)
+      assert pub.verify(signature, text)
+    end
   end
 end

data/test/test_wallet.rb

@@ -36,13 +36,28 @@ class TestWallet < Minitest::Test
       wallet = wallet(dir)
       amount = Zold::Amount.new(zld: 39.99)
       key = Zold::Key.new(file: 'fixtures/id_rsa')
-      assert wallet.version.zero?
+      assert(
+        wallet.version.zero?,
+        "Wallet version #{wallet.version} is not equal to zero"
+      )
       wallet.sub(amount, Zold::Id.new, key)
+      assert(
+        wallet.version == 1,
+        "Wallet version #{wallet.version} is not equal to 1"
+      )
       wallet.sub(amount, Zold::Id.new, key)
-      assert wallet.version == 2
       assert(
-        wallet.balance == amount.mul(-2),
-        "#{wallet.balance} is not equal to #{amount.mul(-2)}"
+        wallet.version == 2,
+        "Wallet version #{wallet.version} is not equal to 2"
+      )
+      wallet.sub(amount, Zold::Id.new, key)
+      assert(
+        wallet.version == 3,
+        "Wallet version #{wallet.version} is not equal to 3"
+      )
+      assert(
+        wallet.balance == amount.mul(-3),
+        "#{wallet.balance} is not equal to #{amount.mul(-3)}"
       )
     end
   end
@@ -51,7 +66,7 @@ class TestWallet < Minitest::Test
     Dir.mktmpdir 'test' do |dir|
       pkey = Zold::Key.new(file: 'fixtures/id_rsa.pub')
       Dir.chdir(dir) do
-        file = File.join(dir, 'source.xml')
+        file = File.join(dir, 'source')
         wallet = Zold::Wallet.new(file)
         id = Zold::Id.new.to_s
         wallet.init(id, pkey)
@@ -105,7 +120,7 @@ class TestWallet < Minitest::Test
 
   def wallet(dir)
     id = Zold::Id.new
-    file = File.join(dir, "#{id}.xml")
+    file = File.join(dir, id.to_s)
     wallet = Zold::Wallet.new(file)
     wallet.init(id, Zold::Key.new(file: 'fixtures/id_rsa.pub'))
     wallet

data/zold.gemspec

@@ -46,7 +46,6 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
   s.add_runtime_dependency 'cucumber', '1.3.17'
   s.add_runtime_dependency 'haml', '5.0.3'
-  s.add_runtime_dependency 'nokogiri', '~>1.8'
   s.add_runtime_dependency 'rainbow', '~>3.0'
   s.add_runtime_dependency 'rake', '12.0.0'
   s.add_runtime_dependency 'rubocop', '~>0.52.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zold
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-05 00:00:00.000000000 Z
+date: 2018-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -38,20 +38,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 5.0.3
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -230,7 +216,6 @@ files:
 - README.md
 - Rakefile
 - appveyor.yml
-- assets/wallet.xsd
 - bin/zold
 - cucumber.yml
 - deploy.sh

data/assets/wallet.xsd

@@ -1,71 +0,0 @@
-<?xml version="1.0"?>
-<!--
-(The MIT License)
-
-Copyright (c) 2018 Zerocracy, Inc.
-
-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 NONINFRINGEMENT. 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.
--->
-<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
-  <xs:simpleType name="amount">
-    <xs:restriction base="xs:integer">
-      <xs:minInclusive value="-9223372036854775808"/>
-      <xs:maxInclusive value="9223372036854775807"/>
-    </xs:restriction>
-  </xs:simpleType>
-  <xs:simpleType name="wallet">
-    <xs:restriction base="xs:string">
-      <xs:pattern value="[0-9a-f]{16}"/>
-    </xs:restriction>
-  </xs:simpleType>
-  <xs:complexType name="txn">
-    <xs:all>
-      <xs:element name="beneficiary" type="wallet" minOccurs="1" maxOccurs="1"/>
-      <xs:element name="date" type="xs:dateTime" minOccurs="1" maxOccurs="1"/>
-      <xs:element name="sign" type="xs:string" minOccurs="0" maxOccurs="1"/>
-      <xs:element name="amount" type="amount" minOccurs="1" maxOccurs="1"/>
-    </xs:all>
-    <xs:attribute name="id" use="required">
-      <xs:simpleType>
-        <xs:restriction base="xs:string">
-          <xs:pattern value="/?[0-9]+"/>
-        </xs:restriction>
-      </xs:simpleType>
-    </xs:attribute>
-  </xs:complexType>
-  <xs:complexType name="ledger">
-    <xs:sequence>
-      <xs:element name="txn" type="txn" minOccurs="0" maxOccurs="unbounded"/>
-    </xs:sequence>
-  </xs:complexType>
-  <xs:element name="wallet">
-    <xs:complexType>
-      <xs:all>
-        <xs:element name="id" type="wallet" minOccurs="1" maxOccurs="1"/>
-        <xs:element name="pkey" type="xs:string" minOccurs="1" maxOccurs="1"/>
-        <xs:element name="ledger" type="ledger" minOccurs="1" maxOccurs="1">
-          <xs:unique name="txnUnique">
-            <xs:selector xpath="./txn"/>
-            <xs:field xpath="@id"/>
-          </xs:unique>
-        </xs:element>
-      </xs:all>
-    </xs:complexType>
-  </xs:element>
-</xs:schema>