ConsensusParms.h

//------------------------------------------------------------------------------
/*
    This file is part of rippled: https://github.com/ripple/rippled
    Copyright (c) 2012-2017 Ripple Labs Inc.
 
    Permission to use, copy, modify, and/or distribute this software for any
    purpose  with  or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
 
    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL ,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
 
#ifndef RIPPLE_CONSENSUS_CONSENSUS_PARMS_H_INCLUDED
#define RIPPLE_CONSENSUS_CONSENSUS_PARMS_H_INCLUDED
 
#include <chrono>
#include <cstddef>
 
namespace ripple {
 
struct ConsensusParms
{
    explicit ConsensusParms() = default;
 
    //-------------------------------------------------------------------------
    // Validation and proposal durations are relative to NetClock times, so use
    // second resolution
    std::chrono::seconds validationVALID_WALL = std::chrono::minutes{5};
 
    std::chrono::seconds validationVALID_LOCAL = std::chrono::minutes{3};
 
    std::chrono::seconds validationVALID_EARLY = std::chrono::minutes{3};
 
    std::chrono::seconds proposeFRESHNESS = std::chrono::seconds{20};
 
    std::chrono::seconds proposeINTERVAL = std::chrono::seconds{12};
 
    //-------------------------------------------------------------------------
    // Consensus durations are relative to the internal Consensus clock and use
    // millisecond resolution.
 
    std::size_t minCONSENSUS_PCT = 80;
 
    std::chrono::milliseconds ledgerIDLE_INTERVAL = std::chrono::seconds{15};
 
    std::chrono::milliseconds ledgerMIN_CONSENSUS =
        std::chrono::milliseconds{1950};
 
    std::chrono::milliseconds ledgerMAX_CONSENSUS = std::chrono::seconds{10};
 
    std::chrono::milliseconds ledgerMIN_CLOSE = std::chrono::seconds{2};
 
    std::chrono::milliseconds ledgerGRANULARITY = std::chrono::seconds{1};
 
    std::chrono::milliseconds avMIN_CONSENSUS_TIME = std::chrono::seconds{5};
 
    //------------------------------------------------------------------------------
    // Avalanche tuning
    // As a function of the percent this round's duration is of the prior round,
    // we increase the threshold for yes votes to add a transaction to our
    // position.
 
    std::size_t avINIT_CONSENSUS_PCT = 50;
 
    std::size_t avMID_CONSENSUS_TIME = 50;
 
    std::size_t avMID_CONSENSUS_PCT = 65;
 
    std::size_t avLATE_CONSENSUS_TIME = 85;
 
    std::size_t avLATE_CONSENSUS_PCT = 70;
 
    std::size_t avSTUCK_CONSENSUS_TIME = 200;
 
    std::size_t avSTUCK_CONSENSUS_PCT = 95;
 
    std::size_t avCT_CONSENSUS_PCT = 75;
};
 
}  // namespace ripple
#endif