bech32 1.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d1dbccb1bebbe132f71fac8cdad1a0e8a0beba9e
-  data.tar.gz: cdd71f62ac2d8733815fb59e9d369f13c654d752
+SHA256:
+  metadata.gz: 1556fd0046c912f798c99efd7162f3afc6ca970d618d0ba44dd38c05ab88de75
+  data.tar.gz: fc267a9f2e3344f11f692f7749666ba099a5f5fd73326271c412bc1000fe8616
 SHA512:
-  metadata.gz: 733bf71d25d4344e550c9906c25678370ba23988a92e15955779c2f64d633aa836c6404bcf6ae2f6331d9babb22f25eeba60b454eba5adf785b3dfcd0c1882d5
-  data.tar.gz: 72d15f485dd93fdbb0a9bca2da08eb4aee8ee66fb2df2c2b5cc059c9e2291748fc96032d44f30fb5fd683276959bec0f9b22b5180edc1e3dec1cb72797853faa
+  metadata.gz: 21045a72a45ddf3640801ed9845fa61e758a6199cf492f64cee355bec019f5f0e0a62696e6061aa3479c30d6e566c3e63663f3c8a9838b1bc2ba0e860265f335
+  data.tar.gz: cfb2828365abd683dfeb0af311a583661cd2bc95d0c5af65a09f0d3b5d8cf38215cd95552f903667e4589764030b6a1da65473bc11f762262c63936a72340699

data/.github/workflows/main.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+        # change this to (see https://github.com/ruby/setup-ruby#versioning):
+        # uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rake

data/.ruby-version

@@ -1 +1 @@
-2.4.1
+ruby-3.0.0

data/README.md

@@ -1,11 +1,15 @@
 # Bech32 [![Build Status](https://travis-ci.org/azuchi/bech32rb.svg?branch=master)](https://travis-ci.org/azuchi/bech32rb) [![Gem Version](https://badge.fury.io/rb/bech32.svg)](https://badge.fury.io/rb/bech32) [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE) <img src="http://segwit.co/static/public/images/logo.png" width="100">
 
-The implementation of the Bech32 encoder and decoder for Ruby.
+The implementation of the Bech32/Bech32m encoder and decoder for Ruby.
 
 Bech32 is checksummed base32 format that is used in following Bitcoin address format.
 
 https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki
 
+Bech32m is checksummed base32m format that is used in following Bitcoin address format.
+
+https://github.com/bitcoin/bips/blob/master/bip-0350.mediawiki
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -35,13 +39,15 @@ require 'bech32'
 Decode Bech32-encoded data into hrp part and data part.
 
 ```ruby
-hrp, data = Bech32.decode('BC1QW508D6QEJXTDG4Y5R3ZARVARY0C5XW7KV8F3T4')
+hrp, data, spec = Bech32.decode('BC1QW508D6QEJXTDG4Y5R3ZARVARY0C5XW7KV8F3T4')
 
 # hrp is human-readable part of Bech32 format
 'bc'
 
 # data is data part of Bech32 format
 [0, 14, 20, 15, 7, 13, 26, 0, 25, 18, 6, 11, 13, 8, 21, 4, 20, 3, 17, 2, 29, 3, 12, 29, 3, 4, 15, 24, 20, 6, 14, 30, 22]
+
+# spec is whether Bech32::Encoding::BECH32 or Bech32::Encoding::BECH32M
 ```
 
 Decode Bech32-encoded Segwit address into `Bech32::SegwitAddr` instance.
@@ -55,6 +61,20 @@ segwit_addr.to_script_pubkey
 => 0014751e76e8199196d454941c45d1b3a323f1433bd6
 ```
 
+#### Advanced
+
+The maximum number of characters of Bech32 defined in [BIP-173](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki) is limited to 90 characters.
+However, LN specification [BOLT#11](https://github.com/lightningnetwork/lightning-rfc/blob/master/11-payment-encoding.md) has no limitation.
+
+To decode data of more than 90 characters, specify `max_length` at decode as below. (The default value of `max_length` is 90.)
+
+```ruby
+MAX_INTEGER = 2**31 - 1
+Bech32.decode(bechString, MAX_INTEGER)
+```
+
+Note that between length of the addresses and the error-detection capabilities are [trade-off](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki#checksum-design).
+
 ### Encode
 
 Encode Bech32 human-readable part and data part into Bech32 string.
@@ -63,7 +83,7 @@ Encode Bech32 human-readable part and data part into Bech32 string.
 hrp = 'bc'
 data = [0, 14, 20, 15, 7, 13, 26, 0, 25, 18, 6, 11, 13, 8, 21, 4, 20, 3, 17, 2, 29, 3, 12, 29, 3, 4, 15, 24, 20, 6, 14, 30, 22]
 
-bech = Bech32.encode(hrp, data)
+bech = Bech32.encode(hrp, data, Bech32::Encoding::BECH32)
 => bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4
 ```
 
