ciri-p2p 0.1.0

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ciri/p2p"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/htmldiff

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "htmldiff")

data/bin/ldiff

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "ldiff")

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ciri-p2p.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ciri/p2p/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ciri-p2p"
+  spec.version       = Ciri::P2p::VERSION
+  spec.authors       = ["jjy"]
+  spec.email         = ["jjyruby@gmail.com"]
+
+  spec.summary       = %q{P2P network implementation for Ciri Ethereum.}
+  spec.description   = %q{ciri-p2p is a DevP2P implementation, we also seek to implement LibP2P components upon ciri-p2p codebase in the future.}
+  spec.homepage      = "https://github.com/ciri-ethereum/ciri-p2p"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'ciri-utils', '~> 0.2.2'
+  spec.add_dependency 'ciri-rlp', '~> 1.0.1'
+  spec.add_dependency 'ciri-crypto', '~> 0.1.1'
+  spec.add_dependency 'ciri-common', '~> 0.1.0'
+  spec.add_dependency 'async', '~> 1.10.3'
+  spec.add_dependency 'async-io', '~> 1.15.5'
+  spec.add_dependency 'snappy', '~> 0.0.17'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/ciri/p2p.rb

@@ -0,0 +1,7 @@
+require "ciri/p2p/version"
+
+module Ciri
+  module P2p
+    # Your code goes here...
+  end
+end

data/lib/ciri/p2p/address.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018 by Jiang Jinyang <jjyruby@gmail.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+
+module Ciri
+  module P2P
+
+    class Address
+      attr_reader :ip, :udp_port, :tcp_port
+
+      def initialize(ip:, udp_port:, tcp_port: udp_port)
+        @ip = ip.is_a?(IPAddr) ? ip : IPAddr.new(ip)
+        @udp_port = udp_port
+        @tcp_port = tcp_port
+      end
+
+      def ==(other)
+        self.class == other.class && ip == other.ip && udp_port == other.udp_port
+      end
+
+      def <=>(other)
+        ip <=> other.ip
+      end
+
+      def inspect
+        "<PeerStore::Address #{ip.inspect} udp_port: #{udp_port} tcp_port: #{tcp_port}>"
+      end
+    end
+
+  end
+end
+

data/lib/ciri/p2p/dial_scheduler.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+
+# Copyright (c) 2018 by Jiang Jinyang <jjyruby@gmail.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+
+require 'async'
+require 'ciri/utils/logger'
+
+module Ciri
+  module P2P
+
+    # DialScheduler
+    # establish outoging connections
+    class DialScheduler
+      include Utils::Logger
+
+      def initialize(network_state, dialer, dial_outgoing_interval_secs: 15)
+        @network_state = network_state
+        @dialer = dialer
+        @dial_outgoing_interval_secs = dial_outgoing_interval_secs
+      end
+
+      def run(task: Async::Task.current)
+        dial_bootnodes
+        # dial outgoing peers every 15 seconds
+        task.reactor.every(@dial_outgoing_interval_secs) do
+          task.async do
+            schedule_dialing_tasks
+          end
+        end
+      end
+
+      private
+
+      def dial_bootnodes
+        @network_state.peer_store.find_bootnodes(@network_state.number_of_attemp_outgoing).each do |node|
+          conn, handshake = @dialer.dial(node)
+          @network_state.new_peer_connected(conn, handshake, way_for_connection: Peer::OUTGOING)
+        end
+      end
+
+      def schedule_dialing_tasks
+        @network_state.peer_store.find_attempt_peers(@network_state.number_of_attemp_outgoing).each do |node|
+          # avoid dial self or connected peers
+          next if @network_state.peers.include?(node.raw_node_id) || node.raw_node_id == @network_state.local_node_id
+          conn, handshake = @dialer.dial(node)
+          @network_state.new_peer_connected(conn, handshake, way_for_connection: Peer::OUTGOING)
+        end
+      end
+    end
+
+  end
+end
+

data/lib/ciri/p2p/dialer.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+
+# Copyright (c) 2018 by Jiang Jinyang <jjyruby@gmail.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+
+require 'async/io'
+require 'async/io/stream'
+require_relative 'rlpx/connection'
+
+module Ciri
+  module P2P
+    # Discovery and dial new nodes
+    class Dialer
+      include RLPX
+
+      def initialize(private_key:, handshake:)
+        @private_key = private_key
+        @handshake = handshake
+      end
+
+      # setup a new connection to node
+      def dial(node)
+        # connect tcp socket
+        # Use Stream to buffer IO operation
+        address = node.addresses&.first
+        return unless address
+        socket = Async::IO::Stream.new(Async::IO::Endpoint.tcp(address.ip.to_s, address.tcp_port).connect)
+        c = Connection.new(socket)
+        c.encryption_handshake!(private_key: @private_key, remote_node_id: node.node_id)
+        remote_handshake = c.protocol_handshake!(@handshake)
+        [c, remote_handshake]
+      end
+    end
+  end
+end
+

data/lib/ciri/p2p/discovery/protocol.rb

