#pragma once #include #include #include namespace xrpl { /** Possible ledger close time resolutions. Values should not be duplicated. @see getNextLedgerTimeResolution */ std::chrono::seconds constexpr ledgerPossibleTimeResolutions[] = { std::chrono::seconds{10}, std::chrono::seconds{20}, std::chrono::seconds{30}, std::chrono::seconds{60}, std::chrono::seconds{90}, std::chrono::seconds{120}}; //! Initial resolution of ledger close time. auto constexpr ledgerDefaultTimeResolution = ledgerPossibleTimeResolutions[2]; //! Close time resolution in genesis ledger auto constexpr ledgerGenesisTimeResolution = ledgerPossibleTimeResolutions[0]; //! How often we increase the close time resolution (in numbers of ledgers) auto constexpr increaseLedgerTimeResolutionEvery = 8; //! How often we decrease the close time resolution (in numbers of ledgers) auto constexpr decreaseLedgerTimeResolutionEvery = 1; /** Calculates the close time resolution for the specified ledger. The XRPL protocol uses binning to represent time intervals using only one timestamp. This allows servers to derive a common time for the next ledger, without the need for perfectly synchronized clocks. The time resolution (i.e. the size of the intervals) is adjusted dynamically based on what happened in the last ledger, to try to avoid disagreements. @param previousResolution the resolution used for the prior ledger @param previousAgree whether consensus agreed on the close time of the prior ledger @param ledgerSeq the sequence number of the new ledger @pre previousResolution must be a valid bin from @ref ledgerPossibleTimeResolutions @tparam Rep Type representing number of ticks in std::chrono::duration @tparam Period An std::ratio representing tick period in std::chrono::duration @tparam Seq Unsigned integer-like type corresponding to the ledger sequence number. It should be comparable to 0 and support modular division. Built-in and tagged_integers are supported. */ template std::chrono::duration getNextLedgerTimeResolution( std::chrono::duration previousResolution, bool previousAgree, Seq ledgerSeq) { XRPL_ASSERT(ledgerSeq != Seq{0}, "xrpl::getNextLedgerTimeResolution : valid ledger sequence"); using namespace std::chrono; // Find the current resolution: auto iter = std::find( std::begin(ledgerPossibleTimeResolutions), std::end(ledgerPossibleTimeResolutions), previousResolution); XRPL_ASSERT( iter != std::end(ledgerPossibleTimeResolutions), "xrpl::getNextLedgerTimeResolution : found time resolution"); // This should never happen, but just as a precaution if (iter == std::end(ledgerPossibleTimeResolutions)) return previousResolution; // If we did not previously agree, we try to decrease the resolution to // improve the chance that we will agree now. if (!previousAgree && (ledgerSeq % Seq{decreaseLedgerTimeResolutionEvery} == Seq{0})) { if (++iter != std::end(ledgerPossibleTimeResolutions)) return *iter; } // If we previously agreed, we try to increase the resolution to determine // if we can continue to agree. if (previousAgree && (ledgerSeq % Seq{increaseLedgerTimeResolutionEvery} == Seq{0})) { if (iter-- != std::begin(ledgerPossibleTimeResolutions)) return *iter; } return previousResolution; } /** Calculates the close time for a ledger, given a close time resolution. @param closeTime The time to be rounded @param closeResolution The resolution @return @b closeTime rounded to the nearest multiple of @b closeResolution. Rounds up if @b closeTime is midway between multiples of @b closeResolution. */ template std::chrono::time_point roundCloseTime( std::chrono::time_point closeTime, std::chrono::duration closeResolution) { using time_point = decltype(closeTime); if (closeTime == time_point{}) return closeTime; closeTime += (closeResolution / 2); return closeTime - (closeTime.time_since_epoch() % closeResolution); } /** Calculate the effective ledger close time After adjusting the ledger close time based on the current resolution, also ensure it is sufficiently separated from the prior close time. @param closeTime The raw ledger close time @param resolution The current close time resolution @param priorCloseTime The close time of the prior ledger */ template std::chrono::time_point effCloseTime( std::chrono::time_point closeTime, std::chrono::duration resolution, std::chrono::time_point priorCloseTime) { using namespace std::chrono_literals; using time_point = decltype(closeTime); if (closeTime == time_point{}) return closeTime; return std::max(roundCloseTime(closeTime, resolution), (priorCloseTime + 1s)); } } // namespace xrpl