ciri-p2p 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d4f5def844a74637c9a5aae3a6716df8d35743bc165f818f166b3ba5b645a97
-  data.tar.gz: 7fa69fc607c4bed9a5e1d169743b0b4b4f9866141175648094fe7e14aee38e7c
+  metadata.gz: 84a78196ee2a9a850e3f893c8f3f7a4a30eae83eb9cde69537020215723b9a8e
+  data.tar.gz: '09e75872015ea1b557150db5650f4ef2ccd7bcd180b6fbfa2caa78eae705a769'
 SHA512:
-  metadata.gz: 633de9a2b3118aa103eafab18167c12a45c4f3852fa7f5c35e52667a92ced44bde8cdc4b843aabf4a9b441c5362ec6e8400e2aac8d98599fddbd44791fed1370
-  data.tar.gz: a9e761a941672630419300fccce12dc1a0726cf8db35c2a7961ac94c138d4265824af02149c672580423c92c661d3595dcc9588e75c6bf47a1ab106fb56a9244
+  metadata.gz: adb6135d935ee3ec9e4aa77c65a0aa44d741481acc44b30d6c880f6a9e35732243fdb9e318fee7a99efaab4d3370c3bfdb31d1a9d3bd2a2729e74a501f3b1b4a
+  data.tar.gz: ce7fcafe49551d9a0cbb9d62496395524d21507053f48add1f9d06101ee123930e2d09d6c082b0c671f3edeb46fe4fd37832513b6c9198fb45e15ff760ecee05

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "secp256k1"]
+	path = secp256k1
+	url = https://github.com/bitcoin-core/secp256k1.git

data/.travis.yml

@@ -8,8 +8,8 @@ install:
   - echo "install nothing"
 
 before_install:
-  - docker pull ciriethereum/ciri:latest
+  - docker pull ciriethereum/ciri-p2p-test:latest
 
 script:
-  - docker run -v `pwd`:/app --rm ciriethereum/ciri:latest bash -c 'bundle install && bundle exec rspec'
+  - docker run -v `pwd`:/app --rm ciriethereum/ciri-p2p-test:latest bash -c 'bundle install && bundle exec rake'
 

data/Dockerfile

@@ -0,0 +1,21 @@
+FROM ruby:2.6.0-preview2 AS build
+
+LABEL maintainer="Jiang Jinyang <jjyruby@gmail.com>"
+
+# install bitcoin secp256k1
+COPY . /app
+WORKDIR /app
+RUN rake install:secp256k1
+
+# Runtime image
+FROM ruby:2.6.0-preview2
+
+# install runtime dependencies libraries
+RUN apt-get update && apt-get install -y libsnappy-dev libgflags-dev zlib1g-dev libbz2-dev liblz4-dev libzstd-dev
+
+# copy header files and shared libraries
+COPY --from=build /usr/local/include /usr/local/include
+COPY --from=build /usr/local/lib/ /usr/local/lib
+
+WORKDIR /app
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ciri-p2p (0.1.0)
+    ciri-p2p (0.2.0)
       async (~> 1.10.3)
       async-io (~> 1.15.5)
       ciri-common (~> 0.1.0)

data/README.md

