nem-ruby 0.0.1

data/lib/nem/util/serializer.rb

@@ -0,0 +1,260 @@
+module Nem
+  module Util
+    module Serializer
+      # Serialize a transaction object
+      # @param [Hash] entity
+      # @return [Array]
+      def self.serialize_transaction(entity)
+        specific = case entity[:type]
+                   when 0x0101 then serialize_transfer(entity)
+                   when 0x0801 then serialize_importance_transfer(entity)
+                   when 0x1001 then serialize_multisig_aggregate_modification(entity)
+                   when 0x1002 then serialize_multisig_signature(entity)
+                   when 0x1004 then serialize_multisig(entity)
+                   when 0x2001 then serialize_provision_namespace(entity)
+                   when 0x4001 then serialize_mosaic_definition_creation(entity)
+                   when 0x4002 then serialize_mosaic_supply_change(entity)
+          else raise "Not implemented entity type: #{entity[:type]}"
+        end
+        serialize_common(entity) + specific
+      end
+
+      private
+
+      def self.serialize_transfer(entity)
+        a = []
+        a.concat serialize_safe_string(entity[:recipient])
+        a.concat serialize_long(entity[:amount])
+        payload = Nem::Util::Convert.hex2ua(entity[:message][:payload])
+        if payload.size == 0
+          a.concat [0, 0, 0, 0]
+        else
+          a.concat serialize_int(payload.size + 8)
+          a.concat serialize_int(entity[:message][:type])
+          a.concat serialize_int(payload.size)
+          a.concat payload
+        end
+        if entity[:mosaics] && entity[:mosaics].size > 0
+          a.concat serialize_mosaics(entity[:mosaics])
+        end
+        a
+      end
+
+      def self.serialize_importance_transfer(entity)
+        a = []
+        a.concat serialize_int(entity[:mode])
+        temp = Nem::Util::Convert.hex2ua(entity[:remoteAccount])
+        a.concat serialize_int(temp.size)
+        a.concat temp
+      end
+
+      def self.serialize_multisig_aggregate_modification(entity)
+        a = []
+        a.concat serialize_int(entity[:modifications].size)
+        mods = entity[:modifications].inject([]) do |b, mod|
+          b.concat serialize_int(40)
+          b.concat serialize_int(mod[:modificationType])
+          b.concat serialize_int(32)
+          b.concat Nem::Util::Convert.hex2ua(mod[:cosignatoryAccount])
+          b
+        end
+        a.concat mods
+
+        # The following part describes the minimum cosignatories modification.
+        # The part is optional. Version 1 aggregate modification transactions should omit this part.
+        # Version 2 aggregate modification transactions with no minimum cosignatories modification
+        # should only write the length field with value 0x00, 0x00, 0x00, 0x00.
+        if true # only version2
+          if entity[:minCosignatories][:relativeChange] > 0
+            a.concat serialize_int(4)
+            a.concat serialize_int(entity[:minCosignatories][:relativeChange])
+          else
+            a.concat [0, 0, 0, 0]
+          end
+        end
+        a
+      end
+
+      def self.serialize_multisig_signature(entity)
+        a = []
+        temp = Nem::Util::Convert.hex2ua(entity[:otherHash][:data])
+        a.concat serialize_int(4 + temp.size)
+        a.concat serialize_int(temp.size)
+        a.concat temp
+        a.concat serialize_safe_string(entity[:otherAccount])
+      end
+
+      def self.serialize_multisig(entity)
+        a = []
+        trans = entity[:otherTrans]
+        tx = case trans[:type]
+             when 0x0101 then serialize_transfer(trans)
+             when 0x0801 then serialize_importance_transfer(trans)
+             when 0x1001 then serialize_multisig_aggregate_modification(trans)
+          else raise "Unexpected type #{trans[:type]}"
+        end
+        tx = serialize_common(trans) + tx
+        a.concat serialize_int(tx.size)
+        a.concat tx
+      end
+
+      def self.serialize_provision_namespace(entity)
+        a = []
+        a.concat serialize_safe_string(entity[:rentalFeeSink])
+        a.concat serialize_long(entity[:rentalFee])
+        temp = Nem::Util::Convert.hex2ua(Nem::Util::Convert.utf8_to_hex(entity[:newPart]))
+        a.concat serialize_int(temp.size)
+        a.concat temp
+        if entity[:parent]
+          temp = Nem::Util::Convert.hex2ua(Nem::Util::Convert.utf8_to_hex(entity[:parent]))
+          a.concat serialize_int(temp.size)
+          a.concat temp
+        else
+          a.concat [255, 255, 255, 255]
+        end
+        a
+      end
+
+      def self.serialize_mosaic_definition_creation(entity)
+        a = []
+        a.concat serialize_mosaic_definition(entity[:mosaicDefinition])
+        a.concat serialize_safe_string(entity[:creationFeeSink])
+        a.concat serialize_long(entity[:creationFee])
+      end
+
+      def self.serialize_mosaic_supply_change(entity)
+        a = []
+        a.concat serialize_mosaic_id(entity[:mosaicId])
+        a.concat serialize_int(entity[:supplyType])
+        a.concat serialize_long(entity[:delta])
+      end
+
+      def self.serialize_common(entity)
+        a = []
+        a.concat serialize_int(entity[:type])
+        a.concat serialize_int(entity[:version])
+        a.concat serialize_int(entity[:timeStamp])
+
+        signer = Nem::Util::Convert.hex2ua(entity[:signer])
+        a.concat serialize_int(signer.size)
+        a.concat signer
+
+        a.concat serialize_long(entity[:fee].to_i)
+        a.concat serialize_int(entity[:deadline])
+      end
+
+      # Safe String - Each char is 8 bit
+      # @param [String] str
+      # @return [Array]
+      def self.serialize_safe_string(str)
+        return [255, 255, 255, 255] if str.nil?
+        return [0, 0, 0, 0] if str.empty?
+        [str.size, 0, 0, 0] + str.bytes
+      end
+
+      # @param [String] str
+      # @return [Array]
+      def self.serialize_bin_string(str)
+        return [255, 255, 255, 255] if str.nil?
+        return [0, 0, 0, 0] if str.empty?
+        chars = str.is_a?(String) ? str.chars : str
+        [chars.size, 0, 0, 0] + chars.map(&:to_i)
+      end
+
+      # @param [Integer] value
+      # @return [Array]
+      def self.serialize_int(value)
+        [value].pack('I').unpack('C4')
+      end
+
+      # @param [Integer] value
+      # @return [Array]
+      def self.serialize_long(value)
+        a = [0, 0, 0, 0, 0, 0, 0, 0]
+        bin = sprintf('%040b', value)
+        0.upto(bin.size / 8 - 1) do |i|
+          a[i] = 0xFF & (value >> 8 * i)
+        end
+        a
+      end
+
+      # @param [Nem::Struct::Mosaic] mosaic
+      # @return [Array]
+      def self.serialize_mosaic_and_quantity(mosaic_attachment)
+        a = []
+        a.concat serialize_mosaic_id(mosaic_attachment[:mosaicId])
+        a.concat serialize_long(mosaic_attachment[:quantity])
+      end
+
+      # @param [Array <Nem::Struct::Mosaic>] entities
+      # @return [Array]
+      def self.serialize_mosaics(entities)
+        a = []
+        a.concat serialize_int(entities.size)
+        mosaics = entities.inject([]) do |memo, ent|
+          memo.concat serialize_mosaic_and_quantity(ent)
+        end
+        a.concat serialize_int(mosaics.size)
+        a.concat mosaics
+      end
+
+      # @param [Hash] entity
+      # @return [Array]
+      def self.serialize_mosaic_id(entity)
+        a = []
+        a.concat serialize_safe_string(entity[:namespaceId])
+        a.concat serialize_safe_string(entity[:name])
+        serialize_int(a.size) + a
+      end
+
+      # @param [Hash] entity
+      # @return [Array]
+      def self.serialize_property(entity)
+        a = []
+        a.concat serialize_safe_string(entity[:name])
+        a.concat serialize_safe_string(entity[:value])
+        serialize_int(a.size) + a
+      end
+
+      # @param [Array] entities
+      # @return [Array]
+      def self.serialize_properties(entities)
+        order = {
+          'divisibility'  => 1,
+          'initialSupply' => 2,
+          'supplyMutable' => 3,
+          'transferable'  => 4
+        }
+        serialize_int(entities.size) + entities
+          .sort_by { |ent| order[ent[:name]] }
+          .inject([]) { |memo, ent| memo + serialize_property(ent) }
+      end
+
+      # @param [Hash] entity
+      # @return [Array]
+      def self.serialize_levy(entity)
+        return [0, 0, 0, 0] if entity.nil?
+        a = []
+        a.concat serialize_int(entity[:type])
+        a.concat serialize_safe_string(entity[:recipient])
+        a.concat serialize_mosaic_id(entity[:mosaicId])
+        a.concat serialize_long(entity[:fee])
+        serialize_int(a.size) + a
+      end
+
+      # @param [Hash] entity
+      # @return [Array]
+      def self.serialize_mosaic_definition(entity)
+        a = []
+        creator = Nem::Util::Convert.hex2ua(entity[:creator])
+        a.concat serialize_int(creator.size)
+        a.concat creator
+        a.concat serialize_mosaic_id(entity[:id])
+        a.concat serialize_bin_string(Nem::Util::Convert.hex2ua(Nem::Util::Convert.utf8_to_hex(entity[:description])))
+        a.concat serialize_properties(entity[:properties])
+        a.concat serialize_levy(entity[:levy])
+        serialize_int(a.size) + a
+      end
+    end
+  end
+end

