base58-alphabets 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93de3aafa549247ab62457454bfcd47c62e718314c8a7ecb6057160c0b317755
-  data.tar.gz: 9e74c2d2b9106b54be273b22a97dff3a8055cd66ac3ce1d85f5b84a18058ba30
+  metadata.gz: 000b32a445c54f6eb556e6b6c3804bfa2d4df87c1caef2ff001b10a714b38403
+  data.tar.gz: 2984225c57d1514eb716eaddfb07d66079ba7edcfacf9f722ecfcf22e84015e0
 SHA512:
-  metadata.gz: 4ce2677b5f3f6f7c8a4f01014cc29d2888c9bcab241576c3780c95c53b9fe70c8796f97f1fcad3acdcf8a6ee35542db4efb4919d5204688c58c25319d95011e6
-  data.tar.gz: da0dabbb21e0c3c98bddf912cadc0a06f31cd52f2a56e06f72cb2f9bb09e8c9bbf3b11398d07a51f64f30070703a6b4ad613e19d72169d9172a376b82536f0cc
+  metadata.gz: 9a71c550deb538e9928a743103435b5ac7c4f544e7d806529a84a52d4e76ff9ee49ccab0d33602a5deff93511dc92dede5e954697aa9cce59eef4c9da3c118dd
+  data.tar.gz: 579c12f8837066b4f4265df52ff36108341a6d290a60d152a195d532171b7fa92cc0d2da58039cd1ce4babe5ab1ac90e85865619cf01ce251193d55cd5b16ead

data/Manifest.txt

@@ -3,4 +3,9 @@ Manifest.txt
 README.md
 Rakefile
 lib/base58-alphabets.rb
+lib/base58-alphabets/base.rb
+lib/base58-alphabets/base58.rb
+lib/base58-alphabets/bitcoin.rb
 lib/base58-alphabets/version.rb
+test/helper.rb
+test/test_base58_bitcoin.rb

data/README.md

@@ -11,6 +11,67 @@ Encode / decode numbers with Bitcoin or Flickr base58 notation / alphabet
 
 
 
