Merge pull request #8924

ffbf9f4 blockchain_and_pool: move to crytonote_core and enforce its usage (jeffro256)
d6f86e5 Avoid nullptr dereference when constructing Blockchain and tx_memory_pool (lukas)

5 files changed, 83 insertions, 21 deletions

diff --git a/src/cryptonote_core/blockchain.h b/src/cryptonote_core/blockchain.h
index a45d3ec60..3ad051fc3 100644
--- a/src/cryptonote_core/blockchain.h
+++ b/src/cryptonote_core/blockchain.h
@@ -113,13 +113,6 @@ namespace cryptonote
     };
 
     /**
-     * @brief Blockchain constructor
-     *
-     * @param tx_pool a reference to the transaction pool to be kept by the Blockchain
-     */
-    Blockchain(tx_memory_pool& tx_pool);
-
-    /**
      * @brief Blockchain destructor
      */
     ~Blockchain();
@@ -1236,6 +1229,13 @@ namespace cryptonote
     mutable rct_ver_cache_t m_rct_ver_cache;
 
     /**
+     * @brief Blockchain constructor
+     *
+     * @param tx_pool a reference to the transaction pool to be kept by the Blockchain
+     */
+    Blockchain(tx_memory_pool& tx_pool);
+
+    /**
      * @brief collects the keys for all outputs being "spent" as an input
      *
      * This function makes sure that each "input" in an input (mixins) exists
@@ -1608,5 +1608,7 @@ namespace cryptonote
      * @param already_generated_coins total coins mined by the network so far
      */
     void send_miner_notifications(uint64_t height, const crypto::hash &seed_hash, const crypto::hash &prev_id, uint64_t already_generated_coins);
+
+    friend class BlockchainAndPool;
   };
 }  // namespace cryptonote
diff --git a/src/cryptonote_core/blockchain_and_pool.h b/src/cryptonote_core/blockchain_and_pool.h
new file mode 100644
index 000000000..c0f607f64
--- /dev/null
+++ b/src/cryptonote_core/blockchain_and_pool.h
@@ -0,0 +1,58 @@
+// Copyright (c) 2023, The Monero Project
+//
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+//
+// 1. Redistributions of source code must retain the above copyright notice,
+// this list of
+//    conditions and the following disclaimer.
+//
+// 2. Redistributions in binary form must reproduce the above copyright notice,
+// this list
+//    of conditions and the following disclaimer in the documentation and/or
+//    other materials provided with the distribution.
+//
+// 3. Neither the name of the copyright holder nor the names of its contributors
+// may be
+//    used to endorse or promote products derived from this software without
+//    specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
+
+#pragma once
+
+#include <memory>
+
+#include "blockchain.h"
+#include "tx_pool.h"
+
+namespace cryptonote
+{
+/**
+ * @brief Container for safely constructing Blockchain and tx_memory_pool classes
+ * 
+ * The reason for this class existing is that the constructors for both Blockchain and
+ * tx_memory_pool take a reference for tx_memory_pool and Blockchain, respectively. Because of this
+ * circular reference, it is annoying/unsafe to construct these normally. This class guarantees that
+ * we don't make any silly mistakes with pointers / dangling references.
+ */
+struct BlockchainAndPool
+{
+    Blockchain blockchain;
+    tx_memory_pool tx_pool;
+  
+    BlockchainAndPool(): blockchain(tx_pool), tx_pool(blockchain) {}
+};
+}
diff --git a/src/cryptonote_core/cryptonote_core.cpp b/src/cryptonote_core/cryptonote_core.cpp
index dd72b3375..a5a59c892 100644
--- a/src/cryptonote_core/cryptonote_core.cpp
+++ b/src/cryptonote_core/cryptonote_core.cpp
@@ -221,8 +221,9 @@ namespace cryptonote
 
   //-----------------------------------------------------------------------------------------------
   core::core(i_cryptonote_protocol* pprotocol):
-              m_mempool(m_blockchain_storage),
-              m_blockchain_storage(m_mempool),
+              m_bap(),
+              m_mempool(m_bap.tx_pool),
+              m_blockchain_storage(m_bap.blockchain),
               m_miner(this, [this](const cryptonote::block &b, uint64_t height, const crypto::hash *seed_hash, unsigned int threads, crypto::hash &hash) {
                 return cryptonote::get_block_longhash(&m_blockchain_storage, b, hash, height, seed_hash, threads);
               }),
diff --git a/src/cryptonote_core/cryptonote_core.h b/src/cryptonote_core/cryptonote_core.h
index e0655dfa2..8108dfae0 100644
--- a/src/cryptonote_core/cryptonote_core.h
+++ b/src/cryptonote_core/cryptonote_core.h
@@ -42,8 +42,7 @@
 #include "cryptonote_protocol/enums.h"
 #include "common/download.h"
 #include "common/command_line.h"
-#include "tx_pool.h"
-#include "blockchain.h"
+#include "blockchain_and_pool.h"
 #include "cryptonote_basic/miner.h"
 #include "cryptonote_basic/connection_context.h"
 #include "warnings.h"
@@ -1098,8 +1097,9 @@ namespace cryptonote
 
      uint64_t m_test_drop_download_height = 0; //!< height under which to drop incoming blocks, if doing so
 
-     tx_memory_pool m_mempool; //!< transaction pool instance
-     Blockchain m_blockchain_storage; //!< Blockchain instance
+     BlockchainAndPool m_bap; //! Contains owned instances of Blockchain and tx_memory_pool
+     tx_memory_pool& m_mempool; //!< ref to transaction pool instance in m_bap
+     Blockchain& m_blockchain_storage; //!< ref to Blockchain instance in m_bap
 
      i_cryptonote_protocol* m_pprotocol; //!< cryptonote protocol instance
 
diff --git a/src/cryptonote_core/tx_pool.h b/src/cryptonote_core/tx_pool.h
index 6fe2eea59..47268efb6 100644
--- a/src/cryptonote_core/tx_pool.h
+++ b/src/cryptonote_core/tx_pool.h
@@ -98,14 +98,6 @@ namespace cryptonote
   {
   public:
     /**
-     * @brief Constructor
-     *
-     * @param bchs a Blockchain class instance, for getting chain info
-     */
-    tx_memory_pool(Blockchain& bchs);
-
-
-    /**
      * @copydoc add_tx(transaction&, tx_verification_context&, bool, bool, uint8_t)
      *
      * @param id the transaction's hash
@@ -489,6 +481,13 @@ namespace cryptonote
   private:
 
     /**
+     * @brief Constructor
+     *
+     * @param bchs a Blockchain class instance, for getting chain info
+     */
+    tx_memory_pool(Blockchain& bchs);
+
+    /**
      * @brief insert key images into m_spent_key_images
      *
      * @return true on success, false on error
@@ -676,6 +675,8 @@ private:
 
     //! Next timestamp that a DB check for relayable txes is allowed
     std::atomic<time_t> m_next_check;
+
+    friend class BlockchainAndPool;
   };
 }