@keep-network/tbtc-v2 0.1.1-dev.94 → 0.1.1-dev.97

package/contracts/bridge/MovingFunds.sol

@@ -359,6 +359,8 @@ library MovingFunds {
         BitcoinTx.UTXO calldata mainUtxo,
         bytes20 walletPubKeyHash
     ) external {
+        // Wallet state is validated in `notifyWalletFundsMoved`.
+
         // The actual transaction proof is performed here. After that point, we
         // can assume the transaction happened on Bitcoin chain and has
         // a sufficient number of confirmations as determined by
@@ -368,13 +370,31 @@ library MovingFunds {
             movingFundsProof
         );
 
+        // Assert that main UTXO for passed wallet exists in storage.
+        bytes32 mainUtxoHash = self
+            .registeredWallets[walletPubKeyHash]
+            .mainUtxoHash;
+        require(mainUtxoHash != bytes32(0), "No main UTXO for given wallet");
+
+        // Assert that passed main UTXO parameter is the same as in storage and
+        // can be used for further processing.
+        require(
+            keccak256(
+                abi.encodePacked(
+                    mainUtxo.txHash,
+                    mainUtxo.txOutputIndex,
+                    mainUtxo.txOutputValue
+                )
+            ) == mainUtxoHash,
+            "Invalid main UTXO data"
+        );
+
         // Process the moving funds transaction input. Specifically, check if
         // it refers to the expected wallet's main UTXO.
         OutboundTx.processWalletOutboundTxInput(
             self,
             movingFundsTx.inputVector,
-            mainUtxo,
-            walletPubKeyHash
+            mainUtxo
         );
 
         (
@@ -548,31 +568,19 @@ library MovingFunds {
         bytes20 walletPubKeyHash,
         uint32[] calldata walletMembersIDs
     ) external {
-        Wallets.Wallet storage wallet = self.registeredWallets[
-            walletPubKeyHash
-        ];
+        // Wallet state is validated in `notifyWalletMovingFundsTimeout`.
 
-        require(
-            wallet.state == Wallets.WalletState.MovingFunds,
-            "Wallet must be in MovingFunds state"
-        );
+        uint32 movingFundsRequestedAt = self
+            .registeredWallets[walletPubKeyHash]
+            .movingFundsRequestedAt;
 
         require(
             /* solhint-disable-next-line not-rely-on-time */
-            block.timestamp >
-                wallet.movingFundsRequestedAt + self.movingFundsTimeout,
+            block.timestamp > movingFundsRequestedAt + self.movingFundsTimeout,
             "Moving funds has not timed out yet"
         );
 
-        self.ecdsaWalletRegistry.seize(
-            self.movingFundsTimeoutSlashingAmount,
-            self.movingFundsTimeoutNotifierRewardMultiplier,
-            msg.sender,
-            wallet.ecdsaWalletID,
-            walletMembersIDs
-        );
-
-        self.terminateWallet(walletPubKeyHash);
+        self.notifyWalletMovingFundsTimeout(walletPubKeyHash, walletMembersIDs);
 
         // slither-disable-next-line reentrancy-events
         emit MovingFundsTimedOut(walletPubKeyHash);
@@ -596,14 +604,7 @@ library MovingFunds {
         bytes20 walletPubKeyHash,
         BitcoinTx.UTXO calldata mainUtxo
     ) external {
-        Wallets.Wallet storage wallet = self.registeredWallets[
-            walletPubKeyHash
-        ];
-
-        require(
-            wallet.state == Wallets.WalletState.MovingFunds,
-            "Wallet must be in MovingFunds state"
-        );
+        // Wallet state is validated in `notifyWalletMovingFundsBelowDust`.
 
         uint64 walletBtcBalance = self.getWalletBtcBalance(
             walletPubKeyHash,
@@ -615,7 +616,7 @@ library MovingFunds {
             "Wallet BTC balance must be below the moving funds dust threshold"
         );
 
-        self.beginWalletClosing(walletPubKeyHash);
+        self.notifyWalletMovingFundsBelowDust(walletPubKeyHash);
 
         // slither-disable-next-line reentrancy-events
         emit MovingFundsBelowDustReported(walletPubKeyHash);
@@ -666,6 +667,9 @@ library MovingFunds {
         BitcoinTx.Proof calldata sweepProof,
         BitcoinTx.UTXO calldata mainUtxo
     ) external {
+        // Wallet state validation is performed in the
+        // `resolveMovedFundsSweepingWallet` function.
+
         // The actual transaction proof is performed here. After that point, we
         // can assume the transaction happened on Bitcoin chain and has
         // a sufficient number of confirmations as determined by
@@ -1024,6 +1028,8 @@ library MovingFunds {
         uint32 movingFundsTxOutputIndex,
         uint32[] calldata walletMembersIDs
     ) external {
+        // Wallet state is validated in `notifyWalletMovedFundsSweepTimeout`.
+
         MovedFundsSweepRequest storage sweepRequest = self
             .movedFundsSweepRequests[
                 uint256(
@@ -1049,36 +1055,18 @@ library MovingFunds {
         );
 
         bytes20 walletPubKeyHash = sweepRequest.walletPubKeyHash;
-        Wallets.Wallet storage wallet = self.registeredWallets[
-            walletPubKeyHash
-        ];
-        Wallets.WalletState walletState = wallet.state;
 
-        require(
-            walletState == Wallets.WalletState.Live ||
-                walletState == Wallets.WalletState.MovingFunds ||
-                walletState == Wallets.WalletState.Terminated,
-            "Wallet must be in Live or MovingFunds or Terminated state"
+        self.notifyWalletMovedFundsSweepTimeout(
+            walletPubKeyHash,
+            walletMembersIDs
         );
 
+        Wallets.Wallet storage wallet = self.registeredWallets[
+            walletPubKeyHash
+        ];
         sweepRequest.state = MovedFundsSweepRequestState.TimedOut;
         wallet.pendingMovedFundsSweepRequestsCount--;
 
-        if (
-            walletState == Wallets.WalletState.Live ||
-            walletState == Wallets.WalletState.MovingFunds
-        ) {
-            self.ecdsaWalletRegistry.seize(
-                self.movedFundsSweepTimeoutSlashingAmount,
-                self.movedFundsSweepTimeoutNotifierRewardMultiplier,
-                msg.sender,
-                wallet.ecdsaWalletID,
-                walletMembersIDs
-            );
-
-            self.terminateWallet(walletPubKeyHash);
-        }
-
         // slither-disable-next-line reentrancy-events
         emit MovedFundsSweepTimedOut(
             walletPubKeyHash,

package/contracts/bridge/Redemption.sol

@@ -42,34 +42,11 @@ library OutboundTx {
     ///        before it is passed here.
     /// @param mainUtxo Data of the wallet's main UTXO, as currently known on
     ///        the Ethereum chain.
-    /// @param walletPubKeyHash 20-byte public key hash (computed using Bitcoin
-    //         HASH160 over the compressed ECDSA public key) of the wallet which
-    ///        performed the outbound transaction.
     function processWalletOutboundTxInput(
         BridgeState.Storage storage self,
         bytes memory walletOutboundTxInputVector,
-        BitcoinTx.UTXO calldata mainUtxo,
-        bytes20 walletPubKeyHash
+        BitcoinTx.UTXO calldata mainUtxo
     ) internal {
-        // Assert that main UTXO for passed wallet exists in storage.
-        bytes32 mainUtxoHash = self
-            .registeredWallets[walletPubKeyHash]
-            .mainUtxoHash;
-        require(mainUtxoHash != bytes32(0), "No main UTXO for given wallet");
-
-        // Assert that passed main UTXO parameter is the same as in storage and
-        // can be used for further processing.
-        require(
-            keccak256(
-                abi.encodePacked(
-                    mainUtxo.txHash,
-                    mainUtxo.txOutputIndex,
-                    mainUtxo.txOutputValue
-                )
-            ) == mainUtxoHash,
-            "Invalid main UTXO data"
-        );
-
         // Assert that the single outbound transaction input actually
         // refers to the wallet's main UTXO.
         (
@@ -583,6 +560,9 @@ library Redemption {
         BitcoinTx.UTXO calldata mainUtxo,
         bytes20 walletPubKeyHash
     ) external {
+        // Wallet state validation is performed in the `resolveRedeemingWallet`
+        // function.
+
         // The actual transaction proof is performed here. After that point, we
         // can assume the transaction happened on Bitcoin chain and has
         // a sufficient number of confirmations as determined by
@@ -592,24 +572,18 @@ library Redemption {
             redemptionProof
         );
 
+        Wallets.Wallet storage wallet = resolveRedeemingWallet(
+            self,
+            walletPubKeyHash,
+            mainUtxo
+        );
+
         // Process the redemption transaction input. Specifically, check if it
         // refers to the expected wallet's main UTXO.
         OutboundTx.processWalletOutboundTxInput(
             self,
             redemptionTx.inputVector,
-            mainUtxo,
-            walletPubKeyHash
-        );
-
-        Wallets.Wallet storage wallet = self.registeredWallets[
-            walletPubKeyHash
-        ];
-
-        Wallets.WalletState walletState = wallet.state;
-        require(
-            walletState == Wallets.WalletState.Live ||
-                walletState == Wallets.WalletState.MovingFunds,
-            "Wallet must be in Live or MovingFunds state"
+            mainUtxo
         );
 
         // Process redemption transaction outputs to extract some info required
@@ -645,6 +619,50 @@ library Redemption {
         self.bank.transferBalance(self.treasury, outputsInfo.totalTreasuryFee);
     }
 
+    /// @notice Resolves redeeming wallet based on the provided wallet public
+    ///         key hash. Validates the wallet state and current main UTXO, as
+    ///         currently known on the Ethereum chain.
+    /// @param walletPubKeyHash public key hash of the wallet proving the sweep
+    ///        Bitcoin transaction.
+    /// @param mainUtxo Data of the wallet's main UTXO, as currently known on
+    ///        the Ethereum chain.
+    /// @return wallet Data of the sweeping wallet.
+    /// @dev Requirements:
+    ///     - Sweeping wallet must be either in Live or MovingFunds state,
+    ///     - Main UTXO of the redeeming wallet must exists in the storage,
+    ///     - The passed `mainUTXO` parameter must be equal to the stored one.
+    function resolveRedeemingWallet(
+        BridgeState.Storage storage self,
+        bytes20 walletPubKeyHash,
+        BitcoinTx.UTXO calldata mainUtxo
+    ) internal view returns (Wallets.Wallet storage wallet) {
+        wallet = self.registeredWallets[walletPubKeyHash];
+
+        // Assert that main UTXO for passed wallet exists in storage.
+        bytes32 mainUtxoHash = wallet.mainUtxoHash;
+        require(mainUtxoHash != bytes32(0), "No main UTXO for given wallet");
+
+        // Assert that passed main UTXO parameter is the same as in storage and
+        // can be used for further processing.
+        require(
+            keccak256(
+                abi.encodePacked(
+                    mainUtxo.txHash,
+                    mainUtxo.txOutputIndex,
+                    mainUtxo.txOutputValue
+                )
+            ) == mainUtxoHash,
+            "Invalid main UTXO data"
+        );
+
+        Wallets.WalletState walletState = wallet.state;
+        require(
+            walletState == Wallets.WalletState.Live ||
+                walletState == Wallets.WalletState.MovingFunds,
+            "Wallet must be in Live or MovingFunds state"
+        );
+    }
+
     /// @notice Processes the Bitcoin redemption transaction output vector.
     ///         It extracts each output and tries to identify it as a pending
     ///         redemption request, reported timed out request, or change.
@@ -956,6 +974,8 @@ library Redemption {
         uint32[] calldata walletMembersIDs,
         bytes calldata redeemerOutputScript
     ) external {
+        // Wallet state is validated in `notifyWalletRedemptionTimeout`.
+
         uint256 redemptionKey = uint256(
             keccak256(abi.encodePacked(walletPubKeyHash, redeemerOutputScript))
         );
@@ -978,40 +998,19 @@ library Redemption {
             request.requestedAmount -
             request.treasuryFee;
 
-        require(
-            wallet.state == Wallets.WalletState.Live ||
-                wallet.state == Wallets.WalletState.MovingFunds ||
-                wallet.state == Wallets.WalletState.Terminated,
-            "Wallet must be in Live, MovingFunds or Terminated state"
-        );
-
         // It is worth noting that there is no need to check if
         // `timedOutRedemption` mapping already contains the given redemption
         // key. There is no possibility to re-use a key of a reported timed-out
         // redemption because the wallet responsible for causing the timeout is
         // moved to a state that prevents it to receive new redemption requests.
 
+        // Propagate timeout consequences to the wallet
+        self.notifyWalletRedemptionTimeout(walletPubKeyHash, walletMembersIDs);
+
         // Move the redemption from pending redemptions to timed-out redemptions
         self.timedOutRedemptions[redemptionKey] = request;
         delete self.pendingRedemptions[redemptionKey];
 
-        if (
-            wallet.state == Wallets.WalletState.Live ||
-            wallet.state == Wallets.WalletState.MovingFunds
-        ) {
-            // Slash the wallet operators and reward the notifier
-            self.ecdsaWalletRegistry.seize(
-                self.redemptionTimeoutSlashingAmount,
-                self.redemptionTimeoutNotifierRewardMultiplier,
-                msg.sender,
-                wallet.ecdsaWalletID,
-                walletMembersIDs
-            );
-
-            // Propagate timeout consequences to the wallet
-            self.notifyWalletTimedOutRedemption(walletPubKeyHash);
-        }
-
         // slither-disable-next-line reentrancy-events
         emit RedemptionTimedOut(walletPubKeyHash, redeemerOutputScript);