@etherisc/gif-next 0.0.2-d5522f6-712 → 0.0.2-d5b7b78-706

package/contracts/registry/ReleaseManager.sol

@@ -21,7 +21,7 @@ contract ReleaseManager is AccessManaged
 {
     using ObjectTypeLib for ObjectType;
 
-    event LogReleaseCreation(VersionPart version, IService registryService); 
+    event LogReleaseCreation(VersionPart version); 
     event LogReleaseActivation(VersionPart version);
 
     // createNextRelease
@@ -30,11 +30,10 @@ contract ReleaseManager is AccessManaged
 
     // registerService
     error NotService();
-    error ServiceNotInRelease(IService service, ObjectType serviceDomain);
 
     // activateNextRelease
-    //error ReleaseNotCreated();
-    //error ReleaseRegistrationNotFinished();
+    error ReleaseNotCreated();
+    error ReleaseRegistrationNotFinished();
 
     // _getAndVerifyContractInfo
     error UnexpectedRegisterableType(ObjectType expected, ObjectType found);
@@ -42,7 +41,7 @@ contract ReleaseManager is AccessManaged
     error SelfRegistration();
     error RegisterableOwnerIsRegistered();
 
-    // _verifyServiceInfo
+    // _verifyService
     error UnexpectedServiceVersion(VersionPart expected, VersionPart found);
     error UnexpectedServiceDomain(ObjectType expected, ObjectType found);
     
@@ -56,17 +55,20 @@ contract ReleaseManager is AccessManaged
     RegistryAccessManager private immutable _accessManager;
     IRegistry private immutable _registry;
 
+    VersionPart immutable _initial;// first active version    
     VersionPart _latest;// latest active version
-    VersionPart immutable _initial;// first active version
+    VersionPart _next;// version to create and activate 
 
     mapping(VersionPart version => IRegistry.ReleaseInfo info) _release;
 
-    mapping(VersionPart version => mapping(ObjectType serviceDomain => bytes4)) _selector; // registry service function selector assigned to domain 
+    mapping(VersionPart version => mapping(ObjectType serviceDomain => bytes4[])) _selectors; // registry service function selector assigned to domain 
 
     uint _awaitingRegistration; // "services left to register" counter
 
     mapping(address registryService => bool isActive) _active;
 
+    mapping(VersionPart version => bool isValid) _valid; // TODO refactor to use _active only
+
     constructor(
         RegistryAccessManager accessManager, 
         VersionPart initialVersion)
@@ -77,46 +79,82 @@ contract ReleaseManager is AccessManaged
         _accessManager = accessManager;
 
         _initial = initialVersion;
+        _next = initialVersion;
 
         _registry = new Registry();
     }
 
+    /// @dev skips previous release if was not activated
+    function createNextRelease()
+        external
+        restricted // GIF_ADMIN_ROLE
+    {
+        // allow to register new registry service for next version
+        VersionPartLib.toVersionPart(_next.toInt() + 1);
+        // disallow registration of regular services for next version while registry service is not registered 
+        _awaitingRegistration = 0;
+
+        emit LogReleaseCreation(_next); 
+    }
+
+    function activateNextRelease() 
+        external 
+        restricted // GIF_ADMIN_ROLE
+    {
+        VersionPart version = _next;
+        address service = _registry.getServiceAddress(REGISTRY(), version);
+
+        // release was created
+        if(service == address(0)) {
+            revert ReleaseNotCreated();
+        }
+
+        // release fully deployed
+        if(_awaitingRegistration > 0) {
+            revert ReleaseRegistrationNotFinished();
+        }
+
+        //setTargetClosed(service, false);
+
+        _latest = version;
+
+        _active[service] = true;
+        _valid[version] = true;
+
+        emit LogReleaseActivation(version);
+    }
+
     // TODO deploy proxy and initialize with given implementation instead of using given proxy?
     // IMPORTANT: MUST never be possible to create with access/release manager, token registry
-    function createNextRelease(IRegistryService service)
+    // callable once per release after release creation, can not register regular services while registry service is not registered
+    function registerRegistryService(IRegistryService service)
         external
-        restricted // GIF_ADMIN_ROLE
+        restricted // GIF_MANAGER_ROLE
         returns(NftId nftId)
     {
         if(!service.supportsInterface(type(IRegistryService).interfaceId)) {
             revert NotRegistryService();
         }
+
         // TODO unreliable! MUST guarantee the same authority -> how?
-        if(service.authority() != authority()) {
+        address serviceAuthority = service.authority();
+        if(serviceAuthority != authority()) {
             revert UnexpectedServiceAuthority(
                 authority(), 
-                service.authority()); 
+                serviceAuthority); 
         }
 
-        (
-            IRegistry.ObjectInfo memory info, 
-            bytes memory data
-        ) = _getAndVerifyContractInfo(service, SERVICE(), msg.sender);
+        IRegistry.ObjectInfo memory info = _getAndVerifyContractInfo(service, SERVICE(), msg.sender);
 
-        VersionPart version = getNextVersion();
+        VersionPart version = _next;
         ObjectType domain = REGISTRY();
-        _verifyServiceInfo(info, version, domain);
-
-        _createRelease(data);
-
-        //setTargetClosed(service, true);
+        _verifyService(service, version, domain);
+        _createRelease(service.getFunctionConfigs());
         
         nftId = _registry.registerService(info, version, domain);
 
         // external call
         service.linkToRegisteredNftId();
-
-        emit LogReleaseCreation(version, service); 
     }
 
     // TODO adding service to release -> synchronized with proxy upgrades or simple addServiceToRelease(service, version, selector)?
@@ -130,38 +168,22 @@ contract ReleaseManager is AccessManaged
             revert NotService();
         }
 
-        (
-            IRegistry.ObjectInfo memory info, 
-            //bytes memory data
-        ) = _getAndVerifyContractInfo(service, SERVICE(), msg.sender);
-
+        IRegistry.ObjectInfo memory info = _getAndVerifyContractInfo(service, SERVICE(), msg.sender);
         VersionPart version = getNextVersion();
-        ObjectType domain = _verifyServiceInfo(info, version, zeroObjectType());
-
-        bytes4[] memory selector = new bytes4[](1);
-        selector[0] = _selector[version][domain];
-
-        // service type is in release
-        if(selector[0] == 0) {
-            revert ServiceNotInRelease(service, domain);
-        }
+        ObjectType domain = _release[version].domains[_awaitingRegistration];// reversed registration order of services specified in RegistryService config
+        _verifyService(service, version, domain);
 
-        // setup and grant unique role
+        // setup and grant unique role if service does registrations
+        bytes4[] memory selectors = _selectors[version][domain];
         address registryService = _registry.getServiceAddress(REGISTRY(), version);
-        _accessManager.setAndGrantUniqueRole(
-            address(service), 
-            registryService, 
-            selector);
-
-        _awaitingRegistration--;
-
-        // activate release
-        if(_awaitingRegistration == 0) {
-            _latest = version;
-            _active[registryService] = true;  
-
-            emit LogReleaseActivation(version);
+        if(selectors.length > 0) {
+            _accessManager.setAndGrantUniqueRole(
+                address(service), 
+                registryService, 
+                selectors);
         }
+        
+        _awaitingRegistration--;
 
         nftId = _registry.registerService(info, version, domain);
 
@@ -169,31 +191,6 @@ contract ReleaseManager is AccessManaged
         service.linkToRegisteredNftId(); 
     }
 
-    /*function activateNextRelease() 
-        external 
-        restricted // GIF_ADMIN_ROLE
-    {
-        VersionPart version = getNextVersion();
-        address service = _registry.getServiceAddress(REGISTRY(), version);
-
-        // release was created
-        if(service == address(0)) {
-            revert ReleaseNotCreated();
-        }
-
-        // release fully deployed
-        if(_awaitingRegistration > 0) {
-            revert ReleaseRegistrationNotFinished();
-        }
-
-        //setTargetClosed(service, false);
-
-        _latest = version;
-        _active[service] = true;
-
-        LogReleaseActivation(version);
-    }*/
-
     //--- view functions ----------------------------------------------------//
 
     function isActiveRegistryService(address service) external view returns(bool)
