Pass block height in Chain::BlockConnected/Chain::BlockDisconnected

Antoine Riard · Antoine Riard · commit 10b4729e33f7 · 2019-11-05T12:59:16.000-05:00
To do so we update CValidationInterface::BlockDisconnect to take a
CBlockIndex pointing to the block being disconnected.

This new parameter will be use in the following commit to establish
wallet height.
diff --git a/src/interfaces/chain.cpp b/src/interfaces/chain.cpp
@@ -182,11 +182,11 @@ class NotificationsHandlerImpl : public Handler, CValidationInterface
         const CBlockIndex* index,
         const std::vector<CTransactionRef>& tx_conflicted) override
     {
-        m_notifications->BlockConnected(*block, tx_conflicted);
+        m_notifications->BlockConnected(*block, tx_conflicted, index->nHeight);
     }
-    void BlockDisconnected(const std::shared_ptr<const CBlock>& block) override
+    void BlockDisconnected(const std::shared_ptr<const CBlock>& block, const CBlockIndex* index) override
     {
-        m_notifications->BlockDisconnected(*block);
+        m_notifications->BlockDisconnected(*block, index->nHeight);
     }
     void UpdatedBlockTip(const CBlockIndex* index, const CBlockIndex* fork_index, bool is_ibd) override
     {
diff --git a/src/interfaces/chain.h b/src/interfaces/chain.h
@@ -226,8 +226,8 @@ class Chain
         virtual ~Notifications() {}
         virtual void TransactionAddedToMempool(const CTransactionRef& tx) {}
         virtual void TransactionRemovedFromMempool(const CTransactionRef& ptx) {}
-        virtual void BlockConnected(const CBlock& block, const std::vector<CTransactionRef>& tx_conflicted) {}
-        virtual void BlockDisconnected(const CBlock& block) {}
+        virtual void BlockConnected(const CBlock& block, const std::vector<CTransactionRef>& tx_conflicted, int height) {}
+        virtual void BlockDisconnected(const CBlock& block, int height) {}
         virtual void UpdatedBlockTip() {}
         virtual void ChainStateFlushed(const CBlockLocator& locator) {}
     };
diff --git a/src/test/validation_block_tests.cpp b/src/test/validation_block_tests.cpp
@@ -40,9 +40,10 @@ struct TestSubscriber : public CValidationInterface {
         m_expected_tip = block->GetHash();
     }
 
-    void BlockDisconnected(const std::shared_ptr<const CBlock>& block) override
+    void BlockDisconnected(const std::shared_ptr<const CBlock>& block, const CBlockIndex* pindex) override
     {
         BOOST_CHECK_EQUAL(m_expected_tip, block->GetHash());
+        BOOST_CHECK_EQUAL(m_expected_tip, pindex->GetBlockHash());
 
         m_expected_tip = block->hashPrevBlock;
     }
diff --git a/src/validation.cpp b/src/validation.cpp
@@ -2435,7 +2435,7 @@ bool CChainState::DisconnectTip(BlockValidationState& state, const CChainParams&
     UpdateTip(pindexDelete->pprev, chainparams);
     // Let wallets know transactions went from 1-confirmed to
     // 0-confirmed or conflicted:
-    GetMainSignals().BlockDisconnected(pblock);
+    GetMainSignals().BlockDisconnected(pblock, pindexDelete);
     return true;
 }
 
