WIP: impl swiftsync in ChainState

Author: rustaceanrob

src/init.cpp

@@ -5,6 +5,7 @@
 
 #include <bitcoin-build-config.h> // IWYU pragma: keep
 
+#include <filesystem>
 #include <init.h>
 
 #include <kernel/checks.h>
@@ -479,6 +480,7 @@ void SetupServerArgs(ArgsManager& argsman, bool can_listen_ipc)
     argsman.AddArg("-alertnotify=<cmd>", "Execute command when an alert is raised (%s in cmd is replaced by message)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
 #endif
     argsman.AddArg("-assumevalid=<hex>", strprintf("If this block is in the chain assume that it and its ancestors are valid and potentially skip their script verification (0 to verify all, default: %s, testnet3: %s, testnet4: %s, signet: %s)", defaultChainParams->GetConsensus().defaultAssumeValid.GetHex(), testnetChainParams->GetConsensus().defaultAssumeValid.GetHex(), testnet4ChainParams->GetConsensus().defaultAssumeValid.GetHex(), signetChainParams->GetConsensus().defaultAssumeValid.GetHex()), ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
+    argsman.AddArg("-utxohints=<file>", "Specify hints of the UTXO set with a hintfile.", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
     argsman.AddArg("-blocksdir=<dir>", "Specify directory to hold blocks subdirectory for *.dat files (default: <datadir>)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
     argsman.AddArg("-blocksxor",
                    strprintf("Whether an XOR-key applies to blocksdir *.dat files. "
@@ -1089,6 +1091,13 @@ bool AppInitParameterInteraction(const ArgsManager& args)
         }
     }
 
+    if (args.IsArgSet("-utxohints")) {
+        fs::path file_path = fs::absolute(args.GetPathArg("-utxohints"));
+        if (!fs::exists(file_path)) {
+            return InitError(Untranslated("Provided UTXO hints file doesn't exist"));
+        }
+    }
+
     // Also report errors from parsing before daemonization
     {
         kernel::Notifications notifications{};

src/kernel/chainstatemanager_opts.h

@@ -5,6 +5,7 @@
 #ifndef BITCOIN_KERNEL_CHAINSTATEMANAGER_OPTS_H
 #define BITCOIN_KERNEL_CHAINSTATEMANAGER_OPTS_H
 
+#include "util/fs.h"
 #include <kernel/notifications_interface.h>
 
 #include <arith_uint256.h>
@@ -15,7 +16,6 @@
 #include <util/time.h>
 
 #include <cstdint>
-#include <functional>
 #include <optional>
 
 class CChainParams;
@@ -32,6 +32,7 @@ namespace kernel {
  */
 struct ChainstateManagerOpts {
     const CChainParams& chainparams;
+    std::optional<fs::path> utxo_hints{};
     fs::path datadir;
     std::optional<int32_t> check_block_index{};
     //! If set, it will override the minimum work we will assume exists on some valid chain.

src/node/chainstatemanager_args.cpp

@@ -69,6 +69,10 @@ util::Result<void> ApplyArgsManOptions(const ArgsManager& args, ChainstateManage
         opts.signature_cache_bytes = clamped_size_each;
     }
 
+    if (args.IsArgSet("-utxohints")) {
+        opts.utxo_hints = fs::absolute(args.GetPathArg("-ibdboosterfile"));
+    }
+
     return {};
 }
 } // namespace node

src/rpc/blockchain.cpp

@@ -39,7 +39,6 @@
 #include <script/descriptor.h>
 #include <serialize.h>
 #include <streams.h>
-#include <swiftsync.h>
 #include <sync.h>
 #include <tinyformat.h>
 #include <txdb.h>

src/swiftsync.cpp

@@ -41,11 +41,6 @@ Hintfile::Hintfile(AutoFile& file) : m_file(file.release())
     m_file >> m_stop_hash;
 }
 
-Hintfile Hintfile::FromExisting(AutoFile& file)
-{
-    return Hintfile(file);
-}
-
 Hintfile::Hintfile(AutoFile& file, const uint256& stop_hash, const uint32_t& stop_height) : m_file(file.release())
 {
     m_file << stop_height;
@@ -94,3 +89,10 @@ bool Hintfile::WriteNextBlock(const std::vector<uint64_t>& unspent_offsets)
     }
     return m_file.Commit();
 }
+
+Context::Context() = default;
+
+void Context::LoadHints(AutoFile& file)
+{
+    m_hintfile.emplace(file);
+}

src/swiftsync.h

@@ -1,5 +1,6 @@
 #include <cstdint>
 #include <hash.h>
+#include <optional>
 #include <primitives/transaction.h>
 #include <streams.h>
 #include <uint256.h>
@@ -51,12 +52,10 @@ class Hintfile
     AutoFile m_file;
     uint256 m_stop_hash;
     uint32_t m_stop_height;
-    Hintfile(AutoFile& file);
     Hintfile(AutoFile& file, const uint256& stop_hash, const uint32_t& stop_height);
 
 public:
-    // Construct a hint file and immediately read the stop hash and height.
-    static Hintfile FromExisting(AutoFile& file);
+    Hintfile(AutoFile& file);
     // Construct a hint file and write the stop hash and height.
     static Hintfile CreateNew(AutoFile& file, const uint256& stop_hash, const uint32_t& stop_height);
     BlockUnspentHints ReadNextBlock();
@@ -65,4 +64,25 @@ class Hintfile
     uint256 StopHash() { return m_stop_hash; };
     uint32_t StopHeight() { return m_stop_height; };
 };
-}
+
+class Context
+{
+private:
+    std::optional<Hintfile> m_hintfile{};
+    Aggregate m_agg{};
+    bool m_connecting_to_genesis{false};
+
+public:
+    Context();
+    bool IsStartBlockGenesis() { return m_connecting_to_genesis; };
+    bool IsActive() { return m_connecting_to_genesis && m_hintfile.has_value(); };
+    void LoadHints(AutoFile& file);
+    void StartBlockIsGenesis() { m_connecting_to_genesis = true; };
+    uint256 StopHash() { return m_hintfile->StopHash(); };
+    uint32_t StopHeight() { return m_hintfile->StopHeight(); };
+    BlockUnspentHints ReadNextBlock() { return m_hintfile->ReadNextBlock(); };
+    void Add(const COutPoint& outpoint) { m_agg.Add(outpoint); };
+    void Spend(const COutPoint& outpoint) { m_agg.Spend(outpoint); };
+    bool EmptySet() { return m_agg.IsZero(); };
+};
+} // namespace swiftsync

