5.2.1.0, 2021-03-07, leisure

Added
 - voting: Add wait warning to voting tab loading message #2039 (@cyrossignol)
 - rpc: Adds transaction hash and fees paid to consolidateunspent #2040 (@jamescowens)

Changed
- gui, voting: Make some minor adjustments for VotingDialog flow #2041 (@jamescowens)

Fixed
 - beacon, util, gui: Fix small error in beacon db for renewals and fix snapshot download functionality #2036 (@jamescowens)

CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [5.2.1.0] 2021-03-07, leisure
+### Added
+ - voting: Add wait warning to voting tab loading message #2039 (@cyrossignol)
+ - rpc: Adds transaction hash and fees paid to consolidateunspent #2040 (@jamescowens)
+
+### Changed
+- gui, voting: Make some minor adjustments for VotingDialog flow #2041 (@jamescowens)
+
+### Fixed
+ - beacon, util, gui: Fix small error in beacon db for renewals and fix snapshot download functionality #2036 (@jamescowens)
+
 ## [5.2.0.0] 2021-03-01, mandatory, "Hilda"
 ### Added
  - gui: Add RAC column to wizard summary page projects table #1951 (@cyrossignol)

configure.ac

@@ -2,7 +2,7 @@ dnl require autoconf 2.60 (AS_ECHO/AS_ECHO_N)
 AC_PREREQ([2.60])
 define(_CLIENT_VERSION_MAJOR, 5)
 define(_CLIENT_VERSION_MINOR, 2)
-define(_CLIENT_VERSION_REVISION, 0)
+define(_CLIENT_VERSION_REVISION, 1)
 define(_CLIENT_VERSION_BUILD, 0)
 define(_CLIENT_VERSION_IS_RELEASE, true)
 define(_COPYRIGHT_YEAR, 2021)

src/gridcoin/accrual/snapshot.h

@@ -1456,6 +1456,11 @@ class AccrualSnapshotRepository
         return m_registry.Deregister(height);
     }
 
+    bool CloseRegistryFile()
+    {
+        return m_registry.Close();
+    }
+
 private:
     AccrualSnapshotRegistry m_registry; //!< Tracks snapshot files state.
 }; // AccrualSnapshotRepository

src/gridcoin/beacon.cpp

