bitcoinrb 0.3.0 → 0.6.0

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).unpack1('C')
+        hash = buf.read(32).unpack1('H*')
+        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).unpack1("C")
+        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

data/lib/bitcoin/message/cfilter.rb

@@ -0,0 +1,35 @@
+module Bitcoin
+  module Message
+
+    # cfilter message for BIP-157
+    # https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki#cfilter
+    class CFilter < Base
+
+      COMMAND = 'cfilter'
+
+      attr_accessor :filter_type
+      attr_accessor :block_hash   # little endian
+      attr_accessor :filter       # little endian
+
+      def initialize(filter_type, block_hash, filter)
+        @filter_type = filter_type
+        @block_hash = block_hash
+        @filter = filter
+      end
+
+      def self.parse_from_payload(payload)
+        buf = StringIO.new(payload)
+        type = buf.read(1).unpack1("C")
+        hash = buf.read(32).bth
+        len = Bitcoin.unpack_var_int_from_io(buf)
+        filter = buf.read(len).bth
+        self.new(type, hash, filter)
+      end
+
+      def to_payload
+        [filter_type, block_hash].pack('CH*') + Bitcoin.pack_var_string(filter.htb)
+      end
+    end
+
+  end
+end

data/lib/bitcoin/message/fee_filter.rb

@@ -15,7 +15,7 @@ module Bitcoin
       end
 
       def self.parse_from_payload(payload)
-        new(payload.unpack('Q').first)
+        new(payload.unpack1('Q'))
       end
 
       def to_payload

data/lib/bitcoin/message/filter_load.rb

@@ -23,9 +23,9 @@ module Bitcoin
         buf = StringIO.new(payload)
         filter_count = Bitcoin.unpack_var_int_from_io(buf)
         filter = buf.read(filter_count).unpack('C*')
-        func_count = buf.read(4).unpack('V').first
-        tweak = buf.read(4).unpack('V').first
-        flag = buf.read(1).unpack('C').first
+        func_count = buf.read(4).unpack1('V')
+        tweak = buf.read(4).unpack1('V')
+        flag = buf.read(1).unpack1('C')
         FilterLoad.new(Bitcoin::BloomFilter.new(filter, func_count, tweak), flag)
       end
 

data/lib/bitcoin/message/get_cfcheckpt.rb

@@ -0,0 +1,29 @@
+module Bitcoin
+  module Message
+
+    # getcfcheckpt message for BIP-157
+    # https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki#getcfcheckpt
+    class GetCFCheckpt < Base
+
+      COMMAND = 'getcfcheckpt'
+
+      attr_accessor :filter_type
+      attr_accessor :stop_hash    # little endian
+
+      def initialize(filter_type, stop_hash)
+        @filter_type = filter_type
+        @stop_hash = stop_hash
+      end
+
+      def self.parse_from_payload(payload)
+        type, hash = payload.unpack('CH*')
+        self.new(type, hash)
+      end
+
+      def to_payload
+        [filter_type, stop_hash].pack('CH*')
+      end
+
+    end
+  end
+end

data/lib/bitcoin/message/get_cfheaders.rb

@@ -0,0 +1,24 @@
+module Bitcoin
+  module Message
+
+    # getcfheaders message for BIP-157
+    # https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki#getcfheaders
+    class GetCFHeaders < Base
+      include CFParser
+      extend CFParser
+
+      COMMAND = 'getcfheaders'
+
+      attr_accessor :filter_type
+      attr_accessor :start_height
+      attr_accessor :stop_hash    # little endian
+
+      def initialize(filter_type, start_height, stop_hash)
+        @filter_type = filter_type
+        @start_height = start_height
+        @stop_hash = stop_hash
+      end
+
+    end
+  end
+end

data/lib/bitcoin/message/get_cfilters.rb

@@ -0,0 +1,25 @@
+module Bitcoin
+  module Message
+
+    # getcfilters message for BIP-157
+    # https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki#getcfilters
+    class GetCFilters < Base
+      include CFParser
+      extend CFParser
+
+      COMMAND = 'getcfilters'
+
+      attr_accessor :filter_type
+      attr_accessor :start_height
+      attr_accessor :stop_hash    # little endian
+
+      def initialize(filter_type, start_height, stop_hash)
+        @filter_type = filter_type
+        @start_height = start_height
+        @stop_hash = stop_hash
+      end
+
+    end
+
+  end
+end

data/lib/bitcoin/message/header_and_short_ids.rb

@@ -22,7 +22,7 @@ module Bitcoin
       def self.parse_from_payload(payload)
         buf = StringIO.new(payload)
         header = Bitcoin::BlockHeader.parse_from_payload(buf.read(80))
-        nonce = buf.read(8).unpack('q*').first
+        nonce = buf.read(8).unpack1('q*')
         short_ids_len = Bitcoin.unpack_var_int_from_io(buf)
         short_ids = short_ids_len.times.map do
            buf.read(6).reverse.bth.to_i(16)

data/lib/bitcoin/message/inventory.rb

@@ -26,7 +26,7 @@ module Bitcoin
       # parse inventory payload
       def self.parse_from_payload(payload)
         raise Error, 'invalid inventory size.' if payload.bytesize != 36
-        identifier = payload[0..4].unpack('V').first
+        identifier = payload[0..4].unpack1('V')
         hash = payload[4..-1].bth # internal byte order
         new(identifier, hash)
       end

data/lib/bitcoin/message/merkle_block.rb

@@ -20,7 +20,7 @@ module Bitcoin
         m = new
         buf = StringIO.new(payload)
         m.header = Bitcoin::BlockHeader.parse_from_payload(buf.read(80))
