Add deadpool feature

Author: ReverseControl

src/Makefile.am

@@ -145,6 +145,9 @@ BITCOIN_CORE_H = \
   core_memusage.h \
   cuckoocache.h \
   dbwrapper.h \
+  deadpool/announcedb.h \
+  deadpool/deadpool.h \
+  deadpool/index.h \
   deploymentinfo.h \
   deploymentstatus.h \
   external_signer.h \
@@ -156,6 +159,7 @@ BITCOIN_CORE_H = \
   index/base.h \
   index/blockfilterindex.h \
   index/coinstatsindex.h \
+  index/deadpoolindex.h \
   index/disktxpos.h \
   index/txindex.h \
   indirectmap.h \
@@ -329,6 +333,7 @@ libbitcoin_server_a_SOURCES = \
   blockfilter.cpp \
   chain.cpp \
   consensus/tx_verify.cpp \
+  deadpool/announcedb.cpp \
   dbwrapper.cpp \
   deploymentstatus.cpp \
   flatfile.cpp \
@@ -338,6 +343,7 @@ libbitcoin_server_a_SOURCES = \
   index/base.cpp \
   index/blockfilterindex.cpp \
   index/coinstatsindex.cpp \
+  index/deadpoolindex.cpp \
   index/txindex.cpp \
   init.cpp \
   mapport.cpp \
@@ -360,6 +366,7 @@ libbitcoin_server_a_SOURCES = \
   pow.cpp \
   rest.cpp \
   rpc/blockchain.cpp \
+  rpc/deadpool.cpp \
   rpc/mining.cpp \
   rpc/misc.cpp \
   rpc/net.cpp \
@@ -506,6 +513,8 @@ libbitcoin_consensus_a_SOURCES = \
   consensus/params.h \
   consensus/tx_check.cpp \
   consensus/validation.h \
+  deadpool/deadpool.cpp \
+  deadpool/deadpool.h \
   hash.cpp \
   hash.h \
   prevector.h \
@@ -515,6 +524,7 @@ libbitcoin_consensus_a_SOURCES = \
   primitives/transaction.h \
   pubkey.cpp \
   pubkey.h \
+  script/bignum.h \
   script/bitcoinconsensus.cpp \
   script/interpreter.cpp \
   script/interpreter.h \

src/Makefile.test.include

@@ -86,6 +86,7 @@ BITCOIN_TESTS =\
   test/compress_tests.cpp \
   test/crypto_tests.cpp \
   test/cuckoocache_tests.cpp \
+  test/deadpool_tests.cpp \
   test/denialofservice_tests.cpp \
   test/descriptor_tests.cpp \
   test/flatfile_tests.cpp \

src/bench/mempool_eviction.cpp

@@ -15,8 +15,9 @@ static void AddTx(const CTransactionRef& tx, const CAmount& nFee, CTxMemPool& po
     bool spendsCoinbase = false;
     unsigned int sigOpCost = 4;
     LockPoints lp;
+    CAmount nBurnAmount = 0;
     pool.addUnchecked(CTxMemPoolEntry(
-        tx, nFee, nTime, nHeight,
+        tx, nFee, nBurnAmount, nTime, nHeight,
         spendsCoinbase, sigOpCost, lp));
 }
 

src/bench/mempool_stress.cpp

@@ -16,7 +16,7 @@ static void AddTx(const CTransactionRef& tx, CTxMemPool& pool) EXCLUSIVE_LOCKS_R
     bool spendsCoinbase = false;
     unsigned int sigOpCost = 4;
     LockPoints lp;
