partial Merge bitcoin#27920: wallet: bugfix, always use apostrophe for spkm descriptor ID

furszy · knst · commit 05e596619902 · 2024-08-29T17:23:40.000+07:00
BACKPORT NOTICE It includes only this commit: 97a965d refactor: extract descriptor ID calculation from spkm GetID() This allows us to verify the descriptor ID on the descriptors unit tests in different software versions without requiring to use the entire DescriptorScriptPubKeyMan machinery. Note: The unit test changes are introduced after the bugfix commit but this commit + the unit test commit can be cherry-picked on top of the v25 branch to verify IDs correctness. IDs must be the same for v25 and after the bugfix commit.
diff --git a/src/script/descriptor.cpp b/src/script/descriptor.cpp
@@ -1162,6 +1162,14 @@ std::unique_ptr<Descriptor> InferDescriptor(const CScript& script, const Signing
     return InferScript(script, ParseScriptContext::TOP, provider);
 }
 
+uint256 DescriptorID(const Descriptor& desc)
+{
+    std::string desc_str = desc.ToString();
+    uint256 id;
+    CSHA256().Write((unsigned char*)desc_str.data(), desc_str.size()).Finalize(id.begin());
+    return id;
+}
+
 void DescriptorCache::CacheParentExtPubKey(uint32_t key_exp_pos, const CExtPubKey& xpub)
 {
     m_parent_xpubs[key_exp_pos] = xpub;
diff --git a/src/script/descriptor.h b/src/script/descriptor.h
@@ -182,4 +182,9 @@ std::string GetDescriptorChecksum(const std::string& descriptor);
  */
 std::unique_ptr<Descriptor> InferDescriptor(const CScript& script, const SigningProvider& provider);
 
+/** Unique identifier that may not change over time, unless explicitly marked as not backwards compatible.
+*   This is not part of BIP 380, not guaranteed to be interoperable and should not be exposed to the user.
+*/
+uint256 DescriptorID(const Descriptor& desc);
+
 #endif // BITCOIN_SCRIPT_DESCRIPTOR_H
diff --git a/src/wallet/scriptpubkeyman.cpp b/src/wallet/scriptpubkeyman.cpp
@@ -2309,10 +2309,7 @@ std::unique_ptr<CKeyMetadata> DescriptorScriptPubKeyMan::GetMetadata(const CTxDe
 uint256 DescriptorScriptPubKeyMan::GetID() const
 {
     LOCK(cs_desc_man);
-    std::string desc_str = m_wallet_descriptor.descriptor->ToString();
-    uint256 id;
-    CSHA256().Write((unsigned char*)desc_str.data(), desc_str.size()).Finalize(id.begin());
-    return id;
+    return DescriptorID(*m_wallet_descriptor.descriptor);
 }
 
 void DescriptorScriptPubKeyMan::SetInternal(bool internal)

Original file line number	Diff line number	Diff line change
`@@ -1162,6 +1162,14 @@ std::unique_ptr<Descriptor> InferDescriptor(const CScript& script, const Signing`
`1162`	`1162`	`return InferScript(script, ParseScriptContext::TOP, provider);`
`1163`	`1163`	`}`
`1164`	`1164`
	`1165`	`+uint256 DescriptorID(const Descriptor& desc)`
	`1166`	`+{`
	`1167`	`+ std::string desc_str = desc.ToString();`
	`1168`	`+ uint256 id;`
	`1169`	`+ CSHA256().Write((unsigned char*)desc_str.data(), desc_str.size()).Finalize(id.begin());`
	`1170`	`+ return id;`
	`1171`	`+}`
	`1172`	`+`
`1165`	`1173`	`void DescriptorCache::CacheParentExtPubKey(uint32_t key_exp_pos, const CExtPubKey& xpub)`
`1166`	`1174`	`{`
`1167`	`1175`	`m_parent_xpubs[key_exp_pos] = xpub;`
Original file line number	Diff line number	Diff line change
`@@ -2309,10 +2309,7 @@ std::unique_ptr<CKeyMetadata> DescriptorScriptPubKeyMan::GetMetadata(const CTxDe`
`2309`	`2309`	`uint256 DescriptorScriptPubKeyMan::GetID() const`
`2310`	`2310`	`{`
`2311`	`2311`	`LOCK(cs_desc_man);`
`2312`		`- std::string desc_str = m_wallet_descriptor.descriptor->ToString();`
`2313`		`- uint256 id;`
`2314`		`- CSHA256().Write((unsigned char*)desc_str.data(), desc_str.size()).Finalize(id.begin());`
`2315`		`- return id;`
	`2312`	`+ return DescriptorID(*m_wallet_descriptor.descriptor);`
`2316`	`2313`	`}`
`2317`	`2314`
`2318`	`2315`	`void DescriptorScriptPubKeyMan::SetInternal(bool internal)`