@@ -78,6 +98,22 @@ segwit_addr.addr
 => bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4
 ```
 
+### CLI
+
+After installing the gem, the `bech32` command will be available. Encoding and decoding features are also available in the cli. 
+
+#### Encode
+
+    $ bech32 encode genesis 000409190707111719041a120308120a060c161408110d091b090009021b1e1d150e190215010d0a1603091e1f0b100609090d1a1c1a13030c120c0c0f1c020d1d1a0e170b1c17021018121e0a021c121a1c0d161b16131d1609130f1d13180f1e081d041d0a110f110d1313081c11100600180b000c08140c1e130e0f090c160e0018191e1d1c0016060c11101214121e19070d1a0c1c15020414001f10100c09090600181806001809080e180507021913031100030216141b100908160c1213120f1912011f07021c13190d1900170c1d1203040f071c1908050504130e080d0a100d130b03000a0a08191310090918120f11031104120c15180c15120a0f1919070c1c12060c1911091010120a0d191b040c1613020e1911081f000b1a0b0514150c1613010d0c1c030b17011805090119061e0b051e130c00030419000112030110181d011a000f020c0901080c1113060201041a0e1b060a15160506181c11140c1c1d0b1b14020c131e0b0f071519181e0b1f0e0a08170f1d0c05060e1c1b0e160c0f0a171d0b101a1a1f1417160e0d1414030e161b0a000709100d15020c000e010c00000000 bech32
+    genesis1qyfe883hey6jrgj2xvk5g3dfmfqfzm7a4wez4pd2krf7ltsxffd6u6nrvjvv0uzda6whtuhzscj72zuj6udkmknakfn0anc07gaya2303dnngu3sxqctqvg5v7nw0fvkwqce7auqkxv3sj5j7e8d6vu4zy5qlssvffxqccxqcfgwc98zenr3qrzk5msfgkvjnj0ejpl8zunedeqhvajry08ueg99ynwgd2sdntrq22gensffcj03r3yjv4cv4j20ee8vujxve3fssj2demyvknzwe3glqt6t954vknpdvurthpc9fpex7t97nvqryeqpjrpscap6q0zvfpgv3nxzpy6wmx24k9xcu35vuatm5zvn7t084ec7tlw2gh0av9xwumwkv02hats66l5hkwd55rwkm2q8fsd4zvqwpvqqqqtdc6rp
+
+# Decode
+
+    $ bech32 decode genesis1qyfe883hey6jrgj2xvk5g3dfmfqfzm7a4wez4pd2krf7ltsxffd6u6nrvjvv0uzda6whtuhzscj72zuj6udkmknakfn0anc07gaya2303dnngu3sxqctqvg5v7nw0fvkwqce7auqkxv3sj5j7e8d6vu4zy5qlssvffxqccxqcfgwc98zenr3qrzk5msfgkvjnj0ejpl8zunedeqhvajry08ueg99ynwgd2sdntrq22gensffcj03r3yjv4cv4j20ee8vujxve3fssj2demyvknzwe3glqt6t954vknpdvurthpc9fpex7t97nvqryeqpjrpscap6q0zvfpgv3nxzpy6wmx24k9xcu35vuatm5zvn7t084ec7tlw2gh0av9xwumwkv02hats66l5hkwd55rwkm2q8fsd4zvqwpvqqqqtdc6rp
+    HRP: genesis
+    DATA: 000409190707111719041a120308120a060c161408110d091b090009021b1e1d150e190215010d0a1603091e1f0b100609090d1a1c1a13030c120c0c0f1c020d1d1a0e170b1c17021018121e0a021c121a1c0d161b16131d1609130f1d13180f1e081d041d0a110f110d1313081c11100600180b000c08140c1e130e0f090c160e0018191e1d1c0016060c11101214121e19070d1a0c1c15020414001f10100c09090600181806001809080e180507021913031100030216141b100908160c1213120f1912011f07021c13190d1900170c1d1203040f071c1908050504130e080d0a100d130b03000a0a08191310090918120f11031104120c15180c15120a0f1919070c1c12060c1911091010120a0d191b040c1613020e1911081f000b1a0b0514150c1613010d0c1c030b17011805090119061e0b051e130c00030419000112030110181d011a000f020c0901080c1113060201041a0e1b060a15160506181c11140c1c1d0b1b14020c131e0b0f071519181e0b1f0e0a08170f1d0c05060e1c1b0e160c0f0a171d0b101a1a1f1417160e0d1414030e161b0a000709100d15020c000e010c00000000
+    TYPE: bech32
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/bech32.gemspec

@@ -1,23 +1,25 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bech32/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "bech32"
-  spec.version       = "1.0.2"
-  spec.authors       = ["Shigeyuki Azuchi"]
-  spec.email         = ["azuchi@haw.co.jp"]
+  spec.name          = 'bech32'
+  spec.version       = Bech32::VERSION
+  spec.authors       = ['Shigeyuki Azuchi']
+  spec.email         = ['techmedia.think@gmail.com']
 
-  spec.summary       = %q{The implementation of Bech32 encoder and decoder.}
-  spec.description   = %q{The implementation of Bech32 encoder and decoder.}
-  spec.homepage      = "https://github.com/azuchi/bech32rb"
-  spec.license       = "MIT"
+  spec.summary       = %q(The implementation of Bech32 encoder and decoder.)
+  spec.description   = %q(The implementation of Bech32 encoder and decoder.)
+  spec.homepage      = 'https://github.com/azuchi/bech32rb'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+  spec.add_runtime_dependency 'thor', '>= 1.1.0'
 
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/exe/bech32

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require 'bech32'
+require 'thor'
+
+class CLI < Thor
+
+  desc 'encode hrp data bech32/bech32m', 'Encoding data to bech32/bech32m string.'
+  def encode(hrp, data, type)
+    if type && !['bech32', 'bech32m'].include?(type)
+      puts 'Invalid type value. type must be bech32 or bech32m.'
+    else
+      spec = type.nil? || type == 'bech32' ? 1 : 2
+      data = [data].pack('H*').unpack('C*')
+      puts Bech32.encode(hrp, data, spec)
+    end
+  end
+
+  desc 'decode "bech32string"', 'Decoding bech32/bech32m string.'
+  def decode(bech32_str)
+    bech32 = Bech32.decode(bech32_str, bech32_str.length)
+    puts <<~EOS
+      HRP: #{bech32[0]}
+      DATA: #{bech32[1].pack('C*').unpack1('H*')}
+      TYPE: #{bech32[2] == Bech32::Encoding::BECH32 ? 'bech32' : 'bech32m'}
+    EOS
+  end
+
+end
+
+CLI.start(ARGV)

data/lib/bech32.rb

@@ -1,66 +1,84 @@
 module Bech32
 
+  module Encoding
+    BECH32 = 1
+    BECH32M = 2
+  end
+
   autoload :SegwitAddr, 'bech32/segwit_addr'
 
   SEPARATOR = '1'
 
   CHARSET = %w(q p z r y 9 x 8 g f 2 t v d w 0 s 3 j n 5 4 k h c e 6 m u a 7 l)
 
+  BECH32M_CONST = 0x2bc830a3
+
   module_function
 
   # Returns the encoded Bech32 string.
   #
   #   require 'bech32'
   #
-  #   bech = Bech32.encode('bc', [])
+  #   bech = Bech32.encode('bc', [], Bech32::Encoding::BECH32)
   #
   #   <i>Generates:</i>
   #   'BC1QW508D6QEJXTDG4Y5R3ZARVARY0C5XW7KV8F3T4' # bech
   #
-  def encode(hrp, data)
-    checksummed = data + create_checksum(hrp, data)
+  def encode(hrp, data, spec)
+    checksummed = data + create_checksum(hrp, data, spec)
     hrp + SEPARATOR + checksummed.map{|i|CHARSET[i]}.join
   end
 
-  # Returns the Bach32 decoded hrp and data.
+  # Returns the Bech32 decoded hrp and data.
   #
   #   require 'bech32'
   #
   #   addr = 'BC1QW508D6QEJXTDG4Y5R3ZARVARY0C5XW7KV8F3T4'
-  #   hrp, data = Bech32.decode(addr)
+  #   hrp, data, spec = Bech32.decode(addr)
   #
   #   <i>Generates:</i>
   #   'bc' # hrp
   #   [0, 14, 20, 15, 7, 13, 26, 0, 25, 18, 6, 11, 13, 8, 21, 4, 20, 3, 17, 2, 29, 3, 12, 29, 3, 4, 15, 24, 20, 6, 14, 30, 22] # data
+  #   1 # spec see Bech32::Encoding
   #
-  def decode(bech)
+  def decode(bech, max_length = 90)
     # check uppercase/lowercase
+    return nil if bech.bytes.index{|x| x < 33 || x > 126}
     return nil if (bech.downcase != bech && bech.upcase != bech)
-    bech.each_char{|c|return nil if c.ord < 33 || c.ord > 126}
     bech = bech.downcase
     # check data length
     pos = bech.rindex(SEPARATOR)
-    return nil if pos.nil? || pos + 7 > bech.length || bech.length > 90
+    return nil if pos.nil? || pos + 7 > bech.length || bech.length > max_length
     # check valid charset
     bech[pos+1..-1].each_char{|c|return nil unless CHARSET.include?(c)}
     # split hrp and data
     hrp = bech[0..pos-1]
     data = bech[pos+1..-1].each_char.map{|c|CHARSET.index(c)}
     # check checksum
-    return nil unless verify_checksum(hrp, data)
-    [hrp, data[0..-7]]
+    spec = verify_checksum(hrp, data)
+    spec ? [hrp, data[0..-7], spec] : nil
   end
 
   # Returns computed checksum values of +hrp+ and +data+
-  def create_checksum(hrp, data)
+  def create_checksum(hrp, data, spec)
     values = expand_hrp(hrp) + data
-    polymod = polymod(values + [0, 0, 0, 0, 0, 0]) ^ 1
+    const = (spec == Bech32::Encoding::BECH32M ? Bech32::BECH32M_CONST : 1)
+    polymod = polymod(values + [0, 0, 0, 0, 0, 0]) ^ const
     (0..5).map{|i|(polymod >> 5 * (5 - i)) & 31}
   end
 
   # Verify a checksum given Bech32 string
+  # @param [String] hrp hrp part.
+  # @param [Array[Integer]] data data array.
+  # @return [Integer] spec
   def verify_checksum(hrp, data)
-    polymod(expand_hrp(hrp) + data) == 1
+    const = polymod(expand_hrp(hrp) + data)
+    case const
+    when 1
+      Encoding::BECH32
+    when BECH32M_CONST
+      Encoding::BECH32M
+    end
   end
 
   # Expand the hrp into values for checksum computation.
@@ -82,4 +100,4 @@ module Bech32
 
   private_class_method :polymod, :expand_hrp
 
-end
+end

data/lib/bech32/segwit_addr.rb

@@ -4,6 +4,7 @@ module Bech32
 
     HRP_MAINNET = 'bc'
     HRP_TESTNET = 'tb'
+    HRP_REGTEST = 'bcrt'
 
     attr_accessor :hrp # human-readable part
     attr_accessor :ver # witness version
@@ -23,25 +24,27 @@ module Bech32
     # parse script pubkey into witness version and witness program
     def script_pubkey=(script_pubkey)
       values = [script_pubkey].pack('H*').unpack("C*")
-      @ver = values[0]
+      @ver = values[0] == 0 ? values[0] : values[0] - 0x50
       @prog = values[2..-1]
     end
 
     # Returns segwit address string which generated from hrp, witness version and witness program.
     def addr
-      Bech32.encode(hrp, [ver] + convert_bits(prog, 8, 5))
+      spec = (ver == 0 ? Bech32::Encoding::BECH32 : Bech32::Encoding::BECH32M)
+      Bech32.encode(hrp, [ver] + convert_bits(prog, 8, 5), spec)
     end
 
     private
 
     def parse_addr(addr)
-      @hrp, data = Bech32.decode(addr)
-      raise 'Invalid address.' if @hrp.nil? || ![HRP_MAINNET, HRP_TESTNET].include?(@hrp)
+      @hrp, data, spec = Bech32.decode(addr)
+      raise 'Invalid address.' if hrp.nil? || data[0].nil? || ![HRP_MAINNET, HRP_TESTNET, HRP_REGTEST].include?(hrp)
       @ver = data[0]
       raise 'Invalid witness version' if @ver > 16
       @prog = convert_bits(data[1..-1], 5, 8, false)
       raise 'Invalid witness program' if @prog.nil? || @prog.length < 2 || @prog.length > 40
       raise 'Invalid witness program with version 0' if @ver == 0 && (@prog.length != 20 && @prog.length != 32)
+      raise 'Witness version and encoding spec do not match' if (@ver == 0 && spec != Bech32::Encoding::BECH32) || (@ver != 0 && spec != Bech32::Encoding::BECH32M)
     end
 
     def convert_bits(data, from, to, padding=true)

data/lib/bech32/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Bech32
+  VERSION = '1.2.0'
+end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: bech32
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Shigeyuki Azuchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-07 00:00:00.000000000 Z
+date: 2021-07-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -40,16 +54,17 @@ dependencies:
         version: '3.0'
 description: The implementation of Bech32 encoder and decoder.
 email:
-- azuchi@haw.co.jp
-executables: []
+- techmedia.think@gmail.com
+executables:
+- bech32
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -58,8 +73,10 @@ files:
 - bech32.gemspec
 - bin/console
 - bin/setup
+- exe/bech32
 - lib/bech32.rb
 - lib/bech32/segwit_addr.rb
+- lib/bech32/version.rb
 homepage: https://github.com/azuchi/bech32rb
 licenses:
 - MIT
@@ -79,8 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: The implementation of Bech32 encoder and decoder.

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 2.1
-  - 2.2.2
-  - 2.3.0
-  - 2.4.0