mirror of
https://github.com/bitcoin/bitcoin.git
synced 2026-02-08 06:31:11 +00:00
a23cca56c0
Rename `BResult` class to `util::Result` and update the class interface to be more compatible with `std::optional` and with a full-featured result class implemented in https://github.com/bitcoin/bitcoin/pull/25665. Motivation for this change is to update existing `BResult` usages now so they don't have to change later when more features are added in #25665. This change makes the following improvements originally implemented in #25665: - More explicit API. Drops potentially misleading `BResult` constructor that treats any bilingual string argument as an error. Adds `util::Error` constructor so it is never ambiguous when a result is being assigned an error or non-error value. - Better type compatibility. Supports `util::Result<bilingual_str>` return values to hold translated messages which are not errors. - More standard and consistent API. `util::Result` supports most of the same operators and methods as `std::optional`. `BResult` had a less familiar interface with `HasRes`/`GetObj`/`ReleaseObj` methods. The Result/Res/Obj naming was also not internally consistent. - Better code organization. Puts `src/util/` code in the `util::` namespace so naming reflects code organization and it is obvious where the class is coming from. Drops "B" from name because it is undocumented what it stands for (bilingual?) - Has unit tests.
106 lines
4.0 KiB
C++
106 lines
4.0 KiB
C++
// Copyright (c) 2022 The Bitcoin Core developers
|
|
// Distributed under the MIT software license, see the accompanying
|
|
// file COPYING or https://www.opensource.org/licenses/mit-license.php.
|
|
|
|
#include <validation.h>
|
|
#include <wallet/coincontrol.h>
|
|
#include <wallet/spend.h>
|
|
#include <wallet/test/util.h>
|
|
#include <wallet/test/wallet_test_fixture.h>
|
|
|
|
#include <boost/test/unit_test.hpp>
|
|
|
|
namespace wallet {
|
|
BOOST_FIXTURE_TEST_SUITE(availablecoins_tests, WalletTestingSetup)
|
|
class AvailableCoinsTestingSetup : public TestChain100Setup
|
|
{
|
|
public:
|
|
AvailableCoinsTestingSetup()
|
|
{
|
|
CreateAndProcessBlock({}, {});
|
|
wallet = CreateSyncedWallet(*m_node.chain, m_node.chainman->ActiveChain(), m_args, coinbaseKey);
|
|
}
|
|
|
|
~AvailableCoinsTestingSetup()
|
|
{
|
|
wallet.reset();
|
|
}
|
|
CWalletTx& AddTx(CRecipient recipient)
|
|
{
|
|
CTransactionRef tx;
|
|
CCoinControl dummy;
|
|
{
|
|
constexpr int RANDOM_CHANGE_POSITION = -1;
|
|
auto res = CreateTransaction(*wallet, {recipient}, RANDOM_CHANGE_POSITION, dummy);
|
|
BOOST_CHECK(res);
|
|
tx = res->tx;
|
|
}
|
|
wallet->CommitTransaction(tx, {}, {});
|
|
CMutableTransaction blocktx;
|
|
{
|
|
LOCK(wallet->cs_wallet);
|
|
blocktx = CMutableTransaction(*wallet->mapWallet.at(tx->GetHash()).tx);
|
|
}
|
|
CreateAndProcessBlock({CMutableTransaction(blocktx)}, GetScriptForRawPubKey(coinbaseKey.GetPubKey()));
|
|
|
|
LOCK(wallet->cs_wallet);
|
|
wallet->SetLastBlockProcessed(wallet->GetLastBlockHeight() + 1, m_node.chainman->ActiveChain().Tip()->GetBlockHash());
|
|
auto it = wallet->mapWallet.find(tx->GetHash());
|
|
BOOST_CHECK(it != wallet->mapWallet.end());
|
|
it->second.m_state = TxStateConfirmed{m_node.chainman->ActiveChain().Tip()->GetBlockHash(), m_node.chainman->ActiveChain().Height(), /*index=*/1};
|
|
return it->second;
|
|
}
|
|
|
|
std::unique_ptr<CWallet> wallet;
|
|
};
|
|
|
|
BOOST_FIXTURE_TEST_CASE(BasicOutputTypesTest, AvailableCoinsTestingSetup)
|
|
{
|
|
CoinsResult available_coins;
|
|
util::Result<CTxDestination> dest{util::Error{}};
|
|
LOCK(wallet->cs_wallet);
|
|
|
|
// Verify our wallet has one usable coinbase UTXO before starting
|
|
// This UTXO is a P2PK, so it should show up in the Other bucket
|
|
available_coins = AvailableCoins(*wallet);
|
|
BOOST_CHECK_EQUAL(available_coins.size(), 1U);
|
|
BOOST_CHECK_EQUAL(available_coins.other.size(), 1U);
|
|
|
|
// We will create a self transfer for each of the OutputTypes and
|
|
// verify it is put in the correct bucket after running GetAvailablecoins
|
|
//
|
|
// For each OutputType, We expect 2 UTXOs in our wallet following the self transfer:
|
|
// 1. One UTXO as the recipient
|
|
// 2. One UTXO from the change, due to payment address matching logic
|
|
|
|
// Bech32m
|
|
dest = wallet->GetNewDestination(OutputType::BECH32M, "");
|
|
BOOST_ASSERT(dest);
|
|
AddTx(CRecipient{{GetScriptForDestination(*dest)}, 1 * COIN, /*fSubtractFeeFromAmount=*/true});
|
|
available_coins = AvailableCoins(*wallet);
|
|
BOOST_CHECK_EQUAL(available_coins.bech32m.size(), 2U);
|
|
|
|
// Bech32
|
|
dest = wallet->GetNewDestination(OutputType::BECH32, "");
|
|
BOOST_ASSERT(dest);
|
|
AddTx(CRecipient{{GetScriptForDestination(*dest)}, 2 * COIN, /*fSubtractFeeFromAmount=*/true});
|
|
available_coins = AvailableCoins(*wallet);
|
|
BOOST_CHECK_EQUAL(available_coins.bech32.size(), 2U);
|
|
|
|
// P2SH-SEGWIT
|
|
dest = wallet->GetNewDestination(OutputType::P2SH_SEGWIT, "");
|
|
AddTx(CRecipient{{GetScriptForDestination(*dest)}, 3 * COIN, /*fSubtractFeeFromAmount=*/true});
|
|
available_coins = AvailableCoins(*wallet);
|
|
BOOST_CHECK_EQUAL(available_coins.P2SH_segwit.size(), 2U);
|
|
|
|
// Legacy (P2PKH)
|
|
dest = wallet->GetNewDestination(OutputType::LEGACY, "");
|
|
BOOST_ASSERT(dest);
|
|
AddTx(CRecipient{{GetScriptForDestination(*dest)}, 4 * COIN, /*fSubtractFeeFromAmount=*/true});
|
|
available_coins = AvailableCoins(*wallet);
|
|
BOOST_CHECK_EQUAL(available_coins.legacy.size(), 2U);
|
|
}
|
|
|
|
BOOST_AUTO_TEST_SUITE_END()
|
|
} // namespace wallet
|