Merge remote-tracking branch 'origin/token-vault' into deploy-scripts

core/.solhint.json

@@ -1,7 +1,4 @@
 {
   "extends": "thesis",
-  "plugins": [],
-  "rules": {
-    "func-visibility": ["off", { "ignoreConstructors": true }]
-  }
+  "plugins": []
 }

core/contracts/Acre.sol

@@ -3,14 +3,21 @@ pragma solidity ^0.8.21;
 
 import "@openzeppelin/contracts/token/ERC20/extensions/ERC4626.sol";
 
+/// @title Acre
+/// @notice Implementation of the ERR-4626 tokenized vault standard. ERC-4626 is
+///         a standard to optimize and unify the technical parameters of
+///         yield-bearing vaults. This contract allows the minting and burning
+///         of shares, represented as standard ERC20 token, in exchange for tBTC
+///         tokens.
+/// @dev ERC-4626 standard extends the ERC-20 token.
 contract Acre is ERC4626 {
     event Staked(bytes32 indexed referral, uint256 assets, uint256 shares);
 
     constructor(
-        IERC20 _token
-    ) ERC4626(_token) ERC20("Acre Staked Bitcoin", "stBTC") {}
+        IERC20 tbtc
+    ) ERC4626(tbtc) ERC20("Acre Staked Bitcoin", "stBTC") {}
 
-    /// @notice Stakes a given amount of underlying token and mints shares to a
+    /// @notice Stakes a given amount of tBTC token and mints shares to a
     ///         receiver.
     /// @dev This function calls `deposit` function from `ERC4626` contract.
     /// @param assets Approved amount for the transfer and stake.
@@ -21,8 +28,9 @@ contract Acre is ERC4626 {
         uint256 assets,
         address receiver,
         bytes32 referral
-    ) public returns (uint256 shares) {
-        shares = deposit(assets, receiver);
+    ) public returns (uint256) {
+        // TODO: revisit the type of referral.
+        uint256 shares = deposit(assets, receiver);
 
         emit Staked(referral, assets, shares);
 

core/contracts/test/TestToken.sol

@@ -2,30 +2,11 @@
 pragma solidity ^0.8.21;
 
 import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
-import "@thesis/solidity-contracts/contracts/token/IApproveAndCall.sol";
-import "@thesis/solidity-contracts/contracts/token/IReceiveApproval.sol";
 
-contract TestToken is ERC20, IApproveAndCall {
+contract TestERC20 is ERC20 {
     constructor() ERC20("Test Token", "TEST") {}
 
     function mint(address account, uint256 value) external {
         _mint(account, value);
     }
-
-    function approveAndCall(
-        address spender,
-        uint256 amount,
-        bytes memory extraData
-    ) external returns (bool) {
-        if (approve(spender, amount)) {
-            IReceiveApproval(spender).receiveApproval(
-                msg.sender,
-                amount,
-                address(this),
-                extraData
-            );
-            return true;
-        }
-        return false;
-    }
 }

core/package.json

@@ -57,7 +57,6 @@
     "typescript": "^5.3.2"
   },
   "dependencies": {
-    "@openzeppelin/contracts": "^5.0.0",
-    "@thesis/solidity-contracts": "github:thesis/solidity-contracts#c315b9d"
+    "@openzeppelin/contracts": "^5.0.0"
   }
 }