Interface.h

Go to the documentation of this file.

/*
        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/>.
*/
#pragma once

#include <libdevcore/Common.h>
#include <libdevcore/CommonIO.h>
#include <libdevcore/Guards.h>
#include <libdevcrypto/Common.h>
#include <libethcore/SealEngine.h>
#include "GasPricer.h"
#include "LogFilter.h"
#include "Transaction.h"
#include "BlockDetails.h"

namespace dev
{
namespace eth
{

struct SyncStatus;

using TransactionHashes = h256s;
using UncleHashes = h256s;

enum class Reaping
{
        Automatic,
        Manual
};

enum class FudgeFactor
{
        Strict,
        Lenient
};

struct GasEstimationProgress
{
        u256 lowerBound;
        u256 upperBound;
};

using GasEstimationCallback = std::function<void(GasEstimationProgress const&)>;

class Interface
{
public:
        Interface() {}

        virtual ~Interface() {}

        // [TRANSACTION API]

        virtual std::pair<h256, Address> submitTransaction(TransactionSkeleton const& _t, Secret const& _secret) = 0;

        void submitTransaction(Secret const& _secret, u256 const& _value, Address const& _dest, bytes const& _data = bytes(), u256 const& _gas = 1000000, u256 const& _gasPrice = DefaultGasPrice, u256 const& _nonce = Invalid256);

        Address submitTransaction(Secret const& _secret, u256 const& _endowment, bytes const& _init, u256 const& _gas = 1000000, u256 const& _gasPrice = DefaultGasPrice, u256 const& _nonce = Invalid256);

        virtual void flushTransactions() = 0;

        virtual ExecutionResult call(Address const& _from, u256 _value, Address _dest, bytes const& _data, u256 _gas, u256 _gasPrice, BlockNumber _blockNumber, FudgeFactor _ff = FudgeFactor::Strict) = 0;
        ExecutionResult call(Address const& _from, u256 _value, Address _dest, bytes const& _data = bytes(), u256 _gas = 1000000, u256 _gasPrice = DefaultGasPrice, FudgeFactor _ff = FudgeFactor::Strict) { return call(_from, _value, _dest, _data, _gas, _gasPrice, m_default, _ff); }
        ExecutionResult call(Secret const& _secret, u256 _value, Address _dest, bytes const& _data, u256 _gas, u256 _gasPrice, BlockNumber _blockNumber, FudgeFactor _ff = FudgeFactor::Strict) { return call(toAddress(_secret), _value, _dest, _data, _gas, _gasPrice, _blockNumber, _ff); }
        ExecutionResult call(Secret const& _secret, u256 _value, Address _dest, bytes const& _data, u256 _gas, u256 _gasPrice, FudgeFactor _ff = FudgeFactor::Strict) { return call(toAddress(_secret), _value, _dest, _data, _gas, _gasPrice, _ff); }

        virtual ExecutionResult create(Address const& _from, u256 _value, bytes const& _data, u256 _gas, u256 _gasPrice, BlockNumber _blockNumber, FudgeFactor _ff = FudgeFactor::Strict) = 0;
        ExecutionResult create(Address const& _from, u256 _value, bytes const& _data = bytes(), u256 _gas = 1000000, u256 _gasPrice = DefaultGasPrice, FudgeFactor _ff = FudgeFactor::Strict) { return create(_from, _value, _data, _gas, _gasPrice, m_default, _ff); }
        ExecutionResult create(Secret const& _secret, u256 _value, bytes const& _data, u256 _gas, u256 _gasPrice, BlockNumber _blockNumber, FudgeFactor _ff = FudgeFactor::Strict) { return create(toAddress(_secret), _value, _data, _gas, _gasPrice, _blockNumber, _ff); }
        ExecutionResult create(Secret const& _secret, u256 _value, bytes const& _data, u256 _gas, u256 _gasPrice, FudgeFactor _ff = FudgeFactor::Strict) { return create(toAddress(_secret), _value, _data, _gas, _gasPrice, _ff); }

        virtual ImportResult injectTransaction(bytes const& _rlp, IfDropped _id = IfDropped::Ignore) = 0;

