ethminer/libethereum/Client.cpp

/*
	This file is part of cpp-ethereum.

	cpp-ethereum 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.

	cpp-ethereum 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 cpp-ethereum.  If not, see <http://www.gnu.org/licenses/>.
*/
/** @file Client.cpp
 * @author Gav Wood <i@gavwood.com>
 * @date 2014
 */

#include "Client.h"

#include <chrono>
#include <thread>
#include <boost/filesystem.hpp>
#include <libethential/Common.h>
#include "Defaults.h"
#include "PeerServer.h"
using namespace std;
using namespace eth;

VersionChecker::VersionChecker(string const& _dbPath, unsigned _protocolVersion):
	m_path(_dbPath.size() ? _dbPath : Defaults::dbPath()),
	m_protocolVersion(_protocolVersion)
{
	m_ok = RLP(contents(m_path + "/protocol")).toInt<unsigned>(RLP::LaisezFaire) == _protocolVersion;
}

void VersionChecker::setOk()
{
	if (!m_ok)
	{
		try
		{
			boost::filesystem::create_directory(m_path);
		}
		catch (...) {}
		writeFile(m_path + "/protocol", rlp(m_protocolVersion));
	}
}

Client::Client(std::string const& _clientVersion, Address _us, std::string const& _dbPath, bool _forceClean):
	m_clientVersion(_clientVersion),
	m_vc(_dbPath, PeerServer::protocolVersion()),
	m_bc(_dbPath, !m_vc.ok() || _forceClean),
	m_stateDB(State::openDB(_dbPath, !m_vc.ok() || _forceClean)),
	m_preMine(_us, m_stateDB),
	m_postMine(_us, m_stateDB),
	m_workState(Active)
{
	if (_dbPath.size())
		Defaults::setDBPath(_dbPath);
	m_vc.setOk();
	m_changed = true;

	static const char* c_threadName = "eth";

	m_work.reset(new thread([&](){
		setThreadName(c_threadName);
		while (m_workState.load(std::memory_order_acquire) != Deleting)
			work();
		m_workState.store(Deleted, std::memory_order_release);

		// Synchronise the state according to the head of the block chain.
		// TODO: currently it contains keys for *all* blocks. Make it remove old ones.
		m_preMine.sync(m_bc);
		m_postMine = m_preMine;
	}));
}

Client::~Client()
{
	if (m_workState.load(std::memory_order_acquire) == Active)
		m_workState.store(Deleting, std::memory_order_release);
	while (m_workState.load(std::memory_order_acquire) != Deleted)
		this_thread::sleep_for(chrono::milliseconds(10));
	m_work->join();
}

void Client::startNetwork(unsigned short _listenPort, std::string const& _seedHost, unsigned short _port, NodeMode _mode, unsigned _peers, string const& _publicIP, bool _upnp)
{
	if (m_net.get())
		return;
	try
	{
		m_net.reset(new PeerServer(m_clientVersion, m_bc, 0, _listenPort, _mode, _publicIP, _upnp));
	}
	catch (std::exception const&)
	{
		// Probably already have the port open.
		cwarn << "Could not initialize with specified/default port. Trying system-assigned port";
		m_net.reset(new PeerServer(m_clientVersion, m_bc, 0, _mode, _publicIP, _upnp));
	}

	m_net->setIdealPeerCount(_peers);
	if (_seedHost.size())
		connect(_seedHost, _port);
}

std::vector<PeerInfo> Client::peers()
{
	return m_net ? m_net->peers() : std::vector<PeerInfo>();
}

size_t Client::peerCount() const
{
	return m_net ? m_net->peerCount() : 0;
}

void Client::connect(std::string const& _seedHost, unsigned short _port)
{
	if (!m_net.get())
		return;
	m_net->connect(_seedHost, _port);
}

void Client::stopNetwork()
{
	m_net.reset(nullptr);
}

void Client::startMining()
{
	m_doMine = true;
	m_restartMining = true;
}

