coins_address_validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 409b4dd853df9b7869ff0ae28b68380175f01319
+  data.tar.gz: 604aa52440b8b4bbeccb179ddcb28532df75d446
+SHA512:
+  metadata.gz: af6ba42856b06c5c39d3a72174946d1157ab9ac5bb0eac8bf8962d1ad2c1f36cc235e1c8ea5a2f11d8d202a50cdae60941195bf7a791db10217e9743d82a28fe
+  data.tar.gz: 5e31f243f491bf9bd561a988d91a4d5248293b941eea738927099639e17f931596c7dc3f58bf573905f24b7b4adba815d0328ffb19b9bfb512786c475a88c01e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in coins_address_validator.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2015, Hothza
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,59 @@
+# CoinsAddressValidator
+
+This gem allows you to check if virtual coin address is valid and retrieve information about it.
+
+Supported coins: 
+ - Bitcoin (BTC),
+ - DASH (DASH),
+ - Dogecoin (DOGE),
+ - Litecoin (LTC),
+ - Namecoin (NMC),
+ - Peercoin (PPC),
+ - Primecoin (XPM)
+
+If you find this gem useful please send few coins for coffee:
+
+- BTC: 1HRqmR2dbuHKeNWp478W77NxLzPi63QoKi
+- LTC: LUzmQEYEMHxh7Q8JWh3vjW2BYCGd8VxANF
+- DASH: XtPu4gA71zMdp37x3XiYdG2U25UA85Gq1w
+
+Thank you! :)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'coins_address_validator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install coins_address_validator
+
+## Usage
+
+This gem has two public methods:
+```ruby
+is_address_valid?() 
+```
+which checks if address passed as a parameter is valid BASE58 string, has correct length
+and checksum from decoded address is equal to first four bytes of SHA256(SHA256(h160))
+
+Second one:
+```ruby
+get_address_info()
+```
+returns information about network (Bitcoin, Litecoin, etc.), network symbol and type of address. 
+
+## Contributing
+
+1. Fork it ( https://github.com/Hothza/coins_address_validator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "coins_address_validator"
+
+# 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

data/bin/setup

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

data/coins_address_validator.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'coins_address_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "coins_address_validator"
+  spec.version       = CoinsAddressValidator::VERSION
+  spec.authors       = ["Hothza"]
+  spec.email         = ["hothza@users.noreply.github.com"]
+
+#  if spec.respond_to?(:metadata)
+#    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
+#  end
+
+  spec.summary       = %q{CoinsAddressValidator - gem which allows you to check if virtual coin address is valid and retrieve information about it.}
+  spec.homepage      = "https://github.com/Hothza/coin_address_validator"
+  spec.license       = "BSD"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/coins_address_validator/version.rb

@@ -0,0 +1,3 @@
+module CoinsAddressValidator
+  VERSION = "0.1.0"
+end

data/lib/coins_address_validator.rb

@@ -0,0 +1,156 @@
+# Copyright (c) 2015, Hothza
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+require "coins_address_validator/version"
+require 'base58'
+require 'digest'
+
+module CoinsAddressValidator
+  class Validator
+    def get_address_info(address)
+      if !address.nil? && !address.empty?
+        decoded = decode(address)
+        if has_valid_length?(address, decoded[:version].to_i(16)) && is_checksum_valid?(decoded)
+          info = NETWORKS[decoded[:version].to_i(16)]
+          info = {} if info.nil? # Version is not supported (yet) - return empty info for such coin
+      
+          return { :valid => true, :info => info }
+        end
+      end
+      return { :valid => false, :info => {} }
+    end
+    
+    def is_address_valid?(address)
+      if !address.nil? && !address.empty?
+        decoded = decode(address)
+        is_checksum_valid?(decoded) && has_valid_length?(address, decoded[:version].to_i(16))
+      else
+        false
+      end
+    end
+    
+    private
+      NETWORKS = {
+        ## Bitcoin
+        0x00 => { :name => 'Bitcoin', :network => 'mainnet', :symbol => 'BTC', :type => 'Pay-to-PubkeyHash' },
+        0x05 => { :name => 'Bitcoin', :network => 'mainnet', :symbol => 'BTC', :type => 'Pay-to-Script-Hash' },
+        0x6f => { :name => 'Bitcoin', :network => 'testnet3', :symbol => 'XTN', :type => 'Pay-to-PubkeyHash' },
+        0xc4 => { :name => 'Bitcoin', :network => 'testnet3', :symbol => 'XTN', :type => 'Pay-to-Script-Hash' },
+        
+        ## Litecoin
+        0x30 => { :name => 'Litecoin', :network => 'mainnet', :symbol => 'LTC', :type => 'Pay-to-PubkeyHash' },
+        
+        # Litecoin Multisig -> version will be changed after hard-fork
+        # to some number which gives 'M' character in address (probably: 0x31 - 0x33)
+        
+        # 0x05 => { :name => 'Litecoin', :network => 'mainnet', :symbol => 'LTC', :type => 'Pay-to-Script-Hash' },
+        
+        # Litecoin version will be changed probably in similar way like in mainnet
+        
+        # 0x6f => { :name => 'Litecoin', :network => 'testnet', :symbol => 'XLT', :type => 'Pay-to-PubkeyHash' },
+        # 0xc4 => { :name => 'Litecoin', :network => 'testnet', :symbol => 'XLT', :type => 'Pay-to-Script-Hash' },
+        
+        ## Dogecoin
+        0x1e => { :name => 'Dogecoin', :network => 'mainnet', :symbol => 'DOGE', :type => 'Pay-to-PubkeyHash' },
+        0x16 => { :name => 'Dogecoin', :network => 'mainnet', :symbol => 'DOGE', :type => 'Pay-to-Script-Hash' },
+        0x71 => { :name => 'Dogecoin', :network => 'testnet', :symbol => 'XDT', :type => 'Pay-to-PubkeyHash' },
+        #{ 0xc4 => { :name => 'Dogecoin', :network => 'testnet', :symbol => 'XDT', :type => 'Pay-to-Script-Hash' },
+        
+        ## DASH / DRK
+        0x4c => { :name => 'DASH', :network => 'mainnet', :symbol => 'DASH', :type => 'Pay-to-PubkeyHash' },
+        0x10 => { :name => 'DASH', :network => 'mainnet', :symbol => 'DASH', :type => 'Pay-to-Script-Hash' },
+        0x8b => { :name => 'DASH', :network => 'testnet', :symbol => 'tDASH', :type => 'Pay-to-PubkeyHash' },
+        0x13 => { :name => 'DASH', :network => 'testnet', :symbol => 'tDASH', :type => 'Pay-to-Script-Hash' },
+        
+        ## Feathercoin
+        0x0e => { :name => 'Feathercoin', :network => 'mainnet', :symbol => 'FTC', :type => 'Pay-to-PubkeyHash' },
+        0x60 => { :name => 'Feathercoin', :network => 'mainnet', :symbol => 'FTC', :type => 'Pay-to-Script-Hash'  },
+        0x41 => { :name => 'Feathercoin', :network => 'testnet', :symbol => 'FTX', :type => 'Pay-to-PubkeyHash' },
+        #0xc4 => { :name => 'Feathercoin', :network => 'mainnet', :symbol => 'FTX', :type => 'Pay-to-Script-Hash'  },
+        
+        ## Namecoin
+        0x34 => { :name => 'Namecoin', :network => 'mainnet', :symbol => 'NMC', :type => 'Pay-to-PubkeyHash' },
+        #0x6f => { :name => 'Namecoin', :network => 'testnet', :symbol => 'NMC', :type => 'Pay-to-PubkeyHash' },
+  
+        ## Peercoin 
+        0x37 => { :name => 'Peercoin', :network => 'mainnet', :symbol => 'PPC', :type => 'Pay-to-PubkeyHash' },
+        0x75 => { :name => 'Peercoin', :network => 'mainnet', :symbol => 'PPC', :type => 'Pay-to-Script-Hash' },
+        
+        ## Primecoin
+        0x17 => { :name => 'Primecoin', :network => 'mainnet', :symbol => 'XPM', :type => 'Pay-to-PubkeyHash' },
+        0x53 => { :name => 'Primecoin', :network => 'mainnet', :symbol => 'XPM', :type => 'Pay-to-Script-Hash' },
+      }
+      BASE58 = '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz'
+      LENGTH = BASE58.length
+      
+      def is_checksum_valid?(decoded)
+        double_sha256 = (Digest::SHA256.new << (Digest::SHA256.new << [decoded[:h160]].pack('H*')).digest)
+        double_sha256.hexdigest[0, 8] == decoded[:checksum]
+      end
+      
+      def has_valid_length?(address, version)
+        if version == 0
+          return address.length < 35
+        elsif version == 1
+          return address.length == 33
+        elsif version == 2
+          return address.length == 33 || address.length == 34
+        elsif version > 2 && version < 144
+          return address.length == 34
+        elsif version == 144
+          return address.length == 34 || address.length == 35
+        elsif version > 144 && version < 256
+          return address.length == 35
+        else
+          return false
+        end
+      end
+      
+      def b58tos(string)
+        value = 0
+        prefix = 0
+        string.each_char do |char|
+          index = BASE58.index(char)
+          raise ArgumentError, 'String passed as a parameter is not a valid BASE58 string.' if index.nil?
+          value = (value * LENGTH) + index
+          if value == 0
+            prefix += 1
+          end
+        end
+        
+        output = value.to_s(16)
+        
+        # Stupid workaround for missing leading zeros
+        output = "0" + output if (output.length % 2) == 1
+        
+        output = ("00" * prefix) + output if prefix > 0
+        output
+      end
+
+      def decode(string)
+        decoded = b58tos(string)
+        { :version => decoded[0, 2],  :h160 => decoded[0, decoded.length - 8 ], :checksum => decoded[-8, decoded.length] }
+      end
+  end  
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: coins_address_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hothza
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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'
+description: 
+email:
+- hothza@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- coins_address_validator.gemspec
+- lib/coins_address_validator.rb
+- lib/coins_address_validator/version.rb
+homepage: https://github.com/Hothza/coin_address_validator
+licenses:
+- BSD
+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.4.8
+signing_key: 
+specification_version: 4
+summary: CoinsAddressValidator - gem which allows you to check if virtual coin address
+  is valid and retrieve information about it.
+test_files: []