Suggested interfaces::Chain cleanups from #15288

Mostly documentation improvements requested in the last review of #15288 before
it was merged
(https://github.com/bitcoin/bitcoin/pull/15288#pullrequestreview-210241864)

1 files changed, 30 insertions, 8 deletions

diff --git a/src/interfaces/chain.h b/src/interfaces/chain.h
index 60f8570e36..037e8e9ff5 100644
--- a/src/interfaces/chain.h
+++ b/src/interfaces/chain.h
@@ -6,7 +6,6 @@
 #define BITCOIN_INTERFACES_CHAIN_H
 
 #include <optional.h>               // For Optional and nullopt
-#include <policy/rbf.h>             // For RBFTransactionState
 #include <primitives/transaction.h> // For CTransactionRef
 
 #include <memory>
@@ -16,9 +15,11 @@
 #include <vector>
 
 class CBlock;
+class CFeeRate;
 class CScheduler;
 class CValidationState;
 class uint256;
+enum class RBFTransactionState;
 struct CBlockLocator;
 struct FeeCalculation;
 
@@ -26,7 +27,27 @@ namespace interfaces {
 
 class Wallet;
 
-//! Interface for giving wallet processes access to blockchain state.
+//! Interface giving clients (wallet processes, maybe other analysis tools in
+//! the future) ability to access to the chain state, receive notifications,
+//! estimate fees, and submit transactions.
+//!
+//! TODO: Current chain methods are too low level, exposing too much of the
+//! internal workings of the bitcoin node, and not being very convenient to use.
+//! Chain methods should be cleaned up and simplified over time. Examples:
+//!
+//! * The Chain::lock() method, which lets clients delay chain tip updates
+//!   should be removed when clients are able to respond to updates
+//!   asynchronously
+//!   (https://github.com/bitcoin/bitcoin/pull/10973#issuecomment-380101269).
+//!
+//! * The relayTransactions() and submitToMemoryPool() methods could be replaced
+//!   with a higher-level broadcastTransaction method
+//!   (https://github.com/bitcoin/bitcoin/pull/14978#issuecomment-459373984).
+//!
+//! * The initMessages() and loadWallet() methods which the wallet uses to send
+//!   notifications to the GUI should go away when GUI and wallet can directly
+//!   communicate with each other without going through the node
+//!   (https://github.com/bitcoin/bitcoin/pull/15288#discussion_r253321096).
 class Chain
 {
 public:
@@ -114,8 +135,9 @@ public:
         virtual bool checkFinalTx(const CTransaction& tx) = 0;
 
         //! Add transaction to memory pool if the transaction fee is below the
-        //! amount specified by absurd_fee (as a safeguard). */
-        virtual bool submitToMemoryPool(CTransactionRef tx, CAmount absurd_fee, CValidationState& state) = 0;
+        //! amount specified by absurd_fee. Returns false if the transaction
+        //! could not be added due to the fee or for another reason.
+        virtual bool submitToMemoryPool(const CTransactionRef& tx, CAmount absurd_fee, CValidationState& state) = 0;
     };
 
     //! Return Lock interface. Chain is locked when this is called, and
@@ -154,8 +176,8 @@ public:
     //! Calculate mempool ancestor and descendant counts for the given transaction.
     virtual void getTransactionAncestry(const uint256& txid, size_t& ancestors, size_t& descendants) = 0;
 
-    //! Check chain limits.
-    virtual bool checkChainLimits(CTransactionRef tx) = 0;
+    //! Check if transaction will pass the mempool's chain limits.
+    virtual bool checkChainLimits(const CTransactionRef& tx) = 0;
 
     //! Estimate smart fee.
     virtual CFeeRate estimateSmartFee(int num_blocks, bool conservative, FeeCalculation* calc = nullptr) = 0;
@@ -163,10 +185,10 @@ public:
     //! Fee estimator max target.
     virtual unsigned int estimateMaxBlocks() = 0;
 
-    //! Pool min fee.
+    //! Mempool minimum fee.
     virtual CFeeRate mempoolMinFee() = 0;
 
-    //! Get node max tx fee setting (-maxtxfee).
+    //! Node max tx fee setting (-maxtxfee).
     //! This could be replaced by a per-wallet max fee, as proposed at
     //! https://github.com/bitcoin/bitcoin/issues/15355
     //! But for the time being, wallets call this to access the node setting.