void Client::stopMining()
{
	m_doMine = false;
}

void Client::transact(Secret _secret, u256 _value, Address _dest, bytes const& _data, u256 _gas, u256 _gasPrice)
{
	ClientGuard l(this);
	Transaction t;
	t.nonce = m_postMine.transactionsFrom(toAddress(_secret));
	t.value = _value;
	t.gasPrice = _gasPrice;
	t.gas = _gas;
	t.receiveAddress = _dest;
	t.data = _data;
	t.sign(_secret);
	cnote << "New transaction " << t;
	m_tq.attemptImport(t.rlp());
}

Address Client::transact(Secret _secret, u256 _endowment, bytes const& _init, u256 _gas, u256 _gasPrice)
{
	ClientGuard l(this);
	Transaction t;
	t.nonce = m_postMine.transactionsFrom(toAddress(_secret));
	t.value = _endowment;
	t.gasPrice = _gasPrice;
	t.gas = _gas;
	t.receiveAddress = Address();
	t.data = _init;
	t.sign(_secret);
	cnote << "New transaction " << t;
	m_tq.attemptImport(t.rlp());
	return right160(sha3(rlpList(t.sender(), t.nonce)));
}

void Client::inject(bytesConstRef _rlp)
{
	ClientGuard l(this);
	m_tq.attemptImport(_rlp);
	m_changed = true;
}

void Client::work()
{
	bool changed = false;

	// Process network events.
	// Synchronise block chain with network.
	// Will broadcast any of our (new) transactions and blocks, and collect & add any of their (new) transactions and blocks.
	if (m_net)
	{
		ClientGuard l(this);
		m_net->process();	// must be in guard for now since it uses the blockchain. TODO: make BlockChain thread-safe.

		if (m_net->sync(m_bc, m_tq, m_stateDB))
			changed = true;
	}

	// Synchronise state to block chain.
	// This should remove any transactions on our queue that are included within our state.
	// It also guarantees that the state reflects the longest (valid!) chain on the block chain.
	//   This might mean reverting to an earlier state and replaying some blocks, or, (worst-case:
	//   if there are no checkpoints before our fork) reverting to the genesis block and replaying
	//   all blocks.
	// Resynchronise state with block chain & trans
	{
		ClientGuard l(this);
		if (m_preMine.sync(m_bc) || m_postMine.address() != m_preMine.address())
		{
			if (m_doMine)
				cnote << "New block on chain: Restarting mining operation.";
			changed = true;
			m_restartMining = true;	// need to re-commit to mine.
			m_postMine = m_preMine;
		}
		if (m_postMine.sync(m_tq, &changed))
		{
			if (m_doMine)
				cnote << "Additional transaction ready: Restarting mining operation.";
			m_restartMining = true;
		}
	}

	if (m_doMine)
	{
		if (m_restartMining)
		{
			m_mineProgress.best = (double)-1;
			m_mineProgress.hashes = 0;
			m_mineProgress.ms = 0;
			ClientGuard l(this);
			if (m_paranoia)
			{
				if (m_postMine.amIJustParanoid(m_bc))
				{
					cnote << "I'm just paranoid. Block is fine.";
					m_postMine.commitToMine(m_bc);
				}
				else
				{
					cwarn << "I'm not just paranoid. Cannot mine. Please file a bug report.";
					m_doMine = false;
				}
			}
			else
				m_postMine.commitToMine(m_bc);
		}
	}

	if (m_doMine)
	{
		m_restartMining = false;

		// Mine for a while.
		MineInfo mineInfo = m_postMine.mine(100);

		m_mineProgress.best = min(m_mineProgress.best, mineInfo.best);
		m_mineProgress.current = mineInfo.best;
		m_mineProgress.requirement = mineInfo.requirement;
		m_mineProgress.ms += 100;
		m_mineProgress.hashes += mineInfo.hashes;
		{
			ClientGuard l(this);
			m_mineHistory.push_back(mineInfo);
		}

		if (mineInfo.completed)
		{
			// Import block.
			ClientGuard l(this);
			m_postMine.completeMine();
			m_bc.attemptImport(m_postMine.blockData(), m_stateDB);
			m_changed = true;
		}
	}
	else
		this_thread::sleep_for(chrono::milliseconds(100));

	m_changed = m_changed || changed;
}

