Merge pull request #114 from DistributedCollective/feat/rename-eth

Rename ETH to RBTC

Author: swamp-thing-sovryn

packages/contracts/.gitignore

@@ -9,7 +9,7 @@
 # Buidler compilation cache
 /cache
 
-# Ethereum accounts for testing
+# RBtcereum accounts for testing
 /accountsList.js 
 
 # Exported function gas costs and test outputs

packages/contracts/contracts/ActivePool.sol

@@ -10,9 +10,9 @@ import "./ActivePoolStorage.sol";
 
 /**
  * @title Active Pool
- * @notice The Active Pool holds the ETH collateral and ZUSD debt (but not ZUSD tokens) for all active troves.
+ * @notice The Active Pool holds the RBTC collateral and ZUSD debt (but not ZUSD tokens) for all active troves.
  * 
- * When a trove is liquidated, it's ETH and ZUSD debt are transferred from the Active Pool, to either the
+ * When a trove is liquidated, it's RBTC and ZUSD debt are transferred from the Active Pool, to either the
  * Stability Pool, the Default Pool, or both, depending on the liquidation conditions.
  */
 contract ActivePool is CheckContract, IActivePool, ActivePoolStorage {
@@ -21,7 +21,7 @@ contract ActivePool is CheckContract, IActivePool, ActivePoolStorage {
     event BorrowerOperationsAddressChanged(address _newBorrowerOperationsAddress);
     event TroveManagerAddressChanged(address _newTroveManagerAddress);
     event ActivePoolZUSDDebtUpdated(uint _ZUSDDebt);
-    event ActivePoolETHBalanceUpdated(uint _ETH);
+    event ActivePoolRBTCBalanceUpdated(uint _RBTC);
 
     // --- Contract setters ---
     /// @notice initializer function that sets required addresses
@@ -57,10 +57,10 @@ contract ActivePool is CheckContract, IActivePool, ActivePoolStorage {
     // --- Getters for public variables. Required by IPool interface ---
 
 
-    /// @notice Not necessarily equal to the the contract's raw ETH balance - ether can be forcibly sent to contracts.
-    /// @return the ETH state variable.
-    function getETH() external view override returns (uint) {
-        return ETH;
+    /// @notice Not necessarily equal to the the contract's raw RBTC balance - ether can be forcibly sent to contracts.
+    /// @return the RBTC state variable.
+    function getRBTC() external view override returns (uint) {
+        return RBTC;
     }
 
     /// @return the ZUSD debt state variable
@@ -70,17 +70,17 @@ contract ActivePool is CheckContract, IActivePool, ActivePoolStorage {
 
     // --- Pool functionality ---
 
-    /// @notice Send ETH amount to given account. Updates ActivePool balance. Only callable by BorrowerOperations, TroveManager or StabilityPool.
-    /// @param _account account to receive the ETH amount
-    /// @param _amount ETH amount to send
-    function sendETH(address _account, uint _amount) external override {
+    /// @notice Send RBTC amount to given account. Updates ActivePool balance. Only callable by BorrowerOperations, TroveManager or StabilityPool.
+    /// @param _account account to receive the RBTC amount
+    /// @param _amount RBTC amount to send
+    function sendRBTC(address _account, uint _amount) external override {
         _requireCallerIsBOorTroveMorSP();
-        ETH = ETH.sub(_amount);
-        emit ActivePoolETHBalanceUpdated(ETH);
-        emit EtherSent(_account, _amount);
+        RBTC = RBTC.sub(_amount);
+        emit ActivePoolRBTCBalanceUpdated(RBTC);
+        emit RBtcerSent(_account, _amount);
 
         (bool success, ) = _account.call{value: _amount}("");
-        require(success, "ActivePool: sending ETH failed");
+        require(success, "ActivePool: sending RBTC failed");
     }
 
     /// @notice Increases ZUSD debt of the active pool. Only callable by BorrowerOperations, TroveManager or StabilityPool.
@@ -128,7 +128,7 @@ contract ActivePool is CheckContract, IActivePool, ActivePoolStorage {
 
     receive() external payable {
         _requireCallerIsBorrowerOperationsOrDefaultPool();
-        ETH = ETH.add(msg.value);
-        emit ActivePoolETHBalanceUpdated(ETH);
+        RBTC = RBTC.add(msg.value);
+        emit ActivePoolRBTCBalanceUpdated(RBTC);
     }
 }

packages/contracts/contracts/ActivePoolStorage.sol

@@ -5,7 +5,7 @@ import "./Dependencies/Ownable.sol";
 
 /**
  * @title Active Pool Storage
- * @dev Stores Active Pool required addresses and internal ETH and ZUSD debt states
+ * @dev Stores Active Pool required addresses and internal RBTC and ZUSD debt states
  * Extends Ownable
  */
 contract ActivePoolStorage is Ownable {
@@ -15,6 +15,6 @@ contract ActivePoolStorage is Ownable {
     address public troveManagerAddress;
     address public stabilityPoolAddress;
     address public defaultPoolAddress;
-    uint256 internal ETH; // deposited ether tracker
+    uint256 internal RBTC; // deposited ether tracker
     uint256 internal ZUSDDebt;
 }

packages/contracts/contracts/BorrowerOperations.sol

@@ -213,18 +213,18 @@ contract BorrowerOperations is LiquityBase, BorrowerOperationsStorage, CheckCont
         emit ZUSDBorrowingFeePaid(_sender, vars.ZUSDFee);
     }
 
-    /// Send ETH as collateral to a trove
+    /// Send RBTC as collateral to a trove
     function addColl(address _upperHint, address _lowerHint) external payable override {
         _adjustTrove(msg.sender, 0, 0, false, _upperHint, _lowerHint, 0);
     }
 
-    /// Send ETH as collateral to a trove. Called by only the Stability Pool.
-    function moveETHGainToTrove(address _borrower, address _upperHint, address _lowerHint) external payable override {
+    /// Send RBTC as collateral to a trove. Called by only the Stability Pool.
+    function moveRBTCGainToTrove(address _borrower, address _upperHint, address _lowerHint) external payable override {
         _requireCallerIsStabilityPool();
         _adjustTrove(_borrower, 0, 0, false, _upperHint, _lowerHint, 0);
     }
 
-    /// Withdraw ETH collateral from a trove
+    /// Withdraw RBTC collateral from a trove
     function withdrawColl(uint _collWithdrawal, address _upperHint, address _lowerHint) external override {
         _adjustTrove(msg.sender, _collWithdrawal, 0, false, _upperHint, _lowerHint, 0);
     }
@@ -282,12 +282,12 @@ contract BorrowerOperations is LiquityBase, BorrowerOperationsStorage, CheckCont
         _requireNonZeroAdjustment(_collWithdrawal, _ZUSDChange);
         _requireTroveisActive(contractsCache.troveManager, _borrower);
 
-        // Confirm the operation is either a borrower adjusting their own trove, or a pure ETH transfer from the Stability Pool to a trove
+        // Confirm the operation is either a borrower adjusting their own trove, or a pure RBTC transfer from the Stability Pool to a trove
         assert(_sender == _borrower || (_sender == stabilityPoolAddress && _value > 0 && _ZUSDChange == 0));
 
         contractsCache.troveManager.applyPendingRewards(_borrower);
 
-        // Get the collChange based on whether or not ETH was sent in the transaction
+        // Get the collChange based on whether or not RBTC was sent in the transaction
         (vars.collChange, vars.isCollIncrease) = _getCollChange(_value, _collWithdrawal);
 
         vars.netDebtChange = _ZUSDChange;
@@ -327,7 +327,7 @@ contract BorrowerOperations is LiquityBase, BorrowerOperationsStorage, CheckCont
         emit ZUSDBorrowingFeePaid(_sender,  vars.ZUSDFee);
 
         // Use the unmodified _ZUSDChange here, as we don't send the fee to the user
-        _moveTokensAndETHfromAdjustment(
+        _moveTokensAndRBTCfromAdjustment(
             contractsCache.activePool,
             contractsCache.zusdToken,
             _sender,
@@ -382,14 +382,14 @@ contract BorrowerOperations is LiquityBase, BorrowerOperationsStorage, CheckCont
         _repayZUSD(activePoolCached, zusdTokenCached, gasPoolAddress, ZUSD_GAS_COMPENSATION);
 
         // Send the collateral back to the user
-        activePoolCached.sendETH(msg.sender, coll);
+        activePoolCached.sendRBTC(msg.sender, coll);
     }
 
     /**
      * Claim remaining collateral from a redemption or from a liquidation with ICR > MCR in Recovery Mode
      */
     function claimCollateral() external override {
-        // send ETH from CollSurplus Pool to owner
+        // send RBTC from CollSurplus Pool to owner
         collSurplusPool.claimColl(msg.sender);
     }
 
@@ -449,7 +449,7 @@ contract BorrowerOperations is LiquityBase, BorrowerOperationsStorage, CheckCont
         return (newColl, newDebt);
     }
 
-    function _moveTokensAndETHfromAdjustment
+    function _moveTokensAndRBTCfromAdjustment
     (
         IActivePool _activePool,
         IZUSDToken _zusdToken,
@@ -472,14 +472,14 @@ contract BorrowerOperations is LiquityBase, BorrowerOperationsStorage, CheckCont
         if (_isCollIncrease) {
             _activePoolAddColl(_activePool, _collChange);
         } else {
-            _activePool.sendETH(_borrower, _collChange);
+            _activePool.sendRBTC(_borrower, _collChange);
         }
     }
 
-    /// Send ETH to Active Pool and increase its recorded ETH balance
+    /// Send RBTC to Active Pool and increase its recorded RBTC balance
     function _activePoolAddColl(IActivePool _activePool, uint _amount) internal {
         (bool success, ) = address(_activePool).call{value: _amount}("");
-        require(success, "BorrowerOps: Sending ETH to ActivePool failed");
+        require(success, "BorrowerOps: Sending RBTC to ActivePool failed");
     }
 
     /// Issue the specified amount of ZUSD to _account and increases the total active debt (_netDebtIncrease potentially includes a ZUSDFee)

packages/contracts/contracts/CollSurplusPool.sol

@@ -18,7 +18,7 @@ contract CollSurplusPool is CollSurplusPoolStorage, CheckContract, ICollSurplusP
     event ActivePoolAddressChanged(address _newActivePoolAddress);
 
     event CollBalanceUpdated(address indexed _account, uint _newBalance);
-    event EtherSent(address _to, uint _amount);
+    event RBtcerSent(address _to, uint _amount);
 
     // --- Contract setters ---
 
@@ -46,10 +46,10 @@ contract CollSurplusPool is CollSurplusPoolStorage, CheckContract, ICollSurplusP
 
     }
 
-    /** Returns the ETH state variable at ActivePool address.
+    /** Returns the RBTC state variable at ActivePool address.
        Not necessarily equal to the raw ether balance - ether can be forcibly sent to contracts. */
-    function getETH() external view override returns (uint) {
-        return ETH;
+    function getRBTC() external view override returns (uint) {
+        return RBTC;
     }
 
     function getCollateral(address _account) external view override returns (uint) {
@@ -75,11 +75,11 @@ contract CollSurplusPool is CollSurplusPoolStorage, CheckContract, ICollSurplusP
         balances[_account] = 0;
         emit CollBalanceUpdated(_account, 0);
 
-        ETH = ETH.sub(claimableColl);
-        emit EtherSent(_account, claimableColl);
+        RBTC = RBTC.sub(claimableColl);
+        emit RBtcerSent(_account, claimableColl);
 
         (bool success, ) = _account.call{ value: claimableColl }("");
-        require(success, "CollSurplusPool: sending ETH failed");
+        require(success, "CollSurplusPool: sending RBTC failed");
     }
 
     // --- 'require' functions ---
@@ -106,6 +106,6 @@ contract CollSurplusPool is CollSurplusPoolStorage, CheckContract, ICollSurplusP
 
     receive() external payable {
         _requireCallerIsActivePool();
-        ETH = ETH.add(msg.value);
+        RBTC = RBTC.add(msg.value);
     }
 }

packages/contracts/contracts/CollSurplusPoolStorage.sol

@@ -12,7 +12,7 @@ contract CollSurplusPoolStorage is Ownable {
     address public activePoolAddress;
 
     // deposited ether tracker
-    uint256 internal ETH;
+    uint256 internal RBTC;
     // Collateral surplus claimable by trove owners
     mapping(address => uint256) internal balances;
 }

packages/contracts/contracts/DefaultPool.sol

@@ -9,18 +9,18 @@ import "./Dependencies/console.sol";
 import "./DefaultPoolStorage.sol";
 
 /**
- * The Default Pool holds the ETH and ZUSD debt (but not ZUSD tokens) from liquidations that have been redistributed
+ * The Default Pool holds the RBTC and ZUSD debt (but not ZUSD tokens) from liquidations that have been redistributed
  * to active troves but not yet "applied", i.e. not yet recorded on a recipient active trove's struct.
  *
- * When a trove makes an operation that applies its pending ETH and ZUSD debt, its pending ETH and ZUSD debt is moved
+ * When a trove makes an operation that applies its pending RBTC and ZUSD debt, its pending RBTC and ZUSD debt is moved
  * from the Default Pool to the Active Pool.
  */
 contract DefaultPool is DefaultPoolStorage, CheckContract, IDefaultPool {
     using SafeMath for uint256;
 
     event TroveManagerAddressChanged(address _newTroveManagerAddress);
     event DefaultPoolZUSDDebtUpdated(uint _ZUSDDebt);
-    event DefaultPoolETHBalanceUpdated(uint _ETH);
+    event DefaultPoolRBTCBalanceUpdated(uint _RBTC);
 
     // --- Dependency setters ---
 
@@ -46,12 +46,12 @@ contract DefaultPool is DefaultPoolStorage, CheckContract, IDefaultPool {
     // --- Getters for public variables. Required by IPool interface ---
 
     /**
-    * @return the ETH state variable.
+    * @return the RBTC state variable.
     *
-    * Not necessarily equal to the the contract's raw ETH balance - ether can be forcibly sent to contracts.
+    * Not necessarily equal to the the contract's raw RBTC balance - ether can be forcibly sent to contracts.
     */
-    function getETH() external view override returns (uint) {
-        return ETH;
+    function getRBTC() external view override returns (uint) {
+        return RBTC;
     }
 
     function getZUSDDebt() external view override returns (uint) {
@@ -60,15 +60,15 @@ contract DefaultPool is DefaultPoolStorage, CheckContract, IDefaultPool {
 
     // --- Pool functionality ---
 
-    function sendETHToActivePool(uint _amount) external override {
+    function sendRBTCToActivePool(uint _amount) external override {
         _requireCallerIsTroveManager();
         address activePool = activePoolAddress; // cache to save an SLOAD
-        ETH = ETH.sub(_amount);
-        emit DefaultPoolETHBalanceUpdated(ETH);
-        emit EtherSent(activePool, _amount);
+        RBTC = RBTC.sub(_amount);
+        emit DefaultPoolRBTCBalanceUpdated(RBTC);
+        emit RBtcerSent(activePool, _amount);
 
         (bool success, ) = activePool.call{ value: _amount }("");
-        require(success, "DefaultPool: sending ETH failed");
+        require(success, "DefaultPool: sending RBTC failed");
     }
 
     function increaseZUSDDebt(uint _amount) external override {
@@ -97,7 +97,7 @@ contract DefaultPool is DefaultPoolStorage, CheckContract, IDefaultPool {
 
     receive() external payable {
         _requireCallerIsActivePool();
-        ETH = ETH.add(msg.value);
-        emit DefaultPoolETHBalanceUpdated(ETH);
+        RBTC = RBTC.add(msg.value);
+        emit DefaultPoolRBTCBalanceUpdated(RBTC);
     }
 }

packages/contracts/contracts/DefaultPoolStorage.sol

@@ -10,6 +10,6 @@ contract DefaultPoolStorage is Ownable {
 
     address public troveManagerAddress;
     address public activePoolAddress;
-    uint256 internal ETH;  // deposited ETH tracker
+    uint256 internal RBTC;  // deposited RBTC tracker
     uint256 internal ZUSDDebt;  // debt
 }

packages/contracts/contracts/Dependencies/IERC2612.sol

@@ -7,7 +7,7 @@ pragma solidity 0.6.11;
  *
  * Adds the {permit} method, which can be used to change one's
  * {IERC20-allowance} without having to send a transaction, by signing a
- * message. This allows users to spend tokens without having to hold Ether.
+ * message. This allows users to spend tokens without having to hold RBtcer.
  *
  * See https://eips.ethereum.org/EIPS/eip-2612.
  * 

packages/contracts/contracts/Dependencies/LiquityBase.sol

@@ -44,14 +44,14 @@ contract LiquityBase is BaseMath, ILiquityBase {
         return _debt.sub(ZUSD_GAS_COMPENSATION);
     }
 
-    /// Return the amount of ETH to be drawn from a trove's collateral and sent as gas compensation.
+    /// Return the amount of RBTC to be drawn from a trove's collateral and sent as gas compensation.
     function _getCollGasCompensation(uint256 _entireColl) internal view returns (uint256) {
         return _entireColl / liquityBaseParams.PERCENT_DIVISOR();
     }
 
     function getEntireSystemColl() public view returns (uint256 entireSystemColl) {
-        uint256 activeColl = activePool.getETH();
-        uint256 liquidatedColl = defaultPool.getETH();
+        uint256 activeColl = activePool.getRBTC();
+        uint256 liquidatedColl = defaultPool.getRBTC();
 
         return activeColl.add(liquidatedColl);
     }