diff --git a/src/wallet/test/coinselector_tests.cpp b/src/wallet/test/coinselector_tests.cpp index 984417728..395f1cca8 100644 --- a/src/wallet/test/coinselector_tests.cpp +++ b/src/wallet/test/coinselector_tests.cpp @@ -1,184 +1,606 @@ // Copyright (c) 2017 The Bitcoin Core developers // Distributed under the MIT software license, see the accompanying // file COPYING or http://www.opensource.org/licenses/mit-license.php. #include #include #include #include #include #include #include #include #include BOOST_FIXTURE_TEST_SUITE(coinselector_tests, WalletTestingSetup) +// how many times to run all the tests to have a chance to catch errors that +// only show up with particular random shuffles +#define RUN_TESTS 100 + +// some tests fail 1% of the time due to bad luck. +// we repeat those tests this many times and only complain if all iterations of +// the test fail +#define RANDOM_REPEATS 5 + +std::vector> wtxn; + typedef std::set CoinSet; static std::vector vCoins; +CoinEligibilityFilter filter_standard(1, 6, 0); +CoinEligibilityFilter filter_confirmed(1, 1, 0); +CoinEligibilityFilter filter_standard_extra(6, 6, 0); + static void add_coin(const Amount nValue, int nInput, std::vector &set) { CMutableTransaction tx; tx.vout.resize(nInput + 1); tx.vout[nInput].nValue = nValue; set.emplace_back(MakeTransactionRef(tx), nInput); } static void add_coin(const Amount nValue, int nInput, CoinSet &set) { CMutableTransaction tx; tx.vout.resize(nInput + 1); tx.vout[nInput].nValue = nValue; set.emplace(MakeTransactionRef(tx), nInput); } +static void add_coin(const CWallet &wallet, const Amount nValue, + int nAge = 6 * 24, bool fIsFromMe = false, + int nInput = 0) { + static int nextLockTime = 0; + CMutableTransaction tx; + // so all transactions get different hashes + tx.nLockTime = nextLockTime++; + tx.vout.resize(nInput + 1); + tx.vout[nInput].nValue = nValue; + if (fIsFromMe) { + // IsFromMe() returns (GetDebit() > 0), and GetDebit() is 0 if + // vin.empty(), so stop vin being empty, and cache a non-zero Debit to + // fake out IsFromMe() + tx.vin.resize(1); + } + std::unique_ptr wtx( + new CWalletTx(&wallet, MakeTransactionRef(std::move(tx)))); + if (fIsFromMe) { + wtx->fDebitCached = true; + wtx->nDebitCached = SATOSHI; + } + COutput output(wtx.get(), nInput, nAge, true /* spendable */, + true /* solvable */, true /* safe */); + vCoins.push_back(output); + wtxn.emplace_back(std::move(wtx)); +} + +static void empty_wallet(void) { + vCoins.clear(); + wtxn.clear(); +} + static bool equal_sets(CoinSet a, CoinSet b) { std::pair ret = mismatch(a.begin(), a.end(), b.begin()); return ret.first == a.end() && ret.second == b.end(); } static Amount make_hard_case(int utxos, std::vector &utxo_pool) { utxo_pool.clear(); Amount target = Amount::zero(); for (int i = 0; i < utxos; ++i) { const Amount base = (int64_t(1) << (utxos + i)) * SATOSHI; target += base; add_coin(base, 2 * i, utxo_pool); add_coin(base + (int64_t(1) << (utxos - 1 - i)) * SATOSHI, 2 * i + 1, utxo_pool); } return target; } // Branch and bound coin selection tests BOOST_AUTO_TEST_CASE(bnb_search_test) { LOCK(m_wallet.cs_wallet); // Setup std::vector utxo_pool; CoinSet selection; CoinSet actual_selection; Amount value_ret = Amount::zero(); Amount not_input_fees = Amount::zero(); ///////////////////////// // Known Outcome tests // ///////////////////////// BOOST_TEST_MESSAGE("Testing known outcomes"); // Empty utxo pool BOOST_CHECK(!SelectCoinsBnB(utxo_pool, 1 * CENT, CENT / 2, selection, value_ret, not_input_fees)); selection.clear(); // Add utxos add_coin(1 * CENT, 1, utxo_pool); add_coin(2 * CENT, 2, utxo_pool); add_coin(3 * CENT, 3, utxo_pool); add_coin(4 * CENT, 4, utxo_pool); // Select 1 Cent add_coin(1 * CENT, 1, actual_selection); BOOST_CHECK(SelectCoinsBnB(utxo_pool, 1 * CENT, CENT / 2, selection, value_ret, not_input_fees)); BOOST_CHECK(equal_sets(selection, actual_selection)); actual_selection.clear(); selection.clear(); // Select 2 Cent add_coin(2 * CENT, 2, actual_selection); BOOST_CHECK(SelectCoinsBnB(utxo_pool, 2 * CENT, CENT / 2, selection, value_ret, not_input_fees)); BOOST_CHECK(equal_sets(selection, actual_selection)); actual_selection.clear(); selection.clear(); // Select 5 Cent add_coin(3 * CENT, 3, actual_selection); add_coin(2 * CENT, 2, actual_selection); BOOST_CHECK(SelectCoinsBnB(utxo_pool, 5 * CENT, CENT / 2, selection, value_ret, not_input_fees)); BOOST_CHECK(equal_sets(selection, actual_selection)); actual_selection.clear(); selection.clear(); // Select 11 Cent, not possible BOOST_CHECK(!SelectCoinsBnB(utxo_pool, 11 * CENT, CENT / 2, selection, value_ret, not_input_fees)); actual_selection.clear(); selection.clear(); // Select 10 Cent add_coin(5 * CENT, 5, utxo_pool); add_coin(4 * CENT, 4, actual_selection); add_coin(3 * CENT, 3, actual_selection); add_coin(2 * CENT, 2, actual_selection); add_coin(1 * CENT, 1, actual_selection); BOOST_CHECK(SelectCoinsBnB(utxo_pool, 10 * CENT, CENT / 2, selection, value_ret, not_input_fees)); BOOST_CHECK(equal_sets(selection, actual_selection)); actual_selection.clear(); selection.clear(); // Negative effective value // Select 10 Cent but have 1 Cent not be possible because too small add_coin(5 * CENT, 5, actual_selection); add_coin(3 * CENT, 3, actual_selection); add_coin(2 * CENT, 2, actual_selection); BOOST_CHECK(SelectCoinsBnB(utxo_pool, 10 * CENT, 5000 * SATOSHI, selection, value_ret, not_input_fees)); // Select 0.25 Cent, not possible BOOST_CHECK(!SelectCoinsBnB(utxo_pool, CENT / 4, CENT / 2, selection, value_ret, not_input_fees)); actual_selection.clear(); selection.clear(); // Iteration exhaustion test Amount target = make_hard_case(17, utxo_pool); // Should exhaust BOOST_CHECK(!SelectCoinsBnB(utxo_pool, target, Amount::zero(), selection, value_ret, not_input_fees)); target = make_hard_case(14, utxo_pool); // Should not exhaust BOOST_CHECK(SelectCoinsBnB(utxo_pool, target, Amount::zero(), selection, value_ret, not_input_fees)); // Test same value early bailout optimization add_coin(7 * CENT, 7, actual_selection); add_coin(7 * CENT, 7, actual_selection); add_coin(7 * CENT, 7, actual_selection); add_coin(7 * CENT, 7, actual_selection); add_coin(2 * CENT, 7, actual_selection); add_coin(7 * CENT, 7, utxo_pool); add_coin(7 * CENT, 7, utxo_pool); add_coin(7 * CENT, 7, utxo_pool); add_coin(7 * CENT, 7, utxo_pool); add_coin(2 * CENT, 7, utxo_pool); for (int i = 0; i < 50000; ++i) { add_coin(5 * CENT, 7, utxo_pool); } BOOST_CHECK(SelectCoinsBnB(utxo_pool, 30 * CENT, 5000 * SATOSHI, selection, value_ret, not_input_fees)); //////////////////// // Behavior tests // //////////////////// // Select 1 Cent with pool of only greater than 5 Cent utxo_pool.clear(); for (int i = 5; i <= 20; ++i) { add_coin(i * CENT, i, utxo_pool); } // Run 100 times, to make sure it is never finding a solution for (int i = 0; i < 100; ++i) { BOOST_CHECK(!SelectCoinsBnB(utxo_pool, 1 * CENT, 2 * CENT, selection, value_ret, not_input_fees)); } } +BOOST_AUTO_TEST_CASE(knapsack_solver_test) { + CoinSet setCoinsRet, setCoinsRet2; + Amount nValueRet; + + LOCK(m_wallet.cs_wallet); + + // test multiple times to allow for differences in the shuffle order + for (int i = 0; i < RUN_TESTS; i++) { + empty_wallet(); + + // with an empty wallet we can't even pay one cent + BOOST_CHECK(!m_wallet.SelectCoinsMinConf( + 1 * CENT, filter_standard, vCoins, setCoinsRet, nValueRet)); + // add a new 1 cent coin + add_coin(m_wallet, 1 * CENT, 4); + + // with a new 1 cent coin, we still can't find a mature 1 cent + BOOST_CHECK(!m_wallet.SelectCoinsMinConf( + 1 * CENT, filter_standard, vCoins, setCoinsRet, nValueRet)); + + // but we can find a new 1 cent + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 1 * CENT, filter_confirmed, vCoins, setCoinsRet, nValueRet)); + BOOST_CHECK_EQUAL(nValueRet, 1 * CENT); + // add a mature 2 cent coin + add_coin(m_wallet, 2 * CENT); + + // we can't make 3 cents of mature coins + BOOST_CHECK(!m_wallet.SelectCoinsMinConf( + 3 * CENT, filter_standard, vCoins, setCoinsRet, nValueRet)); + + // we can make 3 cents of new coins + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 3 * CENT, filter_confirmed, vCoins, setCoinsRet, nValueRet)); + BOOST_CHECK_EQUAL(nValueRet, 3 * CENT); + + // add a mature 5 cent coin, + add_coin(m_wallet, 5 * CENT); + // a new 10 cent coin sent from one of our own addresses + add_coin(m_wallet, 10 * CENT, 3, true); + // and a mature 20 cent coin + add_coin(m_wallet, 20 * CENT); + + // now we have new: 1+10=11 (of which 10 was self-sent), and mature: + // 2+5+20=27. total = 38 + + // we can't make 38 cents only if we disallow new coins: + BOOST_CHECK(!m_wallet.SelectCoinsMinConf( + 38 * CENT, filter_standard, vCoins, setCoinsRet, nValueRet)); + // we can't even make 37 cents if we don't allow new coins even if + // they're from us + BOOST_CHECK(!m_wallet.SelectCoinsMinConf( + 38 * CENT, filter_standard_extra, vCoins, setCoinsRet, nValueRet)); + // but we can make 37 cents if we accept new coins from ourself + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 37 * CENT, filter_standard, vCoins, setCoinsRet, nValueRet)); + BOOST_CHECK_EQUAL(nValueRet, 37 * CENT); + // and we can make 38 cents if we accept all new coins + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 38 * CENT, filter_confirmed, vCoins, setCoinsRet, nValueRet)); + BOOST_CHECK_EQUAL(nValueRet, 38 * CENT); + + // try making 34 cents from 1,2,5,10,20 - we can't do it exactly + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 34 * CENT, filter_confirmed, vCoins, setCoinsRet, nValueRet)); + // but 35 cents is closest + BOOST_CHECK_EQUAL(nValueRet, 35 * CENT); + // the best should be 20+10+5. it's incredibly unlikely the 1 or 2 got + // included (but possible) + BOOST_CHECK_EQUAL(setCoinsRet.size(), 3U); + + // when we try making 7 cents, the smaller coins (1,2,5) are enough. We + // should see just 2+5 + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 7 * CENT, filter_confirmed, vCoins, setCoinsRet, nValueRet)); + BOOST_CHECK_EQUAL(nValueRet, 7 * CENT); + BOOST_CHECK_EQUAL(setCoinsRet.size(), 2U); + + // when we try making 8 cents, the smaller coins (1,2,5) are exactly + // enough. + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 8 * CENT, filter_confirmed, vCoins, setCoinsRet, nValueRet)); + BOOST_CHECK(nValueRet == 8 * CENT); + BOOST_CHECK_EQUAL(setCoinsRet.size(), 3U); + + // when we try making 9 cents, no subset of smaller coins is enough, and + // we get the next bigger coin (10) + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 9 * CENT, filter_confirmed, vCoins, setCoinsRet, nValueRet)); + BOOST_CHECK_EQUAL(nValueRet, 10 * CENT); + BOOST_CHECK_EQUAL(setCoinsRet.size(), 1U); + + // now clear out the wallet and start again to test choosing between + // subsets of smaller coins and the next biggest coin + empty_wallet(); + + add_coin(m_wallet, 6 * CENT); + add_coin(m_wallet, 7 * CENT); + add_coin(m_wallet, 8 * CENT); + add_coin(m_wallet, 20 * CENT); + // now we have 6+7+8+20+30 = 71 cents total + add_coin(m_wallet, 30 * CENT); + + // check that we have 71 and not 72 + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 71 * CENT, filter_confirmed, vCoins, setCoinsRet, nValueRet)); + BOOST_CHECK(!m_wallet.SelectCoinsMinConf( + 72 * CENT, filter_confirmed, vCoins, setCoinsRet, nValueRet)); + + // now try making 16 cents. the best smaller coins can do is 6+7+8 = + // 21; not as good at the next biggest coin, 20 + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 16 * CENT, filter_confirmed, vCoins, setCoinsRet, nValueRet)); + // we should get 20 in one coin + BOOST_CHECK_EQUAL(nValueRet, 20 * CENT); + BOOST_CHECK_EQUAL(setCoinsRet.size(), 1U); + + // now we have 5+6+7+8+20+30 = 75 cents total + add_coin(m_wallet, 5 * CENT); + + // now if we try making 16 cents again, the smaller coins can make 5+6+7 + // = 18 cents, better than the next biggest coin, 20 + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 16 * CENT, filter_confirmed, vCoins, setCoinsRet, nValueRet)); + // we should get 18 in 3 coins + BOOST_CHECK_EQUAL(nValueRet, 18 * CENT); + BOOST_CHECK_EQUAL(setCoinsRet.size(), 3U); + + // now we have 5+6+7+8+18+20+30 + add_coin(m_wallet, 18 * CENT); + + // and now if we try making 16 cents again, the smaller coins can make + // 5+6+7 = 18 cents, the same as the next biggest coin, 18 + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 16 * CENT, filter_confirmed, vCoins, setCoinsRet, nValueRet)); + // we should get 18 in 1 coin + BOOST_CHECK_EQUAL(nValueRet, 18 * CENT); + // because in the event of a tie, the biggest coin wins + BOOST_CHECK_EQUAL(setCoinsRet.size(), 1U); + + // now try making 11 cents. we should get 5+6 + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 11 * CENT, filter_confirmed, vCoins, setCoinsRet, nValueRet)); + BOOST_CHECK_EQUAL(nValueRet, 11 * CENT); + BOOST_CHECK_EQUAL(setCoinsRet.size(), 2U); + + // check that the smallest bigger coin is used + add_coin(m_wallet, 1 * COIN); + add_coin(m_wallet, 2 * COIN); + add_coin(m_wallet, 3 * COIN); + // now we have 5+6+7+8+18+20+30+100+200+300+400 = 1094 cents + add_coin(m_wallet, 4 * COIN); + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 95 * CENT, filter_confirmed, vCoins, setCoinsRet, nValueRet)); + // we should get 1 BCH in 1 coin + BOOST_CHECK_EQUAL(nValueRet, 1 * COIN); + BOOST_CHECK_EQUAL(setCoinsRet.size(), 1U); + + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 195 * CENT, filter_confirmed, vCoins, setCoinsRet, nValueRet)); + // we should get 2 BCH in 1 coin + BOOST_CHECK_EQUAL(nValueRet, 2 * COIN); + BOOST_CHECK_EQUAL(setCoinsRet.size(), 1U); + + // empty the wallet and start again, now with fractions of a cent, to + // test small change avoidance + + empty_wallet(); + add_coin(m_wallet, 1 * MIN_CHANGE / 10); + add_coin(m_wallet, 2 * MIN_CHANGE / 10); + add_coin(m_wallet, 3 * MIN_CHANGE / 10); + add_coin(m_wallet, 4 * MIN_CHANGE / 10); + add_coin(m_wallet, 5 * MIN_CHANGE / 10); + + // try making 1 * MIN_CHANGE from the 1.5 * MIN_CHANGE we'll get change + // smaller than MIN_CHANGE whatever happens, so can expect MIN_CHANGE + // exactly + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + MIN_CHANGE, filter_confirmed, vCoins, setCoinsRet, nValueRet)); + BOOST_CHECK_EQUAL(nValueRet, MIN_CHANGE); + + // but if we add a bigger coin, small change is avoided + add_coin(m_wallet, 1111 * MIN_CHANGE); + + // try making 1 from 0.1 + 0.2 + 0.3 + 0.4 + 0.5 + 1111 = 1112.5 + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 1 * MIN_CHANGE, filter_confirmed, vCoins, setCoinsRet, nValueRet)); + // we should get the exact amount + BOOST_CHECK_EQUAL(nValueRet, 1 * MIN_CHANGE); + + // if we add more small coins: + add_coin(m_wallet, 6 * MIN_CHANGE / 10); + add_coin(m_wallet, 7 * MIN_CHANGE / 10); + + // and try again to make 1.0 * MIN_CHANGE + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 1 * MIN_CHANGE, filter_confirmed, vCoins, setCoinsRet, nValueRet)); + // we should get the exact amount + BOOST_CHECK_EQUAL(nValueRet, 1 * MIN_CHANGE); + + // run the 'mtgox' test (see + // http://blockexplorer.com/tx/29a3efd3ef04f9153d47a990bd7b048a4b2d213daaa5fb8ed670fb85f13bdbcf) + // they tried to consolidate 10 50k coins into one 500k coin, and ended + // up with 50k in change + empty_wallet(); + for (int j = 0; j < 20; j++) { + add_coin(m_wallet, 50000 * COIN); + } + + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 500000 * COIN, filter_confirmed, vCoins, setCoinsRet, nValueRet)); + // we should get the exact amount + BOOST_CHECK_EQUAL(nValueRet, 500000 * COIN); + // in ten coins + BOOST_CHECK_EQUAL(setCoinsRet.size(), 10U); + + // if there's not enough in the smaller coins to make at least 1 * + // MIN_CHANGE change (0.5+0.6+0.7 < 1.0+1.0), we need to try finding an + // exact subset anyway + + // sometimes it will fail, and so we use the next biggest coin: + empty_wallet(); + add_coin(m_wallet, 5 * MIN_CHANGE / 10); + add_coin(m_wallet, 6 * MIN_CHANGE / 10); + add_coin(m_wallet, 7 * MIN_CHANGE / 10); + add_coin(m_wallet, 1111 * MIN_CHANGE); + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 1 * MIN_CHANGE, filter_confirmed, vCoins, setCoinsRet, nValueRet)); + // we get the bigger coin + BOOST_CHECK_EQUAL(nValueRet, 1111 * MIN_CHANGE); + BOOST_CHECK_EQUAL(setCoinsRet.size(), 1U); + + // but sometimes it's possible, and we use an exact subset (0.4 + 0.6 = + // 1.0) + empty_wallet(); + add_coin(m_wallet, 4 * MIN_CHANGE / 10); + add_coin(m_wallet, 6 * MIN_CHANGE / 10); + add_coin(m_wallet, 8 * MIN_CHANGE / 10); + add_coin(m_wallet, 1111 * MIN_CHANGE); + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + MIN_CHANGE, filter_confirmed, vCoins, setCoinsRet, nValueRet)); + // we should get the exact amount + BOOST_CHECK_EQUAL(nValueRet, MIN_CHANGE); + // in two coins 0.4+0.6 + BOOST_CHECK_EQUAL(setCoinsRet.size(), 2U); + + // test avoiding small change + empty_wallet(); + add_coin(m_wallet, 5 * MIN_CHANGE / 100); + add_coin(m_wallet, 1 * MIN_CHANGE); + add_coin(m_wallet, 100 * MIN_CHANGE); + + // trying to make 100.01 from these three coins + BOOST_CHECK(m_wallet.SelectCoinsMinConf(10001 * MIN_CHANGE / 100, + filter_confirmed, vCoins, + setCoinsRet, nValueRet)); + // we should get all coins + BOOST_CHECK_EQUAL(nValueRet, 10105 * MIN_CHANGE / 100); + BOOST_CHECK_EQUAL(setCoinsRet.size(), 3U); + + // but if we try to make 99.9, we should take the bigger of the two + // small coins to avoid small change + BOOST_CHECK(m_wallet.SelectCoinsMinConf(9990 * MIN_CHANGE / 100, + filter_confirmed, vCoins, + setCoinsRet, nValueRet)); + BOOST_CHECK_EQUAL(nValueRet, 101 * MIN_CHANGE); + BOOST_CHECK_EQUAL(setCoinsRet.size(), 2U); + + // test with many inputs + for (Amount amt = 1500 * SATOSHI; amt < COIN; amt = 10 * amt) { + empty_wallet(); + // Create 676 inputs (= (old MAX_STANDARD_TX_SIZE == 100000) / 148 + // bytes per input) + for (uint16_t j = 0; j < 676; j++) { + add_coin(m_wallet, amt); + } + BOOST_CHECK(m_wallet.SelectCoinsMinConf(2000 * SATOSHI, + filter_confirmed, vCoins, + setCoinsRet, nValueRet)); + if (amt - 2000 * SATOSHI < MIN_CHANGE) { + // needs more than one input: + uint16_t returnSize = std::ceil( + double(2000 + (MIN_CHANGE / SATOSHI)) / (amt / SATOSHI)); + Amount returnValue = returnSize * amt; + BOOST_CHECK_EQUAL(nValueRet, returnValue); + BOOST_CHECK_EQUAL(setCoinsRet.size(), returnSize); + } else { + // one input is sufficient: + BOOST_CHECK_EQUAL(nValueRet, amt); + BOOST_CHECK_EQUAL(setCoinsRet.size(), 1U); + } + } + + // test randomness + { + empty_wallet(); + for (int i2 = 0; i2 < 100; i2++) { + add_coin(m_wallet, COIN); + } + + // picking 50 from 100 coins doesn't depend on the shuffle, but does + // depend on randomness in the stochastic approximation code + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 50 * COIN, filter_standard, vCoins, setCoinsRet, nValueRet)); + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 50 * COIN, filter_standard, vCoins, setCoinsRet2, nValueRet)); + BOOST_CHECK(!equal_sets(setCoinsRet, setCoinsRet2)); + + int fails = 0; + for (int j = 0; j < RANDOM_REPEATS; j++) { + // selecting 1 from 100 identical coins depends on the shuffle; + // this test will fail 1% of the time run the test + // RANDOM_REPEATS times and only complain if all of them fail + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + COIN, filter_standard, vCoins, setCoinsRet, nValueRet)); + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + COIN, filter_standard, vCoins, setCoinsRet2, nValueRet)); + if (equal_sets(setCoinsRet, setCoinsRet2)) { + fails++; + } + } + BOOST_CHECK_NE(fails, RANDOM_REPEATS); + + // add 75 cents in small change. not enough to make 90 cents, then + // try making 90 cents. there are multiple competing "smallest + // bigger" coins, one of which should be picked at random + add_coin(m_wallet, 5 * CENT); + add_coin(m_wallet, 10 * CENT); + add_coin(m_wallet, 15 * CENT); + add_coin(m_wallet, 20 * CENT); + add_coin(m_wallet, 25 * CENT); + + fails = 0; + for (int j = 0; j < RANDOM_REPEATS; j++) { + // selecting 1 from 100 identical coins depends on the shuffle; + // this test will fail 1% of the time run the test + // RANDOM_REPEATS times and only complain if all of them fail + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 90 * CENT, filter_standard, vCoins, setCoinsRet, + nValueRet)); + BOOST_CHECK(m_wallet.SelectCoinsMinConf( + 90 * CENT, filter_standard, vCoins, setCoinsRet2, + nValueRet)); + if (equal_sets(setCoinsRet, setCoinsRet2)) { + fails++; + } + } + BOOST_CHECK_NE(fails, RANDOM_REPEATS); + } + } + empty_wallet(); +} + +BOOST_AUTO_TEST_CASE(ApproximateBestSubset) { + CoinSet setCoinsRet; + Amount nValueRet; + + LOCK(m_wallet.cs_wallet); + + empty_wallet(); + + // Test vValue sort order + for (int i = 0; i < 1000; i++) { + add_coin(m_wallet, 1000 * COIN); + } + add_coin(m_wallet, 3 * COIN); + + BOOST_CHECK(m_wallet.SelectCoinsMinConf(1003 * COIN, filter_standard, + vCoins, setCoinsRet, nValueRet)); + BOOST_CHECK_EQUAL(nValueRet, 1003 * COIN); + BOOST_CHECK_EQUAL(setCoinsRet.size(), 2U); + + empty_wallet(); +} + BOOST_AUTO_TEST_SUITE_END() diff --git a/src/wallet/test/wallet_tests.cpp b/src/wallet/test/wallet_tests.cpp index 6bc48e479..d221297b8 100644 --- a/src/wallet/test/wallet_tests.cpp +++ b/src/wallet/test/wallet_tests.cpp @@ -1,820 +1,383 @@ // Copyright (c) 2012-2016 The Bitcoin Core developers // Distributed under the MIT software license, see the accompanying // file COPYING or http://www.opensource.org/licenses/mit-license.php. #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include -// how many times to run all the tests to have a chance to catch errors that -// only show up with particular random shuffles -#define RUN_TESTS 100 - -// some tests fail 1% of the time due to bad luck. We repeat those tests this -// many times and only complain if all iterations of the test fail. -#define RANDOM_REPEATS 5 - -std::vector> wtxn; - -typedef std::set CoinSet; - BOOST_FIXTURE_TEST_SUITE(wallet_tests, WalletTestingSetup) -// Critical section is used to prevent concurrent execution of -// tests in this fixture -static CCriticalSection walletCriticalSection; - -static std::vector vCoins; - -static void add_coin(const CWallet &wallet, const Amount nValue, - int nAge = 6 * 24, bool fIsFromMe = false, - int nInput = 0) { - static int nextLockTime = 0; - CMutableTransaction tx; - // So all transactions get different hashes. - tx.nLockTime = nextLockTime++; - tx.vout.resize(nInput + 1); - tx.vout[nInput].nValue = nValue; - if (fIsFromMe) { - // IsFromMe() returns (GetDebit() > 0), and GetDebit() is 0 if - // vin.empty(), so stop vin being empty, and cache a non-zero Debit to - // fake out IsFromMe() - tx.vin.resize(1); - } - std::unique_ptr wtx( - new CWalletTx(&wallet, MakeTransactionRef(std::move(tx)))); - if (fIsFromMe) { - wtx->fDebitCached = true; - wtx->nDebitCached = SATOSHI; - } - COutput output(wtx.get(), nInput, nAge, true /* spendable */, - true /* solvable */, true /* safe */); - vCoins.push_back(output); - wtxn.emplace_back(std::move(wtx)); -} - -static void empty_wallet(void) { - vCoins.clear(); - wtxn.clear(); -} - -static bool equal_sets(CoinSet a, CoinSet b) { - std::pair ret = - mismatch(a.begin(), a.end(), b.begin()); - return ret.first == a.end() && ret.second == b.end(); -} - -CoinEligibilityFilter filter_standard(1, 6, 0); -CoinEligibilityFilter filter_confirmed(1, 1, 0); -CoinEligibilityFilter filter_standard_extra(6, 6, 0); - -BOOST_AUTO_TEST_CASE(coin_selection_tests) { - CoinSet setCoinsRet, setCoinsRet2; - Amount nValueRet; - - const CWallet wallet(Params(), "dummy", CWalletDBWrapper::CreateDummy()); - LOCK(walletCriticalSection); - - // test multiple times to allow for differences in the shuffle order - for (int i = 0; i < RUN_TESTS; i++) { - empty_wallet(); - - // with an empty wallet we can't even pay one cent - BOOST_CHECK(!wallet.SelectCoinsMinConf(1 * CENT, filter_standard, - vCoins, setCoinsRet, nValueRet)); - // add a new 1 cent coin - add_coin(wallet, 1 * CENT, 4); - - // with a new 1 cent coin, we still can't find a mature 1 cent - BOOST_CHECK(!wallet.SelectCoinsMinConf(1 * CENT, filter_standard, - vCoins, setCoinsRet, nValueRet)); - - // but we can find a new 1 cent - BOOST_CHECK(wallet.SelectCoinsMinConf(1 * CENT, filter_confirmed, - vCoins, setCoinsRet, nValueRet)); - BOOST_CHECK_EQUAL(nValueRet, 1 * CENT); - // add a mature 2 cent coin - add_coin(wallet, 2 * CENT); - - // we can't make 3 cents of mature coins - BOOST_CHECK(!wallet.SelectCoinsMinConf(3 * CENT, filter_standard, - vCoins, setCoinsRet, nValueRet)); - - // we can make 3 cents of new coins - BOOST_CHECK(wallet.SelectCoinsMinConf(3 * CENT, filter_confirmed, - vCoins, setCoinsRet, nValueRet)); - BOOST_CHECK_EQUAL(nValueRet, 3 * CENT); - - // add a mature 5 cent coin, - add_coin(wallet, 5 * CENT); - // a new 10 cent coin sent from one of our own addresses - add_coin(wallet, 10 * CENT, 3, true); - // and a mature 20 cent coin - add_coin(wallet, 20 * CENT); - - // now we have new: 1+10=11 (of which 10 was self-sent), and mature: - // 2+5+20=27. total = 38 - - // we can't make 38 cents only if we disallow new coins: - BOOST_CHECK(!wallet.SelectCoinsMinConf(38 * CENT, filter_standard, - vCoins, setCoinsRet, nValueRet)); - // we can't even make 37 cents if we don't allow new coins even if - // they're from us - BOOST_CHECK(!wallet.SelectCoinsMinConf(38 * CENT, filter_standard_extra, - vCoins, setCoinsRet, nValueRet)); - // but we can make 37 cents if we accept new coins from ourself - BOOST_CHECK(wallet.SelectCoinsMinConf(37 * CENT, filter_standard, - vCoins, setCoinsRet, nValueRet)); - BOOST_CHECK_EQUAL(nValueRet, 37 * CENT); - // and we can make 38 cents if we accept all new coins - BOOST_CHECK(wallet.SelectCoinsMinConf(38 * CENT, filter_confirmed, - vCoins, setCoinsRet, nValueRet)); - BOOST_CHECK_EQUAL(nValueRet, 38 * CENT); - - // try making 34 cents from 1,2,5,10,20 - we can't do it exactly - BOOST_CHECK(wallet.SelectCoinsMinConf(34 * CENT, filter_confirmed, - vCoins, setCoinsRet, nValueRet)); - // but 35 cents is closest - BOOST_CHECK_EQUAL(nValueRet, 35 * CENT); - // the best should be 20+10+5. it's incredibly unlikely the 1 or 2 got - // included (but possible) - BOOST_CHECK_EQUAL(setCoinsRet.size(), 3U); - - // when we try making 7 cents, the smaller coins (1,2,5) are enough. We - // should see just 2+5 - BOOST_CHECK(wallet.SelectCoinsMinConf(7 * CENT, filter_confirmed, - vCoins, setCoinsRet, nValueRet)); - BOOST_CHECK_EQUAL(nValueRet, 7 * CENT); - BOOST_CHECK_EQUAL(setCoinsRet.size(), 2U); - - // when we try making 8 cents, the smaller coins (1,2,5) are exactly - // enough. - BOOST_CHECK(wallet.SelectCoinsMinConf(8 * CENT, filter_confirmed, - vCoins, setCoinsRet, nValueRet)); - BOOST_CHECK(nValueRet == 8 * CENT); - BOOST_CHECK_EQUAL(setCoinsRet.size(), 3U); - - // when we try making 9 cents, no subset of smaller coins is enough, and - // we get the next bigger coin (10) - BOOST_CHECK(wallet.SelectCoinsMinConf(9 * CENT, filter_confirmed, - vCoins, setCoinsRet, nValueRet)); - BOOST_CHECK_EQUAL(nValueRet, 10 * CENT); - BOOST_CHECK_EQUAL(setCoinsRet.size(), 1U); - - // now clear out the wallet and start again to test choosing between - // subsets of smaller coins and the next biggest coin - empty_wallet(); - - add_coin(wallet, 6 * CENT); - add_coin(wallet, 7 * CENT); - add_coin(wallet, 8 * CENT); - add_coin(wallet, 20 * CENT); - // now we have 6+7+8+20+30 = 71 cents total - add_coin(wallet, 30 * CENT); - - // check that we have 71 and not 72 - BOOST_CHECK(wallet.SelectCoinsMinConf(71 * CENT, filter_confirmed, - vCoins, setCoinsRet, nValueRet)); - BOOST_CHECK(!wallet.SelectCoinsMinConf(72 * CENT, filter_confirmed, - vCoins, setCoinsRet, nValueRet)); - - // now try making 16 cents. the best smaller coins can do is 6+7+8 = - // 21; not as good at the next biggest coin, 20 - BOOST_CHECK(wallet.SelectCoinsMinConf(16 * CENT, filter_confirmed, - vCoins, setCoinsRet, nValueRet)); - // we should get 20 in one coin - BOOST_CHECK_EQUAL(nValueRet, 20 * CENT); - BOOST_CHECK_EQUAL(setCoinsRet.size(), 1U); - - // now we have 5+6+7+8+20+30 = 75 cents total - add_coin(wallet, 5 * CENT); - - // now if we try making 16 cents again, the smaller coins can make 5+6+7 - // = 18 cents, better than the next biggest coin, 20 - BOOST_CHECK(wallet.SelectCoinsMinConf(16 * CENT, filter_confirmed, - vCoins, setCoinsRet, nValueRet)); - // we should get 18 in 3 coins - BOOST_CHECK_EQUAL(nValueRet, 18 * CENT); - BOOST_CHECK_EQUAL(setCoinsRet.size(), 3U); - - // now we have 5+6+7+8+18+20+30 - add_coin(wallet, 18 * CENT); - - // and now if we try making 16 cents again, the smaller coins can make - // 5+6+7 = 18 cents, the same as the next biggest coin, 18 - BOOST_CHECK(wallet.SelectCoinsMinConf(16 * CENT, filter_confirmed, - vCoins, setCoinsRet, nValueRet)); - // we should get 18 in 1 coin - BOOST_CHECK_EQUAL(nValueRet, 18 * CENT); - // because in the event of a tie, the biggest coin wins - BOOST_CHECK_EQUAL(setCoinsRet.size(), 1U); - - // now try making 11 cents. we should get 5+6 - BOOST_CHECK(wallet.SelectCoinsMinConf(11 * CENT, filter_confirmed, - vCoins, setCoinsRet, nValueRet)); - BOOST_CHECK_EQUAL(nValueRet, 11 * CENT); - BOOST_CHECK_EQUAL(setCoinsRet.size(), 2U); - - // check that the smallest bigger coin is used - add_coin(wallet, 1 * COIN); - add_coin(wallet, 2 * COIN); - add_coin(wallet, 3 * COIN); - // now we have 5+6+7+8+18+20+30+100+200+300+400 = 1094 cents - add_coin(wallet, 4 * COIN); - BOOST_CHECK(wallet.SelectCoinsMinConf(95 * CENT, filter_confirmed, - vCoins, setCoinsRet, nValueRet)); - // we should get 1 BCH in 1 coin - BOOST_CHECK_EQUAL(nValueRet, 1 * COIN); - BOOST_CHECK_EQUAL(setCoinsRet.size(), 1U); - - BOOST_CHECK(wallet.SelectCoinsMinConf(195 * CENT, filter_confirmed, - vCoins, setCoinsRet, nValueRet)); - // we should get 2 BCH in 1 coin - BOOST_CHECK_EQUAL(nValueRet, 2 * COIN); - BOOST_CHECK_EQUAL(setCoinsRet.size(), 1U); - - // empty the wallet and start again, now with fractions of a cent, to - // test small change avoidance - - empty_wallet(); - add_coin(wallet, 1 * MIN_CHANGE / 10); - add_coin(wallet, 2 * MIN_CHANGE / 10); - add_coin(wallet, 3 * MIN_CHANGE / 10); - add_coin(wallet, 4 * MIN_CHANGE / 10); - add_coin(wallet, 5 * MIN_CHANGE / 10); - - // try making 1 * MIN_CHANGE from the 1.5 * MIN_CHANGE we'll get change - // smaller than MIN_CHANGE whatever happens, so can expect MIN_CHANGE - // exactly - BOOST_CHECK(wallet.SelectCoinsMinConf(MIN_CHANGE, filter_confirmed, - vCoins, setCoinsRet, nValueRet)); - BOOST_CHECK_EQUAL(nValueRet, MIN_CHANGE); - - // but if we add a bigger coin, small change is avoided - add_coin(wallet, 1111 * MIN_CHANGE); - - // try making 1 from 0.1 + 0.2 + 0.3 + 0.4 + 0.5 + 1111 = 1112.5 - BOOST_CHECK(wallet.SelectCoinsMinConf(1 * MIN_CHANGE, filter_confirmed, - vCoins, setCoinsRet, nValueRet)); - // we should get the exact amount - BOOST_CHECK_EQUAL(nValueRet, 1 * MIN_CHANGE); - - // if we add more small coins: - add_coin(wallet, 6 * MIN_CHANGE / 10); - add_coin(wallet, 7 * MIN_CHANGE / 10); - - // and try again to make 1.0 * MIN_CHANGE - BOOST_CHECK(wallet.SelectCoinsMinConf(1 * MIN_CHANGE, filter_confirmed, - vCoins, setCoinsRet, nValueRet)); - // we should get the exact amount - BOOST_CHECK_EQUAL(nValueRet, 1 * MIN_CHANGE); - - // run the 'mtgox' test (see - // http://blockexplorer.com/tx/29a3efd3ef04f9153d47a990bd7b048a4b2d213daaa5fb8ed670fb85f13bdbcf) - // they tried to consolidate 10 50k coins into one 500k coin, and ended - // up with 50k in change - empty_wallet(); - for (int j = 0; j < 20; j++) { - add_coin(wallet, 50000 * COIN); - } - - BOOST_CHECK(wallet.SelectCoinsMinConf(500000 * COIN, filter_confirmed, - vCoins, setCoinsRet, nValueRet)); - // we should get the exact amount - BOOST_CHECK_EQUAL(nValueRet, 500000 * COIN); - // in ten coins - BOOST_CHECK_EQUAL(setCoinsRet.size(), 10U); - - // if there's not enough in the smaller coins to make at least 1 * - // MIN_CHANGE change (0.5+0.6+0.7 < 1.0+1.0), we need to try finding an - // exact subset anyway - - // sometimes it will fail, and so we use the next biggest coin: - empty_wallet(); - add_coin(wallet, 5 * MIN_CHANGE / 10); - add_coin(wallet, 6 * MIN_CHANGE / 10); - add_coin(wallet, 7 * MIN_CHANGE / 10); - add_coin(wallet, 1111 * MIN_CHANGE); - BOOST_CHECK(wallet.SelectCoinsMinConf(1 * MIN_CHANGE, filter_confirmed, - vCoins, setCoinsRet, nValueRet)); - // we get the bigger coin - BOOST_CHECK_EQUAL(nValueRet, 1111 * MIN_CHANGE); - BOOST_CHECK_EQUAL(setCoinsRet.size(), 1U); - - // but sometimes it's possible, and we use an exact subset (0.4 + 0.6 = - // 1.0) - empty_wallet(); - add_coin(wallet, 4 * MIN_CHANGE / 10); - add_coin(wallet, 6 * MIN_CHANGE / 10); - add_coin(wallet, 8 * MIN_CHANGE / 10); - add_coin(wallet, 1111 * MIN_CHANGE); - BOOST_CHECK(wallet.SelectCoinsMinConf(MIN_CHANGE, filter_confirmed, - vCoins, setCoinsRet, nValueRet)); - // we should get the exact amount - BOOST_CHECK_EQUAL(nValueRet, MIN_CHANGE); - // in two coins 0.4+0.6 - BOOST_CHECK_EQUAL(setCoinsRet.size(), 2U); - - // test avoiding small change - empty_wallet(); - add_coin(wallet, 5 * MIN_CHANGE / 100); - add_coin(wallet, 1 * MIN_CHANGE); - add_coin(wallet, 100 * MIN_CHANGE); - - // trying to make 100.01 from these three coins - BOOST_CHECK(wallet.SelectCoinsMinConf(10001 * MIN_CHANGE / 100, - filter_confirmed, vCoins, - setCoinsRet, nValueRet)); - // we should get all coins - BOOST_CHECK_EQUAL(nValueRet, 10105 * MIN_CHANGE / 100); - BOOST_CHECK_EQUAL(setCoinsRet.size(), 3U); - - // but if we try to make 99.9, we should take the bigger of the two - // small coins to avoid small change - BOOST_CHECK(wallet.SelectCoinsMinConf(9990 * MIN_CHANGE / 100, - filter_confirmed, vCoins, - setCoinsRet, nValueRet)); - BOOST_CHECK_EQUAL(nValueRet, 101 * MIN_CHANGE); - BOOST_CHECK_EQUAL(setCoinsRet.size(), 2U); - - // test with many inputs - for (Amount amt = 1500 * SATOSHI; amt < COIN; amt = 10 * amt) { - empty_wallet(); - // Create 676 inputs (= (old MAX_STANDARD_TX_SIZE == 100000) / 148 - // bytes per input) - for (uint16_t j = 0; j < 676; j++) { - add_coin(wallet, amt); - } - BOOST_CHECK(wallet.SelectCoinsMinConf(2000 * SATOSHI, - filter_confirmed, vCoins, - setCoinsRet, nValueRet)); - if (amt - 2000 * SATOSHI < MIN_CHANGE) { - // needs more than one input: - uint16_t returnSize = std::ceil( - double(2000 + (MIN_CHANGE / SATOSHI)) / (amt / SATOSHI)); - Amount returnValue = returnSize * amt; - BOOST_CHECK_EQUAL(nValueRet, returnValue); - BOOST_CHECK_EQUAL(setCoinsRet.size(), returnSize); - } else { - // one input is sufficient: - BOOST_CHECK_EQUAL(nValueRet, amt); - BOOST_CHECK_EQUAL(setCoinsRet.size(), 1U); - } - } - - // test randomness - { - empty_wallet(); - for (int i2 = 0; i2 < 100; i2++) { - add_coin(wallet, COIN); - } - - // picking 50 from 100 coins doesn't depend on the shuffle, but does - // depend on randomness in the stochastic approximation code - BOOST_CHECK(wallet.SelectCoinsMinConf( - 50 * COIN, filter_standard, vCoins, setCoinsRet, nValueRet)); - BOOST_CHECK(wallet.SelectCoinsMinConf( - 50 * COIN, filter_standard, vCoins, setCoinsRet2, nValueRet)); - BOOST_CHECK(!equal_sets(setCoinsRet, setCoinsRet2)); - - int fails = 0; - for (int j = 0; j < RANDOM_REPEATS; j++) { - // selecting 1 from 100 identical coins depends on the shuffle; - // this test will fail 1% of the time run the test - // RANDOM_REPEATS times and only complain if all of them fail - BOOST_CHECK(wallet.SelectCoinsMinConf( - COIN, filter_standard, vCoins, setCoinsRet, nValueRet)); - BOOST_CHECK(wallet.SelectCoinsMinConf( - COIN, filter_standard, vCoins, setCoinsRet2, nValueRet)); - if (equal_sets(setCoinsRet, setCoinsRet2)) { - fails++; - } - } - BOOST_CHECK_NE(fails, RANDOM_REPEATS); - - // add 75 cents in small change. not enough to make 90 cents, then - // try making 90 cents. there are multiple competing "smallest - // bigger" coins, one of which should be picked at random - add_coin(wallet, 5 * CENT); - add_coin(wallet, 10 * CENT); - add_coin(wallet, 15 * CENT); - add_coin(wallet, 20 * CENT); - add_coin(wallet, 25 * CENT); - - fails = 0; - for (int j = 0; j < RANDOM_REPEATS; j++) { - // selecting 1 from 100 identical coins depends on the shuffle; - // this test will fail 1% of the time run the test - // RANDOM_REPEATS times and only complain if all of them fail - BOOST_CHECK(wallet.SelectCoinsMinConf(90 * CENT, - filter_standard, vCoins, - setCoinsRet, nValueRet)); - BOOST_CHECK(wallet.SelectCoinsMinConf(90 * CENT, - filter_standard, vCoins, - setCoinsRet2, nValueRet)); - if (equal_sets(setCoinsRet, setCoinsRet2)) { - fails++; - } - } - BOOST_CHECK_NE(fails, RANDOM_REPEATS); - } - } - empty_wallet(); -} - -BOOST_AUTO_TEST_CASE(ApproximateBestSubset) { - CoinSet setCoinsRet; - Amount nValueRet; - - const CWallet wallet(Params(), "dummy", CWalletDBWrapper::CreateDummy()); - LOCK(walletCriticalSection); - - empty_wallet(); - - // Test vValue sort order - for (int i = 0; i < 1000; i++) { - add_coin(wallet, 1000 * COIN); - } - add_coin(wallet, 3 * COIN); - - BOOST_CHECK(wallet.SelectCoinsMinConf(1003 * COIN, filter_standard, vCoins, - setCoinsRet, nValueRet)); - BOOST_CHECK_EQUAL(nValueRet, 1003 * COIN); - BOOST_CHECK_EQUAL(setCoinsRet.size(), 2U); - - empty_wallet(); -} - static void AddKey(CWallet &wallet, const CKey &key) { LOCK(wallet.cs_wallet); wallet.AddKeyPubKey(key, key.GetPubKey()); } BOOST_FIXTURE_TEST_CASE(rescan, TestChain100Setup) { // Cap last block file size, and mine new block in a new block file. CBlockIndex *const nullBlock = nullptr; CBlockIndex *oldTip = chainActive.Tip(); GetBlockFileInfo(oldTip->GetBlockPos().nFile)->nSize = MAX_BLOCKFILE_SIZE; CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())); CBlockIndex *newTip = chainActive.Tip(); LOCK(cs_main); // Verify ScanForWalletTransactions picks up transactions in both the old // and new block files. { CWallet wallet(Params(), "dummy", CWalletDBWrapper::CreateDummy()); AddKey(wallet, coinbaseKey); WalletRescanReserver reserver(&wallet); reserver.reserve(); BOOST_CHECK_EQUAL(nullBlock, wallet.ScanForWalletTransactions( oldTip, nullptr, reserver)); BOOST_CHECK_EQUAL(wallet.GetImmatureBalance(), 100 * COIN); } // Prune the older block file. PruneOneBlockFile(oldTip->GetBlockPos().nFile); UnlinkPrunedFiles({oldTip->GetBlockPos().nFile}); // Verify ScanForWalletTransactions only picks transactions in the new block // file. { CWallet wallet(Params(), "dummy", CWalletDBWrapper::CreateDummy()); AddKey(wallet, coinbaseKey); WalletRescanReserver reserver(&wallet); reserver.reserve(); BOOST_CHECK_EQUAL(oldTip, wallet.ScanForWalletTransactions( oldTip, nullptr, reserver)); BOOST_CHECK_EQUAL(wallet.GetImmatureBalance(), 50 * COIN); } // Verify importmulti RPC returns failure for a key whose creation time is // before the missing block, and success for a key whose creation time is // after. { CWallet wallet(Params(), "dummy", CWalletDBWrapper::CreateDummy()); vpwallets.insert(vpwallets.begin(), &wallet); UniValue keys; keys.setArray(); UniValue key; key.setObject(); key.pushKV("scriptPubKey", HexStr(GetScriptForRawPubKey(coinbaseKey.GetPubKey()))); key.pushKV("timestamp", 0); key.pushKV("internal", UniValue(true)); keys.push_back(key); key.clear(); key.setObject(); CKey futureKey; futureKey.MakeNewKey(true); key.pushKV("scriptPubKey", HexStr(GetScriptForRawPubKey(futureKey.GetPubKey()))); key.pushKV("timestamp", newTip->GetBlockTimeMax() + TIMESTAMP_WINDOW + 1); key.pushKV("internal", UniValue(true)); keys.push_back(key); JSONRPCRequest request; request.params.setArray(); request.params.push_back(keys); UniValue response = importmulti(GetConfig(), request); BOOST_CHECK_EQUAL( response.write(), strprintf("[{\"success\":false,\"error\":{\"code\":-1,\"message\":" "\"Rescan failed for key with creation timestamp %d. " "There was an error reading a block from time %d, which " "is after or within %d seconds of key creation, and " "could contain transactions pertaining to the key. As a " "result, transactions and coins using this key may not " "appear in the wallet. This error could be caused by " "pruning or data corruption (see bitcoind log for " "details) and could be dealt with by downloading and " "rescanning the relevant blocks (see -reindex and " "-rescan options).\"}},{\"success\":true}]", 0, oldTip->GetBlockTimeMax(), TIMESTAMP_WINDOW)); vpwallets.erase(vpwallets.begin()); } } // Verify importwallet RPC starts rescan at earliest block with timestamp // greater or equal than key birthday. Previously there was a bug where // importwallet RPC would start the scan at the latest block with timestamp less // than or equal to key birthday. BOOST_FIXTURE_TEST_CASE(importwallet_rescan, TestChain100Setup) { // Create two blocks with same timestamp to verify that importwallet rescan // will pick up both blocks, not just the first. const int64_t BLOCK_TIME = chainActive.Tip()->GetBlockTimeMax() + 5; SetMockTime(BLOCK_TIME); coinbaseTxns.emplace_back( *CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())) .vtx[0]); coinbaseTxns.emplace_back( *CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())) .vtx[0]); // Set key birthday to block time increased by the timestamp window, so // rescan will start at the block time. const int64_t KEY_TIME = BLOCK_TIME + TIMESTAMP_WINDOW; SetMockTime(KEY_TIME); coinbaseTxns.emplace_back( *CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())) .vtx[0]); LOCK(cs_main); // Import key into wallet and call dumpwallet to create backup file. { CWallet wallet(Params(), "dummy", CWalletDBWrapper::CreateDummy()); LOCK(wallet.cs_wallet); wallet.mapKeyMetadata[coinbaseKey.GetPubKey().GetID()].nCreateTime = KEY_TIME; wallet.AddKeyPubKey(coinbaseKey, coinbaseKey.GetPubKey()); JSONRPCRequest request; request.params.setArray(); request.params.push_back((pathTemp / "wallet.backup").string()); vpwallets.insert(vpwallets.begin(), &wallet); ::dumpwallet(GetConfig(), request); } // Call importwallet RPC and verify all blocks with timestamps >= BLOCK_TIME // were scanned, and no prior blocks were scanned. { CWallet wallet(Params(), "dummy", CWalletDBWrapper::CreateDummy()); JSONRPCRequest request; request.params.setArray(); request.params.push_back((pathTemp / "wallet.backup").string()); vpwallets[0] = &wallet; ::importwallet(GetConfig(), request); LOCK(wallet.cs_wallet); BOOST_CHECK_EQUAL(wallet.mapWallet.size(), 3); BOOST_CHECK_EQUAL(coinbaseTxns.size(), 103); for (size_t i = 0; i < coinbaseTxns.size(); ++i) { bool found = wallet.GetWalletTx(coinbaseTxns[i].GetId()); bool expected = i >= 100; BOOST_CHECK_EQUAL(found, expected); } } SetMockTime(0); vpwallets.erase(vpwallets.begin()); } // Check that GetImmatureCredit() returns a newly calculated value instead of // the cached value after a MarkDirty() call. // // This is a regression test written to verify a bugfix for the immature credit // function. Similar tests probably should be written for the other credit and // debit functions. BOOST_FIXTURE_TEST_CASE(coin_mark_dirty_immature_credit, TestChain100Setup) { CWallet wallet(Params(), "dummy", CWalletDBWrapper::CreateDummy()); CWalletTx wtx(&wallet, MakeTransactionRef(coinbaseTxns.back())); LOCK2(cs_main, wallet.cs_wallet); wtx.hashBlock = chainActive.Tip()->GetBlockHash(); wtx.nIndex = 0; // Call GetImmatureCredit() once before adding the key to the wallet to // cache the current immature credit amount, which is 0. BOOST_CHECK_EQUAL(wtx.GetImmatureCredit(), Amount::zero()); // Invalidate the cached value, add the key, and make sure a new immature // credit amount is calculated. wtx.MarkDirty(); wallet.AddKeyPubKey(coinbaseKey, coinbaseKey.GetPubKey()); BOOST_CHECK_EQUAL(wtx.GetImmatureCredit(), 50 * COIN); } static int64_t AddTx(CWallet &wallet, uint32_t lockTime, int64_t mockTime, int64_t blockTime) { CMutableTransaction tx; tx.nLockTime = lockTime; SetMockTime(mockTime); CBlockIndex *block = nullptr; if (blockTime > 0) { LOCK(cs_main); auto inserted = mapBlockIndex.emplace(GetRandHash(), new CBlockIndex); assert(inserted.second); const uint256 &hash = inserted.first->first; block = inserted.first->second; block->nTime = blockTime; block->phashBlock = &hash; } CWalletTx wtx(&wallet, MakeTransactionRef(tx)); if (block) { wtx.SetMerkleBranch(block, 0); } { LOCK(cs_main); wallet.AddToWallet(wtx); } LOCK(wallet.cs_wallet); return wallet.mapWallet.at(wtx.GetId()).nTimeSmart; } // Simple test to verify assignment of CWalletTx::nSmartTime value. Could be // expanded to cover more corner cases of smart time logic. BOOST_AUTO_TEST_CASE(ComputeTimeSmart) { // New transaction should use clock time if lower than block time. BOOST_CHECK_EQUAL(AddTx(m_wallet, 1, 100, 120), 100); // Test that updating existing transaction does not change smart time. BOOST_CHECK_EQUAL(AddTx(m_wallet, 1, 200, 220), 100); // New transaction should use clock time if there's no block time. BOOST_CHECK_EQUAL(AddTx(m_wallet, 2, 300, 0), 300); // New transaction should use block time if lower than clock time. BOOST_CHECK_EQUAL(AddTx(m_wallet, 3, 420, 400), 400); // New transaction should use latest entry time if higher than // min(block time, clock time). BOOST_CHECK_EQUAL(AddTx(m_wallet, 4, 500, 390), 400); // If there are future entries, new transaction should use time of the // newest entry that is no more than 300 seconds ahead of the clock time. BOOST_CHECK_EQUAL(AddTx(m_wallet, 5, 50, 600), 300); // Reset mock time for other tests. SetMockTime(0); } BOOST_AUTO_TEST_CASE(LoadReceiveRequests) { CTxDestination dest = CKeyID(); LOCK(m_wallet.cs_wallet); m_wallet.AddDestData(dest, "misc", "val_misc"); m_wallet.AddDestData(dest, "rr0", "val_rr0"); m_wallet.AddDestData(dest, "rr1", "val_rr1"); auto values = m_wallet.GetDestValues("rr"); BOOST_CHECK_EQUAL(values.size(), 2); BOOST_CHECK_EQUAL(values[0], "val_rr0"); BOOST_CHECK_EQUAL(values[1], "val_rr1"); } class ListCoinsTestingSetup : public TestChain100Setup { public: ListCoinsTestingSetup() { CreateAndProcessBlock({}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())); wallet = std::make_unique(Params(), "mock", CWalletDBWrapper::CreateMock()); bool firstRun; wallet->LoadWallet(firstRun); AddKey(*wallet, coinbaseKey); WalletRescanReserver reserver(wallet.get()); reserver.reserve(); wallet->ScanForWalletTransactions(chainActive.Genesis(), nullptr, reserver); } ~ListCoinsTestingSetup() { wallet.reset(); } CWalletTx &AddTx(CRecipient recipient) { CTransactionRef tx; CReserveKey reservekey(wallet.get()); Amount fee; int changePos = -1; std::string error; CCoinControl dummy; BOOST_CHECK(wallet->CreateTransaction({recipient}, tx, reservekey, fee, changePos, error, dummy)); CValidationState state; BOOST_CHECK(wallet->CommitTransaction(tx, {}, {}, {}, reservekey, nullptr, state)); CMutableTransaction blocktx; { LOCK(wallet->cs_wallet); blocktx = CMutableTransaction(*wallet->mapWallet.at(tx->GetId()).tx); } CreateAndProcessBlock({CMutableTransaction(blocktx)}, GetScriptForRawPubKey(coinbaseKey.GetPubKey())); LOCK(wallet->cs_wallet); auto it = wallet->mapWallet.find(tx->GetId()); BOOST_CHECK(it != wallet->mapWallet.end()); it->second.SetMerkleBranch(chainActive.Tip(), 1); return it->second; } std::unique_ptr wallet; }; BOOST_FIXTURE_TEST_CASE(ListCoins, ListCoinsTestingSetup) { std::string coinbaseAddress = coinbaseKey.GetPubKey().GetID().ToString(); // Confirm ListCoins initially returns 1 coin grouped under coinbaseKey // address. auto list = wallet->ListCoins(); BOOST_CHECK_EQUAL(list.size(), 1); BOOST_CHECK_EQUAL(boost::get(list.begin()->first).ToString(), coinbaseAddress); BOOST_CHECK_EQUAL(list.begin()->second.size(), 1); // Check initial balance from one mature coinbase transaction. BOOST_CHECK_EQUAL(50 * COIN, wallet->GetAvailableBalance()); // Add a transaction creating a change address, and confirm ListCoins still // returns the coin associated with the change address underneath the // coinbaseKey pubkey, even though the change address has a different // pubkey. AddTx(CRecipient{GetScriptForRawPubKey({}), 1 * COIN, false /* subtract fee */}); list = wallet->ListCoins(); BOOST_CHECK_EQUAL(list.size(), 1); BOOST_CHECK_EQUAL(boost::get(list.begin()->first).ToString(), coinbaseAddress); BOOST_CHECK_EQUAL(list.begin()->second.size(), 2); // Lock both coins. Confirm number of available coins drops to 0. { LOCK2(cs_main, wallet->cs_wallet); std::vector available; wallet->AvailableCoins(available); BOOST_CHECK_EQUAL(available.size(), 2); } for (const auto &group : list) { for (const auto &coin : group.second) { LOCK(wallet->cs_wallet); wallet->LockCoin(COutPoint(coin.tx->GetId(), coin.i)); } } { LOCK2(cs_main, wallet->cs_wallet); std::vector available; wallet->AvailableCoins(available); BOOST_CHECK_EQUAL(available.size(), 0); } // Confirm ListCoins still returns same result as before, despite coins // being locked. list = wallet->ListCoins(); BOOST_CHECK_EQUAL(list.size(), 1); BOOST_CHECK_EQUAL(boost::get(list.begin()->first).ToString(), coinbaseAddress); BOOST_CHECK_EQUAL(list.begin()->second.size(), 2); } BOOST_AUTO_TEST_SUITE_END() diff --git a/src/wallet/wallet.cpp b/src/wallet/wallet.cpp index 86d928f4d..9d2d616c0 100644 --- a/src/wallet/wallet.cpp +++ b/src/wallet/wallet.cpp @@ -1,4499 +1,4493 @@ // Copyright (c) 2009-2010 Satoshi Nakamoto // Copyright (c) 2009-2016 The Bitcoin Core developers // Distributed under the MIT software license, see the accompanying // file COPYING or http://www.opensource.org/licenses/mit-license.php. #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include // for IsDeprecatedRPCEnabled #include #include