base58 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec389588355af34bfc88dd2fcf6e8c551461c546a8bf532413536885d6c0bf5e
-  data.tar.gz: 38755386088de0e65513c6ed888f4a6185cecc2168ba28145d207b4c71f80fb2
+  metadata.gz: 33ccbcef765a46e1e856bc882fc45b75b727de51da69e5bece5e097bc39d1dbd
+  data.tar.gz: 7eb54e225d04709b747c16b1d741b645d7c42b2911dd5da83a4111104b00b26e
 SHA512:
-  metadata.gz: c5bfb539ec0b97fddb1c5ac616461959532fbfffdec768c30ba2c810795984a0a563c3f0fff83447ce1b0bb52d5dad1a6751905f9bee9a2d0bef13248a6b02e3
-  data.tar.gz: 4a2e0bbcbb5d1b95cd70b089080257d49666525d07666f415ae1641d047424cbb60096b1aa06f2dfd115ccd538b037337dae95d5a95877f707601f5b2141b192
+  metadata.gz: d6cb74b302d8f367860fb85bfd0bdc842bb57064a2c852bd03e4fafe215fc850deb3efc4ae98ca21380c8f2939eb92f17886a4a29bcde37b77524292cdbd80fa
+  data.tar.gz: cb77134f325a5ed494727f1f2c5662e1332f57666ee824d74db8929ea7d04990823531b666c4cca3877633a30bc56b8ee75cf1b2d57a72c448c1ec268e57fd47

data/CHANGELOG

