arkecosystem-crypto 0.1.0

data/lib/arkecosystem/crypto/deserialiser.rb

@@ -0,0 +1,94 @@
+require 'arkecosystem/crypto/identity/address'
+
+module ArkEcosystem
+  module Crypto
+    # The base deserialiser for transactions.
+    class Deserialiser
+      def initialize(serialised)
+        @serialised = serialised
+        @binary = BTC::Data.data_from_hex(@serialised)
+
+        @handlers = %w[
+          Transfer
+          SecondSignatureRegistration
+          DelegateRegistration
+          Vote
+          MultiSignatureRegistration
+          Ipfs
+          TimelockTransfer
+          MultiPayment
+          DelegateResignation
+        ]
+      end
+
+      def deserialise
+        transaction = {}
+        transaction[:version] = @binary.unpack('C2').last
+        transaction[:network] = @binary.unpack('C3').last
+        transaction[:type] = @binary.unpack('C4').last
+        transaction[:timestamp] = @binary.unpack('V2').last
+        transaction[:sender_public_key] = @binary.unpack('H16H66').last
+        transaction[:fee] = @binary.unpack('C41Q<').last
+
+        vendor_field_length = @binary.unpack('C49C1').last
+
+        if vendor_field_length > 0
+          vendor_field_offset = (41 + 8 + 1) * 2
+          vendor_field_take = vendor_field_length * 2
+
+          transaction[:vendor_field_hex] = @binary.unpack("H#{vendor_field_offset}H#{vendor_field_take}").last
+        end
+
+        asset_offset = (41 + 8 + 1) * 2 + vendor_field_length * 2
+
+        transaction = handle_type(asset_offset, transaction)
+
+        transaction[:amount] = 0 unless transaction[:amount]
+
+        if transaction[:version] == 1 || transaction[:version].empty?
+          transaction = handle_version_one(transaction)
+        end
+
+        transaction
+      end
+
+      private
+
+      def handle_type(asset_offset, transaction)
+        deserialiser = @handlers[transaction[:type]]
+        deserialiser = Object.const_get("ArkEcosystem::Crypto::Deserialisers::#{deserialiser}")
+        deserialiser.new(@serialised, @binary, asset_offset, transaction).deserialise
+      end
+
+      def handle_version_one(transaction)
+        if transaction[:second_signature]
+          transaction[:sign_signature] = transaction[:second_signature]
+        end
+
+        if transaction[:type] == ArkEcosystem::Crypto::Enums::Types::SECOND_SIGNATURE_REGISTRATION
+          transaction[:recipient_id] = ArkEcosystem::Crypto::Identity::Address.from_public_key(transaction[:sender_public_key])
+        end
+
+        if transaction[:type] == ArkEcosystem::Crypto::Enums::Types::VOTE
+          transaction[:recipient_id] = ArkEcosystem::Crypto::Identity::Address.from_public_key(transaction[:sender_public_key])
+        end
+
+        if transaction[:type] == ArkEcosystem::Crypto::Enums::Types::MULTI_SIGNATURE_REGISTRATION
+          # The "recipientId" doesn't exist on v1 multi signature registrations
+          # transaction[:recipient_id] = ArkEcosystem::Crypto::Identity::Address::from_public_key(transaction[:sender_public_key]);
+          transaction[:asset][:multisignature][:keysgroup] = transaction[:asset][:multisignature][:keysgroup].map! { |key| '+' + key }
+        end
+
+        if transaction[:vendor_field_hex]
+          transaction[:vendor_field] = BTC::Data.data_from_hex(transaction[:vendor_field_hex])
+        end
+
+        unless transaction[:id]
+          transaction[:id] = ArkEcosystem::Crypto::Crypto.get_id(transaction)
+        end
+
+        transaction
+      end
+    end
+  end
+end

data/lib/arkecosystem/crypto/deserialisers/base.rb

@@ -0,0 +1,15 @@
+module ArkEcosystem
+  module Crypto
+    module Deserialisers
+      # The base deserialiser for transactions.
+      class Base
+        def initialize(serialised, binary, asset_offset, transaction)
+          @serialised = serialised
+          @binary = binary
+          @asset_offset = asset_offset
+          @transaction = transaction
+        end
+      end
+    end
+  end
+end