@@ -367,7 +367,15 @@ bool BeaconRegistry::TryRenewal(Beacon_ptr& current_beacon_ptr, int& height, con
     renewal.m_prev_beacon_hash = current_beacon_ptr->m_hash;
 
     // Put the renewal beacon into the db.
-    m_beacon_db.update(renewal.m_hash, height, renewal);
+    if (!m_beacon_db.insert(renewal.m_hash, height, renewal))
+    {
+        LogPrint(LogFlags::BEACON, "WARNING: %s: In renewal of beacon for cpid %s, address %s, hash %s, beacon db record "
+                                   "already exists.",
+                 __func__,
+                 renewal.m_cpid.ToString(),
+                 renewal.GetAddress().ToString(),
+                 renewal.m_hash.GetHex());
+    }
 
     // Get the iterator to the renewal beacon.
     auto renewal_iter = m_beacon_db.find(renewal.m_hash);
@@ -989,6 +997,35 @@ int BeaconRegistry::BeaconDB::Initialize(PendingBeaconMap& m_pending, BeaconMap&
 {
     bool status = true;
     int height = 0;
+    uint32_t version = 0;
+
+    // First load the beacon db version from leveldb and check it against the constant in the class.
+    {
+        CTxDB txdb("r");
+
+        std::pair<std::string, std::string> key = std::make_pair("beacon_db", "version");
+
+        bool status = txdb.ReadGenericSerializable(key, version);
+
+        if (!status) version = 0;
+    }
+
+    if (version != CURRENT_VERSION)
+    {
+        LogPrint(LogFlags::BEACON, "WARNING: %s: Version level of the beacon db stored in leveldb, %u, does not "
+                                   "match that required in this code level, version %u. Clearing the leveldb beacon "
+                                   "storage and setting version level to match this code level.",
+                 __func__,
+                 version,
+                 CURRENT_VERSION);
+
+        clear_leveldb();
+
+        LogPrint(LogFlags::BEACON, "INFO: %s: Leveldb beacon area cleared. Version level set to %u.",
+                 __func__,
+                 CURRENT_VERSION);
+    }
+
 
     // If LoadDBHeight not successful or height is zero then leveldb has not been initialized before.
     // LoadDBHeight will also set the private member variable m_height_stored from leveldb for this first call.
@@ -1175,6 +1212,9 @@ void BeaconRegistry::ResetInMemoryOnly()
     m_beacon_db.clear_in_memory_only();
 }
 
+// Required to make the linker happy.
+constexpr uint32_t BeaconRegistry::BeaconDB::CURRENT_VERSION;
+
 void BeaconRegistry::BeaconDB::clear_in_memory_only()
 {
     m_historical.clear();
@@ -1189,15 +1229,19 @@ bool BeaconRegistry::BeaconDB::clear_leveldb()
 
     CTxDB txdb("rw");
 
-    std::string key_type = "beacon_db";
+    std::string key_type = "beacon";
+    uint256 start_key_hint_beacon = uint256();
+
+    status &= txdb.EraseGenericSerializablesByKeyType(key_type, start_key_hint_beacon);
+
+    key_type = "beacon_db";
     std::string start_key_hint_beacon_db {};
 
     status &= txdb.EraseGenericSerializablesByKeyType(key_type, start_key_hint_beacon_db);
 
-    key_type = "beacon";
-    uint256 start_key_hint_beacon = uint256();
-
-    status &= txdb.EraseGenericSerializablesByKeyType(key_type, start_key_hint_beacon);
+    // We want to write back into leveldb the revision level of the db in the running code.
+    std::pair<std::string, std::string> key = std::make_pair(key_type, "version");
+    status &= txdb.WriteGenericSerializable(key, CURRENT_VERSION);
 
     m_height_stored = 0;
     m_recnum_stored = 0;

src/gridcoin/beacon.h

@@ -707,6 +707,15 @@ class BeaconRegistry : public IContractHandler
     class BeaconDB
     {
     public:
+        //!
+        //! \brief Version number of the beacon db.
+        //!
+        //! CONSENSUS: Increment this value when introducing a breaking change to the beacon db. This
+        //! will ensure that when the wallet is restarted, the level db beacon storage will be cleared and
+        //! reloaded from the contract replay with the correct lookback scope.
+        //!
+        static constexpr uint32_t CURRENT_VERSION = 1;
+
         //!
         //! \brief Initializes the Beacon Registry map structures from the replay of the beacon states stored
         //! in the beacon database.

src/gridcoin/contract/contract.cpp

@@ -463,8 +463,7 @@ void GRC::ReplayContracts(const CBlockIndex* pindex_end, const CBlockIndex* pind
             // Only apply activations that have not already been stored/loaded into
             // the beacon DB. This is at the block level, so we have to be careful here.
             // If the pindex->nHeight is equal to the beacon_db_height, then the ActivatePending
-            // has already been replayed. This is different than below in ApplyContracts, where
-            // there can be more than one contract in a block, so the condition is subtly different.
+            // has already been replayed.
             if (pindex->nHeight > beacon_db_height)
             {
                 GetBeaconRegistry().ActivatePending(
@@ -510,9 +509,8 @@ void GRC::ApplyContracts(
 {
     for (const auto& contract : tx.GetContracts()) {
         // Do not (re)apply contracts that have already been stored/loeaded into
-        // the beacon DB. Note here if pindex->nHeight == beacon_db_height, the contract
-        // will be replayed. This is because there can be more than one contract per block.
-        if ((pindex->nHeight < beacon_db_height) && contract.m_type == ContractType::BEACON)
+        // the beacon DB.
+        if ((pindex->nHeight <= beacon_db_height) && contract.m_type == ContractType::BEACON)
         {
             LogPrint(BCLog::LogFlags::CONTRACT, "INFO: %s: ApplyContract tx skipped: "
                       "pindex->height = %i <= beacon_db_height = %i and "

src/gridcoin/gridcoin.cpp

@@ -398,6 +398,11 @@ bool GRC::Initialize(ThreadHandlerPtr threads, CBlockIndex* pindexBest)
     return true;
 }
 
+void GRC::CloseResearcherRegistryFile()
+{
+    Tally::CloseRegistryFile();
+}
+
 void GRC::ScheduleBackgroundJobs(CScheduler& scheduler)
 {
     scheduler.schedule(CheckBlockIndexJob);

src/gridcoin/gridcoin.h

@@ -18,6 +18,12 @@ namespace GRC {
 //!
 bool Initialize(ThreadHandlerPtr threads, CBlockIndex* pindexBest);
 
+//!
+//! \brief This closes the underlying research file to support the snapshot update
+//! process, which must remove the accrual directory as part of the blockchain cleanup.
+//!
+void CloseResearcherRegistryFile();
+
 //!
 //! \brief Set up Gridcoin-specific background jobs.
 //!

src/gridcoin/tally.cpp

@@ -792,6 +792,11 @@ class ResearcherTally
 
         return Initialize(GetStartHeight(), SuperblockPtr::Empty());
     }
+
+    bool CloseRegistryFile()
+    {
+        return m_snapshots.CloseRegistryFile();
+    }
 }; // ResearcherTally
 
 ResearcherTally g_researcher_tally; //!< Tracks lifetime research rewards.
@@ -1261,3 +1266,8 @@ const CBlockIndex* Tally::GetBaseline()
 {
     return g_researcher_tally.GetBaseline();
 }
+
+void Tally::CloseRegistryFile()
+{
+    g_researcher_tally.CloseRegistryFile();
+}

src/gridcoin/tally.h

@@ -261,5 +261,13 @@ class Tally
     //!
     const static CBlockIndex* GetBaseline();
 
+    //!
+    //! \brief This closes the underlying register file of the researcher repository. It
+    //! is ONLY used in Shutdown() to release the lock on the registry.dat file
+    //! so that a snapshot download process cleanup will succeed, since the accrual directory
+    //! needs to be removed.
+    //!
+    static void CloseRegistryFile();
+
 };
 }

src/gridcoin/upgrade.cpp

@@ -376,6 +376,7 @@ bool Upgrade::CleanupBlockchainData()
                         if (!fs::remove_all(*Iter)) return false;
                     }
                 }
+
                 continue;
             }
 
@@ -391,6 +392,7 @@ bool Upgrade::CleanupBlockchainData()
                         if (!fs::remove(*Iter))
                             return false;
                 }
+
                 continue;
             }
         }

src/init.cpp

@@ -104,6 +104,11 @@ void Shutdown(void* parg)
         StopNode();
         bitdb.Flush(true);
         StopRPCThreads();
+
+        // This is necessary here to prevent a snapshot download from failing at the cleanup
+        // step because of a write lock on accrual/registry.dat.
+        GRC::CloseResearcherRegistryFile();
+
         fs::remove(GetPidFile());
         UnregisterWallet(pwalletMain);
         delete pwalletMain;

src/qt/aboutdialog.cpp

@@ -7,7 +7,7 @@ AboutDialog::AboutDialog(QWidget *parent) :
     ui(new Ui::AboutDialog)
 {
     ui->setupUi(this);
-    ui->copyrightLabel->setText("Copyright 2009-2020 The Bitcoin/Peercoin/Black-Coin/Gridcoin developers");
+    ui->copyrightLabel->setText("Copyright 2009-2021 The Bitcoin/Peercoin/Black-Coin/Gridcoin developers");
 }
 
 void AboutDialog::setModel(ClientModel *model)

src/qt/bitcoin.cpp

@@ -23,6 +23,7 @@
 #include "util.h"
 #include "winshutdownmonitor.h"
 #include "gridcoin/upgrade.h"
+#include "gridcoin/gridcoin.h"
 #include "upgradeqt.h"
 
 #include <QMessageBox>
@@ -404,7 +405,7 @@ int main(int argc, char *argv[])
         //
         CTxDB().Close();
 
-        if (Snapshot.SnapshotMain())
+        if (Snapshot.SnapshotMain(app))
             LogPrintf("Snapshot: Success!");
 
         else
@@ -560,6 +561,7 @@ int StartGridcoinQt(int argc, char *argv[], QApplication& app, OptionsModel& opt
     threads->removeAll();
     threads.reset();
 
+
     return EXIT_SUCCESS;
 }
 

src/qt/bitcoingui.cpp

@@ -1136,7 +1136,7 @@ void BitcoinGUI::gotoSendCoinsPage()
 void BitcoinGUI::gotoVotingPage()
 {
     votingAction->setChecked(true);
-    votingPage->resetData();
+    //votingPage->loadPolls(false);
     centralWidget->setCurrentWidget(votingPage);
 
     exportAction->setEnabled(false);

src/qt/peertablemodel.cpp

@@ -108,7 +108,7 @@ PeerTableModel::PeerTableModel(ClientModel *parent) :
     clientModel(parent),
     timer(nullptr)
 {
-    columns << tr("NodeId") << tr("Node/Service") << tr("Ping") << tr("Sent") << tr("Received") << tr("User Agent");
+    columns << tr("Node ID") << tr("Node/Service") << tr("Ping") << tr("Sent") << tr("Received") << tr("User Agent");
     priv.reset(new PeerTablePriv());
 
     // set up timer for auto refresh

src/qt/upgradeqt.cpp

@@ -8,7 +8,6 @@
 #include <QtWidgets>
 #include <QProgressDialog>
 #include <QMessageBox>
-#include <QApplication>
 #include <QPixmap>
 #include <QIcon>
 #include <QString>
@@ -23,16 +22,8 @@ QString UpgradeQt::ToQString(const std::string& string)
     return QString::fromStdString(string);
 }
 
-bool UpgradeQt::SnapshotMain()
+bool UpgradeQt::SnapshotMain(QApplication& SnapshotApp)
 {
-    // Keep this separate from the main application
-    int xargc = 1;
-    char *xargv[] = {(char*)"gridcoinresearch"};
-
-    QApplication SnapshotApp(xargc, xargv);
-
-    SnapshotApp.setOrganizationName("Gridcoin");
-    SnapshotApp.setApplicationName("Gridcoin-Qt");
     SnapshotApp.processEvents();
     SnapshotApp.setWindowIcon(QPixmap(":/images/gridcoin"));
 

src/qt/upgradeqt.h

@@ -7,6 +7,7 @@
 
 #include <string>
 #include <QString>
+#include <QApplication>
 
 class UpgradeQt
 {
@@ -20,7 +21,7 @@ class UpgradeQt
     //!
     //! \return Returns success of snapshot task.
     //!
-    bool SnapshotMain();
+    bool SnapshotMain(QApplication& SnapshotApp);
     //!
     //! \brief Function called via thread to download snapshot and provide realtime updates of progress.
     //!