Fix/refresh unused keys

.github/workflows/tests.yml

@@ -14,14 +14,16 @@ jobs:
       fail-fast: false
     name: JAVA ${{ matrix.distribution }} ${{ matrix.java }} OS ${{ matrix.os }} Gradle ${{ matrix.gradle }}
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
       - name: Set up JDK
-        uses: actions/setup-java@v1
+        uses: actions/setup-java@v4
         with:
+          distribution: 'temurin'
           java-version: ${{ matrix.java }}
       - name: Build bls library
         run: |
-          git submodule update --init --recursive
           cd contrib/dashj-bls
           git apply catch_changes.patch
           mvn package -DskipTests -Dmaven.javadoc.skip=true

core/src/main/java/org/bitcoinj/coinjoin/utils/CoinJoinManager.java

@@ -296,7 +296,8 @@ public void close() {
         if (masternodeGroup != null) {
             masternodeGroup.removePreMessageReceivedEventListener(preMessageReceivedEventListener);
         }
-        // Ensure executor is shut down
+
+        // Shut down the executor before nulling fields — queued tasks may still reference them.
         ExecutorService execToStop = null;
         lock.lock();
         try {
@@ -310,6 +311,8 @@ public void close() {
         if (execToStop != null) {
             execToStop.shutdown();
         }
+        blockChain = null;
+        peerGroup = null;
     }
 
     public boolean isMasternodeOrDisconnectRequested(MasternodeAddress address) {
@@ -547,12 +550,12 @@ public void processTransaction(Transaction tx) {
                 if(!alreadyHave(item)) {
                     getdata.addItem(item);
                 } else {
-                    log.info("coinjoin: DSQUEUE: already has {}", item.hash);
+                    log.debug("coinjoin: DSQUEUE: already has {}", item.hash);
                 }
             }
             if (!getdata.getItems().isEmpty()) {
                 // This will cause us to receive a bunch of block or tx messages.
-                log.info(COINJOIN_EXTRA, "coinjoin: DSQUEUE: requesting {} dsq messages", getdata.getItems().size());
+                log.debug(COINJOIN_EXTRA, "coinjoin: DSQUEUE: requesting {} dsq messages", getdata.getItems().size());
                 getdata.getItems().forEach(
                         inventoryItem -> log.info(COINJOIN_EXTRA, "getdata: {}", inventoryItem.hash));
                 peer.sendMessage(getdata);

core/src/main/java/org/bitcoinj/core/AbstractManager.java

@@ -308,6 +308,9 @@ public void setFilename(String filename) {
         autosaveToFile(new File(filename), DELAY_TIME, TimeUnit.MILLISECONDS, null);
     }
 
+    /**
+     * Typically called when DashSystem is shutting down.
+     */
     public void close() {
         if (vFileManager != null) {
             shutdownAutosaveAndWait();

core/src/main/java/org/bitcoinj/core/DualBlockChain.java

@@ -16,7 +16,9 @@
 
 package org.bitcoinj.core;
 
+import org.bitcoinj.core.listeners.DownloadProgressTracker;
 import org.bitcoinj.store.BlockStoreException;
+import org.bitcoinj.utils.Threading;
 
 import javax.annotation.Nullable;
 
@@ -105,4 +107,56 @@ public StoredBlock getBlock(int height) {
     public StoredBlock getChainHead() {
         return getLongestChain().chainHead;
     }
+
+    PeerGroup peerGroup;
+    MyDownloadProgressTracker downloadProgressTracker;
+
+    private static class MyDownloadProgressTracker extends DownloadProgressTracker {
+        volatile boolean headerDownloadCompleted = false;
+        volatile boolean blockDownloadCompleted = false;
+        MyDownloadProgressTracker(boolean preprocessingBeforeBlocks) {
+            super(preprocessingBeforeBlocks);
+        }
+
+        @Override
+        public void doneHeaderDownload() {
+            super.doneHeaderDownload();
+            headerDownloadCompleted = true;
+        }
+
+        @Override
+        protected void doneDownload() {
+            super.doneDownload();
+            blockDownloadCompleted = true;
+        }
+    }
+
+    public void setPeerGroup(PeerGroup peerGroup, MasternodeSync masternodeSync) {
+        close();
+        if (peerGroup != null) {
+            this.peerGroup = peerGroup;
+            downloadProgressTracker = new MyDownloadProgressTracker(masternodeSync.hasSyncFlag(MasternodeSync.SYNC_FLAGS.SYNC_BLOCKS_AFTER_PREPROCESSING));
+            peerGroup.addHeadersDownloadedEventListener(Threading.USER_THREAD, downloadProgressTracker);
+            peerGroup.addHeadersDownloadStartedEventListener(Threading.USER_THREAD, downloadProgressTracker);
+            peerGroup.addBlocksDownloadedEventListener(Threading.USER_THREAD, downloadProgressTracker);
+            peerGroup.addChainDownloadStartedEventListener(Threading.USER_THREAD, downloadProgressTracker);
+            peerGroup.addMasternodeListDownloadListener(Threading.USER_THREAD, downloadProgressTracker);
+        }
+    }
+
+    public boolean isInitialHeaderSyncComplete() {
+        return downloadProgressTracker != null && (downloadProgressTracker.headerDownloadCompleted || downloadProgressTracker.blockDownloadCompleted);
+    }
+
+    public void close() {
+        if (peerGroup != null && downloadProgressTracker != null) {
+            peerGroup.removeHeadersDownloadedEventListener(downloadProgressTracker);
+            peerGroup.removeHeadersDownloadStartedEventListener(downloadProgressTracker);
+            peerGroup.removeBlocksDownloadedEventListener(downloadProgressTracker);
+            peerGroup.removeChainDownloadStartedEventListener(downloadProgressTracker);
+            peerGroup.removeMasternodeListDownloadedListener(downloadProgressTracker);
+        }
+        peerGroup = null;
+        downloadProgressTracker = null;
+    }
 }

core/src/main/java/org/bitcoinj/core/MasternodeSync.java

@@ -126,6 +126,8 @@ public void close() {
         if (peerGroup != null) {
             peerGroup.removePreMessageReceivedEventListener(preMessageReceivedEventListener);
         }
+        peerGroup = null;
+        blockChain = null;
     }
 
     public MasternodeSync(Context context, boolean isLiteMode, boolean allowInstantSendInLiteMode) {

core/src/main/java/org/bitcoinj/core/PeerGroup.java

@@ -2044,7 +2044,7 @@ protected void handlePeerDeath(final Peer peer, @Nullable Throwable exception) {
                 final Peer newDownloadPeer = selectDownloadPeer(peers);
                 if (newDownloadPeer != null) {
                     setDownloadPeer(newDownloadPeer);
-                    if (downloadListener != null) {
+                    if (downloadListener != null && vRunning) {
                         startBlockChainDownloadFromPeer(newDownloadPeer);
                     }
                 }

core/src/main/java/org/bitcoinj/core/SporkManager.java

@@ -72,6 +72,7 @@ private static void makeSporkDefinition(SporkId sporkId, long defaultValue) {
     @GuardedBy("lock") private final HashMap<SporkId, Long> mapSporksCachedValues;
     @GuardedBy("lock") private final HashSet<KeyId> setSporkPubKeyIds = new HashSet<>();
 
+    private PeerGroup peerGroup;
     private AbstractBlockChain blockChain;
     private MasternodeSync masternodeSync;
     private final Context context;
@@ -91,6 +92,7 @@ public SporkManager(Context context)
     public void setBlockChain(AbstractBlockChain blockChain, @Nullable PeerGroup peerGroup, MasternodeSync masternodeSync) {
         this.blockChain = blockChain;
         this.masternodeSync = masternodeSync;
+        this.peerGroup = peerGroup;
         if (peerGroup != null) {
             peerGroup.addConnectedEventListener(peerConnectedEventListener);
             peerGroup.addPreMessageReceivedEventListener(SAME_THREAD, preMessageReceivedEventListener);
@@ -102,18 +104,23 @@ public void clear() {
         mapSporksByHash.clear();
     }
 
-    public void close(PeerGroup peerGroup) {
+    public void close() {
         if (peerGroup != null) {
             peerGroup.removeConnectedEventListener(peerConnectedEventListener);
             peerGroup.removePreMessageReceivedEventListener(preMessageReceivedEventListener);
         }
+        peerGroup = null;
+        blockChain = null;
+        masternodeSync = null;
     }
 
     void processSpork(Peer from, SporkMessage spork) {
 //        if (context.isLiteMode() && !context.allowInstantXinLiteMode()) {
 //            return; //disable all darksend/masternode related functionality
 //        }
 
+        if (blockChain == null) return; // closed during shutdown
+
         Sha256Hash hash = spork.getHash();
         String logMessage = String.format("SPORK -- hash: %s id: %d (%s) value: %10d bestHeight: %d peer=%s:%d",
                 hash, spork.getSporkId().value, String.format("%1$35s", spork.getSporkId().name()),

core/src/main/java/org/bitcoinj/evolution/AbstractQuorumState.java

@@ -554,7 +554,7 @@ public void removeEventListeners(AbstractBlockChain blockChain, PeerGroup peerGr
             blockChain.removeNewBestBlockListener(newBestBlockListener);
             blockChain.removeReorganizeListener(reorganizeListener);
         }
-         if (peerGroup != null) {
+        if (peerGroup != null) {
             peerGroup.removeConnectedEventListener(peerConnectedEventListener);
             peerGroup.removeChainDownloadStartedEventListener(chainDownloadStartedEventListener);
             peerGroup.removeHeadersDownloadStartedEventListener(headersDownloadStartedEventListener);
@@ -597,6 +597,7 @@ public void notifyNewBestBlock(StoredBlock block) throws VerificationException {
     public final PeerConnectedEventListener peerConnectedEventListener = new PeerConnectedEventListener() {
         @Override
         public void onPeerConnected(Peer peer, int peerCount) {
+            if (peerGroup == null) return; // closed during shutdown
             downloadPeer = peerGroup.getDownloadPeer();
             log.info("peer connected and setting download peer to {} with onPeerConnected", downloadPeer);
         }
@@ -605,6 +606,7 @@ public void onPeerConnected(Peer peer, int peerCount) {
     final PeerDisconnectedEventListener peerDisconnectedEventListener = new PeerDisconnectedEventListener() {
         @Override
         public void onPeerDisconnected(Peer peer, int peerCount) {
+            if (peerGroup == null) return; // closed during shutdown
             if (downloadPeer == peer) {
                 downloadPeer = peerGroup.getDownloadPeer();
                 log.info("setting download peer to {} with onPeerDisconnected, previously was {}", downloadPeer, peer);
@@ -897,5 +899,7 @@ public void close() {
             retryFuture.cancel(true);
             retryFuture = null;
         }
+        peerGroup = null;
+        blockChain = null;
     }
 }

core/src/main/java/org/bitcoinj/evolution/QuorumRotationState.java

@@ -445,13 +445,20 @@ public boolean isSynced() {
         if (blockChain != null && !params.isDIP0024Active(blockChain.getBestChainHeight()))
             return true;
 
-        if(mnListAtH.getHeight() == -1)
+        if (mnListAtH.getHeight() == -1)
             return false;
 
-        if (peerGroup == null)
+        if (blockChain == null)
             return false;
 
-        int mostCommonHeight = peerGroup.getMostCommonHeight();
+        if (!blockChain.isInitialHeaderSyncComplete()) {
+            return false;
+        }
+
+        // Use local chain height instead of peerGroup.getMostCommonHeight() to avoid
+        // acquiring the PeerGroup lock, which can deadlock during shutdown or when the
+        // PeerGroup thread holds it while blocked on SPVBlockStore I/O.
+        int mostCommonHeight = blockChain.getBestChainHeight();
 
         // determine when the last QR height was
         LLMQParameters llmqParameters = params.getLlmqs().get(llmqType);

core/src/main/java/org/bitcoinj/evolution/SimplifiedMasternodeListManager.java

@@ -453,8 +453,9 @@ public void close() {
                 threadPool.shutdownNow(); // Send interrupt signal but don't wait
             }
             saveNow(); // Always save, regardless of thread pool state
+            peerGroup = null;
+            blockChain = null;
             super.close();
-
         }
     }
 

core/src/main/java/org/bitcoinj/governance/GovernanceManager.java

@@ -1719,5 +1719,6 @@ public void close() {
             peerGroup.removeGetDataEventListener(getDataEventListener);
             peerGroup.removePreMessageReceivedEventListener(preMessageReceivedEventListener);
         }
+        peerGroup = null;
     }
 }

core/src/main/java/org/bitcoinj/manager/DashSystem.java

@@ -58,6 +58,7 @@ public class DashSystem {
     public AbstractBlockChain blockChain;
     @Nullable
     public AbstractBlockChain headerChain;
+    DualBlockChain dualBlockChain;
     public SporkManager sporkManager;
     public MasternodePayments masternodePayments;
     public MasternodeSync masternodeSync;
@@ -251,10 +252,13 @@ private void stopLLMQThread() {
         }
     }
 
+    /**
+     * close down DashSystem and free resources, typically called after the PeerGroup is shutdown
+     */
     public void close() {
         if (initializedObjects) {
             log.info("Closing network spork configuration manager");
-            sporkManager.close(peerGroup);
+            sporkManager.close();
             log.info("Closing masternode synchronization state");
             masternodeSync.close();
             log.info("Closing masternode list manager (includes thread pool shutdown)");
@@ -285,6 +289,8 @@ public void close() {
                 log.info("Closing header chain");
                 headerChain.close();
             }
+            log.info("closing dual blockchain");
+            dualBlockChain.close();
             log.info("Clearing peer group reference");
             peerGroup = null;
         }
@@ -295,13 +301,14 @@ public void setPeerGroupAndBlockChain(PeerGroup peerGroup, AbstractBlockChain bl
             this.peerGroup = peerGroup;
             this.blockChain = blockChain;
             this.headerChain = headerChain;
-            DualBlockChain dualBlockChain = new DualBlockChain(headerChain, blockChain);
+            dualBlockChain = new DualBlockChain(headerChain, blockChain);
             hashStore = new HashStore(blockChain.getBlockStore());
             blockChain.addNewBestBlockListener(newBestBlockListener);
             handleActivations(blockChain.getChainHead());
             if (initializedObjects) {
                 sporkManager.setBlockChain(blockChain, peerGroup, masternodeSync);
                 masternodeSync.setBlockChain(blockChain, peerGroup, netFullfilledRequestManager, governanceManager);
+                dualBlockChain.setPeerGroup(peerGroup, masternodeSync);
                 masternodeListManager.setBlockChain(
                         dualBlockChain,
                         peerGroup,

core/src/main/java/org/bitcoinj/quorums/ChainLocksHandler.java

@@ -203,10 +203,12 @@ public void processChainLockSignature(Peer peer, ChainLockSignature clsig)
         processNewChainLock(peer, clsig, hash);
     }
 
-    void processNewChainLock(Peer from, ChainLockSignature clsig, Sha256Hash hash)
-    {
+    void processNewChainLock(Peer from, ChainLockSignature clsig, Sha256Hash hash) {
+        if (blockChain == null) return; // closed during shutdown
+
         lock.lock();
         try {
+            if (blockChain == null) return;   // re-check under lock
             if (seenChainLocks.put(hash, Utils.currentTimeMillis()) != null) {
                 return;
             }

core/src/main/java/org/bitcoinj/quorums/InstantSendManager.java

@@ -132,6 +132,9 @@ public void close(PeerGroup peerGroup) {
         if (chainLocksHandler != null) {
             chainLocksHandler.removeChainLockListener(this.chainLockListener);
         }
+        blockChain = null;
+        peerGroup = null;
+        chainLocksHandler = null;
         wallets.forEach(wallet -> wallet.removeCoinsSentEventListener(coinsSentEventListener));
         try {
             if (!scheduledExecutorService.awaitTermination(3000, TimeUnit.MILLISECONDS)) {