void Client::lock() const
{
	m_lock.lock();
}

void Client::unlock() const
{
	m_lock.unlock();
}

unsigned Client::numberOf(int _n) const
{
	if (_n > 0)
		return _n;
	else if (_n == GenesisBlock)
		return 0;
	else
		return m_bc.details().number + max(-(int)m_bc.details().number, 1 + _n);
}

State Client::asOf(int _h) const
{
	if (_h == 0)
		return m_postMine;
	else if (_h == -1)
		return m_preMine;
	else
		return State(m_stateDB, m_bc, m_bc.numberHash(numberOf(_h)));
}

u256 Client::balanceAt(Address _a, int _block) const
{
	ClientGuard l(this);
	return asOf(_block).balance(_a);
}

u256 Client::countAt(Address _a, int _block) const
{
	ClientGuard l(this);
	return asOf(_block).transactionsFrom(_a);
}

u256 Client::stateAt(Address _a, u256 _l, int _block) const
{
	ClientGuard l(this);
	return asOf(_block).storage(_a, _l);
}

bytes Client::codeAt(Address _a, int _block) const
{
	ClientGuard l(this);
	return asOf(_block).code(_a);
}

bool TransactionFilter::matches(State const& _s, unsigned _i) const
{
	Transaction t = _s.pending()[_i];
	if (!m_to.empty() && !m_to.count(t.receiveAddress))
		return false;
	if (!m_from.empty() && !m_from.count(t.sender()))
		return false;
	if (m_stateAltered.empty() && m_altered.empty())
		return true;
	StateDiff d = _s.pendingDiff(_i);
	if (!m_altered.empty())
	{
		for (auto const& s: m_altered)
			if (d.accounts.count(s))
				return true;
		return false;
	}
	if (!m_stateAltered.empty())
	{
		for (auto const& s: m_stateAltered)
			if (d.accounts.count(s.first) && d.accounts.at(s.first).storage.count(s.second))
				return true;
		return false;
	}
	return true;
}

PastTransactions Client::transactions(TransactionFilter const& _f) const
{
	ClientGuard l(this);

	PastTransactions ret;
	unsigned begin = numberOf(_f.latest());
	unsigned end = min(begin, numberOf(_f.earliest()));
	unsigned m = _f.max();
	unsigned s = _f.skip();

	// Handle pending transactions differently as they're not on the block chain.
	if (_f.latest() == 0)
	{
		for (unsigned i = m_postMine.pending().size(); i-- && ret.size() != m;)
			if (_f.matches(m_postMine, i))
			{
				if (s)
					s--;
				else
					ret.insert(ret.begin(), PastTransaction(m_postMine.pending()[i], h256(), i, time(0), 0));
			}
		// Early exit here since we can't rely on begin/end, being out of the blockchain as we are.
		if (_f.earliest() == 0)
			return ret;
	}

	auto cn = m_bc.number();
	auto h = m_bc.numberHash(begin);
	for (unsigned n = begin; ret.size() != m && n != end; n--, h = m_bc.details(h).parent)
	{
		try
		{
			State st(m_stateDB, m_bc, h);
			for (unsigned i = st.pending().size(); i-- && ret.size() != m;)
				if (_f.matches(st, i))
				{
					if (s)
						s--;
					else
						ret.insert(ret.begin(), PastTransaction(st.pending()[i], h, i, BlockInfo(m_bc.block(h)).timestamp, cn - n + 2));
				}
		}
		catch (...)
		{
			// Gaa. bad state. not good at all. bury head in sand for now.
		}

		if (n == end)
			break;
	}
	return ret;
}