bech32 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1dbf369ac8990456626ab97fbc98580c01a47110
-  data.tar.gz: 6c12e12379890d8a47aec779e19f68c04d0ce919
+SHA256:
+  metadata.gz: 975a0d606b86cdb7487afad52363ef284de471f1530cf7614b0a7db0728dc937
+  data.tar.gz: 1e3d9f3f389cbfd94a8af919a0ec842395605649138bdf3860ac9db2617e3939
 SHA512:
-  metadata.gz: 29940231175f3150e370c4fbe5b9d2955e61673af9bdc953304a61761048047fde43827037b25fa66dea0f4ba28e9a0be080a3aebfa76a7acc9c809f88f1fc50
-  data.tar.gz: 659fd697fc7edcad0645c26768ef6f320dd5db4fdd8e986d2cc19fb3b5df88791d0dc2a7309792576457800a8107034875aca91e445671148b8155f9364472c1
+  metadata.gz: ab8fdc36df45376ea1ec0e7d7553fb6309900d8db824998f327dbfe670451a00ec240bbd75fe59e1bdda2590981d174e0be086756e919582dad55ce5441fe5fb
+  data.tar.gz: 07bf7ac092a89c997932d380a57f30916baa809fd3adf2c86b7418e599949be6fc593b226bcdb7240247fde19d7f092ebdcdd82bfce154adde9d16b5de2df68e

data/.ruby-version

@@ -1 +1 @@
-2.3.0
+ruby-3.0.0

data/.travis.yml

@@ -1,6 +1,9 @@
 language: ruby
 rvm:
-  - 2.1
-  - 2.2.2
-  - 2.3.0
-  - 2.4.0
+  - 2.2.10
+  - 2.3.8
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
+  - 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
 ```
 

data/bech32.gemspec

@@ -1,10 +1,11 @@
 # 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.1"
+  spec.version       = Bech32::VERSION
   spec.authors       = ["Shigeyuki Azuchi"]
   spec.email         = ["azuchi@haw.co.jp"]
 
@@ -18,6 +19,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

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
@@ -16,32 +17,34 @@ module Bech32
 
     # Returns segwit script pubkey which generated from witness version and witness program.
     def to_script_pubkey
-      v = ver == 0 ? ver : ver + 0x80
+      v = ver == 0 ? ver : ver + 0x50
       ([v, prog.length].pack("CC") + prog.map{|p|[p].pack("C")}.join).unpack('H*').first
     end
 
     # 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,3 @@
+module Bech32
+  VERSION = "1.1.0"
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: bech32
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Shigeyuki Azuchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-04 00:00:00.000000000 Z
+date: 2021-02-05 00:00:00.000000000 Z
 dependencies:
 - !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
@@ -60,6 +60,7 @@ files:
 - bin/setup
 - lib/bech32.rb
 - lib/bech32/segwit_addr.rb
+- lib/bech32/version.rb
 homepage: https://github.com/azuchi/bech32rb
 licenses:
 - MIT
@@ -79,8 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: The implementation of Bech32 encoder and decoder.