ChainTip: add JavaDoc to findActiveChainTip

ConsensusJ · Sep 26, 2023 · 624bc50 · 624bc50
1 parent 5e6b909
commit 624bc50
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/cj-btc-json/src/main/java/org/consensusj/bitcoin/json/pojo/ChainTip.java b/cj-btc-json/src/main/java/org/consensusj/bitcoin/json/pojo/ChainTip.java
@@ -44,6 +44,11 @@ public String getStatus() {
         return status;
     }
 
+    /**
+     * Find the active chain tip if there is one
+     * @param chainTips the list to search
+     * @return non-empty optional if active is found, empty optional if not found
+     */
     public static Optional<ChainTip> findActiveChainTip(List<ChainTip> chainTips) {
         return chainTips.stream().filter(tip -> tip.getStatus().equals("active")).findFirst();
     }