@keep-network/tbtc-v2 0.1.1-dev.81 → 0.1.1-dev.84

package/contracts/vault/TBTCVault.sol

@@ -25,7 +25,7 @@ import "../token/TBTC.sol";
 /// @notice TBTC is a fully Bitcoin-backed ERC-20 token pegged to the price of
 ///         Bitcoin. It facilitates Bitcoin holders to act on the Ethereum
 ///         blockchain and access the decentralized finance (DeFi) ecosystem.
-///         TBTC Vault mints and redeems TBTC based on Bitcoin balances in the
+///         TBTC Vault mints and unmints TBTC based on Bitcoin balances in the
 ///         Bank.
 /// @dev TBTC Vault is the owner of TBTC token contract and is the only contract
 ///      minting the token.
@@ -35,7 +35,7 @@ contract TBTCVault is IVault, Governable {
 
     event Minted(address indexed to, uint256 amount);
 
-    event Redeemed(address indexed from, uint256 amount);
+    event Unminted(address indexed from, uint256 amount);
 
     modifier onlyBank() {
         require(msg.sender == address(bank), "Caller is not the Bank");
@@ -110,7 +110,7 @@ contract TBTCVault is IVault, Governable {
     function receiveBalanceApproval(
         address owner,
         uint256 amount,
-        bytes memory
+        bytes calldata
     ) external override onlyBank {
         require(
             bank.balanceOf(owner) >= amount,
@@ -136,32 +136,60 @@ contract TBTCVault is IVault, Governable {
         }
     }
 
-    /// @notice Burns `amount` of TBTC from the caller's account and transfers
+    /// @notice Burns `amount` of TBTC from the caller's balance and transfers
     ///         `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.
-    function redeem(uint256 amount) external {
-        _redeem(msg.sender, amount);
+    /// @param amount Amount of TBTC to unmint.
+    function unmint(uint256 amount) external {
+        _unmint(msg.sender, amount);
     }
 
-    /// @notice Burns `amount` of TBTC from the caller's account and transfers
-    ///         `amount` back to the caller's balance in the Bank.
-    /// @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.
+    /// @notice Burns `amount` of TBTC from the caller's balance and transfers
+    ///         `amount` of Bank balance to the Bridge requesting redemption
+    ///         based on the provided `redemptionData`.
+    /// @dev Caller must have at least `amount` of TBTC approved to
+    ///       TBTC Vault.
+    /// @param amount Amount of TBTC to unmint and request to redeem in Bridge.
+    /// @param redemptionData Redemption data in a format expected from
+    ///        `redemptionData` parameter of Bridge's `receiveBalanceApproval`
+    ///        function.
+    function unmintAndRedeem(uint256 amount, bytes calldata redemptionData)
+        external
+    {
+        _unmintAndRedeem(msg.sender, amount, redemptionData);
+    }
+
+    /// @notice Burns `amount` of TBTC from the caller's balance. If `extraData`
+    ///         is empty, transfers `amount` back to the caller's balance in the
+    ///         Bank. If `extraData` is not empty, requests redemption in the
+    ///         Bridge using the `extraData` as a `redemptionData` parameter to
+    ///         Bridge's `receiveBalanceApproval` function.
+    /// @dev This function is doing the same as `unmint` or `unmintAndRedeem`
+    ///      (depending on `extraData` parameter) but it allows to execute
+    ///      unminting without a separate approval transaction. The function can
+    ///      be called only via `approveAndCall` of TBTC token.
+    /// @param from TBTC token holder executing unminting.
+    /// @param amount Amount of TBTC to unmint.
     /// @param token TBTC token address.
+    /// @param extraData Redemption data in a format expected from
+    ///        `redemptionData` parameter of Bridge's `receiveBalanceApproval`
+    ///        function. If empty, `receiveApproval` is not requesting a
+    ///        redemption of Bank balance but is instead performing just TBTC
+    ///        unminting to a Bank balance.
     function receiveApproval(
         address from,
         uint256 amount,
         address token,
-        bytes calldata
+        bytes calldata extraData
     ) external {
         require(token == address(tbtcToken), "Token is not TBTC");
         require(msg.sender == token, "Only TBTC caller allowed");
-        _redeem(from, amount);
+        if (extraData.length == 0) {
+            _unmint(from, amount);
+        } else {
+            _unmintAndRedeem(from, amount, extraData);
+        }
     }
 
     // slither-disable-next-line calls-loop
@@ -170,9 +198,19 @@ contract TBTCVault is IVault, Governable {
         tbtcToken.mint(minter, amount);
     }
 
-    function _redeem(address redeemer, uint256 amount) internal {
-        emit Redeemed(redeemer, amount);
+    function _unmint(address unminter, uint256 amount) internal {
+        emit Unminted(unminter, amount);
+        tbtcToken.burnFrom(unminter, amount);
+        bank.transferBalance(unminter, amount);
+    }
+
+    function _unmintAndRedeem(
+        address redeemer,
+        uint256 amount,
+        bytes calldata redemptionData
+    ) internal {
+        emit Unminted(redeemer, amount);
         tbtcToken.burnFrom(redeemer, amount);
-        bank.transferBalance(redeemer, amount);
+        bank.approveBalanceAndCall(bank.bridge(), amount, redemptionData);
     }
 }

package/export.json

@@ -15515,6 +15515,28 @@
           ],
           "outputs": []
         },
+        {
+          "type": "function",
+          "name": "receiveBalanceApproval",
+          "constant": false,
+          "payable": false,
+          "gas": 29000000,
+          "inputs": [
+            {
+              "type": "address",
+              "name": "balanceOwner"
+            },
+            {
+              "type": "uint256",
+              "name": "amount"
+            },
+            {
+              "type": "bytes",
+              "name": "redemptionData"
+            }
+          ],
+          "outputs": []
+        },
         {
           "type": "function",
           "name": "redemptionParameters",
@@ -16858,7 +16880,7 @@
               "type": "uint256"
             }
           ],
-          "name": "Redeemed",
+          "name": "Unminted",
           "type": "event"
         },
         {
@@ -16919,7 +16941,7 @@
             },
             {
               "internalType": "bytes",
-              "name": "",
+              "name": "extraData",
               "type": "bytes"
             }
           ],
