bitcoinrb 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa485194b6a1f5ea2ba0a4ed3355cae8cc8cdd4252475a78dc811ec54a93dfa4
-  data.tar.gz: 5c2c91ab2041b88e0ada77a1099df5e4d564f2d1da0a2963e3ff1beec0b63172
+  metadata.gz: 5026fc4446c5a88954149551d7168d8022e5aa41cd45cbf86b44ce62fdb308a5
+  data.tar.gz: a6a3708940e5eca7d8eba4ac71ca941e98ba5af7e09f516ea6e7583b38299c80
 SHA512:
-  metadata.gz: c84550004b92167af33a7832c69cafeb44e24a98d491865976194614eed2ea6c831f5ac47a716ec989d1f759786741a26cb81fa6b5da33850a2e2b4dc0fa331b
-  data.tar.gz: fb8bdfea37eb452b565f826cb2a12c56865fd80410376f0d444cddf339a1e4eb423988ef617a1dc84b573bb114db3ddae89ae49f60afd882349e92169bac6031
+  metadata.gz: 0f3ce5cc15d9de9c0fbb578ec179a81148228bb7f12c9937f6a3fe6f73585d09f6d62798abe1255e95e5d415c0a0e7fdeeb51457245b16565c8908b76d2d0249
+  data.tar.gz: fc3f64635b4330c15152b9a38b49a2ec7b324d3a7940cd7a51c64a601d6f9e89a6731014a9f7d2c86cef8a0453b18beb39c5ecec288b8a77c24d73d615c2aebf

data/.travis.yml

@@ -1,3 +1,4 @@
+dist: bionic
 language: ruby
 rvm:
   - 2.4.10

data/bitcoinrb.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'ecdsa'
   spec.add_runtime_dependency 'eventmachine'
   spec.add_runtime_dependency 'murmurhash3'
-  spec.add_runtime_dependency 'bech32', '~> 1.0.3'
+  spec.add_runtime_dependency 'bech32', '~> 1.1.0'
   spec.add_runtime_dependency 'daemon-spawn'
   spec.add_runtime_dependency 'thor'
   spec.add_runtime_dependency 'ffi'
@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'protobuf', '3.8.5'
   spec.add_runtime_dependency 'json_pure', '>= 2.3.1'
   spec.add_runtime_dependency 'bip-schnorr', '>= 0.3.2'
+  spec.add_runtime_dependency 'base32', '>= 0.3.4'
 
   # for options
   spec.add_development_dependency 'leveldb-native'

data/lib/bitcoin.rb

@@ -133,14 +133,7 @@ module Bitcoin
 
     # get opcode
     def opcode
-      case encoding
-      when Encoding::ASCII_8BIT
-        each_byte.next
-      when Encoding::US_ASCII
-        ord
-      else
-        to_i
-      end
+      force_encoding(Encoding::ASCII_8BIT).ord
     end
 
     def opcode?

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'
@@ -44,6 +46,8 @@ module Bitcoin
     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}/"
 
@@ -73,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

@@ -23,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/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).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).unpack1('n')
-        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
+
+      # 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 to_payload(skip_time = false)
+      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/send_addr_v2.rb

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

data/lib/bitcoin/rpc/request_handler.rb

@@ -49,7 +49,7 @@ module Bitcoin
       # Returns connected peer information.
       def getpeerinfo
         node.pool.peers.map do |peer|
-          local_addr = "#{peer.remote_version.remote_addr.ip}:18333"
+          local_addr = "#{peer.remote_version.remote_addr.addr_string}:18333"
           {
             id: peer.id,
             addr: "#{peer.host}:#{peer.port}",

data/lib/bitcoin/version.rb

@@ -1,3 +1,3 @@
 module Bitcoin
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitcoinrb
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - azuchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ecdsa
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: daemon-spawn
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +206,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.2
+- !ruby/object:Gem::Dependency
+  name: base32
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.4
 - !ruby/object:Gem::Dependency
   name: leveldb-native
   requirement: !ruby/object:Gem::Requirement
@@ -342,6 +356,7 @@ files:
 - lib/bitcoin/merkle_tree.rb
 - lib/bitcoin/message.rb
 - lib/bitcoin/message/addr.rb
+- lib/bitcoin/message/addr_v2.rb
 - lib/bitcoin/message/base.rb
 - lib/bitcoin/message/block.rb
 - lib/bitcoin/message/block_transaction_request.rb
@@ -379,6 +394,7 @@ files:
 - lib/bitcoin/message/pong.rb
 - lib/bitcoin/message/prefilled_tx.rb
 - lib/bitcoin/message/reject.rb
+- lib/bitcoin/message/send_addr_v2.rb
 - lib/bitcoin/message/send_cmpct.rb
 - lib/bitcoin/message/send_headers.rb
 - lib/bitcoin/message/tx.rb