// Copyright 2015, 2016 Ethcore (UK) Ltd. // This file is part of Parity. // Parity is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // Parity is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with Parity. If not, see . //! LES Protocol Version 1 implementation. //! //! This uses a "Provider" to answer requests and syncs to a `Client`. //! See https://github.com/ethcore/parity/wiki/Light-Ethereum-Subprotocol-(LES) use ethcore::light::{Client, Provider}; use io::TimerToken; use network::{NetworkProtocolHandler, NetworkService, NetworkContext, NetworkError, PeerId}; use rlp::{DecoderError, RlpStream, Stream, UntrustedRlp, View}; use util::hash::H256; use parking_lot::{Mutex, RwLock}; use std::collections::{HashMap, HashSet}; use std::sync::atomic::{AtomicUsize, Ordering}; const TIMEOUT: TimerToken = 0; const TIMEOUT_INTERVAL_MS: u64 = 1000; // LPV1 const PROTOCOL_VERSION: u32 = 1; // TODO [rob] make configurable. const PROTOCOL_ID: [u8; 3] = *b"les"; // TODO [rob] Buffer flow. // packet ID definitions. mod packet { // the status packet. pub const STATUS: u8 = 0x00; // broadcast that new block hashes have appeared. pub const NEW_BLOCK_HASHES: u8 = 0x01; // request and response for block headers pub const GET_BLOCK_HEADERS: u8 = 0x02; pub const BLOCK_HEADERS: u8 = 0x03; // request and response for block bodies pub const GET_BLOCK_BODIES: u8 = 0x04; pub const BLOCK_BODIES: u8 = 0x05; // request and response for transaction receipts. pub const GET_RECEIPTS: u8 = 0x06; pub const RECEIPTS: u8 = 0x07; // request and response for merkle proofs. pub const GET_PROOFS: u8 = 0x08; pub const PROOFS: u8 = 0x09; // request and response for contract code. pub const GET_CONTRACT_CODES: u8 = 0x0a; pub const CONTRACT_CODES: u8 = 0x0b; // relay transactions to peers. pub const SEND_TRANSACTIONS: u8 = 0x0c; // request and response for header proofs in a CHT. pub const GET_HEADER_PROOFS: u8 = 0x0d; pub const HEADER_PROOFS: u8 = 0x0e; // broadcast dynamic capabilities. pub const CAPABILITIES: u8 = 0x0f; // request and response for block-level state deltas. pub const GET_BLOCK_DELTAS: u8 = 0x10; pub const BLOCK_DELTAS: u8 = 0x11; // request and response for transaction proofs. pub const GET_TRANSACTION_PROOFS: u8 = 0x12; pub const TRANSACTION_PROOFS: u8 = 0x13; } struct Request; struct Requested { timestamp: usize, total: Request, } // data about each peer. struct Peer { buffer: u64, // remaining buffer value. current_asking: HashSet, // pending request ids. } /// This handles synchronization of the header chain for a light client. pub struct Chain { client: Client, genesis_hash: H256, mainnet: bool, peers: RwLock>, pending_requests: RwLock>, req_id: AtomicUsize, } impl Chain { // make a request to a given peer. fn request_from(&self, peer: &PeerId, req: Request) { unimplemented!() } // called when a peer connects. fn on_connect(&self, peer: &PeerId, io: &NetworkContext) { let peer = *peer; match self.send_status(peer, io) { Ok(()) => { self.peers.write().insert(peer, Peer { buffer: 0, current_asking: HashSet::new(), }); } Err(e) => { trace!(target: "les", "Error while sending status: {}", e); io.disable_peer(peer); } } } // called when a peer disconnects. fn on_disconnect(&self, peer: PeerId, io: &NetworkContext) { // TODO: reassign all requests assigned to this peer. self.peers.write().remove(&peer); } fn send_status(&self, peer: PeerId, io: &NetworkContext) -> Result<(), NetworkError> { let chain_info = self.client.chain_info(); // TODO [rob] use optional keys too. let mut stream = RlpStream::new_list(6); stream .new_list(2) .append("protocolVersion") .append(&PROTOCOL_VERSION) .new_list(2) .append("networkId") .append(&(self.mainnet as u8)) .new_list(2) .append("headTd") .append(&chain_info.total_difficulty) .new_list(2) .append("headHash") .append(&chain_info.best_block_hash) .new_list(2) .append("headNum") .append(&chain_info.best_block_number) .new_list(2) .append("genesisHash") .append(&self.genesis_hash); io.send(peer, packet::STATUS, stream.out()) } /// Check on the status of all pending requests. fn check_pending_requests(&self) { unimplemented!() } fn status(&self, peer: &PeerId, io: &NetworkContext) { unimplemented!() } // Handle a new block hashes message. fn new_block_hashes(&self, peer: &PeerId, io: &NetworkContext, data: UntrustedRlp) { const MAX_NEW_HASHES: usize = 256; unimplemented!() } // Handle a request for block headers. fn get_block_headers(&self, peer: &PeerId, io: &NetworkContext, data: UntrustedRlp) { const MAX_HEADERS: usize = 512; unimplemented!() } // Receive a response for block headers. fn block_headers(&self, peer: &PeerId, io: &NetworkContext, data: UntrustedRlp) { unimplemented!() } // Handle a request for block bodies. fn get_block_bodies(&self, peer: &PeerId, io: &NetworkContext, data: UntrustedRlp) { unimplemented!() } // Receive a response for block bodies. fn block_bodies(&self, peer: &PeerId, io: &NetworkContext, data: UntrustedRlp) { unimplemented!() } // Handle a request for proofs. fn get_proofs(&self, peer: &PeerId, io: &NetworkContext, data: UntrustedRlp) { unimplemented!() } // Receive a response for proofs. fn proofs(&self, peer: &PeerId, io: &NetworkContext, data: UntrustedRlp) { unimplemented!() } // Handle a request for contract code. fn get_contract_code(&self, peer: &PeerId, io: &NetworkContext, data: UntrustedRlp) { unimplemented!() } // Receive a response for contract code. fn contract_code(&self, peer: &PeerId, io: &NetworkContext, data: UntrustedRlp) { unimplemented!() } // Handle a request for header proofs fn get_header_proofs(&self, peer: &PeerId, io: &NetworkContext, data: UntrustedRlp) { unimplemented!() } // Receive a response for header proofs fn header_proofs(&self, peer: &PeerId, io: &NetworkContext, data: UntrustedRlp) { unimplemented!() } // Receive a set of transactions to relay. fn relay_transactions(&self, peer: &PeerId, io: &NetworkContext, data: UntrustedRlp) { unimplemented!() } // Receive updated capabilities from a peer. fn capabilities(&self, peer: &PeerId, io: &NetworkContext, data: UntrustedRlp) { unimplemented!() } // Handle a request for block deltas. fn get_block_deltas(&self, peer: &PeerId, io: &NetworkContext, data: UntrustedRlp) { unimplemented!() } // Receive block deltas. fn block_deltas(&self, peer: &PeerId, io: &NetworkContext, data: UntrustedRlp) { unimplemented!() } // Handle a request for transaction proofs. fn get_transaction_proofs(&self, peer: &PeerId, io: &NetworkContext, data: UntrustedRlp) { unimplemented!() } // Receive transaction proofs. fn transaction_proofs(&self, peer: &PeerId, io: &NetworkContext, data: UntrustedRlp) { unimplemented!() } } impl NetworkProtocolHandler for Chain { fn initialize(&self, io: &NetworkContext) { io.register_timer(TIMEOUT, TIMEOUT_INTERVAL_MS).expect("Error registering sync timer."); } fn read(&self, io: &NetworkContext, peer: &PeerId, packet_id: u8, data: &[u8]) { let rlp = UntrustedRlp::new(data); match packet_id { packet::STATUS => self.status(peer, io, rlp), packet::NEW_BLOCK_HASHES => self.new_block_hashes(peer, io, rlp), packet::GET_BLOCK_HEADERS => self.get_block_headers(peer, io, rlp), packet::BLOCK_HEADERS => self.block_headers(peer, io, rlp), packet::GET_BLOCK_BODIES => self.get_block_bodies(peer, io, rlp), packet::BLOCK_BODIES => self.block_bodies(peer, io, rlp), packet::GET_RECEIPTS => self.get_receipts(peer, io, rlp), packet::RECEIPTS => self.receipt(peer, io, rlp), packet::GET_PROOFS => self.get_proofs(peer, io, rlp), packet::PROOFS => self.proofs(peer, io, rlp), packet::GET_CONTRACT_CODES => self.get_contract_code(peer, io, rlp), packet::CONTRACT_CODES => self.contract_code(peer, io, rlp), packet::SEND_TRANSACTIONS => self.relay_transactions(peer, io, rlp), packet::CAPABILITIES => self.capabilities(peer, io, rlp), packet::GET_HEADER_PROOFS => self.get_header_proofs(peer, io, rlp), packet::HEADER_PROOFS => self.header_proofs(peer, io, rlp), packet::GET_BLOCK_DELTAS => self.get_block_deltas(peer, io, rlp), packet::BLOCK_DELTAS => self.block_deltas(peer, io, rlp), packet::GET_TRANSACTION_PROOFS => self.get_transaction_proofs(peer, io, rlp), packet::TRANSACTION_PROOFS => self.transaction_proofs(peer, io, rlp), } } fn connected(&self, io: &NetworkContext, peer: &PeerId) { self.on_connect(peer, io); } fn disconnected(&self, io: &NetworkContext, peer: &PeerId) { self.on_disconnect(peer, io); } fn timeout(&self, io: &NetworkContext, timer: TimerToken) { match timer { TIMEOUT => { // broadcast transactions to peers. // update buffer flow. } _ => warn!(target: "les", "received timeout on unknown token {}", timer), } } }