data/lib/arkecosystem/crypto/deserialisers/delegate_registration.rb

@@ -0,0 +1,22 @@
+module ArkEcosystem
+  module Crypto
+    module Deserialisers
+      # The deserialiser for delegate registration transactions.
+      class DelegateRegistration < Base
+        def deserialise
+          @transaction[:asset] = {
+            delegate: {}
+          }
+
+          username_length = @binary.unpack("C#{@asset_offset / 2}Q<").last & 0xff
+
+          username = @serialised[@asset_offset + 2, username_length * 2]
+
+          @transaction[:asset][:delegate][:username] = BTC::Data.data_from_hex(username)
+
+          ArkEcosystem::Crypto::Crypto.parse_signatures(@serialised, @transaction, @asset_offset + (username_length + 1) * 2)
+        end
+      end
+    end
+  end
+end

data/lib/arkecosystem/crypto/deserialisers/delegate_resignation.rb

@@ -0,0 +1,12 @@
+module ArkEcosystem
+  module Crypto
+    module Deserialisers
+      # The deserialiser for delegate resignation transactions.
+      class DelegateResignation < Base
+        def deserialise
+          ArkEcosystem::Crypto::Crypto.parse_signatures(@serialised, @transaction, @asset_offset)
+        end
+      end
+    end
+  end
+end

data/lib/arkecosystem/crypto/deserialisers/ipfs.rb

@@ -0,0 +1,18 @@
+module ArkEcosystem
+  module Crypto
+    module Deserialisers
+      # The deserialiser for IPFS transactions.
+      class IPFS < Base
+        def deserialise
+          @transaction[:asset] = {}
+
+          dag_length = @binary.unpack("C#{@asset_offset / 2}Q<").last & 0xff
+
+          @transaction[:asset][:dag] = @serialised[@asset_offset + 2, dag_length * 2]
+
+          ArkEcosystem::Crypto::Crypto.parse_signatures(@serialised, @transaction, @asset_offset + 2 + length * 2)
+        end
+      end
+    end
+  end
+end

data/lib/arkecosystem/crypto/deserialisers/multi_payment.rb

@@ -0,0 +1,38 @@
+module ArkEcosystem
+  module Crypto
+    module Deserialisers
+      # The deserialiser for multi payment transactions.
+      class MultiPayment < Base
+        def deserialise
+          @transaction[:asset] = {
+            amount: 0,
+            payments: []
+          }
+
+          total = @binary.unpack("C#{@asset_offset / 2}Q<").last & 0xff
+          offset = @asset_offset / 2 + 1
+
+          i = 0
+          while i < total
+            recipient_id = @binary.unpack("H#{(offset + 1) * 2}H42").last
+
+            payment = {
+              amount: @binary.unpack("C#{@asset_offset / 2}Q<").last,
+              recipient_id: BTC::Base58.base58check_from_data([recipient_id].pack('H*'))
+            }
+
+            @transaction[:asset][:payments].push(payment)
+
+            offset += 22
+
+            i += 1
+          end
+
+          products.each { |item| @transaction[:amount] += item[:amount] }
+
+          ArkEcosystem::Crypto::Crypto.parse_signatures(@serialised, @transaction, offset * 2)
+        end
+      end
+    end
+  end
+end

data/lib/arkecosystem/crypto/deserialisers/multi_signature_registration.rb

@@ -0,0 +1,32 @@
+module ArkEcosystem
+  module Crypto
+    module Deserialisers
+      # The deserialiser for multi signature registrations transactions.
+      class MultiSignatureRegistration < Base
+        def deserialise
+          @transaction[:asset] = {
+            multisignature: {
+              keysgroup: []
+            }
+          }
+
+          @transaction[:asset][:multisignature][:min] = @binary.unpack("C#{@asset_offset / 2}Q<").last & 0xff
+          @transaction[:asset][:multisignature][:lifetime] = @binary.unpack("C#{@asset_offset / 2 + 2}Q<").last & 0xff
+
+          count = @binary.unpack("C#{@asset_offset / 2 + 1}Q<").last & 0xff
+
+          i = 0
+          while i < count
+            index_start = @asset_offset + 6 + i * 66
+
+            @transaction[:asset][:multisignature][:keysgroup].push(@serialised[index_start, 66])
+
+            i += 1
+          end
+
+          ArkEcosystem::Crypto::Crypto.parse_signatures(@serialised, @transaction, @asset_offset + 6 + count * 66)
+        end
+      end
+    end
+  end
+end