@@ -1,3 +1,6 @@
+= 0.2.1 [2017-01-08]
+- Bitcoin-style leading-zeroes encoding. Thanks to @joelnordell.
+
 = 0.2.0 [2017-01-05]
 - Bitcoin and Ripple alphabet support. Thanks to @joelnordell.
 - Binary encoding and decoding support. Thanks to @joelnordell.

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 - 2017 Douglas F Shearer
+Copyright (c) 2009 - 2018 Douglas F Shearer
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -86,6 +86,8 @@ The alphabet used by the [Bitcoin](https://en.wikipedia.org/wiki/Bitcoin) protoc
 
     123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz
 
+See the "Leading Zeros" section for enabling full Bitcoin-style leading-zeros support.
+
 
 ### Ripple
 
@@ -96,6 +98,17 @@ The alphabet used by the [Ripple protocol](https://en.wikipedia.org/wiki/Ripple_
     rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz
 
 
+## Leading Zeroes
+
+Some protocols, such as Bitcoin, require that leading zeros be encoded. Passing `true` to the third argument of binary_to_base58()` will enable this behaviour.
+
+```ruby
+bitcoin_address_hex = '00000000000000000000123456789ABCDEF0'
+bitcoin_address_bin = [bitcoin_address_hex].pack('H*')
+
+Base58.binary_to_base58(bitcoin_address_bin, :bitcoin, true) # => 111111111143c9JGph3DZ
+```
+
 ## Contributing
 
 Source repository is on [Github](https://github.com/dougal/base58), please file issues and pull requests there.
@@ -114,13 +127,13 @@ rake rdoc
 
 ## Credits
 
-  * [Joel Nordell](https://github.com/joelnordell) for Bitcoin and Ripple alphabet support. Also binary encoding support.
+  * [Joel Nordell](https://github.com/joelnordell) for various Bitcoin/Ripple support features.
   * [Jim Myhrberg](https://github.com/jimeh) for argument checking and method aliases.
 
 
 ## Copyright and Licence
 
-Copyright (c) 2009-2018, Douglas F Shearer.
+Copyright (c) 2009 - 2018, Douglas F Shearer.
 
 Base58 is licensed under the MIT Licence.
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/base58.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: base58 0.2.0 ruby lib
+# stub: base58 0.2.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "base58".freeze
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Douglas F Shearer".freeze]
-  s.date = "2018-01-05"
+  s.date = "2018-01-08"
   s.description = "Base58 is a Ruby library for converting ints or binaries to and from base58.".freeze
   s.email = "dougal.s@gmail.com".freeze
   s.extra_rdoc_files = [

data/lib/base58.rb

@@ -1,5 +1,5 @@
 # Base58
-# Copyright (c) 2009 - 2017 Douglas F Shearer.
+# Copyright (c) 2009 - 2018 Douglas F Shearer.
 # http://douglasfshearer.com
 # Distributed under the MIT license as included with this plugin.
 
@@ -40,17 +40,30 @@ class Base58
   end
 
   # Converts a ASCII-8BIT (binary) encoded string to a base58 string.
-  def self.binary_to_base58(binary_val, alphabet = :flickr)
+  def self.binary_to_base58(binary_val, alphabet = :flickr, include_leading_zeroes = true)
     raise ArgumentError, 'Value passed is not a String.' unless binary_val.is_a?(String)
     raise ArgumentError, 'Value passed is not binary.' unless binary_val.encoding == Encoding::BINARY
     raise ArgumentError, 'Invalid alphabet selection.' unless ALPHABETS.include?(alphabet)
-    int_to_base58(binary_val.bytes.inject{|a,b|(a<<8)+b}, alphabet)
+    return int_to_base58(0, alphabet) if binary_val.empty?
+
+    if include_leading_zeroes
+      nzeroes = binary_val.bytes.find_index{|b| b != 0} || binary_val.length-1
+      prefix = ALPHABETS[alphabet][0] * nzeroes
+    else
+      prefix = ''
+    end
+
+    prefix + int_to_base58(binary_val.bytes.inject{|a,b|(a<<8)+b}, alphabet)
   end
 
   # Converts a base58 string to an ASCII-8BIT (binary) encoded string.
+  # All leading zeroes in the base58 input are preserved and converted to
+  # "\x00" in the output.
   def self.base58_to_binary(base58_val, alphabet = :flickr)
     raise ArgumentError, 'Invalid alphabet selection.' unless ALPHABETS.include?(alphabet)
-    [base58_to_int(base58_val, alphabet).to_s(16)].pack('H*')
+    nzeroes = base58_val.chars.find_index{|c| c != ALPHABETS[alphabet][0]} || base58_val.length-1
+    prefix = nzeroes < 0 ? '' : '00' * nzeroes
+    [prefix + base58_to_int(base58_val, alphabet).to_s(16)].pack('H*')
   end
 
   class << self

data/test/test_base58.rb

@@ -551,6 +551,147 @@ EXAMPLES =  {
     }
   }
 
+  LEADING_ZEROES_EXAMPLES = {
+    :bitcoin => [
+      {
+        :hex => "00000000000000000000123456789ABCDEF0",
+        :b58 => "111111111143c9JGph3DZ",
+        :b58_no_zeroes => "43c9JGph3DZ"
+      },
+      {
+        :hex => "00000000000000000000",
+        :b58 => "1111111111",
+        :b58_no_zeroes => "1"
+      },
+      {
+        :hex => "00",
+        :b58 => "1",
+        :b58_no_zeroes => "1"
+      },
+      {
+        :hex => "",
+        :b58 => "1",
+        :b58_no_zeroes => "1"
+      },
+    ],
+    :flickr => [
+      {
+        :hex => "00000000000000000000123456789ABCDEF0",
+        :b58 => "111111111143B9igPG3dy",
+        :b58_no_zeroes => "43B9igPG3dy"
+      },
+      {
+        :hex => "00000000000000000000",
+        :b58 => "1111111111",
+        :b58_no_zeroes => "1"
+      },
+      {
+        :hex => "00",
+        :b58 => "1",
+        :b58_no_zeroes => "1"
+      },
+      {
+        :hex => "",
+        :b58 => "1",
+        :b58_no_zeroes => "1"
+      },
+    ],
+    :ripple => [
+      {
+        :hex => "00000000000000000000123456789ABCDEF0",
+        :b58 => "rrrrrrrrrrhsc9JGF6sDZ",
+        :b58_no_zeroes => "hsc9JGF6sDZ"
+      },
+      {
+        :hex => "00000000000000000000",
+        :b58 => "rrrrrrrrrr",
+        :b58_no_zeroes => "r"
+      },
+      {
+        :hex => "00",
+        :b58 => "r",
+        :b58_no_zeroes => "r"
+      },
+      {
+        :hex => "",
+        :b58 => "r",
+        :b58_no_zeroes => "r"
+      }
+    ]
+  }
+
+  HEX_TO_BIN = ->hex { [hex].pack('H*') }
+  HEX_TO_INT = ->hex { hex.to_i(16) }
+
+  STRIP_LEADING = ->char { ->str { str.gsub(/^#{char}*/, '') } }
+  STRIP_BINARY = STRIP_LEADING["\x00"]
+
+  LEADING_ZEROES_EXAMPLES.each do |alphabet, examples|
+    examples.each do |example|
+      define_method("test_binary_to_base58_leading_zeroes_#{alphabet}_#{example[:hex]}") do
+        bin = HEX_TO_BIN[example[:hex]]
+        bin_no_zeroes = STRIP_BINARY[bin]
+
+        assert_equal example[:b58], Base58.binary_to_base58(bin, alphabet) # Default behavior is to include leading zeroes
+        assert_equal example[:b58], Base58.binary_to_base58(bin, alphabet, true)
+        assert_equal example[:b58_no_zeroes], Base58.binary_to_base58(bin, alphabet, false) # Optionally, leading zeroes may be omitted
+
+        # If there are no zeroes in the input, there are never zeroes in the output
+        assert_equal example[:b58_no_zeroes], Base58.binary_to_base58(bin_no_zeroes, alphabet)
+        assert_equal example[:b58_no_zeroes], Base58.binary_to_base58(bin_no_zeroes, alphabet, true)
+        assert_equal example[:b58_no_zeroes], Base58.binary_to_base58(bin_no_zeroes, alphabet, false)
+      end
+    end
+  end
+
+  LEADING_ZEROES_EXAMPLES.each do |alphabet, examples|
+    examples.each do |example|
+      define_method("test_base58_to_binary_leading_zeroes_#{alphabet}_#{example[:hex]}") do
+        bin = HEX_TO_BIN[example[:hex]]
+        bin_no_zeroes = STRIP_BINARY[bin]
+
+        # When converting from base58, an empty string will never be produced.
+        bin_no_zeroes = "\x00" if bin_no_zeroes.empty?
+        bin = "\x00" if bin.empty?
+
+        assert_equal bin, Base58.base58_to_binary(example[:b58], alphabet)
+        assert_equal bin_no_zeroes, Base58.base58_to_binary(example[:b58_no_zeroes], alphabet)
+      end
+    end
+  end
+
+  LEADING_ZEROES_EXAMPLES.each do |alphabet, examples|
+    examples.each do |example|
+      define_method("test_int_to_base58_leading_zeroes_#{alphabet}_#{example[:hex]}") do
+        assert_equal example[:b58_no_zeroes], Base58.int_to_base58(HEX_TO_INT[example[:hex]], alphabet)
+      end
+    end
+  end
+
+  LEADING_ZEROES_EXAMPLES.each do |alphabet, examples|
+    examples.each do |example|
+      define_method("test_base58_to_int_leading_zeroes_#{alphabet}_#{example[:hex]}") do
+        assert_equal HEX_TO_INT[example[:hex]], Base58.base58_to_int(example[:b58], alphabet)
+        assert_equal HEX_TO_INT[example[:hex]], Base58.base58_to_int(example[:b58_no_zeroes], alphabet)
+      end
+    end
+  end
+
+  def test_base58_to_binary_empty_input
+    assert_equal "\x00", Base58.base58_to_binary("")
+  end
+
+  def test_base58_to_int_leading_zeroes_other_examples
+    # All other examples, when prepended with varying amounts of leading zeroes, should work properly.
+    EXAMPLES.each do |alphabet, examples|
+      examples.each do |base_58, expected|
+        (0..50).each do |n|
+          assert_equal expected, Base58.base58_to_int( (Base58::ALPHABETS[alphabet][0] * n) + base_58, alphabet )
+        end
+      end
+    end
+  end
+
   def test_binary_to_base58_all_alphabets
     BINARY_STRING_EXAMPLES.each do |alphabet, examples|
       examples.each do |expected, integer|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: base58
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Douglas F Shearer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-05 00:00:00.000000000 Z
+date: 2018-01-08 00:00:00.000000000 Z
 dependencies: []
 description: Base58 is a Ruby library for converting ints or binaries to and from
   base58.