@@ -17020,19 +17042,6 @@
           "stateMutability": "nonpayable",
           "type": "function"
         },
-        {
-          "inputs": [
-            {
-              "internalType": "uint256",
-              "name": "amount",
-              "type": "uint256"
-            }
-          ],
-          "name": "redeem",
-          "outputs": [],
-          "stateMutability": "nonpayable",
-          "type": "function"
-        },
         {
           "inputs": [],
           "name": "tbtcToken",
@@ -17058,6 +17067,37 @@
           "outputs": [],
           "stateMutability": "nonpayable",
           "type": "function"
+        },
+        {
+          "inputs": [
+            {
+              "internalType": "uint256",
+              "name": "amount",
+              "type": "uint256"
+            }
+          ],
+          "name": "unmint",
+          "outputs": [],
+          "stateMutability": "nonpayable",
+          "type": "function"
+        },
+        {
+          "inputs": [
+            {
+              "internalType": "uint256",
+              "name": "amount",
+              "type": "uint256"
+            },
+            {
+              "internalType": "bytes",
+              "name": "redemptionData",
+              "type": "bytes"
+            }
+          ],
+          "name": "unmintAndRedeem",
+          "outputs": [],
+          "stateMutability": "nonpayable",
+          "type": "function"
         }
       ]
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keep-network/tbtc-v2",
-  "version": "0.1.1-dev.81+main.676ff79abb0c7f23e4b3870e2b03068af81cf11a",
+  "version": "0.1.1-dev.84+main.a75bdeccd9bb9e381d79fb9df51e2af42de98794",
   "license": "MIT",
   "files": [
     "artifacts/",