        virtual ImportResult injectBlock(bytes const& _block) = 0;

        virtual std::pair<u256, ExecutionResult> estimateGas(Address const& _from, u256 _value, Address _dest, bytes const& _data, int64_t _maxGas, u256 _gasPrice, BlockNumber _blockNumber, GasEstimationCallback const& _callback = GasEstimationCallback()) = 0;

        // [STATE-QUERY API]

        int getDefault() const { return m_default; }
        void setDefault(BlockNumber _block) { m_default = _block; }

        u256 balanceAt(Address _a) const { return balanceAt(_a, m_default); }
        u256 countAt(Address _a) const { return countAt(_a, m_default); }
        u256 stateAt(Address _a, u256 _l) const { return stateAt(_a, _l, m_default); }
        bytes codeAt(Address _a) const { return codeAt(_a, m_default); }
        h256 codeHashAt(Address _a) const { return codeHashAt(_a, m_default); }
        std::map<h256, std::pair<u256, u256>> storageAt(Address _a) const { return storageAt(_a, m_default); }

        virtual u256 balanceAt(Address _a, BlockNumber _block) const = 0;
        virtual u256 countAt(Address _a, BlockNumber _block) const = 0;
        virtual u256 stateAt(Address _a, u256 _l, BlockNumber _block) const = 0;
        virtual h256 stateRootAt(Address _a, BlockNumber _block) const = 0;
        virtual bytes codeAt(Address _a, BlockNumber _block) const = 0;
        virtual h256 codeHashAt(Address _a, BlockNumber _block) const = 0;
        virtual std::map<h256, std::pair<u256, u256>> storageAt(Address _a, BlockNumber _block) const = 0;

        // [LOGS API]
        
        virtual LocalisedLogEntries logs(unsigned _watchId) const = 0;
        virtual LocalisedLogEntries logs(LogFilter const& _filter) const = 0;

        virtual unsigned installWatch(LogFilter const& _filter, Reaping _r = Reaping::Automatic) = 0;
        virtual unsigned installWatch(h256 _filterId, Reaping _r = Reaping::Automatic) = 0;
        virtual bool uninstallWatch(unsigned _watchId) = 0;
        LocalisedLogEntries peekWatchSafe(unsigned _watchId) const { try { return peekWatch(_watchId); } catch (...) { return LocalisedLogEntries(); } }
        LocalisedLogEntries checkWatchSafe(unsigned _watchId) { try { return checkWatch(_watchId); } catch (...) { return LocalisedLogEntries(); } }
        virtual LocalisedLogEntries peekWatch(unsigned _watchId) const = 0;
        virtual LocalisedLogEntries checkWatch(unsigned _watchId) = 0;

        // [BLOCK QUERY API]

        virtual bool isKnownTransaction(h256 const& _transactionHash) const = 0;
        virtual bool isKnownTransaction(h256 const& _blockHash, unsigned _i) const = 0;
        virtual Transaction transaction(h256 _transactionHash) const = 0;
        virtual LocalisedTransaction localisedTransaction(h256 const& _transactionHash) const = 0;
        virtual TransactionReceipt transactionReceipt(h256 const& _transactionHash) const = 0;
        virtual LocalisedTransactionReceipt localisedTransactionReceipt(h256 const& _transactionHash) const = 0;
        virtual std::pair<h256, unsigned> transactionLocation(h256 const& _transactionHash) const = 0;
        virtual h256 hashFromNumber(BlockNumber _number) const = 0;
        virtual BlockNumber numberFromHash(h256 _blockHash) const = 0;
        virtual int compareBlockHashes(h256 _h1, h256 _h2) const = 0;

        virtual bool isKnown(BlockNumber _block) const = 0;
        virtual bool isKnown(h256 const& _hash) const = 0;
        virtual BlockHeader blockInfo(h256 _hash) const = 0;
        virtual BlockDetails blockDetails(h256 _hash) const = 0;
        virtual Transaction transaction(h256 _blockHash, unsigned _i) const = 0;
        virtual LocalisedTransaction localisedTransaction(h256 const& _blockHash, unsigned _i) const = 0;
        virtual BlockHeader uncle(h256 _blockHash, unsigned _i) const = 0;
        virtual UncleHashes uncleHashes(h256 _blockHash) const = 0;
        virtual unsigned transactionCount(h256 _blockHash) const = 0;
        virtual unsigned uncleCount(h256 _blockHash) const = 0;
        virtual Transactions transactions(h256 _blockHash) const = 0;
        virtual TransactionHashes transactionHashes(h256 _blockHash) const = 0;

