Update stake mentions in docs

thesis · Apr 9, 2024 · b4552b1 · b4552b1
1 parent f73e729
commit b4552b1
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 7 deletions.
diff --git a/core/contracts/BitcoinRedeemer.sol b/core/contracts/BitcoinRedeemer.sol
@@ -138,7 +138,7 @@ contract BitcoinRedeemer is Ownable2StepUpgradeable, IReceiveApproval {
     ///      setup. This contract remains upgradable to have flexibility to handle
     ///      adjustments to tBTC Bridge changes.
     /// @dev Redemption data should include a `redeemer` address matching the
-    ///      address of the staker who is redeeming the shares. In case anything
+    ///      address of the deposit owner who is redeeming the shares. In case anything
     ///      goes wrong during the tBTC unminting process, the redeemer will be
     ///      able to claim the tBTC tokens back from the tBTC Bank contract.
     /// @param owner The owner of the stBTC tokens.

diff --git a/core/contracts/Dispatcher.sol b/core/contracts/Dispatcher.sol
@@ -19,7 +19,7 @@ contract Dispatcher is Router, Ownable2Step {
         bool authorized;
     }
 
-    /// The main stBTC contract holding tBTC deposited by stakers.
+    /// The main stBTC contract holding tBTC deposits.
     stBTC public immutable stbtc;
     /// tBTC token contract.
     IERC20 public immutable tbtc;

diff --git a/core/contracts/stBTC.sol b/core/contracts/stBTC.sol
@@ -13,10 +13,9 @@ import {ZeroAddress} from "./utils/Errors.sol";
 /// @title stBTC
 /// @notice This contract implements the ERC-4626 tokenized vault standard. By
 ///         staking tBTC, users acquire a liquid staking token called stBTC,
-///         commonly referred to as "shares". The staked tBTC is securely
-///         deposited into Acre's vaults, where it generates yield over time.
+///         commonly referred to as "shares".
 ///         Users have the flexibility to redeem stBTC, enabling them to
-///         withdraw their staked tBTC along with the accrued yield.
+///         withdraw their deposited tBTC along with the accrued yield.
 /// @dev ERC-4626 is a standard to optimize and unify the technical parameters
 ///      of yield-bearing vaults. This contract facilitates the minting and
 ///      burning of shares (stBTC), which are represented as standard ERC20
@@ -126,7 +125,7 @@ contract stBTC is ERC4626Fees, PausableOwnable {
     // TODO: Implement a governed upgrade process that initiates an update and
     //       then finalizes it after a delay.
     /// @notice Updates the dispatcher contract and gives it an unlimited
-    ///         allowance to transfer staked tBTC.
+    ///         allowance to transfer deposited tBTC.
     /// @param newDispatcher Address of the new dispatcher contract.
     function updateDispatcher(Dispatcher newDispatcher) external onlyOwner {
         if (address(newDispatcher) == address(0)) {

diff --git a/core/contracts/test/upgrades/stBTCV2.sol b/core/contracts/test/upgrades/stBTCV2.sol
@@ -117,7 +117,7 @@ contract stBTCV2 is ERC4626Fees, PausableOwnable {
     // TODO: Implement a governed upgrade process that initiates an update and
     //       then finalizes it after a delay.
     /// @notice Updates the dispatcher contract and gives it an unlimited
-    ///         allowance to transfer staked tBTC.
+    ///         allowance to transfer deposited tBTC.
     /// @param newDispatcher Address of the new dispatcher contract.
     function updateDispatcher(Dispatcher newDispatcher) external onlyOwner {
         if (address(newDispatcher) == address(0)) {