Add reasonable ETTS test to diagnostics

This commit also alters the ETTS function to allow ignoring
the staking status and calculating ETTS anyway. This is useful
for the diagnostics, and also will be used to modify the tooltip
to report staking frequency even if all of the coins are on
cooldown.

Author: jamescowens

src/main.cpp

@@ -341,7 +341,7 @@ double GetAverageDifficulty(unsigned int nPoSInterval)
     return result;
 }
 
-double GetEstimatedTimetoStake(double dDiff, double dConfidence)
+double GetEstimatedTimetoStake(bool ignore_staking_status, double dDiff, double dConfidence)
 {
     /*
      * The algorithm below is an attempt to come up with a more accurate way of estimating Time to Stake (ETTS) based on
@@ -378,8 +378,8 @@ double GetEstimatedTimetoStake(double dDiff, double dConfidence)
     }
 
     bool staking = MinerStatus.nLastCoinStakeSearchInterval && MinerStatus.WeightSum;
-    // Get out early if not staking and set return value of 0.
-    if (!staking)
+    // Get out early if not staking and ignore_staking_status is false and set return value of 0.
+    if (!staking && !ignore_staking_status)
     {
         if (fDebug10) LogPrintf("GetEstimatedTimetoStake debug: Not staking: ETTS = %f", result);
         return result;

src/main.h

@@ -256,12 +256,12 @@ double GetEstimatedNetworkWeight(unsigned int nPoSInterval = 40);
 double GetDifficulty(const CBlockIndex* blockindex = NULL);
 double GetBlockDifficulty(unsigned int nBits);
 double GetAverageDifficulty(unsigned int nPoSInterval = 40);
+
 // Note that dDiff cannot be = 0 normally. This is set as default because you can't specify the output of
 // GetAverageDifficulty(nPosInterval) = to dDiff here.
-// The defeult confidence is 1-1/e which is the mean for the geometric distribution.
-
-const double DEFAULT_ETTS_CONFIDENCE = 0.632120558829;
-double GetEstimatedTimetoStake(double dDiff = 0.0, double dConfidence = DEFAULT_ETTS_CONFIDENCE);
+// The defeult confidence is 1-1/e which is the mean for the geometric distribution for small probabilities.
+const double DEFAULT_ETTS_CONFIDENCE = 1.0 - 1.0 / exp(1.0);
+double GetEstimatedTimetoStake(bool ignore_staking_status = false, double dDiff = 0.0, double dConfidence = DEFAULT_ETTS_CONFIDENCE);
 
 NN::ClaimOption GetClaimByIndex(const CBlockIndex* const pblockindex);
 

src/qt/diagnosticsdialog.cpp

@@ -287,6 +287,19 @@ bool DiagnosticsDialog::VerifyCPIDHasRAC()
     return (racValue >= 1) ? true : false;
 }
 
+double VerifyETTSReasonable()
+{
+    // We are going to compute the ETTS with ignore_staking_status set to true
+    // and also use a 960 block diff as the input, which smooths out short
+    // term fluctuations. The standard 1-1/e confidence (mean) is used.
+
+    double diff = GetAverageDifficulty(960);
+
+    double result = GetEstimatedTimetoStake(true, diff);
+
+    return result;
+}
+
 int DiagnosticsDialog::VerifyCountSeedNodes()
 {
     LOCK(cs_vNodes);
@@ -320,7 +333,7 @@ void DiagnosticsDialog::on_testButton_clicked()
     }
 
     // This needs to be updated if there are more tests added.
-    unsigned int number_of_tests = 10;
+    unsigned int number_of_tests = 11;
 
     ResetOverallDiagnosticResult(number_of_tests);
     DisplayOverallDiagnosticResult();
@@ -543,6 +556,36 @@ void DiagnosticsDialog::on_testButton_clicked()
         UpdateOverallDiagnosticResult(NA);
      }
 
+    // verify reasonable ETTS
+    ui->checkETTSResultLabel->setStyleSheet("");
+    ui->checkETTSResultLabel->setText(tr("Testing..."));
+    UpdateTestStatus("checkETTS", pending);
+    double ETTS = VerifyETTSReasonable() / (24.0 * 60.0 * 60.0);
+
+    if (ETTS > 90.0)
+    {
+        ui->checkETTSResultLabel->setText(tr("Failed: ETTS = %1 > 90 days"));
+        ui->checkETTSResultLabel->setStyleSheet("color:white;background-color:red");
+        UpdateTestStatus("checkETTS", completed);
+        UpdateOverallDiagnosticResult(failed);
+    }
+    else if (ETTS > 45.0 && ETTS <= 90.0)
+    {
+        ui->checkETTSResultLabel->setText(tr("Warning: 45 days < ETTS = %1 <= 90 days"));
+        ui->checkETTSResultLabel->setStyleSheet("color:black;background-color:yellow");
+        UpdateTestStatus("checkETTS", completed);
+        UpdateOverallDiagnosticResult(warning);
+    }
+    else
+    {
+        ui->checkETTSResultLabel->setText(tr("Passed: ETTS <= 45 days"));
+        ui->checkETTSResultLabel->setStyleSheet("color:white;background-color:green");
+        UpdateTestStatus("checkETTS", completed);
+        UpdateOverallDiagnosticResult(passed);
+    }
+
+
+
     // client version
     ui->checkClientVersionResultLabel->setStyleSheet("");
     ui->checkClientVersionResultLabel->setText(tr("Testing..."));

src/qt/diagnosticsdialog.h

@@ -48,6 +48,7 @@ class DiagnosticsDialog : public QDialog
     bool VerifyWalletIsSynced();
     bool VerifyIsCPIDValid();
     bool VerifyCPIDHasRAC();
+    double VerifyETTSReasonable();
     int VerifyCountSeedNodes();
     int VerifyCountConnections();
     double GetTotalCPIDRAC(std::string cpid);