reth 0.1.0

data/lib/reth/synchronizer.rb

@@ -0,0 +1,192 @@
+# -*- encoding : ascii-8bit -*-
+
+module Reth
+
+  ##
+  # Handles the synchronization of blocks.
+  #
+  # There's only one sync task active at a time. In order to deal with the
+  # worst case of initially syncing the wrong chain, a checkpoint blockhash
+  # can be specified and synced via force_sync.
+  #
+  # Received blocks are given to chainservice.add_block, which has a fixed
+  # size queue, the synchronization blocks if the queue is full.
+  #
+  # on_status:
+  #   if peer.head.chain_difficulty > chain.head.chain_difficulty
+  #     fetch peer.head and handle as newblock
+  #
+  # on_newblock:
+  #   if block.parent
+  #     add
+  #   else
+  #     sync
+  #
+  # on_blocks/on_blockhashes:
+  #   if synctask
+  #     handle to requester
+  #   elsif unkonwn and has parent
+  #     add to chain
+  #   else
+  #     drop
+  #
+  class Synchronizer
+
+    MAX_NEWBLOCK_AGE = 5 # maximum age (in blocks) of blocks received as newblock
+
+    attr :chain, :chainservice, :synctask
+
+    ##
+    # @param force_sync [Array, NilClass] If passed in array, it must be in
+    #   the form of tuple: (blockhash, chain_difficulty). Helper for long
+    #   initial syncs to get on the right chain used with first
+    #   status_received.
+    #
+    def initialize(chainservice, force_sync=nil)
+      @chainservice = chainservice
+      @force_sync = force_sync
+      @chain = chainservice.chain
+      @protocols = {} # proto => chain_difficulty
+      @synctask = nil
+    end
+
+    def syncing?
+      !!@synctask
+    end
+
+    def synctask_exited(success=false)
+      @force_sync = nil if success
+      @synctask = nil
+    end
+
+    def protocols
+      @protocols = @protocols
+        .map {|proto, diff| [proto, diff] }
+        .select {|tuple| !tuple[0].stopped? }
+        .to_h
+
+      @protocols.keys.sort_by {|proto| -@protocols[proto] }
+    end
+
+    ##
+    # Called if there's a newblock announced on the network.
+    #
+    def receive_newblock(proto, t_block, chain_difficulty)
+      logger.debug 'newblock', proto: proto, block: t_block, chain_difficulty: chain_difficulty, client: proto.peer.remote_client_version
+
+      if @chain.include?(t_block.header.full_hash)
+        raise AssertError, 'chain difficulty mismatch' unless chain_difficulty == @chain.get(t_block.header.full_hash).chain_difficulty
+      end
+
+      @protocols[proto] = chain_difficulty
+
+      if @chainservice.knows_block(t_block.header.full_hash)
+        logger.debug 'known block'
+        return
+      end
+
+      expected_difficulty = @chain.head.chain_difficulty + t_block.header.difficulty
+      if chain_difficulty >= @chain.head.chain_difficulty
+        # broadcast duplicates filtering is done in chainservice
+        logger.debug 'sufficient difficulty, broadcasting', client: proto.peer.remote_client_version
+        @chainservice.broadcast_newblock t_block, chain_difficulty, proto
+      else
+        age = @chain.head.number - t_block.header.number
+        logger.debug "low difficulty", client: proto.peer.remote_client_version, chain_difficulty: chain_difficulty, expected_difficulty: expected_difficulty, block_age: age
+
+        if age > MAX_NEWBLOCK_AGE
+          logger.debug 'newblock is too old, not adding', block_age: age, max_age: MAX_NEWBLOCK_AGE
+          return
+        end
+      end
+
+      if @chainservice.knows_block(t_block.header.prevhash)
+        logger.debug 'adding block'
+        @chainservice.add_block t_block, proto
+      else
+        logger.debug 'missing parent'
+        if @synctask
+          logger.debug 'existing task, discarding'
+        else
+          @synctask = SyncTask.new self, proto, t_block.header.full_hash, chain_difficulty
+        end
+      end
+    end
+
+    ##
+    # Called if a new peer is connected.
+    #
+    def receive_status(proto, blockhash, chain_difficulty)
+      logger.debug 'status received', proto: proto, chain_difficulty: chain_difficulty
+
+      @protocols[proto] = chain_difficulty
+
+      if @chainservice.knows_block(blockhash) || @synctask
+        logger.debug 'existing task or known hash, discarding'
+        return
+      end
+
+      if @force_sync
+        blockhash, difficulty = force_sync
+        logger.debug 'starting forced synctask', blockhash: Utils.encode_hex(blockhash)
+        @synctask = SyncTask.new self, proto, blockhash, difficulty
+      elsif chain_difficulty > @chain.head.chain_difficulty
+        logger.debug 'sufficient difficulty'
+        @synctask = SyncTask.new self, proto, blockhash, chain_difficulty
+      end
+    rescue
+      logger.debug $!
+      logger.debug $!.backtrace[0,10].join("\n")
+    end
+
+    ##
+    # No way to check if this really an interesting block at this point.
+    # Might lead to an amplification attack, need to track this proto and
+    # judge usefulness.
+    #
+    def receive_newblockhashes(proto, newblockhashes)
+      logger.debug 'received newblockhashes', num: newblockhashes.size, proto: proto
+
+      newblockhashes = newblockhashes.select {|h| !@chainservice.knows_block(h) }
+
+      known = @protocols.include?(proto)
+      if !known || newblockhashes.empty? || @synctask
+        logger.debug 'discarding', known: known, synctask: syncing?, num: newblockhashes.size
+        return
+      end
+
+      if newblockhashes.size != 1
+        logger.warn 'supporting only one newblockhash', num: newblockhashes.size
+      end
+      blockhash = newblockhashes[0]
+
+      logger.debug 'starting synctask for newblockhashes', blockhash: Utils.encode_hex(blockhash)
+      @synctask = SyncTask.new self, proto, blockhash, 0, true
+    end
+
+    def receive_blocks(proto, t_blocks)
+      logger.debug 'blocks received', proto: proto, num: t_blocks.size
+      if @synctask
+        @synctask.receive_blocks proto, t_blocks
+      else
+        logger.warn 'no synctask, not expecting blocks'
+      end
+    end
+
+    def receive_blockhashes(proto, blockhashes)
+      logger.debug 'blockhashes received', proto: proto, num: blockhashes.size
+      if @synctask
+        @synctask.receive_blockhashes proto, blockhashes
+      else
+        logger.warn 'no synctask, not expecting blockhashes'
+      end
+    end
+
+    private
+
+    def logger
+      @logger ||= Logger.new('eth.sync')
+    end
+  end
+
+end

