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

package/build/contracts/bridge/Wallets.sol/Wallets.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/4dae352543b4d68232673fef698e9426.json"
+  "buildInfo": "../../../build-info/3909615ca5118087c155583cb43fa5d3.json"
 }

package/build/contracts/l2/L2TBTC.sol/L2TBTC.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/4dae352543b4d68232673fef698e9426.json"
+  "buildInfo": "../../../build-info/3909615ca5118087c155583cb43fa5d3.json"
 }

package/build/contracts/l2/L2WormholeGateway.sol/IWormholeTokenBridge.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/4dae352543b4d68232673fef698e9426.json"
+  "buildInfo": "../../../build-info/3909615ca5118087c155583cb43fa5d3.json"
 }

package/build/contracts/l2/L2WormholeGateway.sol/L2WormholeGateway.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/4dae352543b4d68232673fef698e9426.json"
+  "buildInfo": "../../../build-info/3909615ca5118087c155583cb43fa5d3.json"
 }

package/build/contracts/maintainer/MaintainerProxy.sol/MaintainerProxy.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/4dae352543b4d68232673fef698e9426.json"
+  "buildInfo": "../../../build-info/3909615ca5118087c155583cb43fa5d3.json"
 }

package/build/contracts/relay/LightRelay.sol/ILightRelay.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/4dae352543b4d68232673fef698e9426.json"
+  "buildInfo": "../../../build-info/3909615ca5118087c155583cb43fa5d3.json"
 }

package/build/contracts/relay/LightRelay.sol/LightRelay.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/4dae352543b4d68232673fef698e9426.json"
+  "buildInfo": "../../../build-info/3909615ca5118087c155583cb43fa5d3.json"
 }

package/build/contracts/relay/LightRelay.sol/RelayUtils.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/4dae352543b4d68232673fef698e9426.json"
+  "buildInfo": "../../../build-info/3909615ca5118087c155583cb43fa5d3.json"
 }

package/build/contracts/relay/LightRelayMaintainerProxy.sol/LightRelayMaintainerProxy.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/4dae352543b4d68232673fef698e9426.json"
+  "buildInfo": "../../../build-info/3909615ca5118087c155583cb43fa5d3.json"
 }

package/build/contracts/token/TBTC.sol/TBTC.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/4dae352543b4d68232673fef698e9426.json"
+  "buildInfo": "../../../build-info/3909615ca5118087c155583cb43fa5d3.json"
 }

package/build/contracts/vault/DonationVault.sol/DonationVault.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/4dae352543b4d68232673fef698e9426.json"
+  "buildInfo": "../../../build-info/3909615ca5118087c155583cb43fa5d3.json"
 }

package/build/contracts/vault/IVault.sol/IVault.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/4dae352543b4d68232673fef698e9426.json"
+  "buildInfo": "../../../build-info/3909615ca5118087c155583cb43fa5d3.json"
 }

package/build/contracts/vault/TBTCOptimisticMinting.sol/TBTCOptimisticMinting.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/4dae352543b4d68232673fef698e9426.json"
+  "buildInfo": "../../../build-info/3909615ca5118087c155583cb43fa5d3.json"
 }

package/build/contracts/vault/TBTCVault.sol/TBTCVault.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/4dae352543b4d68232673fef698e9426.json"
+  "buildInfo": "../../../build-info/3909615ca5118087c155583cb43fa5d3.json"
 }

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";
 