diff --git a/src/validationinterface.cpp b/src/validationinterface.cpp
@@ -29,7 +29,7 @@ struct MainSignalsInstance {
     boost::signals2::signal<void (const CBlockIndex *, const CBlockIndex *, bool fInitialDownload)> UpdatedBlockTip;
     boost::signals2::signal<void (const CTransactionRef &)> TransactionAddedToMempool;
     boost::signals2::signal<void (const std::shared_ptr<const CBlock> &, const CBlockIndex *pindex, const std::vector<CTransactionRef>&)> BlockConnected;
-    boost::signals2::signal<void (const std::shared_ptr<const CBlock> &)> BlockDisconnected;
+    boost::signals2::signal<void (const std::shared_ptr<const CBlock>&, const CBlockIndex* pindex)> BlockDisconnected;
     boost::signals2::signal<void (const CTransactionRef &)> TransactionRemovedFromMempool;
     boost::signals2::signal<void (const CBlockLocator &)> ChainStateFlushed;
     boost::signals2::signal<void (const CBlock&, const BlockValidationState&)> BlockChecked;
@@ -92,7 +92,7 @@ void RegisterValidationInterface(CValidationInterface* pwalletIn) {
     conns.UpdatedBlockTip = g_signals.m_internals->UpdatedBlockTip.connect(std::bind(&CValidationInterface::UpdatedBlockTip, pwalletIn, std::placeholders::_1, std::placeholders::_2, std::placeholders::_3));
     conns.TransactionAddedToMempool = g_signals.m_internals->TransactionAddedToMempool.connect(std::bind(&CValidationInterface::TransactionAddedToMempool, pwalletIn, std::placeholders::_1));
     conns.BlockConnected = g_signals.m_internals->BlockConnected.connect(std::bind(&CValidationInterface::BlockConnected, pwalletIn, std::placeholders::_1, std::placeholders::_2, std::placeholders::_3));
-    conns.BlockDisconnected = g_signals.m_internals->BlockDisconnected.connect(std::bind(&CValidationInterface::BlockDisconnected, pwalletIn, std::placeholders::_1));
+    conns.BlockDisconnected = g_signals.m_internals->BlockDisconnected.connect(std::bind(&CValidationInterface::BlockDisconnected, pwalletIn, std::placeholders::_1, std::placeholders::_2));
     conns.TransactionRemovedFromMempool = g_signals.m_internals->TransactionRemovedFromMempool.connect(std::bind(&CValidationInterface::TransactionRemovedFromMempool, pwalletIn, std::placeholders::_1));
     conns.ChainStateFlushed = g_signals.m_internals->ChainStateFlushed.connect(std::bind(&CValidationInterface::ChainStateFlushed, pwalletIn, std::placeholders::_1));
     conns.BlockChecked = g_signals.m_internals->BlockChecked.connect(std::bind(&CValidationInterface::BlockChecked, pwalletIn, std::placeholders::_1, std::placeholders::_2));
@@ -156,9 +156,10 @@ void CMainSignals::BlockConnected(const std::shared_ptr<const CBlock> &pblock, c
     });
 }
 
