bitcoinrb 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34ec1d9b1b20094213a29e9df2a47b901bdef1d537323446230b6ff2f3420a50
-  data.tar.gz: 5591f08d5909d1b18b60b091a41e4f6638d424ea0512dbd270001d8e9555e633
+  metadata.gz: a5da63d0663778eba1816d008ebf369348bc75d214965b68c2ff7ce564e95ac3
+  data.tar.gz: 2a7e31c9f5b29b72b14e93103f1b69111a2283e390fb61fdad517a5aa764f9f4
 SHA512:
-  metadata.gz: 8e1a4df59cb46fa6d35dab5dc3d83dac58aaf6b8f39ae2ccc782c10ce06821000a1e31732887b0019b2ac62f0f4d7e831d71a0a9ad8964868b24c168862b963a
-  data.tar.gz: 9f374d157b4c8814c771697365ffded665a17b36579130604fd8c85375e05fbaa41f8212006ef037f5d2442af67a6130a1d5400d5019b9685404b433de1dff77
+  metadata.gz: b062f7c6e944cac7787fdca7be284224961b9a675467bd6f55fa0d49ed502157507e098aee9b28998f600826d677ddc3f8b26947134591240b5d8ada5e004686
+  data.tar.gz: b32d9705400ac5bfb1cc252e4a79c66ff9fb2d8dcba1f530060b5c130e14726e412a5434d5769dd6824588374cbae99c797ae65a2478a92d53cc5fa664ab5a4e

data/.ruby-version

@@ -1 +1 @@
-2.6.3
+2.7.0

data/.travis.yml

@@ -3,6 +3,7 @@ rvm:
   - 2.4.6
   - 2.5.5
   - 2.6.3
+  - 2.7.0
 addons:
   apt:
     packages:

data/README.md

