Refactor beaconstatus to separate actual back-end

calls into GetBeaconStatus so that this can be consumed
easily by the GUI. Implement simple BeaconStatus struct.

Implement initial BitcoinGUI::updateBeaconIcon() function.

Author: jamescowens

src/Makefile.qt.include

@@ -284,9 +284,9 @@ RES_ICONS = \
   qt/res/icons/tx_por_ss.svg \
   qt/res/icons/tx_por.svg \
   qt/res/icons/tx2.png \
+  qt/res/icons/white_and_red_x.svg \
   qt/res/icons/www.png \
   qt/res/icons/wwww.png \
-  qt/res/icons/x.svg \
   qt/res/icons/icons_native/overview.svg \
   qt/res/icons/icons_light/overview.svg \
   qt/res/icons/icons_dark/overview.svg \

src/beacon.cpp

@@ -8,6 +8,8 @@
 #include "appcache.h"
 #include "contract/contract.h"
 #include "key.h"
+#include "neuralnet/researcher.h"
+#include "neuralnet/tally.h"
 
 std::string RetrieveBeaconValueWithMaxAge(const std::string& cpid, int64_t iMaxSeconds);
 std::string ExtractXML(const std::string& XMLdata, const std::string& key, const std::string& key_end);
@@ -316,3 +318,25 @@ BeaconConsensus GetConsensusBeaconList()
 
     return Consensus;
 }
+
+// -------------------------- Both In and Out
+BeaconStatus GetBeaconStatus(std::string& sCPID)
+{
+    BeaconStatus beacon_status;
+
+    LOCK(cs_main);
+
+    if (sCPID.empty())
+    {
+        sCPID = NN::GetPrimaryCpid();
+    }
+
+    beacon_status.sPubKey = GetBeaconPublicKey(sCPID, false);
+    beacon_status.iBeaconTimestamp = BeaconTimeStamp(sCPID);
+    beacon_status.timestamp = TimestampToHRDate(beacon_status.iBeaconTimestamp);
+    beacon_status.hasBeacon = HasActiveBeacon(sCPID);
+    beacon_status.dPriorSBMagnitude = NN::Tally::GetMagnitude(NN::MiningId::Parse(sCPID));
+    beacon_status.is_mine = (sCPID == NN::GetPrimaryCpid());
+
+    return beacon_status;
+}

src/beacon.h

@@ -25,6 +25,17 @@ struct BeaconConsensus
     BeaconMap mBeaconMap;
 };
 
+//Note this should be replaced when we redo the beacon structures...
+struct BeaconStatus
+{
+    std::string sPubKey;
+    int64_t iBeaconTimestamp;
+    std::string timestamp;
+    bool hasBeacon;
+    double dPriorSBMagnitude;
+    bool is_mine;
+};
+
 //!
 //! \brief Generate beacon key pair.
 //!
@@ -100,3 +111,10 @@ bool ImportBeaconKeysFromConfig(const std::string& cpid, CWallet* wallet);
 //! \return A list of active beacons.
 //!
 BeaconConsensus GetConsensusBeaconList();
+
+//!
+//! \brief Get beacon status for a specified CPID.
+//!
+//! \return Beacon status structure for specific CPID.
+//!
+BeaconStatus GetBeaconStatus(std::string& sCPID);

src/neuralnet/researcher.cpp

@@ -44,31 +44,6 @@ std::string LowerUnderscore(std::string data)
     return data;
 }
 
-//!
-//! \brief Determine whether the wallet must run in investor mode before trying
-//! to load BOINC CPIDs.
-//!
-//! \return \c true if the user explicitly configured investor mode or failed
-//! to input a valid email address.
-//!
-bool ConfiguredForInvestorMode()
-{
-    if (GetBoolArg("-investor", false)) {
-        LogPrintf("Investor mode configured. Skipping CPID import.");
-        return true;
-    }
-
-    if (Researcher::Email().empty()) {
-        LogPrintf(
-            "WARNING: Please set 'email=<your BOINC account email>' in "
-            "gridcoinresearch.conf. Continuing in investor mode.");
-
-        return true;
-    }
-
-    return false;
-}
-
 //!
 //! \brief Fetch the contents of BOINC's client_state.xml file from disk.
 //!
