npm - @etherisc/gif-next - Versions diffs - 0.0.2-e0ff180-766 → 0.0.2-e14821a-976 - Mend

@etherisc/gif-next 0.0.2-e0ff180-766 → 0.0.2-e14821a-976

Files changed (739) hide show

package/contracts/{shared → upgradeability}/ProxyManager.sol RENAMED Viewed

@@ -1,16 +1,16 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
+import {ProxyAdmin} from "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
 import {ITransparentUpgradeableProxy} from "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
-import {Blocknumber, blockNumber} from "../types/Blocknumber.sol";
+import {Blocknumber, blockNumber} from "../type/Blocknumber.sol";
 import {IVersionable} from "./IVersionable.sol";
-import {NftOwnable} from "./NftOwnable.sol";
-import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
-import {ProxyAdmin} from "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
-import {Timestamp, TimestampLib} from "../types/Timestamp.sol";
+import {NftId} from "../type/NftId.sol";
+import {NftOwnable} from "../shared/NftOwnable.sol";
+import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
 import {UpgradableProxyWithAdmin} from "./UpgradableProxyWithAdmin.sol";
-import {Version, VersionLib} from "../types/Version.sol";
+import {Version, VersionLib} from "../type/Version.sol";
 /// @dev manages proxy deployments for upgradable contracs of type IVersionable
 contract ProxyManager is
@@ -18,11 +18,13 @@ contract ProxyManager is
 {
     struct VersionInfo {
-        Version version;
+        // slot 0
         address implementation;
-        address activatedBy;
         Timestamp activatedAt;
         Blocknumber activatedIn;
+        Version version;
+        // slot 1
+        address activatedBy;
     }
     event LogProxyManagerVersionableDeployed(address indexed proxy, address initialImplementation);
@@ -37,46 +39,95 @@ contract ProxyManager is
     UpgradableProxyWithAdmin internal _proxy;
     // state to keep version history
-    mapping(Version version => VersionInfo info) _versionHistory;
-    Version [] _versions;
-    /// @dev only used to capture proxy owner
-    constructor(address registry)
-    {
-        initializeProxyManager(registry);
-    }
+    mapping(Version version => VersionInfo info) internal _versionHistory;
+    Version [] internal _versions;
-    function initializeProxyManager(address registry)
+    /// @dev convencience initializer
+    function initialize(
+        address registry,
+        address implementation,
+        bytes memory data,
+        bytes32 salt
+    )
         public
         initializer()
+        returns (IVersionable versionable)
     {
-        initializeNftOwnable(msg.sender, registry);
+        versionable = deployDetermenistic(
+            registry,
+            implementation,
+            data,
+            salt);
     }
     /// @dev deploy initial contract
-    function deploy(address initialImplementation, bytes memory initializationData)
+    function deploy(
+        address registry,
+        address initialImplementation,
+        bytes memory initializationData
+    )
         public
         virtual
-        onlyOwner()
+        onlyInitializing()
         returns (IVersionable versionable)
     {
-        if (_versions.length > 0) {
-            revert ErrorProxyManagerAlreadyDeployed();
-        }
+        (
+            address currentProxyOwner,
+            address initialProxyAdminOwner
+        ) = _preDeployChecksAndSetup(registry);
-        address currentProxyOwner = getOwner(); // used by implementation
-        address initialProxyAdminOwner = address(this); // used by proxy
         _proxy = new UpgradableProxyWithAdmin(
             initialImplementation,
             initialProxyAdminOwner,
             getDeployData(currentProxyOwner, initializationData)
         );
-        versionable = IVersionable(address(_proxy));
-        _updateVersionHistory(versionable.getVersion(), initialImplementation, currentProxyOwner);
+        versionable = _updateVersionHistory(
+            initialImplementation,
+            currentProxyOwner);
-        emit LogProxyManagerVersionableDeployed(address(_proxy), initialImplementation);
+        emit LogProxyManagerVersionableDeployed(address(versionable), initialImplementation);
+    }
+    function deployDetermenistic(
+        address registry,
+        address initialImplementation,
+        bytes memory initializationData,
+        bytes32 salt
+    )
+        public
+        virtual
+        onlyInitializing()
+        returns (IVersionable versionable)
+    {
+        (
+            address currentProxyOwner,
+            address initialProxyAdminOwner
+        ) = _preDeployChecksAndSetup(registry);
+        _proxy = new UpgradableProxyWithAdmin{salt: salt}(
+            initialImplementation,
+            initialProxyAdminOwner,
+            getDeployData(currentProxyOwner, initializationData)
+        );
+        versionable = _updateVersionHistory(
+            initialImplementation,
+            currentProxyOwner);
+        emit LogProxyManagerVersionableDeployed(address(versionable), initialImplementation);
+    }
+    /// @dev upgrade existing contract.
+    /// convenience method using empty data
+    function upgrade(address newImplementation)
+        public
+        virtual
+        onlyOwner()
+        returns (IVersionable versionable)
+    {
+        bytes memory emptyUpgradeData;
+        return upgrade(newImplementation, emptyUpgradeData);
     }
     /// @dev upgrade existing contract
@@ -99,11 +150,16 @@ contract ProxyManager is
             newImplementation,
             getUpgradeData(upgradeData));