@@ -49,6 +48,8 @@ contract WalletCoordinator is OwnableUpgradeable, Reimbursable {
     enum WalletAction {
         /// @dev The wallet does not perform any action.
         Idle,
+        /// @dev The wallet is executing heartbeat.
+        Heartbeat,
         /// @dev The wallet is handling a deposit sweep action.
         DepositSweep,
         /// @dev The wallet is handling a redemption action.
@@ -70,13 +71,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 +110,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,8 +121,20 @@ 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 wallet heartbeat request validity time. In other
+    ///         words, this is  the worst-case time for a wallet heartbeat
+    ///         during which the wallet is busy and canot take other actions.
+    ///         This is also the duration of the time lock applied to the wallet
+    ///         once a new heartbeat request is submitted.
+    ///
+    ///         For example, if a deposit sweep proposal was submitted at
+    ///         2 pm and heartbeatRequestValidity is 1 hour, the next request or
+    ///         proposal (of any type) can be submitted after 3 pm.
+    uint32 public heartbeatRequestValidity;
+
+    /// @notice Gas that is meant to balance the heartbeat request overall cost.
+    ///         Can be updated by the owner based on the current conditions.
+    uint32 public heartbeatRequestGasOffset;
 
     /// @notice Determines the deposit sweep proposal validity time. In other
     ///         words, this is the worst-case time for a deposit sweep during
@@ -175,61 +182,37 @@ contract WalletCoordinator is OwnableUpgradeable, Reimbursable {
 
     /// @notice Gas that is meant to balance the deposit sweep proposal
     ///         submission overall cost. Can be updated by the owner based on
-    ///         the current market conditions.
+    ///         the current 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);
 
-    event DepositSweepProposalValidityUpdated(
-        uint32 depositSweepProposalValidity
+    event HeartbeatRequestParametersUpdated(
+        uint32 heartbeatRequestValidity,
+        uint32 heartbeatRequestGasOffset
     );
 
-    event DepositMinAgeUpdated(uint32 depositMinAge);
-
-    event DepositRefundSafetyMarginUpdated(uint32 depositRefundSafetyMargin);
-
-    event DepositSweepMaxSizeUpdated(uint16 depositSweepMaxSize);
+    event HeartbeatRequestSubmitted(bytes20 walletPubKeyHash, bytes message);
 
-    event DepositSweepProposalSubmissionGasOffsetUpdated(
+    event DepositSweepProposalParametersUpdated(
+        uint32 depositSweepProposalValidity,
+        uint32 depositMinAge,
+        uint32 depositRefundSafetyMargin,
+        uint16 depositSweepMaxSize,
         uint32 depositSweepProposalSubmissionGasOffset
     );
 
     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,49 +234,45 @@ 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();
+
+        heartbeatRequestValidity = 1 hours;
+        heartbeatRequestGasOffset = 5_000;
 
         depositSweepProposalValidity = 4 hours;
         depositMinAge = 2 hours;
         depositRefundSafetyMargin = 24 hours;
         depositSweepMaxSize = 5;
-        depositSweepProposalSubmissionGasOffset = 25000;
+        depositSweepProposalSubmissionGasOffset = 5_000;
     }
 
-    /// @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.
@@ -309,61 +288,96 @@ contract WalletCoordinator is OwnableUpgradeable, Reimbursable {
         emit WalletManuallyUnlocked(walletPubKeyHash);
     }
 
-    /// @notice Updates the value of the depositSweepProposalValidity parameter.
-    /// @param _depositSweepProposalValidity New value.
+    /// @notice Updates parameters related to heartbeat request.
+    /// @param _heartbeatRequestValidity The new value of `heartbeatRequestValidity`.
+    /// @param _heartbeatRequestGasOffset The new value of `heartbeatRequestGasOffset`.
     /// @dev Requirements:
     ///      - The caller must be the owner.
-    function updateDepositSweepProposalValidity(
-        uint32 _depositSweepProposalValidity
+    function updateHeartbeatRequestParameters(
+        uint32 _heartbeatRequestValidity,
+        uint32 _heartbeatRequestGasOffset
     ) external onlyOwner {
-        depositSweepProposalValidity = _depositSweepProposalValidity;
-        emit DepositSweepProposalValidityUpdated(_depositSweepProposalValidity);
+        heartbeatRequestValidity = _heartbeatRequestValidity;
+        heartbeatRequestGasOffset = _heartbeatRequestGasOffset;
+        emit HeartbeatRequestParametersUpdated(
+            _heartbeatRequestValidity,
+            _heartbeatRequestGasOffset
+        );
     }
 
-    /// @notice Updates the value of the depositMinAge parameter.
-    /// @param _depositMinAge New value.
+    /// @notice Updates parameters related to deposit sweep proposal.
+    /// @param _depositSweepProposalValidity The new value of `depositSweepProposalValidity`.
+    /// @param _depositMinAge The new value of `depositMinAge`.
+    /// @param _depositRefundSafetyMargin The new value of `depositRefundSafetyMargin`.
+    /// @param _depositSweepMaxSize The new value of `depositSweepMaxSize`.
     /// @dev Requirements:
     ///      - The caller must be the owner.
-    function updateDepositMinAge(uint32 _depositMinAge) external onlyOwner {
+    function updateDepositSweepProposalParameters(
+        uint32 _depositSweepProposalValidity,
+        uint32 _depositMinAge,
+        uint32 _depositRefundSafetyMargin,
+        uint16 _depositSweepMaxSize,
+        uint32 _depositSweepProposalSubmissionGasOffset
+    ) external onlyOwner {
+        depositSweepProposalValidity = _depositSweepProposalValidity;
         depositMinAge = _depositMinAge;
-        emit DepositMinAgeUpdated(_depositMinAge);
-    }
-
-    /// @notice Updates the value of the depositRefundSafetyMargin parameter.
-    /// @param _depositRefundSafetyMargin New value.
-    /// @dev Requirements:
-    ///      - The caller must be the owner.
-    function updateDepositRefundSafetyMargin(uint32 _depositRefundSafetyMargin)
-        external
-        onlyOwner
-    {
         depositRefundSafetyMargin = _depositRefundSafetyMargin;
-        emit DepositRefundSafetyMarginUpdated(_depositRefundSafetyMargin);
+        depositSweepMaxSize = _depositSweepMaxSize;
+        depositSweepProposalSubmissionGasOffset = _depositSweepProposalSubmissionGasOffset;
+
+        emit DepositSweepProposalParametersUpdated(
+            _depositSweepProposalValidity,
+            _depositMinAge,
+            _depositRefundSafetyMargin,
+            _depositSweepMaxSize,
+            _depositSweepProposalSubmissionGasOffset
+        );
     }
 
-    /// @notice Updates the value of the depositSweepMaxSize parameter.
-    /// @param _depositSweepMaxSize New value.
+    /// @notice Submits a heartbeat request from the wallet. Locks the wallet
+    ///         for a specific time, equal to the request validity period.
+    ///         This function validates the proposed heartbeat messge to see
+    ///         if it matches the heartbeat format expected by the Bridge.
+    /// @param walletPubKeyHash 20-byte public key hash of the wallet that is
+    ///        supposed to execute the heartbeat.
+    /// @param message The proposed heartbeat message for the wallet to sign.
     /// @dev Requirements:
-    ///      - The caller must be the owner.
-    function updateDepositSweepMaxSize(uint16 _depositSweepMaxSize)
-        external
-        onlyOwner
+    ///      - The caller is a coordinator,
+    ///      - The wallet is not time-locked,
+    ///      - The message to sign is a valid heartbeat message.
+    function requestHeartbeat(bytes20 walletPubKeyHash, bytes calldata message)
+        public
+        onlyCoordinator
+        onlyAfterWalletLock(walletPubKeyHash)
     {
-        depositSweepMaxSize = _depositSweepMaxSize;
-        emit DepositSweepMaxSizeUpdated(_depositSweepMaxSize);
+        require(
+            Heartbeat.isValidHeartbeatMessage(message),
+            "Not a valid heartbeat message"
+        );
+
+        walletLock[walletPubKeyHash] = WalletLock(
+            /* solhint-disable-next-line not-rely-on-time */
+            uint32(block.timestamp) + heartbeatRequestValidity,
+            WalletAction.Heartbeat
+        );
+
+        emit HeartbeatRequestSubmitted(walletPubKeyHash, message);
     }
 
-    /// @notice Updates the value of the depositSweepProposalSubmissionGasOffset
-    ///         parameter.
-    /// @param _depositSweepProposalSubmissionGasOffset New value.
-    /// @dev Requirements:
-    ///      - The caller must be the owner.
-    function updateDepositSweepProposalSubmissionGasOffset(
-        uint32 _depositSweepProposalSubmissionGasOffset
-    ) external onlyOwner {
-        depositSweepProposalSubmissionGasOffset = _depositSweepProposalSubmissionGasOffset;
-        emit DepositSweepProposalSubmissionGasOffsetUpdated(
-            _depositSweepProposalSubmissionGasOffset
+    /// @notice Wraps `requestHeartbeat` call and reimburses the caller's
+    ///         transaction cost.
+    /// @dev See `requestHeartbeat` function documentation.
+    function requestHeartbeatWithReimbursement(
+        bytes20 walletPubKeyHash,
+        bytes calldata message
+    ) external {
+        uint256 gasStart = gasleft();
+
+        requestHeartbeat(walletPubKeyHash, message);
+
+        reimbursementPool.refund(
+            (gasStart - gasleft()) + heartbeatRequestGasOffset,
+            msg.sender
         );
     }
 
@@ -374,23 +388,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 +409,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,