-void CMainSignals::BlockDisconnected(const std::shared_ptr<const CBlock> &pblock) {
-    m_internals->m_schedulerClient.AddToProcessQueue([pblock, this] {
-        m_internals->BlockDisconnected(pblock);
+void CMainSignals::BlockDisconnected(const std::shared_ptr<const CBlock>& pblock, const CBlockIndex* pindex)
+{
+    m_internals->m_schedulerClient.AddToProcessQueue([pblock, pindex, this] {
+        m_internals->BlockDisconnected(pblock, pindex);
     });
 }
 
diff --git a/src/validationinterface.h b/src/validationinterface.h
@@ -114,7 +114,7 @@ class CValidationInterface {
      *
      * Called on a background thread.
      */
-    virtual void BlockDisconnected(const std::shared_ptr<const CBlock> &block) {}
+    virtual void BlockDisconnected(const std::shared_ptr<const CBlock> &block, const CBlockIndex* pindex) {}
     /**
      * Notifies listeners of the new active block chain on-disk.
      *
@@ -178,7 +178,7 @@ class CMainSignals {
     void UpdatedBlockTip(const CBlockIndex *, const CBlockIndex *, bool fInitialDownload);
     void TransactionAddedToMempool(const CTransactionRef &);
     void BlockConnected(const std::shared_ptr<const CBlock> &, const CBlockIndex *pindex, const std::shared_ptr<const std::vector<CTransactionRef>> &);
-    void BlockDisconnected(const std::shared_ptr<const CBlock> &);
+    void BlockDisconnected(const std::shared_ptr<const CBlock> &, const CBlockIndex* pindex);
     void ChainStateFlushed(const CBlockLocator &);
     void BlockChecked(const CBlock&, const BlockValidationState&);
     void NewPoWValidBlock(const CBlockIndex *, const std::shared_ptr<const CBlock>&);
diff --git a/src/wallet/wallet.cpp b/src/wallet/wallet.cpp
@@ -1052,7 +1052,8 @@ void CWallet::TransactionRemovedFromMempool(const CTransactionRef &ptx) {
     }
 }
 
-void CWallet::BlockConnected(const CBlock& block, const std::vector<CTransactionRef>& vtxConflicted) {
+void CWallet::BlockConnected(const CBlock& block, const std::vector<CTransactionRef>& vtxConflicted, int height)
+{
     const uint256& block_hash = block.GetHash();
     auto locked_chain = chain().lock();
     LOCK(cs_wallet);
@@ -1068,7 +1069,8 @@ void CWallet::BlockConnected(const CBlock& block, const std::vector<CTransaction
     m_last_block_processed = block_hash;
 }
 
-void CWallet::BlockDisconnected(const CBlock& block) {
+void CWallet::BlockDisconnected(const CBlock& block, int height)
+{
     auto locked_chain = chain().lock();
     LOCK(cs_wallet);
 
diff --git a/src/wallet/wallet.h b/src/wallet/wallet.h
@@ -855,8 +855,8 @@ class CWallet final : public WalletStorage, private interfaces::Chain::Notificat
     bool AddToWallet(const CWalletTx& wtxIn, bool fFlushOnClose=true);
     void LoadToWallet(CWalletTx& wtxIn) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
     void TransactionAddedToMempool(const CTransactionRef& tx) override;
-    void BlockConnected(const CBlock& block, const std::vector<CTransactionRef>& vtxConflicted) override;
-    void BlockDisconnected(const CBlock& block) override;
+    void BlockConnected(const CBlock& block, const std::vector<CTransactionRef>& vtxConflicted, int height) override;
+    void BlockDisconnected(const CBlock& block, int height) override;
     void UpdatedBlockTip() override;
     int64_t RescanFromTime(int64_t startTime, const WalletRescanReserver& reserver, bool update);
 
diff --git a/src/zmq/zmqnotificationinterface.cpp b/src/zmq/zmqnotificationinterface.cpp
@@ -185,7 +185,7 @@ void CZMQNotificationInterface::BlockConnected(const std::shared_ptr<const CBloc
     }
 }
 
-void CZMQNotificationInterface::BlockDisconnected(const std::shared_ptr<const CBlock>& pblock)
+void CZMQNotificationInterface::BlockDisconnected(const std::shared_ptr<const CBlock>& pblock, const CBlockIndex* pindexDisconnected)
 {
     for (const CTransactionRef& ptx : pblock->vtx) {
         // Do a normal notify for each transaction removed in block disconnection
diff --git a/src/zmq/zmqnotificationinterface.h b/src/zmq/zmqnotificationinterface.h
@@ -27,7 +27,7 @@ class CZMQNotificationInterface final : public CValidationInterface
     // CValidationInterface
     void TransactionAddedToMempool(const CTransactionRef& tx) override;
     void BlockConnected(const std::shared_ptr<const CBlock>& pblock, const CBlockIndex* pindexConnected, const std::vector<CTransactionRef>& vtxConflicted) override;
-    void BlockDisconnected(const std::shared_ptr<const CBlock>& pblock) override;
+    void BlockDisconnected(const std::shared_ptr<const CBlock>& pblock, const CBlockIndex* pindexDisconnected) override;
     void UpdatedBlockTip(const CBlockIndex *pindexNew, const CBlockIndex *pindexFork, bool fInitialDownload) override;
 
 private:

Original file line number	Diff line number	Diff line change
`@@ -182,11 +182,11 @@ class NotificationsHandlerImpl : public Handler, CValidationInterface`
`182`	`182`	`const CBlockIndex* index,`
`183`	`183`	`const std::vector<CTransactionRef>& tx_conflicted) override`
`184`	`184`	`{`
`185`		`- m_notifications->BlockConnected(*block, tx_conflicted);`
	`185`	`+ m_notifications->BlockConnected(*block, tx_conflicted, index->nHeight);`
`186`	`186`	`}`
`187`		`- void BlockDisconnected(const std::shared_ptr<const CBlock>& block) override`
	`187`	`+ void BlockDisconnected(const std::shared_ptr<const CBlock>& block, const CBlockIndex* index) override`
`188`	`188`	`{`
`189`		`- m_notifications->BlockDisconnected(*block);`
	`189`	`+ m_notifications->BlockDisconnected(*block, index->nHeight);`
`190`	`190`	`}`
`191`	`191`	`void UpdatedBlockTip(const CBlockIndex* index, const CBlockIndex* fork_index, bool is_ibd) override`
`192`	`192`	`{`
Original file line number	Diff line number	Diff line change
`@@ -40,9 +40,10 @@ struct TestSubscriber : public CValidationInterface {`
`40`	`40`	`m_expected_tip = block->GetHash();`
`41`	`41`	`}`
`42`	`42`
`43`		`- void BlockDisconnected(const std::shared_ptr<const CBlock>& block) override`
	`43`	`+ void BlockDisconnected(const std::shared_ptr<const CBlock>& block, const CBlockIndex* pindex) override`
`44`	`44`	`{`
`45`	`45`	`BOOST_CHECK_EQUAL(m_expected_tip, block->GetHash());`
	`46`	`+ BOOST_CHECK_EQUAL(m_expected_tip, pindex->GetBlockHash());`
`46`	`47`
`47`	`48`	`m_expected_tip = block->hashPrevBlock;`
`48`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2435,7 +2435,7 @@ bool CChainState::DisconnectTip(BlockValidationState& state, const CChainParams&`
`2435`	`2435`	`UpdateTip(pindexDelete->pprev, chainparams);`
`2436`	`2436`	`// Let wallets know transactions went from 1-confirmed to`
`2437`	`2437`	`// 0-confirmed or conflicted:`
`2438`		`- GetMainSignals().BlockDisconnected(pblock);`
	`2438`	`+ GetMainSignals().BlockDisconnected(pblock, pindexDelete);`
`2439`	`2439`	`return true;`
`2440`	`2440`	`}`
`2441`	`2441`
Original file line number	Diff line number	Diff line change
`@@ -1052,7 +1052,8 @@ void CWallet::TransactionRemovedFromMempool(const CTransactionRef &ptx) {`
`1052`	`1052`	`}`
`1053`	`1053`	`}`
`1054`	`1054`
`1055`		`-void CWallet::BlockConnected(const CBlock& block, const std::vector<CTransactionRef>& vtxConflicted) {`
	`1055`	`+void CWallet::BlockConnected(const CBlock& block, const std::vector<CTransactionRef>& vtxConflicted, int height)`
	`1056`	`+{`
`1056`	`1057`	`const uint256& block_hash = block.GetHash();`
`1057`	`1058`	`auto locked_chain = chain().lock();`
`1058`	`1059`	`LOCK(cs_wallet);`
`@@ -1068,7 +1069,8 @@ void CWallet::BlockConnected(const CBlock& block, const std::vector<CTransaction`
`1068`	`1069`	`m_last_block_processed = block_hash;`
`1069`	`1070`	`}`
`1070`	`1071`
`1071`		`-void CWallet::BlockDisconnected(const CBlock& block) {`
	`1072`	`+void CWallet::BlockDisconnected(const CBlock& block, int height)`
	`1073`	`+{`
`1072`	`1074`	`auto locked_chain = chain().lock();`
`1073`	`1075`	`LOCK(cs_wallet);`
`1074`	`1076`
Original file line number	Diff line number	Diff line change
`@@ -185,7 +185,7 @@ void CZMQNotificationInterface::BlockConnected(const std::shared_ptr<const CBloc`
`185`	`185`	`}`
`186`	`186`	`}`
`187`	`187`
`188`		`-void CZMQNotificationInterface::BlockDisconnected(const std::shared_ptr<const CBlock>& pblock)`
	`188`	`+void CZMQNotificationInterface::BlockDisconnected(const std::shared_ptr<const CBlock>& pblock, const CBlockIndex* pindexDisconnected)`
`189`	`189`	`{`
`190`	`190`	`for (const CTransactionRef& ptx : pblock->vtx) {`
`191`	`191`	`// Do a normal notify for each transaction removed in block disconnection`