@@ -0,0 +1,237 @@
+# frozen_string_literal: true
+
+
+# Copyright (c) 2018 by Jiang Jinyang <jjyruby@gmail.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+
+require 'ciri/utils/logger'
+require 'ciri/key'
+require 'ciri/rlp'
+require 'ciri/p2p/node'
+require 'ciri/p2p/errors'
+require 'ipaddr'
+
+module Ciri
+  module P2P
+    module Discovery
+      module Protocol
+
+        # implement the DiscV4 protocol
+        # https://github.com/ethereum/devp2p/blob/master/discv4.md
+        class Message
+
+          MAX_LEN=1280
+
+          attr_reader :message_hash, :packet_type, :packet_data
+
+          def initialize(message_hash:, signature:, packet_type:, packet_data:)
+            @message_hash = message_hash
+            @signature = signature
+            @packet_type = packet_type
+            @packet_data = packet_data
+          end
+
+          # compute key and return NodeID
+          def sender
+            @sender ||= begin
+                          encoded_packet_type = Utils.big_endian_encode(packet_type)
+                          public_key = Key.ecdsa_recover(Utils.keccak(encoded_packet_type + packet_data), @signature)
+                          NodeID.new(public_key)
+                        end
+          end
+
+          def packet
+            packet_class = case @packet_type
+                           when Ping::CODE
+                             Ping
+                           when Pong::CODE
+                             Pong
+                           when FindNode::CODE
+                             FindNode
+                           when Neighbors::CODE
+                             Neighbors
+                           else
+                             raise UnknownMessageCodeError.new("unkonwn discovery message code: #{@packet_type}")
+                           end
+            # TODO according discv4 protocol, rlp_decode should support ignore additional elements
+            # we should support ignore_extra_data option in Ciri::RLP
+            packet_class.rlp_decode @packet_data
+          end
+
+          # validate message hash and signature
+          def validate
+            encoded_packet_type = Utils.big_endian_encode(packet_type)
+            raise InvalidMessageError.new("mismatch hash") if message_hash != Utils.keccak(@signature + encoded_packet_type + packet_data)
+            begin
+              sender
+            rescue StandardError => e
+              raise InvalidMessageError.new("recover sender error: #{e}")
+            end
+          end
+
+          # encode message to string
+          def encode_message
+            buf = String.new
+            buf << message_hash
+            buf << @signature
+            buf << packet_type
+            buf << packet_data
+            buf
+          end
+
+          class << self
+            # return a Message
+            def decode_message(raw_bytes)
+              hash = raw_bytes[0...32]
+              # signature is 65 length r,s,v
+              signature = raw_bytes[32...97]
+              packet_type = Utils.big_endian_decode raw_bytes[97]
+              packet_data = raw_bytes[98..-1]
+              Message.new(message_hash: hash, signature: signature, packet_type: packet_type, packet_data: packet_data)
+            end
+
+            # return a new message instance include packet
+            def pack(packet, private_key:)
+              packet_data = Ciri::RLP.encode(packet)
+              packet_type = packet.class.code
+              encoded_packet_type = Utils.big_endian_encode(packet_type)
+              signature = private_key.ecdsa_signature(Utils.keccak(encoded_packet_type + packet_data)).to_s
+              hash = Utils.keccak(signature + encoded_packet_type + packet_data)
+              if (msg_size=hash.size + signature.size + encoded_packet_type.size + packet_data.size) > MAX_LEN
+                raise InvalidMessageError.new("failed to pack, message size is too long, size: #{msg_size}, max_len: #{MAX_LEN}")
+              end
+              Message.new(message_hash: hash, signature: signature, packet_type: packet_type, packet_data: packet_data)
+            end
+          end
+        end
+
+        # a struct represent which node send this packet
+        class From
+          include Ciri::RLP::Serializable
+
+          # we should not trust the sender_ip field
+          schema(
+            sender_ip: Integer,
+            sender_udp_port: Integer,
+            sender_tcp_port: Integer,
+          )
+        end
+
+        # a struct represent which node is target of this packet
+        class To
+          include Ciri::RLP::Serializable
+
+          # because discv4 protocol has not give us a name of last field,
+          # we just keep the field value 0 and guess it name should be recipient_tcp_port
+          # https://github.com/ethereum/devp2p/blob/master/discv4.md#ping-packet-0x01
+
+          schema(
+            recipient_ip: Integer,
+            recipient_udp_port: Integer,
+            recipient_tcp_port: Integer,
+          )
+          default_data(recipient_tcp_port: 0)
+
+          class << self
+            def from_inet_addr(address)
+              from_host_port(address.ip_address, address.ip_port)
+            end
+
+            def from_host_port(host, port)
+              new(recipient_ip: host.is_a?(IPAddr) ? host.to_i : IPAddr.new(host).to_i, recipient_udp_port: port)
+            end
+          end
+        end
+
+        # abstract class
+        class Packet
+          def self.code
+            self::CODE
+          end
+        end
+
+        class Ping < Packet
+          include Ciri::RLP::Serializable
+
+          CODE = 0x01
+
+          schema(
+            version: Integer,
+            from: From,
+            to: To,
+            expiration: Integer,
+          )
+
+          default_data(version: 0)
+        end
+
+        class Pong < Packet
+          include Ciri::RLP::Serializable
+
+          CODE = 0x02
+
+          schema(
+            to: To,
+            ping_hash: RLP::Bytes,
+            expiration: Integer,
+          )
+        end
+
+        class FindNode < Packet
+          include Ciri::RLP::Serializable
+
+          CODE = 0x03
+
+          schema(
+            target: RLP::Bytes,
+            expiration: Integer,
+          )
+        end
+
+        class Neighbors < Packet
+          include Ciri::RLP::Serializable
+
+          CODE = 0x04
+
+          # neighbour info
+          class Node
+            include Ciri::RLP::Serializable
+
+            schema(
+              ip: Integer,
+              udp_port: Integer,
+              tcp_port: Integer,
+              node_id: RLP::Bytes,
+            )
+          end
+
+          schema(
+            nodes: [Node],
+            expiration: Integer,
+          )
+        end
+
+      end
+
+    end
+  end
+end
+