Key pool: Move LearnRelated and GetDestination calls

achow101 · achow101 · commit ba41aa496916 · 2019-12-02T11:57:20.000-05:00
Addresses are determined by LegacyScriptPubKeyMan::GetReservedDestination
instead of ReserveDestination::GetReservedDestination as other ScriptPubKeyMan
implementations may construct addresses differently

This does not change behavior.
diff --git a/src/wallet/scriptpubkeyman.cpp b/src/wallet/scriptpubkeyman.cpp
@@ -262,7 +262,7 @@ bool LegacyScriptPubKeyMan::EncryptKeys(CKeyingMaterial& vMasterKeyIn)
     return true;
 }
 
-bool LegacyScriptPubKeyMan::GetReservedDestination(const OutputType type, bool internal, int64_t& index, CKeyPool& keypool)
+bool LegacyScriptPubKeyMan::GetReservedDestination(const OutputType type, bool internal, CTxDestination& address, int64_t& index, CKeyPool& keypool)
 {
     if (!CanGetAddresses(internal)) {
         return false;
@@ -271,6 +271,7 @@ bool LegacyScriptPubKeyMan::GetReservedDestination(const OutputType type, bool i
     if (!ReserveKeyFromKeyPool(index, keypool, internal)) {
         return false;
     }
+    address = GetDestinationForKey(keypool.vchPubKey, type);
     return true;
 }
 
@@ -1091,6 +1092,7 @@ void LegacyScriptPubKeyMan::KeepDestination(int64_t nIndex, const OutputType& ty
     // Remove from key pool
     WalletBatch batch(m_storage.GetDatabase());
     batch.ErasePool(nIndex);
+    LearnRelatedScripts(pubkey, type);
     WalletLogPrintf("keypool keep %d\n", nIndex);
 }
 
diff --git a/src/wallet/scriptpubkeyman.h b/src/wallet/scriptpubkeyman.h
@@ -150,7 +150,7 @@ class ScriptPubKeyMan
     virtual bool GetNewDestination(const OutputType type, CTxDestination& dest, std::string& error) { return false; }
     virtual isminetype IsMine(const CScript& script) const { return ISMINE_NO; }
 
-    virtual bool GetReservedDestination(const OutputType type, bool internal, int64_t& index, CKeyPool& keypool) { return false; }
+    virtual bool GetReservedDestination(const OutputType type, bool internal, CTxDestination& address, int64_t& index, CKeyPool& keypool) { return false; }
     virtual void KeepDestination(int64_t index, const OutputType& type, const CPubKey& pubkey) {}
     virtual void ReturnDestination(int64_t index, bool internal, const CPubKey& pubkey) {}
 
@@ -273,7 +273,7 @@ class LegacyScriptPubKeyMan : public ScriptPubKeyMan, public FillableSigningProv
     //! will encrypt previously unencrypted keys
     bool EncryptKeys(CKeyingMaterial& vMasterKeyIn);
 
-    bool GetReservedDestination(const OutputType type, bool internal, int64_t& index, CKeyPool& keypool) override;
+    bool GetReservedDestination(const OutputType type, bool internal, CTxDestination& address, int64_t& index, CKeyPool& keypool) override;
     void KeepDestination(int64_t index, const OutputType& type, const CPubKey& pubkey) override;
     void ReturnDestination(int64_t index, bool internal, const CPubKey& pubkey) override;
 
diff --git a/src/wallet/wallet.cpp b/src/wallet/wallet.cpp
@@ -3302,14 +3302,13 @@ bool ReserveDestination::GetReservedDestination(CTxDestination& dest, bool inter
     if (nIndex == -1)
     {
         CKeyPool keypool;
-        if (!m_spk_man->GetReservedDestination(type, internal, nIndex, keypool)) {
+        if (!m_spk_man->GetReservedDestination(type, internal, address, nIndex, keypool)) {
             return false;
         }
         vchPubKey = keypool.vchPubKey;
         fInternal = keypool.fInternal;
     }
     assert(vchPubKey.IsValid());
-    address = GetDestinationForKey(vchPubKey, type);
     dest = address;
     return true;
 }
@@ -3318,7 +3317,6 @@ void ReserveDestination::KeepDestination()
 {
     if (nIndex != -1) {
         m_spk_man->KeepDestination(nIndex, type, vchPubKey);
-        m_spk_man->LearnRelatedScripts(vchPubKey, type);
     }
     nIndex = -1;
     vchPubKey = CPubKey();
diff --git a/src/wallet/wallet.h b/src/wallet/wallet.h
@@ -141,7 +141,8 @@ class ReserveDestination
 protected:
     //! The wallet to reserve from
     CWallet* const pwallet;
-    LegacyScriptPubKeyMan* m_spk_man{nullptr};
+    //! The ScriptPubKeyMan to reserve from. Based on type when GetReservedDestination is called
+    ScriptPubKeyMan* m_spk_man{nullptr};
     OutputType const type;
     //! The index of the address's key in the keypool
     int64_t nIndex{-1};

Original file line number	Diff line number	Diff line change
`@@ -262,7 +262,7 @@ bool LegacyScriptPubKeyMan::EncryptKeys(CKeyingMaterial& vMasterKeyIn)`
`262`	`262`	`return true;`
`263`	`263`	`}`
`264`	`264`
`265`		`-bool LegacyScriptPubKeyMan::GetReservedDestination(const OutputType type, bool internal, int64_t& index, CKeyPool& keypool)`
	`265`	`+bool LegacyScriptPubKeyMan::GetReservedDestination(const OutputType type, bool internal, CTxDestination& address, int64_t& index, CKeyPool& keypool)`
`266`	`266`	`{`
`267`	`267`	`if (!CanGetAddresses(internal)) {`
`268`	`268`	`return false;`
`@@ -271,6 +271,7 @@ bool LegacyScriptPubKeyMan::GetReservedDestination(const OutputType type, bool i`
`271`	`271`	`if (!ReserveKeyFromKeyPool(index, keypool, internal)) {`
`272`	`272`	`return false;`
`273`	`273`	`}`
	`274`	`+ address = GetDestinationForKey(keypool.vchPubKey, type);`
`274`	`275`	`return true;`
`275`	`276`	`}`
`276`	`277`
`@@ -1091,6 +1092,7 @@ void LegacyScriptPubKeyMan::KeepDestination(int64_t nIndex, const OutputType& ty`
`1091`	`1092`	`// Remove from key pool`
`1092`	`1093`	`WalletBatch batch(m_storage.GetDatabase());`
`1093`	`1094`	`batch.ErasePool(nIndex);`
	`1095`	`+ LearnRelatedScripts(pubkey, type);`
`1094`	`1096`	`WalletLogPrintf("keypool keep %d\n", nIndex);`
`1095`	`1097`	`}`
`1096`	`1098`
Original file line number	Diff line number	Diff line change
`@@ -3302,14 +3302,13 @@ bool ReserveDestination::GetReservedDestination(CTxDestination& dest, bool inter`
`3302`	`3302`	`if (nIndex == -1)`
`3303`	`3303`	`{`
`3304`	`3304`	`CKeyPool keypool;`
`3305`		`- if (!m_spk_man->GetReservedDestination(type, internal, nIndex, keypool)) {`
	`3305`	`+ if (!m_spk_man->GetReservedDestination(type, internal, address, nIndex, keypool)) {`
`3306`	`3306`	`return false;`
`3307`	`3307`	`}`
`3308`	`3308`	`vchPubKey = keypool.vchPubKey;`
`3309`	`3309`	`fInternal = keypool.fInternal;`
`3310`	`3310`	`}`
`3311`	`3311`	`assert(vchPubKey.IsValid());`
`3312`		`- address = GetDestinationForKey(vchPubKey, type);`
`3313`	`3312`	`dest = address;`
`3314`	`3313`	`return true;`
`3315`	`3314`	`}`
`@@ -3318,7 +3317,6 @@ void ReserveDestination::KeepDestination()`
`3318`	`3317`	`{`
`3319`	`3318`	`if (nIndex != -1) {`
`3320`	`3319`	`m_spk_man->KeepDestination(nIndex, type, vchPubKey);`
`3321`		`- m_spk_man->LearnRelatedScripts(vchPubKey, type);`
`3322`	`3320`	`}`
`3323`	`3321`	`nIndex = -1;`
`3324`	`3322`	`vchPubKey = CPubKey();`