@keep-network/tbtc-v2 0.1.1-dev.70 → 0.1.1-dev.73

package/contracts/bridge/Wallets.sol

@@ -129,14 +129,14 @@ library Wallets {
     ///        UTXO of the given active wallet, as currently known on the
     ///        Ethereum chain. If there is no active wallet at the moment, or
     ///        the active wallet has no main UTXO, this parameter can be
-    ///        empty as it is ignored.
-    ///      - Wallet creation must not be in progress
+    ///        empty as it is ignored,
+    ///      - Wallet creation must not be in progress,
     ///      - If the active wallet is set, one of the following
     ///        conditions must be true:
     ///        - The active wallet BTC balance is above the minimum threshold
     ///          and the active wallet is old enough, i.e. the creation period
-    ///           was elapsed since its creation time
-    ///        - The active wallet BTC balance is above the maximum threshold
+    ///           was elapsed since its creation time,
+    ///        - The active wallet BTC balance is above the maximum threshold.
     function requestNewWallet(
         BridgeState.Storage storage self,
         BitcoinTx.UTXO calldata activeWalletMainUtxo
@@ -181,7 +181,7 @@ library Wallets {
     }
 
     /// @notice Gets BTC balance for given the wallet.
-    /// @param walletPubKeyHash 20-byte public key hash of the wallet
+    /// @param walletPubKeyHash 20-byte public key hash of the wallet.
     /// @param walletMainUtxo Data of the wallet's main UTXO, as currently
     ///        known on the Ethereum chain.
     /// @return walletBtcBalance Current BTC balance for the given wallet.
@@ -227,8 +227,8 @@ library Wallets {
     /// @param publicKeyX Wallet's public key's X coordinate.
     /// @param publicKeyY Wallet's public key's Y coordinate.
     /// @dev Requirements:
-    ///      - The only caller authorized to call this function is `registry`
-    ///      - Given wallet data must not belong to an already registered wallet
+    ///      - The only caller authorized to call this function is `registry`,
+    ///      - Given wallet data must not belong to an already registered wallet.
     function registerNewWallet(
         BridgeState.Storage storage self,
         bytes32 ecdsaWalletID,
@@ -268,8 +268,8 @@ library Wallets {
     /// @param publicKeyX Wallet's public key's X coordinate.
     /// @param publicKeyY Wallet's public key's Y coordinate.
     /// @dev Requirements:
-    ///      - The only caller authorized to call this function is `registry`
-    ///      - Wallet must be in Live state
+    ///      - The only caller authorized to call this function is `registry`,
+    ///      - Wallet must be in Live state.
     function notifyWalletHeartbeatFailed(
         BridgeState.Storage storage self,
         bytes32 publicKeyX,
@@ -298,9 +298,9 @@ library Wallets {
     ///         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
+    /// @param walletPubKeyHash 20-byte public key hash of the wallet.
     /// @dev Requirements:
-    ///      - The wallet must be in the `Live` or `MovingFunds` state
+    ///      - The wallet must be in the `Live` or `MovingFunds` state.
     function notifyWalletTimedOutRedemption(
         BridgeState.Storage storage self,
         bytes20 walletPubKeyHash
@@ -322,19 +322,19 @@ library Wallets {
 
     /// @notice Notifies that the wallet is either old enough or has too few
     ///         satoshis left and qualifies to be closed.
-    /// @param walletPubKeyHash 20-byte public key hash of the wallet
+    /// @param walletPubKeyHash 20-byte public key hash of the wallet.
     /// @param walletMainUtxo Data of the wallet's main UTXO, as currently
     ///        known on the Ethereum chain.
     /// @dev Requirements:
-    ///      - Wallet must not be set as the current active wallet
+    ///      - Wallet must not be set as the current active wallet,
     ///      - Wallet must exceed the wallet maximum age OR the wallet BTC
     ///        balance must be lesser than the minimum threshold. If the latter
     ///        case is true, the `walletMainUtxo` components must point to the
     ///        recent main UTXO of the given wallet, as currently known on the
     ///        Ethereum chain. If the wallet has no main UTXO, this parameter
     ///        can be empty as it is ignored since the wallet balance is
-    ///        assumed to be zero.
-    ///      - Wallet must be in Live state
+    ///        assumed to be zero,
+    ///      - Wallet must be in Live state.
     function notifyCloseableWallet(
         BridgeState.Storage storage self,
         bytes20 walletPubKeyHash,
@@ -370,9 +370,9 @@ library Wallets {
     ///         funds request refers to the current active wallet, such a wallet
     ///         is no longer considered active and the active wallet slot
     ///         is unset allowing to trigger a new wallet creation immediately.
-    /// @param walletPubKeyHash 20-byte public key hash of the wallet
+    /// @param walletPubKeyHash 20-byte public key hash of the wallet.
     /// @dev Requirements:
-    ///      - The caller must make sure that the wallet is in the Live state
+    ///      - The caller must make sure that the wallet is in the Live state.
     function moveFunds(
         BridgeState.Storage storage self,
         bytes20 walletPubKeyHash
@@ -403,10 +403,10 @@ library Wallets {
     }
 
     /// @notice Begins the closing period of the given wallet.
-    /// @param walletPubKeyHash 20-byte public key hash of the wallet
+    /// @param walletPubKeyHash 20-byte public key hash of the wallet.
     /// @dev Requirements:
     ///      - The caller must make sure that the wallet is in the
-    ///        MovingFunds state
+    ///        MovingFunds state.
     function beginWalletClosing(
         BridgeState.Storage storage self,
         bytes20 walletPubKeyHash
@@ -423,10 +423,10 @@ library Wallets {
     /// @notice Notifies about the end of the closing period for the given wallet.
     ///         Closes the wallet ultimately and notifies the ECDSA registry
     ///         about this fact.
-    /// @param walletPubKeyHash 20-byte public key hash of the wallet
+    /// @param walletPubKeyHash 20-byte public key hash of the wallet.
     /// @dev Requirements:
-    ///      - The wallet must be in the Closing state
-    ///      - The wallet closing period must have elapsed
+    ///      - The wallet must be in the Closing state,
+    ///      - The wallet closing period must have elapsed.
     function notifyWalletClosingPeriodElapsed(
         BridgeState.Storage storage self,
         bytes20 walletPubKeyHash
@@ -450,9 +450,9 @@ library Wallets {
 
     /// @notice Finalizes the closing period of the given wallet and notifies
     ///         the ECDSA registry about this fact.
-    /// @param walletPubKeyHash 20-byte public key hash of the wallet
+    /// @param walletPubKeyHash 20-byte public key hash of the wallet.
     /// @dev Requirements:
-    ///      - The caller must make sure that the wallet is in the Closing state
+    ///      - The caller must make sure that the wallet is in the Closing state.
     function finalizeWalletClosing(
         BridgeState.Storage storage self,
         bytes20 walletPubKeyHash
@@ -471,7 +471,7 @@ library Wallets {
     ///         active wallet, such a wallet is no longer considered active and
     ///         the active wallet slot is unset allowing to trigger a new wallet
     ///         creation immediately.
-    /// @param walletPubKeyHash 20-byte public key hash of the wallet
+    /// @param walletPubKeyHash 20-byte public key hash of the wallet.
     /// @dev Requirements:
     ///      - The caller must make sure that the wallet is in the
     ///        Live or MovingFunds or Closing state.
@@ -503,16 +503,16 @@ library Wallets {
     ///         successfully. Checks if the funds were moved to the expected
     ///         target wallets. Closes the source wallet if everything went
     ///         good and reverts otherwise.
-    /// @param walletPubKeyHash 20-byte public key hash of the wallet
+    /// @param walletPubKeyHash 20-byte public key hash of the wallet.
     /// @param targetWalletsHash 32-byte keccak256 hash over the list of
     ///        20-byte public key hashes of the target wallets actually used
     ///        within the moving funds transactions.
     /// @dev Requirements:
     ///      - The caller must make sure the moving funds transaction actually
-    ///        happened on Bitcoin chain and fits the protocol requirements.
-    ///      - The source wallet must be in the MovingFunds state
+    ///        happened on Bitcoin chain and fits the protocol requirements,
+    ///      - The source wallet must be in the MovingFunds state,
     ///      - The target wallets commitment must be submitted by the source
-    ///        wallet.
+    ///        wallet,
     ///      - The actual target wallets used in the moving funds transaction
     ///        must be exactly the same as the target wallets commitment.
     function notifyWalletFundsMoved(

package/contracts/vault/DonationVault.sol

@@ -49,10 +49,10 @@ contract DonationVault is IVault {
     /// @notice Transfers the given `amount` of the Bank balance from the
     ///         caller to the Donation Vault and immediately decreases the
     ///         vault's balance in the Bank by the transferred `amount`.
-    /// @param amount Amount of the Bank balance to donate
+    /// @param amount Amount of the Bank balance to donate.
     /// @dev Requirements:
     ///      - The caller's balance in the Bank must be greater than or equal
-    ///        to the `amount`.
+    ///        to the `amount`,
     ///      - Donation Vault must have an allowance for caller's balance in
     ///        the Bank for at least `amount`.
     function donate(uint256 amount) external {
@@ -73,11 +73,11 @@ contract DonationVault is IVault {
     ///         `owner` to the Donation Vault and immediately decreases the
     ///         vault's balance in the Bank by the transferred `amount`.
     /// @param owner Address of the Bank balance owner who approved their
-    ///        balance to be used by the vault
+    ///        balance to be used by the vault.
     /// @param amount The amount of the Bank balance approved by the owner
-    ///        to be used by the vault
+    ///        to be used by the vault.
     /// @dev Requirements:
-    ///      - Can only be called by the Bank via `approveBalanceAndCall`.
+    ///      - Can only be called by the Bank via `approveBalanceAndCall`,
     ///      - The `owner` balance in the Bank must be greater than or equal
     ///        to the `amount`.
     function receiveBalanceApproval(address owner, uint256 amount)
@@ -99,13 +99,13 @@ contract DonationVault is IVault {
     /// @notice Ignores the deposited amounts and does not increase depositors'
     ///         individual balances. The vault decreases its own tBTC balance
     ///         in the Bank by the total deposited amount.
-    /// @param depositors Addresses of depositors whose deposits have been swept
+    /// @param depositors Addresses of depositors whose deposits have been swept.
     /// @param depositedAmounts Amounts deposited by individual depositors and
-    ///        swept
+    ///        swept.
     /// @dev Requirements:
     ///      - Can only be called by the Bank after the Bridge swept deposits
-    ///        and Bank increased balance for the vault.
-    ///      - The `depositors` array must not be empty.
+    ///        and Bank increased balance for the vault,
+    ///      - The `depositors` array must not be empty,
     ///      - The `depositors` array length must be equal to the
     ///        `depositedAmounts` array length.
     function receiveBalanceIncrease(

package/contracts/vault/IVault.sol

@@ -25,9 +25,9 @@ interface IVault {
     ///         and call the vault to use the approved balance in a single
     ///         transaction.
     /// @param owner Address of the Bank balance owner who approved their
-    ///        balance to be used by the vault
+    ///        balance to be used by the vault.
     /// @param amount The amount of the Bank balance approved by the owner
-    ///        to be used by the vault
+    ///        to be used by the vault.
     // @dev The implementation must ensure this function can only be called
     ///      by the Bank. The Bank does _not_ guarantee that the `amount`
     ///      approved by the `owner` currently exists on their balance. That is,
@@ -46,9 +46,9 @@ interface IVault {
     ///         depositor does not have to execute additional transaction after
     ///         the deposit gets swept by the Bridge to approve and transfer
     ///         their balance to the vault.
-    /// @param depositors Addresses of depositors whose deposits have been swept
+    /// @param depositors Addresses of depositors whose deposits have been swept.
     /// @param depositedAmounts Amounts deposited by individual depositors and
-    ///        swept
+    ///        swept.
     /// @dev The implementation must ensure this function can only be called
     ///      by the Bank. The Bank guarantees that the vault's balance was
     ///      increased by the sum of all deposited amounts before this function

package/contracts/vault/TBTCVault.sol

@@ -15,6 +15,8 @@
 
 pragma solidity ^0.8.9;
 
+import "@keep-network/random-beacon/contracts/Governable.sol";
+
 import "./IVault.sol";
 import "../bank/Bank.sol";
 import "../token/TBTC.sol";
@@ -27,7 +29,7 @@ import "../token/TBTC.sol";
 ///         Bank.
 /// @dev TBTC Vault is the owner of TBTC token contract and is the only contract
 ///      minting the token.
-contract TBTCVault is IVault {
+contract TBTCVault is IVault, Governable {
     Bank public bank;
     TBTC public tbtcToken;
 
@@ -53,13 +55,43 @@ contract TBTCVault is IVault {
 
         bank = _bank;
         tbtcToken = _tbtcToken;
+
+        _transferGovernance(msg.sender);
+    }
+
+    /// @notice Allows the governance of the TBTCVault to recover any ERC20
+    ///         token sent mistakenly to the TBTC token contract address.
+    /// @param token Address of the recovered ERC20 token contract.
+    /// @param recipient Address the recovered token should be sent to.
+    /// @param amount Recovered amount.
+    function recoverERC20(
+        IERC20 token,
+        address recipient,
+        uint256 amount
+    ) external onlyGovernance {
+        tbtcToken.recoverERC20(token, recipient, amount);
+    }
+
+    /// @notice Allows the governance of the TBTCVault to recover any ERC721
+    ///         token sent mistakenly to the TBTC token contract address.
+    /// @param token Address of the recovered ERC721 token contract.
+    /// @param recipient Address the recovered token should be sent to.
+    /// @param tokenId Identifier of the recovered token.
+    /// @param data Additional data.
+    function recoverERC721(
+        IERC721 token,
+        address recipient,
+        uint256 tokenId,
+        bytes calldata data
+    ) external onlyGovernance {
+        tbtcToken.recoverERC721(token, recipient, tokenId, data);
     }
 
     /// @notice Transfers the given `amount` of the Bank balance from caller
     ///         to TBTC Vault, and mints `amount` of TBTC to the caller.
     /// @dev TBTC Vault must have an allowance for caller's balance in the Bank
     ///      for at least `amount`.
-    /// @param amount Amount of TBTC to mint
+    /// @param amount Amount of TBTC to mint.
     function mint(uint256 amount) external {
         address minter = msg.sender;
         require(
@@ -73,8 +105,8 @@ contract TBTCVault is IVault {
     /// @notice Transfers the given `amount` of the Bank balance from the caller
     ///         to TBTC Vault and mints `amount` of TBTC to the caller.
     /// @dev Can only be called by the Bank via `approveBalanceAndCall`.
-    /// @param owner The owner who approved their Bank balance
-    /// @param amount Amount of TBTC to mint
+    /// @param owner The owner who approved their Bank balance.
+    /// @param amount Amount of TBTC to mint.
     function receiveBalanceApproval(address owner, uint256 amount)
         external
         override
@@ -108,7 +140,7 @@ contract TBTCVault is IVault {
     ///         `amount` back to the caller's balance in the Bank.
     /// @dev Caller must have at least `amount` of TBTC approved to
     ///       TBTC Vault.
-    /// @param amount Amount of TBTC to redeem
+    /// @param amount Amount of TBTC to redeem.
     function redeem(uint256 amount) external {
         _redeem(msg.sender, amount);
     }
@@ -118,9 +150,9 @@ contract TBTCVault is IVault {
     /// @dev This function is doing the same as `redeem` but it allows to
     ///      execute redemption without an additional approval transaction.
     ///      The function can be called only via `approveAndCall` of TBTC token.
-    /// @param from TBTC token holder executing redemption
-    /// @param amount Amount of TBTC to redeem
-    /// @param token TBTC token address
+    /// @param from TBTC token holder executing redemption.
+    /// @param amount Amount of TBTC to redeem.
+    /// @param token TBTC token address.
     function receiveApproval(
         address from,
         uint256 amount,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keep-network/tbtc-v2",
-  "version": "0.1.1-dev.70+main.b4eeb6c7af8a69554710724e6830a246f7b610db",
+  "version": "0.1.1-dev.73+main.c8a8bafd237774855af2c75fdcf76f598c555f42",
   "license": "MIT",
   "files": [
     "artifacts/",