Merge pull request #2425 from jamescowens/mrc_for_pr

consensus, contract, mining, researcher, rpc, staking, gui: Implementation of MRC - baseline functionality

Author: jamescowens

src/Makefile.am

@@ -106,6 +106,7 @@ GRIDCOIN_CORE_H = \
     gridcoin/cpid.h \
     gridcoin/gridcoin.h \
     gridcoin/magnitude.h \
+    gridcoin/mrc.h \
     gridcoin/project.h \
     gridcoin/quorum.h \
     gridcoin/researcher.h \
@@ -223,6 +224,7 @@ GRIDCOIN_CORE_CPP = addrdb.cpp \
     gridcoin/contract/message.cpp \
     gridcoin/cpid.cpp \
     gridcoin/gridcoin.cpp \
+    gridcoin/mrc.cpp \
     gridcoin/project.cpp \
     gridcoin/quorum.cpp \
     gridcoin/researcher.cpp \

src/Makefile.qt.include

@@ -439,6 +439,7 @@ RES_ICONS = \
   qt/res/icons/transaction0.png \
   qt/res/icons/transaction2.svg \
   qt/res/icons/tx_contract_beacon.svg \
+  qt/res/icons/tx_contract_mrc.svg \
   qt/res/icons/tx_contract_voting.svg \
   qt/res/icons/tx_inout.svg \
   qt/res/icons/tx_input.svg \

src/Makefile.test.include

@@ -50,6 +50,7 @@ GRIDCOIN_TESTS =\
 	test/gridcoin/cpid_tests.cpp \
 	test/gridcoin/enumbytes_tests.cpp \
 	test/gridcoin/magnitude_tests.cpp \
+	test/gridcoin/mrc_tests.cpp \
 	test/gridcoin/project_tests.cpp \
 	test/gridcoin/researcher_tests.cpp \
 	test/gridcoin/superblock_tests.cpp \

src/chainparams.cpp

