From 98790608a43e60b8025346034d28ff1f58cebab0 Mon Sep 17 00:00:00 2001
From: Luke Dashjr <luke-jr+git@utopios.org>
Date: Wed, 1 Jun 2016 16:47:36 +0000
Subject: [PATCH] getblocktemplate: Explicitly handle the distinction between
 GBT-affecting softforks vs not

---
 src/rpc/mining.cpp  | 32 ++++++++++++++++++++++++++++++--
 src/versionbits.cpp |  2 ++
 src/versionbits.h   |  2 ++
 3 files changed, 34 insertions(+), 2 deletions(-)

diff --git a/src/rpc/mining.cpp b/src/rpc/mining.cpp
index 277696fe0b5..9558b4c20ef 100644
--- a/src/rpc/mining.cpp
+++ b/src/rpc/mining.cpp
@@ -264,7 +264,9 @@ static UniValue BIP22ValidationResult(const CValidationState& state)
 std::string gbt_vb_name(const Consensus::DeploymentPos pos) {
     const struct BIP9DeploymentInfo& vbinfo = VersionBitsDeploymentInfo[pos];
     std::string s = vbinfo.name;
-    s.insert(s.begin(), '!');
+    if (!vbinfo.gbt_force) {
+        s.insert(s.begin(), '!');
+    }
     return s;
 }
 
@@ -342,6 +344,7 @@ UniValue getblocktemplate(const UniValue& params, bool fHelp)
 
     std::string strMode = "template";
     UniValue lpval = NullUniValue;
+    std::set<std::string> setClientRules;
     if (params.size() > 0)
     {
         const UniValue& oparam = params[0].get_obj();
@@ -385,6 +388,14 @@ UniValue getblocktemplate(const UniValue& params, bool fHelp)
             TestBlockValidity(state, Params(), block, pindexPrev, false, true);
             return BIP22ValidationResult(state);
         }
+
+        const UniValue& aClientRules = find_value(oparam, "rules");
+        if (aClientRules.isArray()) {
+            for (unsigned int i = 0; i < aClientRules.size(); ++i) {
+                const UniValue& v = aClientRules[i];
+                setClientRules.insert(v.get_str());
+            }
+        }
     }
 
     if (strMode != "template")
@@ -544,13 +555,30 @@ UniValue getblocktemplate(const UniValue& params, bool fHelp)
                 pblock->nVersion |= VersionBitsMask(consensusParams, pos);
                 // FALL THROUGH to get vbavailable set...
             case THRESHOLD_STARTED:
-                // Add to vbavailable (and it's presumably in version already)
+            {
+                const struct BIP9DeploymentInfo& vbinfo = VersionBitsDeploymentInfo[pos];
                 vbavailable.push_back(Pair(gbt_vb_name(pos), consensusParams.vDeployments[pos].bit));
+                if (setClientRules.find(vbinfo.name) == setClientRules.end()) {
+                    if (!vbinfo.gbt_force) {
+                        // If the client doesn't support this, don't indicate it in the [default] version
+                        pblock->nVersion &= ~VersionBitsMask(consensusParams, pos);
+                    }
+                }
                 break;
+            }
             case THRESHOLD_ACTIVE:
+            {
                 // Add to rules only
+                const struct BIP9DeploymentInfo& vbinfo = VersionBitsDeploymentInfo[pos];
                 aRules.push_back(gbt_vb_name(pos));
+                if (setClientRules.find(vbinfo.name) == setClientRules.end()) {
+                    // Not supported by the client; make sure it's safe to proceed
+                    if (!vbinfo.gbt_force) {
+                        throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Support for '%s' rule requires explicit client support", vbinfo.name));
+                    }
+                }
                 break;
+            }
         }
     }
     result.push_back(Pair("version", pblock->nVersion));
diff --git a/src/versionbits.cpp b/src/versionbits.cpp
index 041ca2adbca..c06c9907be9 100644
--- a/src/versionbits.cpp
+++ b/src/versionbits.cpp
@@ -9,9 +9,11 @@
 const struct BIP9DeploymentInfo VersionBitsDeploymentInfo[Consensus::MAX_VERSION_BITS_DEPLOYMENTS] = {
     {
         /*.name =*/ "testdummy",
+        /*.gbt_force =*/ true,
     },
     {
         /*.name =*/ "csv",
+        /*.gbt_force =*/ true,
     }
 };
 
diff --git a/src/versionbits.h b/src/versionbits.h
index d8059420288..ede2dcdda8a 100644
--- a/src/versionbits.h
+++ b/src/versionbits.h
@@ -33,6 +33,8 @@ typedef std::map<const CBlockIndex*, ThresholdState> ThresholdConditionCache;
 struct BIP9DeploymentInfo {
     /** Deployment name */
     const char *name;
+    /** Whether GBT clients can safely ignore this rule in simplified usage */
+    bool gbt_force;
 };
 
 extern const struct BIP9DeploymentInfo VersionBitsDeploymentInfo[];