data/lib/reth/transient_block.rb

@@ -0,0 +1,40 @@
+# -*- encoding : ascii-8bit -*-
+
+module Reth
+
+  class TransientBlock
+    include RLP::Sedes::Serializable
+
+    set_serializable_fields(
+      header: BlockHeader,
+      transaction_list: RLP::Sedes::CountableList.new(Transaction),
+      uncles: RLP::Sedes::CountableList.new(BlockHeader)
+    )
+
+    attr :newblock_timestamp
+
+    def initialize(block_data, newblock_timestamp=0)
+      @newblock_timestamp = newblock_timestamp
+
+      header = BlockHeader.deserialize block_data[0]
+      transaction_list = RLP::Sedes::CountableList.new(Transaction).deserialize block_data[1]
+      uncles = RLP::Sedes::CountableList.new(BlockHeader).deserialize block_data[2]
+      super(header, transaction_list, uncles)
+    end
+
+    def to_block(env, parent=nil)
+      Block.new header: header, transaction_list: transaction_list, uncles: uncles, env: env, parent: parent
+    end
+
+    def full_hash_hex
+      header.full_hash_hex
+    end
+
+    def to_s
+      "<TransientBlock(##{header.number} #{header.full_hash_hex[0,8]})"
+    end
+    alias inspect to_s
+
+  end
+
+end

data/lib/reth/utils.rb

@@ -0,0 +1,22 @@
+# -*- encoding : ascii-8bit -*-
+
+require 'securerandom'
+
+module Reth
+
+  module Utils
+
+    include ::Ethereum::Utils
+    extend self
+
+    def mk_random_privkey
+      SecureRandom.random_bytes(32)
+    end
+
+    def mk_privkey(seed)
+      keccak256 seed
+    end
+
+  end
+
+end

data/lib/reth/version.rb

@@ -0,0 +1,3 @@
+module Reth
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: reth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jan Xie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-ethereum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: devp2p
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.8.3
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+- !ruby/object:Gem::Dependency
+  name: serpent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: A ethereum full node written in ruby.
+email:
+- jan.h.xie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/reth
+- lib/reth.rb
+- lib/reth/account.rb
+- lib/reth/account_service.rb
+- lib/reth/app.rb
+- lib/reth/chain_service.rb
+- lib/reth/config.rb
+- lib/reth/db_service.rb
+- lib/reth/duplicates_filter.rb
+- lib/reth/eth_protocol.rb
+- lib/reth/genesisdata/genesis_frontier.json
+- lib/reth/genesisdata/genesis_morden.json
+- lib/reth/genesisdata/genesis_olympic.json
+- lib/reth/jsonrpc.rb
+- lib/reth/jsonrpc/app.rb
+- lib/reth/jsonrpc/filter.rb
+- lib/reth/jsonrpc/handler.rb
+- lib/reth/jsonrpc/helper.rb
+- lib/reth/jsonrpc/server.rb
+- lib/reth/jsonrpc/service.rb
+- lib/reth/keystore.rb
+- lib/reth/leveldb_service.rb
+- lib/reth/profile.rb
+- lib/reth/sync_task.rb
+- lib/reth/synchronizer.rb
+- lib/reth/transient_block.rb
+- lib/reth/utils.rb
+- lib/reth/version.rb
+homepage: https://github.com/janx/reth
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ethereum full node.
+test_files: []
+has_rdoc: