@etherisc/gif-next 0.0.2-790d44b-698 → 0.0.2-7acbd99-227

package/contracts/shared/Registerable.sol

@@ -1,21 +1,39 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
+
+import {Initializable} from "@openzeppelin5/contracts/proxy/utils/Initializable.sol"; 
 
 import {NftId, zeroNftId} from "../types/NftId.sol";
 import {ObjectType} from "../types/ObjectType.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegisterable} from "./IRegisterable.sol";
+import {Versionable} from "./Versionable.sol";
 
 import {ERC165} from "./ERC165.sol";
 
 abstract contract Registerable is
     ERC165,
-    IRegisterable
+    IRegisterable,
+    Initializable
 {
-    IRegistry internal immutable _registry;
-    NftId internal immutable _parentNftId;
-    address internal immutable _initialOwner;
+    // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.shared.Registerable.sol")) - 1)) & ~bytes32(uint256(0xff));
+    bytes32 public constant REGISTERABLE_LOCATION_V1 = 0x6548007c3f4340f82f348c576c0ff69f4f529cadd5ad41f96aae61abceeaa300;
+
+    struct RegisterableStorage {
+        IRegistry _registry;
+        NftId _parentNftId;
+        address _initialOwner;
+        ObjectType _objectType;
+        bool _isInterceptor;
+        bytes _data;
+    }
+
+    function _getRegisterableStorage() private pure returns (RegisterableStorage storage $) {
+        assembly {
+            $.slot := REGISTERABLE_LOCATION_V1
+        }
+    }
 
     modifier onlyOwner() virtual {
         require(
@@ -25,62 +43,75 @@ abstract contract Registerable is
         _;
     }
 
-    constructor(
+    function _initializeRegisterable(
         address registryAddress,
-        NftId parentNftId
+        NftId parentNftId,
+        ObjectType objectType,
+        bool isInterceptor,
+        address initialOwner,
+        bytes memory data
     )
-        ERC165()
+        internal
+        //onlyInitializing//TODO uncomment when "fully" upgradeable
+        virtual
     {
         require(
-            address(registryAddress) != address(0),
+            registryAddress != address(0),
             "ERROR:RGB-010:REGISTRY_ZERO"
         );
 
-        _registry = IRegistry(registryAddress);
-        require(
-            _registry.supportsInterface(type(IRegistry).interfaceId),
-            "ERROR:RGB-011:NOT_REGISTRY"
-        );
+        // TODO check parentNftId -> registry.isRegistered(parentNftId)
+        // TODO check object-parent type pair -> registry.isValidTypeCombo() or something...verify with registry that setup will be able to register...
 
-        _parentNftId = parentNftId;
+        IRegistry registry = IRegistry(registryAddress);
         require(
-            _registry.isRegistered(_parentNftId),
-            "ERROR:RGB-012:PARENT_NOT_REGISTERED"
+            registry.supportsInterface(type(IRegistry).interfaceId),
+            "ERROR:RGB-011:NOT_REGISTRY"
         );
 
-        _initialOwner = msg.sender;
+        RegisterableStorage storage $ = _getRegisterableStorage();
+        $._registry = registry;
+        $._parentNftId = parentNftId;
+        $._objectType = objectType;
+        $._isInterceptor = isInterceptor;
+        $._initialOwner = initialOwner;// not msg.sender because called in proxy constructor where msg.sender is proxy deployer
+        $._data = data;
 
-        // register support for IRegisterable
-        _registerInterface(type(IRegisterable).interfaceId);
+        _registerInterface(type(Registerable).interfaceId);
     }
 
-    // from IRegistryLinked
-    function register() public onlyOwner virtual override returns (NftId nftId) {
-        return _registry.register(address(this));
+    // from IOwnable
+    function getOwner() public view virtual returns (address) {
+        return _getRegisterableStorage()._registry.ownerOf(address(this));
     }
 
-    function getRegistry() public view virtual override returns (IRegistry registry) {
-        return _registry;
+    // from IRegisterable
+    function getRegistry() public view virtual returns (IRegistry registry) {
+        return _getRegisterableStorage()._registry;
     }
 
-    function getOwner() public view virtual override returns (address owner) {
-        NftId nftId = _registry.getNftId(address(this));
-        if(nftId == zeroNftId()) {
-            return _initialOwner;
-        }
-
-        return _registry.getOwner(nftId);
-    }
-
-    function getNftId() public view override returns (NftId nftId) {
-        return _registry.getNftId(address(this));
+    function getNftId() public view virtual returns (NftId nftId) {
+        return _getRegisterableStorage()._registry.getNftId(address(this));
     }
 
-    function getParentNftId() public view override returns (NftId nftId) {
-        return _parentNftId;
-    }
-
-    function getData() public view virtual override returns (bytes memory data) {
-        return "";
+    function getInitialInfo() 
+        public 
+        view 
+        virtual 
+        returns (IRegistry.ObjectInfo memory, bytes memory data) 
+    {
+        RegisterableStorage storage $ = _getRegisterableStorage();
+        return (
+            IRegistry.ObjectInfo(
+                zeroNftId(),
+                $._parentNftId,
+                $._objectType,
+                $._isInterceptor,
+                address(this), 
+                $._initialOwner,
+                $._data
+            ),
+            bytes("")
+        );
     }
-}
+}

package/contracts/shared/UpgradableProxyWithAdmin.sol

@@ -0,0 +1,16 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {ProxyAdmin} from "@openzeppelin5/contracts/proxy/transparent/ProxyAdmin.sol";
+import {TransparentUpgradeableProxy, ITransparentUpgradeableProxy} from "@openzeppelin5/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
+
+import {IVersionable} from "./IVersionable.sol";
+
+contract UpgradableProxyWithAdmin is TransparentUpgradeableProxy {
+
+    constructor(address implementation, address initialProxyAdminOwner, bytes memory data)
+        TransparentUpgradeableProxy(implementation, initialProxyAdminOwner, data)
+    {}
+
+    function getProxyAdmin() external returns (ProxyAdmin) { return ProxyAdmin(_proxyAdmin()); }
+}

package/contracts/shared/Versionable.sol

@@ -15,6 +15,10 @@ abstract contract Versionable is
     Initializable,
     IVersionable 
 {
+    // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.shared.Versionable.sol")) - 1)) & ~bytes32(uint256(0xff))
+    bytes32 private constant VERSIONABLE_LOCATION_V1 = 0x4f61291a8ac3d020d0a7d919a76b8592aa88385744dee3f8b4f3873b969ed900;
+
+
     /// @custom:storage-location erc7201:gif-next.contracts.shared.Versionable.sol
     struct VersionableStorage {
         mapping(Version version => VersionInfo info) _versionHistory;
@@ -22,30 +26,24 @@ abstract contract Versionable is
         Version _v1;
     }
 
-    // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.shared.Versionable.sol")) - 1)) & ~bytes32(uint256(0xff))
-    bytes32 private constant VersionableStorageLocation = 0x4f61291a8ac3d020d0a7d919a76b8592aa88385744dee3f8b4f3873b969ed900;
-    
-    function _getVersionableStorage() private pure returns (VersionableStorage storage $) {
-        assembly {
-            $.slot := VersionableStorageLocation
-        }
-    }
 
     constructor() {
         _disableInitializers();
     }
-
+    // TODO write test where new version of private _updateVersionHistory is added and used... 
     function initialize(
         address implementation,
-        address activatedBy, // TODO can it be a msg.sender ? 
+        address activatedBy,
         bytes memory data
     )
         public
         initializer
     {
         _updateVersionHistory(implementation, activatedBy);
-        _initialize(data);
+        _initialize(activatedBy, data);
     }
+
+    // TODO activatedBy MUST ALWAYS be an owner?
     function upgrade(
         address implementation,
         address activatedBy,
@@ -57,13 +55,42 @@ abstract contract Versionable is
         _updateVersionHistory(implementation, activatedBy);
         _upgrade(data);
     }
+
+    function isInitialized(Version _version) public override view returns(bool) {
+        return _getVersionableStorage()._versionHistory[_version].activatedIn.toInt() > 0;
+    }
+
+    function getVersion() public pure virtual returns(Version);
+
+    function getVersionCount() public view override returns(uint256) {
+        return _getVersionableStorage()._versions.length;
+    }
+
+    function getVersion(uint256 idx) public view override returns(Version) {
+        return _getVersionableStorage()._versions[idx];
+    }
+
+    function getVersionInfo(Version _version) public override view returns(VersionInfo memory) {
+        return _getVersionableStorage()._versionHistory[_version];
+    }
+
+    function getInitializedVersion() public view returns(uint64) {
+        return _getInitializedVersion();
+    }
+
+
+
     // IMPORTANT each version must implement this function 
     // each implementation MUST use onlyInitialising modifier
-    function _initialize(bytes memory data) 
+    // each implementation MUST call intializers of all base contracts...
+    function _initialize(address owner, bytes memory data) 
         internal
         onlyInitializing
         virtual 
-    {}
+    {
+        revert();
+    }
+
 
     // IMPORTANT each version except version "1" must implement this function 
     // each implementation MUST use onlyInitialising modifier
@@ -75,6 +102,12 @@ abstract contract Versionable is
         revert();
     }
 
+    function _getVersionableStorage() private pure returns (VersionableStorage storage $) {
+        assembly {
+            $.slot := VERSIONABLE_LOCATION_V1
+        }
+    }
+
     // can only be called once per contract
     // needs to be called inside the proxy upgrade tx
     // TODO run reinitializer(version().toUint64()) modifier after "version()" is checked, 
@@ -111,31 +144,4 @@ abstract contract Versionable is
 
         emit LogVersionableInitialized(thisVersion, implementation, activatedBy);
     }
-
-    // TODO previous version(s) can not be active -> check that _version is the latest one
-    function isInitialized(Version _version) public override view returns(bool) {
-        return _getVersionableStorage()._versionHistory[_version].activatedIn.toInt() > 0;
-    }
-
-
-    function getVersion() public pure virtual returns(Version);
-
-
-    function getVersionCount() external view override returns(uint256) {
-        return _getVersionableStorage()._versions.length;
-    }
-
-    function getVersion(uint256 idx) external view override returns(Version) {
-        return _getVersionableStorage()._versions[idx];
-    }
-
-
-    function getVersionInfo(Version _version) external override view returns(VersionInfo memory) {
-        return _getVersionableStorage()._versionHistory[_version];
-    }
-
-    function getInitializedVersion() external view returns(uint64)
-    {
-        return _getInitializedVersion();
-    }
 }

package/contracts/test/TestDistribution.sol

@@ -13,9 +13,10 @@ contract TestDistribution is Distribution {
         NftId instanceNftid,
         address token,
         bool isVerifying,
-        Fee memory distributionFee
+        Fee memory distributionFee,
+        address initialOwner
     )
-        Distribution(registry, instanceNftid, token, isVerifying, distributionFee)
+        Distribution(registry, instanceNftid, token, isVerifying, distributionFee, initialOwner)
     // solhint-disable-next-line no-empty-blocks
     {}
 }

package/contracts/test/TestPool.sol

@@ -13,13 +13,15 @@ contract TestPool is Pool {
         address registry,
         NftId instanceNftid,
         address token,
+        bool isInterceptor,
         bool isVerifying,
         UFixed collateralizationLevel,
         Fee memory poolFee,
         Fee memory stakingFee,
-        Fee memory performanceFee
+        Fee memory performanceFee,
+        address initialOwner
     )
-        Pool(registry, instanceNftid, token, isVerifying, collateralizationLevel, poolFee, stakingFee, performanceFee)
+        Pool(registry, instanceNftid, token, isInterceptor, isVerifying, collateralizationLevel, poolFee, stakingFee, performanceFee, initialOwner)
     // solhint-disable-next-line no-empty-blocks
     {}
 }

package/contracts/test/TestProduct.sol

@@ -19,12 +19,14 @@ contract TestProduct is Product {
         address registry,
         NftId instanceNftid,
         address token,
+        bool isInterceptor,
         address pool,
         address distribution,
         Fee memory productFee,
-        Fee memory processingFee
+        Fee memory processingFee,
+        address initialOwner
     )
-        Product(registry, instanceNftid, token, pool, distribution, productFee, processingFee)
+        Product(registry, instanceNftid, token, isInterceptor, pool, distribution, productFee, processingFee, initialOwner)
     // solhint-disable-next-line no-empty-blocks
     {
     }

package/contracts/test/TestRegisterable.sol

@@ -8,12 +8,11 @@ import {Registerable} from "../../contracts/shared/Registerable.sol";
 
 contract TestRegisterable is Registerable {
 
-    constructor(address registry, NftId registryNftId)
-        Registerable(registry, registryNftId)
+    constructor(address registry, NftId registryNftId, ObjectType objectType, bool isInterceptor, address initialOwner)
+        //Registerable(registry, registryNftId)
     // solhint-disable-next-line no-empty-blocks
-    {}
-
-    function getType() external pure override returns (ObjectType) {
-        return TOKEN();
+    {
+        bytes memory data = "";
+        _initializeRegisterable(registry, registryNftId, objectType, isInterceptor, initialOwner, data);
     }
 }

package/contracts/test/TestService.sol

@@ -8,25 +8,19 @@ import {ServiceBase} from "../../contracts/instance/base/ServiceBase.sol";
 import {IVersionable} from "../../contracts/shared/IVersionable.sol";
 import {Versionable} from "../../contracts/shared/Versionable.sol";
 
+//import {IService} from "../../contracts/instance/base/IService.sol";
+
 contract TestService is ServiceBase {
 
     string public constant NAME = "TestService";
 
-    constructor(address registry, NftId registryNftId)
-        ServiceBase(registry, registryNftId)
+    constructor(address registry, NftId registryNftId, address initialOwner)
     // solhint-disable-next-line no-empty-blocks
-    {}
-
-    function getVersion()
-        public 
-        pure 
-        virtual override (IVersionable, Versionable)
-        returns(Version)
     {
-        return VersionLib.toVersion(3,0,0);
+        _initializeServiceBase(registry, registryNftId, initialOwner);
     }
 
-    function getName() external pure override returns(string memory name) {
+    function getName() public pure override returns(string memory name) {
         return NAME;
     }
 }

package/contracts/types/Version.sol

@@ -94,6 +94,7 @@ library VersionLib {
 
     // TODO check for overflow?
     function toVersion(uint64 versionNumber) external pure returns(Version) {
+        //assert(versionNumber <= type(Version).max);
         return Version.wrap(uint24(versionNumber));
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherisc/gif-next",
-  "version": "0.0.2-790d44b-698",
+  "version": "0.0.2-7acbd99-227",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {

package/artifacts/contracts/shared/Proxy.sol/ProxyDeployer.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/8001b3000c8aaafadc7458dc79160a6a.json"
-}