@@ -3,10 +3,37 @@
 
 P2P network implementation for [Ciri Ethereum](https://github.com/ciri-ethereum/ciri).
 
-`ciri-p2p` is a DevP2P implementation, we also seek to implement LibP2P components upon ciri-p2p codebase in the future.
+`ciri-p2p` is a [DevP2P](https://github.com/ethereum/devp2p) implementation, we also seek to implement [LibP2P](https://github.com/libp2p/libp2p) components upon ciri-p2p codebase in the future.
 
 ## Installation
 
+### Install dependencies
+
+Ciri P2P depend on `secp256k1` to handle crypto signature and depend on `snappy` to compress data.
+
+Build and install `secp256k1`
+
+``` bash
+cd ciri
+git submodule init && git submodule update
+rake install:secp256k1
+```
+
+On Mac you can install `snappy` with homebrew
+
+``` bash
+brew install snappy
+```
+
+For linux users, remember to check [Dockerfile](/docker) instructions for hint.
+
+then run tests: 
+``` bash
+bundle exec rake spec
+```
+
+### Install as Gem
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -23,7 +50,7 @@ Or install it yourself as:
 
 ## Usage
 
-Check spec directory.
+Check [spec](https://github.com/ciri-ethereum/ciri-p2p/tree/master/spec) directory.
 
 ## Development
 

data/Rakefile

@@ -1,6 +1,77 @@
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'fileutils'
+require 'tmpdir'
 
-RSpec::Core::RakeTask.new(:spec)
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+rescue LoadError
+  warn("rspec not installed, use `gem install rspec-core` to install")
+end
+
+namespace :install do
+  desc "Build and install secp256k1 shared library"
+  task :secp256k1 do
+    Dir.mktmpdir do |path|
+      source_dir = "secp256k1"
+      build_dir = "#{path}/#{source_dir}"
+      FileUtils.copy_entry source_dir, build_dir
+      Dir.chdir(build_dir)
+      run("./autogen.sh")
+      run("./configure --enable-module-recovery --enable-experimental --enable-module-ecdh")
+      run("make")
+      run("make install")
+    end
+    puts "Success installed secp256k1"
+  end
+
+  desc "Build and install all"
+  task all: [:secp256k1, :install]
+end
+
+namespace :docker do
+  base_image = 'ciriethereum/ciri-p2p-test'
+
+  desc 'pull docker image'
+  task :pull do
+    run("docker pull #{base_image}:latest")
+  end
+
+  desc 'build docker image, rerun this task after updated Gemfile or Dockerfile'
+  task :build do
+    system("git submodule init && git submodule update")
+    run("docker build . -f Dockerfile -t #{base_image}:latest")
+  end
+
+  desc 'push docker image'
+  task :push do
+    run("docker push #{base_image}:latest")
+  end
+
+  desc 'open Ciri P2P develop container shell'
+  task :shell do
+    container_name = 'ciri-p2p-develop'
+    if system("docker inspect #{container_name} > /dev/null")
+      system("docker start -i #{container_name}")
+    else
+      puts "start a new develop container: #{container_name}"
+      system("docker run -v `pwd`:/app -it --name #{container_name} #{base_image}:latest bash")
+    end
+  end
+
+  desc 'run spec in docker'
+  task :spec do |task, args|
+    run("docker run -v `pwd`:/app --rm #{base_image}:latest rake")
+  end
+end
+
+private
+
+def run(cmd)
+  puts "$ #{cmd}"
+  pid = spawn(cmd)
+  Process.wait(pid)
+  exit $?.exitstatus unless $?.success?
+end
 
-task :default => :spec

data/ciri-p2p.gemspec

@@ -5,7 +5,7 @@ require "ciri/p2p/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "ciri-p2p"
-  spec.version       = Ciri::P2p::VERSION
+  spec.version       = Ciri::P2P::VERSION
   spec.authors       = ["jjy"]
   spec.email         = ["jjyruby@gmail.com"]
 

data/lib/ciri/p2p/dial_scheduler.rb

@@ -54,7 +54,7 @@ module Ciri
       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)
+          @network_state.new_peer_connected(conn, handshake, direction: Peer::OUTGOING)
         end
       end
 
@@ -63,7 +63,7 @@ module Ciri
           # 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)
+          @network_state.new_peer_connected(conn, handshake, direction: Peer::OUTGOING)
         end
       end
     end

data/lib/ciri/p2p/network_state.rb

@@ -23,6 +23,7 @@
 
 
 require 'async'
+require 'async/semaphore'
 require 'ciri/utils/logger'
 require_relative 'peer'
 require_relative 'errors'
@@ -40,6 +41,7 @@ module Ciri
 
       def initialize(protocols:, peer_store:, local_node_id:, max_outgoing: 10, max_incoming: 10, ping_interval_secs: 15)
         @peers = {}
+        @peers_lock = Async::Semaphore.new
         @peer_store = peer_store
         @protocols = protocols
         @local_node_id = local_node_id
@@ -60,35 +62,41 @@ module Ciri
         @max_outgoing - @peers.values.select(&:outgoing?).count
       end
 
-      def new_peer_connected(connection, handshake, way_for_connection:, task: Async::Task.current)
-        protocol_handshake_checks(handshake)
-        peer = Peer.new(connection, handshake, @protocols, way_for_connection: way_for_connection)
-        # disconnect already connected peers
-        if @peers.include?(peer.raw_node_id)
-          debug("[#{local_node_id.short_hex}] peer #{peer} is already connected")
-          return
-        end
-        @peers[peer.raw_node_id] = peer
-        debug "[#{local_node_id.short_hex}] connect to new peer #{peer}"
-        @peer_store.update_peer_status(peer.raw_node_id, PeerStore::Status::CONNECTED)
-        # run peer logic
-        task.async do
-          register_peer_protocols(peer)
-          handling_peer(peer)
+      def new_peer_connected(connection, handshake, direction:, task: Async::Task.current)
+        @peers_lock.acquire do
+          peer = Peer.new(connection, handshake, @protocols, direction: direction)
+          # disconnect already connected peers
+          if @peers.include?(peer.raw_node_id)
+            debug("[#{local_node_id.short_hex}] peer #{peer.inspect} is already connected")
+            # disconnect duplicate connection
+            peer.disconnect
+            return
+          end
+          # check peers
+          protocol_handshake_checks(handshake)
+          @peers[peer.raw_node_id] = peer
+          debug "[#{local_node_id.short_hex}] connect to new peer #{peer.inspect}"
+          @peer_store.update_peer_status(peer.raw_node_id, PeerStore::Status::CONNECTED)
+          # run peer logic
+          task.async do
+            register_peer_protocols(peer)
+            handling_peer(peer)
+          end
         end
       end
 
-      def remove_peer(peer)
-        @peers.delete(peer.raw_node_id)
-        deregister_peer_protocols(peer)
-      end
-
       def disconnect_peer(peer, reason: nil)
-        return unless @peers.include?(peer.raw_node_id)
-        debug("[#{local_node_id.short_hex}] disconnect peer: #{peer}, reason: #{reason}")
-        remove_peer(peer)
-        peer.disconnect
-        @peer_store.update_peer_status(peer.raw_node_id, PeerStore::Status::DISCONNECTED)
+        @peers_lock.acquire do
+          # only disconnect from peers if direction correct to avoiding delete peer by mistake
+          if (exist_peer = @peers[peer.raw_node_id]) && exist_peer.direction == peer.direction
+            debug("[#{local_node_id.short_hex}] disconnect peer: #{peer.inspect}, reason: #{reason}")
+            remove_peer(peer)
+            peer.disconnect
+            @peer_store.update_peer_status(peer.raw_node_id, PeerStore::Status::DISCONNECTED)
+          else
+            debug("[#{local_node_id.short_hex}] Ignoring: disconnect peer: #{peer.inspect}, reason: #{reason}")
+          end
+        end
       end
 
       def disconnect_all
@@ -100,6 +108,12 @@ module Ciri
 
       private
 
+      def remove_peer(peer)
+        @peers.delete(peer.raw_node_id)
+        deregister_peer_protocols(peer)
+      end
+
+
       def register_peer_protocols(peer, task: Async::Task.current)
         peer.protocol_ios.dup.each do |protocol_io|
           task.async do
@@ -107,7 +121,7 @@ module Ciri
             context = ProtocolContext.new(self, peer: peer, protocol: protocol_io.protocol, protocol_io: protocol_io)
             context.protocol.connected(context)
           rescue StandardError => e
-            error("Protocol#connected error: {e}\nbacktrace: #{e.backtrace.join "\n"}")
+            error("Protocol#connected error: #{e}\nbacktrace: #{e.backtrace.join "\n"}")
             disconnect_peer(peer, reason: "Protocol#connected callback error: #{e}")
           end
         end

data/lib/ciri/p2p/peer.rb

@@ -35,22 +35,22 @@ module Ciri
       OUTGOING = :outgoing
       INCOMING = :incoming
 
-      attr_reader :connection
+      attr_reader :connection, :direction
 
-      def initialize(connection, handshake, protocols, way_for_connection:)
+      def initialize(connection, handshake, protocols, direction:)
         @connection = connection
         @handshake = handshake
         @protocols = protocols
         @protocol_io_hash = make_protocol_io_hash(protocols, handshake.caps, connection)
-        @way_for_connection = way_for_connection
+        @direction = direction
       end
 
       def outgoing?
-        @way_for_connection == OUTGOING
+        @direction == OUTGOING
       end
 
       def incoming?
-        @way_for_connection == INCOMING
+        @direction == INCOMING
       end
 
       def to_s
@@ -60,7 +60,7 @@ module Ciri
       end
 
       def inspect
-        "<Peer:#{to_s}>"
+        "<Peer:#{to_s} direction: #{@direction}>"
       end
 
       def hash

data/lib/ciri/p2p/server.rb

@@ -148,7 +148,7 @@ module Ciri
             c = Connection.new(client)
             c.encryption_handshake!(private_key: @private_key)
             remote_handshake = c.protocol_handshake!(handshake)
-            @network_state.new_peer_connected(c, remote_handshake, way_for_connection: Peer::INCOMING)
+            @network_state.new_peer_connected(c, remote_handshake, direction: Peer::INCOMING)
           end
         end
       end

data/lib/ciri/p2p/version.rb

@@ -1,5 +1,6 @@
 module Ciri
-  module P2p
-    VERSION = "0.1.0"
+  module P2P
+    VERSION = "0.2.0"
   end
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ciri-p2p
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - jjy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-13 00:00:00.000000000 Z
+date: 2018-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ciri-utils
@@ -159,10 +159,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitmodules"
 - ".rspec"
 - ".travis.yml"
-- ".vscode/launch.json"
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt

data/.vscode/launch.json

@@ -1,90 +0,0 @@
-{
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Debug Local File",
-            "type": "Ruby",
-            "request": "launch",
-            "cwd": "${workspaceRoot}",
-            "program": "${workspaceRoot}/main.rb"
-        },
-        {
-            "name": "Listen for rdebug-ide",
-            "type": "Ruby",
-            "request": "attach",
-            "cwd": "${workspaceRoot}",
-            "remoteHost": "127.0.0.1",
-            "remotePort": "1234",
-            "remoteWorkspaceRoot": "${workspaceRoot}"
-        },
-        {
-            "name": "Rails server",
-            "type": "Ruby",
-            "request": "launch",
-            "cwd": "${workspaceRoot}",
-            "program": "${workspaceRoot}/bin/rails",
-            "args": [
-                "server"
-            ]
-        },
-        {
-            "name": "RSpec - all",
-            "type": "Ruby",
-            "request": "launch",
-            "cwd": "${workspaceRoot}",
-            "program": "${workspaceRoot}/bin/rspec",
-            "args": [
-                "-I",
-                "${workspaceRoot}"
-            ]
-        },
-        {
-            "name": "RSpec - quick",
-            "type": "Ruby",
-            "request": "launch",
-            "cwd": "${workspaceRoot}",
-            "program": "${workspaceRoot}/bin/rake",
-            "args": [
-                "test"
-            ]
-        },
-        {
-            "name": "RSpec - BlockChainSpec",
-            "type": "Ruby",
-            "request": "launch",
-            "cwd": "${workspaceRoot}",
-            "program": "${workspaceRoot}/bin/rspec",
-            "args": [
-                "-t",
-                "~slow_tests",
-                "spec/ciri/fixtures_tests/block_chain_spec.rb"
-            ],
-            "env": {
-                "DEBUG": true,
-                "RUBY_THREAD_VM_STACK_SIZE": 52428800
-            }
-        },
-        {
-            "name": "RSpec - active spec file only",
-            "type": "Ruby",
-            "request": "launch",
-            "cwd": "${workspaceRoot}",
-            "program": "${workspaceRoot}/bin/rspec",
-            "args": [
-                "-I",
-                "${workspaceRoot}",
-                "${file}"
-            ]
-        },
-        {
-            "name": "Cucumber",
-            "type": "Ruby",
-            "request": "launch",
-            "cwd": "${workspaceRoot}",
-            "program": "${workspaceRoot}/bin/cucumber"
-        }
-    ]
-}