-        versionable = IVersionable(address(_proxy));
-        _updateVersionHistory(versionable.getVersion(), newImplementation, currentProxyOwner);
+        versionable = _updateVersionHistory(
+            newImplementation,
+            currentProxyOwner);
+        emit LogProxyManagerVersionableUpgraded(address(versionable), newImplementation);
-        emit LogProxyManagerVersionableUpgraded(address(_proxy), newImplementation);
+    }
+    function linkToProxy() public returns (NftId) {
+        return _linkToNftOwnable(address(_proxy));
     }
     function getDeployData(address proxyOwner, bytes memory deployData) public pure returns (bytes memory data) {
@@ -119,7 +175,7 @@ contract ProxyManager is
             upgradeData);
     }
-    function getProxy() public returns (UpgradableProxyWithAdmin) {
+    function getProxy() public view returns (UpgradableProxyWithAdmin) {
         return _proxy;
     }
@@ -139,13 +195,34 @@ contract ProxyManager is
         return _versionHistory[_version];
     }
+    function _preDeployChecksAndSetup(address registry)
+        private
+        returns (
+            address currentProxyOwner,
+            address initialProxyAdminOwner
+        )
+    {
+        if (_versions.length > 0) {
+            revert ErrorProxyManagerAlreadyDeployed();
+        }
+        address initialOwner = msg.sender;
+        __NftOwnable_init(registry, initialOwner);
+        currentProxyOwner = getOwner(); // used by implementation
+        initialProxyAdminOwner = address(this); // used by proxy
+    }
     function _updateVersionHistory(
-        Version newVersion,
         address implementation,
         address activatedBy
     )
         private
+        returns (IVersionable versionable)
     {
+        versionable = IVersionable(address(_proxy));
+        Version newVersion = versionable.getVersion();
         if(newVersion == VersionLib.zeroVersion()) {
             revert ErrorProxyManagerZeroVersion();
         }
@@ -158,12 +235,12 @@ contract ProxyManager is
         // update version history
         _versions.push(newVersion);
-        _versionHistory[newVersion] = VersionInfo(
-            newVersion,
-            implementation,
-            activatedBy,
-            TimestampLib.blockTimestamp(),
-            blockNumber()
-        );
+        _versionHistory[newVersion] = VersionInfo({
+            version: newVersion,
+            implementation: implementation,
+            activatedBy: activatedBy,
+            activatedAt: TimestampLib.current(),
+            activatedIn: blockNumber()
+        });
     }
 }

