ciri-utils 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: caed03d7633bd1969a1c30077108174620796d2f33aadd2535abb61e2794dacf
+  data.tar.gz: c099eb45fdeb30f8bc01083f5d55621c69397086736965c057558aef9e688d03
+SHA512:
+  metadata.gz: bf6a784ed8c0bb566f8abe7f506e9a1cde5aabaf460a8fcdb1c44e2f8e702666fc66f67e07f4fd6edeb476135058bc6c81277b5f50984624c953c03f276eb9b8
+  data.tar.gz: 1698dad2effd4f3cb6aec338f318ce27a759b81df040004987d3567bc69cb1f877894c03112700e3ce8c3ed33675b4b63333b1e1ee630e475e0a033d9a99e5fe

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jjyruby@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ciri-utils.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jiang Jinyang
+
+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.

data/README.md

@@ -0,0 +1,61 @@
+# Ciri::Utils
+
+Toolkit module of [Ciri](https://github.com/ciri-ethereum/ciri)
+
+Functions include: big endian encode/decode, hex/bytes convert, keccak256 ...
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ciri-utils'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ciri-utils
+
+## Usage
+
+``` ruby
+# keccak256
+Ciri::Utils.sha3("...")
+
+# secret_compare
+Ciri::Utils.sha3(password, secret)
+
+# convert between hex and bytes
+Ciri::Utils.to_bytes("0x...")
+Ciri::Utils.to_hex("\x00...")
+
+# big endian encode and decode
+Ciri::Utils.big_endian_encode(200)
+Ciri::Utils.big_endian_decode("....")
+
+# ....
+```
+
+See source code to find other methods.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ciri-utils. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Ciri::Utils project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ciri-utils/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ciri/utils"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ciri-utils.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ciri/utils/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ciri-utils"
+  spec.version       = Ciri::Utils::VERSION
+  spec.authors       = ["Jiang Jinyang"]
+  spec.email         = ["jjyruby@gmail.com"]
+
+  spec.summary       = %q{Toolkit module of [Ciri](https://github.com/ciri-ethereum/ciri)}
+  spec.description   = %q{Functions include: big endian encode/decode, hex/bytes convert, keccak256 ...}
+  spec.homepage      = "https://github.com/ciri-ethereum/ciri"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'digest-sha3', '~> 1.1.0'
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/ciri/utils/logger.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018, by Jiang Jinyang. <https://justjjy.com>
+#
+# 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.
+
+
+require 'logger'
+
+module Ciri
+  module Utils
+
+    # Logger
+    # Example:
+    #
+    #   class A
+    #     include Logger
+    #
+    #     def initialize(name)
+    #       @name = name
+    #       debug("initial with name")
+    #     end
+    #
+    #     def greet
+    #       puts "hello"
+    #       debug("greeting hello")
+    #     end
+    #
+    #     # customize logging name
+    #     def logging_name
+    #       "#{super}:#{@name}"
+    #     end
+    #   end
+    #
+    #   # don't forget initialize global logger
+    #   Ciri::Utils::Logger.setup(level: :debug)
+    #
+    module Logger
+
+      class << self
+        attr_reader :global_logger
+
+        def setup(level:)
+          @global_logger = ::Logger.new(STDERR, level: level)
+          global_logger.datetime_format = '%Y-%m-%d %H:%M:%S'
+          set_concurrent_logger(level: global_logger.level)
+        end
+
+        private
+
+        def set_concurrent_logger(level:)
+          require 'concurrent'
+          Concurrent.use_simple_logger(level = level)
+        rescue LoadError
+          nil
+        end
+      end
+
+      def debug(message)
+        add(::Logger::DEBUG, message)
+      end
+
+      def info(message)
+        add(::Logger::INFO, message)
+      end
+
+      def error(message)
+        add(::Logger::ERROR, message)
+      end
+
+      def logging_name
+        self.class.to_s
+      end
+
+      private
+
+      def add(severity, message = nil, progname = logging_name)
+        Logger.global_logger.add(severity, message, progname)
+      end
+
+    end
+  end
+end

data/lib/ciri/utils/number.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018, by Jiang Jinyang. <https://justjjy.com>
+#
+# 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.
+
+
+module Ciri
+  module Utils
+    module Number
+      extend self
+
+      def big_endian_encode(n, zero = ''.b, size: nil)
+        b = big_endian_encode_raw(n, zero)
+        size.nil? ? b : b.rjust(size, "\x00".b)
+      end
+
+      def big_endian_decode(input)
+        input.each_byte.reduce(0) {|s, i| s * 256 + i}
+      end
+
+      UINT_256_MAX = 2 ** 256 - 1
+      UINT_256_CEILING = 2 ** 256
+      UINT_255_MAX = 2 ** 255 - 1
+      UINT_255_CEILING = 2 ** 255
+
+      def unsigned_to_signed(n)
+        n <= UINT_255_MAX ? n : n - UINT_256_CEILING
+      end
+
+      def signed_to_unsigned(n)
+        n >= 0 ? n : n + UINT_256_CEILING
+      end
+
+      def ceil_div(n, ceil)
+        size, m = n.divmod ceil
+        m.zero? ? size : size + 1
+      end
+
+      private
+
+      def big_endian_encode_raw(n, zero = ''.b)
+        if n == 0
+          zero
+        elsif n > 0
+          big_endian_encode(n / 256) + (n % 256).chr
+        else
+          raise ArgumentError.new("can't encode negative number #{n}")
+        end
+      end
+
+    end
+  end
+end

data/lib/ciri/utils/version.rb

@@ -0,0 +1,5 @@
+module Ciri
+  module Utils
+    VERSION = "0.1.0"
+  end
+end

data/lib/ciri/utils.rb

@@ -0,0 +1,83 @@
+require "ciri/utils/version"
+
+require 'digest/sha3'
+require_relative 'utils/number'
+
+module Ciri
+  module Utils
+
+    class << self
+      include Utils::Number
+
+
+      def sha3(*data)
+        s = Digest::SHA3.new(256)
+        data.each {|i| s.update(i)}
+        s.digest
+      end
+
+      def secret_compare(s1, s2)
+        s1.size == s2.size && s1.each_byte.each_with_index.map {|b, i| b ^ s2[i].ord}.reduce(0, :+) == 0
+      end
+
+      def to_bytes(hex)
+        hex = hex[2..-1] if hex.start_with?('0x')
+        [hex].pack("H*")
+      end
+
+      def hex_to_number(hex)
+        big_endian_decode to_bytes(hex)
+      end
+
+      def to_hex(data)
+        hex = data.to_s.unpack("H*").first
+        '0x' + hex
+      end
+
+      def number_to_hex(number)
+        to_hex big_endian_encode(number)
+      end
+
+      def create_ec_pk(raw_pubkey: nil, raw_privkey: nil)
+        public_key = raw_pubkey && begin
+          group = OpenSSL::PKey::EC::Group.new('secp256k1')
+          bn = OpenSSL::BN.new(raw_pubkey, 2)
+          OpenSSL::PKey::EC::Point.new(group, bn)
+        end
+
+        OpenSSL::PKey::EC.new('secp256k1').tap do |key|
+          key.public_key = public_key if public_key
+          key.private_key = OpenSSL::BN.new(raw_privkey, 2) if raw_privkey
+        end
+      end
+
+      def to_underscore(str)
+        str.gsub(/[A-Z]/) {|a| "_" + a.downcase}
+      end
+
+      def blank_bytes?(item)
+        return true if item.is_a?(String) && item.each_byte.all?(&:zero?)
+        blank?(item)
+      end
+
+      def blank?(item)
+        if item.nil?
+          true
+        elsif item.is_a? Integer
+          item.zero?
+        elsif item.is_a? String
+          item.empty?
+        else
+          false
+        end
+      end
+
+      def present?(item)
+        !blank?(item)
+      end
+
+    end
+
+    BLANK_SHA3 = Utils.sha3(''.b).freeze
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: ciri-utils
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jiang Jinyang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: digest-sha3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: 'Functions include: big endian encode/decode, hex/bytes convert, keccak256
+  ...'
+email:
+- jjyruby@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ciri-utils.gemspec
+- lib/ciri/utils.rb
+- lib/ciri/utils/logger.rb
+- lib/ciri/utils/number.rb
+- lib/ciri/utils/version.rb
+homepage: https://github.com/ciri-ethereum/ciri
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Toolkit module of [Ciri](https://github.com/ciri-ethereum/ciri)
+test_files: []