src/validation.cpp

@@ -1987,6 +1987,13 @@ void Chainstate::InitCoinsCache(size_t cache_size_bytes)
     m_coins_views->InitCache();
 }
 
+void Chainstate::AddUtxoHints(const fs::path& path)
+{
+    FILE* file{fsbridge::fopen(path, "rb")};
+    AutoFile afile{file};
+    m_swiftsync_ctx.LoadHints(afile);
+}
+
 // Note that though this is marked const, we may end up modifying `m_cached_finished_ibd`, which
 // is a performance-related implementation detail. This function must be marked
 // `const` so that `CValidationInterface` clients (which are given a `const Chainstate*`)
@@ -2417,6 +2424,7 @@ bool Chainstate::ConnectBlock(const CBlock& block, BlockValidationState& state,
     // Special case for the genesis block, skipping connection of its transactions
     // (its coinbase is unspendable)
     if (block_hash == params.GetConsensus().hashGenesisBlock) {
+        m_swiftsync_ctx.StartBlockIsGenesis();
         if (!fJustCheck)
             view.SetBestBlock(pindex->GetBlockHash());
         return true;
@@ -5668,6 +5676,9 @@ Chainstate& ChainstateManager::InitializeChainstate(CTxMemPool* mempool)
     assert(!m_active_chainstate);
 
     m_ibd_chainstate = std::make_unique<Chainstate>(mempool, m_blockman, *this);
+    if (m_options.utxo_hints) {
+        m_ibd_chainstate->AddUtxoHints(m_options.utxo_hints.value());
+    }
     m_active_chainstate = m_ibd_chainstate.get();
     return *m_active_chainstate;
 }

src/validation.h

@@ -25,6 +25,7 @@
 #include <script/sigcache.h>
 #include <script/verify_flags.h>
 #include <sync.h>
+#include <swiftsync.h>
 #include <txdb.h>
 #include <txmempool.h>
 #include <uint256.h>
@@ -563,6 +564,8 @@ class Chainstate
 
     std::optional<const char*> m_last_script_check_reason_logged GUARDED_BY(::cs_main){};
 
+    swiftsync::Context m_swiftsync_ctx {};
+
 public:
     //! Reference to a BlockManager instance which itself is shared across all
     //! Chainstate instances.
@@ -792,6 +795,8 @@ class Chainstate
 
     std::string ToString() EXCLUSIVE_LOCKS_REQUIRED(::cs_main);
 
+    void AddUtxoHints(const fs::path& path);
+
     //! Indirection necessary to make lock annotations work with an optional mempool.
     RecursiveMutex* MempoolMutex() const LOCK_RETURNED(m_mempool->cs)
     {