accrual mod WIP

Author: jamescowens

src/chainparams.h

@@ -134,5 +134,5 @@ inline int GetNewbieSnapshotFixHeight()
 {
     // This was the original hard fork point for the newbie accrual fix that didn't work.
     // return fTestNet ? 1393000 : 2104000;
-    return fTestNet ? 1479000 : 2104000;
+    return fTestNet ? 1393000 : 2104000;
 }

src/gridcoin/beacon.cpp

@@ -44,7 +44,10 @@ uint256 HashBeaconPayload(const BeaconPayload& payload)
 //! \return \c true if the supplied beacon contract matches an active beacon.
 //! This updates the matched beacon with a new timestamp.
 //!
-bool TryRenewal(BeaconRegistry::BeaconMap& beacons, const BeaconPayload& payload)
+bool TryRenewal(BeaconRegistry::BeaconMap& beacons,
+                BeaconRegistry::HistoricalBeaconMap& historical_beacons,
+                const BeaconPayload& payload,
+                const uint256& ctx_hash)
 {
     auto beacon_pair_iter = beacons.find(payload.m_cpid);
 
@@ -62,7 +65,12 @@ bool TryRenewal(BeaconRegistry::BeaconMap& beacons, const BeaconPayload& payload
         return false;
     }
 
+    // Insert current beacon into historical map.
+    historical_beacons.emplace(std::make_pair(ctx_hash, current_beacon));
+
+    // Update current beacon record.
     current_beacon.m_timestamp = payload.m_beacon.m_timestamp;
+    current_beacon.m_prev_beacon_txn_hash = ctx_hash;
 
     return true;
 }
@@ -93,6 +101,7 @@ Beacon::Beacon(CPubKey public_key)
 Beacon::Beacon(CPubKey public_key, int64_t timestamp)
     : m_public_key(std::move(public_key))
     , m_timestamp(timestamp)
+    , m_prev_beacon_txn_hash()
 {
 }
 
@@ -157,6 +166,12 @@ bool Beacon::Renewable(const int64_t now) const
     return Age(now) > RENEWAL_AGE;
 }
 
+bool Beacon::Renewed() const
+{
+    // If not empty, the beacon was a renewal.
+    return (m_prev_beacon_txn_hash != uint256());
+}
+
 CKeyID Beacon::GetId() const
 {
     return m_public_key.GetID();
@@ -276,6 +291,11 @@ const BeaconRegistry::PendingBeaconMap& BeaconRegistry::PendingBeacons() const
     return m_pending;
 }
 
+const BeaconRegistry::HistoricalBeaconMap &BeaconRegistry::HistoricalBeacons() const
+{
+    return m_historical;
+}
+
 BeaconOption BeaconRegistry::Try(const Cpid& cpid) const
 {
     const auto iter = m_beacons.find(cpid);
@@ -353,7 +373,7 @@ void BeaconRegistry::Add(const ContractContext& ctx)
     // For beacon renewals, check that the new beacon contains the same public
     // key. If it matches, we don't need to verify it again:
     //
-    if (TryRenewal(m_beacons, payload)) {
+    if (TryRenewal(m_beacons, m_historical, payload, ctx.m_tx.GetHash())) {
         return;
     }
 

src/gridcoin/beacon.h

@@ -68,6 +68,13 @@ class Beacon
     CPubKey m_public_key;      //!< Verifies blocks that claim research rewards.
     int64_t m_timestamp;       //!< Time of the the beacon contract transaction.
 
+    // The reason the transaction hash is included here instead of a pointer
+    // to the previous beacon, is that given the limited lookback scope, the
+    // previous beacon may not be in the map. This makes the linked list harder
+    // to deal with, but relieves us of dealing with the leading edge of the
+    // lookback window.
+    uint256 m_prev_beacon_txn_hash; //!< If a renewal contains the txn hash of the previous beacon.
+
     //!
     //! \brief Initialize an empty, invalid beacon instance.
     //!
@@ -140,6 +147,13 @@ class Beacon
     //!
     bool Renewable(const int64_t now) const;
 
+    //!
+    //! \brief Determine whether the beacon was renewed.
+    //!
+    //! \return \c true if the beacon is a renewal rather than new advertisement
+    //!
+    bool Renewed() const;
+
     //!
     //! \brief Get the hash of the beacon public key.
     //!
@@ -409,6 +423,11 @@ class BeaconRegistry : public IContractHandler
     //!
     typedef std::unordered_map<Cpid, Beacon> BeaconMap;
 
+    //!
+    //! \brief The type that associates historical beacons with the ctx hash.
+    //!
+    typedef std::map<uint256, Beacon> HistoricalBeaconMap;
+
     //!
     //! \brief Associates pending beacons with the hash of the beacon public
     //! keys.
@@ -429,6 +448,13 @@ class BeaconRegistry : public IContractHandler
     //!
     const PendingBeaconMap& PendingBeacons() const;
 
+    //!
+    //! \brief Get the collection of historical beacons.
+    //!
+    //! \return A reference to the historical beacons stored in the registry.
+    //!
+    const HistoricalBeaconMap& HistoricalBeacons() const;
+
     //!
     //! \brief Get the beacon for the specified CPID.
     //!
@@ -531,6 +557,7 @@ class BeaconRegistry : public IContractHandler
 private:
     BeaconMap m_beacons;        //!< Contains the active registered beacons.
     PendingBeaconMap m_pending; //!< Contains beacons awaiting verification.
+    HistoricalBeaconMap m_historical; //!< Contains historical beacons.
 }; // BeaconRegistry
 
 //!

src/gridcoin/tally.cpp

@@ -644,7 +644,7 @@ class ResearcherTally
     //!
     //! \brief Compute "catch-up" accrual to correct for newbie accrual bug.
     //!
-    //! \param superblock Incoming superblock to calculate rewards at.
+    //! \param cpid for which to calculate the accrual correction.
     //!
     CAmount GetNewbieSuperblockAccrualCorrection(Cpid cpid)
     {

src/rpc/mining.cpp

@@ -316,6 +316,21 @@ UniValue auditsnapshotaccrual(const UniValue& params, bool fHelp)
         }
     }
 
