Merge pull request #5764 from nuttycom/test/rollback_double_spend

Add an RPC test for Sapling and Orchard double-spends & fix revealed bugs.
This commit is contained in:
Kris Nuttycombe 2022-03-28 21:25:18 -06:00 committed by GitHub
commit a63a4601ea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 184 additions and 13 deletions

View File

@ -71,6 +71,7 @@ BASE_SCRIPTS= [
'wallet_addresses.py',
'wallet_anchorfork.py',
'wallet_changeindicator.py',
'wallet_doublespend.py',
'wallet_import_export.py',
'wallet_isfromme.py',
'wallet_orchard.py',

View File

@ -0,0 +1,162 @@
#!/usr/bin/env python3
# Copyright (c) 2022 The Zcash developers
# Distributed under the MIT software license, see the accompanying
# file COPYING or https://www.opensource.org/licenses/mit-license.php .
import shutil
import os.path
from test_framework.test_framework import BitcoinTestFramework
from test_framework.util import (
NU5_BRANCH_ID,
assert_equal,
get_coinbase_address,
nuparams,
start_nodes,
stop_nodes,
wait_bitcoinds,
wait_and_assert_operationid_status,
)
# Test wallet behaviour with the Orchard protocol
class WalletDoubleSpendTest(BitcoinTestFramework):
def __init__(self):
super().__init__()
self.num_nodes = 4
def setup_nodes(self):
return start_nodes(self.num_nodes, self.options.tmpdir, [[
nuparams(NU5_BRANCH_ID, 201),
]] * self.num_nodes)
def run_test_for_recipient_type(self, recipient_type):
# Get a couple of new accounts
acct0a = self.nodes[0].z_getnewaccount()['account']
ua0a = self.nodes[0].z_getaddressforaccount(acct0a, [recipient_type])['address']
acct0b = self.nodes[0].z_getnewaccount()['account']
ua0b = self.nodes[0].z_getaddressforaccount(acct0b, [recipient_type])['address']
# Get a new UA for account 1
acct1 = self.nodes[1].z_getnewaccount()['account']
addrRes1 = self.nodes[1].z_getaddressforaccount(acct1, [recipient_type])
ua1 = addrRes1['address']
# Create a note matching recipient_type on node 1
recipients = [{"address": ua1, "amount": 10}]
myopid = self.nodes[0].z_sendmany(get_coinbase_address(self.nodes[0]), recipients, 1, 0, 'AllowRevealedSenders')
wait_and_assert_operationid_status(self.nodes[0], myopid)
self.sync_all()
self.nodes[0].generate(1)
self.sync_all()
# Check the value sent to ua1 was received
assert_equal(
{'pools': {recipient_type: {'valueZat': 1000000000}}, 'minimum_confirmations': 1},
self.nodes[1].z_getbalanceforaccount(acct1))
# Shut down the nodes
stop_nodes(self.nodes)
wait_bitcoinds()
# Copy node 1's wallet to node 2
tmpdir = self.options.tmpdir
shutil.copyfile(
os.path.join(tmpdir, "node1", "regtest", "wallet.dat"),
os.path.join(tmpdir, "node2", "regtest", "wallet.dat"))
# Restart with the network split
self.setup_network(True)
# Verify the balance on node 1
assert_equal(
{'pools': {recipient_type: {'valueZat': 1000000000}}, 'minimum_confirmations': 1},
self.nodes[1].z_getbalanceforaccount(acct1))
# Verify the balance on node 2, on the other side of the split
assert_equal(
{'pools': {recipient_type: {'valueZat': 1000000000}}, 'minimum_confirmations': 1},
self.nodes[2].z_getbalanceforaccount(acct1))
# Spend the note from node 1
recipients = [{"address": ua0a, "amount": 1}]
myopid = self.nodes[1].z_sendmany(ua1, recipients, 1, 0)
txa_id = wait_and_assert_operationid_status(self.nodes[1], myopid)
# Spend the note from node 2
recipients = [{"address": ua0b, "amount": 2}]
myopid = self.nodes[2].z_sendmany(ua1, recipients, 1, 0)
txb_id = wait_and_assert_operationid_status(self.nodes[2], myopid)
# Mine the conflicting notes in the split
self.sync_all()
self.nodes[0].generate(2)
self.nodes[3].generate(10)
self.sync_all()
# the remaining balance is visible on both sides of the split
assert_equal(
{'pools': {recipient_type: {'valueZat': 900000000}}, 'minimum_confirmations': 1},
self.nodes[1].z_getbalanceforaccount(acct1))
assert_equal(
{'pools': {recipient_type: {'valueZat': 800000000}}, 'minimum_confirmations': 1},
self.nodes[2].z_getbalanceforaccount(acct1))
# before re-joining the network, there is no recognition of the conflict
txa = self.nodes[1].gettransaction(txa_id)
txb = self.nodes[2].gettransaction(txb_id)
assert_equal(2, txa['confirmations']);
assert_equal(10, txb['confirmations']);
assert_equal([], txa['walletconflicts']);
assert_equal([], txb['walletconflicts']);
# acct0a will have received the transaction; it can't see node 2's send
assert_equal(
{'pools': {recipient_type: {'valueZat': 100000000}}, 'minimum_confirmations': 1},
self.nodes[0].z_getbalanceforaccount(acct0a))
self.join_network()
# after the network is re-joined, both transactions should be viewed as conflicted
txa = self.nodes[1].gettransaction(txa_id)
txb = self.nodes[1].gettransaction(txb_id)
assert_equal(-1, txa['confirmations']);
assert_equal(10, txb['confirmations']);
assert_equal([txb_id], txa['walletconflicts']);
assert_equal([txa_id], txb['walletconflicts']);
# After the reorg, node 2 wins, so its balance is the consensus for
# both wallets
assert_equal(
{'pools': {recipient_type: {'valueZat': 800000000}}, 'minimum_confirmations': 1},
self.nodes[1].z_getbalanceforaccount(acct1))
assert_equal(
{'pools': {recipient_type: {'valueZat': 800000000}}, 'minimum_confirmations': 1},
self.nodes[2].z_getbalanceforaccount(acct1))
# acct0b will have received the transaction
assert_equal(
{'pools': {recipient_type: {'valueZat': 200000000}}, 'minimum_confirmations': 1},
self.nodes[0].z_getbalanceforaccount(acct0b))
# acct0a's note was un-mined
assert_equal(
{'pools': {}, 'minimum_confirmations': 1},
self.nodes[0].z_getbalanceforaccount(acct0a))
def run_test(self):
# Sanity-check the test harness
assert_equal(self.nodes[0].getblockcount(), 200)
# Activate NU5
self.nodes[0].generate(1)
self.sync_all()
self.run_test_for_recipient_type('sapling')
self.run_test_for_recipient_type('orchard')
if __name__ == '__main__':
WalletDoubleSpendTest().main()

View File

@ -1100,13 +1100,7 @@ bool CWallet::LoadCaches()
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 (orchardFvk.has_value() && orchardReceiver.has_value()) {
if (!AddOrchardRawAddress(orchardFvk.value().ToIncomingViewingKey(), orchardReceiver.value())) {
LogPrintf("%s: Error: Unable to add Orchard address -> IVK mapping.\n",
__func__);
@ -2370,8 +2364,14 @@ SpendableInputs CWallet::FindSpendableInputs(
}
auto mit = mapWallet.find(noteMeta.GetOutPoint().hash);
auto confirmations = mit->second.GetDepthInMainChain();
if (mit != mapWallet.end() && confirmations >= minDepth) {
// We should never get an outpoint from the Orchard wallet where
// the transaction does not exist in the main wallet.
assert(mit != mapWallet.end());
int confirmations = mit->second.GetDepthInMainChain();
if (confirmations < 0) continue;
if (confirmations >= minDepth) {
noteMeta.SetConfirmations(confirmations);
unspent.orchardNoteMetadata.push_back(noteMeta);
}

View File

@ -936,7 +936,7 @@ DBErrors CWalletDB::LoadWallet(CWallet* pwallet)
Dbc* pcursor = GetCursor();
if (!pcursor)
{
LogPrintf("Error getting wallet database cursor\n");
LogPrintf("LoadWallet: Error getting wallet database cursor.");
return DB_CORRUPT;
}
@ -950,7 +950,7 @@ DBErrors CWalletDB::LoadWallet(CWallet* pwallet)
break;
else if (ret != 0)
{
LogPrintf("Error reading next record from wallet database\n");
LogPrintf("LoadWallet: Error reading next record from wallet database.");
return DB_CORRUPT;
}
@ -963,6 +963,7 @@ DBErrors CWalletDB::LoadWallet(CWallet* pwallet)
result = DB_WRONG_NETWORK;
} else if (result != DB_WRONG_NETWORK && IsKeyType(strType)) {
// losing keys is considered a catastrophic error
LogPrintf("LoadWallet: Unable to read key/value for key type %s (%d)", strType, result);
result = DB_CORRUPT;
} else {
// Leave other errors alone, if we try to fix them we might make things worse.
@ -974,7 +975,7 @@ DBErrors CWalletDB::LoadWallet(CWallet* pwallet)
}
}
if (!strErr.empty())
LogPrintf("%s\n", strErr);
LogPrintf("LoadWallet: %s", strErr);
}
pcursor->close();
@ -983,15 +984,22 @@ DBErrors CWalletDB::LoadWallet(CWallet* pwallet)
// 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.
LogPrintf("LoadWallet: Failed to restore cached wallet data from chain state.");
result = DB_CORRUPT;
}
}
catch (const boost::thread_interrupted&) {
throw;
}
catch (...) {
catch (const std::exception& e) {
LogPrintf("LoadWallet: Caught exception: %s", e.what());
result = DB_CORRUPT;
}
catch (...) {
LogPrintf("LoadWallet: Caught something that wasn't a std::exception.");
result = DB_CORRUPT;
}
if (fNoncriticalErrors && result == DB_LOAD_OK)
result = DB_NONCRITICAL_ERROR;