cashaddress 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 657f955260080576cc0fb9031bc36f5ae4b67bd0
+  data.tar.gz: f71f4aeccc2c5db452697c657bb302db084d1f88
+SHA512:
+  metadata.gz: 8f558e7b8331a7e8e38d228dbd73616e7120b1895da98b930eff5dd0e48c775e7d72014eb290890469f4319bfcca15ec21654ee1f3d0855f4e8dbfb71fa6a325
+  data.tar.gz: cb07eb8951d5e6d922fd20f25c7ee0bfc8fd609fc29aa19c20cf4cdb175e702c874c3e2787eedaecd256cc5f969715cf54ff9938951e63c8d8a5b975bae37a2e

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.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 cashaddress.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 nubis
+
+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,42 @@
+# Cashaddress
+
+Converts between bitcoin cash cashaddress and legacy bitcoin address format.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cashaddress'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cashaddress
+
+## Usage
+
+```ruby
+   > Cashaddress.from_legacy('1BpEi6DfDAUFd7GtittLSdBeYJvcoaVggu')
+   => 'bitcoincash:qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a',
+   > Cashaddress.to_legacy('bitcoincash:qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a')
+   => '1BpEi6DfDAUFd7GtittLSdBeYJvcoaVggu'
+```
+
+## 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/bitex-la/cashaddress-ruby
+
+## 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,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 "cashaddress"
+
+# 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/cashaddress.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cashaddress/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cashaddress"
+  spec.version       = Cashaddress::VERSION
+  spec.authors       = ["nubis"]
+  spec.email         = ["yo@nubis.im"]
+
+  spec.summary       = %q{Convert between bitcoin legacy and cashaddress format}
+  spec.description   = %q{Converts between bitcoin legacy and cashaddress formats}
+  spec.homepage      = "https://github.com/bitex-la/cashaddress-ruby"
+  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_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
+end

data/lib/cashaddress.rb

