bech32 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 746f17b48aafeb175a66ea2d5e5d75adcb2a4bc7
+  data.tar.gz: 345ef0c51a1e399871d316e196a7d25e7fa6caf2
+SHA512:
+  metadata.gz: 8b8df48e2f10f6a00e27e3f9f19332e83eacd8aca2659299b24508a59f688ebfad9585a126373396a9e69fab53a3790d99f0d0b732f1d19621a4964fb5cf0aca
+  data.tar.gz: 114e4c62ec06132002b30c17b51884875d475f5d33aaec2c4a73436a331180984f10e644ea3762d0c3d4302d71503fe801fdd7622c9eb9e4b8d8752482ac5c2f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+bech32

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at azuchi@haw.co.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bech32.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Shigeyuki Azuchi
+
+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,83 @@
+# 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)
+
+The implementation of the Bech32 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bech32'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bech32
+
+## Usage
+
+Require the Gem:
+
+```ruby
+require 'bech32'
+```
+
+### Decode
+
+Decode Bech32-encoded data into hrp part and data part.
+
+```ruby
+hrp, data = 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]
+```
+
+Decode Bech32-encoded Segwit address into `Bech32::SegwitAddr` instance.
+
+```ruby
+segwit_addr = Bech32::SegwitAddr.new(addr)
+
+# generate script pubkey
+segwit_addr.to_script_pubkey
+=> 0014751e76e8199196d454941c45d1b3a323f1433bd6
+```
+
+### Encode
+
+Encode Bech32 human-readable part and data part into Bech32 string.
+
+```ruby
+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)
+=> bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4
+```
+
+Encode Segwit script into Bech32 Segwit address.
+
+```ruby
+segwit_addr = Bech32::SegwitAddr.new
+segwit_addr.script_pubkey = '0014751e76e8199196d454941c45d1b3a323f1433bd6'
+
+# generate addr
+segwit_addr.addr
+=> bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4
+```
+
+## 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/bech32.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "bech32"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Shigeyuki Azuchi"]
+  spec.email         = ["azuchi@haw.co.jp"]
+
+  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.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 "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bech32"
+
+# 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

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/lib/bech32.rb

@@ -0,0 +1,85 @@
+module Bech32
+
+  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)
+
+  module_function
+
+  # Returns the encoded Bech32 string.
+  #
+  #   require 'bech32'
+  #
+  #   bech = Bech32.encode('bc', [])
+  #
+  #   <i>Generates:</i>
+  #   'BC1QW508D6QEJXTDG4Y5R3ZARVARY0C5XW7KV8F3T4' # bech
+  #
+  def encode(hrp, data)
+    checksummed = data + create_checksum(hrp, data)
+    hrp + SEPARATOR + checksummed.map{|i|CHARSET[i]}.join
+  end
+
+  # Returns the Bach32 decoded hrp and data.
+  #
+  #   require 'bech32'
+  #
+  #   addr = 'BC1QW508D6QEJXTDG4Y5R3ZARVARY0C5XW7KV8F3T4'
+  #   hrp, data = 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
+  #
+  def decode(bech)
+    # check uppercase/lowercase
+    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
+    # 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]]
+  end
+
+  # Returns computed checksum values of +hrp+ and +data+
+  def create_checksum(hrp, data)
+    values = expand_hrp(hrp) + data
+    polymod = polymod(values + [0, 0, 0, 0, 0, 0]) ^ 1
+    (0..5).map{|i|(polymod >> 5 * (5 - i)) & 31}
+  end
+
+  # Verify a checksum given Bech32 string
+  def verify_checksum(hrp, data)
+    polymod(expand_hrp(hrp) + data) == 1
+  end
+
+  # Expand the hrp into values for checksum computation.
+  def expand_hrp(hrp)
+    hrp.each_char.map{|c|c.ord >> 5} + [0] + hrp.each_char.map{|c|c.ord & 31}
+  end
+
+  # Compute Bech32 checksum
+  def polymod(values)
+    generator = [0x3b6a57b2, 0x26508e6d, 0x1ea119fa, 0x3d4233dd, 0x2a1462b3]
+    chk = 1
+    values.each do |v|
+      top = chk >> 25
+      chk = (chk & 0x1ffffff) << 5 ^ v
+      (0..4).each{|i|chk ^= ((top >> i) & 1) == 0 ? 0 : generator[i]}
+    end
+    chk
+  end
+
+  private_class_method :polymod, :expand_hrp
+
+end

data/lib/bech32/segwit_addr.rb

@@ -0,0 +1,67 @@
+module Bech32
+
+  class SegwitAddr
+    attr_accessor :hrp # human-readable part
+    attr_accessor :ver # witness version
+    attr_accessor :prog # witness program
+
+    def initialize(addr = nil)
+      @hrp = 'bc'
+      parse_addr(addr) if addr
+    end
+
+    # Returns segwit script pubkey which generated from witness version and witness program.
+    def to_script_pubkey
+      v = ver == 0 ? ver : ver + 0x80
+      ([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]
+      @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))
+    end
+
+    private
+
+    def parse_addr(addr)
+      @hrp, data = Bech32.decode(addr)
+      raise 'Invalid address.' if @hrp.nil? || (@hrp != 'bc' && @hrp != 'tb')
+      @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)
+    end
+
+    def convert_bits(data, from, to, padding=true)
+      acc = 0
+      bits = 0
+      ret = []
+      maxv = (1 << to) - 1
+      max_acc = (1 << (from + to - 1)) - 1
+      data.each do |v|
+        return nil if v < 0 || (v >> from) != 0
+        acc = ((acc << from) | v) & max_acc
+        bits += from
+        while bits >= to
+          bits -= to
+          ret << ((acc >> bits) & maxv)
+        end
+      end
+      if padding
+        ret << ((acc << (to - bits)) & maxv) unless bits == 0
+      elsif bits >= from || ((acc << (to - bits)) & maxv) != 0
+        return nil
+      end
+      ret
+    end
+
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: bech32
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Shigeyuki Azuchi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-10 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'
+  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'
+description: The implementation of Bech32 encoder and decoder.
+email:
+- azuchi@haw.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bech32.gemspec
+- bin/console
+- bin/setup
+- lib/bech32.rb
+- lib/bech32/segwit_addr.rb
+homepage: https://github.com/azuchi/bech32rb
+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.5.1
+signing_key: 
+specification_version: 4
+summary: The implementation of Bech32 encoder and decoder.
+test_files: []