money-tree 0.10.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6b1fd18c035198917d9939d44f6bcbbe4ae69ef168af5de52ab32f5778662b1
-  data.tar.gz: 31ef2d35cd3d2f10cf40d7fe44787a38857c1c79173494f97d0d296f7828bfba
+  metadata.gz: a817c56d0f39bc09f84b1dd02d9e828a9b3fd4d93500d7f6e9cd4ead322c7355
+  data.tar.gz: 1e8de14764b5ddf911769e537b99eb4b9f3ce2e91e6dff9ffc2cef923214d156
 SHA512:
-  metadata.gz: 03c0b6c55c8f290f10989870d559904a644a68f441cc0ae6498d9cde12bc4853f63babc6ce68d5ad1dfbfb3f6a67b0b4b400053fdddacb62faa9d01adc43f765
-  data.tar.gz: 8c37b6e7386c60be7ac9797a248039b88ff39b0f46438a07c46aa363b8c8fa30160cdeb0f6d5d54f92fc0b512f437e6a73488cc12e355c25b04fb9dcb7af5d33
+  metadata.gz: d2d89e5ffa65f7781a7ff35c830da95614b22e743a24ce5662f4f952dd18685ba9b5a18078fb5bc0a45c1527bb66e32473a5d8453a0a87026e7d5625dbd940d0
+  data.tar.gz: 1355fe75f77593dec9c191e9c1d91f4a1f5205fe8e6f01600298311a17c070f25002c8ed0889166125b5879ce9b03675e476f2cf64b5a6f03e19b01886a4506f

data/.github/workflows/spec.yml

@@ -0,0 +1,33 @@
+---
+name: Spec
+
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: ['2.7', '3.0']
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: false
+    - name: Install Dependencies
+      run: |
+        bundle install
+    - name: Run Tests
+      run: |
+        bundle exec rspec
+      env:
+        COVERAGE: true

data/Gemfile

@@ -1,4 +1,16 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in money-tree.gemspec
-gemspec
+gem "openssl", "~> 3.0"
+gem "bech32", "~> 1.2"
+
+group :test, :development do
+  gem "bundler", "~> 2.2"
+  gem "codecov", "~> 0.6"
+  gem "pry", "~> 0.14"
+  gem "rake", "~> 13.0"
+  gem "rdoc", "~> 6.3"
+  gem "rspec", "~> 3.10"
+  gem "rufo", "~> 0.13"
+  gem "simplecov", "~> 0.21"
+  gem "yard", "~> 0.9"
+end

data/README.md

