refactor(patterns): rename Upgradable to Upgradeable

guidiaz · guidiaz · commit 64517ca25e13 · 2023-01-03T19:05:25.000+01:00
diff --git a/contracts/impls/WitnetProxy.sol b/contracts/impls/WitnetProxy.sol
@@ -3,7 +3,7 @@
 pragma solidity >=0.7.0 <0.9.0;
 pragma experimental ABIEncoderV2;
 
-import "../patterns/Upgradable.sol";
+import "../patterns/Upgradeable.sol";
 
 /// @title WitnetProxy: upgradable delegate-proxy contract. 
 /// @author The Witnet Foundation.
@@ -70,7 +70,7 @@ contract WitnetProxy {
             require(_newImplementation != _oldImplementation, "WitnetProxy: nothing to upgrade");
 
             // Assert whether current implementation is intrinsically upgradable:
-            try Upgradable(_oldImplementation).isUpgradable() returns (bool _isUpgradable) {
+            try Upgradeable(_oldImplementation).isUpgradable() returns (bool _isUpgradable) {
                 require(_isUpgradable, "WitnetProxy: not upgradable");
             } catch {
                 revert("WitnetProxy: unable to check upgradability");
@@ -86,7 +86,7 @@ contract WitnetProxy {
             require(_wasCalled, "WitnetProxy: not compliant");
             require(abi.decode(_result, (bool)), "WitnetProxy: not authorized");
             require(
-                Upgradable(_oldImplementation).proxiableUUID() == Upgradable(_newImplementation).proxiableUUID(),
+                Upgradeable(_oldImplementation).proxiableUUID() == Upgradeable(_newImplementation).proxiableUUID(),
                 "WitnetProxy: proxiableUUIDs mismatch"
             );
         }
@@ -104,8 +104,8 @@ contract WitnetProxy {
         __proxySlot().implementation = _newImplementation;
         emit Upgraded(_newImplementation);
 
-        // Asserts new implementation complies w/ minimal implementation of Upgradable interface:
-        try Upgradable(_newImplementation).isUpgradable() returns (bool _isUpgradable) {
+        // Asserts new implementation complies w/ minimal implementation of Upgradeable interface:
+        try Upgradeable(_newImplementation).isUpgradable() returns (bool _isUpgradable) {
             return _isUpgradable;
         }
         catch {
diff --git a/contracts/impls/WitnetUpgradableBase.sol b/contracts/impls/WitnetUpgradableBase.sol
@@ -6,17 +6,17 @@ pragma solidity >=0.8.0 <0.9.0;
 import "../patterns/ERC165.sol";
 import "../patterns/Ownable2Step.sol";
 import "../patterns/ReentrancyGuard.sol";
-import "../patterns/Upgradable.sol";
+import "../patterns/Upgradeable.sol";
 
 import "./WitnetProxy.sol";
 
-/// @title Witnet Request Board base contract, with an Upgradable (and Destructible) touch.
+/// @title Witnet Request Board base contract, with an Upgradeable (and Destructible) touch.
 /// @author The Witnet Foundation.
 abstract contract WitnetUpgradableBase
     is
         ERC165,
         Ownable2Step,
-        Upgradable, 
+        Upgradeable, 
         ReentrancyGuard
 {
     bytes32 internal immutable _WITNET_UPGRADABLE_VERSION;
@@ -31,7 +31,7 @@ abstract contract WitnetUpgradableBase
             bytes32 _versionTag,
             string memory _proxiableUUID
         )
-        Upgradable(_upgradable)
+        Upgradeable(_upgradable)
     {
         _WITNET_UPGRADABLE_VERSION = _versionTag;
         proxiableUUID = keccak256(bytes(_proxiableUUID));
@@ -55,21 +55,21 @@ abstract contract WitnetUpgradableBase
       returns (bool)
     {
         return _interfaceId == type(Ownable2Step).interfaceId
-            || _interfaceId == type(Upgradable).interfaceId
+            || _interfaceId == type(Upgradeable).interfaceId
             || super.supportsInterface(_interfaceId);
     }
 
     // ================================================================================================================
     // --- Overrides 'Proxiable' --------------------------------------------------------------------------------------
 
-    /// @dev Gets immutable "heritage blood line" (ie. genotype) as a Proxiable, and eventually Upgradable, contract.
-    ///      If implemented as an Upgradable touch, upgrading this contract to another one with a different 
+    /// @dev Gets immutable "heritage blood line" (ie. genotype) as a Proxiable, and eventually Upgradeable, contract.
+    ///      If implemented as an Upgradeable touch, upgrading this contract to another one with a different 
     ///      `proxiableUUID()` value should fail.
     bytes32 public immutable override proxiableUUID;
 
 
     // ================================================================================================================
-    // --- Overrides 'Upgradable' --------------------------------------------------------------------------------------
+    // --- Overrides 'Upgradeable' --------------------------------------------------------------------------------------
 
     /// Retrieves human-readable version tag of current implementation.
     function version() public view override returns (string memory) {
diff --git a/contracts/impls/boards/trustable/WitnetRequestBoardTrustableBase.sol b/contracts/impls/boards/trustable/WitnetRequestBoardTrustableBase.sol
@@ -56,7 +56,7 @@ abstract contract WitnetRequestBoardTrustableBase
 
 
     // ================================================================================================================
-    // --- Overrides 'Upgradable' -------------------------------------------------------------------------------------
+    // --- Overrides 'Upgradeable' -------------------------------------------------------------------------------------
 
     /// @notice Re-initialize contract's storage context upon a new upgrade from a proxy.
     /// @dev Must fail when trying to upgrade to same logic contract more than once.
diff --git a/contracts/impls/boards/trustless/WitnetRequestBoardTrustlessBase.sol b/contracts/impls/boards/trustless/WitnetRequestBoardTrustlessBase.sol
@@ -178,7 +178,7 @@ abstract contract WitnetRequestBoardTrustlessBase
 
 
     // ================================================================================================================
-    // --- Overrides 'Upgradable' -------------------------------------------------------------------------------------
+    // --- Overrides 'Upgradeable' -------------------------------------------------------------------------------------
 
     /// @notice Re-initialize contract's storage context upon a new upgrade from a proxy.
     /// @dev Must fail when trying to upgrade to same logic contract more than once.
diff --git a/contracts/impls/bytecodes/WitnetBytecodes.sol b/contracts/impls/bytecodes/WitnetBytecodes.sol
@@ -108,7 +108,7 @@ contract WitnetBytecodes
 
 
     // ================================================================================================================
-    // --- Overrides 'Upgradable' -------------------------------------------------------------------------------------
+    // --- Overrides 'Upgradeable' -------------------------------------------------------------------------------------
 
     /// @notice Re-initialize contract's storage context upon a new upgrade from a proxy.
     /// @dev Must fail when trying to upgrade to same logic contract more than once.
diff --git a/contracts/patterns/Proxiable.sol b/contracts/patterns/Proxiable.sol
@@ -3,7 +3,7 @@
 pragma solidity >=0.6.0 <0.9.0;
 
 interface Proxiable {
-    /// @dev Complying with EIP-1822: Universal Upgradable Proxy Standard (UUPS)
+    /// @dev Complying with EIP-1822: Universal Upgradeable Proxy Standard (UUPS)
     /// @dev See https://eips.ethereum.org/EIPS/eip-1822.
     function proxiableUUID() external view returns (bytes32);
 }
diff --git a/contracts/patterns/Upgradable.sol b/contracts/patterns/Upgradable.sol
@@ -7,7 +7,7 @@ pragma solidity >=0.6.0 <0.9.0;
 import "./Initializable.sol";
 import "./Proxiable.sol";
 
-abstract contract Upgradable is Initializable, Proxiable {
+abstract contract Upgradeable is Initializable, Proxiable {
 
     address internal immutable _BASE;
     bytes32 internal immutable _CODEHASH;
@@ -16,7 +16,7 @@ abstract contract Upgradable is Initializable, Proxiable {
     modifier onlyDelegateCalls {
         require(
             address(this) != _BASE,
-            "Upgradable: not a delegate call"
+            "Upgradeable: not a delegate call"
         );
         _;
     }
diff --git a/contracts/requests/WitnetRequestMalleableBase.sol b/contracts/requests/WitnetRequestMalleableBase.sol
@@ -229,7 +229,7 @@ abstract contract WitnetRequestMalleableBase
     // ================================================================================================================
     // --- 'Proxiable 'overriden functions ----------------------------------------------------------------------------
 
-    /// @dev Complying with EIP-1822: Universal Upgradable Proxy Standard (UUPS)
+    /// @dev Complying with EIP-1822: Universal Upgradeable Proxy Standard (UUPS)
     /// @dev See https://eips.ethereum.org/EIPS/eip-1822.
     function proxiableUUID()
         external pure
diff --git a/test/helpers/WitnetRequestBoardTrojanHorseBadProxiable.sol b/test/helpers/WitnetRequestBoardTrojanHorseBadProxiable.sol
@@ -11,7 +11,7 @@ import "../../contracts/patterns/Proxiable.sol";
  * @title Witnet Requests Board Trojan Horse: Proxiable with a bad `proxiableUUID()`.
  * @notice Contract to test proxy upgrade assertions.
  * @dev Upgrading an existing WitnetRequestBoard implementation with an instance of 
- * this kind (i.e. Proxiable and Upgradable) but with a `proxiableUUID()` value different
+ * this kind (i.e. Proxiable and Upgradeable) but with a `proxiableUUID()` value different
  * to the one required for WitnetRequestBoards, should not be permitted by the WitnetProxy.
  * The contract has been created for testing purposes.
  * @author Witnet Foundation
diff --git a/test/helpers/WitnetRequestBoardTrojanHorseNotUpgradable.sol b/test/helpers/WitnetRequestBoardTrojanHorseNotUpgradable.sol
@@ -8,10 +8,10 @@ import "../../contracts/patterns/Initializable.sol";
 import "../../contracts/patterns/Proxiable.sol";
 
 /**
- * @title Witnet Requests Board Trojan Horse: Proxiable but not-Upgradable
+ * @title Witnet Requests Board Trojan Horse: Proxiable but not-Upgradeable
  * @notice Contract to test proxy upgrade assertions.
  * @dev Upgrading an existing WitnetRequestBoard implementation with an instance of 
- * this kind (i.e. Proxiable but not-Upgradable), should not be permitted by the WitnetProxy.
+ * this kind (i.e. Proxiable but not-Upgradeable), should not be permitted by the WitnetProxy.
  * The contract has been created for testing purposes.
  * @author Witnet Foundation
  */
diff --git a/test/witnet_bytecodes.test.js b/test/witnet_bytecodes.test.js
@@ -62,7 +62,7 @@ contract('WitnetBytecodes', (accounts) => {
         })
     })
 
-    context("Upgradable", async () => {
+    context("Upgradeable", async () => {
         it('should manifest to be upgradable from actual owner', async () => {
             assert.equal(
                 await bytecodes.isUpgradableFrom(firstOwnerAddress),
diff --git a/test/wrb.test.js b/test/wrb.test.js
@@ -712,7 +712,7 @@ contract("WitnetRequestBoard", ([
   })
 
   describe("interfaces", async () => {
-    describe("Upgradable:", async () => {
+    describe("Upgradeable:", async () => {
       it("initialization fails if called from non owner address", async () => {
         await expectRevert(
           this.WitnetRequestBoard.initialize(
diff --git a/test/wrb_proxy.test.js b/test/wrb_proxy.test.js
@@ -91,7 +91,7 @@ contract("Witnet Requests Board Proxy", accounts => {
       )
     })
 
-    it("fails if owner tries to upgrade to not Upgradable-compliant implementation", async () => {
+    it("fails if owner tries to upgrade to not Upgradeable-compliant implementation", async () => {
       const troyHorse = await TrojanHorseNotUpgradable.new()
       await truffleAssert.reverts(
         proxy.upgradeWitnetRequestBoard(troyHorse.address, { from: contractOwner }),

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`pragma solidity >=0.6.0 <0.9.0;`
`4`	`4`
`5`	`5`	`interface Proxiable {`
`6`		`- /// @dev Complying with EIP-1822: Universal Upgradable Proxy Standard (UUPS)`
	`6`	`+ /// @dev Complying with EIP-1822: Universal Upgradeable Proxy Standard (UUPS)`
`7`	`7`	`/// @dev See https://eips.ethereum.org/EIPS/eip-1822.`
`8`	`8`	`function proxiableUUID() external view returns (bytes32);`
`9`	`9`	`}`