Feature/powpeg validation protocol integration

src/main/java/co/rsk/federate/BtcToRskClient.java

@@ -111,24 +111,26 @@ public synchronized void setup(
     public void start(Federation federation) {
         logger.info("[start] Starting for Federation {}", federation.getAddress());
         this.federation = federation;
+
         FederationMember federator = federatorSupport.getFederationMember();
         boolean isMember = federation.isMember(federator);
-
         if (!isMember) {
-            logger.info("[start] member {} is no part of the federation {} ",
+            String message = String.format(
+                "Member %s is no part of the federation %s",
                 federator.getBtcPublicKey(),
                 federation.getAddress());
-            return;
+            logger.error("[start] {}", message);
+            throw new IllegalStateException(message);
         }
 
         logger.info("[start] {} is member of the federation {}",
             federator.getBtcPublicKey(), federation.getAddress());
         logger.info("[start] Watching federation {} since I belong to it",
             federation.getAddress());
         bitcoinWrapper.addFederationListener(federation, this);
+
         Optional<Integer> federatorIndex = federation.getBtcPublicKeyIndex(
-            federatorSupport.getFederationMember().getBtcPublicKey()
-        );
+            federatorSupport.getFederationMember().getBtcPublicKey());
         if (!federatorIndex.isPresent()) {
             String message = String.format(
                 "Federator %s is a member of the federation %s but could not find the btcPublicKeyIndex",
@@ -138,34 +140,33 @@ public void start(Federation federation) {
             logger.error("[start] {}", message);
             throw new IllegalStateException(message);
         }
-        TurnScheduler scheduler = new TurnScheduler(
-                bridgeConstants.getUpdateBridgeExecutionPeriod(),
-                federation.getSize()
-        );
-        long now = Clock.systemUTC().instant().toEpochMilli();
 
         if (isUpdateBridgeTimerEnabled) {
-            updateBridgeTimer = Executors.newSingleThreadScheduledExecutor();
+            long now = Clock.systemUTC().instant().toEpochMilli();
+            TurnScheduler scheduler = new TurnScheduler(
+              bridgeConstants.getUpdateBridgeExecutionPeriod(),
+              federation.getSize());
+
+            this.updateBridgeTimer = Executors.newSingleThreadScheduledExecutor();
+
             updateBridgeTimer.scheduleAtFixedRate(
                 this::updateBridge,
                 scheduler.getDelay(now, federatorIndex.get()),
                 scheduler.getInterval(),
-                TimeUnit.MILLISECONDS
-            );
-        }
-        else {
+                TimeUnit.MILLISECONDS);
+        } else {
             logger.info("[start] updateBridgeTimer is disabled");
         }
     }
 
     public void stop() {
         logger.info("Stopping");
 
-        federation = null;
+        this.federation = null;
 
         if (updateBridgeTimer != null) {
             updateBridgeTimer.shutdown();
-            updateBridgeTimer = null;
+            this.updateBridgeTimer = null;
         }
     }
 
@@ -177,13 +178,15 @@ public void updateBridge() {
         if (federation == null) {
             logger.warn("[updateBridge] updateBridge skipped because no Federation is associated to this BtcToRskClient");
         }
+
         if (nodeBlockProcessor.hasBetterBlockToSync()) {
             logger.warn("[updateBridge] updateBridge skipped because the node is syncing blocks");
             return;
         }
+
         logger.debug("[updateBridge] Updating bridge");
 
-        if(shouldUpdateBridgeBtcBlockchain) {
+        if (shouldUpdateBridgeBtcBlockchain) {
             // Call receiveHeaders
             try {
                 int numberOfBlocksSent = updateBridgeBtcBlockchain();
@@ -194,7 +197,7 @@ public void updateBridge() {
             }
         }
 
-        if(shouldUpdateBridgeBtcCoinbaseTransactions) {
+        if (shouldUpdateBridgeBtcCoinbaseTransactions) {
             // Call registerBtcCoinbaseTransaction
             try {
                 logger.debug("[updateBridge] Updating transactions and sending update");
@@ -205,7 +208,7 @@ public void updateBridge() {
             }
         }
 
-        if(shouldUpdateBridgeBtcTransactions) {
+        if (shouldUpdateBridgeBtcTransactions) {
             // Call registerBtcTransaction
             try {
                 logger.debug("[updateBridge] Updating transactions and sending update");
@@ -216,7 +219,7 @@ public void updateBridge() {
             }
         }
 
-        if(shouldUpdateCollections) {
+        if (shouldUpdateCollections) {
             // Call updateCollections
             try {
                 logger.debug("[updateBridge] Sending updateCollections");

src/main/java/co/rsk/federate/FedNodeContext.java

@@ -29,6 +29,7 @@
 import co.rsk.federate.signing.hsm.advanceblockchain.HSMBookKeepingClientProvider;
 import co.rsk.federate.signing.hsm.client.HSMClientProtocolFactory;
 import co.rsk.federate.solidity.DummySolidityCompiler;
+import co.rsk.federate.watcher.FederationWatcher;
 import java.util.concurrent.TimeUnit;
 import org.ethereum.rpc.Web3;
 import org.ethereum.solidity.compiler.SolidityCompiler;

src/main/java/co/rsk/federate/FedNodeRunner.java

@@ -52,7 +52,9 @@
 import co.rsk.federate.signing.hsm.message.SignerMessageBuilderFactory;
 import co.rsk.federate.signing.hsm.requirements.AncestorBlockUpdater;
 import co.rsk.federate.signing.hsm.requirements.ReleaseRequirementsEnforcer;
-import co.rsk.peg.federation.Federation;
+import co.rsk.federate.watcher.FederationWatcher;
+import co.rsk.federate.watcher.FederationWatcherListener;
+import co.rsk.federate.watcher.FederationWatcherListenerImpl;
 import co.rsk.peg.federation.FederationMember;
 import co.rsk.peg.btcLockSender.BtcLockSenderProvider;
 import co.rsk.peg.pegininstructions.PeginInstructionsProvider;
@@ -65,7 +67,6 @@
 import java.net.UnknownHostException;
 import java.util.Arrays;
 import java.util.List;
-import java.util.Optional;
 import java.util.stream.Stream;
 
 /**
@@ -342,27 +343,14 @@ private void startFederate() throws Exception {
                     config.getBtcReleaseClientInitializationMaxDepth()
                 )
             );
-            federationWatcher.setup(federationProvider);
-
-            federationWatcher.addListener(new FederationWatcher.Listener() {
-                @Override
-                public void onActiveFederationChange(Optional<Federation> oldFederation, Federation newFederation) {
-                    String oldFederationAddress = oldFederation.map(f -> f.getAddress().toString()).orElse("NONE");
-                    String newFederationAddress = newFederation.getAddress().toString();
-                    logger.debug(String.format("[onActiveFederationChange] Active federation change: from %s to %s", oldFederationAddress, newFederationAddress));
-                    triggerClientChange(btcToRskClientActive, Optional.of(newFederation));
-                }
-
-                @Override
-                public void onRetiringFederationChange(Optional<Federation> oldFederation, Optional<Federation> newFederation) {
-                    String oldFederationAddress = oldFederation.map(f -> f.getAddress().toString()).orElse("NONE");
-                    String newFederationAddress = newFederation.map(f -> f.getAddress().toString()).orElse("NONE");
-                    logger.debug(String.format("[onRetiringFederationChange] Retiring federation change: from %s to %s", oldFederationAddress, newFederationAddress));
-                    triggerClientChange(btcToRskClientRetiring, newFederation);
-                }
-            });
-            // Trigger the first events
-            federationWatcher.updateState();
+
+            FederationWatcherListener federationWatcherListener = new FederationWatcherListenerImpl(
+                btcToRskClientActive,
+                btcToRskClientRetiring,
+                btcReleaseClient,
+                bitcoinWrapper);
+
+            federationWatcher.start(federationProvider, federationWatcherListener);
         }
     }
 
@@ -384,22 +372,6 @@ private void shutdown() {
         System.exit(-1);
     }
 
-    // TODO: This this method (and this whole class)
-    private void triggerClientChange(BtcToRskClient client, Optional<Federation> federation) {
-        client.stop();
-        federation.ifPresent(btcReleaseClient::stop);
-        // Only start if this federator is part of the new federation
-        if (federation.isPresent() && federation.get().isMember(this.member)) {
-            String federationAddress = federation.get().getAddress().toString();
-            logger.debug("[triggerClientChange] Starting lock and release clients since I belong to federation {}", federationAddress);
-            logger.info("[triggerClientChange] Joined to {} federation", federationAddress);
-            client.start(federation.get());
-            btcReleaseClient.start(federation.get());
-        } else {
-            logger.warn("[triggerClientChange] This federator node is not part of the new federation. Check your configuration for signers BTC, RSK and MST keys");
-        }
-    }
-
     @Override
     public void stop() {
         logger.info("[stop] Shutting down Federation node");

src/main/java/co/rsk/federate/FederationProvider.java

@@ -15,34 +15,59 @@
  * You should have received a copy of the GNU Lesser General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-
 package co.rsk.federate;
 
 import co.rsk.bitcoinj.core.Address;
 import co.rsk.peg.federation.Federation;
-
-import java.util.List;
 import java.util.Optional;
 
 /**
- * Implementors of this interface must be able to provide
- * federation instances.
- *
- * @author Ariel Mendelzon
+ * Provides access to various federation instances, including the active, retiring, and proposed federations.
+ * Implementations of this interface must define how to retrieve the federations and their respective addresses.
+ * These methods allow clients to manage and monitor federations in different lifecycle stages within the bridge.
  */
 public interface FederationProvider {
-    // The currently "active" federation
+
+    /**
+     * Retrieves the currently active federation.
+     *
+     * @return the active {@link Federation} instance
+     */
     Federation getActiveFederation();
-    // The currently "active" federation's address
+
+    /**
+     * Retrieves the address of the currently active federation.
+     *
+     * @return the {@link Address} of the active federation
+     */
     Address getActiveFederationAddress();
 
-    // The currently "retiring" federation
+    /**
+     * Retrieves the currently retiring federation, if one exists. This federation is in transition 
+     * and will soon be replaced by a new active federation.
+     *
+     * @return an {@link Optional} containing the retiring {@link Federation}, or {@link Optional#empty()} if none exists
+     */
     Optional<Federation> getRetiringFederation();
-    // The currently "retiring" federation's address
+
+    /**
+     * Retrieves the address of the currently retiring federation, if one exists.
+     *
+     * @return an {@link Optional} containing the {@link Address} of the retiring federation, or {@link Optional#empty()} if none exists
+     */
     Optional<Address> getRetiringFederationAddress();
 
-    // The federations that are "live", that is, are still
-    // operational. This should be the active federation
-    // plus the retiring federation, if one exists
-    List<Federation> getLiveFederations();
+    /**
+     * Retrieves the currently proposed federation, if one exists. This federation is awaiting validation.
+     *
+     * @return an {@link Optional} containing the proposed {@link Federation}, or {@link Optional#empty()} if none exists
+     */
+    Optional<Federation> getProposedFederation();
+
+    /**
+     * Retrieves the address of the currently proposed federation, if one exists.
+     *
+     * @return an {@link Optional} containing the {@link Address} of the proposed federation, or {@link Optional#empty()} if none exists
+     */
+    Optional<Address> getProposedFederationAddress();
 }