zecfoundation
/
zcashd
mirror of https://github.com/ZcashFoundation/zcashd.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #5612 from ebfull/feature/persist_orchard_keys 

Recover orchard keys and mappings during wallet load
This commit is contained in:
Kris Nuttycombe 2022-03-03 07:47:16 -07:00 committed by GitHub
parent 68d6c3ddc3 bd137561f2
commit 65b5b7509c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 121 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

153
src/wallet/wallet.cpp
View File

@ -822,51 +822,11 @@ WalletUAGenerationResult CWallet::GenerateUnifiedAddress(
}
}
// NOTE: There is an important relationship between `LoadUnifiedFullViewingKey`
// and `LoadUnifiedAddressMetadata`. In all cases, by the end of the
// wallet-loading process, `mapUfvkAddressMetadata` needs to be fully populated
// for each unified full viewing key. However, we cannot guarantee in what
// order UFVKs and unified address and account metadata are loaded from disk.
// Therefore:
// * When we load a unified full viewing key from disk, we repopulate
// the cache of generated addresses by regenerating the address for each
// (diversifierIndex, {receiverType...}) pair in `mapUfvkAddressMetadata`
// that we have loaded so far.
// * When we load a unified address metadata record from disk:
// - if we have not yet loaded the unified full viewing key, simply add
// an entry `mapUfvkAddressMetadata` so that we can restore the address
// once the UFVK has been loaded.
// - if we have already loaded the unified full viewing key from disk,
// regenerate the address from its metadata and add it to the keystore
//
// While this is somewhat complicated, it has the benefit of making each
// piece of unified full viewing key and address metadata write-once in
// the wallet database; we never need to update ufvk or address metadata
// once written.
bool CWallet::LoadUnifiedFullViewingKey(const libzcash::UnifiedFullViewingKey &key)
{
auto zufvk = ZcashdUnifiedFullViewingKey::FromUnifiedFullViewingKey(Params(), key);
auto metadata = mapUfvkAddressMetadata.find(zufvk.GetKeyID());
if (metadata != mapUfvkAddressMetadata.end()) {
// restore unified addresses that have been previously generated to the
// keystore
for (const auto &[j, receiverTypes] : metadata->second.GetKnownReceiverSetsByDiversifierIndex()) {
bool restored = std::visit(match {
[&](const UnifiedAddressGenerationError& err) {
return false;
},
[&](const std::pair<UnifiedAddress, diversifier_index_t>& addr) {
return CCryptoKeyStore::AddTransparentReceiverForUnifiedAddress(
zufvk.GetKeyID(), addr.second, addr.first);
}
}, zufvk.Address(j, receiverTypes));
// failure to restore the generated address is an error
if (!restored) return false;
}
}
return CCryptoKeyStore::AddUnifiedFullViewingKey(zufvk);
return CCryptoKeyStore::AddUnifiedFullViewingKey(
ZcashdUnifiedFullViewingKey::FromUnifiedFullViewingKey(Params(), key)
);
}
bool CWallet::LoadUnifiedAccountMetadata(const ZcashdUnifiedAccountMetadata &skmeta)
@ -880,23 +840,106 @@ bool CWallet::LoadUnifiedAccountMetadata(const ZcashdUnifiedAccountMetadata &skm
bool CWallet::LoadUnifiedAddressMetadata(const ZcashdUnifiedAddressMetadata &addrmeta)
{
AssertLockHeld(cs_wallet);
if (!mapUfvkAddressMetadata[addrmeta.GetKeyID()].SetReceivers(
return mapUfvkAddressMetadata[addrmeta.GetKeyID()].SetReceivers(
addrmeta.GetDiversifierIndex(),
addrmeta.GetReceiverTypes())) {
return false;
}
addrmeta.GetReceiverTypes());
}
auto ufvk = GetUnifiedFullViewingKey(addrmeta.GetKeyID());
if (ufvk.has_value()) {
// Regenerate the unified address and add it to the keystore.
auto j = addrmeta.GetDiversifierIndex();
auto addr = ufvk.value().Address(j, addrmeta.GetReceiverTypes());
auto addrPtr = std::get_if<std::pair<UnifiedAddress, diversifier_index_t>>(&addr);
bool CWallet::LoadUnifiedCaches()
{
AssertLockHeld(cs_wallet);
if (addrPtr == nullptr) {
auto seed = GetMnemonicSeed();
for (auto account = mapUnifiedAccountKeys.begin(); account != mapUnifiedAccountKeys.end(); ++account) {
auto ufvkId = account->second;
auto ufvk = GetUnifiedFullViewingKey(ufvkId);
if (!seed.has_value()) {
LogPrintf("%s: Error: Mnemonic seed was not loaded despite an account existing in the wallet.\n",
__func__);
return false;
}
if (ufvk.has_value()) {
auto metadata = mapUfvkAddressMetadata.find(ufvkId);
if (metadata != mapUfvkAddressMetadata.end()) {
auto accountId = metadata->second.GetAccountId();
if (!accountId.has_value()) {
LogPrintf("%s: Error: Address records exist for an account that was not loaded in the wallet.\n",
__func__);
return false;
}
auto usk = ZcashdUnifiedSpendingKey::ForAccount(seed.value(), BIP44CoinType(), accountId.value());
if (!usk.has_value()) {
LogPrintf("%s: Error: Unable to generate a unified spending key for an account.\n",
__func__);
return false;
}
// add Orchard spending key to the orchard wallet
{
auto orchardSk = usk.value().GetOrchardKey();
orchardWallet.AddSpendingKey(orchardSk);
// Associate the Orchard default change address with its IVK
auto orchardInternalIvk = orchardSk.ToFullViewingKey().ToInternalIncomingViewingKey();
if (!AddOrchardRawAddress(orchardInternalIvk, orchardInternalIvk.Address(0))) {
LogPrintf("%s: Error: Unable to generate a default internal address.\n",
__func__);
return false;
}
}
// restore unified addresses that have been previously generated to the
// keystore
for (const auto &[j, receiverTypes] : metadata->second.GetKnownReceiverSetsByDiversifierIndex()) {
bool restored = std::visit(match {
[&](const UnifiedAddressGenerationError& err) {
LogPrintf("%s: Error: Unable to generate a unified address.\n",
__func__);
return false;
},
[&](const std::pair<UnifiedAddress, diversifier_index_t>& addr) {
// Associate the orchard address with our IVK, if there's
// an orchard receiver present in this address.
auto orchardFvk = ufvk.value().GetOrchardKey();
auto orchardReceiver = addr.first.GetOrchardReceiver();
if (orchardFvk.has_value() != orchardReceiver.has_value()) {
LogPrintf("%s: Error: Orchard receiver in unified address is inconsistent with the unified viewing key.\n",
__func__);
return false;
}
if (orchardFvk.has_value()) {
if (!AddOrchardRawAddress(orchardFvk.value().ToIncomingViewingKey(), orchardReceiver.value())) {
LogPrintf("%s: Error: Unable to add Orchard address -> IVK mapping.\n",
__func__);
return false;
}
}
return CCryptoKeyStore::AddTransparentReceiverForUnifiedAddress(
ufvkId, addr.second, addr.first);
}
}, ufvk.value().Address(j, receiverTypes));
// failure to restore the generated address is an error
if (!restored) return false;
}
} else {
// Loaded an account, but didn't initialize
// `mapUfvkAddressMetadata` for the corresponding viewing key.
LogPrintf("%s: Error: UFVK address map not initialized despite an account existing.\n",
__func__);
return false;
}
} else {
return CCryptoKeyStore::AddTransparentReceiverForUnifiedAddress(addrmeta.GetKeyID(), j, addrPtr->first);
LogPrintf("%s: Error: Unified viewing key missing for an account.\n",
__func__);
return false;
}
}

8
src/wallet/wallet.h
View File

@ -1534,6 +1534,14 @@ public:
bool LoadUnifiedAccountMetadata(const ZcashdUnifiedAccountMetadata &skmeta);
bool LoadUnifiedAddressMetadata(const ZcashdUnifiedAddressMetadata &addrmeta);
//! Reconstructs (in memory) caches and mappings for unified accounts,
//! addresses and keying material. This should be called once, after the
//! remainder of the on-disk wallet data has been loaded.
//!
//! Returns true if and only if there were no detected inconsistencies or
//! failures in reconstructing the cache.
bool LoadUnifiedCaches();
std::optional<libzcash::UFVKId> FindUnifiedFullViewingKey(const libzcash::UnifiedAddress& addr) const;
std::optional<libzcash::AccountId> GetUnifiedAccountId(const libzcash::UFVKId& ufvkId) const;

15
src/wallet/walletdb.cpp
View File

@ -963,6 +963,14 @@ DBErrors CWalletDB::LoadWallet(CWallet* pwallet)
}
pcursor->close();
// Load unified address/account/key caches based on what was loaded
if (!pwallet->LoadUnifiedCaches()) {
// We can be more permissive of certain kinds of failures during
// loading; for now we'll interpret failure to reconstruct the
// caches to be "as bad" as losing keys.
result = DB_CORRUPT;
}
// Run the Orchard batch validator; if it fails, treat it like a bad transaction record.
if (!wss.orchardAuth.Validate()) {
fNoncriticalErrors = true;
@ -1283,6 +1291,13 @@ bool CWalletDB::Recover(CDBEnv& dbenv, const std::string& filename, bool fOnlyKe
ptxn->commit(0);
pdbCopy->close(0);
// Try to load the unified caches, uncovering inconsistencies in wallet
// records like missing viewing key records despite existing account
// records.
if (!dummyWallet.LoadUnifiedCaches()) {
LogPrintf("WARNING: unified caches could not be reconstructed; salvaged wallet file may have omissions");
}
return fSuccess;
}