@@ -507,14 +482,32 @@ std::string Researcher::Email()
     return email;
 }
 
+bool Researcher::ConfiguredForInvestorMode(bool log)
+{
+    if (GetBoolArg("-investor", false)) {
+        if (log) LogPrintf("Investor mode configured. Skipping CPID import.");
+        return true;
+    }
+
+    if (Researcher::Email().empty()) {
+        if (log) LogPrintf(
+            "WARNING: Please set 'email=<your BOINC account email>' in "
+            "gridcoinresearch.conf. Continuing in investor mode.");
+
+        return true;
+    }
+
+    return false;
+}
+
 ResearcherPtr Researcher::Get()
 {
     return std::atomic_load(&researcher);
 }
 
 void Researcher::Reload()
 {
-    if (ConfiguredForInvestorMode()) {
+    if (ConfiguredForInvestorMode(true)) {
         StoreResearcher(Researcher()); // Investor
         return;
     }

src/neuralnet/researcher.h

@@ -220,6 +220,15 @@ class Researcher
     //!
     static std::string Email();
 
+    //!
+    //! \brief Determine whether the wallet must run in investor mode before trying
+    //! to load BOINC CPIDs.
+    //!
+    //! \return \c true if the user explicitly configured investor mode or failed
+    //! to input a valid email address.
+    //!
+    static bool ConfiguredForInvestorMode(bool log = false);
+
     //!
     //! \brief Get the current global researcher context.
     //!

src/qt/bitcoin.qrc

@@ -69,8 +69,8 @@
         <file alias="connect_3">res/icons/connect3.svg</file>
         <file alias="connect_4">res/icons/connect4.svg</file>
         <file alias="notsynced">res/icons/notsynced.svg</file>
-        <file alias="white_and_red_x">res/icons/x.svg</file>
         <file alias="synced">res/icons/green_check.svg</file>
+        <file alias="white_and_red_x">res/icons/white_and_red_x.svg</file>
     </qresource>
     <qresource prefix="/images">
         <file alias="splash">res/images/splash3.png</file>

src/qt/bitcoingui.cpp

@@ -84,6 +84,7 @@
 #include "contract/polls.h"
 #include "contract/contract.h"
 #include "neuralnet/researcher.h"
+#include "beacon.h"
 
 #include <iostream>
 #include <boost/algorithm/string/case_conv.hpp> // for to_lower()
@@ -1620,14 +1621,99 @@ void BitcoinGUI::updateScraperIcon(int scraperEventtype, int status)
     else if ((scraperEventtype == (int)scrapereventtypes::Convergence  || scraperEventtype == (int)scrapereventtypes::SBContract)
              && status == CT_DELETED)
     {
-        labelScraperIcon->setPixmap(QIcon(":/icons/red_and_white_x").pixmap(STATUSBAR_ICONSIZE, STATUSBAR_ICONSIZE));
+        labelScraperIcon->setPixmap(QIcon(":/icons/white_and_red_x").pixmap(STATUSBAR_ICONSIZE, STATUSBAR_ICONSIZE));
         labelScraperIcon->setToolTip(tr("Scraper: No convergence able to be achieved. Will retry in a few minutes."));
     }
 
 }
 
 void BitcoinGUI::updateBeaconIcon()
 {
-    labelBeaconIcon->setPixmap(QIcon(":/icons/beacon_green").pixmap(STATUSBAR_ICONSIZE, STATUSBAR_ICONSIZE));
-    labelBeaconIcon->setToolTip(tr("Iconsize = %1.").arg(QString(std::to_string(STATUSBAR_ICONSIZE).c_str())));
+    std::string sCPID;
+    double beacon_age = 0;
+    double time_to_expiration = 0;
+    double advertise_threshold = 0;
+
+    BeaconStatus beacon_status = GetBeaconStatus(sCPID);
+
+    // Intent is to be an investor. Suppress icon.
+    if (NN::Researcher::ConfiguredForInvestorMode())
+    {
+        labelBeaconIcon->hide();
+    }
+    // Not configured for investor mode, which means the intent is to be a researcher.
+    else
+    {
+        // Beacon does not exist.
+        if (sCPID == "INVESTOR")
+        {
+            labelBeaconIcon->setPixmap(QIcon(":/icons/beacon_red").pixmap(STATUSBAR_ICONSIZE, STATUSBAR_ICONSIZE));
+            labelBeaconIcon->setToolTip(tr("Wallet status is INVESTOR, but the wallet is not configured for investor mode. "
+                                           "If you intend to be an investor only, please remove the email entry in the config file, "
+                                           "otherwise you need to check your email entry and your BOINC installation."));
+        }
+        // CPID resolves to non-INVESTOR and beacon exists.
+        else if (sCPID != "INVESTOR" && beacon_status.hasBeacon)
+        {
+            double seconds_in_day = 24.0 * 60.0 * 60.0;
+
+            beacon_age = (double) (GetAdjustedTime() - beacon_status.iBeaconTimestamp) / seconds_in_day;
+            time_to_expiration = ((double) MaxBeaconAge() / seconds_in_day) - beacon_age;
+            advertise_threshold = BeaconAgeAdvertiseThreshold() / seconds_in_day;
+
+            // If beacon does not need to be renewed...
+            if (beacon_age < advertise_threshold)
+            {
+                labelBeaconIcon->setPixmap(QIcon(":/icons/beacon_green").pixmap(STATUSBAR_ICONSIZE, STATUSBAR_ICONSIZE));
+                labelBeaconIcon->setToolTip(tr("CPID: %1\n"
+                                               "Beacon age: %2 day(s)\n"
+                                               "Expires: %3 day(s)\n"
+                                               "Beacon status is good.").arg(QString(sCPID.c_str()))
+                                            .arg(QString(std::to_string((int) std::round(beacon_age)).c_str()))
+                                            .arg(QString(std::to_string((int) time_to_expiration).c_str())));
+            }
+            // If between start of period where able to renew and 15 days left until expiration, time to renew!...
+            else if (beacon_age >= advertise_threshold && time_to_expiration > 15.0)
+            {
+                labelBeaconIcon->setPixmap(QIcon(":/icons/beacon_yellow").pixmap(STATUSBAR_ICONSIZE, STATUSBAR_ICONSIZE));
+                labelBeaconIcon->setToolTip(tr("CPID: %1\n"
+                                               "Beacon age: %2 day(s)\n"
+                                               "Expires: %3 day(s)\n"
+                                               "Beacon should be renewed.").arg(QString(sCPID.c_str()))
+                                            .arg(QString(std::to_string((int) std::round(beacon_age)).c_str()))
+                                            .arg(QString(std::to_string((int) time_to_expiration).c_str())));
+            }
+            // If magnitude is zero (which is common for new beacons and lapsed beacons that have been renewed)...
+            else if (!beacon_status.dPriorSBMagnitude)
+            {
+                labelBeaconIcon->setPixmap(QIcon(":/icons/beacon_yellow").pixmap(STATUSBAR_ICONSIZE, STATUSBAR_ICONSIZE));
+                labelBeaconIcon->setToolTip(tr("CPID: %1\n"
+                                               "Beacon age: %2 day(s)\n"
+                                               "Expires: %3 day(s)\n"
+                                               "Magnitude is zero, which may prevent staking with research rewards."
+                                               "Please check your magnitude after the next superblock.").arg(QString(sCPID.c_str()))
+                                            .arg(QString(std::to_string((int) std::round(beacon_age)).c_str()))
+                                            .arg(QString(std::to_string((int) time_to_expiration).c_str())));
+           }
+            // If only 15 days left to renew, red alert!...
+            else if (time_to_expiration <= 15.0)
+            {
+                labelBeaconIcon->setPixmap(QIcon(":/icons/beacon_red").pixmap(STATUSBAR_ICONSIZE, STATUSBAR_ICONSIZE));
+                labelBeaconIcon->setToolTip(tr("CPID: %1\n"
+                                               "Beacon age: %2 day(s)\n"
+                                               "Expires: %3 day(s)\n"
+                                               "BEACON SHOULD BE RENEWED IMMEDIATELY TO PREVENT LAPSE.").arg(QString(sCPID.c_str()))
+                                            .arg(QString(std::to_string((int) std::round(beacon_age)).c_str()))
+                                            .arg(QString(std::to_string((int) time_to_expiration).c_str())));
+            }
+        }
+        // CPID resolves, but no active beacon present.
+        else if (sCPID != "INVESTOR"  && !beacon_status.hasBeacon)
+        {
+            labelBeaconIcon->setPixmap(QIcon(":/icons/beacon_red").pixmap(STATUSBAR_ICONSIZE, STATUSBAR_ICONSIZE));
+            labelBeaconIcon->setToolTip(tr("There is a CPID, %1, but there is no active beacon. "
+                                           "Your beacon may be expired or never advertised. Please "
+                                           "advertise a new beacon.").arg(QString(sCPID.c_str())));
+        }
+    }
 }

src/qt/res/icons/x.svg renamed to src/qt/res/icons/white_and_red_x.svg

@@ -805,42 +805,36 @@ UniValue beaconstatus(const UniValue& params, bool fHelp)
 
     // Search for beacon, and report on beacon status.
 
-    std::string sCPID = NN::GetPrimaryCpid();
+    std::string sCPID;
 
     if (params.size() > 0)
         sCPID = params[0].get_str();
 
-    LOCK(cs_main);
-
-    std::string sPubKey =  GetBeaconPublicKey(sCPID, false);
-    int64_t iBeaconTimestamp = BeaconTimeStamp(sCPID);
-    std::string timestamp = TimestampToHRDate(iBeaconTimestamp);
-    bool hasBeacon = HasActiveBeacon(sCPID);
+    // If sCPID is supplied, uses that. If not, then sCPID is filled in from GetPrimaryCPID.
+    BeaconStatus beacon_status = GetBeaconStatus(sCPID);
 
     res.pushKV("CPID", sCPID);
-    res.pushKV("Beacon Exists",YesNo(hasBeacon));
-    res.pushKV("Beacon Timestamp",timestamp.c_str());
-    res.pushKV("Public Key", sPubKey.c_str());
-    res.pushKV("Private Key", "not-shown"); //TODO: show the key?
+    res.pushKV("Beacon Exists", YesNo(beacon_status.hasBeacon));
+    res.pushKV("Beacon Timestamp", beacon_status.timestamp.c_str());
+    res.pushKV("Public Key", beacon_status.sPubKey.c_str());
 
     std::string sErr = "";
 
-    if (sPubKey.empty())
+    if (beacon_status.sPubKey.empty())
         sErr += "Public Key Missing. ";
 
     // Prior superblock Magnitude
-    double dMagnitude = NN::Tally::GetMagnitude(NN::MiningId::Parse(sCPID));
-
-    res.pushKV("Magnitude (As of last superblock)", dMagnitude);
+    res.pushKV("Magnitude (As of last superblock)", beacon_status.dPriorSBMagnitude);
 
-    const bool is_mine = sCPID == NN::GetPrimaryCpid();
-    res.pushKV("Mine", is_mine);
+    res.pushKV("Mine", beacon_status.is_mine);
 
-    if (is_mine && dMagnitude == 0)
+    if (beacon_status.is_mine && beacon_status.dPriorSBMagnitude == 0)
         res.pushKV("Warning","Your magnitude is 0 as of the last superblock: this may keep you from staking POR blocks.");
 
-    if (!sPubKey.empty() && is_mine)
+    if (!beacon_status.sPubKey.empty() && beacon_status.is_mine)
     {
+        LOCK(cs_main);
+
         EnsureWalletIsUnlocked();
 
         bool bResult;