data/lib/nem/version.rb

@@ -0,0 +1,3 @@
+module Nem
+  VERSION = '0.0.1'
+end

data/nem-ruby.gemspec

@@ -0,0 +1,46 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nem/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'nem-ruby'
+  spec.version = Nem::VERSION
+  spec.authors = ['Yoshiyuki Ieyama']
+  spec.email   = ['yukku0423@gmail.com']
+
+  spec.summary     = 'Ruby gem for communicating with the nem'
+  spec.description = 'Ruby gem for communicating with the nem'
+  spec.homepage    = 'https://github.com/44uk/nem-ruby'
+  spec.license     = 'MIT'
+
+  spec.required_ruby_version = '>= 2.2.6'
+  spec.metadata['yard.run'] = 'yri'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.post_install_message = '
+  <# nem-ruby #>
+  Please see https://gitter.im/44uk/nem-ruby for the latest information.
+  The gem is under development. Incompatible changes can be made.
+  Feel free to ask and give feedback to https://twitter.com/44uk_i3
+  Good luck! NEM application development with Ruby!
+  '
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'yard', '~> 0.9'
+  spec.add_development_dependency 'rubocop', '~> 0.47'
+  spec.add_development_dependency 'timecop', '~> 0.8'
+  spec.add_development_dependency 'webmock', '~> 2.3'
+  spec.add_development_dependency 'pry-byebug', '~> 3'
+
+  spec.add_dependency 'digest-sha3', '~> 1.1'
+  spec.add_dependency 'base32', '~> 0.3'
+  spec.add_dependency 'faraday', '~> 0.11'
+  spec.add_dependency 'faraday_middleware', '~> 0.11'
+end

