openethereum/bin/oe/lib.rs

// Copyright 2015-2020 Parity Technologies (UK) Ltd.
// This file is part of OpenEthereum.

// OpenEthereum 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.

// OpenEthereum 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 OpenEthereum.  If not, see <http://www.gnu.org/licenses/>.

//! Ethcore client application.
#![warn(missing_docs)]

extern crate ansi_term;
extern crate docopt;
#[macro_use]
extern crate clap;
extern crate atty;
extern crate dir;
extern crate futures;
extern crate jsonrpc_core;
extern crate num_cpus;
extern crate number_prefix;
extern crate parking_lot;
extern crate regex;
extern crate rlp;
extern crate rpassword;
extern crate rustc_hex;
extern crate semver;
extern crate serde;
extern crate serde_json;
#[macro_use]
extern crate serde_derive;
extern crate toml;

extern crate blooms_db;
extern crate cli_signer;
extern crate common_types as types;
extern crate ethcore;
extern crate ethcore_call_contract as call_contract;
extern crate ethcore_db;
extern crate ethcore_io as io;
extern crate ethcore_logger;
extern crate ethcore_miner as miner;
extern crate ethcore_network as network;
extern crate ethcore_service;
extern crate ethcore_sync as sync;
extern crate ethereum_types;
extern crate ethkey;
extern crate ethstore;
extern crate fetch;
extern crate hyper;
extern crate journaldb;
extern crate keccak_hash as hash;
extern crate kvdb;
extern crate node_filter;
extern crate parity_bytes as bytes;
extern crate parity_local_store as local_store;
extern crate parity_path as path;
extern crate parity_rpc;
extern crate parity_runtime;
extern crate parity_version;
extern crate prometheus;
extern crate stats;

#[macro_use]
extern crate log as rlog;

#[cfg(feature = "ethcore-accounts")]
extern crate ethcore_accounts as accounts;

#[cfg(feature = "secretstore")]
extern crate ethcore_secretstore;

#[cfg(test)]
#[macro_use]
extern crate pretty_assertions;

#[cfg(test)]
extern crate tempdir;

#[cfg(test)]
#[macro_use]
extern crate lazy_static;

mod account;
mod account_utils;
mod blockchain;
mod cache;
mod cli;
mod configuration;
mod db;
mod helpers;
mod informant;
mod metrics;
mod modules;
mod params;
mod presale;
mod rpc;
mod rpc_apis;
mod run;
mod secretstore;
mod signer;
mod snapshot;
mod upgrade;
mod user_defaults;

use std::{fs::File, io::BufReader, sync::Arc};

use cli::Args;
use configuration::{Cmd, Execute};
use hash::keccak_buffer;

#[cfg(feature = "memory_profiling")]
use std::alloc::System;

pub use self::{configuration::Configuration, run::RunningClient};
pub use ethcore_logger::{setup_log, Config as LoggerConfig, RotatingLogger};
pub use parity_rpc::PubSubSession;

#[cfg(feature = "memory_profiling")]
#[global_allocator]
static A: System = System;

fn print_hash_of(maybe_file: Option<String>) -> Result<String, String> {
    if let Some(file) = maybe_file {
        let mut f =
            BufReader::new(File::open(&file).map_err(|_| "Unable to open file".to_owned())?);
        let hash = keccak_buffer(&mut f).map_err(|_| "Unable to read from file".to_owned())?;
        Ok(format!("{:x}", hash))
    } else {
        Err("Streaming from standard input not yet supported. Specify a file.".to_owned())
    }
}

#[cfg(feature = "deadlock_detection")]
fn run_deadlock_detection_thread() {
    use ansi_term::Style;
    use parking_lot::deadlock;
    use std::{thread, time::Duration};

    info!("Starting deadlock detection thread.");
    // Create a background thread which checks for deadlocks every 10s
    thread::spawn(move || loop {
        thread::sleep(Duration::from_secs(10));
        let deadlocks = deadlock::check_deadlock();
        if deadlocks.is_empty() {
            continue;
        }

        warn!(
            "{} {} detected",
            deadlocks.len(),
            Style::new().bold().paint("deadlock(s)")
        );
        for (i, threads) in deadlocks.iter().enumerate() {
            warn!("{} #{}", Style::new().bold().paint("Deadlock"), i);
            for t in threads {
                warn!("Thread Id {:#?}", t.thread_id());
                warn!("{:#?}", t.backtrace());
            }
        }
    });
}

/// Action that OpenEthereum performed when running `start`.
pub enum ExecutionAction {
    /// The execution didn't require starting a node, and thus has finished.
    /// Contains the string to print on stdout, if any.
    Instant(Option<String>),

    /// The client has started running and must be shut down manually by calling `shutdown`.
    ///
    /// If you don't call `shutdown()`, execution will continue in the background.
    Running(RunningClient),
}

fn execute(command: Execute, logger: Arc<RotatingLogger>) -> Result<ExecutionAction, String> {
    #[cfg(feature = "deadlock_detection")]
    run_deadlock_detection_thread();

    match command.cmd {
        Cmd::Run(run_cmd) => {
            let outcome = run::execute(run_cmd, logger)?;
            Ok(ExecutionAction::Running(outcome))
        }
        Cmd::Version => Ok(ExecutionAction::Instant(Some(Args::print_version()))),
        Cmd::Hash(maybe_file) => {
            print_hash_of(maybe_file).map(|s| ExecutionAction::Instant(Some(s)))
        }
        Cmd::Account(account_cmd) => {
            account::execute(account_cmd).map(|s| ExecutionAction::Instant(Some(s)))
        }
        Cmd::ImportPresaleWallet(presale_cmd) => {
            presale::execute(presale_cmd).map(|s| ExecutionAction::Instant(Some(s)))
        }
        Cmd::Blockchain(blockchain_cmd) => {
            blockchain::execute(blockchain_cmd).map(|_| ExecutionAction::Instant(None))
        }
        Cmd::SignerToken(ws_conf, logger_config) => {
            signer::execute(ws_conf, logger_config).map(|s| ExecutionAction::Instant(Some(s)))
        }
        Cmd::SignerSign {
            id,
            pwfile,
            port,
            authfile,
        } => cli_signer::signer_sign(id, pwfile, port, authfile)
            .map(|s| ExecutionAction::Instant(Some(s))),
        Cmd::SignerList { port, authfile } => {
            cli_signer::signer_list(port, authfile).map(|s| ExecutionAction::Instant(Some(s)))
        }
        Cmd::SignerReject { id, port, authfile } => {
            cli_signer::signer_reject(id, port, authfile).map(|s| ExecutionAction::Instant(Some(s)))
        }
        Cmd::Snapshot(snapshot_cmd) => {
            snapshot::execute(snapshot_cmd).map(|s| ExecutionAction::Instant(Some(s)))
        }
    }
}

/// Starts the OpenEthereum client.
///
/// The first parameter is the command line arguments that you would pass when running the openethereum
/// binary.
///
/// On error, returns what to print on stderr.
// FIXME: totally independent logging capability, see https://github.com/openethereum/openethereum/issues/10252
pub fn start(conf: Configuration, logger: Arc<RotatingLogger>) -> Result<ExecutionAction, String> {
    execute(conf.into_command()?, logger)
}