data/lib/arkecosystem/crypto/deserialisers/second_signature_registration.rb

@@ -0,0 +1,18 @@
+module ArkEcosystem
+  module Crypto
+    module Deserialisers
+      # The deserialiser for second signature registrations transactions.
+      class SecondSignatureRegistration < Base
+        def deserialise
+          @transaction[:asset] = {
+            signature: {}
+          }
+
+          @transaction[:asset][:signature][:public_key] = @serialised[@asset_offset, 66]
+
+          ArkEcosystem::Crypto::Crypto.parse_signatures(@serialised, @transaction, @asset_offset + 66)
+        end
+      end
+    end
+  end
+end

data/lib/arkecosystem/crypto/deserialisers/timelock_transfer.rb

@@ -0,0 +1,19 @@
+module ArkEcosystem
+  module Crypto
+    module Deserialisers
+      # The deserialiser for timelock transfer transactions.
+      class TimelockTransfer < Base
+        def deserialise
+          @transaction[:amount] = @binary.unpack("C#{@asset_offset / 2}Q<").last
+          @transaction[:timelocktype] = @binary.unpack("C#{@asset_offset / 2 + 8}").last & 0xff
+          @transaction[:timelock] = @binary.unpack("C#{@asset_offset / 2 + 9}Q<").last
+
+          recipient_id = @binary.unpack("H#{(@asset_offset / 2 + 13) * 2}H42").last
+          @transaction[:recipient_id] = BTC::Base58.base58check_from_data([recipient_id].pack('H*'))
+
+          ArkEcosystem::Crypto::Crypto.parse_signatures(@serialised, @transaction, @asset_offset + (21 + 13) * 2)
+        end
+      end
+    end
+  end
+end

data/lib/arkecosystem/crypto/deserialisers/transfer.rb

@@ -0,0 +1,18 @@
+module ArkEcosystem
+  module Crypto
+    module Deserialisers
+      # The deserialiser for transfer transactions.
+      class Transfer < Base
+        def deserialise
+          @transaction[:amount] = @binary.unpack("C#{@asset_offset / 2}Q<").last
+          @transaction[:expiration] = @binary.unpack("C#{@asset_offset / 2 + 8}").last
+
+          recipient_id = @binary.unpack("H#{(@asset_offset / 2 + 12) * 2}H42").last
+          @transaction[:recipient_id] = BTC::Base58.base58check_from_data([recipient_id].pack('H*'))
+
+          ArkEcosystem::Crypto::Crypto.parse_signatures(@serialised, @transaction, @asset_offset + (21 + 12) * 2)
+        end
+      end
+    end
+  end
+end

data/lib/arkecosystem/crypto/deserialisers/vote.rb

@@ -0,0 +1,31 @@
+module ArkEcosystem
+  module Crypto
+    module Deserialisers
+      # The deserialiser for vote transactions.
+      class Vote < Base
+        def deserialise
+          @transaction[:asset] = {
+            votes: []
+          }
+
+          vote_length = @binary.unpack("C#{@asset_offset / 2}Q<").last & 0xff
+
+          i = 0
+          while i < vote_length
+            index_start = @asset_offset + 2 + i * 2 * 34
+            index_end = 2 * 34
+
+            vote = @serialised[index_start, index_end]
+            vote = (vote[1] == '1' ? '+' : '-') + vote[2..-1]
+
+            @transaction[:asset][:votes].push(vote)
+
+            i += 1
+          end
+
+          ArkEcosystem::Crypto::Crypto.parse_signatures(@serialised, @transaction, @asset_offset + 2 + vote_length * 34 * 2)
+        end
+      end
+    end
+  end
+end

