util: simplify the interface of serviceFlagToStr()

vasild · vasild · commit fbacad188034 · 2020-05-29T18:49:26.000+02:00
Don't take two redundant arguments in `serviceFlagToStr()`. As a side effect this fixes an issue introduced in bitcoin#18165 due to which the GUI could print something like `UNKNOWN[1033] & UNKNOWN[1033] & UNKNOWN[2^10]` instead of `NETWORK & WITNESS`.
diff --git a/src/protocol.cpp b/src/protocol.cpp
@@ -195,9 +195,10 @@ const std::vector<std::string> &getAllNetMessageTypes()
     return allNetMessageTypesVec;
 }
 
-std::string serviceFlagToStr(const uint64_t mask, const int bit)
+std::string serviceFlagToStr(size_t bit)
 {
-    switch (ServiceFlags(mask)) {
+    const uint64_t service_flag = 1ULL << bit;
+    switch ((ServiceFlags)service_flag) {
     case NODE_NONE: abort();  // impossible
     case NODE_NETWORK:         return "NETWORK";
     case NODE_GETUTXO:         return "GETUTXO";
@@ -211,7 +212,7 @@ std::string serviceFlagToStr(const uint64_t mask, const int bit)
     stream.imbue(std::locale::classic());
     stream << "UNKNOWN[";
     if (bit < 8) {
-        stream << mask;
+        stream << service_flag;
     } else {
         stream << "2^" << bit;
     }
diff --git a/src/protocol.h b/src/protocol.h
@@ -288,7 +288,12 @@ enum ServiceFlags : uint64_t {
     // BIP process.
 };
 
-std::string serviceFlagToStr(uint64_t mask, int bit);
+/**
+ * Convert a service flag (NODE_*) to a human readable string.
+ * It supports unknown service flags which will be returned as "UNKNOWN[...]".
+ * @param[in] bit the service flag is calculated as (1 << bit)
+ */
+std::string serviceFlagToStr(size_t bit);
 
 /**
  * Gets the set of service flags which are "desirable" for a given peer.
diff --git a/src/qt/guiutil.cpp b/src/qt/guiutil.cpp
@@ -759,7 +759,7 @@ QString formatServicesStr(quint64 mask)
         uint64_t check = 1ull << i;
         if (mask & check)
         {
-            strList.append(QString::fromStdString(serviceFlagToStr(mask, i)));
+            strList.append(QString::fromStdString(serviceFlagToStr(i)));
         }
     }
 
diff --git a/src/rpc/util.cpp b/src/rpc/util.cpp
@@ -847,7 +847,7 @@ UniValue GetServicesNames(ServiceFlags services)
     for (int i = 0; i < 64; ++i) {
         const uint64_t mask = 1ull << i;
         if (services_n & mask) {
-            servicesNames.push_back(serviceFlagToStr(mask, i));
+            servicesNames.push_back(serviceFlagToStr(i));
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -759,7 +759,7 @@ QString formatServicesStr(quint64 mask)`
`759`	`759`	`uint64_t check = 1ull << i;`
`760`	`760`	`if (mask & check)`
`761`	`761`	`{`
`762`		`- strList.append(QString::fromStdString(serviceFlagToStr(mask, i)));`
	`762`	`+ strList.append(QString::fromStdString(serviceFlagToStr(i)));`
`763`	`763`	`}`
`764`	`764`	`}`
`765`	`765`
Original file line number	Diff line number	Diff line change
`@@ -847,7 +847,7 @@ UniValue GetServicesNames(ServiceFlags services)`
`847`	`847`	`for (int i = 0; i < 64; ++i) {`
`848`	`848`	`const uint64_t mask = 1ull << i;`
`849`	`849`	`if (services_n & mask) {`
`850`		`- servicesNames.push_back(serviceFlagToStr(mask, i));`
	`850`	`+ servicesNames.push_back(serviceFlagToStr(i));`
`851`	`851`	`}`
`852`	`852`	`}`
`853`	`853`