bitcoinrb 0.3.2 → 0.8.0

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

@@ -1,10 +1,16 @@
 require 'ipaddr'
+require 'base32'
 
 module Bitcoin
   module Message
 
+    NETWORK_ID = {ipv4: 0x01, ipv6: 0x02, tor_v2: 0x03, tor_v3: 0x04, i2p: 0x05, cjdns: 0x06}
+    INTERNAL_IN_IPV6_PREFIX = "fd6b:88c0:8724"
+
     class NetworkAddr
 
+      TYPE = {legacy: 0x01, addr_v2: 0x02}
+
       # unix time.
       # Nodes advertising their own IP address set this to the current time.
       # Nodes advertising IP addresses they’ve connected to set this to the last time they connected to that node.
@@ -14,47 +20,164 @@ module Bitcoin
       # The services the node advertised in its version message.
       attr_accessor :services
 
-      attr_accessor :ip_addr # IPAddr
+      attr_accessor :net # network ID that defined by BIP-155
+
+      # Network address. The interpretation depends on networkID.
+      # If ipv4 or ipv6 this field is a IPAddr object, otherwise hex string.
+      attr_accessor :addr
 
       attr_accessor :port
 
       attr_reader :skip_time
 
-      def initialize(ip: '127.0.0.1', port: Bitcoin.chain_params.default_port, services: DEFAULT_SERVICE_FLAGS, time: Time.now.to_i)
+      def initialize(ip: '127.0.0.1', port: Bitcoin.chain_params.default_port,
+                     services: DEFAULT_SERVICE_FLAGS, time: Time.now.to_i, net: NETWORK_ID[:ipv4])
         @time = time
-        @ip_addr = IPAddr.new(ip)
         @port = port
         @services = services
+        @net = net
+        case net
+        when NETWORK_ID[:ipv4], NETWORK_ID[:ipv6]
+          @addr = IPAddr.new(ip) if ip
+        end
       end
 
-      def self.parse_from_payload(payload)
-        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.ip_addr = IPAddr::new_ntoh(buf.read(16))
-        addr.port = buf.read(2).unpack('n').first
-        addr
+      # Parse addr payload
+      # @param [String] payload payload of addr
+      # @param [Integer] type Address format type
+      # @return [NetworkAddr]
+      def self.parse_from_payload(payload, type: TYPE[:legacy])
+        case type
+        when TYPE[:legacy]
+          load_legacy_payload(payload)
+        when TYPE[:addr_v2]
+          load_addr_v2_payload(payload)
+        else
+          raise Bitcoin::Message::Error, "Unknown type: #{type}."
+        end
       end
 
       def self.local_addr
         addr = new
-        addr.ip_addr = IPAddr.new('127.0.0.1')
+        addr.addr = IPAddr.new('127.0.0.1')
         addr.port = Bitcoin.chain_params.default_port
         addr.services = DEFAULT_SERVICE_FLAGS
         addr
       end
 
-      def ip
-        ip_addr.ipv4_mapped? ? ip_addr.native : ip_addr.to_s
+      # Show addr string. e.g 127.0.0.1
+      def addr_string
+        case net
+        when NETWORK_ID[:ipv4]
+          addr.native
+        when NETWORK_ID[:ipv6]
+          if addr.to_s.start_with?(INTERNAL_IN_IPV6_PREFIX)
+            Base32.encode(addr.hton[6..-1]).downcase.delete('=') + ".internal"
+          else
+            addr.to_s
+          end
+        when NETWORK_ID[:tor_v2]
+          Base32.encode(addr.htb).downcase + ".onion"
+        when NETWORK_ID[:tor_v3]
+          # TORv3 onion_address = base32(PUBKEY | CHECKSUM | VERSION) + ".onion"
+          pubkey = addr.htb
+          checksum = OpenSSL::Digest.new('SHA3-256').digest('.onion checksum' + pubkey + "\x03")
+          Base32.encode(pubkey + checksum[0...2] + "\x03").downcase + ".onion"
+        when NETWORK_ID[:i2p]
+          Base32.encode(addr.htb).downcase.delete('=') + ".b32.i2p"
+        when NETWORK_ID[:cjdns]
+          addr.to_s
+        end
+      end
+
+      def to_payload(skip_time = false, type: TYPE[:legacy])
+        case type
+        when TYPE[:legacy]
+          legacy_payload(skip_time)
+        when TYPE[:addr_v2]
+          v2_payload
+        else
+          raise Bitcoin::Message::Error, "Unknown type: #{type}."
+        end
       end
 