@@ -201,6 +198,11 @@ contract ReleaseManager is AccessManaged
         return _active[service];
     }
 
+    function isValidRelease(VersionPart version) external view returns(bool)
+    {
+        return _valid[version];
+    }
+
     function getRegistry() external view returns(address)
     {
         return (address(_registry));
@@ -213,11 +215,7 @@ contract ReleaseManager is AccessManaged
 
     function getNextVersion() public view returns(VersionPart) 
     {
-        uint256 latest = _latest.toInt();
-
-        return latest == 0 ?
-            _initial : // no active releases yet
-            VersionPartLib.toVersionPart(latest + 1);
+        return _next;
     }
 
     function getLatestVersion() external view returns(VersionPart) {
@@ -236,13 +234,12 @@ contract ReleaseManager is AccessManaged
         address expectedOwner // assume always valid, can not be 0
     )
         internal
-        view
+        // view
         returns(
-            IRegistry.ObjectInfo memory info, 
-            bytes memory data
+            IRegistry.ObjectInfo memory info
         )
     {
-        (info, data) = service.getInitialInfo();
+        info = service.getInitialInfo();
         info.objectAddress = address(service);
         info.isInterceptor = false; // service is never interceptor, at least now
 
@@ -259,27 +256,14 @@ contract ReleaseManager is AccessManaged
         if(owner == address(service)) {
             revert SelfRegistration();
         }
-
-        /*if(owner == address(0)) { // never 0
-            revert();// RegisterableOwnerIsZero();
-        }*/
         
         if(_registry.isRegistered(owner)) { 
             revert RegisterableOwnerIsRegistered(); 
         }
-
-        /*NftId parentNftId = info.parentNftId;
-        IRegistry.ObjectInfo memory parentInfo = getRegistry().getObjectInfo(parentNftId);
-
-        if(parentInfo.objectType != parentType) { // parent registration + type
-            revert InvalidParent(parentNftId);
-        }*/
-
-        return(info, data);
     }
 
-    function _verifyServiceInfo(
-        IRegistry.ObjectInfo memory info,
+    function _verifyService(
+        IService service,
         VersionPart expectedVersion,
         ObjectType expectedDomain
     )
@@ -287,30 +271,22 @@ contract ReleaseManager is AccessManaged
         view
         returns(ObjectType)
     {
-        (
-            ObjectType domain,
-            VersionPart version
-        ) = abi.decode(info.data, (ObjectType, VersionPart));
-
-        if(version != expectedVersion) {
-            revert UnexpectedServiceVersion(expectedVersion, version);
+        if(service.getMajorVersion() != expectedVersion) {
+            revert UnexpectedServiceVersion(expectedVersion, service.getMajorVersion());
         }
 
-        if(expectedDomain.gtz()) { 
-            if(domain != expectedDomain) {
-                revert UnexpectedServiceDomain(expectedDomain, domain);
-            }
+        if(service.getDomain() != expectedDomain) {
+            revert UnexpectedServiceDomain(expectedDomain, service.getDomain());
         }
 
-        return domain;
+        return expectedDomain;
     }
 
     // TODO check if registry supports types specified in the config array
-    function _createRelease(bytes memory configBytes)
+    function _createRelease(IRegistryService.FunctionConfig[] memory config)
         internal
     {
         VersionPart version = getNextVersion();
-        IRegistryService.FunctionConfig[] memory config = abi.decode(configBytes, (IRegistryService.FunctionConfig[]));
 
         if(config.length == 0) {
             revert ConfigMissing();
@@ -320,23 +296,21 @@ contract ReleaseManager is AccessManaged
         for(uint idx = 0; idx < config.length; idx++)
         {
             ObjectType domain = config[idx].serviceDomain;
-            bytes4 selector = config[idx].selector;
-
             // not "registry service" / zero domain
             if(
                 domain == REGISTRY() ||
                 domain.eqz()
             ) { revert ConfigServiceDomainInvalid(idx, domain); } 
 
-            // selector not zero
-            if(selector == 0) { revert ConfigSelectorZero(idx); }
+            bytes4[] memory selectors = config[idx].selectors;
 
+            // TODO can be zero -> e.g. duplicate domain, first with zero selector, second with non zero selector -> need to check _release[version].domains.contains(domain) instead
             // no overwrite
-            if(_selector[version][domain] > 0) {
+            if(_selectors[version][domain].length > 0) {
                 revert SelectorAlreadyExists(version, domain); 
             }
             
-            _selector[version][domain] = selector;
+            _selectors[version][domain] = selectors;
             _release[version].domains.push(domain);
         }
         // TODO set when activated?

package/contracts/registry/TokenRegistry.sol

@@ -26,21 +26,32 @@ contract TokenRegistry is
     mapping(address token => bool registered) internal _registered;
     mapping(address token => mapping(VersionPart majorVersion => bool isActive)) internal _active;
 
-    constructor()
-        NftOwnable()
-    { }
+    constructor(
+        address registry
+    )
+    { 
+        initialize(registry);
+    }
+
+    function initialize(address registry)
+        public
+        initializer()
+    {
+        initializeNftOwnable(msg.sender, registry);
+    }
 
 
     /// @dev link ownership of token registry to nft owner of registry service
+    // TODO latter registry service will get new release, new address, new nft, TokenRegistry will not catch that -> use AccessManaged only for services
     function linkToNftOwnable(address registryAddress) 
         external
         onlyOwner
     {
         IRegistry registry = IRegistry(registryAddress);
-        // TODO use _latest instead of `next version` -> but _latest is 0 before first release activation
-        address registryServiceAddress = registry.getServiceAddress(REGISTRY(), registry.getMajorVersionMax());
+        // TODO use _latest instead of _initial -> but _latest is 0 before first release activation
+        address registryServiceAddress = registry.getServiceAddress(REGISTRY(), registry.getNextVersion());
 
-        _linkToNftOwnable(registryAddress, registryServiceAddress);
+        _linkToNftOwnable(registryServiceAddress);
     }
 
     /// @dev token state is informative, registry have no clue about used tokens
@@ -58,7 +69,7 @@ contract TokenRegistry is
         // verify valid major version
         // ensure major version increments is one
         uint256 version = majorVersion.toInt();
-        if (version < _registry.getMajorVersionMin().toInt() || version > _registry.getMajorVersionMax().toInt()) {
+        if (!getRegistry().isValidRelease(majorVersion)) {
             revert TokenMajorVersionInvalid(majorVersion);
         }
 
@@ -91,12 +102,7 @@ contract TokenRegistry is
             revert NotContract(token);
         }
 
-        // MUST not be GIF registerable
-        if(ERC165Checker.supportsInterface(token, type(IRegisterable).interfaceId)) {
-            revert NotToken(token);
-        }
-
-        // MUST have decimals > 0
+        // MUST have decimals > 0 (indicator that this is in fact an erc20 token)
         IERC20Metadata erc20 = IERC20Metadata(token);
         if(erc20.decimals() == 0) {
             revert TokenDecimalsZero();

package/contracts/shared/ERC165.sol

@@ -2,24 +2,26 @@
 pragma solidity ^0.8.19;
 
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
 
-contract ERC165 is IERC165 {
+contract ERC165 is
+    Initializable,
+    IERC165
+{
     mapping(bytes4 => bool) private _isSupported;
 
-    constructor() {
-        _initializeERC165();
-    }
-
-    function supportsInterface(bytes4 interfaceId) external view override returns (bool) {
-        return _isSupported[interfaceId];
-    }
-
-    // @dev register support for ERC165 itself
-    function _initializeERC165() internal {
+    // @dev initializes with support for ERC165
+    function initializeERC165() public onlyInitializing() {
         _isSupported[type(IERC165).interfaceId] = true;
     }
 
-    function _registerInterface(bytes4 interfaceId) internal {
+    // @dev register support for provided interfaceId
+    // includes initialization for ERC165_ID if not yet done
+    function registerInterface(bytes4 interfaceId) public onlyInitializing() {
         _isSupported[interfaceId] = true;
     }
+
+    function supportsInterface(bytes4 interfaceId) external view override returns (bool) {
+        return _isSupported[interfaceId];
+    }
 }

package/contracts/shared/INftOwnable.sol

@@ -1,22 +1,23 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IRegistry} from "../registry/IRegistry.sol";
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+
+import {IRegistryLinked} from "./IRegistryLinked.sol";
 import {NftId} from "../types/NftId.sol";
 
-interface INftOwnable {
-    error ErrorNotOwner(address account);
+interface INftOwnable is
+    IERC165,
+    IRegistryLinked
+{
+    error ErrorNftOwnableInitialOwnerZero();
+    error ErrorNftOwnableNotOwner(address account);
 
-    error ErrorAlreadyLinked(address registry, NftId nftId);
-    error ErrorRegistryAlreadyInitialized(address registry);
-    error ErrorRegistryNotInitialized();
-    error ErrorRegistryAddressZero();
-    error ErrorNotRegistry(address registryAddress);
-    error ErrorContractNotRegistered(address contractAddress);
+    error ErrorNftOwnableAlreadyLinked(NftId nftId);
+    error ErrorNftOwnableContractNotRegistered(address contractAddress);
 
     function linkToRegisteredNftId() external;
 
-    function getRegistry() external view returns (IRegistry);
     function getNftId() external view returns (NftId);
     function getOwner() external view returns (address);
 }

package/contracts/shared/IPolicyHolder.sol

@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import {IERC721Receiver} from "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
+
+import {IRegistry} from "../registry/IRegistry.sol";
+import {NftId} from "../types/NftId.sol";
+import {NumberId} from "../types/NumberId.sol";
+
+/// @dev generic interface for contracts that need to hold policies and receive payouts
+/// GIF will notify policy holder contracts for policy creation and payout execution
+/// 
+
+interface IPolicyHolder is IERC165, IERC721Receiver {
+
+    /// @dev callback function that will be called after successful policy creation
+    function policyCreatedCallback(NftId policyNftId) external;
+
+    /// @dev callback function that will be called after a successful payout
+    function payoutExecutedCallback(NftId policyNftId, NumberId payoutId, address beneficiary, uint256 amount) external;
+
+    /// @dev determines beneficiary address that will be used in payouts targeting this contract
+    /// returned address will override GIF default where the policy nft holder is treated as beneficiary
+    function getBeneficiary(NftId policyId, NumberId claimId) external view returns (address beneficiary);
+}

package/contracts/shared/IRegisterable.sol

@@ -1,17 +1,15 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
-
 import {INftOwnable} from "./INftOwnable.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
-import {NftId} from "../types/NftId.sol";
-import {ObjectType} from "../types/ObjectType.sol";
 
-interface IRegisterable is IERC165, INftOwnable {
+interface IRegisterable is
+    INftOwnable
+{
 
     function getInitialInfo() 
         external 
         view
-        returns (IRegistry.ObjectInfo memory, bytes memory data);
+        returns (IRegistry.ObjectInfo memory);
 }

package/contracts/shared/IRegistryLinked.sol

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IRegistry} from "../registry/IRegistry.sol";
+
+interface IRegistryLinked {
+
+    error ErrorNotRegistry(address registryAddress);
+
+    function getRegistry() external view returns (IRegistry);
+    function getRegistryAddress() external view returns (address);
+}

package/contracts/shared/IService.sol

@@ -11,6 +11,8 @@ interface IService is
     IRegisterable,
     IVersionable
 {
+    error ErrorIServiceCallerUnknown(address caller);
+    
     function getDomain() external pure returns(ObjectType serviceDomain);
     function getMajorVersion() external view returns(VersionPart majorVersion);
 }

package/contracts/shared/IVersionable.sol

@@ -1,11 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Blocknumber} from "../types/Blocknumber.sol";
-import {Timestamp} from "../types/Timestamp.sol";
 import {Version} from "../types/Version.sol";
 
-
 /// IMPORTANT
 // Upgradeable contract MUST:
 // 1) inherit from Versionable
@@ -14,7 +11,7 @@ import {Version} from "../types/Version.sol";
 // 4) implement internal _upgrade() function with onlyInitializing modifier (1st version MUST revert)
 // 5) have onlyInitialising modifier for each function callable inside _initialize()/_upgrade() (MUST use different functions for initialization/upgrade and normal operations)
 // 6) use default empty constructor -> _disableInitializer() is called from Versionable contructor
-// 7) use namespace storage
+// 7) use namespace storage (should this be needed)
 // 8) since now inheritance is used for upgradability, contract MUST BE inherited ONLY by the next version 
 // Upgradeable contract SHOULD:
 // 9) define all non private methods as virtual (in order to be able to upgrade them latter)
@@ -22,48 +19,29 @@ import {Version} from "../types/Version.sol";
 //    in some cases this ok but not in the others...
 //
 // IMPORTANT
-// Each version MUST:
+// If introducting/amending storage related to Versionable version MUST:
 // 1) define namespace storage struct if accessing storage
 //      - DO NOT use structs inside, except
 //      - CAN use structs ONLY inside mappings
 // 2) ALWAYS define private getter if accessing storage
 //      - MUST use default implementation, CAN change ONLY return type
-//      - MUST use the same "LOCATION_V1"
 
 interface IVersionable {
 
-    struct VersionInfo {
-        Version version;
-        address implementation;
-        address activatedBy;
-        Timestamp activatedAt;
-        Blocknumber activatedIn;
-    }
-
-    event LogVersionableInitialized(Version version, address implementation, address activatedBy);
-
-    // TODO uncomment when all implementations are ready
     /**
      * @dev IMPORTANT
      * implementation MUST be guarded by initializer modifier
-     * implementation MUST call internal function Versionable._updateVersionHistory 
      * new version MUST inherit from previous version
      */
-    function initialize(address implementation, address activatedBy, bytes memory activationData) external;
+    function initializeVersionable(address activatedBy, bytes memory activationData) external;
 
     /**
      * @dev
      * implementation MUST be guarded by reinitializer(version().toUint64()) modifier
-     * implementation MUST call internal function Versionable._updateVersionHistory
      * new version MUST inherit from previous version
      * the first verion MUST revert 
      */
-    function upgrade(address implementation, address activatedBy, bytes memory upgradeData) external;
-
-    /**
-     * @dev returns true if the specified version has been activated for the current contract
-     */
-    function isInitialized(Version version) external view returns(bool);
+    function upgradeVersionable(bytes memory upgradeData) external;
 
     /**
      * @dev returns version of this contract
@@ -72,25 +50,4 @@ interface IVersionable {
      */
     function getVersion() external pure returns(Version);
 
-    /**
-     * @dev returns the number of all deployed versions of this contract
-     */
-    function getVersionCount() external view returns(uint256 numberOfVersions);
-
-    /**
-     * @dev returns the i-th (index) version of this contract
-     */
-    function getVersion(uint256 index) external view returns(Version version);
-
-    /**
-     * @dev returns the i-th (index) version info of this contract
-     */
-    function getVersionInfo(Version version) external view returns(VersionInfo memory versionInfo);
-
-    // TODO make sure it is needed here
-    /**
-     * @dev returns currently active version
-     */
-    function getInitializedVersion() external view returns(uint64);
-
 }