bitcoinrb 0.3.1 → 0.7.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

@@ -1,6 +1,8 @@
 module Bitcoin
   module Message
 
+    class Error < StandardError; end
+
     autoload :Base, 'bitcoin/message/base'
     autoload :Inventory, 'bitcoin/message/inventory'
     autoload :InventoriesParser, 'bitcoin/message/inventories_parser'
@@ -37,6 +39,15 @@ 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'
+    autoload :SendAddrV2, 'bitcoin/message/send_addr_v2'
+    autoload :AddrV2, 'bitcoin/message/addr_v2'
 
     USER_AGENT = "/bitcoinrb:#{Bitcoin::VERSION}/"
 
@@ -66,5 +77,73 @@ module Bitcoin
         compact_witness: 70015
     }
 
+    module_function
+
+    # Decode P2P message.
+    # @param [String] command P2P message command string.
+    # @param [String] payload P2P message payload with hex format..
+    # @return [Bitcoin::Message::]
+    def decode(command, payload = nil)
+      payload = payload.htb if payload
+      case command
+      when Bitcoin::Message::Version::COMMAND
+        Bitcoin::Message::Version.parse_from_payload(payload)
+      when Bitcoin::Message::VerAck::COMMAND
+        Bitcoin::Message::VerAck.new
+      when Bitcoin::Message::GetAddr::COMMAND
+        Bitcoin::Message::GetAddr.new
+      when Bitcoin::Message::Addr::COMMAND
+        Bitcoin::Message::Addr.parse_from_payload(payload)
+      when Bitcoin::Message::SendHeaders::COMMAND
+        Bitcoin::Message::SendHeaders.new
+      when Bitcoin::Message::FeeFilter::COMMAND
+        Bitcoin::Message::FeeFilter.parse_from_payload(payload)
+      when Bitcoin::Message::Ping::COMMAND
+        Bitcoin::Message::Ping.parse_from_payload(payload)
+      when Bitcoin::Message::Pong::COMMAND
+        Bitcoin::Message::Pong.parse_from_payload(payload)
+      when Bitcoin::Message::GetHeaders::COMMAND
+        Bitcoin::Message::GetHeaders.parse_from_payload(payload)
+      when Bitcoin::Message::Headers::COMMAND
+        Bitcoin::Message::Headers.parse_from_payload(payload)
+      when Bitcoin::Message::Block::COMMAND
+        Bitcoin::Message::Block.parse_from_payload(payload)
+      when Bitcoin::Message::Tx::COMMAND
+        Bitcoin::Message::Tx.parse_from_payload(payload)
+      when Bitcoin::Message::NotFound::COMMAND
+        Bitcoin::Message::NotFound.parse_from_payload(payload)
+      when Bitcoin::Message::MemPool::COMMAND
+        Bitcoin::Message::MemPool.new
+      when Bitcoin::Message::Reject::COMMAND
+        Bitcoin::Message::Reject.parse_from_payload(payload)
+      when Bitcoin::Message::SendCmpct::COMMAND
+        Bitcoin::Message::SendCmpct.parse_from_payload(payload)
+      when Bitcoin::Message::Inv::COMMAND
+        Bitcoin::Message::Inv.parse_from_payload(payload)
+      when Bitcoin::Message::MerkleBlock::COMMAND
+        Bitcoin::Message::MerkleBlock.parse_from_payload(payload)
+      when Bitcoin::Message::CmpctBlock::COMMAND
+        Bitcoin::Message::CmpctBlock.parse_from_payload(payload)
+      when Bitcoin::Message::GetData::COMMAND
+        Bitcoin::Message::GetData.parse_from_payload(payload)
+      when Bitcoin::Message::GetCFHeaders::COMMAND
+        Bitcoin::Message::GetCFHeaders.parse_from_payload(payload)
+      when Bitcoin::Message::GetCFilters::COMMAND
+        Bitcoin::Message::GetCFilters.parse_from_payload(payload)
+      when Bitcoin::Message::GetCFCheckpt::COMMAND
+        Bitcoin::Message::GetCFCheckpt.parse_from_payload(payload)
+      when Bitcoin::Message::CFCheckpt::COMMAND
+        Bitcoin::Message::CFCheckpt.parse_from_payload(payload)
+      when Bitcoin::Message::CFHeaders::COMMAND
+        Bitcoin::Message::CFHeaders.parse_from_payload(payload)
+      when Bitcoin::Message::CFilter::COMMAND
+        Bitcoin::Message::CFilter.parse_from_payload(payload)
+      when Bitcoin::Message::SendAddrV2::COMMAND
+        Bitcoin::Message::SendAddrV2.new
+      when Bitcoin::Message::AddrV2::COMMAND
+        Bitcoin::Message::AddrV2.parse_from_payload(payload)
+      end
+    end
+
   end
 end

data/lib/bitcoin/message/addr_v2.rb

@@ -0,0 +1,34 @@
+module Bitcoin
+  module Message
+
+    # addrv2 message class.
+    # https://github.com/bitcoin/bips/blob/master/bip-0155.mediawiki
+    class AddrV2 < Base
+
+      COMMAND = 'addrv2'
+
+      attr_reader :addrs
+
+      def initialize(addrs = [])
+        @addrs = addrs
+      end
+
+      def self.parse_from_payload(payload)
+        buf = StringIO.new(payload)
+        addr_count = Bitcoin.unpack_var_int_from_io(buf)
+        v2 = new
+        addr_count.times do
+          v2.addrs << NetworkAddr.parse_from_payload(buf, type: NetworkAddr::TYPE[:addr_v2])
+        end
+        v2
+      end
+
+      def to_payload
+        buf = Bitcoin.pack_var_int(addrs.size)
+        buf << (addrs.map { |a| a.to_payload(type: NetworkAddr::TYPE[:addr_v2])}.join)
+      end
+
+    end
+
+  end
+end

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
 
@@ -22,6 +23,22 @@ module Bitcoin
         raise 'to_payload must be implemented in a child class.'
       end
 
+      # Decode message data to message object.
+      # @param [String] message with binary format.
+      # @return [Bitcoin::Message::XXX] An instance of a class that inherits Bitcoin::Message::Base
+      # @raise [ArgumentError] Occurs for data that cannot be decoded.
+      def self.from_pkt(message)
+        buf = StringIO.new(message)
+        magic = buf.read(4)
+        raise ArgumentError, 'Invalid magic.' unless magic == Bitcoin.chain_params.magic_head.htb
+        command = buf.read(12).delete("\x00")
+        length = buf.read(4).unpack1('V')
+        checksum = buf.read(4)
+        payload = buf.read(length)
+        raise ArgumentError, 'Checksum do not match.' unless checksum == Bitcoin.double_sha256(payload)[0...4]
+        Bitcoin::Message.decode(command, payload&.bth)
+      end
+
     end
 
   end

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