@keep-network/tbtc-v2 1.3.0-dev.5 → 1.3.0-dev.6

package/contracts/bridge/WalletCoordinator.sol

@@ -17,7 +17,6 @@ pragma solidity 0.8.17;
 
 import {BTCUtils} from "@keep-network/bitcoin-spv-sol/contracts/BTCUtils.sol";
 import {BytesLib} from "@keep-network/bitcoin-spv-sol/contracts/BytesLib.sol";
-import {IWalletRegistry as EcdsaWalletRegistry} from "@keep-network/ecdsa/contracts/api/IWalletRegistry.sol";
 import "@keep-network/random-beacon/contracts/Reimbursable.sol";
 import "@keep-network/random-beacon/contracts/ReimbursementPool.sol";
 
@@ -70,13 +69,6 @@ contract WalletCoordinator is OwnableUpgradeable, Reimbursable {
         WalletAction cause;
     }
 
-    /// @notice Helper structure carrying data necessary to validate the wallet
-    ///         membership of the caller.
-    struct WalletMemberContext {
-        uint32[] walletMembersIDs;
-        uint256 walletMemberIndex;
-    }
-
     /// @notice Helper structure representing a deposit sweep proposal.
     struct DepositSweepProposal {
         // 20-byte public key hash of the target wallet.
@@ -116,8 +108,9 @@ contract WalletCoordinator is OwnableUpgradeable, Reimbursable {
         bytes4 refundLocktime;
     }
 
-    /// @notice Mapping that holds addresses allowed to submit proposals.
-    mapping(address => bool) public isProposalSubmitter;
+    /// @notice Mapping that holds addresses allowed to submit proposals and
+    ///         request heartbeats.
+    mapping(address => bool) public isCoordinator;
 
     /// @notice Mapping that holds wallet time locks. The key is a 20-byte
     ///         wallet public key hash.
@@ -126,9 +119,6 @@ contract WalletCoordinator is OwnableUpgradeable, Reimbursable {
     /// @notice Handle to the Bridge contract.
     Bridge public bridge;
 
-    /// @notice Handle to the WalletRegistry contract.
-    EcdsaWalletRegistry public walletRegistry;
-
     /// @notice Determines the deposit sweep proposal validity time. In other
     ///         words, this is the worst-case time for a deposit sweep during
     ///         which the wallet is busy and cannot take another actions. This
@@ -178,9 +168,9 @@ contract WalletCoordinator is OwnableUpgradeable, Reimbursable {
     ///         the current market conditions.
     uint32 public depositSweepProposalSubmissionGasOffset;
 
-    event ProposalSubmitterAdded(address indexed proposalSubmitter);
+    event CoordinatorAdded(address indexed coordinator);
 
-    event ProposalSubmitterRemoved(address indexed proposalSubmitter);
+    event CoordinatorRemoved(address indexed coordinator);
 
     event WalletManuallyUnlocked(bytes20 indexed walletPubKeyHash);
 
@@ -200,35 +190,11 @@ contract WalletCoordinator is OwnableUpgradeable, Reimbursable {
 
     event DepositSweepProposalSubmitted(
         DepositSweepProposal proposal,
-        address indexed proposalSubmitter
+        address indexed coordinator
     );
 
-    // TODO: Enhance this modifier by adding the coordinator role check. See:
-    //       https://github.com/keep-network/tbtc-v2/pull/575#discussion_r1151564813
-    modifier onlyProposalSubmitterOrWalletMember(
-        bytes20 walletPubKeyHash,
-        WalletMemberContext calldata walletMemberContext
-    ) {
-        bool proposalSubmitter = isProposalSubmitter[msg.sender];
-        bool walletMember = false;
-
-        if (!proposalSubmitter) {
-            bytes32 ecdsaWalletID = bridge
-                .wallets(walletPubKeyHash)
-                .ecdsaWalletID;
-
-            walletMember = walletRegistry.isWalletMember(
-                ecdsaWalletID,
-                walletMemberContext.walletMembersIDs,
-                msg.sender,
-                walletMemberContext.walletMemberIndex
-            );
-        }
-
-        require(
-            proposalSubmitter || walletMember,
-            "Caller is neither a proposal submitter nor a wallet member"
-        );
+    modifier onlyCoordinator() {
+        require(isCoordinator[msg.sender], "Caller is not a coordinator");
 
         _;
     }
@@ -251,9 +217,8 @@ contract WalletCoordinator is OwnableUpgradeable, Reimbursable {
         __Ownable_init();
 
         bridge = _bridge;
-        // Pre-fetch wallet registry address to save gas on calls protected
-        // by the onlyProposalSubmitterOrWalletMember modifier.
-        (, , walletRegistry, reimbursementPool) = _bridge.contractReferences();
+        // Pre-fetch addresses to save gas later.
+        (, , , reimbursementPool) = _bridge.contractReferences();
 
         depositSweepProposalValidity = 4 hours;
         depositMinAge = 2 hours;
@@ -262,38 +227,32 @@ contract WalletCoordinator is OwnableUpgradeable, Reimbursable {
         depositSweepProposalSubmissionGasOffset = 25000;
     }
 
-    /// @notice Adds the given address to the proposal submitters set.
-    /// @param proposalSubmitter Address of the new proposal submitter.
+    /// @notice Adds the given address to the set of coordinator addresses.
+    /// @param coordinator Address of the new coordinator.
     /// @dev Requirements:
     ///      - The caller must be the owner,
-    ///      - The `proposalSubmitter` must not be an existing proposal submitter.
-    function addProposalSubmitter(address proposalSubmitter)
-        external
-        onlyOwner
-    {
+    ///      - The `coordinator` must not be an existing coordinator.
+    function addCoordinator(address coordinator) external onlyOwner {
         require(
-            !isProposalSubmitter[proposalSubmitter],
-            "This address is already a proposal submitter"
+            !isCoordinator[coordinator],
+            "This address is already a coordinator"
         );
-        isProposalSubmitter[proposalSubmitter] = true;
-        emit ProposalSubmitterAdded(proposalSubmitter);
+        isCoordinator[coordinator] = true;
+        emit CoordinatorAdded(coordinator);
     }
 
-    /// @notice Removes the given address from the proposal submitters set.
-    /// @param proposalSubmitter Address of the existing proposal submitter.
+    /// @notice Removes the given address from the set of coordinator addresses.
+    /// @param coordinator Address of the existing coordinator.
     /// @dev Requirements:
     ///      - The caller must be the owner,
-    ///      - The `proposalSubmitter` must be an existing proposal submitter.
-    function removeProposalSubmitter(address proposalSubmitter)
-        external
-        onlyOwner
-    {
+    ///      - The `coordinator` must be an existing coordinator.
+    function removeCoordinator(address coordinator) external onlyOwner {
         require(
-            isProposalSubmitter[proposalSubmitter],
-            "This address is not a proposal submitter"
+            isCoordinator[coordinator],
+            "This address is not a coordinator"
         );
-        delete isProposalSubmitter[proposalSubmitter];
-        emit ProposalSubmitterRemoved(proposalSubmitter);
+        delete isCoordinator[coordinator];
+        emit CoordinatorRemoved(coordinator);
     }
 
     /// @notice Allows to unlock the given wallet before their time lock expires.
@@ -374,23 +333,12 @@ contract WalletCoordinator is OwnableUpgradeable, Reimbursable {
     ///         off-chain members. Wallet members are supposed to validate
     ///         the proposal on their own, before taking any action.
     /// @param proposal The deposit sweep proposal
-    /// @param walletMemberContext Optional parameter holding some data allowing
-    ///        to confirm the wallet membership of the caller. This parameter is
-    ///        relevant only when the caller is not a registered proposal
-    ///        submitter but claims to be a member of the target wallet.
     /// @dev Requirements:
-    ///      - The caller is either a proposal submitter or a member of the
-    ///        target wallet,
+    ///      - The caller is a coordinator,
     ///      - The wallet is not time-locked.
-    function submitDepositSweepProposal(
-        DepositSweepProposal calldata proposal,
-        WalletMemberContext calldata walletMemberContext
-    )
+    function submitDepositSweepProposal(DepositSweepProposal calldata proposal)
         public
-        onlyProposalSubmitterOrWalletMember(
-            proposal.walletPubKeyHash,
-            walletMemberContext
-        )
+        onlyCoordinator
         onlyAfterWalletLock(proposal.walletPubKeyHash)
     {
         walletLock[proposal.walletPubKeyHash] = WalletLock(
@@ -406,12 +354,11 @@ contract WalletCoordinator is OwnableUpgradeable, Reimbursable {
     ///         caller's transaction cost.
     /// @dev See `submitDepositSweepProposal` function documentation.
     function submitDepositSweepProposalWithReimbursement(
-        DepositSweepProposal calldata proposal,
-        WalletMemberContext calldata walletMemberContext
+        DepositSweepProposal calldata proposal
     ) external {
         uint256 gasStart = gasleft();
 
-        submitDepositSweepProposal(proposal, walletMemberContext);
+        submitDepositSweepProposal(proposal);
 
         reimbursementPool.refund(
             (gasStart - gasleft()) + depositSweepProposalSubmissionGasOffset,