From 838647802024ca1bbc9458a17f8ed16aed98e5ed Mon Sep 17 00:00:00 2001 From: Dimitrios Siganos Date: Wed, 30 Mar 2022 20:58:14 +0100 Subject: [PATCH] Add function comment for function nano::upgrade_epoch. (#3772) --- nano/test_common/system.cpp | 3 +++ 1 file changed, 3 insertions(+) diff --git a/nano/test_common/system.cpp b/nano/test_common/system.cpp index 081591fe5..7e955afe1 100644 --- a/nano/test_common/system.cpp +++ b/nano/test_common/system.cpp @@ -209,6 +209,9 @@ uint64_t nano::system::work_generate_limited (nano::block_hash const & root_a, u return result; } +/** Initiate an epoch upgrade. Writes the epoch block into the ledger and leaves it to + * node background processes (e.g. frontiers confirmation) to cement the block. + */ std::unique_ptr nano::upgrade_epoch (nano::work_pool & pool_a, nano::ledger & ledger_a, nano::epoch epoch_a) { auto transaction (ledger_a.store.tx_begin_write ());