data/lib/arkecosystem/crypto/enums/fees.rb

@@ -0,0 +1,18 @@
+module ArkEcosystem
+  module Crypto
+    module Enums
+      # The list of available tansaction fees.
+      class Fees
+        TRANSFER = 10_000_000
+        SECOND_SIGNATURE_REGISTRATION = 500_000_000
+        DELEGATE_REGISTRATION = 2_500_000_000
+        VOTE = 100_000_000
+        MULTI_SIGNATURE_REGISTRATION = 500_000_000
+        IPFS = 0
+        TIMELOCK_TRANSFER = 0
+        MULTI_PAYMENT = 0
+        DELEGATE_RESIGNATION = 0
+      end
+    end
+  end
+end

data/lib/arkecosystem/crypto/enums/types.rb

@@ -0,0 +1,18 @@
+module ArkEcosystem
+  module Crypto
+    module Enums
+      # The list of available tansaction types.
+      class Types
+        TRANSFER = 0
+        SECOND_SIGNATURE_REGISTRATION = 1
+        DELEGATE_REGISTRATION = 2
+        VOTE = 3
+        MULTI_SIGNATURE_REGISTRATION = 4
+        IPFS = 5
+        TIMELOCK_TRANSFER = 6
+        MULTI_PAYMENT = 7
+        DELEGATE_RESIGNATION = 8
+      end
+    end
+  end
+end

data/lib/arkecosystem/crypto/identity/address.rb

@@ -0,0 +1,35 @@
+require 'btcruby'
+require 'arkecosystem/crypto/configuration/network'
+
+module ArkEcosystem
+  module Crypto
+    module Identity
+      # The identity utility for an address.
+      class Address
+        def self.from_secret(secret, network = nil)
+          private_key = PrivateKey.from_secret(secret)
+
+          from_private_key(private_key, network)
+        end
+
+        def self.from_public_key(public_key, network = nil)
+          private_key = BTC::Key.new(public_key: [public_key].pack('H*'))
+
+          from_private_key(private_key, network)
+        end
+
+        def self.from_private_key(private_key, network = nil)
+          network ||= ArkEcosystem::Crypto::Configuration::Network.get
+
+          public_key = Digest::RMD160.digest(private_key.public_key)
+
+          BTC::Base58.base58check_from_data([network.version.to_i(16)].pack('c') + public_key)
+        end
+
+        def self.validate(address)
+          BTC::Address.parse(address)
+        end
+      end
+    end
+  end
+end

data/lib/arkecosystem/crypto/identity/private_key.rb

@@ -0,0 +1,14 @@
+require 'btcruby'
+
+module ArkEcosystem
+  module Crypto
+    module Identity
+      # The identity utility for a private key.
+      class PrivateKey
+        def self.from_secret(secret)
+          BTC::Key.new(private_key: Digest::SHA256.digest(secret), public_key_compressed: true)
+        end
+      end
+    end
+  end
+end

data/lib/arkecosystem/crypto/identity/public_key.rb

@@ -0,0 +1,18 @@
+require 'btcruby'
+
+module ArkEcosystem
+  module Crypto
+    module Identity
+      # The identity utility for a public key.
+      class PublicKey
+        def self.from_secret(secret)
+          PrivateKey.from_secret(secret).public_key
+        end
+
+        def self.from_secret_as_hex(secret)
+          from_secret(secret).unpack('H*').first
+        end
+      end
+    end
+  end
+end

data/lib/arkecosystem/crypto/identity/wif.rb

@@ -0,0 +1,22 @@
+require 'btcruby'
+
+module ArkEcosystem
+  module Crypto
+    module Identity
+      # The identity utility for a WIF.
+      class WIF
+        def self.from_secret(secret, network = nil)
+          network ||= ArkEcosystem::Crypto::Configuration::Network.get
+
+          secret = Digest::SHA256.digest(secret)
+
+          seed = [network.wif].pack('C*')
+          seed << secret
+          seed << [0x01].pack('C*')
+
+          BTC::Base58.base58check_from_data(seed)
+        end
+      end
+    end
+  end
+end