-        m.tx_count = buf.read(4).unpack('V').first
+        m.tx_count = buf.read(4).unpack1('V')
         hash_count = Bitcoin.unpack_var_int_from_io(buf)
         hash_count.times do
           m.hashes << buf.read(32).bth

data/lib/bitcoin/message/network_addr.rb

@@ -31,10 +31,10 @@ module Bitcoin
         buf = payload.is_a?(String) ? StringIO.new(payload) : payload
         has_time = buf.size > 26
         addr = new(time: nil)
-        addr.time = buf.read(4).unpack('V').first if has_time
-        addr.services = buf.read(8).unpack('Q').first
+        addr.time = buf.read(4).unpack1('V') if has_time
+        addr.services = buf.read(8).unpack1('Q')
         addr.ip_addr = IPAddr::new_ntoh(buf.read(16))
-        addr.port = buf.read(2).unpack('n').first
+        addr.port = buf.read(2).unpack1('n')
         addr
       end
 

data/lib/bitcoin/message/ping.rb

@@ -14,7 +14,7 @@ module Bitcoin
       end
 
       def self.parse_from_payload(payload)
-        new(payload.unpack('Q').first)
+        new(payload.unpack1('Q'))
       end
 
       def to_payload

data/lib/bitcoin/message/pong.rb

@@ -14,7 +14,7 @@ module Bitcoin
       end
 
       def self.parse_from_payload(payload)
-        new(payload.unpack('Q').first)
+        new(payload.unpack1('Q'))
       end
 
       def to_payload

data/lib/bitcoin/message/send_cmpct.rb

@@ -21,8 +21,8 @@ module Bitcoin
 
       def self.parse_from_payload(payload)
         buf = StringIO.new(payload)
-        mode = buf.read(1).unpack('c').first
-        version = buf.read(8).unpack('Q').first
+        mode = buf.read(1).unpack1('c')
+        version = buf.read(8).unpack1('Q')
         new(mode, version)
       end
 

data/lib/bitcoin/message/version.rb

@@ -64,6 +64,13 @@ module Bitcoin
         ( version >= 70001 && payload ) ? unpack_boolean(payload) : [ true, nil ]
       end
 
+      # Check whether +service_flag+ support this version.
+      # @param [Integer] service_flag the service flags.
+      # @return [Boolean] whether support +service_flag+
+      def support?(service_flag)
+        (services & service_flag) != 0
+      end
+
     end
   end
 end

data/lib/bitcoin/mnemonic.rb

@@ -6,11 +6,11 @@ module Bitcoin
 
     WORD_DIR = "#{__dir__}/mnemonic/wordlist"
 
-    attr_reader :word_list
+    attr_reader :language
 
-    def initialize(word_list)
-      raise ArgumentError, 'specified language is not supported.' unless Mnemonic.word_lists.include?(word_list)
-      @word_list = word_list
+    def initialize(language)
+      raise ArgumentError, 'specified language is not supported.' unless Mnemonic.word_lists.include?(language)
+      @language = language
     end
 
     # get support language list
@@ -39,7 +39,7 @@ module Bitcoin
     # @return [Array] the array of mnemonic word.
     def to_mnemonic(entropy)
       raise ArgumentError, 'entropy is empty.' if entropy.nil? || entropy.empty?
-      e = entropy.htb.unpack('B*').first
+      e = entropy.htb.unpack1('B*')
       seed = e + checksum(e)
       mnemonic_index = seed.chars.each_slice(11).map{|i|i.join.to_i(2)}
       word_master = load_words
@@ -61,7 +61,7 @@ module Bitcoin
     # @param [String] entropy an entropy with bit string format
     # @return [String] an entropy checksum with bit string format
     def checksum(entropy)
-      b = Bitcoin.sha256([entropy].pack('B*')).unpack('B*').first
+      b = Bitcoin.sha256([entropy].pack('B*')).unpack1('B*')
       b.slice(0, (entropy.length/32))
     end
 
@@ -69,7 +69,7 @@ module Bitcoin
 
     # load word list contents
     def load_words
-      File.readlines("#{WORD_DIR}/#{word_list}.txt").map(&:strip)
+      File.readlines("#{WORD_DIR}/#{language}.txt").map(&:strip)
     end
 
   end

data/lib/bitcoin/network/peer.rb

@@ -83,10 +83,15 @@ module Bitcoin
 
       def post_handshake
         @connected = true
-        pool.handle_new_peer(self)
-        # require remote peer to use headers message instead fo inv message.
-        conn.send_message(Bitcoin::Message::SendHeaders.new)
-        EM.add_periodic_timer(PING_INTERVAL) {send_ping}
+        if remote_version.support?(Bitcoin::Message::SERVICE_FLAGS[:bloom])
+          pool.handle_new_peer(self)
+          # require remote peer to use headers message instead fo inv message.
+          conn.send_message(Bitcoin::Message::SendHeaders.new)
+          EM.add_periodic_timer(PING_INTERVAL) {send_ping}
+        else
+          close("peer does not support NODE_BLOOM.")
+          pool.pending_peers.delete(self)
+        end
       end
 
       # start block header download

data/lib/bitcoin/network/peer_discovery.rb

@@ -30,7 +30,7 @@ module Bitcoin
         logger.debug 'discover peer address from DNS seeds.'
         dns_seeds.map { |seed|
           begin
-            Socket.getaddrinfo(seed, Bitcoin.chain_params.default_port).map{|a|a[2]}.uniq
+            Socket.getaddrinfo("#{seed}", Bitcoin.chain_params.default_port).map{|a|a[2]}.uniq
           rescue SocketError => e
             logger.error "SocketError occurred when load DNS seed: #{seed}, error: #{e.message}"
             nil