@@ -1,13 +1,23 @@
-[![Build Status](https://travis-ci.org/GemHQ/money-tree.png)](https://travis-ci.org/GemHQ/money-tree) [![Coverage Status](https://img.shields.io/coveralls/GemHQ/money-tree.svg)](https://coveralls.io/r/GemHQ/money-tree?branch=master) [![Code Climate](https://codeclimate.com/github/GemHQ/money-tree.png)](https://codeclimate.com/github/GemHQ/money-tree) [![Gem Version](https://badge.fury.io/rb/money-tree.png)](http://badge.fury.io/rb/money-tree)
 # MoneyTree
+
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/GemHQ/money-tree)](https://github.com/GemHQ/money-tree/releases)
+[![Gem](https://img.shields.io/gem/v/money-tree)](https://rubygems.org/gems/money-tree)
+[![Gem](https://img.shields.io/gem/dt/money-tree)](https://rubygems.org/gems/money-tree)
+[![GitHub top language](https://img.shields.io/github/languages/top/GemHQ/money-tree?color=red)](https://github.com/GemHQ/money-tree/pulse)
+
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/GemHQ/money-tree/Spec)](https://github.com/GemHQ/money-tree/actions)
+[![Code Coverage](https://codecov.io/gh/GemHQ/money-tree/branch/master/graph/badge.svg?token=PF4BL36Z9q)](https://codecov.io/gh/GemHQ/money-tree)
+[![Code Climate](https://codeclimate.com/github/GemHQ/money-tree.png)](https://codeclimate.com/github/GemHQ/money-tree)
+[![GitHub](https://img.shields.io/github/license/GemHQ/money-tree)](LICENSE)
+
 ### RSpec tested. Big Brother removed.
 
 MoneyTree is a Ruby implementation of Bitcoin Wallets. Specifically, it supports [Hierachical Deterministic wallets](https://en.bitcoin.it/wiki/Deterministic_Wallet) according to the protocol specified in [BIP0032](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki).
 
 ___
-If you find this helpful, please consider a small Bitcoin donation to 1nj2kie1hATcFbAaD7dEY53QaxNgt4KBp
+If you find this helpful, please consider a small Bitcoin donation to `1nj2kie1hATcFbAaD7dEY53QaxNgt4KBp`.
 
-![Donate BTC](https://raw.github.com/wink/money-tree/master/donation_btc_qr_code.gif)
+![Donate BTC](./.github/donation_btc_qr_code.gif)
 ___
 
 ## Why would I want an HD Wallet?
@@ -163,7 +173,7 @@ Because we need multiple pieces of info to reconstruct nodes in a tree, when we'
 "xpub661MyMwAqRbcFtXgS5sYJABqqG9YLmC4Q1Rdap9gSE8NqtwybGhePY2gZ29ESFjqJoCu1Rupje8YtGqsefD265TMg7usUDFdp6W1EGMcet8"
 ```
 
-In addition to the key and the chain code, this encoding also includes info about the depth and index of the key, along with a fingerprint of its parent key (which I presume is for quickly sorting a big pile of keys into a tree).   
+In addition to the key and the chain code, this encoding also includes info about the depth and index of the key, along with a fingerprint of its parent key (which I presume is for quickly sorting a big pile of keys into a tree).
 
 These are the addresses that you should use to represent each node in the tree structure, however these are NOT the bitcoin addresses you should pass around for receiving money. These are more for storing inside a wallet file so that you can reconstruct the tree.
 

data/Rakefile

@@ -1,6 +1,6 @@
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task :default => :spec

data/checksum/money-tree-0.11.0.gem.sha512

@@ -0,0 +1 @@
+cc59abeb70c300eb32c0562dea582de4d26da71cb3fac9937fb3b88fd7092177c98ccbdf6eba7517c3dbc14b33f15e95bf799a02adfec5c12583cb9179c68bb7

data/checksum/money-tree-0.9.0.gem.sha512

@@ -1 +1 @@
-ce3c7dc0fe6817aee65f990c7a97f89fd36c94380ac804c7579554d665a934df99d4e72ee9b2e467efcc76799a20c4d1de4c950bbba3512d42260c38a46e54b9
+ce3c7dc0fe6817aee65f990c7a97f89fd36c94380ac804c7579554d665a934df99d4e72ee9b2e467efcc76799a20c4d1de4c950bbba3512d42260c38a46e54b9

data/lib/money-tree/address.rb

@@ -1,16 +1,26 @@
 module MoneyTree
   class Address
-    attr_reader :private_key, :public_key
-    
+    attr_reader :private_key
+    attr_reader :public_key
+
     def initialize(opts = {})
       private_key = opts.delete(:private_key)
-      @private_key = MoneyTree::PrivateKey.new({ key: private_key }.merge(opts))
-      @public_key = MoneyTree::PublicKey.new(@private_key, opts)
+      @private_key = PrivateKey.new({ key: private_key }.merge(opts))
+      @public_key = PublicKey.new(@private_key, opts)
     end
-    
+
     def to_s(network: :bitcoin)
-      public_key.to_s(network: network)
+      @public_key.to_s(network: network)
     end
 
+    def to_bech32(network: :bitcoin)
+      hrp = NETWORKS[network][:human_readable_part]
+      witprog = @public_key.to_ripemd160
+      Support.to_serialized_bech32(hrp, witprog)
+    end
+
+    def to_p2wpkh_p2sh(network: :bitcoin)
+      @public_key.to_p2wpkh_p2sh(network: network)
+    end
   end
 end

data/lib/money-tree/key.rb

@@ -1,12 +1,11 @@
 # encoding ascii-8bit
 
-require 'openssl'
+require "openssl"
 
 module MoneyTree
   class Key
-    include OpenSSL
     include Support
-    extend Support
+
     class KeyInvalid < StandardError; end
     class KeyGenerationFailure < StandardError; end
     class KeyImportFailure < StandardError; end
@@ -14,10 +13,13 @@ module MoneyTree
     class InvalidWIFFormat < StandardError; end
     class InvalidBase64Format < StandardError; end
 
-    attr_reader :options, :key, :raw_key
+    attr_reader :options
+    attr_reader :key
+    attr_reader :raw_key
+
     attr_accessor :ec_key
 
-    GROUP_NAME = 'secp256k1'
+    GROUP_NAME = "secp256k1"
     ORDER = "fffffffffffffffffffffffffffffffebaaedce6af48a03bbfd25e8cd0364141".to_i(16)
 
     def valid?(eckey = nil)
@@ -35,7 +37,6 @@ module MoneyTree
   end
 
   class PrivateKey < Key
-
     def initialize(opts = {})
       @options = opts
       @ec_key = PKey::EC.new GROUP_NAME
@@ -70,14 +71,9 @@ module MoneyTree
     end
 
     def parse_raw_key
-      result = if raw_key.is_a?(Integer) then from_integer
-      elsif hex_format? then from_hex
-      elsif base64_format? then from_base64
-      elsif compressed_wif_format? then from_wif
-      elsif uncompressed_wif_format? then from_wif
-      else
-        raise KeyFormatNotFound
-      end
+      result = if raw_key.is_a?(Integer) then from_integer elsif hex_format? then from_hex elsif base64_format? then from_base64 elsif compressed_wif_format? then from_wif elsif uncompressed_wif_format? then from_wif else
+          raise KeyFormatNotFound
+        end
       result.downcase
     end
 
@@ -113,7 +109,7 @@ module MoneyTree
 
     def wif_format?(compression)
       length = compression == :compressed ? 52 : 51
-      wif_prefixes = MoneyTree::NETWORKS.map {|k, v| v["#{compression}_wif_chars".to_sym]}.flatten
+      wif_prefixes = MoneyTree::NETWORKS.map { |k, v| v["#{compression}_wif_chars".to_sym] }.flatten
       raw_key.length == length && wif_prefixes.include?(raw_key.slice(0))
     end
 
@@ -160,7 +156,6 @@ module MoneyTree
     def to_s(network: :bitcoin)
       to_wif(network: network)
     end
-
   end
 
   class PublicKey < Key
@@ -209,19 +204,19 @@ module MoneyTree
       self.compression = opts[:compressed] ? :compressed : :uncompressed
       bn = BN.new int_to_hex(int), 16
       @point = PKey::EC::Point.new group, bn
-      raise KeyInvalid, 'point is not on the curve' unless @point.on_curve?
+      raise KeyInvalid, "point is not on the curve" unless @point.on_curve?
     end
 
     def parse_raw_key
       result = if raw_key.is_a?(Integer)
-        set_point raw_key
-      elsif hex_format?
-        set_point hex_to_int(raw_key), compressed: false
-      elsif compressed_hex_format?
-        set_point hex_to_int(raw_key), compressed: true
-      else
-        raise KeyFormatNotFound
-      end
+          set_point raw_key
+        elsif hex_format?
+          set_point hex_to_int(raw_key), compressed: false
+        elsif compressed_hex_format?
+          set_point hex_to_int(raw_key), compressed: true
+        else
+          raise KeyFormatNotFound
+        end
       to_hex
     end
 
@@ -251,8 +246,20 @@ module MoneyTree
       address = NETWORKS[network][:address_version] + hash
       to_serialized_base58 address
     end
+
     alias :to_s :to_address
 
+    def to_p2wpkh_p2sh(network: :bitcoin)
+      prefix = [NETWORKS[network][:p2sh_version]].pack("H*")
+      convert_p2wpkh_p2sh(to_hex, prefix)
+    end
+
+    def to_bech32_address(network: :bitcoin)
+      hrp = NETWORKS[network][:human_readable_part]
+      witprog = to_ripemd160
+      to_serialized_bech32(hrp, witprog)
+    end
+
     def to_fingerprint
       hash = to_ripemd160
       hash.slice(0..7)

data/lib/money-tree/networks.rb

@@ -1,33 +1,34 @@
 module MoneyTree
-  NETWORKS =
-    begin
+  NETWORKS = begin
       hsh = Hash.new do |_, key|
         raise "#{key} is not a valid network!"
       end.merge(
         bitcoin: {
-          address_version: '00',
-          p2sh_version: '05',
-          p2sh_char: '3',
-          privkey_version: '80',
-          privkey_compression_flag: '01',
+          address_version: "00",
+          p2sh_version: "05",
+          p2sh_char: "3",
+          privkey_version: "80",
+          privkey_compression_flag: "01",
           extended_privkey_version: "0488ade4",
           extended_pubkey_version: "0488b21e",
           compressed_wif_chars: %w(K L),
           uncompressed_wif_chars: %w(5),
-          protocol_version: 70001
+          protocol_version: 70001,
+          human_readable_part: "bc",
         },
         bitcoin_testnet: {
-          address_version: '6f',
-          p2sh_version: 'c4',
-          p2sh_char: '2',
-          privkey_version: 'ef',
-          privkey_compression_flag: '01',
+          address_version: "6f",
+          p2sh_version: "c4",
+          p2sh_char: "2",
+          privkey_version: "ef",
+          privkey_compression_flag: "01",
           extended_privkey_version: "04358394",
           extended_pubkey_version: "043587cf",
           compressed_wif_chars: %w(c),
           uncompressed_wif_chars: %w(9),
-          protocol_version: 70001
-        }
+          protocol_version: 70001,
+          human_readable_part: "tb",
+        },
       )
       hsh[:testnet3] = hsh[:bitcoin_testnet]
       hsh

data/lib/money-tree/node.rb

@@ -2,8 +2,14 @@ module MoneyTree
   class Node
     include Support
     extend Support
-    attr_reader :private_key, :public_key, :chain_code,
-      :is_private, :depth, :index, :parent
+
+    attr_reader :private_key
+    attr_reader :public_key
+    attr_reader :chain_code
+    attr_reader :is_private
+    attr_reader :depth
+    attr_reader :index
+    attr_reader :parent
 
     class PublicDerivationFailure < StandardError; end
     class InvalidKeyForIndex < StandardError; end
@@ -21,26 +27,21 @@ module MoneyTree
         depth: hex.slice!(0..1).to_i(16),
         parent_fingerprint: hex.slice!(0..7),
         index: hex.slice!(0..7).to_i(16),
-        chain_code: hex.slice!(0..63).to_i(16)
+        chain_code: hex.slice!(0..63).to_i(16),
       }.merge(parse_out_key(hex)))
     end
 
-    def self.from_serialized_address(address)
-      puts 'Node.from_serialized_address is DEPRECATED. Please use .from_bip32 instead.'
-      from_bip32(address)
-    end
-
     def self.parse_out_key(hex)
-      if hex.slice(0..1) == '00'
+      if hex.slice(0..1) == "00"
         private_key = MoneyTree::PrivateKey.new(key: hex.slice(2..-1))
         {
           private_key: private_key,
-          public_key: MoneyTree::PublicKey.new(private_key)
+          public_key: MoneyTree::PublicKey.new(private_key),
         }
       elsif %w(02 03).include? hex.slice(0..1)
         { public_key: MoneyTree::PublicKey.new(hex) }
       else
-        raise ImportError, 'Public or private key data does not match version type'
+        raise ImportError, "Public or private key data does not match version type"
       end
     end
 
@@ -50,7 +51,7 @@ module MoneyTree
 
     def index_hex(i = index)
       if i < 0
-        [i].pack('l>').unpack('H*').first
+        [i].pack("l>").unpack("H*").first
       else
         i.to_s(16).rjust(8, "0")
       end
@@ -69,16 +70,16 @@ module MoneyTree
     end
 
     def i_as_bytes(i)
-      [i].pack('N')
+      [i].pack("N")
     end
 
     def derive_private_key(i = 0)
       message = i >= 0x80000000 || i < 0 ? private_derivation_message(i) : public_derivation_message(i)
       hash = hmac_sha512 hex_to_bytes(chain_code_hex), message
       left_int = left_from_hash(hash)
-      raise InvalidKeyForIndex, 'greater than or equal to order' if left_int >= MoneyTree::Key::ORDER # very low probability
+      raise InvalidKeyForIndex, "greater than or equal to order" if left_int >= MoneyTree::Key::ORDER # very low probability
       child_private_key = (left_int + private_key.to_i) % MoneyTree::Key::ORDER
-      raise InvalidKeyForIndex, 'equal to zero' if child_private_key == 0 # very low probability
+      raise InvalidKeyForIndex, "equal to zero" if child_private_key == 0 # very low probability
       child_chain_code = right_from_hash(hash)
       return child_private_key, child_chain_code
     end
@@ -88,10 +89,15 @@ module MoneyTree
       message = public_derivation_message(i)
       hash = hmac_sha512 hex_to_bytes(chain_code_hex), message
       left_int = left_from_hash(hash)
-      raise InvalidKeyForIndex, 'greater than or equal to order' if left_int >= MoneyTree::Key::ORDER # very low probability
+      raise InvalidKeyForIndex, "greater than or equal to order" if left_int >= MoneyTree::Key::ORDER # very low probability
       factor = BN.new left_int.to_s
-      child_public_key = public_key.uncompressed.group.generator.mul(factor).add(public_key.uncompressed.point).to_bn.to_i
-      raise InvalidKeyForIndex, 'at infinity' if child_public_key == 1/0.0 # very low probability
+
+      gen_point = public_key.uncompressed.group.generator.mul(factor)
+
+      sum_point_hex = MoneyTree::OpenSSLExtensions.add(gen_point, public_key.uncompressed.point)
+      child_public_key = OpenSSL::PKey::EC::Point.new(public_key.group, OpenSSL::BN.new(sum_point_hex, 16)).to_bn.to_i
+
+      raise InvalidKeyForIndex, "at infinity" if child_public_key == 1 / 0.0 # very low probability
       child_chain_code = right_from_hash(hash)
       return child_public_key, child_chain_code
     end
@@ -120,12 +126,7 @@ module MoneyTree
       to_serialized_base58 to_serialized_hex(type, network: network)
     end
 
-    def to_serialized_address(type = :public, network: :bitcoin)
-      puts 'Node.to_serialized_address is DEPRECATED. Please use .to_bip32.'
-      to_bip32(type, network: network)
-    end
-
-    def to_identifier(compressed=true)
+    def to_identifier(compressed = true)
       key = compressed ? public_key.compressed : public_key.uncompressed
       key.to_ripemd160
     end
@@ -138,15 +139,25 @@ module MoneyTree
       if @parent_fingerprint
         @parent_fingerprint
       else
-        depth.zero? ? '00000000' : parent.to_fingerprint
+        depth.zero? ? "00000000" : parent.to_fingerprint
       end
     end
 
-    def to_address(compressed=true, network: :bitcoin)
+    def to_address(compressed = true, network: :bitcoin)
       address = NETWORKS[network][:address_version] + to_identifier(compressed)
       to_serialized_base58 address
     end
 
+    def to_p2wpkh_p2sh(network: :bitcoin)
+      public_key.to_p2wpkh_p2sh(network: network)
+    end
+
+    def to_bech32_address(network: :bitcoin)
+      hrp = NETWORKS[network][:human_readable_part]
+      witprog = to_identifier
+      to_serialized_bech32(hrp, witprog)
+    end
+
     def subnode(i = 0, opts = {})
       if private_key.nil?
         child_public_key, child_chain_code = derive_public_key(i)
@@ -157,7 +168,7 @@ module MoneyTree
         child_public_key = MoneyTree::PublicKey.new child_private_key
       end
 
-      MoneyTree::Node.new( depth: depth+1,
+      MoneyTree::Node.new(depth: depth + 1,
                           index: i,
                           private_key: private_key.nil? ? nil : child_private_key,
                           public_key: child_public_key,
@@ -177,9 +188,9 @@ module MoneyTree
     #
     # You should choose either the p or the negative number convention for private key derivation.
     def node_for_path(path)
-      force_public = path[-4..-1] == '.pub'
+      force_public = path[-4..-1] == ".pub"
       path = path[0..-5] if force_public
-      parts = path.split('/')
+      parts = path.split("/")
       nodes = []
       parts.each_with_index do |part, depth|
         if part =~ /m/i
@@ -190,7 +201,7 @@ module MoneyTree
           nodes << node.subnode(i)
         end
       end
-      if force_public or parts.first == 'M'
+      if force_public or parts.first == "M"
         node = nodes.last
         node.strip_private_info!
         node
@@ -204,12 +215,12 @@ module MoneyTree
       i = path_part.to_i
 
       i = if i < 0
-        i
-      elsif is_prime
-        i | 0x80000000
-      else
-        i & 0x7fffffff
-      end
+          i
+        elsif is_prime
+          i | 0x80000000
+        else
+          i & 0x7fffffff
+        end
     end
 
     def strip_private_info!
@@ -246,7 +257,7 @@ module MoneyTree
         raise SeedGeneration::ImportError unless seed_valid?(@seed_hash)
         set_seeded_keys
       elsif opts[:private_key] || opts[:public_key]
-        raise ImportError, 'chain code required' unless opts[:chain_code]
+        raise ImportError, "chain code required" unless opts[:chain_code]
         @chain_code = opts[:chain_code]
         if opts[:private_key]
           @private_key = opts[:private_key]
@@ -256,8 +267,7 @@ module MoneyTree
             opts[:public_key]
           else
             MoneyTree::PublicKey.new(opts[:public_key])
-          end
-        end
+          end         end
       else
         generate_seed
         set_seeded_keys