        virtual BlockHeader pendingInfo() const { return BlockHeader(); }
        virtual BlockDetails pendingDetails() const { return BlockDetails(); }
        virtual EVMSchedule evmSchedule() const { return EVMSchedule(); }

        BlockHeader blockInfo(BlockNumber _block) const;
        BlockDetails blockDetails(BlockNumber _block) const;
        Transaction transaction(BlockNumber _block, unsigned _i) const { auto p = transactions(_block); return _i < p.size() ? p[_i] : Transaction(); }
        unsigned transactionCount(BlockNumber _block) const { if (_block == PendingBlock) { auto p = pending(); return p.size(); } return transactionCount(hashFromNumber(_block)); }
        Transactions transactions(BlockNumber _block) const { if (_block == PendingBlock) return pending(); return transactions(hashFromNumber(_block)); }
        TransactionHashes transactionHashes(BlockNumber _block) const { if (_block == PendingBlock) return pendingHashes(); return transactionHashes(hashFromNumber(_block)); }
        BlockHeader uncle(BlockNumber _block, unsigned _i) const { return uncle(hashFromNumber(_block), _i); }
        UncleHashes uncleHashes(BlockNumber _block) const { return uncleHashes(hashFromNumber(_block)); }
        unsigned uncleCount(BlockNumber _block) const { return uncleCount(hashFromNumber(_block)); }

        // [EXTRA API]:

        virtual unsigned number() const = 0;

        virtual Transactions pending() const = 0;
        virtual h256s pendingHashes() const = 0;

        virtual Addresses addresses() const { return addresses(m_default); }
        virtual Addresses addresses(BlockNumber _block) const = 0;

        virtual u256 gasLimitRemaining() const = 0;
        // Get the gas bidding price
        virtual u256 gasBidPrice() const = 0;

        virtual SyncStatus syncStatus() const = 0;

        // [SEALING API]:

        virtual void setAuthor(Address const& _us) = 0;
        virtual Address author() const = 0;

        virtual void startSealing() = 0;
        virtual void stopSealing() = 0;
        virtual bool wouldSeal() const = 0;

        virtual bool isSyncing() const { return false; }
        virtual bool isMajorSyncing() const { return false; }

        virtual u256 networkId() const { return 0; }
        virtual void setNetworkId(u256 const&) {}

        virtual SealEngineFace* sealEngine() const { return nullptr; }

protected:
        int m_default = PendingBlock;
};

class Watch;

}
}

namespace std { void swap(dev::eth::Watch& _a, dev::eth::Watch& _b); }

namespace dev
{
namespace eth
{

class Watch: public boost::noncopyable
{
        friend void std::swap(Watch& _a, Watch& _b);

public:
        Watch() {}
        Watch(Interface& _c, h256 _f): m_c(&_c), m_id(_c.installWatch(_f)) {}
        Watch(Interface& _c, LogFilter const& _tf): m_c(&_c), m_id(_c.installWatch(_tf)) {}
        ~Watch() { if (m_c) m_c->uninstallWatch(m_id); }

        LocalisedLogEntries check() { return m_c ? m_c->checkWatch(m_id) : LocalisedLogEntries(); }
        LocalisedLogEntries peek() { return m_c ? m_c->peekWatch(m_id) : LocalisedLogEntries(); }
        LocalisedLogEntries logs() const { return m_c->logs(m_id); }

private:
        Interface* m_c = nullptr;
        unsigned m_id = 0;
};

}
}

namespace std
{

inline void swap(dev::eth::Watch& _a, dev::eth::Watch& _b)
{
        swap(_a.m_c, _b.m_c);
        swap(_a.m_id, _b.m_id);
}

}