metadata

@@ -0,0 +1,350 @@
+--- !ruby/object:Gem::Specification
+name: nem-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yoshiyuki Ieyama
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: digest-sha3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: base32
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Ruby gem for communicating with the nem
+email:
+- yukku0423@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- examples/apostille_audit.rb
+- examples/apostille_create.rb
+- examples/endpoint/account.rb
+- examples/endpoint/account_local.rb
+- examples/endpoint/block.rb
+- examples/endpoint/chain.rb
+- examples/endpoint/debug.rb
+- examples/endpoint/local.rb
+- examples/endpoint/mosaic.rb
+- examples/endpoint/namespace.rb
+- examples/endpoint/node.rb
+- examples/endpoint/timesync.rb
+- examples/endpoint/transaction.rb
+- examples/localnode.rb
+- examples/nis.rb
+- examples/node_pool.rb
+- examples/transaction/importance_transfer.rb
+- examples/transaction/mosaic_definition_creation.rb
+- examples/transaction/mosaic_supply_change.rb
+- examples/transaction/multisig_add_cosignatory.rb
+- examples/transaction/multisig_aggregate_modification.rb
+- examples/transaction/multisig_signature.rb
+- examples/transaction/multisig_transfer.rb
+- examples/transaction/provision_namespace.rb
+- examples/transaction/transfer.rb
+- examples/transaction/transfer_mosaic.rb
+- examples/transaction/transfer_with_encrypted_message.rb
+- examples/transaction/transfer_with_local.rb
+- lib/nem.rb
+- lib/nem/apostille.rb
+- lib/nem/apostille_audit.rb
+- lib/nem/client.rb
+- lib/nem/configuration.rb
+- lib/nem/endpoint.rb
+- lib/nem/endpoint/account.rb
+- lib/nem/endpoint/base.rb
+- lib/nem/endpoint/block.rb
+- lib/nem/endpoint/chain.rb
+- lib/nem/endpoint/debug.rb
+- lib/nem/endpoint/local/account.rb
+- lib/nem/endpoint/local/chain.rb
+- lib/nem/endpoint/mosaic.rb
+- lib/nem/endpoint/namespace.rb
+- lib/nem/endpoint/node.rb
+- lib/nem/endpoint/timesync.rb
+- lib/nem/endpoint/transaction.rb
+- lib/nem/error.rb
+- lib/nem/fee.rb
+- lib/nem/fee/importance_transfer.rb
+- lib/nem/fee/mosaic_definition_creation.rb
+- lib/nem/fee/mosaic_supply_change_transfer.rb
+- lib/nem/fee/multisig.rb
+- lib/nem/fee/multisig_aggregation_modification.rb
+- lib/nem/fee/provision_namespace.rb
+- lib/nem/fee/transfer.rb
+- lib/nem/keypair.rb
+- lib/nem/mixin.rb
+- lib/nem/mixin/assignable.rb
+- lib/nem/model.rb
+- lib/nem/model/account.rb
+- lib/nem/model/account_historical.rb
+- lib/nem/model/block.rb
+- lib/nem/model/chain.rb
+- lib/nem/model/connection.rb
+- lib/nem/model/experience.rb
+- lib/nem/model/explorer_block.rb
+- lib/nem/model/harvest.rb
+- lib/nem/model/heartbeat.rb
+- lib/nem/model/importance.rb
+- lib/nem/model/importance_transfer_transaction.rb
+- lib/nem/model/keypair.rb
+- lib/nem/model/message.rb
+- lib/nem/model/mosaic.rb
+- lib/nem/model/mosaic_attachment.rb
+- lib/nem/model/mosaic_definition.rb
+- lib/nem/model/mosaic_definition_creation_transaction.rb
+- lib/nem/model/mosaic_id.rb
+- lib/nem/model/mosaic_levy.rb
+- lib/nem/model/mosaic_owned.rb
+- lib/nem/model/mosaic_properties.rb
+- lib/nem/model/mosaic_supply.rb
+- lib/nem/model/mosaic_supply_change_transaction.rb
+- lib/nem/model/multisig_aggregate_modification_transaction.rb
+- lib/nem/model/multisig_info.rb
+- lib/nem/model/multisig_signature_transaction.rb
+- lib/nem/model/multisig_transaction.rb
+- lib/nem/model/namespace.rb
+- lib/nem/model/nem_announce_result.rb
+- lib/nem/model/network_time.rb
+- lib/nem/model/nis_node_info.rb
+- lib/nem/model/node.rb
+- lib/nem/model/provision_namespace_transaction.rb
+- lib/nem/model/status.rb
+- lib/nem/model/timer.rb
+- lib/nem/model/timesync.rb
+- lib/nem/model/transaction.rb
+- lib/nem/model/transfer_transaction.rb
+- lib/nem/model/unlocked_info.rb
+- lib/nem/mosaic.rb
+- lib/nem/mosaic/dim_coin.rb
+- lib/nem/mosaic/dim_token.rb
+- lib/nem/mosaic/ecobit_eco.rb
+- lib/nem/mosaic/xem.rb
+- lib/nem/node.rb
+- lib/nem/node_pool.rb
+- lib/nem/request.rb
+- lib/nem/request/announce.rb
+- lib/nem/transaction.rb
+- lib/nem/transaction/base.rb
+- lib/nem/transaction/importance_transfer.rb
+- lib/nem/transaction/mosaic_definition_creation.rb
+- lib/nem/transaction/mosaic_supply_change.rb
+- lib/nem/transaction/multisig.rb
+- lib/nem/transaction/multisig_aggregate_modification.rb
+- lib/nem/transaction/multisig_cosignatory_modification.rb
+- lib/nem/transaction/multisig_signature.rb
+- lib/nem/transaction/provision_namespace.rb
+- lib/nem/transaction/transfer.rb
+- lib/nem/util.rb
+- lib/nem/util/assignable.rb
+- lib/nem/util/convert.rb
+- lib/nem/util/deserializer.rb
+- lib/nem/util/ed25519.rb
+- lib/nem/util/serializer.rb
+- lib/nem/version.rb
+- nem-ruby.gemspec
+homepage: https://github.com/44uk/nem-ruby
+licenses:
+- MIT
+metadata:
+  yard.run: yri
+post_install_message: "\n  <# nem-ruby #>\n  Please see https://gitter.im/44uk/nem-ruby
+  for the latest information.\n  The gem is under development. Incompatible changes
+  can be made.\n  Feel free to ask and give feedback to https://twitter.com/44uk_i3\n
+  \ Good luck! NEM application development with Ruby!\n  "
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Ruby gem for communicating with the nem
+test_files: []