eip55 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 979aa4ae1e5c3bd0d1a494b883473c0af665a12c68422b6059fc1df6ff001616
+  data.tar.gz: 49f2f4c70194dd9560edab690b5ff89cea31155b384901012491bc48b33f0d96
+SHA512:
+  metadata.gz: c25aad542bd53972fffca1081825d92819ec8d1740270bf5d9ce96125665fa5db59fe7ce0bc1a3d88179866866597669215c1a0ef07654ff29f910026bd87bf7
+  data.tar.gz: 552ffb437a30a85ce287b1e97823706a9cc8c8fe67da7a90f25b3188c38ddcfd0da05db14e7bac84fc065e112cd2604a354b5faa6bcb9247b1e7422487fef7cd

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Steve Ellis
+
+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,35 @@
+# EIP55 [![CircleCI](https://circleci.com/gh/FractalBlockchain/ruby-eip55.svg?style=svg)](https://circleci.com/gh/FractalBlockchain/ruby-eip55)
+
+A library for [Ethereum mixed-case checksum address encoding](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-55.md). Mostly extracted from [se3000/ruby-eth](https://github.com/se3000/ruby-eth).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eip55'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself:
+
+    $ gem install eip55
+
+## Usage
+
+See tests for usage examples
+
+## Tests
+
+    $ rake test
+
+## Code style
+
+    $ bundle exec rubocop
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+task default: :test

data/lib/eip55.rb

@@ -0,0 +1,5 @@
+require "eip55/util"
+require "eip55/address"
+
+module EIP55
+end

data/lib/eip55/address.rb

@@ -0,0 +1,62 @@
+module EIP55
+  class InvalidAddressError < StandardError
+  end
+
+  class Address
+    def initialize address
+      @address = Util.prefix(address)
+    end
+
+    def valid?
+      if !matches_any_format?
+        false
+      elsif not_checksummed?
+        true
+      else
+        checksum_matches?
+      end
+    end
+
+    def checksummed
+      raise InvalidAddressError.new("Invalid address: #{address}") unless matches_any_format?
+
+      cased = unprefixed.chars.zip(checksum.chars).map do |char, check|
+        check.match?(/[0-7]/) ? char.downcase : char.upcase
+      end
+
+      Util.prefix(cased.join)
+    end
+
+    private
+
+    attr_reader :address
+
+    def checksum_matches?
+      address == checksummed
+    end
+
+    def matches_any_format?
+      address.match(/\A(?:0[xX])[a-fA-F0-9]{40}\z/)
+    end
+
+    def not_checksummed?
+      all_uppercase? || all_lowercase?
+    end
+
+    def all_uppercase?
+      address.match(/\A(?:0[xX])[A-F0-9]{40}\z/)
+    end
+
+    def all_lowercase?
+      address.match(/\A(?:0[xX])[a-f0-9]{40}\z/)
+    end
+
+    def unprefixed
+      Util.unprefix(address)
+    end
+
+    def checksum
+      Util.encode_hex(Util.keccak256(unprefixed.downcase))
+    end
+  end
+end

data/lib/eip55/util.rb

@@ -0,0 +1,23 @@
+require "digest"
+
+module EIP55
+  class Util
+    class << self
+      def encode_hex string
+        string.unpack1("H*")
+      end
+
+      def keccak256 buffer
+        Digest::SHA3.new(256).digest(buffer)
+      end
+
+      def prefix address
+        address[0, 2] == "0x" ? address : "0x#{address}"
+      end
+
+      def unprefix address
+        address[0, 2] == "0x" ? address[2..-1] : address
+      end
+    end
+  end
+end

data/lib/eip55/version.rb

@@ -0,0 +1,3 @@
+module EIP55
+  VERSION = "1.0.0".freeze
+end

data/test/address_test.rb

@@ -0,0 +1,125 @@
+require "test_helper"
+
+describe EIP55::Address do
+  describe "#valid?" do
+    describe "given an address with a valid checksum" do
+      let(:addresses) do
+        %w[
+          0x5aAeb6053F3E94C9b9A09f33669435E7Ef1BeAed
+          0xfB6916095ca1df60bB79Ce92cE3Ea74c37c5d359
+          0xdbF03B407c01E7cD3CBea99509d93f8DDDC8C6FB
+          0xD1220A0cf47c7B9Be7A2E6BA89F429762e7b9aDb
+        ]
+      end
+
+      it "returns true" do
+        addresses.each do |address|
+          assert EIP55::Address.new(address).valid?
+        end
+      end
+    end
+
+    describe "given an address with an invalid checksum" do
+      let(:addresses) do
+        %w[
+          0x5AAeb6053F3E94C9b9A09f33669435E7Ef1BeAed
+          0xFB6916095ca1df60bB79Ce92cE3Ea74c37c5d359
+          0xDbF03B407c01E7cD3CBea99509d93f8DDDC8C6FB
+          0xd1220A0cf47c7B9Be7A2E6BA89F429762e7b9aDb
+        ]
+      end
+
+      it "returns false" do
+        addresses.each do |address|
+          refute EIP55::Address.new(address).valid?
+        end
+      end
+    end
+
+    describe "given an address with all uppercase letters" do
+      let(:addresses) do
+        %w[
+          0x5AAEB6053F3E94C9B9A09F33669435E7EF1BEAED
+          0xFB6916095CA1DF60BB79CE92CE3EA74C37C5D359
+          0xDBF03B407C01E7CD3CBEA99509D93F8DDDC8C6FB
+          0xD1220A0CF47C7B9BE7A2E6BA89F429762E7B9ADB
+          0x52908400098527886E0F7030069857D2E4169EE7
+          0x8617E340B3D01FA5F11F306F4090FD50E238070D
+        ]
+      end
+
+      it "returns true" do
+        addresses.each do |address|
+          assert EIP55::Address.new(address).valid?
+        end
+      end
+    end
+
+    describe "given an address with all lowercase letters" do
+      let(:addresses) do
+        %w[
+          0x5aaeb6053f3e94c9b9a09f33669435e7ef1beaed
+          0xfb6916095ca1df60bb79ce92ce3ea74c37c5d359
+          0xdbf03b407c01e7cd3cbea99509d93f8dddc8c6fb
+          0xd1220a0cf47c7b9be7a2e6ba89f429762e7b9adb
+          0xde709f2102306220921060314715629080e2fb77
+          0x27b1fdb04752bbc536007a920d24acb045561c26
+        ]
+      end
+
+      it "returns true" do
+        addresses.each do |address|
+          assert EIP55::Address.new(address).valid?
+        end
+      end
+    end
+
+    describe "given an invalid address" do
+      let(:addresses) do
+        %w[
+          0x5aaeb6053f3e94c9b9a09f33669435e7ef1beae
+          0xfb6916095ca1df60bb79ce92ce3ea74c37c5d359d
+          0x5AAEB6053F3E94C9B9A09F33669435E7EF1BEAE
+          0xFB6916095CA1DF60BB79CE92CE3EA74C37C5D359D
+        ]
+      end
+
+      it "returns false" do
+        addresses.each do |address|
+          refute EIP55::Address.new(address).valid?
+        end
+      end
+    end
+  end
+
+  describe "#checksummed" do
+    let(:addresses) do
+      %w[
+        5aAeb6053F3E94C9b9A09f33669435E7Ef1BeAed
+        fB6916095ca1df60bB79Ce92cE3Ea74c37c5d359
+        dbF03B407c01E7cD3CBea99509d93f8DDDC8C6FB
+        D1220A0cf47c7B9Be7A2E6BA89F429762e7b9aDb
+      ]
+    end
+
+    it "follows EIP55 standard" do
+      addresses.each do |checksummed|
+        assert_equal "0x#{checksummed}", EIP55::Address.new(checksummed.upcase).checksummed
+      end
+
+      addresses.each do |checksummed|
+        assert_equal "0x#{checksummed}", EIP55::Address.new(checksummed.downcase).checksummed
+      end
+    end
+
+    describe "given an invalid address" do
+      let(:bad) { "0x#{SecureRandom.hex(21)}" }
+
+      it "raises an error" do
+        assert_raises EIP55::InvalidAddressError do
+          EIP55::Address.new(bad).checksummed
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require "minitest/autorun"
+require "minitest/spec"
+require "minitest/reporters"
+require "securerandom"
+require "eip55"
+
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: eip55
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Steve Ellis
+- Mário Carneiro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-20 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+description: 
+email:
+- email@steveell.is
+- mario.carneiro@frctls.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/eip55.rb
+- lib/eip55/address.rb
+- lib/eip55/util.rb
+- lib/eip55/version.rb
+- test/address_test.rb
+- test/test_helper.rb
+homepage: https://github.com/FractalBlockchain/ruby-eip55
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.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: Implementation of the EIP55 checksum address encoding
+test_files:
+- test/address_test.rb
+- test/test_helper.rb