@@ -0,0 +1,193 @@
+require "cashaddress/version"
+require 'digest'
+
+module Cashaddress
+  def self.to_lookup(array)
+    Hash[*array.each_with_index.to_a.flatten]
+  end
+
+  CHARSET = "qpzry9x8gf2tvdw0s3jn54khce6mua7l".split('')
+  CHARSET_LOOKUP = to_lookup(CHARSET)
+  
+  # ALPHABET is missing some confusing characters like O and I
+  ALPHABET = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz".split('')
+  ALPHABET_LOOKUP = to_lookup(ALPHABET)
+  
+  MAINNET_PREFIX = [2, 9, 20, 3, 15, 9, 14, 3, 1, 19, 8, 0]
+  TESTNET_PREFIX = [2, 3, 8, 20, 5, 19, 20, 0]
+
+  def self.to_legacy(cashaddress)
+    unless match = /(.+?):(.+)/.match(cashaddress)
+      raise Error.new("Malformed cashaddress: #{cashaddress}")
+    end
+    
+    is_mainnet = match.captures.first == 'bitcoincash'
+    prefix = is_mainnet ? MAINNET_PREFIX.clone : TESTNET_PREFIX.clone
+    raw_payload = match.captures.last.split('').map{|m| CHARSET_LOOKUP[m] }
+    
+    if polymod(prefix + raw_payload) != 0
+      raise Error.new("Address checksum invalid: #{cashaddress}")
+    end
+    
+    payload = convert_bits(raw_payload[0..-9], 5, 8, false)
+    if payload.empty?
+      raise Error.new("Converted payload was empty")
+    end
+    
+    version = if (payload.first >> 3) == 0
+      is_mainnet ? 0x00 : 0x6f
+    else
+      is_mainnet ? 0x05 : 0xc4
+    end
+
+    make_old_address(payload[1..21], version)
+  end
+
+  def self.make_old_address(payload, version)
+    raw = [version] + payload
+    digest = Digest::SHA256.digest(Digest::SHA256.digest(raw.pack("C*"))).unpack('C*')
+    encode_base58( raw + digest[0..3] )
+  end
+  
+  def self.encode_base58(bytes)
+    digits = [0]
+    bytes.each do |byte|
+      carry = byte
+      digits.each_with_index do |digit, index|
+        carry += digit << 8
+        digits[index] = carry % 58
+        carry = ( carry / 58 ) | 0
+      end
+      
+      while carry > 0 
+        digits << carry % 58
+        carry = (carry / 58) | 0
+      end
+    end
+    
+    encoded = ''
+    bytes.each do |byte|
+      break if byte != 0
+      encoded << "1"
+    end
+    
+    encoded << digits.reverse.map{|d| ALPHABET[d] }.join('')
+
+    encoded 
+  end
+
+  def self.from_legacy(legacy_address)
+    bytes = [0]
+    characters = legacy_address.split('')
+
+    characters.each_with_index do |char, i|
+      unless value = ALPHABET_LOOKUP[char]
+        raise Error.new("Invalid char #{char}")
+      end
+
+      carry = value
+      bytes.each_with_index do |byte, j|
+        carry += byte * 58
+        bytes[j] = carry & 0xff
+        carry = carry >> 8
+      end
+
+      while carry > 0
+        bytes << ( carry & 0xff )
+        carry = carry >> 8
+      end
+    end
+
+    characters.each do |char|
+      break if char != "1"
+      bytes << 0
+    end
+    
+    if bytes.size < 5
+      raise Error.new("Decoded less than 5 bytes from #{legacy_address}")
+    end
+    
+    bytes = bytes.reverse
+    version = bytes.first
+
+    digest = Digest::SHA256.digest(Digest::SHA256.digest(bytes[0..-5].pack("C*"))).unpack('C*')
+
+    if digest[0..3] != bytes[-4..-1]
+      raise Error.new("Invalid checksum")
+    end
+
+    kind, is_main_net = case version
+      when 0x00, 0x1c then [0, true]
+      when 0x05, 0x28 then [1, true]
+      when 0x6f then [0, false]
+      when 0xc4 then [1, false]
+      else raise Error.new("Unexpected version #{version}")
+    end
+
+    make_cashaddress(kind, bytes[1..-5], is_main_net)
+  end
+
+  def self.make_cashaddress(kind, hash, main_net)
+    packed = convert_bits( [ kind << 3] + hash, 8, 5, true)
+    raise Error.new("Can't pack Cashaddress") unless packed
+
+    prefix = main_net ? MAINNET_PREFIX.clone : TESTNET_PREFIX.clone
+    encoded = prefix.concat(packed)
+    moduled = polymod(encoded + [0] * 8)
+    checksum = 8.times.map do |i|
+      shifted = ('%0*b' % [ 5 * (i+1), moduled >> ( 5 * (7-i))])[-5..-1]
+        .split('').map(&:to_i)
+      to_five_bit_array(shifted).first
+    end
+
+    address = main_net ? "bitcoincash:" : "bchtest:"
+
+    address << (packed + checksum).map{|b| CHARSET[b] }.join('')
+
+    if address.size != 54 && address.size != 50
+      raise Error.new("Address is not 50 or 54 characters long #{address}")
+    end
+    
+    address
+  end
+
+  def self.to_five_bit_array(array)
+    array.each_slice(5).collect do |slice|
+      slice.zip([16, 8, 4, 2, 1]).map{|a,b| a * b}.sum
+    end
+  end
+
+  def self.convert_bits(data, from, to, pad)
+    converted = data
+      .map{|i| '%0*b' % [from, i] } # Get chunks <from> bits long
+      .join('') # In a long row of zeros and ones.
+      .chars.each_slice(to) # Then in bits that are <
+      .map{|bits| bits.join('').ljust(to, '0').to_i(2) }
+    
+    converted = converted[0..-2] if converted.last == 0 && !pad
+    converted
+  end
+
+  # Polymod checksum is defined in the cashaddr spec
+  # https://github.com/Bitcoin-UAHF/spec/blob/master/cashaddr.md
+  def self.polymod(vector)
+    accum = 1
+    vector.each do |byte|
+      pivot = accum >> 35
+      accum = ((accum & 0x07ffffffff) << 5) ^ byte
+  
+      [
+       [0x01, 0x98f2bc8e61],
+       [0x02, 0x79b76d99e2],
+       [0x04, 0xf33e5fb3c4],
+       [0x08, 0xae2eabe2a8],
+       [0x10, 0x1e4f43e470],
+      ].each do |bit, mask|
+        accum ^= mask if (pivot & bit) != 0
+      end
+    end
+    accum ^ 1
+  end
+
+  class Error < StandardError; end;
+end

data/lib/cashaddress/version.rb

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

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: cashaddress
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nubis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-18 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: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Converts between bitcoin legacy and cashaddress formats
+email:
+- yo@nubis.im
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cashaddress.gemspec
+- lib/cashaddress.rb
+- lib/cashaddress/version.rb
+homepage: https://github.com/bitex-la/cashaddress-ruby
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Convert between bitcoin legacy and cashaddress format
+test_files: []