+    const GRC::BeaconRegistry& beacons = GRC::GetBeaconRegistry();
+
+    GRC::BeaconOption beacon = beacons.Try(*cpid);
+
+    UniValue beacon_chain(UniValue::VARR);
+
+    // This walks back the entries in the historical beacon map linked by renewal prev tx hash until the first
+    // beacon in the renewal chain is found (the original advertisement). The accrual starts no earlier than here.
+    while (beacon->Renewed())
+    {
+        beacon_chain.push_back(beacon->m_timestamp);
+
+        beacon = &beacons.HistoricalBeacons().find(beacon->m_prev_beacon_txn_hash)->second;
+    }
+
     // Set the pindex_low to the pindex_superblock. For right now, we are going to take the accrual at the first snapshot
     // after the flip to v11 (the second snapshot in the accrual directory recorded at the first SB after the transition
     // height) as gospel. This doesn't allow us to verify the accrual between the transition height and the first snapshot
@@ -413,6 +428,10 @@ UniValue auditsnapshotaccrual(const UniValue& params, bool fHelp)
     };
 
     for (; pindex; pindex = pindex->pnext) {
+
+        // Due not accrue for any block with a timestamp ealier than the first beacon in the renewal chain.
+        if (pindex->nTime < beacon->m_timestamp) continue;
+
         if (pindex->ResearchSubsidy() > 0 && pindex->GetMiningId() == *cpid) {
             tally_accrual_period(
                 "stake",
@@ -442,10 +461,13 @@ UniValue auditsnapshotaccrual(const UniValue& params, bool fHelp)
     int64_t period = tally_accrual_period("tip", 0, pindex_low->nTime, now, 0);
 
     if (report_details) {
+        result.pushKV("beacon_chain", beacon_chain);
         result.pushKV("audit", audit);
         result.pushKV("computed", computed);
         result.pushKV("accrual_account_exists", accrual_account_exists);
     } else {
+        result.pushKV("original_beacon_timestamp", beacon_chain[0]);
+        result.pushKV("beacon_chain_size", beacon_chain.size());
         result.pushKV("accrual_by_audit", accrual);
         result.pushKV("accrual_by_GetAccrual", computed);
         result.pushKV("accrual_last_period", period);
@@ -496,6 +518,8 @@ UniValue auditsnapshotaccruals(const UniValue& params, bool fHelp)
 
         if (!audit.empty())
         {
+            //const int64_t original_beacon_timestamp = find_value(audit, "original_beacon_timestamp").get_int64();
+            //const int64_t renewals = find_value(audit, "renewals").get_int64();
             const CAmount& accrual_by_audit = find_value(audit, "accrual_by_audit").get_int64();
             const CAmount& accrual_by_GetAccrual = find_value(audit, "accrual_by_GetAccrual").get_int64();
             const CAmount& accrual_last_period = find_value(audit, "accrual_last_period").get_int64();