@@ -64,6 +64,11 @@ class CMainParams : public CChainParams {
         consensus.BlockV9TallyHeight = 1144120;
         consensus.BlockV10Height = 1420000;
         consensus.BlockV11Height = 2053000;
+        consensus.BlockV12Height = std::numeric_limits<int>::max();
+        // Immediately post zero payment interval fees 40% for mainnet
+        consensus.InitialMRCFeeFractionPostZeroInterval = Fraction(2, 5);
+        // Zero day interval is 14 days on mainnet
+        consensus.MRCZeroPaymentInterval = 14 * 24 * 60 * 60;
         // "standard" scrypt target limit for proof of work, results in 0,000244140625 proof-of-work difficulty.
         // Equivalent to ~arith_uint256() >> 20 or 1e0fffff in compact notation.
         consensus.powLimit = uint256S("00000fffffffffffffffffffffffffffffffffffffffffffffffffffffffffff");
@@ -149,6 +154,11 @@ class CTestNetParams : public CChainParams {
         consensus.BlockV9TallyHeight = 399120;
         consensus.BlockV10Height = 629409;
         consensus.BlockV11Height = 1301500;
+        consensus.BlockV12Height = std::numeric_limits<int>::max();
+        // Immediately post zero payment interval fees 40% for testnet, the same as mainnet
+        consensus.InitialMRCFeeFractionPostZeroInterval = Fraction(2, 5);
+        // Zero day interval is 10 minutes on testnet. The very short interval facilitates testing.
+        consensus.MRCZeroPaymentInterval = 10 * 60;
         // Equivalent to ~arith_uint256() >> 16 or 1f00ffff in compact notation.
         consensus.powLimit = uint256S("0000ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff");
 

src/chainparams.h

@@ -10,6 +10,9 @@
 #include "consensus/params.h"
 #include "protocol.h"
 
+// system.h included only for temporary V12 fork point overrides for testing.
+#include "util/system.h"
+
 #include <memory>
 #include <vector>
 
@@ -131,6 +134,14 @@ inline bool IsV11Enabled(int nHeight)
     return nHeight >= Params().GetConsensus().BlockV11Height;
 }
 
+inline bool IsV12Enabled(int nHeight)
+{
+    // Temporary override for testing. Cf. Corresponding code in init.cpp
+    int BlockV12Height = gArgs.GetArg("-blockv12height", Params().GetConsensus().BlockV12Height);
+
+    return nHeight >= BlockV12Height;
+}
+
 inline int GetSuperblockAgeSpacing(int nHeight)
 {
     return (fTestNet ? 86400 : (nHeight > 364500) ? 86400 : 43200);

src/consensus/params.h

@@ -7,6 +7,7 @@
 #define BITCOIN_CONSENSUS_PARAMS_H
 
 #include "uint256.h"
+#include "util.h"
 
 namespace Consensus {
 
@@ -30,6 +31,16 @@ struct Params {
     int BlockV10Height;
     /** Block height at which v11 blocks are created */
     int BlockV11Height;
+    /** Block height at which v12 blocks are created */
+    int BlockV12Height;
+    /** The fraction of rewards taken as fees in an MRC after the zero payment interval. Only consesnus critical
+      * at BlockV12Height or above.
+      */
+    Fraction InitialMRCFeeFractionPostZeroInterval;
+    /** The amount of time from the last reward payment to a researcher where submitting an MRC will resort in 100%
+      * forfeiture of fees to the staker and/or foundation. Only consensus critical at BlockV12Height or above.
+      */
+    int64_t MRCZeroPaymentInterval;
 
     uint256 powLimit;
 };

src/dbwrapper.cpp

@@ -396,6 +396,7 @@ bool CTxDB::LoadBlockIndex()
         pindexNew->nBits          = diskindex.nBits;
         pindexNew->nNonce         = diskindex.nNonce;
         pindexNew->m_researcher   = diskindex.m_researcher;
+        pindexNew->m_mrc_researchers = diskindex.m_mrc_researchers;
 
         nBlockCount++;
         // Watch for genesis block

src/gridcoin/account.h

@@ -197,7 +197,7 @@ class ResearchAccount
     //! \return A block height of zero if the account never earned a research
     //! reward before.
     //!
-    uint32_t LastRewardHeight() const
+    int32_t LastRewardHeight() const
     {
         if (const BlockPtrOption pindex = LastRewardBlock()) {
             return (*pindex)->nHeight;

src/gridcoin/beacon.cpp

@@ -117,9 +117,9 @@ bool Beacon::Expired(const int64_t now) const
     // Temporary transition to version 2 beacons after the block version 11
     // hard-fork:
     //
-    if (m_timestamp <= g_v11_timestamp) {
-        return now - g_v11_timestamp > 14 * 86400;
-    }
+    // if (m_timestamp <= g_v11_timestamp) {
+    //    return now - g_v11_timestamp > 14 * 86400;
+    // }
 
     return false;
 }

src/gridcoin/block_index.h

@@ -30,6 +30,15 @@ class ResearcherContext
     Cpid m_cpid;
     int64_t m_research_subsidy;
     double m_magnitude;
+
+    ADD_SERIALIZE_METHODS;
+
+    template <typename Stream, typename Operation>
+    inline void SerializationOp(Stream& s, Operation ser_action) {
+        READWRITE(m_cpid);
+        READWRITE(m_research_subsidy);
+        READWRITE(m_magnitude);
+    }
 };
 
 //!

src/gridcoin/claim.cpp

@@ -59,6 +59,10 @@ uint256 GetClaimHash(
 
         if (claim.m_version >= 3) {
             hasher << coinstake_tx;
+
+            if (claim.m_version >= 4) {
+                hasher << claim.m_mrc_tx_map;
+            }
         }
 
         return hasher.GetHash();
@@ -173,6 +177,10 @@ bool Claim::WellFormed() const
         return false;
     }
 
+    // Note: It is appealing to check the size of m_mrc to ensure within limit of number of MRC outputs; however,
+    // the limit of the number of MRC outputs is a function of the block version as well as the claim version, so
+    // this is done exterior to this class in block level validation.
+
     return true;
 }
 

src/gridcoin/claim.h

@@ -35,7 +35,7 @@ class Claim : public IContractPayload
     //! ensure that the serialization/deserialization routines also handle all
     //! of the previous versions.
     //!
-    static constexpr uint32_t CURRENT_VERSION = 3;
+    static constexpr uint32_t CURRENT_VERSION = 4;
 
     //!
     //! \brief The maximum length of a serialized client version in a claim.
@@ -187,6 +187,19 @@ class Claim : public IContractPayload
     //!
     SuperblockPtr m_superblock;
 
+    //!
+    //! \brief A map of mrc transactions keyed by CPID. There can be only one MRC per CPID
+    //! in the claim.
+    //!
+    std::map<Cpid, uint256> m_mrc_tx_map;
+
+    //!
+    //! \brief This represents the fees taken from the MRC research subsidies that are awarded to the staker.
+    //! This must be tracked because this value is added to coinstake award for the staker and must be
+    //! included in the claim validation.
+    //!
+    CAmount m_mrc_fees_to_staker;
+
     //!
     //! \brief Initialize an empty, invalid reward claim object.
     //!
@@ -394,6 +407,10 @@ class Claim : public IContractPayload
         {
             READWRITE(m_superblock);
         }
+
+        if (m_version >= 4) {
+            READWRITE(m_mrc_tx_map);
+        }
     }
 }; // Claim
 }