package/contracts/upgradeability/UpgradableProxyWithAdmin.sol ADDED Viewed

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+import {ProxyAdmin} from "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
+import {TransparentUpgradeableProxy} from "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
+contract UpgradableProxyWithAdmin is TransparentUpgradeableProxy {
+    //bytes private _initializationData;
+    constructor(address implementation, address initialProxyAdminOwner, bytes memory data)
+        TransparentUpgradeableProxy(implementation, initialProxyAdminOwner, data)
+    {
+        // TODO
+        // This overwrites implementations storage
+        // Implementation can not use storage with root at slot 0 -OR- proxy MUST be stateless
+        // In case of Staking overwrites RegistryLinked._registry
+        //_initializationData = data;
+    }
+    function getProxyAdmin() external returns (ProxyAdmin) {
+        return ProxyAdmin(_proxyAdmin());
+    }
+    //function getProxyInitializationData() external view returns (bytes memory) {
+    //    return _initializationData;
+    //}
+}

package/contracts/{shared → upgradeability}/Versionable.sol RENAMED Viewed

@@ -4,7 +4,7 @@ pragma solidity ^0.8.20;
 import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
 import {IVersionable} from "./IVersionable.sol";
-import {Version, VersionLib} from "../types/Version.sol";
+import {Version, VersionLib} from "../type/Version.sol";
 abstract contract Versionable is
@@ -20,7 +20,7 @@ abstract contract Versionable is
         bytes memory data
     )
         public
-        initializer
+        initializer()
     {
         _initialize(activatedBy, data);
     }
@@ -39,12 +39,15 @@ abstract contract Versionable is
     // IMPORTANT each version must implement this function
     // each implementation MUST use onlyInitialising modifier
     // each implementation MUST call intializers of all base contracts...
-    function _initialize(address owner, bytes memory data)
+    function _initialize(
+        address, // owner
+        bytes memory // data
+    )
         internal
-        onlyInitializing
+        onlyInitializing()
         virtual
     {
-        revert();
+        revert ErrorVersionableInitializeNotImplemented();
     }
     // IMPORTANT each version except version "1" must implement this function
@@ -54,6 +57,6 @@ abstract contract Versionable is
         onlyInitializing
         virtual
     {
-        revert();
+        revert ErrorVersionableUpgradeNotImplemented();
     }
 }

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@etherisc/gif-next",
-  "version": "0.0.2-e0ff180-766",
+  "version": "0.0.2-e14821a-976",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {
@@ -30,22 +30,26 @@
   "homepage": "https://github.com/etherisc/gif-next#readme",
   "devDependencies": {
     "@nomicfoundation/hardhat-foundry": "^1.1.1",
-    "@nomicfoundation/hardhat-toolbox": "^3.0.0",
-    "@nomicfoundation/hardhat-verify": "^1.1.1",
-    "@typescript-eslint/eslint-plugin": "^7.1.0",
-    "@typescript-eslint/parser": "^7.1.0",
+    "@nomicfoundation/hardhat-toolbox": "^5.0.0",
+    "@nomicfoundation/hardhat-verify": "^2.0.1",
+    "@typescript-eslint/eslint-plugin": "^8.1.0",
+    "@typescript-eslint/parser": "^8.1.0",
+    "antlr4ng-cli": "^2.0.0",
     "dotenv": "^16.3.1",
-    "eslint": "^8.50.0",
+    "eslint": "^9.9.1",
     "hardhat": "^2.17.2",
     "prettier": "^3.0.3",
     "prettier-plugin-solidity": "^1.1.3",
     "typescript": "^5"
   },
   "dependencies": {
-    "@openzeppelin/contracts": "5.0.0",
-    "@openzeppelin/contracts-upgradeable": "5.0.0",
+    "@openzeppelin/contracts": "5.0.2",
+    "@openzeppelin/contracts-upgradeable": "5.0.2",
+    "@openzeppelin/upgrades-core": "^1.34.1",
     "abi-coder": "^5.0.0",
+    "antlr4ng": "^3.0.4",
     "ethers": "^6.7.1",
+    "ethers-decode-error": "^2.1.3",
     "solidity-docgen": "^0.6.0-beta.36",
     "winston": "^3.10.0"
   }