From fa46ac3127142358116c8473741708b3bb70ca15 Mon Sep 17 00:00:00 2001
From: MarcoFalke <falke.marco@gmail.com>
Date: Wed, 10 Apr 2019 15:06:31 -0400
Subject: [PATCH] bench: Add wallet_balance benchmarks

---
 .../bench_bitcoin/bench_bitcoin.vcxproj       |  1 +
 src/Makefile.bench.include                    |  1 +
 src/bench/wallet_balance.cpp                  | 68 +++++++++++++++++++
 src/test/util.cpp                             |  3 +-
 src/test/util.h                               |  4 ++
 5 files changed, 76 insertions(+), 1 deletion(-)
 create mode 100644 src/bench/wallet_balance.cpp

diff --git a/build_msvc/bench_bitcoin/bench_bitcoin.vcxproj b/build_msvc/bench_bitcoin/bench_bitcoin.vcxproj
index 7e27127f155..723e230d3ac 100644
--- a/build_msvc/bench_bitcoin/bench_bitcoin.vcxproj
+++ b/build_msvc/bench_bitcoin/bench_bitcoin.vcxproj
@@ -39,6 +39,7 @@
     <ClCompile Include="..\..\src\bench\rpc_mempool.cpp" />
     <ClCompile Include="..\..\src\bench\merkle_root.cpp" />
     <ClCompile Include="..\..\src\bench\rollingbloom.cpp" />
+    <ClCompile Include="..\..\src\bench\wallet_balance.cpp" />
     <ClCompile Include="..\..\src\bench\verify_script.cpp" />
   </ItemGroup>
   <ItemGroup>
diff --git a/src/Makefile.bench.include b/src/Makefile.bench.include
index d93161a9047..ae7eb19ceb2 100644
--- a/src/Makefile.bench.include
+++ b/src/Makefile.bench.include
@@ -64,6 +64,7 @@ endif
 
 if ENABLE_WALLET
 bench_bench_bitcoin_SOURCES += bench/coin_selection.cpp
+bench_bench_bitcoin_SOURCES += bench/wallet_balance.cpp
 endif
 
 bench_bench_bitcoin_LDADD += $(BOOST_LIBS) $(BDB_LIBS) $(CRYPTO_LIBS) $(EVENT_PTHREADS_LIBS) $(EVENT_LIBS) $(MINIUPNPC_LIBS)
diff --git a/src/bench/wallet_balance.cpp b/src/bench/wallet_balance.cpp
new file mode 100644
index 00000000000..7fd27941641
--- /dev/null
+++ b/src/bench/wallet_balance.cpp
@@ -0,0 +1,68 @@
+// Copyright (c) 2012-2019 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 <bench/bench.h>
+#include <interfaces/chain.h>
+#include <key_io.h>
+#include <optional.h>
+#include <test/util.h>
+#include <validationinterface.h>
+#include <wallet/wallet.h>
+
+struct WalletTestingSetup {
+    std::unique_ptr<interfaces::Chain> m_chain = interfaces::MakeChain();
+    CWallet m_wallet;
+
+    WalletTestingSetup()
+        : m_wallet{m_chain.get(), WalletLocation(), WalletDatabase::CreateMock()}
+    {
+    }
+
+    void handleNotifications()
+    {
+        m_wallet.m_chain_notifications_handler = m_chain->handleNotifications(m_wallet);
+    }
+};
+
+static void WalletBalance(benchmark::State& state, const bool set_dirty, const bool add_watchonly, const bool add_mine)
+{
+    const auto& ADDRESS_WATCHONLY = ADDRESS_BCRT1_UNSPENDABLE;
+
+    WalletTestingSetup wallet_t{};
+    auto& wallet = wallet_t.m_wallet;
+    {
+        bool first_run;
+        if (wallet.LoadWallet(first_run) != DBErrors::LOAD_OK) assert(false);
+        wallet_t.handleNotifications();
+    }
+
+
+    const Optional<std::string> address_mine{add_mine ? Optional<std::string>{getnewaddress(wallet)} : nullopt};
+    if (add_watchonly) importaddress(wallet, ADDRESS_WATCHONLY);
+
+    for (int i = 0; i < 100; ++i) {
+        generatetoaddress(address_mine.get_value_or(ADDRESS_WATCHONLY));
+        generatetoaddress(ADDRESS_WATCHONLY);
+    }
+    SyncWithValidationInterfaceQueue();
+
+    auto bal = wallet.GetBalance(); // Cache
+
+    while (state.KeepRunning()) {
+        if (set_dirty) wallet.MarkDirty();
+        bal = wallet.GetBalance();
+        if (add_mine) assert(bal.m_mine_trusted > 0);
+        if (add_watchonly) assert(bal.m_watchonly_trusted > 0);
+    }
+}
+
+static void WalletBalanceDirty(benchmark::State& state) { WalletBalance(state, /* set_dirty */ true, /* add_watchonly */ true, /* add_mine */ true); }
+static void WalletBalanceClean(benchmark::State& state) { WalletBalance(state, /* set_dirty */ false, /* add_watchonly */ true, /* add_mine */ true); }
+static void WalletBalanceMine(benchmark::State& state) { WalletBalance(state, /* set_dirty */ false, /* add_watchonly */ false, /* add_mine */ true); }
+static void WalletBalanceWatch(benchmark::State& state) { WalletBalance(state, /* set_dirty */ false, /* add_watchonly */ true, /* add_mine */ false); }
+
+BENCHMARK(WalletBalanceDirty, 2500);
+BENCHMARK(WalletBalanceClean, 8000);
+BENCHMARK(WalletBalanceMine, 16000);
+BENCHMARK(WalletBalanceWatch, 8000);
diff --git a/src/test/util.cpp b/src/test/util.cpp
index 7c348c5b257..05d3a97a596 100644
--- a/src/test/util.cpp
+++ b/src/test/util.cpp
@@ -22,6 +22,8 @@
 
 #include <boost/thread.hpp>
 
+const std::string ADDRESS_BCRT1_UNSPENDABLE = "bcrt1qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq3xueyj";
+
 #ifdef ENABLE_WALLET
 std::string getnewaddress(CWallet& w)
 {
@@ -75,7 +77,6 @@ CTxIn MineBlock(const CScript& coinbase_scriptPubKey)
     return CTxIn{block->vtx[0]->GetHash(), 0};
 }
 
-
 std::shared_ptr<CBlock> PrepareBlock(const CScript& coinbase_scriptPubKey)
 {
     auto block = std::make_shared<CBlock>(
diff --git a/src/test/util.h b/src/test/util.h
index e51e924f650..8ba647ec3f2 100644
--- a/src/test/util.h
+++ b/src/test/util.h
@@ -13,6 +13,10 @@ class CScript;
 class CTxIn;
 class CWallet;
 
+// Constants //
+
+extern const std::string ADDRESS_BCRT1_UNSPENDABLE;
+
 // Lower-level utils //
 
 /** Returns the generated coin */