@keep-network/tbtc-v2 0.1.1-dev.52 → 0.1.1-dev.55

package/contracts/bridge/BridgeState.sol

@@ -83,17 +83,24 @@ library BridgeState {
         // if per single redemption. `movingFundsTxMaxTotalFee` is a total
         // fee for the entire transaction.
         uint64 movingFundsTxMaxTotalFee;
-        // Time after which the moving funds process can be reported as
-        // timed out. It is counted from the moment when the wallet
-        // was requested to move their funds and switched to the MovingFunds
-        // state. Value in seconds.
-        uint32 movingFundsTimeout;
         // The minimal satoshi amount that makes sense to be transferred during
         // the moving funds process. Moving funds wallets having their BTC
         // balance below that value can begin closing immediately as
         // transferring such a low value may not be possible due to
         // BTC network fees.
         uint64 movingFundsDustThreshold;
+        // Time after which the moving funds process can be reported as
+        // timed out. It is counted from the moment when the wallet
+        // was requested to move their funds and switched to the MovingFunds
+        // state. Value in seconds.
+        uint32 movingFundsTimeout;
+        // The amount of stake slashed from each member of a wallet for a moving
+        // funds timeout.
+        uint96 movingFundsTimeoutSlashingAmount;
+        // The percentage of the notifier reward from the staking contract
+        // the notifier of a moving funds timeout receives. The value is in the
+        // range [0, 100].
+        uint256 movingFundsTimeoutNotifierRewardMultiplier;
         // The minimal amount that can be requested for redemption.
         // Value of this parameter must take into account the value of
         // `redemptionTreasuryFeeDivisor` and `redemptionTxMaxFee`
@@ -122,6 +129,13 @@ library BridgeState {
         // timed out requests are cancelled and locked TBTC is returned
         // to the redeemer in full amount.
         uint256 redemptionTimeout;
+        // The amount of stake slashed from each member of a wallet for a
+        // redemption timeout.
+        uint96 redemptionTimeoutSlashingAmount;
+        // The percentage of the notifier reward from the staking contract
+        // the notifier of a redemption timeout receives. The value is in the
+        // range [0, 100].
+        uint256 redemptionTimeoutNotifierRewardMultiplier;
         // Collection of all pending redemption requests indexed by
         // redemption key built as
         // `keccak256(walletPubKeyHash | redeemerOutputScript)`.
@@ -151,16 +165,16 @@ library BridgeState {
         //    mapping basing on a timed out request stored previously in
         //    `pendingRedemptions` mapping.
         mapping(uint256 => Redemption.RedemptionRequest) timedOutRedemptions;
+        // The amount of ETH in wei the party challenging the wallet for fraud
+        // needs to deposit.
+        uint256 fraudChallengeDepositAmount;
+        // The amount of time the wallet has to defeat a fraud challenge.
+        uint256 fraudChallengeDefeatTimeout;
         // The amount of stake slashed from each member of a wallet for a fraud.
         uint96 fraudSlashingAmount;
         // The percentage of the notifier reward from the staking contract
         // the notifier of a fraud receives. The value is in the range [0, 100].
         uint256 fraudNotifierRewardMultiplier;
-        // The amount of time the wallet has to defeat a fraud challenge.
-        uint256 fraudChallengeDefeatTimeout;
-        // The amount of ETH in wei the party challenging the wallet for fraud
-        // needs to deposit.
-        uint256 fraudChallengeDepositAmount;
         // Collection of all submitted fraud challenges indexed by challenge
         // key built as `keccak256(walletPublicKey|sighash)`.
         mapping(uint256 => Fraud.FraudChallenge) fraudChallenges;
@@ -222,13 +236,17 @@ library BridgeState {
         uint64 redemptionDustThreshold,
         uint64 redemptionTreasuryFeeDivisor,
         uint64 redemptionTxMaxFee,
-        uint256 redemptionTimeout
+        uint256 redemptionTimeout,
+        uint96 redemptionTimeoutSlashingAmount,
+        uint256 redemptionTimeoutNotifierRewardMultiplier
     );
 
     event MovingFundsParametersUpdated(
         uint64 movingFundsTxMaxTotalFee,
+        uint64 movingFundsDustThreshold,
         uint32 movingFundsTimeout,
-        uint64 movingFundsDustThreshold
+        uint96 movingFundsTimeoutSlashingAmount,
+        uint256 movingFundsTimeoutNotifierRewardMultiplier
     );
 
     event WalletParametersUpdated(
@@ -242,10 +260,10 @@ library BridgeState {
     );
 
     event FraudParametersUpdated(
-        uint96 fraudSlashingAmount,
-        uint256 fraudNotifierRewardMultiplier,
+        uint256 fraudChallengeDepositAmount,
         uint256 fraudChallengeDefeatTimeout,
-        uint256 fraudChallengeDepositAmount
+        uint96 fraudSlashingAmount,
+        uint256 fraudNotifierRewardMultiplier
     );
 
     /// @notice Updates parameters of deposits.
@@ -334,17 +352,29 @@ library BridgeState {
     ///        request was created via `requestRedemption` call. Reported  timed
     ///        out requests are cancelled and locked TBTC is returned to the
     ///        redeemer in full amount.
+    /// @param _redemptionTimeoutSlashingAmount New value of the redemption
+    ///        timeout slashing amount in T, it is the amount slashed from each
+    ///        wallet member for redemption timeout
+    /// @param _redemptionTimeoutNotifierRewardMultiplier New value of the
+    ///        redemption timeout notifier reward multiplier as percentage,
+    ///        it determines the percentage of the notifier reward from the
+    ///        staking contact the notifier of a redemption timeout receives.
+    ///        The value must be in the range [0, 100]
     /// @dev Requirements:
     ///      - Redemption dust threshold must be greater than zero
     ///      - Redemption treasury fee divisor must be greater than zero
     ///      - Redemption transaction max fee must be greater than zero
     ///      - Redemption timeout must be greater than zero
+    ///      - Redemption timeout notifier reward multiplier must be in the
+    ///        range [0, 100]
     function updateRedemptionParameters(
         Storage storage self,
         uint64 _redemptionDustThreshold,
         uint64 _redemptionTreasuryFeeDivisor,
         uint64 _redemptionTxMaxFee,
-        uint256 _redemptionTimeout
+        uint256 _redemptionTimeout,
+        uint96 _redemptionTimeoutSlashingAmount,
+        uint256 _redemptionTimeoutNotifierRewardMultiplier
     ) internal {
         require(
             _redemptionDustThreshold > 0,
@@ -366,16 +396,26 @@ library BridgeState {
             "Redemption timeout must be greater than zero"
         );
 
+        require(
+            _redemptionTimeoutNotifierRewardMultiplier <= 100,
+            "Redemption timeout notifier reward multiplier must be in the range [0, 100]"
+        );
+
         self.redemptionDustThreshold = _redemptionDustThreshold;
         self.redemptionTreasuryFeeDivisor = _redemptionTreasuryFeeDivisor;
         self.redemptionTxMaxFee = _redemptionTxMaxFee;
         self.redemptionTimeout = _redemptionTimeout;
+        self.redemptionTimeoutSlashingAmount = _redemptionTimeoutSlashingAmount;
+        self
+            .redemptionTimeoutNotifierRewardMultiplier = _redemptionTimeoutNotifierRewardMultiplier;
 
         emit RedemptionParametersUpdated(
             _redemptionDustThreshold,
             _redemptionTreasuryFeeDivisor,
             _redemptionTxMaxFee,
-            _redemptionTimeout
+            _redemptionTimeout,
+            _redemptionTimeoutSlashingAmount,
+            _redemptionTimeoutNotifierRewardMultiplier
         );
     }
 
@@ -385,50 +425,73 @@ library BridgeState {
     ///        BTC transaction fee that is acceptable in a single moving funds
     ///        transaction. This is a _total_ max fee for the entire moving
     ///        funds transaction.
-    /// @param _movingFundsTimeout New value of the moving funds timeout in
-    ///        seconds. It is the time after which the moving funds process can
-    ///        be reported as timed out. It is counted from the moment when the
-    ///        wallet was requested to move their funds and switched to the
-    ///        MovingFunds state.
     /// @param _movingFundsDustThreshold New value of the moving funds dust
     ///        threshold. It is the minimal satoshi amount that makes sense to
     //         be transferred during the moving funds process. Moving funds
     //         wallets having their BTC balance below that value can begin
     //         closing immediately as transferring such a low value may not be
     //         possible due to BTC network fees.
+    /// @param _movingFundsTimeout New value of the moving funds timeout in
+    ///        seconds. It is the time after which the moving funds process can
+    ///        be reported as timed out. It is counted from the moment when the
+    ///        wallet was requested to move their funds and switched to the
+    ///        MovingFunds state.
+    /// @param _movingFundsTimeoutSlashingAmount New value of the moving funds
+    ///        timeout slashing amount in T, it is the amount slashed from each
+    ///        wallet member for moving funds timeout
+    /// @param _movingFundsTimeoutNotifierRewardMultiplier New value of the
+    ///        moving funds timeout notifier reward multiplier as percentage,
+    ///        it determines the percentage of the notifier reward from the
+    ///        staking contact the notifier of a moving funds timeout receives.
+    ///        The value must be in the range [0, 100]
     /// @dev Requirements:
     ///      - Moving funds transaction max total fee must be greater than zero
-    ///      - Moving funds timeout must be greater than zero
     ///      - Moving funds dust threshold must be greater than zero
+    ///      - Moving funds timeout must be greater than zero
+    ///      - Moving funds timeout notifier reward multiplier must be in the
+    ///        range [0, 100]
     function updateMovingFundsParameters(
         Storage storage self,
         uint64 _movingFundsTxMaxTotalFee,
+        uint64 _movingFundsDustThreshold,
         uint32 _movingFundsTimeout,
-        uint64 _movingFundsDustThreshold
+        uint96 _movingFundsTimeoutSlashingAmount,
+        uint256 _movingFundsTimeoutNotifierRewardMultiplier
     ) internal {
         require(
             _movingFundsTxMaxTotalFee > 0,
             "Moving funds transaction max total fee must be greater than zero"
         );
 
+        require(
+            _movingFundsDustThreshold > 0,
+            "Moving funds dust threshold must be greater than zero"
+        );
+
         require(
             _movingFundsTimeout > 0,
             "Moving funds timeout must be greater than zero"
         );
 
         require(
-            _movingFundsDustThreshold > 0,
-            "Moving funds dust threshold must be greater than zero"
+            _movingFundsTimeoutNotifierRewardMultiplier <= 100,
+            "Moving funds timeout notifier reward multiplier must be in the range [0, 100]"
         );
 
         self.movingFundsTxMaxTotalFee = _movingFundsTxMaxTotalFee;
-        self.movingFundsTimeout = _movingFundsTimeout;
         self.movingFundsDustThreshold = _movingFundsDustThreshold;
+        self.movingFundsTimeout = _movingFundsTimeout;
+        self
+            .movingFundsTimeoutSlashingAmount = _movingFundsTimeoutSlashingAmount;
+        self
+            .movingFundsTimeoutNotifierRewardMultiplier = _movingFundsTimeoutNotifierRewardMultiplier;
 
         emit MovingFundsParametersUpdated(
             _movingFundsTxMaxTotalFee,
+            _movingFundsDustThreshold,
             _movingFundsTimeout,
-            _movingFundsDustThreshold
+            _movingFundsTimeoutSlashingAmount,
+            _movingFundsTimeoutNotifierRewardMultiplier
         );
     }
 
@@ -505,6 +568,12 @@ library BridgeState {
     }
 
     /// @notice Updates parameters related to frauds.
+    /// @param _fraudChallengeDepositAmount New value of the fraud challenge
+    ///        deposit amount in wei, it is the amount of ETH the party
+    ///        challenging the wallet for fraud needs to deposit
+    /// @param _fraudChallengeDefeatTimeout New value of the challenge defeat
+    ///        timeout in seconds, it is the amount of time the wallet has to
+    ///        defeat a fraud challenge. The value must be greater than zero
     /// @param _fraudSlashingAmount New value of the fraud slashing amount in T,
     ///        it is the amount slashed from each wallet member for committing
     ///        a fraud
@@ -512,42 +581,36 @@ library BridgeState {
     ///        reward multiplier as percentage, it determines the percentage of
     ///        the notifier reward from the staking contact the notifier of
     ///        a fraud receives. The value must be in the range [0, 100]
-    /// @param _fraudChallengeDefeatTimeout New value of the challenge defeat
-    ///        timeout in seconds, it is the amount of time the wallet has to
-    ///        defeat a fraud challenge. The value must be greater than zero
-    /// @param _fraudChallengeDepositAmount New value of the fraud challenge
-    ///        deposit amount in wei, it is the amount of ETH the party
-    ///        challenging the wallet for fraud needs to deposit
     /// @dev Requirements:
-    ///      - Fraud notifier reward multiplier must be in the range [0, 100]
     ///      - Fraud challenge defeat timeout must be greater than 0
+    ///      - Fraud notifier reward multiplier must be in the range [0, 100]
     function updateFraudParameters(
         Storage storage self,
-        uint96 _fraudSlashingAmount,
-        uint256 _fraudNotifierRewardMultiplier,
+        uint256 _fraudChallengeDepositAmount,
         uint256 _fraudChallengeDefeatTimeout,
-        uint256 _fraudChallengeDepositAmount
+        uint96 _fraudSlashingAmount,
+        uint256 _fraudNotifierRewardMultiplier
     ) internal {
         require(
-            _fraudNotifierRewardMultiplier <= 100,
-            "Fraud notifier reward multiplier must be in the range [0, 100]"
+            _fraudChallengeDefeatTimeout > 0,
+            "Fraud challenge defeat timeout must be greater than zero"
         );
 
         require(
-            _fraudChallengeDefeatTimeout > 0,
-            "Fraud challenge defeat timeout must be greater than zero"
+            _fraudNotifierRewardMultiplier <= 100,
+            "Fraud notifier reward multiplier must be in the range [0, 100]"
         );
 
+        self.fraudChallengeDepositAmount = _fraudChallengeDepositAmount;
+        self.fraudChallengeDefeatTimeout = _fraudChallengeDefeatTimeout;
         self.fraudSlashingAmount = _fraudSlashingAmount;
         self.fraudNotifierRewardMultiplier = _fraudNotifierRewardMultiplier;
-        self.fraudChallengeDefeatTimeout = _fraudChallengeDefeatTimeout;
-        self.fraudChallengeDepositAmount = _fraudChallengeDepositAmount;
 
         emit FraudParametersUpdated(
-            _fraudSlashingAmount,
-            _fraudNotifierRewardMultiplier,
+            _fraudChallengeDepositAmount,
             _fraudChallengeDefeatTimeout,
-            _fraudChallengeDepositAmount
+            _fraudSlashingAmount,
+            _fraudNotifierRewardMultiplier
         );
     }
 }

package/contracts/bridge/Fraud.sol

@@ -277,7 +277,7 @@ library Fraud {
     ///        for the given `walletID`. Those IDs are not directly stored
     ///        in the contract for gas efficiency purposes but they can be
     ///        read from appropriate `DkgResultSubmitted` and `DkgResultApproved`
-    ///        events.
+    ///        events of the `WalletRegistry` contract
     ///      - The amount of time indicated by `challengeDefeatTimeout` must pass
     ///        after the challenge was reported
     function notifyFraudChallengeDefeatTimeout(

package/contracts/bridge/MovingFunds.sol

@@ -434,12 +434,20 @@ library MovingFunds {
     /// @notice Notifies about a timed out moving funds process. Terminates
     ///         the wallet and slashes signing group members as a result.
     /// @param walletPubKeyHash 20-byte public key hash of the wallet
+    /// @param walletMembersIDs Identifiers of the wallet signing group members
     /// @dev Requirements:
     ///      - The wallet must be in the MovingFunds state
     ///      - The moving funds timeout must be actually exceeded
+    ///      - The expression `keccak256(abi.encode(walletMembersIDs))` must
+    ///        be exactly the same as the hash stored under `membersIdsHash`
+    ///        for the given `walletID`. Those IDs are not directly stored
+    ///        in the contract for gas efficiency purposes but they can be
+    ///        read from appropriate `DkgResultSubmitted` and `DkgResultApproved`
+    ///        events of the `WalletRegistry` contract
     function notifyMovingFundsTimeout(
         BridgeState.Storage storage self,
-        bytes20 walletPubKeyHash
+        bytes20 walletPubKeyHash,
+        uint32[] calldata walletMembersIDs
     ) external {
         Wallets.Wallet storage wallet = self.registeredWallets[
             walletPubKeyHash
@@ -459,8 +467,13 @@ library MovingFunds {
 
         self.terminateWallet(walletPubKeyHash);
 
-        // TODO: Perform slashing of wallet operators, reward the notifier
-        //       using seized amount, and add unit tests for that.
+        self.ecdsaWalletRegistry.seize(
+            self.movingFundsTimeoutSlashingAmount,
+            self.movingFundsTimeoutNotifierRewardMultiplier,
+            msg.sender,
+            wallet.ecdsaWalletID,
+            walletMembersIDs
+        );
 
         // slither-disable-next-line reentrancy-events
         emit MovingFundsTimedOut(walletPubKeyHash);

package/contracts/bridge/Redemption.sol

@@ -765,29 +765,41 @@ library Redemption {
     ///         with the given wallet, that has timed out. The redemption
     ///         request is identified by the key built as
     ///         `keccak256(walletPubKeyHash | redeemerOutputScript)`.
-    ///         The results of calling this function: the pending redemptions
-    ///         value for the wallet will be decreased by the requested amount
-    ///         (minus treasury fee), the tokens taken from the redeemer on
-    ///         redemption request will be returned to the redeemer, the request
-    ///         will be moved from pending redemptions to timed-out redemptions.
-    ///         If the state of the wallet is `Live` or `MovingFunds`, the
-    ///         wallet operators will be slashed.
-    ///         Additionally, if the state of wallet is `Live`, the wallet will
-    ///         be closed or marked as `MovingFunds` (depending on the presence
-    ///         or absence of the wallet's main UTXO) and the wallet will no
-    ///         longer be marked as the active wallet (if it was marked as such).
+    ///         The results of calling this function:
+    ///         - the pending redemptions value for the wallet will be decreased
+    ///           by the requested amount (minus treasury fee),
+    ///         - the tokens taken from the redeemer on redemption request will
+    ///           be returned to the redeemer,
+    ///         - the request will be moved from pending redemptions to
+    ///           timed-out redemptions,
+    ///         - if the state of the wallet is `Live` or `MovingFunds`, the
+    ///           wallet operators will be slashed and the notifier will be
+    ///           rewarded,
+    ///         - if the state of wallet is `Live`, the wallet will be closed or
+    ///           marked as `MovingFunds` (depending on the presence or absence
+    ///           of the wallet's main UTXO) and the wallet will no longer be
+    ///           marked as the active wallet (if it was marked as such).
     /// @param walletPubKeyHash 20-byte public key hash of the wallet
+    /// @param walletMembersIDs Identifiers of the wallet signing group members
     /// @param redeemerOutputScript  The redeemer's length-prefixed output
     ///        script (P2PKH, P2WPKH, P2SH or P2WSH)
     /// @dev Requirements:
+    ///      - The wallet must be in the Live or MovingFunds or Terminated state
     ///      - The redemption request identified by `walletPubKeyHash` and
     ///        `redeemerOutputScript` must exist
+    ///      - The expression `keccak256(abi.encode(walletMembersIDs))` must
+    ///        be exactly the same as the hash stored under `membersIdsHash`
+    ///        for the given `walletID`. Those IDs are not directly stored
+    ///        in the contract for gas efficiency purposes but they can be
+    ///        read from appropriate `DkgResultSubmitted` and `DkgResultApproved`
+    ///        events of the `WalletRegistry` contract
     ///      - The amount of time defined by `redemptionTimeout` must have
     ///        passed since the redemption was requested (the request must be
-    ///        timed-out).
+    ///        timed-out)
     function notifyRedemptionTimeout(
         BridgeState.Storage storage self,
         bytes20 walletPubKeyHash,
+        uint32[] calldata walletMembersIDs,
         bytes calldata redeemerOutputScript
     ) external {
         uint256 redemptionKey = uint256(
@@ -836,7 +848,17 @@ library Redemption {
         ) {
             // Propagate timeout consequences to the wallet
             self.notifyWalletTimedOutRedemption(walletPubKeyHash);
+
+            // Slash the wallet operators and reward the notifier
+            self.ecdsaWalletRegistry.seize(
+                self.redemptionTimeoutSlashingAmount,
+                self.redemptionTimeoutNotifierRewardMultiplier,
+                msg.sender,
+                wallet.ecdsaWalletID,
+                walletMembersIDs
+            );
         }
+
         // slither-disable-next-line reentrancy-events
         emit RedemptionTimedOut(walletPubKeyHash, redeemerOutputScript);
 

package/contracts/bridge/Wallets.sol

@@ -288,12 +288,11 @@ library Wallets {
         moveFunds(self, walletPubKeyHash);
     }
 
-    /// @notice Handles a notification about a wallet redemption timeout
-    ///         and requests slashing of the wallet operators. Triggers the
-    ///         wallet moving funds process only if the wallet is still in the
-    ///         Live state. That means multiple action timeouts can be reported
-    ///         for the same wallet but only the first report requests the
-    ///         wallet to move their funds.
+    /// @notice Handles a notification about a wallet redemption timeout.
+    ///         Triggers the wallet moving funds process only if the wallet is
+    ///         still in the Live state. That means multiple action timeouts can
+    ///         be reported for the same wallet but only the first report
+    ///         requests the wallet to move their funds.
     /// @param walletPubKeyHash 20-byte public key hash of the wallet
     /// @dev Requirements:
     ///      - The wallet must be in the `Live` or `MovingFunds` state
@@ -314,9 +313,6 @@ library Wallets {
         if (walletState == WalletState.Live) {
             moveFunds(self, walletPubKeyHash);
         }
-
-        // TODO: Perform slashing of wallet operators and transfer some of the
-        //       slashed tokens to the caller of this function.
     }
 
     /// @notice Notifies that the wallet is either old enough or has too few