@@ -17,6 +17,7 @@ Bitcoinrb supports following feature:
 * Segwit support (parsing segwit payload, Bech32 address, sign for segwit tx, [BIP-141](https://github.com/bitcoin/bips/blob/master/bip-0141.mediawiki), [BIP-143](https://github.com/bitcoin/bips/blob/master/bip-0143.mediawiki), [BIP-144](https://github.com/bitcoin/bips/blob/master/bip-0144.mediawiki))
 * [BIP-173](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki) Bech32 address support
 * [BIP-174](https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki) PSBT(Partially Signed Bitcoin Transaction) support
+* [BIP-85](https://github.com/bitcoin/bips/blob/master/bip-0085.mediawiki) Deterministic Entropy From BIP32 Keychains support by `Bitcoin::BIP85Entropy` class.
 * [WIP] SPV node
 * [WIP] 0ff-chain protocol
 
@@ -38,8 +39,8 @@ If you use node features, please install level DB as follows.
 
 and put `leveldb-native` in your Gemfile and run bundle install.
 
-```
-gem leveldb-native
+```ruby
+gem 'leveldb-native'
 ```
 
 ## Installation

data/bitcoinrb.gemspec

@@ -29,17 +29,17 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'ffi'
   spec.add_runtime_dependency 'leb128', '~> 1.0.0'
   spec.add_runtime_dependency 'eventmachine_httpserver'
-  spec.add_runtime_dependency 'rest-client'
   spec.add_runtime_dependency 'iniparse'
   spec.add_runtime_dependency 'siphash'
   spec.add_runtime_dependency 'protobuf', '3.8.5'
   spec.add_runtime_dependency 'scrypt'
+  spec.add_runtime_dependency 'json_pure', '>= 2.3.1'
 
   # for options
   spec.add_development_dependency 'leveldb-native'
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'timecop'
   spec.add_development_dependency 'webmock', '~> 3.0'

data/exe/bitcoinrbd

@@ -12,6 +12,11 @@ class BitcoinDaemon < DaemonSpawn::Base
     node.run
   end
 
+  def stop
+    puts "Stopping Bitcoinrb daemon : #{Time.now}"
+    node.shutdown
+  end
+
 end
 
 class Bitcoinrbd < Thor

data/lib/bitcoin.rb

@@ -14,6 +14,7 @@ require_relative 'openassets'
 
 module Bitcoin
 
+  autoload :Ext, 'bitcoin/ext'
   autoload :Util, 'bitcoin/util'
   autoload :ChainParams, 'bitcoin/chain_params'
   autoload :Message, 'bitcoin/message'
@@ -55,6 +56,8 @@ module Bitcoin
   autoload :Descriptor, 'bitcoin/descriptor'
   autoload :SLIP39, 'bitcoin/slip39'
   autoload :Aezeed, 'bitcoin/aezeed'
+  autoload :PaymentCode, 'bitcoin/payment_code'
+  autoload :BIP85Entropy, 'bitcoin/bip85_entropy'
 
   require_relative 'bitcoin/constants'
 
@@ -189,7 +192,7 @@ module Bitcoin
         if value.is_a?(Array)
           result.update(key => value.map{|v|v.to_h})
         else
-          result.update(key => value)
+          result.update(key => value.class.to_s.start_with?("Bitcoin::") ? value.to_h : value)
         end
       end
     end
@@ -223,4 +226,10 @@ module Bitcoin
     end
   end
 
+  class ::ECDSA::Point
+    def to_hex(compression = true)
+      ECDSA::Format::PointOctetString.encode(self, compression: compression).bth
+    end
+  end
+
 end

data/lib/bitcoin/bip85_entropy.rb

@@ -0,0 +1,111 @@
+module Bitcoin
+
+  # Deterministic Entropy From BIP32 Keychains
+  # https://github.com/bitcoin/bips/blob/master/bip-0085.mediawiki
+  class BIP85Entropy
+
+    BIP85_PATH = 83696968 + HARDENED_THRESHOLD
+
+    include Bitcoin::KeyPath
+
+    attr_reader :root_key #hex format
+
+    # Import root key.
+    # @param [String] base58 master bip32 root key.
+    # @return [Bitcoin::BIP85Entropy]
+    def self.from_base58(base58)
+      key = Bitcoin::ExtKey.from_base58(base58)
+      self.new(key)
+    end
+
+    # derive entropy
+    # @param [String] path derive path.
+    # @return [Tuple(String, Object)] a tuple of entropy with hex format and results depending the application.
+    def derive(path)
+      raise ArgumentError, "Invalid BIP85 path format." unless path.start_with?("m/83696968'")
+      derived_key = root_key
+      parse_key_path(path).each{|num| derived_key = derived_key.derive(num)}
+      derived_key = derived_key.priv
+      entropy = Bitcoin.hmac_sha512("bip-entropy-from-k", derived_key.htb).bth
+      app_no = path.split('/')[2]
+      case app_no
+      when "39'"
+        bip39_entropy(path, entropy)
+      when "2'"
+        hd_seed_entropy(entropy)
+      when "32'"
+        xprv_entropy(entropy)
+      else
+        [entropy, entropy]
+      end
+    end
+
+    private
+
+    def initialize(root_key)
+      @root_key = root_key
+    end
+
+    # derive BIP39 entropy.
+    def bip39_entropy(path, entropy)
+      params = path.split('/')
+      word_len = params[4]
+      language = code_to_language(params[3])
+      entropy = case word_len
+                when "12'"
+                  entropy[0...32]
+                when "18'"
+                  entropy[0...48]
+                when "24'"
+                  entropy[0...64]
+                else
+                  raise ArgumentError, "Word length #{word_len} does not supported."
+                end
+      mnemonic = Bitcoin::Mnemonic.new(language)
+      [entropy, mnemonic.to_mnemonic(entropy)]
+    end
+
+    # derive HD-Seed WIF entropy.
+    def hd_seed_entropy(entropy)
+      result = entropy[0...64]
+      [result, Bitcoin::Key.new(priv_key: result).to_wif]
+    end
+
+    # derive xprv entropy
+    def xprv_entropy(entropy)
+      chaincode = entropy[0...64]
+      private_key = Bitcoin::Key.new(priv_key: entropy[64..-1])
+      ext_key = Bitcoin::ExtKey.new
+      ext_key.key = private_key
+      ext_key.chain_code = chaincode.htb
+      ext_key.depth = 0
+      ext_key.number = 0
+      ext_key.parent_fingerprint = Bitcoin::ExtKey::MASTER_FINGERPRINT
+      [entropy, ext_key.to_base58]
+    end
+
+    # convert language code to language string.
+    def code_to_language(code)
+      case code
+      when "0'"
+        "english"
+      when "1'"
+        "japanese"
+      when "3'"
+        "spanish"
+      when "4'"
+        "chinese_simplified"
+      when "5'"
+        "chinese_traditional"
+      when "6'"
+        "french"
+      when "7'"
+        "italian"
+      else
+        raise ArgumentError, "bitcoinrb does not support language: #{code}"
+      end
+    end
+
+  end
+
+end

data/lib/bitcoin/block_header.rb

@@ -3,6 +3,8 @@ module Bitcoin
   # Block Header
   class BlockHeader
 
+    include Bitcoin::HexConverter
+
     attr_accessor :version
     attr_accessor :prev_hash
     attr_accessor :merkle_root

data/lib/bitcoin/ext.rb

@@ -0,0 +1,5 @@
+module Bitcoin
+  module Ext
+    autoload :JsonParser, 'bitcoin/ext/json_parser'
+  end
+end

data/lib/bitcoin/ext/json_parser.rb

@@ -0,0 +1,46 @@
+require 'json/pure'
+
+module Bitcoin
+  module Ext
+    # Extension of JSON::Pure::Parser.
+    # This class convert Float value to String value.
+    class JsonParser < JSON::Pure::Parser
+
+      def parse_value
+        case
+        when scan(FLOAT)
+          self[1].to_s
+        when scan(INTEGER)
+          Integer(self[1])
+        when scan(TRUE)
+          true
+        when scan(FALSE)
+          false
+        when scan(NULL)
+          nil
+        when !UNPARSED.equal?(string = parse_string)
+          string
+        when scan(ARRAY_OPEN)
+          @current_nesting += 1
+          ary = parse_array
+          @current_nesting -= 1
+          ary
+        when scan(OBJECT_OPEN)
+          @current_nesting += 1
+          obj = parse_object
+          @current_nesting -= 1
+          obj
+        when @allow_nan && scan(NAN)
+          NaN
+        when @allow_nan && scan(INFINITY)
+          Infinity
+        when @allow_nan && scan(MINUS_INFINITY)
+          MinusInfinity
+        else
+          UNPARSED
+        end
+      end
+
+    end
+  end
+end

data/lib/bitcoin/ext_key.rb

@@ -6,6 +6,8 @@ module Bitcoin
   # BIP32 Extended private key
   class ExtKey
 
+    include Bitcoin::HexConverter
+
     MAX_DEPTH = 255
     MASTER_FINGERPRINT = '00000000'
 
@@ -50,7 +52,7 @@ module Bitcoin
 
     # Base58 encoded extended private key
     def to_base58
-      h = to_payload.bth
+      h = to_hex
       hex = h + Bitcoin.calc_checksum(h)
       Base58.encode(hex)
     end
@@ -198,6 +200,8 @@ module Bitcoin
   # BIP-32 Extended public key
   class ExtPubkey
 
+    include Bitcoin::HexConverter
+
     attr_accessor :ver
     attr_accessor :depth
     attr_accessor :number
@@ -249,7 +253,7 @@ module Bitcoin
 
     # Base58 encoded extended pubkey
     def to_base58
-      h = to_payload.bth
+      h = to_hex
       hex = h + Bitcoin.calc_checksum(h)
       Base58.encode(hex)
     end
@@ -273,7 +277,7 @@ module Bitcoin
       raise 'invalid key' if left >= CURVE_ORDER
       p1 = Bitcoin::Secp256k1::GROUP.generator.multiply_by_scalar(left)
       p2 = Bitcoin::Key.new(pubkey: pubkey, key_type: key_type).to_point
-      new_key.pubkey = ECDSA::Format::PointOctetString.encode(p1 + p2, compression: true).bth
+      new_key.pubkey = (p1 + p2).to_hex
       new_key.chain_code = l[32..-1]
       new_key.ver = version
       new_key

data/lib/bitcoin/key_path.rb

@@ -4,14 +4,21 @@ module Bitcoin
     # key path convert an array of derive number
     # @param [String] path_string
     # @return [Array[Integer]] key path numbers.
+    # @raise [ArgumentError] if invalid +path_string+.
     def parse_key_path(path_string)
-      path_string.split('/').map.with_index do|p, index|
+      paths = path_string.split('/')
+      raise ArgumentError, "Invalid path." if path_string.include?(" ")
+      raise ArgumentError, "Invalid path." unless path_string.count("/") <= paths.size
+      paths.map.with_index do|p, index|
         if index == 0
-          raise ArgumentError.new("#{path_string} is invalid format.") unless p == 'm'
-          next
+          next if p == 'm'
+          raise ArgumentError, "Invalid path." unless p == 'm'
         end
-        raise ArgumentError.new("#{path_string} is invalid format.") unless p.delete("'") =~ /^[0-9]+$/
-        (p[-1] == "'" ? p.delete("'").to_i + Bitcoin::HARDENED_THRESHOLD : p.to_i)
+        raise ArgumentError, "Invalid path." if p.count("'") > 1 || (p.count("'") == 1 && p[-1] != "'")
+        raise ArgumentError, "Invalid path." unless p.delete("'") =~ /^[0-9]+$/
+        value = (p[-1] == "'" ? p.delete("'").to_i + Bitcoin::HARDENED_THRESHOLD : p.to_i)
+        raise ArgumentError, "Invalid path." if value > 4294967295 # 4294967295 = 0xFFFFFFFF (uint32 max)
+        value
       end[1..-1]
     end
 

data/lib/bitcoin/message.rb

@@ -37,6 +37,13 @@ module Bitcoin
     autoload :BlockTransactionRequest, 'bitcoin/message/block_transaction_request'
     autoload :BlockTxn, 'bitcoin/message/block_txn'
     autoload :BlockTransactions, 'bitcoin/message/block_transactions'
+    autoload :GetCFilters, 'bitcoin/message/get_cfilters'
+    autoload :GetCFHeaders, 'bitcoin/message/get_cfheaders'
+    autoload :CFParser, 'bitcoin/message/cf_parser'
+    autoload :GetCFCheckpt, 'bitcoin/message/get_cfcheckpt'
+    autoload :CFCheckpt, 'bitcoin/message/cfcheckpt'
+    autoload :CFilter, 'bitcoin/message/cfilter'
+    autoload :CFHeaders, 'bitcoin/message/cfheaders'
 
     USER_AGENT = "/bitcoinrb:#{Bitcoin::VERSION}/"
 

data/lib/bitcoin/message/base.rb

@@ -3,6 +3,7 @@ module Bitcoin
 
     # Base message class
     class Base
+      include Bitcoin::HexConverter
       include Bitcoin::Util
       extend Bitcoin::Util
 

data/lib/bitcoin/message/cf_parser.rb

@@ -0,0 +1,16 @@
+module Bitcoin
+  module Message
+    module CFParser
+
+      def parse_from_payload(payload)
+        type, start, hash = payload.unpack('CLH*')
+        self.new(type, start, hash)
+      end
+
+      def to_payload
+        [filter_type, start_height, stop_hash].pack('CLH*')
+      end
+
+    end
+  end
+end

data/lib/bitcoin/message/cfcheckpt.rb

@@ -0,0 +1,36 @@
+module Bitcoin
+  module Message
+
+    # cfcheckpt message for BIP-157
+    # https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki#cfcheckpt
+    class CFCheckpt < Base
+
+      COMMAND = 'cfcheckpt'
+
+      attr_accessor :filter_type
+      attr_accessor :stop_hash      # little endian
+      attr_accessor :filter_headers # little endian
+
+      def initialize(filter_type, stop_hash, filter_headers)
+        @filter_type = filter_type
+        @stop_hash = stop_hash
+        @filter_headers = filter_headers
+      end
+
+      def self.parse_from_payload(payload)
+        buf = StringIO.new(payload)
+        type = buf.read(1).unpack('C').first
+        hash = buf.read(32).unpack('H*').first
+        count = Bitcoin.unpack_var_int_from_io(buf)
+        headers = count.times.map{buf.read(32).bth}
+        self.new(type, hash, headers)
+      end
+
+      def to_payload
+        [filter_type, stop_hash].pack('CH*') +
+            Bitcoin.pack_var_int(filter_headers.size) + filter_headers.map(&:htb).join
+      end
+    end
+
+  end
+end

data/lib/bitcoin/message/cfheaders.rb

@@ -0,0 +1,40 @@
+module Bitcoin
+  module Message
+
+    # cfheaders message for BIP-157
+    # https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki#cfheaders
+    class CFHeaders < Base
+
+      COMMAND = 'cfheaders'
+
+      attr_accessor :filter_type
+      attr_accessor :stop_hash            # little endian
+      attr_accessor :prev_filter_header   # little endian
+      attr_accessor :filter_hashes        # little endian
+
+      def initialize(filter_type, stop_hash, prev_filter_header, filter_hashes)
+        @filter_type = filter_type
+        @stop_hash = stop_hash
+        @prev_filter_header = prev_filter_header
+        @filter_hashes = filter_hashes
+      end
+
+      def self.parse_from_payload(payload)
+        buf = StringIO.new(payload)
+        type = buf.read(1).unpack("C").first
+        hash = buf.read(32).bth
+        header = buf.read(32).bth
+        count = Bitcoin.unpack_var_int_from_io(buf)
+        hashes = count.times.map{buf.read(32).bth}
+        self.new(type, hash, header, hashes)
+      end
+
+      def to_payload
+        [filter_type].pack('C') + stop_hash.htb + prev_filter_header.htb +
+            Bitcoin.pack_var_int(filter_hashes.size) + filter_hashes.map(&:htb).join
+      end
+
+    end
+
+  end
+end