- Rename UnrefundablePeginReason to NonRefundablePeginReason

- Enhance switch for processing each PeginProcessAction

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

@@ -23,7 +23,6 @@
 import static co.rsk.peg.ReleaseTransactionBuilder.BTC_TX_VERSION_2;
 import static co.rsk.peg.bitcoin.BitcoinUtils.*;
 import static co.rsk.peg.bitcoin.UtxoUtils.extractOutpointValues;
-import static co.rsk.peg.pegin.RejectedPeginReason.INVALID_AMOUNT;
 import static java.util.Objects.isNull;
 import static org.ethereum.config.blockchain.upgrades.ConsensusRule.*;
 
@@ -505,68 +504,72 @@ protected void registerPegIn(
         PeginProcessAction peginProcessAction = peginEvaluationResult.getPeginProcessAction();
 
         switch (peginProcessAction) {
-            case CAN_BE_REGISTERED -> {
+            case REGISTER -> {
                 logger.debug("[{}] Peg-in is valid, going to register", METHOD_NAME);
                 executePegIn(btcTx, peginInformation, totalAmount);
             }
-            case CAN_BE_REFUNDED -> {
-                // If the peg-in cannot be registered means it should be rejected
-                handleRejectedPegin(btcTx,
-                    peginEvaluationResult);
-                logger.debug("[{}] Refunding to address {} ", METHOD_NAME,
-                    peginInformation.getBtcRefundAddress());
-                generateRejectionRelease(btcTx, peginInformation.getBtcRefundAddress(), rskTxHash,
-                    totalAmount);
-                markTxAsProcessed(btcTx);
-            }
-            case CANNOT_BE_REFUNDED -> {
-                // If the peg-in cannot be registered means it should be rejected
-                RejectedPeginReason rejectedPeginReason = handleRejectedPegin(btcTx,
-                    peginEvaluationResult);
-
-                handleNonRefundablePegin(btcTx, peginInformation.getProtocolVersion(),
-                    rejectedPeginReason);
-
-                if (!activations.isActive(RSKIP459)) {
-                    return;
-                }
-                // Since RSKIP459, rejected peg-ins should be marked as processed
-                markTxAsProcessed(btcTx);
-            }
+            case REFUND -> handleRefundablePegin(btcTx, rskTxHash, peginEvaluationResult,
+                peginInformation.getBtcRefundAddress());
+            case NO_REFUND -> handleNonRefundablePegin(btcTx, peginInformation.getProtocolVersion(),
+                peginEvaluationResult);
         }
     }
 
-    private RejectedPeginReason handleRejectedPegin(BtcTransaction btcTx,
-        PeginEvaluationResult peginEvaluationResult) {
-        return peginEvaluationResult.getRejectedPeginReason().map(reason -> {
-            logger.debug("[{handleRejectedPegin}] Rejected peg-in, reason {}", reason);
-            eventLogger.logRejectedPegin(btcTx, reason);
-            return reason;
-        }).orElseThrow(() -> {
-            // This flow should never be reached. There should always be a rejected pegin reason.
-            String message = "Invalid state. No rejected reason was returned for an invalid pegin.";
-            logger.error("[{handleRejectedPegin}] {}", message);
-            return new IllegalStateException(message);
-        });
+    private void handleRefundablePegin(BtcTransaction btcTx, Keccak256 rskTxHash,
+        PeginEvaluationResult peginEvaluationResult, Address btcRefundAddress)
+        throws IOException {
+        RejectedPeginReason rejectedPeginReason = peginEvaluationResult.getRejectedPeginReason()
+            .orElseThrow(() -> {
+                // This flow should never be reached. There should always be a rejected pegin reason.
+                String message = "Invalid state. No rejected reason was returned for an invalid pegin.";
+                logger.error("[{handleRefundablePegin}] {}", message);
+                return new IllegalStateException(message);
+            });
+
+        logger.debug("[{handleRefundablePegin}] Rejected peg-in, reason {}", rejectedPeginReason);
+        eventLogger.logRejectedPegin(btcTx, rejectedPeginReason);
+
+        logger.debug("[{handleRefundablePegin}] Refunding to address {} ", btcRefundAddress);
+        Coin totalAmount = computeTotalAmountSent(btcTx);
+        generateRejectionRelease(btcTx, btcRefundAddress, rskTxHash,
+            totalAmount);
+        markTxAsProcessed(btcTx);
     }
 
     private void handleNonRefundablePegin(
         BtcTransaction btcTx,
         int protocolVersion,
-        RejectedPeginReason rejectedPeginReason
-    ) {
-        UnrefundablePeginReason unrefundablePeginReason;
-        if (rejectedPeginReason == INVALID_AMOUNT) {
-            unrefundablePeginReason = UnrefundablePeginReason.INVALID_AMOUNT;
-        } else {
-            unrefundablePeginReason = protocolVersion == 1 ?
-                UnrefundablePeginReason.PEGIN_V1_REFUND_ADDRESS_NOT_SET :
-                UnrefundablePeginReason.LEGACY_PEGIN_UNDETERMINED_SENDER;
-        }
+        PeginEvaluationResult peginEvaluationResult
+    ) throws IOException {
+        RejectedPeginReason rejectedPeginReason = peginEvaluationResult.getRejectedPeginReason()
+            .orElseThrow(() -> {
+                // This flow should never be reached. There should always be a rejected pegin reason.
+                String message = "Invalid state. No rejected reason was returned for an invalid pegin.";
+                logger.error("[{handleNonRefundablePegin}] {}", message);
+                return new IllegalStateException(message);
+            });
+
+        logger.debug("[{handleNonRefundablePegin}] Rejected peg-in, reason {}",
+            rejectedPeginReason);
+        eventLogger.logRejectedPegin(btcTx, rejectedPeginReason);
+
+        NonRefundablePeginReason nonRefundablePeginReason = switch (rejectedPeginReason) {
+            case INVALID_AMOUNT -> NonRefundablePeginReason.INVALID_AMOUNT;
+            case LEGACY_PEGIN_UNDETERMINED_SENDER, PEGIN_V1_INVALID_PAYLOAD ->
+                protocolVersion == 1 ? NonRefundablePeginReason.PEGIN_V1_REFUND_ADDRESS_NOT_SET
+                    : NonRefundablePeginReason.LEGACY_PEGIN_UNDETERMINED_SENDER;
+            default -> throw new IllegalStateException("Unexpected value: " + rejectedPeginReason);
+        };
 
         logger.debug("[handleNonRefundablePegin] Nonrefundable tx {}. Reason {}", btcTx.getHash(),
-            unrefundablePeginReason);
-        eventLogger.logUnrefundablePegin(btcTx, unrefundablePeginReason);
+            nonRefundablePeginReason);
+        eventLogger.logNonRefundablePegin(btcTx, nonRefundablePeginReason);
+
+        if (!activations.isActive(RSKIP459)) {
+            return;
+        }
+        // Since RSKIP459, rejected peg-ins should be marked as processed
+        markTxAsProcessed(btcTx);
     }
 
     /**
@@ -734,9 +737,9 @@ private void refundTxSender(
 
             if (activations.isActive(ConsensusRule.RSKIP181)) {
                 if (peginInformation.getProtocolVersion() == 1) {
-                    eventLogger.logUnrefundablePegin(btcTx, UnrefundablePeginReason.PEGIN_V1_REFUND_ADDRESS_NOT_SET);
+                    eventLogger.logNonRefundablePegin(btcTx, NonRefundablePeginReason.PEGIN_V1_REFUND_ADDRESS_NOT_SET);
                 } else {
-                    eventLogger.logUnrefundablePegin(btcTx, UnrefundablePeginReason.LEGACY_PEGIN_UNDETERMINED_SENDER);
+                    eventLogger.logNonRefundablePegin(btcTx, NonRefundablePeginReason.LEGACY_PEGIN_UNDETERMINED_SENDER);
                 }
             }
         }

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

@@ -182,7 +182,7 @@ static PeginEvaluationResult evaluatePegin(
 
         if(!allUTXOsToFedAreAboveMinimumPeginValue(btcTx, fedWallet, minimumPeginTxValue, activations)) {
             logger.debug("[evaluatePegin] Peg-in contains at least one utxo below the minimum value");
-            return new PeginEvaluationResult(PeginProcessAction.CANNOT_BE_REFUNDED, INVALID_AMOUNT);
+            return new PeginEvaluationResult(PeginProcessAction.NO_REFUND, INVALID_AMOUNT);
         }
 
         try {
@@ -196,8 +196,8 @@ static PeginEvaluationResult evaluatePegin(
             boolean hasRefundAddress = peginInformation.getBtcRefundAddress() != null;
 
             PeginProcessAction peginProcessAction = hasRefundAddress ?
-                                                        PeginProcessAction.CAN_BE_REFUNDED :
-                                                        PeginProcessAction.CANNOT_BE_REFUNDED;
+                                                        PeginProcessAction.REFUND :
+                                                        PeginProcessAction.NO_REFUND;
 
             return new PeginEvaluationResult(peginProcessAction, PEGIN_V1_INVALID_PAYLOAD);
         }
@@ -207,7 +207,7 @@ static PeginEvaluationResult evaluatePegin(
             case 0:
                 return evaluateLegacyPeginSender(peginInformation.getSenderBtcAddressType());
             case 1:
-                return new PeginEvaluationResult(PeginProcessAction.CAN_BE_REGISTERED);
+                return new PeginEvaluationResult(PeginProcessAction.REGISTER);
             default:
                 // This flow should never be reached.
                 String message = String.format("Invalid state. Unexpected pegin protocol %d", protocolVersion);
@@ -220,12 +220,12 @@ private static PeginEvaluationResult evaluateLegacyPeginSender(TxSenderAddressTy
         switch (senderAddressType) {
             case P2PKH:
             case P2SHP2WPKH:
-                return new PeginEvaluationResult(PeginProcessAction.CAN_BE_REGISTERED);
+                return new PeginEvaluationResult(PeginProcessAction.REGISTER);
             case P2SHMULTISIG:
             case P2SHP2WSH:
-                return new PeginEvaluationResult(PeginProcessAction.CAN_BE_REFUNDED, LEGACY_PEGIN_MULTISIG_SENDER);
+                return new PeginEvaluationResult(PeginProcessAction.REFUND, LEGACY_PEGIN_MULTISIG_SENDER);
             default:
-                return new PeginEvaluationResult(PeginProcessAction.CANNOT_BE_REFUNDED, LEGACY_PEGIN_UNDETERMINED_SENDER);
+                return new PeginEvaluationResult(PeginProcessAction.NO_REFUND, LEGACY_PEGIN_UNDETERMINED_SENDER);
         }
     }
 

rskj-core/src/main/java/co/rsk/peg/pegin/PeginProcessAction.java

@@ -1,7 +1,7 @@
 package co.rsk.peg.pegin;
 
 public enum PeginProcessAction {
-    CAN_BE_REGISTERED,
-    CAN_BE_REFUNDED,
-    CANNOT_BE_REFUNDED
+    REGISTER,
+    REFUND,
+    NO_REFUND
 }

rskj-core/src/main/java/co/rsk/peg/utils/BridgeEventLogger.java

@@ -60,7 +60,7 @@ default void logRejectedPegin(BtcTransaction btcTx, RejectedPeginReason reason)
         throw new UnsupportedOperationException();
     }
 
-    default void logUnrefundablePegin(BtcTransaction btcTx, UnrefundablePeginReason reason) {
+    default void logNonRefundablePegin(BtcTransaction btcTx, NonRefundablePeginReason reason) {
         throw new UnsupportedOperationException();
     }
 

rskj-core/src/main/java/co/rsk/peg/utils/BridgeEventLoggerImpl.java

@@ -212,7 +212,7 @@ public void logRejectedPegin(BtcTransaction btcTx, RejectedPeginReason reason) {
     }
 
     @Override
-    public void logUnrefundablePegin(BtcTransaction btcTx, UnrefundablePeginReason reason) {
+    public void logNonRefundablePegin(BtcTransaction btcTx, NonRefundablePeginReason reason) {
         CallTransaction.Function event = BridgeEvents.UNREFUNDABLE_PEGIN.getEvent();
 
         byte[] btcTxHashSerialized = btcTx.getHash().getBytes();

rskj-core/src/main/java/co/rsk/peg/utils/UnrefundablePeginReason.java → rskj-core/src/main/java/co/rsk/peg/utils/NonRefundablePeginReason.java

@@ -1,13 +1,13 @@
 package co.rsk.peg.utils;
 
-public enum UnrefundablePeginReason {
+public enum NonRefundablePeginReason {
     LEGACY_PEGIN_UNDETERMINED_SENDER(1),
     PEGIN_V1_REFUND_ADDRESS_NOT_SET(2),
     INVALID_AMOUNT(3);
 
     private final int value;
 
-    UnrefundablePeginReason(int value) {
+    NonRefundablePeginReason(int value) {
         this.value = value;
     }