-      def to_payload(skip_time = false)
+      # Load addr payload with legacy format.
+      def self.load_legacy_payload(payload)
+        buf = payload.is_a?(String) ? StringIO.new(payload) : payload
+        has_time = buf.size > 26
+        addr = NetworkAddr.new(time: nil)
+        addr.time = buf.read(4).unpack1('V') if has_time
+        addr.services = buf.read(8).unpack1('Q')
+        addr.addr = IPAddr::new_ntoh(buf.read(16))
+        addr.port = buf.read(2).unpack1('n')
+        addr
+      end
+
+      # Load addr payload with addr v2 format.
+      def self.load_addr_v2_payload(payload)
+        buf = payload.is_a?(String) ? StringIO.new(payload) : payload
+        addr = NetworkAddr.new(time: buf.read(4).unpack1('V'))
+        addr.services = Bitcoin.unpack_var_int_from_io(buf)
+        addr.net = buf.read(1).unpack1('C')
+        raise Bitcoin::Message::Error, "Unknown network id: #{addr.net}" unless NETWORK_ID.value?(addr.net)
+        addr_len = Bitcoin.unpack_var_int_from_io(buf)
+        addr.addr = case addr.net 
+                    when NETWORK_ID[:ipv4]
+                      raise Bitcoin::Message::Error, "Invalid IPv4 address." unless addr_len == 4
+                      IPAddr::new_ntoh(buf.read(addr_len))
+                    when NETWORK_ID[:ipv6]
+                      raise Bitcoin::Message::Error, "Invalid IPv6 address." unless addr_len == 16
+                      a = IPAddr::new_ntoh(buf.read(addr_len))
+                      raise Bitcoin::Message::Error, "Invalid IPv6 address." if a.ipv4_mapped?
+                      a
+                    when NETWORK_ID[:tor_v2]
+                      raise Bitcoin::Message::Error, "Invalid Tor v2 address." unless addr_len == 10
+                      buf.read(addr_len).bth
+                    when NETWORK_ID[:tor_v3]
+                      raise Bitcoin::Message::Error, "Invalid Tor v3 address." unless addr_len == 32
+                      buf.read(addr_len).bth
+                    when NETWORK_ID[:i2p]
+                      raise Bitcoin::Message::Error, "Invalid I2P address." unless addr_len == 32
+                      buf.read(addr_len).bth
+                    when NETWORK_ID[:cjdns]
+                      raise Bitcoin::Message::Error, "Invalid CJDNS address." unless addr_len == 16
+                      a = IPAddr::new_ntoh(buf.read(addr_len))
+                      raise Bitcoin::Message::Error, "Invalid CJDNS address." unless a.to_s.start_with?('fc00:')
+                      a
+                    end
+        addr.port = buf.read(2).unpack1('n')
+        addr
+      end
+
+      def legacy_payload(skip_time)
         p = ''
         p << [time].pack('V') unless skip_time
-        addr = ip_addr.ipv4? ? ip_addr.ipv4_mapped : ip_addr
-        p << [services].pack('Q') << addr.hton << [port].pack('n')
+        ip = addr.ipv4? ? addr.ipv4_mapped : addr
+        p << [services].pack('Q') << ip.hton << [port].pack('n')
+      end
+
+      def v2_payload
+        p = [time].pack('V')
+        p << Bitcoin.pack_var_int(services)
+        p << [net].pack('C')
+        case net
+        when NETWORK_ID[:ipv4]
+          p << Bitcoin.pack_var_int(4)
+          p << addr.to_i.to_s(16).htb
+        when NETWORK_ID[:ipv6]
+          p << Bitcoin.pack_var_int(16)
+          p << addr.hton
+        when NETWORK_ID[:tor_v2]
+          p << Bitcoin.pack_var_int(10)
+        when NETWORK_ID[:tor_v3]
+          p << Bitcoin.pack_var_int(32)
+        when NETWORK_ID[:i2p]
+          p << Bitcoin.pack_var_int(32)
+        when NETWORK_ID[:cjdns]
+          p << Bitcoin.pack_var_int(16)
+        end
+        p << [port].pack('n')
+        p
       end
 
     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_addr_v2.rb

@@ -0,0 +1,13 @@
+module Bitcoin
+  module Message
+    class SendAddrV2 < Base
+
+      COMMAND = 'sendaddrv2'
+
+      def to_payload
+        ''
+      end
+
+    end
+  end
+end