Implement getProposedFederation in FederationProviderFromFederatorSupport

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

@@ -23,27 +23,60 @@
 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, which is responsible for processing transactions.
+     *
+     * @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 currently "proposed" federation's address
+    /**
+     * Retrieves the currently proposed federation, if one exists. This federation is awaiting activation.
+     *
+     * @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();
 
-    // The federations that are "live", that is, are still
-    // operational. This should be the active federation
-    // plus the retiring federation, if one exists
+    /**
+     * Retrieves a list of live federations, which includes both the active federation 
+     * and the retiring federation, if one exists.
+     *
+     * @return a {@link List} of live {@link Federation} instances
+     */
     List<Federation> getLiveFederations();
 }

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

@@ -17,7 +17,10 @@
  */
 package co.rsk.federate;
 
+import static co.rsk.peg.federation.FederationChangeResponseCode.FEDERATION_NON_EXISTENT;
+import static co.rsk.peg.federation.FederationMember.KeyType;
 import static org.ethereum.config.blockchain.upgrades.ConsensusRule.RSKIP123;
+import static org.ethereum.config.blockchain.upgrades.ConsensusRule.RSKIP419;
 
 import co.rsk.bitcoinj.core.Address;
 import co.rsk.bitcoinj.core.BtcECKey;
@@ -30,6 +33,7 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Optional;
+import java.util.stream.IntStream;
 
 /**
  * Provides a federation using a FederatorSupport instance, which in turn
@@ -39,13 +43,13 @@
  * @author Ariel Mendelzon
  */
 public class FederationProviderFromFederatorSupport implements FederationProvider {
+
     private final FederatorSupport federatorSupport;
     private final FederationConstants federationConstants;
 
     public FederationProviderFromFederatorSupport(
         FederatorSupport federatorSupport,
         FederationConstants federationConstants) {
-
         this.federatorSupport = federatorSupport;
         this.federationConstants = federationConstants;
     }
@@ -93,7 +97,7 @@ public Optional<Federation> getRetiringFederation() {
         Integer federationSize = federatorSupport.getRetiringFederationSize();
         Optional<Address> optionalRetiringFederationAddress = getRetiringFederationAddress();
 
-        if (federationSize == -1 || !optionalRetiringFederationAddress.isPresent()) {
+        if (federationSize == FEDERATION_NON_EXISTENT.getCode() || optionalRetiringFederationAddress.isEmpty()) {
             return Optional.empty();
         }
 
@@ -135,9 +139,54 @@ public Optional<Address> getRetiringFederationAddress() {
         return federatorSupport.getRetiringFederationAddress();
     }
 
+    @Override
+    public Optional<Federation> getProposedFederation() {
+        if (!federatorSupport.getConfigForBestBlock().isActive(RSKIP419)) {
+            return Optional.empty();
+        }
+
+        Optional<Address> proposedFederationAddress = getProposedFederationAddress();
+        Integer federationSize = federatorSupport.getProposedFederationSize()
+            .orElse(FEDERATION_NON_EXISTENT.getCode());
+        if (federationSize == FEDERATION_NON_EXISTENT.getCode() || proposedFederationAddress.isEmpty()) {
+            return Optional.empty();
+        }
+
+        List<FederationMember> federationMembers = IntStream.range(0, federationSize)
+            .mapToObj(i -> new FederationMember(
+                federatorSupport.getProposedFederatorPublicKeyOfType(i, KeyType.BTC)
+                    .map(ECKey::getPubKey)
+                    .map(BtcECKey::fromPublicOnly)
+                    .orElseThrow(IllegalStateException::new),
+                federatorSupport.getProposedFederatorPublicKeyOfType(i, KeyType.RSK)
+                    .orElseThrow(IllegalStateException::new),
+                federatorSupport.getProposedFederatorPublicKeyOfType(i, KeyType.MST)
+                    .orElseThrow(IllegalStateException::new)
+            ))
+            .toList();
+
+        FederationArgs federationArgs = new FederationArgs(
+            federationMembers,
+            federatorSupport.getProposedFederationCreationTime()
+                .orElseThrow(IllegalStateException::new),
+            federatorSupport.getProposedFederationCreationBlockNumber()
+                .orElseThrow(IllegalStateException::new),
+            federatorSupport.getBtcParams()
+        );
+
+        Federation federation = FederationFactory.buildP2shErpFederation(
+            federationArgs,
+            federationConstants.getErpFedPubKeysList(),
+            federationConstants.getErpFedActivationDelay());
+
+        return Optional.of(federation);
+    }
+
     @Override
     public Optional<Address> getProposedFederationAddress() {
-        return federatorSupport.getProposedFederationAddress();
+        return Optional.of(federatorSupport)
+            .filter(fedSupport -> fedSupport.getConfigForBestBlock().isActive(RSKIP419))
+            .flatMap(FederatorSupport::getProposedFederationAddress);
     }
 
     @Override

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

@@ -23,6 +23,7 @@
 import java.net.UnknownHostException;
 import java.time.Instant;
 import java.util.List;
+import java.util.Objects;
 import java.util.Optional;
 
 /**
@@ -31,17 +32,14 @@
  */
 public class FederatorSupport {
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(FederatorSupport.class);
+    private static final Logger logger = LoggerFactory.getLogger(FederatorSupport.class);
 
     private final Blockchain blockchain;
     private final PowpegNodeSystemProperties config;
-
     private final NetworkParameters parameters;
-
     private final BridgeTransactionSender bridgeTransactionSender;
 
     private ECDSASigner signer;
-
     private FederationMember federationMember;
     private RskAddress federatorAddress;
 
@@ -51,9 +49,7 @@ public FederatorSupport(
             BridgeTransactionSender bridgeTransactionSender) {
         this.blockchain = blockchain;
         this.config = config;
-
         this.parameters = config.getNetworkConstants().getBridgeConstants().getBtcParams();
-
         this.bridgeTransactionSender = bridgeTransactionSender;
     }
 
@@ -98,7 +94,7 @@ public Long getRskBestChainHeight() {
     }
 
     public void sendReceiveHeaders(org.bitcoinj.core.Block[] headers) {
-        LOGGER.debug("About to send to the bridge headers from {} to {}", headers[0].getHash(), headers[headers.length - 1].getHash());
+        logger.debug("About to send to the bridge headers from {} to {}", headers[0].getHash(), headers[headers.length - 1].getHash());
 
         Object[] objectArray = new Object[headers.length];
 
@@ -118,15 +114,15 @@ public Long getBtcTxHashProcessedHeight(Sha256Hash btcTxHash) {
     }
 
     public void sendRegisterBtcTransaction(org.bitcoinj.core.Transaction tx, int blockHeight, PartialMerkleTree pmt) {
-        LOGGER.debug("About to send to the bridge btc tx hash {}. Block height {}", tx.getWTxId(), blockHeight);
+        logger.debug("About to send to the bridge btc tx hash {}. Block height {}", tx.getWTxId(), blockHeight);
 
         byte[] txSerialized = tx.bitcoinSerialize();
         byte[] pmtSerialized = pmt.bitcoinSerialize();
         this.bridgeTransactionSender.sendRskTx(federatorAddress, signer, Bridge.REGISTER_BTC_TRANSACTION, txSerialized, blockHeight, pmtSerialized);
     }
 
     public void sendRegisterCoinbaseTransaction(CoinbaseInformation coinbaseInformation) {
-        LOGGER.debug("About to send to the bridge btc coinbase tx hash {}. Block hash {}", coinbaseInformation.getCoinbaseTransaction().getTxId(), coinbaseInformation.getBlockHash());
+        logger.debug("About to send to the bridge btc coinbase tx hash {}. Block hash {}", coinbaseInformation.getCoinbaseTransaction().getTxId(), coinbaseInformation.getBlockHash());
 
         byte[] txSerialized = coinbaseInformation.getSerializedCoinbaseTransactionWithoutWitness();
         byte[] pmtSerialized = coinbaseInformation.getPmt().bitcoinSerialize();
@@ -197,7 +193,7 @@ public long getFederationCreationBlockNumber() {
     public Optional<Address> getRetiringFederationAddress() {
         String addressString = this.bridgeTransactionSender.callTx(federatorAddress, Bridge.GET_RETIRING_FEDERATION_ADDRESS);
 
-        if (addressString.equals("")) {
+        if (addressString.isEmpty()) {
             return Optional.empty();
         }
 
@@ -261,6 +257,43 @@ public Optional<Address> getProposedFederationAddress() {
             .map(addr -> Address.fromBase58(getBtcParams(), addr));
     }
 
+    public Optional<Integer> getProposedFederationSize() {
+        BigInteger size = bridgeTransactionSender.callTx(
+            federatorAddress, Bridge.GET_PROPOSED_FEDERATION_SIZE);
+
+        return Optional.ofNullable(size)
+            .map(BigInteger::intValue);
+    }
+
+    public Optional<ECKey> getProposedFederatorPublicKeyOfType(int index, FederationMember.KeyType keyType) {
+        Objects.requireNonNull(keyType);
+
+        byte[] publicKeyBytes = bridgeTransactionSender.callTx(
+            federatorAddress,
+            Bridge.GET_PROPOSED_FEDERATOR_PUBLIC_KEY_OF_TYPE,
+            new Object[]{ index, keyType.getValue() });
+
+        return Optional.ofNullable(publicKeyBytes)
+            .map(ECKey::fromPublicOnly);
+    }
+
+    public Optional<Instant> getProposedFederationCreationTime() {
+        BigInteger creationTime = bridgeTransactionSender.callTx(
+            federatorAddress, Bridge.GET_PROPOSED_FEDERATION_CREATION_TIME);
+
+        return Optional.ofNullable(creationTime)
+            .map(BigInteger::longValue)
+            .map(Instant::ofEpochMilli);
+    }
+
+    public Optional<Long> getProposedFederationCreationBlockNumber() {
+        BigInteger creationBlockNumber = bridgeTransactionSender.callTx(
+            federatorAddress, Bridge.GET_PROPOSED_FEDERATION_CREATION_BLOCK_NUMBER);
+
+        return Optional.ofNullable(creationBlockNumber)
+            .map(BigInteger::longValue);
+    }
+
     public int getBtcBlockchainBestChainHeight() {
         BigInteger btcBlockchainBestChainHeight = this.bridgeTransactionSender.callTx(federatorAddress, Bridge.GET_BTC_BLOCKCHAIN_BEST_CHAIN_HEIGHT);
         return btcBlockchainBestChainHeight.intValue();