TransactionReceipt.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 <libethcore/Common.h>
#include <libethcore/LogEntry.h>
#include <libdevcore/RLP.h>

#include <boost/variant/variant.hpp>
#include <array>

namespace dev
{
namespace eth
{

class TransactionReceipt
{
public:
    TransactionReceipt(bytesConstRef _rlp);
    TransactionReceipt(h256 const& _root, u256 const& _gasUsed, LogEntries const& _log);
    TransactionReceipt(uint8_t _status, u256 const& _gasUsed, LogEntries const& _log);

    bool hasStatusCode() const;
    h256 const& stateRoot() const;
    uint8_t statusCode() const;
    u256 const& cumulativeGasUsed() const { return m_gasUsed; }
    LogBloom const& bloom() const { return m_bloom; }
    LogEntries const& log() const { return m_log; }

    void streamRLP(RLPStream& _s) const;

    bytes rlp() const { RLPStream s; streamRLP(s); return s.out(); }

private:
    boost::variant<uint8_t,h256> m_statusCodeOrStateRoot;
    u256 m_gasUsed;
    LogBloom m_bloom;
    LogEntries m_log;
};

using TransactionReceipts = std::vector<TransactionReceipt>;

std::ostream& operator<<(std::ostream& _out, eth::TransactionReceipt const& _r);

class LocalisedTransactionReceipt: public TransactionReceipt
{
public:
    LocalisedTransactionReceipt(
        TransactionReceipt const& _t,
        h256 const& _hash,
        h256 const& _blockHash,
        BlockNumber _blockNumber,
        Address const& _from,
        Address const& _to, 
        unsigned _transactionIndex,
        u256 const& _gasUsed,
        Address const& _contractAddress = Address()
    ):
        TransactionReceipt(_t),
        m_hash(_hash),
        m_blockHash(_blockHash),
        m_blockNumber(_blockNumber),
        m_from(_from),
        m_to(_to),
        m_transactionIndex(_transactionIndex),
        m_gasUsed(_gasUsed),
        m_contractAddress(_contractAddress)
    {
        LogEntries entries = log();
        for (unsigned i = 0; i < entries.size(); i++)
            m_localisedLogs.push_back(LocalisedLogEntry(
                entries[i],
                m_blockHash,
                m_blockNumber,
                m_hash,
                m_transactionIndex,
                i
            ));
    }

    h256 const& hash() const { return m_hash; }
    h256 const& blockHash() const { return m_blockHash; }
    BlockNumber blockNumber() const { return m_blockNumber; }
    Address const& from() const { return m_from; }
    Address const& to() const { return m_to; }
    unsigned transactionIndex() const { return m_transactionIndex; }
    u256 const& gasUsed() const { return m_gasUsed; }
    Address const& contractAddress() const { return m_contractAddress; }
    LocalisedLogEntries const& localisedLogs() const { return m_localisedLogs; };

private:
    h256 m_hash;
    h256 m_blockHash;
    BlockNumber m_blockNumber;
    Address m_from;
    Address m_to;
    unsigned m_transactionIndex = 0;
    u256 m_gasUsed;
    Address m_contractAddress;
    LocalisedLogEntries m_localisedLogs;
};

}
}