-    pool.addUnchecked(CTxMemPoolEntry(tx, 1000, nTime, nHeight, spendsCoinbase, sigOpCost, lp));
+    pool.addUnchecked(CTxMemPoolEntry(tx, 1000, 0, nTime, nHeight, spendsCoinbase, sigOpCost, lp));
 }
 
 struct Available {

src/bench/rpc_mempool.cpp

@@ -12,7 +12,7 @@
 static void AddTx(const CTransactionRef& tx, const CAmount& fee, CTxMemPool& pool) EXCLUSIVE_LOCKS_REQUIRED(cs_main, pool.cs)
 {
     LockPoints lp;
-    pool.addUnchecked(CTxMemPoolEntry(tx, fee, /* time */ 0, /* height */ 1, /* spendsCoinbase */ false, /* sigOpCost */ 4, lp));
+    pool.addUnchecked(CTxMemPoolEntry(tx, fee, /* burned */ 0, /* time */ 0, /* height */ 1, /* spendsCoinbase */ false, /* sigOpCost */ 4, lp));
 }
 
 static void RpcMempool(benchmark::Bench& bench)

src/chainparams.cpp

@@ -100,7 +100,7 @@ class CMainParams : public CChainParams {
         consensus.nPowTargetSpacing  =   30 * 60;                     // 30 Minutes * 60 Seconds                      |-> Seconds in 30 minutes
         consensus.fPowAllowMinDifficultyBlocks = false;
         consensus.fPowNoRetargeting  = false;
-        consensus.nRuleChangeActivationThreshold = 100;
+        consensus.nRuleChangeActivationThreshold = 639; // 95% of 672 (rounded up from 638.4)
         consensus.nMinerConfirmationWindow = 672; // nPowTargetTimespan / nPowTargetSpacing
 
         consensus.vDeployments[Consensus::DEPLOYMENT_TESTDUMMY].bit = 28;
@@ -118,6 +118,17 @@ class CMainParams : public CChainParams {
 	    //Number of rounds for gHash to generate random Ws around which to search for semiprimes.
 	    consensus.hashRounds = 1;
 
+        // Deadpool softfork
+        consensus.vDeployments[Consensus::DEPLOYMENT_DEADPOOL].bit = 27;
+        consensus.vDeployments[Consensus::DEPLOYMENT_DEADPOOL].nStartTime = 1735689600LL; // 2025-01-01
+        consensus.vDeployments[Consensus::DEPLOYMENT_DEADPOOL].nTimeout = 1748736000LL; // 2025-06-01
+        consensus.vDeployments[Consensus::DEPLOYMENT_DEADPOOL].min_activation_height = 155000; // no delay
+
+        // Deadpool parametrization
+        consensus.nDeadpoolAnnounceMaturity = 100;
+        consensus.nDeadpoolAnnounceValidity = 672;
+        consensus.nDeadpoolAnnounceMinBurn = 1000000; // 0.01 COIN
+
         /**
          * The message start string is designed to be unlikely to occur in normal data.
          * The characters are rarely used upper ASCII, not valid as UTF-8, and produce
@@ -210,6 +221,17 @@ class CTestNetParams : public CChainParams {
         //Number of Miller-Rabin rounds, determines primality with false positive rate of 4^(-rounds).
         consensus.MillerRabinRounds = 50 ;
 
+        // Deadpool softfork
+        consensus.vDeployments[Consensus::DEPLOYMENT_DEADPOOL].bit = 27;
+        consensus.vDeployments[Consensus::DEPLOYMENT_DEADPOOL].nStartTime = 1735689600LL; // Jan 1st, 2025
+        consensus.vDeployments[Consensus::DEPLOYMENT_DEADPOOL].nTimeout = Consensus::BIP9Deployment::NO_TIMEOUT;
+        consensus.vDeployments[Consensus::DEPLOYMENT_DEADPOOL].min_activation_height = 0; // No activation delay
+
+        // Deadpool parametrization
+        consensus.nDeadpoolAnnounceMaturity = 5;
+        consensus.nDeadpoolAnnounceValidity = 100;
+        consensus.nDeadpoolAnnounceMinBurn = 1000000; // 0.01 COIN
+
 	    //Number of rounds for gHash to generate random Ws around which to search for semiprimes.
 	    consensus.hashRounds = 1;
 
@@ -356,6 +378,17 @@ class SigNetParams : public CChainParams {
 	    //Number of rounds for gHash to generate random Ws around which to search for semiprimes.
 	    consensus.hashRounds = 1;
 
+        // Deadpool softfork
+        consensus.vDeployments[Consensus::DEPLOYMENT_DEADPOOL].bit = 27;
+        consensus.vDeployments[Consensus::DEPLOYMENT_DEADPOOL].nStartTime = 0;
+        consensus.vDeployments[Consensus::DEPLOYMENT_DEADPOOL].nTimeout = Consensus::BIP9Deployment::NO_TIMEOUT;
+        consensus.vDeployments[Consensus::DEPLOYMENT_DEADPOOL].min_activation_height = (4 * consensus.nMinerConfirmationWindow); // Add one more epoch than required
+
+        // Deadpool parametrization
+        consensus.nDeadpoolAnnounceMaturity = 5;
+        consensus.nDeadpoolAnnounceValidity = 100;
+        consensus.nDeadpoolAnnounceMinBurn = 1000000; // 0.01 COIN
+
         vFixedSeeds.clear();
         base58Prefixes[PUBKEY_ADDRESS] = std::vector<unsigned char>(1,111);
         base58Prefixes[SCRIPT_ADDRESS] = std::vector<unsigned char>(1,196);
@@ -397,8 +430,8 @@ class CRegTestParams : public CChainParams {
         consensus.nPowTargetSpacing = 30 * 60;
         consensus.fPowAllowMinDifficultyBlocks = true;
         consensus.fPowNoRetargeting = true;
-        consensus.nRuleChangeActivationThreshold = 108; // 75% for testchains
-        consensus.nMinerConfirmationWindow = 144; // Faster than normal for regtest (144 instead of 2016)
+        consensus.nRuleChangeActivationThreshold = 24; // 75% for testchains
+        consensus.nMinerConfirmationWindow = 32; // Faster than normal for regtest (32 instead of 2016)
 
         consensus.vDeployments[Consensus::DEPLOYMENT_TESTDUMMY].bit = 28;
         consensus.vDeployments[Consensus::DEPLOYMENT_TESTDUMMY].nStartTime = 0;
@@ -423,6 +456,17 @@ class CRegTestParams : public CChainParams {
 	    //Number of rounds for gHash to generate random Ws around which to search for semiprimes.
 	    consensus.hashRounds = 1;
 
+        // Deadpool softfork
+        consensus.vDeployments[Consensus::DEPLOYMENT_DEADPOOL].bit = 27;
+        consensus.vDeployments[Consensus::DEPLOYMENT_DEADPOOL].nStartTime = 0;
+        consensus.vDeployments[Consensus::DEPLOYMENT_DEADPOOL].nTimeout = Consensus::BIP9Deployment::NO_TIMEOUT;
+        consensus.vDeployments[Consensus::DEPLOYMENT_DEADPOOL].min_activation_height = (4 * consensus.nMinerConfirmationWindow); // Add one more epoch than required
+
+        // Deadpool parametrization
+        consensus.nDeadpoolAnnounceMaturity = 5;
+        consensus.nDeadpoolAnnounceValidity = 100;
+        consensus.nDeadpoolAnnounceMinBurn = 1000000; // 0.01 COIN
+
         UpdateActivationParametersFromArgs(args);
 
         vFixedSeeds.clear(); //!< Regtest mode doesn't have any fixed seeds.

src/consensus/params.h

@@ -28,6 +28,7 @@ constexpr bool ValidDeployment(BuriedDeployment dep) { return dep <= DEPLOYMENT_
 
 enum DeploymentPos : uint16_t {
     DEPLOYMENT_TESTDUMMY,
+    DEPLOYMENT_DEADPOOL,
     // NOTE: Also add new deployments to VersionBitsDeploymentInfo in deploymentinfo.cpp
     MAX_VERSION_BITS_DEPLOYMENTS
 };
@@ -116,6 +117,17 @@ struct Params {
     //Number of rounds for gHash to generate random Ws around which to search for semiprimes.
     uint32_t hashRounds;
 
+    //// deadpool parameters ////
+
+    //! The number of blocks a deadpool announcement needs to mature
+    uint16_t nDeadpoolAnnounceMaturity;
+    //! The number of blocks a deadpool announcement is valid for
+    uint16_t nDeadpoolAnnounceValidity;
+    //! The minimum amount to burn on an announcement
+    int64_t nDeadpoolAnnounceMinBurn;
+
+    int64_t DeadpoolAnnounceMaxAge() const { return nDeadpoolAnnounceMaturity + nDeadpoolAnnounceValidity; }
+
     /**
      * If true, witness commitments contain a payload equal to a Bitcoin Script solution
      * to the signet challenge. See BIP325.

src/consensus/validation.h

@@ -53,6 +53,7 @@ enum class TxValidationResult {
      */
     TX_CONFLICT,
     TX_MEMPOOL_POLICY,        //!< violated mempool's fee/size/descendant/RBF/etc limits
+    TX_DEADPOOL_NO_ANNOUNCE, //!< No valid announcement could be found for a deadpool claim
 };
 
 /** A "reason" why a block was invalid, suitable for determining whether the

src/deadpool/announcedb.cpp

@@ -0,0 +1,80 @@
+// Copyright (c) 2024 AUTHOR
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+#include <deadpool/announcedb.h>
+
+#include <deadpool/deadpool.h>
+#include <deadpool/index_common.h>
+#include <node/ui_interface.h>
+#include <uint256.h>
+#include <util/system.h>
+
+#include <vector>
+#include <stdint.h>
+
+static constexpr uint8_t DB_DEADPOOL_ANN{'a'};
+
+CAnnounceDB::CAnnounceDB(size_t nCacheSize, bool fMemory, bool fWipe) : CDBWrapper(gArgs.GetDataDirNet() / "announcedb", nCacheSize, fMemory, fWipe) {}
+
+bool CAnnounceDB::AddAnnouncements(const std::vector<CLocdAnnouncement> &list) {
+    CDBBatch batch(*this);
+    size_t count;
+
+    for (std::vector<CLocdAnnouncement>::const_iterator it=list.begin(); it != list.end(); it++) {
+        const uint256 entry = it->announcement.NHash();
+        LogPrint(BCLog::COINDB, "Added announcement (%s:%u) at height %d for entry %s to db.\n", it->locator.hash.GetHex(), it->locator.n, it->announcement.nHeight, entry.GetHex());
+        const DeadpoolIndexKey key({DB_DEADPOOL_ANN, entry, it->locator});
+        const CClaimValue value({it->announcement.nHeight, it->announcement.ClaimHash()});
+        batch.Write(key, value);
+        count++;
+    }
+
+    bool ret = WriteBatch(batch);
+    LogPrint(BCLog::COINDB, "Committed %u announcements to db.\n", count);
+    return ret;
+}
+
+bool CAnnounceDB::RemoveAnnouncements(const std::vector<CLocdAnnouncement> &list) {
+    CDBBatch batch(*this);
+    size_t count;
+
+    for (std::vector<CLocdAnnouncement>::const_iterator it=list.begin(); it != list.end(); it++) {
+        const uint256 entry = it->announcement.NHash();
+        LogPrint(BCLog::COINDB, "Removed announcement (%s:%u) for entry %s from db.\n", it->locator.hash.GetHex(), it->locator.n, entry.GetHex());
+        const DeadpoolIndexKey key({DB_DEADPOOL_ANN, entry, it->locator});
+        batch.Erase(key);
+        count++;
+    }
+
+    bool ret = WriteBatch(batch);
+    LogPrint(BCLog::COINDB, "Removed %u announcements from db.\n", count);
+    return ret;
+}
+
+bool CAnnounceDB::ClaimExists(const uint256 &hash, const uint256 &claim, const int32_t minHeight, const int32_t maxHeight) const
+{
+    std::unique_ptr<CDBIterator> pcursor(const_cast<CAnnounceDB&>(*this).NewIterator());
+
+    const DeadpoolIndexSearchKey searchKey({DB_DEADPOOL_ANN, hash});
+    pcursor->Seek(searchKey);
+
+    while (pcursor->Valid()) {
+        DeadpoolIndexKey key = {};
+        CClaimValue value = {};
+
+        if (pcursor->GetKey(key) && key.type == DB_DEADPOOL_ANN && key.deadpoolId == hash) {
+            if (pcursor->GetValue(value)) {
+                if (value.height <= maxHeight && value.height >= minHeight && value.claimHash == claim) {
+                    LogPrint(BCLog::COINDB, "Found claim %s for entry %s: %s:%u.\n", claim.GetHex(), hash.GetHex(), key.locator.hash.GetHex(), key.locator.n);
+                    return true;
+                }
+            }
+            pcursor->Next();
+        } else {
+            break;
+        }
+    }
+
+    return false;
+}

src/deadpool/announcedb.h

@@ -0,0 +1,44 @@
+// Copyright (c) 2024 AUTHOR
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+#ifndef FACTORN_ANNOUNCEDB_H
+#define FACTORN_ANNOUNCEDB_H
+
+#include <deadpool/deadpool.h>
+#include <deadpool/index_common.h>
+#include <primitives/transaction.h> // for COutPoint
+#include <dbwrapper.h>
+#include <uint256.h>
+
+#include <cstdint>
+#include <memory>
+#include <string>
+#include <utility>
+#include <vector>
+
+//! maximum cache for announcedb in MiB
+static const int64_t nMaxAnnounceDbCache = 16;
+
+class CClaimValue {
+public:
+  int32_t height;
+  uint256 claimHash;
+
+  SERIALIZE_METHODS(CClaimValue, obj) {
+    READWRITE(obj.height);
+    READWRITE(obj.claimHash);
+  }
+};
+
+class CAnnounceDB : public CDBWrapper
+{
+public:
+    explicit CAnnounceDB(size_t nCacheSize, bool fMemory = false, bool fWipe = false);
+
+    bool AddAnnouncements(const std::vector<CLocdAnnouncement> &list);
+    bool RemoveAnnouncements(const std::vector<CLocdAnnouncement> &list);
+    bool ClaimExists(const uint256 &hash, const uint256 &claim, const int32_t minHeight, const int32_t maxHeight) const;
+};
+
+#endif // FACTORN_ANNOUNCEDB_H