Implementation of RSKIP379

rskj-core/src/main/java/co/rsk/config/BridgeConstants.java

@@ -71,7 +71,7 @@ public abstract class BridgeConstants {
 
     protected int btcHeightWhenBlockIndexActivates;
     protected int maxDepthToSearchBlocksBelowIndexActivation;
-    protected long minSecondsBetweenCallsReceiveHeader;  // (seconds)
+    protected long minSecondsBetweenCallsReceiveHeader;
 
     protected int maxDepthBlockchainAccepted;
 
@@ -87,6 +87,9 @@ public abstract class BridgeConstants {
 
     protected int numberOfBlocksBetweenPegouts;
 
+    protected int btcHeightWhenPegoutTxIndexActivates;
+    protected int pegoutTxIndexGracePeriodInBtcBlocks;
+
     public NetworkParameters getBtcParams() {
         return NetworkParameters.fromID(btcParamsString);
     }
@@ -186,4 +189,12 @@ public int getMaxInputsPerPegoutTransaction() {
     public int getNumberOfBlocksBetweenPegouts() {
         return numberOfBlocksBetweenPegouts;
     }
+
+    public int getBtcHeightWhenPegoutTxIndexActivates() {
+        return btcHeightWhenPegoutTxIndexActivates;
+    }
+
+    public int getPegoutTxIndexGracePeriodInBtcBlocks() {
+        return pegoutTxIndexGracePeriodInBtcBlocks;
+    }
 }

rskj-core/src/main/java/co/rsk/config/BridgeDevNetConstants.java

@@ -24,13 +24,12 @@
 import co.rsk.peg.AddressBasedAuthorizer;
 import co.rsk.peg.FederationMember;
 import co.rsk.peg.StandardMultisigFederation;
-import org.bouncycastle.util.encoders.Hex;
-import org.ethereum.crypto.ECKey;
-
 import java.time.Instant;
 import java.util.Arrays;
 import java.util.List;
 import java.util.stream.Collectors;
+import org.bouncycastle.util.encoders.Hex;
+import org.ethereum.crypto.ECKey;
 
 public class BridgeDevNetConstants extends BridgeConstants {
     // IMPORTANT: BTC, RSK and MST keys are the same.
@@ -139,7 +138,7 @@ public BridgeDevNetConstants(List<BtcECKey> federationPublicKeys) {
 
         lockingCapIncrementsMultiplier = 2;
 
-        btcHeightWhenBlockIndexActivates = 700_000; //TODO define this value when Iris activation height in RSK is determined
+        btcHeightWhenBlockIndexActivates = 700_000;
         maxDepthToSearchBlocksBelowIndexActivation = 4_320; // 30 days in BTC blocks (considering 1 block every 10 minutes)
 
         erpFedActivationDelay = 52_560; // 1 year in BTC blocks (considering 1 block every 10 minutes)
@@ -159,7 +158,7 @@ public BridgeDevNetConstants(List<BtcECKey> federationPublicKeys) {
         // e1b17fcd0ef1942465eee61b20561b16750191143d365e71de08b33dd84a9788
         oldFederationAddress = "2N7ZgQyhFKm17RbaLqygYbS7KLrQfapyZzu";
 
-        minSecondsBetweenCallsReceiveHeader = 300;  // 5 minutes in seconds
+        minSecondsBetweenCallsReceiveHeader = 300;  // 5 minutes
 
         maxDepthBlockchainAccepted = 25;
 
@@ -168,5 +167,8 @@ public BridgeDevNetConstants(List<BtcECKey> federationPublicKeys) {
         maxInputsPerPegoutTransaction = 10;
 
         numberOfBlocksBetweenPegouts = 360; // 3 hours of RSK blocks (considering 1 block every 30 seconds)
+
+        btcHeightWhenPegoutTxIndexActivates = 1_000_000;
+        pegoutTxIndexGracePeriodInBtcBlocks = 4_320; // 30 days in BTC blocks (considering 1 block every 10 minutes)
     }
 }

rskj-core/src/main/java/co/rsk/config/BridgeMainNetConstants.java

@@ -7,16 +7,15 @@
 import co.rsk.peg.FederationMember;
 import co.rsk.peg.StandardMultisigFederation;
 import com.google.common.collect.Lists;
-import org.bouncycastle.util.encoders.Hex;
-import org.ethereum.crypto.ECKey;
-
 import java.time.Instant;
 import java.util.Arrays;
 import java.util.List;
 import java.util.stream.Collectors;
+import org.bouncycastle.util.encoders.Hex;
+import org.ethereum.crypto.ECKey;
 
 public class BridgeMainNetConstants extends BridgeConstants {
-    private static BridgeMainNetConstants instance = new BridgeMainNetConstants();
+    private static final BridgeMainNetConstants instance = new BridgeMainNetConstants();
 
     BridgeMainNetConstants() {
         btcParamsString = NetworkParameters.ID_MAINNET;
@@ -38,11 +37,11 @@ public class BridgeMainNetConstants extends BridgeConstants {
         BtcECKey federator14PublicKey = BtcECKey.fromPublicOnly(Hex.decode("03b65694ccccda83cbb1e56b31308acd08e993114c33f66a456b627c2c1c68bed6"));
 
         List<BtcECKey> genesisFederationPublicKeys = Lists.newArrayList(
-                federator0PublicKey, federator1PublicKey, federator2PublicKey,
-                federator3PublicKey, federator4PublicKey, federator5PublicKey,
-                federator6PublicKey, federator7PublicKey, federator8PublicKey,
-                federator9PublicKey, federator10PublicKey, federator11PublicKey,
-                federator12PublicKey, federator13PublicKey, federator14PublicKey
+            federator0PublicKey, federator1PublicKey, federator2PublicKey,
+            federator3PublicKey, federator4PublicKey, federator5PublicKey,
+            federator6PublicKey, federator7PublicKey, federator8PublicKey,
+            federator9PublicKey, federator10PublicKey, federator11PublicKey,
+            federator12PublicKey, federator13PublicKey, federator14PublicKey
         );
 
         // IMPORTANT: BTC, RSK and MST keys are the same.
@@ -51,7 +50,7 @@ public class BridgeMainNetConstants extends BridgeConstants {
 
         // Currently set to:
         // Wednesday, January 3, 2018 12:00:00 AM GMT-03:00
-        Instant genesisFederationAddressCreatedAt = Instant.ofEpochMilli(1514948400l);
+        Instant genesisFederationAddressCreatedAt = Instant.ofEpochMilli(1514948400L);
 
         genesisFederation = new StandardMultisigFederation(
             federationMembers,
@@ -107,8 +106,8 @@ public class BridgeMainNetConstants extends BridgeConstants {
         }).map(hex -> ECKey.fromPublicOnly(Hex.decode(hex))).collect(Collectors.toList());
 
         feePerKbChangeAuthorizer = new AddressBasedAuthorizer(
-                feePerKbAuthorizedKeys,
-                AddressBasedAuthorizer.MinimumRequiredCalculation.MAJORITY
+            feePerKbAuthorizedKeys,
+            AddressBasedAuthorizer.MinimumRequiredCalculation.MAJORITY
         );
 
         genesisFeePerKb = Coin.MILLICOIN.multiply(5);
@@ -151,10 +150,12 @@ public class BridgeMainNetConstants extends BridgeConstants {
         maxInputsPerPegoutTransaction = 50;
 
         numberOfBlocksBetweenPegouts = 360; // 3 hours of RSK blocks (considering 1 block every 30 seconds)
+
+        btcHeightWhenPegoutTxIndexActivates = 100; // TODO: TBD and change current mock value. This is an estimation of the btc block number once RSKIP379 is activated.
+        pegoutTxIndexGracePeriodInBtcBlocks = 4_320; // 30 days in BTC blocks (considering 1 block every 10 minutes)
     }
 
     public static BridgeMainNetConstants getInstance() {
         return instance;
     }
-
 }

rskj-core/src/main/java/co/rsk/config/BridgeRegTestConstants.java

@@ -24,16 +24,15 @@
 import co.rsk.peg.AddressBasedAuthorizer;
 import co.rsk.peg.FederationMember;
 import co.rsk.peg.StandardMultisigFederation;
-import org.bouncycastle.util.encoders.Hex;
-import org.ethereum.crypto.ECKey;
-import org.ethereum.crypto.HashUtil;
-
 import java.nio.charset.StandardCharsets;
 import java.time.Instant;
 import java.time.ZonedDateTime;
 import java.util.Arrays;
 import java.util.List;
 import java.util.stream.Collectors;
+import org.bouncycastle.util.encoders.Hex;
+import org.ethereum.crypto.ECKey;
+import org.ethereum.crypto.HashUtil;
 
 public class BridgeRegTestConstants extends BridgeConstants {
     // IMPORTANT: BTC, RSK and MST keys are the same.
@@ -67,7 +66,7 @@ public BridgeRegTestConstants(List<BtcECKey> federationPublicKeys) {
         btc2RskMinimumAcceptableConfirmationsOnRsk = 5;
         rsk2BtcMinimumAcceptableConfirmations = 3;
 
-        updateBridgeExecutionPeriod = 1 * 15 * 1000; //15 seconds in millis
+        updateBridgeExecutionPeriod = 15_000; //15 seconds in millis
 
         maxBtcHeadersPerRskBlock = 500;
 
@@ -164,6 +163,9 @@ public BridgeRegTestConstants(List<BtcECKey> federationPublicKeys) {
         maxInputsPerPegoutTransaction = 10;
 
         numberOfBlocksBetweenPegouts = 50; // 25 Minutes of RSK blocks (considering 1 block every 30 seconds)
+
+        btcHeightWhenPegoutTxIndexActivates = 250;
+        pegoutTxIndexGracePeriodInBtcBlocks = 100;
     }
 
     public static BridgeRegTestConstants getInstance() {

rskj-core/src/main/java/co/rsk/config/BridgeTestNetConstants.java

@@ -24,16 +24,15 @@
 import co.rsk.peg.AddressBasedAuthorizer;
 import co.rsk.peg.FederationMember;
 import co.rsk.peg.StandardMultisigFederation;
-import org.bouncycastle.util.encoders.Hex;
-import org.ethereum.crypto.ECKey;
-
 import java.time.Instant;
 import java.util.Arrays;
 import java.util.List;
 import java.util.stream.Collectors;
+import org.bouncycastle.util.encoders.Hex;
+import org.ethereum.crypto.ECKey;
 
 public class BridgeTestNetConstants extends BridgeConstants {
-    private static BridgeTestNetConstants instance = new BridgeTestNetConstants();
+    private static final BridgeTestNetConstants instance = new BridgeTestNetConstants();
 
     BridgeTestNetConstants() {
         btcParamsString = NetworkParameters.ID_TESTNET;
@@ -51,7 +50,12 @@ public class BridgeTestNetConstants extends BridgeConstants {
             Hex.decode("034844a99cd7028aa319476674cc381df006628be71bc5593b8b5fdb32bb42ef85")
         );
 
-        List<BtcECKey> genesisFederationPublicKeys = Arrays.asList(federator0PublicKey, federator1PublicKey, federator2PublicKey, federator3PublicKey);
+        List<BtcECKey> genesisFederationPublicKeys = Arrays.asList(
+            federator0PublicKey,
+            federator1PublicKey,
+            federator2PublicKey,
+            federator3PublicKey
+        );
 
         // IMPORTANT: BTC, RSK and MST keys are the same.
         // Change upon implementation of the <INSERT FORK NAME HERE> fork.
@@ -156,14 +160,17 @@ public class BridgeTestNetConstants extends BridgeConstants {
         // e1b17fcd0ef1942465eee61b20561b16750191143d365e71de08b33dd84a9788
         oldFederationAddress = "2N7ZgQyhFKm17RbaLqygYbS7KLrQfapyZzu";
 
-        minSecondsBetweenCallsReceiveHeader = 300;  // 5 minutes in seconds
+        minSecondsBetweenCallsReceiveHeader = 300;  // 5 minutes
         maxDepthBlockchainAccepted = 25;
 
         minimumPegoutValuePercentageToReceiveAfterFee = 80;
 
         maxInputsPerPegoutTransaction = 50;
 
         numberOfBlocksBetweenPegouts = 360; // 3 hours of RSK blocks (considering 1 block every 30 seconds)
+
+        btcHeightWhenPegoutTxIndexActivates = 150; // TODO: TBD and change current mock value. This is an estimation of the btc block number once RSKIP379 is activated.
+        pegoutTxIndexGracePeriodInBtcBlocks = 4_320; // 30 days in BTC blocks (considering 1 block every 10 minutes)
     }
 
     public static BridgeTestNetConstants getInstance() {

rskj-core/src/main/java/co/rsk/peg/BridgeStorageIndexKey.java

@@ -39,9 +39,11 @@ public enum BridgeStorageIndexKey {
     BTC_BLOCK_HEIGHT("btcBlockHeight"),
     FAST_BRIDGE_HASH_USED_IN_BTC_TX("fastBridgeHashUsedInBtcTx"),
     FAST_BRIDGE_FEDERATION_INFORMATION("fastBridgeFederationInformation"),
+
+    PEGOUT_TX_SIG_HASH("pegoutTxSigHash"),
     ;
 
-    private String key;
+    private final String key;
 
     BridgeStorageIndexKey(String key) {
         this.key = key;

rskj-core/src/main/java/co/rsk/peg/BridgeStorageProvider.java

@@ -52,8 +52,8 @@ public class BridgeStorageProvider {
     protected static final int LEGACY_ERP_FEDERATION_FORMAT_VERSION = 2000;
     protected static final int P2SH_ERP_FEDERATION_FORMAT_VERSION = 3000;
 
-    // Dummy value to use when saved Fast Bridge Derivation Argument Hash
-    private static final byte FLYOVER_FEDERATION_DERIVATION_HASH_TRUE_VALUE = (byte) 1;
+    // Dummy value to use when saving key only indexes
+    private static final byte TRUE_VALUE = (byte) 1;
 
     private final Repository repository;
     private final RskAddress contractAddress;
@@ -110,6 +110,8 @@ public class BridgeStorageProvider {
 
     private Long nextPegoutHeight;
 
+    private Set<Sha256Hash> pegoutTxSigHashes;
+
     public BridgeStorageProvider(
         Repository repository,
         RskAddress contractAddress,
@@ -787,7 +789,7 @@ public boolean isFlyoverDerivationHashUsed(Sha256Hash btcTxHash, Keccak256 flyov
 
         return data != null &&
             data.length == 1 &&
-            data[0] == FLYOVER_FEDERATION_DERIVATION_HASH_TRUE_VALUE;
+            data[0] == TRUE_VALUE;
     }
 
     public void markFlyoverDerivationHashAsUsed(Sha256Hash btcTxHash, Keccak256 flyoverDerivationHash) {
@@ -808,7 +810,7 @@ private void saveFlyoverDerivationHash() {
                 flyoverBtcTxHash,
                 flyoverDerivationHash
             ),
-            new byte[]{FLYOVER_FEDERATION_DERIVATION_HASH_TRUE_VALUE}
+            new byte[]{TRUE_VALUE}
         );
     }
 
@@ -923,6 +925,51 @@ protected int getReleaseRequestQueueSize() throws IOException {
         return getReleaseRequestQueue().getEntries().size();
     }
 
+    public boolean hasPegoutTxSigHash(Sha256Hash sigHash) {
+        if (!activations.isActive(RSKIP379) || sigHash == null){
+            return false;
+        }
+
+        byte[] data = repository.getStorageBytes(
+            contractAddress,
+            getStorageKeyForPegoutTxSigHash(sigHash)
+        );
+
+        return data != null &&
+           data.length == 1 &&
+           data[0] == TRUE_VALUE;
+    }
+
+    public void setPegoutTxSigHash(Sha256Hash sigHash) {
+        if (!activations.isActive(RSKIP379) || sigHash == null) {
+            return;
+        }
+
+        if (hasPegoutTxSigHash(sigHash)){
+            throw new IllegalStateException(String.format("Given pegout tx sigHash %s already exists in the index. Index entries are considered unique.", sigHash));
+        }
+
+        if (pegoutTxSigHashes == null){
+            pegoutTxSigHashes = new HashSet<>();
+        }
+
+        pegoutTxSigHashes.add(sigHash);
+    }
+
+    private void savePegoutTxSigHashes() {
+        if (!activations.isActive(RSKIP379) || pegoutTxSigHashes == null) {
+            return;
+        }
+
+        pegoutTxSigHashes.forEach(pegoutTxSigHash -> repository.addStorageBytes(
+            contractAddress,
+            getStorageKeyForPegoutTxSigHash(
+                pegoutTxSigHash
+            ),
+            new byte[]{TRUE_VALUE}
+        ));
+    }
+
     public void save() throws IOException {
         saveBtcTxHashesAlreadyProcessed();
 
@@ -964,6 +1011,8 @@ public void save() throws IOException {
         saveReceiveHeadersLastTimestamp();
 
         saveNextPegoutHeight();
+
+        savePegoutTxSigHashes();
     }
 
     private DataWord getStorageKeyForBtcTxHashAlreadyProcessed(Sha256Hash btcTxHash) {
@@ -1000,6 +1049,10 @@ private DataWord getStorageKeyForNewFederationBtcUtxos() {
         return key;
     }
 
+    private DataWord getStorageKeyForPegoutTxSigHash(Sha256Hash sigHash) {
+        return PEGOUT_TX_SIG_HASH.getCompoundKey("-", sigHash.toString());
+    }
+
     private Optional<Integer> getStorageVersion(DataWord versionKey) {
         if (!storageVersionEntries.containsKey(versionKey)) {
             Optional<Integer> version = safeGetFromRepository(versionKey, data -> {