src/gridcoin/contract/contract.cpp

@@ -7,6 +7,7 @@
 #include "main.h"
 #include "gridcoin/appcache.h"
 #include "gridcoin/claim.h"
+#include "gridcoin/mrc.h"
 #include "gridcoin/contract/contract.h"
 #include "gridcoin/contract/handler.h"
 #include "gridcoin/beacon.h"
@@ -304,6 +305,7 @@ class Dispatcher
 
 private:
     AppCacheContractHandler m_appcache_handler; //<! Temporary.
+    MRCContractHandler m_mrc_contract_handler;  //<! Simple wrapper to do context validation on MRC transactions.
     UnknownContractHandler m_unknown_handler;   //<! Logs unknown types.
 
     //!
@@ -324,6 +326,7 @@ class Dispatcher
             case ContractType::PROTOCOL:   return m_appcache_handler;
             case ContractType::SCRAPER:    return m_appcache_handler;
             case ContractType::VOTE:       return GetPollRegistry();
+            case ContractType::MRC:        return m_mrc_contract_handler;
             default:                       return m_unknown_handler;
         }
     }
@@ -765,6 +768,7 @@ Contract::Type Contract::Type::Parse(std::string input)
     // Ordered by frequency:
     if (input == "claim")          return ContractType::CLAIM;
     if (input == "beacon")         return ContractType::BEACON;
+    if (input == "mrc")            return ContractType::MRC;
     if (input == "vote")           return ContractType::VOTE;
     if (input == "poll")           return ContractType::POLL;
     if (input == "project")        return ContractType::PROJECT;
@@ -780,6 +784,7 @@ std::string Contract::Type::ToString() const
     switch (m_value) {
         case ContractType::BEACON:     return "beacon";
         case ContractType::CLAIM:      return "claim";
+        case ContractType::MRC:        return "mrc";
         case ContractType::MESSAGE:    return "message";
         case ContractType::POLL:       return "poll";
         case ContractType::PROJECT:    return "project";
@@ -856,6 +861,9 @@ ContractPayload Contract::Body::ConvertFromLegacy(const ContractType type) const
             // Claims can only exist in a coinbase transaction and have no
             // legacy representation as a contract:
             assert(false && "Attempted to convert legacy claim contract.");
+        case ContractType::MRC:
+            // MRCs have no legacy representation as a contract.
+            assert(false && "Attempted to convert non-existent legacy MRC contract.");
         case ContractType::MESSAGE:
             // The contract system does not map legacy transaction messages
             // stored in the CTransaction::hashBoinc field:
@@ -891,6 +899,9 @@ void Contract::Body::ResetType(const ContractType type)
         case ContractType::CLAIM:
             m_payload.Reset(new Claim());
             break;
+        case ContractType::MRC:
+            m_payload.Reset(new MRC());
+            break;
         case ContractType::MESSAGE:
             m_payload.Reset(new TxMessage());
             break;

src/gridcoin/contract/payload.h

@@ -57,13 +57,14 @@ enum class ContractType
 {
     UNKNOWN,      //!< An invalid, non-standard, or empty contract type.
     BEACON,       //!< Beacon advertisement or deletion.
-    CLAIM,        //!< Gridcoin block reward claim context.
+    CLAIM,        //!< Gridcoin block reward claim context (also includes bound MRCs paid as a delegated stake).
     MESSAGE,      //!< A user-supplied string. No associated protocol behavior.
     POLL,         //!< Submission of a new poll.
     PROJECT,      //!< Project whitelist addition or removal.
     PROTOCOL,     //!< Network control message or configuration directive.
     SCRAPER,      //!< Scraper node authorization grants and revocations.
     VOTE,         //!< A vote cast by a wallet for a poll.
+    MRC,          //!< A manual rewards claim (MRC) request to pay rewards
     OUT_OF_BOUND, //!< Marker value for the end of the valid range.
 };