feat: set constant from public to internal (#260)

Co-authored-by: Robin Le Caignec <[email protected]>

Author: gfournierPro

contracts/facets/FacetBase.sol

@@ -14,27 +14,28 @@ import "../interfaces/IOwnable.sol";
  */
 abstract contract FacetBase {
     // Poco - Constants
-    uint256 public constant CONTRIBUTION_DEADLINE_RATIO = 7;
-    uint256 public constant REVEAL_DEADLINE_RATIO = 2;
-    uint256 public constant FINAL_DEADLINE_RATIO = 10;
-    uint256 public constant WORKERPOOL_STAKE_RATIO = 30;
-    uint256 public constant KITTY_RATIO = 10;
-    uint256 public constant KITTY_MIN = 1e9; // ADJUSTEMENT VARIABLE
+    uint256 internal constant CONTRIBUTION_DEADLINE_RATIO = 7;
+    uint256 internal constant REVEAL_DEADLINE_RATIO = 2;
+    uint256 internal constant FINAL_DEADLINE_RATIO = 10;
+    uint256 internal constant WORKERPOOL_STAKE_RATIO = 30;
+    uint256 internal constant KITTY_RATIO = 10;
+    uint256 internal constant KITTY_MIN = 1e9; // ADJUSTEMENT VARIABLE
 
     // Seized funds of workerpools that do not honor their deals are sent
     // out to this kitty address.
     // It is determined with address(uint256(keccak256(bytes('iExecKitty'))) - 1).
-    address public constant KITTY_ADDRESS = 0x99c2268479b93fDe36232351229815DF80837e23;
+    address internal constant KITTY_ADDRESS = 0x99c2268479b93fDe36232351229815DF80837e23;
 
     // Used with ERC-734 Key Manager identity contract for authorization management.
-    uint256 public constant GROUPMEMBER_PURPOSE = 4;
+    uint256 internal constant GROUPMEMBER_PURPOSE = 4;
 
     modifier onlyOwner() {
         require(_msgSender() == owner(), "Ownable: caller is not the owner");
         _;
     }
 
-    function owner() public view returns (address) {
+    function owner() internal view returns (address) {
+        // TODO use LibDiamond.contractOwner() instead of an external call when migrating all contracts to v8.
         return IOwnable(address(this)).owner();
     }
 

contracts/facets/FacetBase.v8.sol

@@ -14,30 +14,20 @@ import {PocoStorageLib} from "../libs/PocoStorageLib.v8.sol";
  */
 abstract contract FacetBase {
     // Poco - Constants
-    uint256 public constant CONTRIBUTION_DEADLINE_RATIO = 7;
-    uint256 public constant REVEAL_DEADLINE_RATIO = 2;
-    uint256 public constant FINAL_DEADLINE_RATIO = 10;
-    uint256 public constant WORKERPOOL_STAKE_RATIO = 30;
-    uint256 public constant KITTY_RATIO = 10;
-    uint256 public constant KITTY_MIN = 1e9; // ADJUSTEMENT VARIABLE
+    uint256 internal constant CONTRIBUTION_DEADLINE_RATIO = 7;
+    uint256 internal constant REVEAL_DEADLINE_RATIO = 2;
+    uint256 internal constant FINAL_DEADLINE_RATIO = 10;
+    uint256 internal constant WORKERPOOL_STAKE_RATIO = 30;
+    uint256 internal constant KITTY_RATIO = 10;
+    uint256 internal constant KITTY_MIN = 1e9; // ADJUSTEMENT VARIABLE
 
     // Seized funds of workerpools that do not honor their deals are sent
     // out to this kitty address.
     // It is determined with address(uint256(keccak256(bytes('iExecKitty'))) - 1).
-    address public constant KITTY_ADDRESS = 0x99c2268479b93fDe36232351229815DF80837e23;
+    address internal constant KITTY_ADDRESS = 0x99c2268479b93fDe36232351229815DF80837e23;
 
     // Used with ERC-734 Key Manager identity contract for authorization management.
-    uint256 public constant GROUPMEMBER_PURPOSE = 4;
-
-    modifier onlyOwner() {
-        require(_msgSender() == owner(), "Ownable: caller is not the owner");
-        _;
-    }
-
-    function owner() public view returns (address) {
-        // Make an external call to delegatecall the OwnershipFacet.
-        return IERC5313(address(this)).owner();
-    }
+    uint256 internal constant GROUPMEMBER_PURPOSE = 4;
 
     function _msgSender() internal view returns (address) {
         return msg.sender;

contracts/facets/IexecAccessorsFacet.sol

@@ -57,7 +57,9 @@ import { printFunctions } from '../upgrade-helper';
     const newFacetFactory = new IexecPocoAccessorsFacet__factory(iexecLibOrders);
     const newFacetAddress = await factoryDeployer.deployContract(newFacetFactory);
 
-    console.log('\n=== Step 2: Remove old facets (remove all functions of each facet) ===');
+    console.log(
+        '\n=== Step 2: Remove old facets (remove all functions of old accessors facets) ===',
+    );
 
     const diamondLoupe = DiamondLoupeFacet__factory.connect(diamondProxyAddress, account);
     const currentFacets = await diamondLoupe.facets();
@@ -67,17 +69,37 @@ import { printFunctions } from '../upgrade-helper';
         console.log(`  ${facet.facetAddress}: ${facet.functionSelectors.length} functions`);
     });
 
-    const oldAccessorFacets = [
-        '0xEa232be31ab0112916505Aeb7A2a94b5571DCc6b', //IexecAccessorsFacet
-        '0xeb40697b275413241d9b31dE568C98B3EA12FFF0', //IexecPocoAccessorsFacet
-    ];
-
     console.log('Diamond functions before upgrade:');
     await printFunctions(diamondProxyAddress);
 
     const removalCuts: IDiamond.FacetCutStruct[] = [];
+    const constantFunctionSignatures = [
+        'CONTRIBUTION_DEADLINE_RATIO()',
+        'FINAL_DEADLINE_RATIO()',
+        'GROUPMEMBER_PURPOSE()',
+        'KITTY_ADDRESS()',
+        'KITTY_MIN()',
+        'KITTY_RATIO()',
+        'REVEAL_DEADLINE_RATIO()',
+        'WORKERPOOL_STAKE_RATIO()',
+    ];
+    const constantFunctionsToRemove = constantFunctionSignatures.map((sig) =>
+        ethers.id(sig).slice(0, 10),
+    );
+    console.log(
+        `Removing specific constant functions from diamond Proxy - will remove ${constantFunctionsToRemove.length} specific constant functions`,
+    );
+    removalCuts.push({
+        facetAddress: ZeroAddress,
+        action: FacetCutAction.Remove,
+        functionSelectors: constantFunctionsToRemove,
+    });
 
-    // Remove ALL functions from the old accessor facets using diamondLoupe.facetFunctionSelectors()
+    const oldAccessorFacets = [
+        '0xEa232be31ab0112916505Aeb7A2a94b5571DCc6b', //IexecAccessorsFacet
+        '0xeb40697b275413241d9b31dE568C98B3EA12FFF0', //IexecPocoAccessorsFacet
+    ];
+    // Remove ALL functions from the old accessor facets using diamondLoupe.facetFunctionSelectors() except of constant founctions
     for (const facetAddress of oldAccessorFacets) {
         const selectors = await diamondLoupe.facetFunctionSelectors(facetAddress);
         if (selectors.length > 0) {

scripts/upgrades/accessors/deploy-and-update-accessor-facet.ts

@@ -48,7 +48,7 @@ let [requester, appProvider, datasetProvider, scheduler, worker1, anyone]: Signe
 let ordersAssets: OrdersAssets;
 let ordersPrices: OrdersPrices;
 
-describe('IexecAccessors', async () => {
+describe('IexecPocoAccessors', async () => {
     beforeEach('Deploy', async () => {
         // Deploy all contracts
         proxyAddress = await loadHardhatFixtureDeployment();

…ct/IexecAccessors/IexecAccessors.test.ts …PocoAccessors/IexecPocoAccessors.test.tstest/byContract/IexecAccessors/IexecAccessors.test.ts renamed to test/byContract/iexecPocoAccessors/IexecPocoAccessors.test.ts test/byContract/IexecAccessors/IexecAccessors.test.ts renamed to test/byContract/iexecPocoAccessors/IexecPocoAccessors.test.ts

@@ -11,7 +11,7 @@ export function compactSignature(signature: string): string {
 }
 
 export function bigintToAddress(bigint: bigint) {
-    return ethers.getAddress(ethers.toBeHex(bigint));
+    return ethers.getAddress(ethers.toBeHex(bigint, 20));
 }
 
 export function minBigInt(a: bigint, b: bigint) {