+## What's Base 58?
+
+
+> Similar to Base64, but modified to avoid both non-alphanumeric
+> characters (`+` and `/`) and letters which might look ambiguous
+> when printed (`0` - zero, `I` - capital i, `O` - capital o and `l` - lower case L).
+> Satoshi Nakamoto invented the base58 encoding scheme when creating bitcoin.
+> Some messaging and social media systems line break on non-alphanumeric
+> strings. This is avoided by not using URI reserved characters such as `+`.
+>
+> (Source: [Base58 @ Wikipedia](https://en.wikipedia.org/wiki/Binary-to-text_encoding#Base58))
+
+
+
+## Bitcoin
+
+The bitcoin notation / alphabet (`123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz`)
+
+
+Triva Quiz: What characters (digits/letters) are
+missing in the base 56 alphabets?
+
+-  `0` (Zero), `O` (Upper-O), `I` (Upper-I), `l` (Lower-L)
+
+Why use base56 (and not "standard" base64)?
+
+```
+// - Don't want 0OIl characters that look the same in some fonts and
+//      could be used to create visually identical looking account numbers.
+// - A string with non-alphanumeric characters is not as easily accepted as an account number.
+// - E-mail usually won't line-break if there's no punctuation to break at.
+// - Doubleclicking selects the whole number as one word if it's all alphanumeric.
+```
+
+(Source: `base58.h` - Bitcoin Source Code Header Comments)
+
+
+
+### Bitcoin (Base58) Notation
+
+|Num  |Character  |Num  |Character  |Num  |Character  |Num  |Character|
+|----:|----------:|----:|----------:|----:|----------:|----:|--------:|
+| 0   | **1**     |  1  | **2**     |  2  | **3**     |  3  | **4**   |
+| 4   | **5**     |  5  | **6**     |  6  | **7**     |  7  | **8**   |
+| 8   | **9**     |  9  | **A**     |  10 | **B**     |  11 | **C**   |
+| 12  | **D**     |  13 | **E**     |  14 | **F**     |  15 | **G**   |
+| 16  | **H**     |  17 | **J**     |  18 | **K**     |  19 | **L**   |
+| 20  | **M**     |  21 | **N**     |  22 | **P**     |  23 | **Q**   |
+| 24  | **R**     |  25 | **S**     |  26 | **T**     |  27 | **U**   |
+| 28  | **V**     |  29 | **W**     |  30 | **X**     |  31 | **Y**   |
+| 32  | **Z**     |  33 | **a**     |  34 | **b**     |  35 | **c**   |
+| 36  | **d**     |  37 | **e**     |  38 | **f**     |  39 | **g**   |
+| 40  | **h**     |  41 | **i**     |  42 | **j**     |  43 | **k**   |
+| 44  | **m**     |  45 | **n**     |  46 | **o**     |  47 | **p**   |
+| 48  | **q**     |  49 | **r**     |  50 | **s**     |  51 | **t**   |
+| 52  | **u**     |  53 | **v**     |  54 | **w**     |  55 | **x**   |
+| 56  | **y**     |  57 | **z**     |
+
+
+
+
 
 ## License
 

data/lib/base58-alphabets.rb

@@ -6,9 +6,9 @@ require 'pp'
 ## our own code
 require 'base58-alphabets/version'    # note: let version always go first
 
-
-
-
+require 'base58-alphabets/base'
+require 'base58-alphabets/bitcoin'
+require 'base58-alphabets/base58'
 
 
 

data/lib/base58-alphabets/base.rb

@@ -0,0 +1,41 @@
+#########
+#  shared code for formats / variants with single char alphabets
+#    e.g. Bitcoin, Flickr, ...
+
+module Base58
+class Base
+
+  # Converts a base10 integer to a base58 string.
+  def self.encode( num_or_bytes )
+    if num_or_bytes.is_a?( Array )
+      bytes = num_or_bytes
+    else
+      num = num_or_bytes
+      bytes = Base58._bytes( num )
+    end
+
+    bytes.reduce( String.new ) do |buf, byte|
+      buf << alphabet[byte]
+      buf
+    end
+  end
+
+
+  # Converts a base58 string to a base10 integer.
+  def self.decode( str_or_bytes )
+    if str_or_bytes.is_a?( Array )
+      bytes = str_or_bytes
+    else  ## assume string
+      str   = str_or_bytes
+      bytes = str.each_char.reduce([]) do |bytes,char|
+                                         byte = number[char]
+                                         raise ArgumentError, "Value passed not a valid base58 string - >#{char}< not found in alphabet"  if byte.nil?
+                                         bytes << byte
+                                         bytes
+                                       end
+    end
+    Base58._pack( bytes )
+  end
+
+end # class Base
+end # module Base58

data/lib/base58-alphabets/base58.rb

@@ -0,0 +1,85 @@
+module Base58
+
+  BASE = 58    #  ALPHABET.length == 58   ## 58 chars/letters/digits
+
+  class Configuration
+
+     MAPPING = {
+       bitcoin:    Bitcoin,
+       ## flickr:     Flickr,
+     }
+
+     attr_reader :format
+
+     def initialize
+       @format = Bitcoin
+     end
+
+     def format=(value)
+       if value.is_a?( Symbol )
+         @format = MAPPING[ value ]
+       else  ## assume class
+         @format = value
+       end
+     end
+  end # class Configuration
+
+  ## lets you use
+  ##   Base58.configure do |config|
+  ##      config.format     =  :bitcoin
+  ##   end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield( configuration )
+  end
+
+  ## add convenience helper for format
+  def self.format() configuration.format; end
+  def self.format=(value) self.configuration.format = value; end
+
+
+
+
+  def self.encode( num_or_bytes, klass: configuration.format )
+    klass.encode( num_or_bytes )
+  end
+
+  def self.decode( str_or_bytes, klass: configuration.format )
+    klass.decode( str_or_bytes )
+  end
+
+
+
+
+  ####
+  # (private) helper - note: leading underscore in name e.g. _bytes
+  def self._bytes( num )
+    b = []
+    while num >= BASE
+      mod = num % BASE
+      b << mod
+      num = (num - mod) / BASE
+    end
+    b << num
+    b = b.reverse
+    b
+  end
+
+  def self._pack( bytes )
+    num = 0
+    bytes.reverse.each_with_index do |byte,index|
+      num += byte * (BASE**(index))
+    end
+    num
+  end
+
+  ## encoding alphabet - letter-to-number by index / array
+  def self.alphabet( klass: configuration.format ) klass.alphabet; end
+
+  ## decoding letter-to-number mapping / hash
+  def self.number( klass: configuration.format ) klass.number; end
+end # module Base58

data/lib/base58-alphabets/bitcoin.rb

@@ -0,0 +1,85 @@
+
+
+module Base58
+class Bitcoin < Base
+
+ALPHABET = %w[ 1 2 3 4 5 6 7 8 9
+               A B C D E F G H   J K L M N   P Q R S T U V W X Y Z
+               a b c d e f g h i j k   m n o p q r s t u v w x y z ]
+
+
+def self.alphabet() ALPHABET; end    ## add alpha / char aliases - why? why not?
+
+## Note:
+##   for decoding allow (misspelled) l/I for 1  - why? why not?
+##    and               (misspelled) 0/O for o  - why? why not?
+
+
+NUMBER = {
+  '1' => 0,   ## 'l' => 0, 'I' => 0,
+  '2' => 1,
+  '3' => 2,
+  '4' => 3,
+  '5' => 4,
+  '6' => 5,
+  '7' => 6,
+  '8' => 7,
+  '9' => 8,
+  'A' => 9,
+  'B' => 10,
+  'C' => 11,
+  'D' => 12,
+  'E' => 13,
+  'F' => 14,
+  'G' => 15,
+  'H' => 16,
+  'J' => 17,
+  'K' => 18,
+  'L' => 19,
+  'M' => 20,
+  'N' => 21,
+  'P' => 22,
+  'Q' => 23,
+  'R' => 24,
+  'S' => 25,
+  'T' => 26,
+  'U' => 27,
+  'V' => 28,
+  'W' => 29,
+  'X' => 30,
+  'Y' => 31,
+  'Z' => 32,
+  'a' => 33,
+  'b' => 34,
+  'c' => 35,
+  'd' => 36,
+  'e' => 37,
+  'f' => 38,
+  'g' => 39,
+  'h' => 40,
+  'i' => 41,
+  'j' => 42,
+  'k' => 43,
+  'm' => 44,
+  'n' => 45,
+  'o' => 46,   ## '0' => 46, 'O' => 46,
+  'p' => 47,
+  'q' => 48,
+  'r' => 49,
+  's' => 50,
+  't' => 51,
+  'u' => 52,
+  'v' => 53,
+  'w' => 54,
+  'x' => 55,
+  'y' => 56,
+  'z' => 57,
+}
+
+def self.number() NUMBER; end        ## add num alias - why? why not?
+
+## add shortcuts (convenience) aliases
+NUM = NUMBER
+
+end # class Bitcoin
+end # module Base58

data/lib/base58-alphabets/version.rb

@@ -2,8 +2,8 @@
 
 module Base58
   MAJOR = 0
-  MINOR = 0
-  PATCH = 1
+  MINOR = 1
+  PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/test/helper.rb

@@ -0,0 +1,10 @@
+## $:.unshift(File.dirname(__FILE__))
+
+## minitest setup
+
+require 'minitest/autorun'
+
+
+## our own code
+
+require 'base58-alphabets'

data/test/test_base58_bitcoin.rb

@@ -0,0 +1,34 @@
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_base58_bitcoin.rb
+
+
+require 'helper'
+
+
+class TestBase58Bitcoin < MiniTest::Test
+
+
+def test_bitcoin
+  assert_equal "2j",     Base58::Bitcoin.encode( 100 )
+  assert_equal "4fr",    Base58::Bitcoin.encode( 12345 )
+  assert_equal "b2pH",   Base58::Bitcoin.encode( 6639914 )
+
+  assert_equal 100,      Base58::Bitcoin.decode( "2j" )
+  assert_equal 12345,    Base58::Bitcoin.decode( "4fr" )
+  assert_equal 6639914,  Base58::Bitcoin.decode( "b2pH" )
+
+
+  Base58.format = :bitcoin
+  assert_equal "2j",     Base58.encode( 100 )
+  assert_equal "4fr",    Base58.encode( 12345 )
+  assert_equal "b2pH",   Base58.encode( 6639914 )
+
+  assert_equal 100,      Base58.decode( "2j" )
+  assert_equal 12345,    Base58.decode( "4fr" )
+  assert_equal 6639914,  Base58.decode( "b2pH" )
+end
+
+
+
+end  # class TestBase58Bitcoin

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: base58-alphabets
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Gerald Bauer
@@ -59,7 +59,12 @@ files:
 - README.md
 - Rakefile
 - lib/base58-alphabets.rb
+- lib/base58-alphabets/base.rb
+- lib/base58-alphabets/base58.rb
+- lib/base58-alphabets/bitcoin.rb
 - lib/base58-alphabets/version.rb
+- test/helper.rb
+- test/test_base58_bitcoin.rb
 homepage: https://github.com/rubycoco/blockchain
 licenses:
 - Public Domain