LedgerHeader.h

#pragma once
 
#include <xrpl/basics/Slice.h>
#include <xrpl/basics/base_uint.h>
#include <xrpl/basics/chrono.h>
#include <xrpl/beast/utility/Zero.h>
#include <xrpl/protocol/Protocol.h>
#include <xrpl/protocol/Serializer.h>
#include <xrpl/protocol/XRPAmount.h>
 
#include <cstdint>
 
namespace xrpl {

struct LedgerHeader
{
    explicit LedgerHeader() = default;
 
    //
    // For all ledgers
    //
 
    LedgerIndex seq = 0;
    NetClock::time_point parentCloseTime;
 
    //
    // For closed ledgers
    //
 
    // Closed means "tx set already determined"
    UInt256 hash = beast::kZero;
    UInt256 txHash = beast::kZero;
    UInt256 accountHash = beast::kZero;
    UInt256 parentHash = beast::kZero;
 
    XRPAmount drops = beast::kZero;
 
    // If validated is false, it means "not yet validated."
    // Once validated is true, it will never be set false at a later time.
    // VFALCO TODO Make this not mutable
    bool mutable validated = false;
    bool accepted = false;
 
    // flags indicating how this ledger close took place
    int closeFlags = 0;
 
    // the resolution for this ledger close time (2-120 seconds)
    NetClock::duration closeTimeResolution = {};
 
    // For closed ledgers, the time the ledger
    // closed. For open ledgers, the time the ledger
    // will close if there's no transactions.
    //
    NetClock::time_point closeTime;
};
 
// ledger close flags
static std::uint32_t const kSLcfNoConsensusTime = 0x01;
 
inline bool
getCloseAgree(LedgerHeader const& info)
{
    return (info.closeFlags & kSLcfNoConsensusTime) == 0;
}
 
void
addRaw(LedgerHeader const&, Serializer&, bool includeHash = false);

LedgerHeader
deserializeHeader(Slice data, bool hasHash = false);

LedgerHeader
deserializePrefixedHeader(Slice data, bool hasHash = false);

UInt256
calculateLedgerHash(LedgerHeader const& info);
 
}  // namespace xrpl