doc: Fix CWalletTx::Confirmation doc

MarcoFalke · MarcoFalke · commit fa8fef6ef228 · 2021-10-21T22:13:35.000+02:00
Follow-up to: * commit 700c42b, which replaced pIndex with block_hash in AddToWalletIfInvolvingMe. * commit 9700fcb, which replaced posInBlock with confirm.nIndex.
diff --git a/src/wallet/transaction.h b/src/wallet/transaction.h
@@ -162,7 +162,8 @@ class CWalletTx
         int block_height;
         uint256 hashBlock;
         int nIndex;
-        Confirmation(Status s = UNCONFIRMED, int b = 0, uint256 h = uint256(), int i = 0) : status(s), block_height(b), hashBlock(h), nIndex(i) {}
+        Confirmation(Status status = UNCONFIRMED, int block_height = 0, uint256 block_hash = uint256(), int block_index = 0)
+            : status{status}, block_height{block_height}, hashBlock{block_hash}, nIndex{block_index} {}
     };
 
     Confirmation m_confirm;
diff --git a/src/wallet/wallet.cpp b/src/wallet/wallet.cpp
@@ -1212,7 +1212,7 @@ void CWallet::SyncTransaction(const CTransactionRef& ptx, CWalletTx::Confirmatio
 
 void CWallet::transactionAddedToMempool(const CTransactionRef& tx, uint64_t mempool_sequence) {
     LOCK(cs_wallet);
-    SyncTransaction(tx, {CWalletTx::Status::UNCONFIRMED, /* block height */ 0, /* block hash */ {}, /* index */ 0});
+    SyncTransaction(tx, {CWalletTx::Status::UNCONFIRMED, /*block_height=*/0, /*block_hash=*/{}, /*block_index=*/0});
 
     auto it = mapWallet.find(tx->GetHash());
     if (it != mapWallet.end()) {
@@ -1253,7 +1253,7 @@ void CWallet::transactionRemovedFromMempool(const CTransactionRef& tx, MemPoolRe
         // distinguishing between conflicted and unconfirmed transactions are
         // imperfect, and could be improved in general, see
         // https://github.com/bitcoin-core/bitcoin-devwiki/wiki/Wallet-Transaction-Conflict-Tracking
-        SyncTransaction(tx, {CWalletTx::Status::UNCONFIRMED, /* block height */ 0, /* block hash */ {}, /* index */ 0});
+        SyncTransaction(tx, {CWalletTx::Status::UNCONFIRMED, /*block_height=*/0, /*block_hash=*/{}, /*block_index=*/0});
     }
 }
 
@@ -1281,7 +1281,7 @@ void CWallet::blockDisconnected(const CBlock& block, int height)
     m_last_block_processed_height = height - 1;
     m_last_block_processed = block.hashPrevBlock;
     for (const CTransactionRef& ptx : block.vtx) {
-        SyncTransaction(ptx, {CWalletTx::Status::UNCONFIRMED, /* block height */ 0, /* block hash */ {}, /* index */ 0});
+        SyncTransaction(ptx, {CWalletTx::Status::UNCONFIRMED, /*block_height=*/0, /*block_hash=*/{}, /*block_index=*/0});
     }
 }
 
diff --git a/src/wallet/wallet.h b/src/wallet/wallet.h
@@ -260,17 +260,17 @@ class CWallet final : public WalletStorage, public interfaces::Chain::Notificati
     void AddToSpends(const uint256& wtxid, WalletBatch* batch = nullptr) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
 
     /**
-     * Add a transaction to the wallet, or update it.  pIndex and posInBlock should
+     * Add a transaction to the wallet, or update it.  confirm.block_* should
      * be set when the transaction was known to be included in a block.  When
-     * pIndex == nullptr, then wallet state is not updated in AddToWallet, but
+     * block_hash.IsNull(), then wallet state is not updated in AddToWallet, but
      * notifications happen and cached balances are marked dirty.
      *
      * If fUpdate is true, existing transactions will be updated.
      * TODO: One exception to this is that the abandoned state is cleared under the
      * assumption that any further notification of a transaction that was considered
      * abandoned is an indication that it is not safe to be considered abandoned.
      * Abandoned state should probably be more carefully tracked via different
-     * posInBlock signals or by checking mempool presence when necessary.
+     * chain notifications or by checking mempool presence when necessary.
      *
      * Should be called with rescanning_old_block set to true, if the transaction is
      * not discovered in real time, but during a rescan of old blocks.
@@ -285,8 +285,6 @@ class CWallet final : public WalletStorage, public interfaces::Chain::Notificati
 
     void SyncMetaData(std::pair<TxSpends::iterator, TxSpends::iterator>) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
 
-    /* Used by TransactionAddedToMemorypool/BlockConnected/Disconnected/ScanForWalletTransactions.
-     * Should be called with non-zero block_hash and posInBlock if this is for a transaction that is included in a block. */
     void SyncTransaction(const CTransactionRef& tx, CWalletTx::Confirmation confirm, bool update_tx = true, bool rescanning_old_block = false) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
 
     /** WalletFlags set on this wallet. */

Original file line number	Diff line number	Diff line change
`@@ -1212,7 +1212,7 @@ void CWallet::SyncTransaction(const CTransactionRef& ptx, CWalletTx::Confirmatio`
`1212`	`1212`
`1213`	`1213`	`void CWallet::transactionAddedToMempool(const CTransactionRef& tx, uint64_t mempool_sequence) {`
`1214`	`1214`	`LOCK(cs_wallet);`
`1215`		`- SyncTransaction(tx, {CWalletTx::Status::UNCONFIRMED, /* block height / 0, / block hash / {}, / index */ 0});`
	`1215`	`+ SyncTransaction(tx, {CWalletTx::Status::UNCONFIRMED, /block_height=/0, /block_hash=/{}, /block_index=/0});`
`1216`	`1216`
`1217`	`1217`	`auto it = mapWallet.find(tx->GetHash());`
`1218`	`1218`	`if (it != mapWallet.end()) {`
`@@ -1253,7 +1253,7 @@ void CWallet::transactionRemovedFromMempool(const CTransactionRef& tx, MemPoolRe`
`1253`	`1253`	`// distinguishing between conflicted and unconfirmed transactions are`
`1254`	`1254`	`// imperfect, and could be improved in general, see`
`1255`	`1255`	`// https://github.com/bitcoin-core/bitcoin-devwiki/wiki/Wallet-Transaction-Conflict-Tracking`
`1256`		`- SyncTransaction(tx, {CWalletTx::Status::UNCONFIRMED, /* block height / 0, / block hash / {}, / index */ 0});`
	`1256`	`+ SyncTransaction(tx, {CWalletTx::Status::UNCONFIRMED, /block_height=/0, /block_hash=/{}, /block_index=/0});`
`1257`	`1257`	`}`
`1258`	`1258`	`}`
`1259`	`1259`
`@@ -1281,7 +1281,7 @@ void CWallet::blockDisconnected(const CBlock& block, int height)`
`1281`	`1281`	`m_last_block_processed_height = height - 1;`
`1282`	`1282`	`m_last_block_processed = block.hashPrevBlock;`
`1283`	`1283`	`for (const CTransactionRef& ptx : block.vtx) {`
`1284`		`- SyncTransaction(ptx, {CWalletTx::Status::UNCONFIRMED, /* block height / 0, / block hash / {}, / index */ 0});`
	`1284`	`+ SyncTransaction(ptx, {CWalletTx::Status::UNCONFIRMED, /block_height=/0, /block_hash=/{}, /block_index=/0});`
`1285`	`1285`	`}`
`1286`	`1286`	`}`
`1287`	`1287`