@etherisc/gif-next 0.0.2-f4f92b3-338 → 0.0.2-f509abc-684

package/contracts/registry/RegistryService.sol

@@ -19,7 +19,7 @@ import {IRegisterable} from "../../contracts/shared/IRegisterable.sol";
 import {Registerable} from "../../contracts/shared/Registerable.sol";
 
 import {RoleId, PRODUCT_OWNER_ROLE, POOL_OWNER_ROLE, ORACLE_OWNER_ROLE} from "../../contracts/types/RoleId.sol";
-import {ObjectType, REGISTRY, SERVICE, PRODUCT, ORACLE, POOL, INSTANCE, DISTRIBUTION, POLICY, BUNDLE, STAKE} from "../../contracts/types/ObjectType.sol";
+import {ObjectType, REGISTRY, SERVICE, PRODUCT, ORACLE, POOL, INSTANCE, DISTRIBUTION, DISTRIBUTOR, APPLICATION, POLICY, CLAIM, BUNDLE, STAKE} from "../../contracts/types/ObjectType.sol";
 import {StateId, ACTIVE, PAUSED} from "../../contracts/types/StateId.sol";
 import {NftId, NftIdLib, zeroNftId} from "../../contracts/types/NftId.sol";
 import {Fee, FeeLib} from "../../contracts/types/Fee.sol";
@@ -40,6 +40,33 @@ contract RegistryService is
     // TODO update to real hash when registry is stable
     bytes32 public constant REGISTRY_CREATION_CODE_HASH = bytes32(0);
 
+    // From IService
+    function getDomain() public pure override(IService, Service) returns(ObjectType serviceDomain) {
+        return REGISTRY(); 
+    }
+
+    // from Versionable
+
+    /// @dev top level initializer
+    function _initialize(
+        address owner, 
+        bytes memory data
+    )
+        internal
+        virtual override
+        initializer()
+    {
+        (
+            address registryAddress,
+            address initialAuthority
+        ) = abi.decode(data, (address, address));
+
+        __AccessManaged_init(initialAuthority);
+
+        initializeService(registryAddress, owner);
+        registerInterface(type(IRegistryService).interfaceId);
+    }
+
     function registerInstance(IRegisterable instance, address owner)
         external
         restricted
@@ -52,7 +79,7 @@ contract RegistryService is
         }
 
         info = _getAndVerifyContractInfo(instance, INSTANCE(), owner);
-        info.nftId = _registry.register(info);
+        info.nftId = getRegistry().register(info);
 
         instance.linkToRegisteredNftId(); // asume safe
     }
@@ -70,7 +97,7 @@ contract RegistryService is
         }
 
         info = _getAndVerifyContractInfo(product, PRODUCT(), owner);
-        info.nftId = _registry.register(info);
+        info.nftId = getRegistry().register(info);
     }
 
     function registerPool(IComponent pool, address owner)
@@ -85,7 +112,7 @@ contract RegistryService is
         }
 
         info = _getAndVerifyContractInfo(pool, POOL(), owner);
-        info.nftId = _registry.register(info);
+        info.nftId = getRegistry().register(info);
     }
 
     function registerDistribution(IComponent distribution, address owner)
@@ -100,7 +127,16 @@ contract RegistryService is
         }
 
         info = _getAndVerifyContractInfo(distribution, DISTRIBUTION(), owner);
-        info.nftId = _registry.register(info);
+        info.nftId = getRegistry().register(info);
+    }
+
+    function registerDistributor(IRegistry.ObjectInfo memory info)
+        external
+        restricted 
+        returns(NftId nftId) 
+    {
+        _verifyObjectInfo(info, DISTRIBUTOR());
+        nftId = getRegistry().register(info);
     }
 
     function registerPolicy(IRegistry.ObjectInfo memory info)
@@ -110,7 +146,7 @@ contract RegistryService is
     {
         _verifyObjectInfo(info, POLICY());
 
-        nftId = _registry.register(info);
+        nftId = getRegistry().register(info);
     }
 
     function registerBundle(IRegistry.ObjectInfo memory info)
@@ -120,7 +156,7 @@ contract RegistryService is
     {
         _verifyObjectInfo(info, BUNDLE());
 
-        nftId = _registry.register(info);
+        nftId = getRegistry().register(info);
     }
 
     function registerStake(IRegistry.ObjectInfo memory info)
@@ -130,35 +166,7 @@ contract RegistryService is
     {
         _verifyObjectInfo(info, STAKE());
 
-        nftId = _registry.register(info);
-    }
-
-    // From IService
-    function getDomain() public pure override(IService, Service) returns(ObjectType serviceDomain) {
-        return REGISTRY(); 
-    }
-
-    // from Versionable
-
-    /// @dev top level initializer
-    function _initialize(
-        address owner, 
-        bytes memory data
-    )
-        internal
-        initializer
-        virtual override
-    {
-        (
-            address initialAuthority,
-            address registry
-        ) = abi.decode(data, (address, address));
-
-        __AccessManaged_init(initialAuthority);
-
-        _initializeService(address(registry), owner);
-
-        _registerInterface(type(IRegistryService).interfaceId);
+        nftId = getRegistry().register(info);
     }
 
     // from IRegisterable
@@ -170,30 +178,43 @@ contract RegistryService is
             FunctionConfig[] memory config
         )
     {
-        config = new FunctionConfig[](6);
+        config = new FunctionConfig[](8);
 
         // order of service registrations MUST be reverse to this array 
         /*config[-1].serviceDomain = STAKE();
         config[-1].selector = RegistryService.registerStake.selector;*/
 
         config[0].serviceDomain = POLICY();
-        config[0].selector = RegistryService.registerPolicy.selector;
+        config[0].selectors = new bytes4[](0);
+
+        config[1].serviceDomain = APPLICATION();
+        config[1].selectors = new bytes4[](1);
+        config[1].selectors[0] = RegistryService.registerPolicy.selector;
+
+        config[2].serviceDomain = CLAIM();
+        config[2].selectors = new bytes4[](0);
 
-        config[1].serviceDomain = BUNDLE();
-        config[1].selector = RegistryService.registerBundle.selector;
+        config[3].serviceDomain = BUNDLE();
+        config[3].selectors = new bytes4[](1);
+        config[3].selectors[0] = RegistryService.registerBundle.selector;
 
-        config[2].serviceDomain = PRODUCT();
-        config[2].selector = RegistryService.registerProduct.selector;
+        config[4].serviceDomain = PRODUCT();
+        config[4].selectors = new bytes4[](1);
+        config[4].selectors[0] = RegistryService.registerProduct.selector;
 
-        config[3].serviceDomain = POOL();
-        config[3].selector = RegistryService.registerPool.selector;
+        config[5].serviceDomain = POOL();
+        config[5].selectors = new bytes4[](1);
+        config[5].selectors[0] = RegistryService.registerPool.selector;
 
-        config[4].serviceDomain = DISTRIBUTION();
-        config[4].selector = RegistryService.registerDistribution.selector;
+        config[6].serviceDomain = DISTRIBUTION();
+        config[6].selectors = new bytes4[](2);
+        config[6].selectors[0] = RegistryService.registerDistribution.selector;
+        config[6].selectors[1] = RegistryService.registerDistributor.selector;
 
         // registerInstance() have no restriction
-        config[5].serviceDomain = INSTANCE();
-        config[5].selector = RegistryService.registerInstance.selector;
+        config[7].serviceDomain = INSTANCE();
+        config[7].selectors = new bytes4[](1);
+        config[7].selectors[0] = RegistryService.registerInstance.selector;
     }
 
     // Internal

package/contracts/registry/RegistryServiceManager.sol

@@ -22,32 +22,32 @@ contract RegistryServiceManager is
     /// @dev initializes proxy manager with registry service implementation and deploys registry
     constructor(
         address initialAuthority, // used by implementation 
-        address registry) // used by implementation 
-        ProxyManager()
+        address registryAddress) // used by implementation 
+        ProxyManager(registryAddress)
     {
         require(initialAuthority > address(0), "RegistryServiceManager: initial authority is 0");
-        require(registry > address(0), "RegistryServiceManager: registry is 0");
+        require(registryAddress > address(0), "RegistryServiceManager: registry is 0");
         
         // implementation's initializer func `data` argument
-        bytes memory initializationData = abi.encode(
-            initialAuthority,
-            registry); 
-
+        RegistryService srv = new RegistryService();
+        bytes memory data = abi.encode(registryAddress, initialAuthority);
         IVersionable versionable = deploy(
-            address(new RegistryService()), 
-            initializationData);
+            address(srv), 
+            data);
 
         _registryService = RegistryService(address(versionable));
+
+//        _linkToNftOwnable(address(_registryService));
     }
 
-    // from IRegisterable
+    // // from IRegisterable
 
-    // IMPORTANT: registry here and in constructor MUST be the same
-    function linkToNftOwnable(address registry)
+    // // IMPORTANT: registry here and in constructor MUST be the same
+    function linkOwnershipToServiceNft()
         public
         onlyOwner
     {
-        _linkToNftOwnable(registry, address(_registryService));
+        _linkToNftOwnable(address(_registryService));
     }
 
     //--- view functions ----------------------------------------------------//

package/contracts/registry/ReleaseManager.sol

@@ -41,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);
     
@@ -61,7 +61,7 @@ contract ReleaseManager is AccessManaged
 
     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
 
@@ -148,12 +148,8 @@ contract ReleaseManager is AccessManaged
 
         VersionPart version = _next;
         ObjectType domain = REGISTRY();
-        _verifyServiceInfo(info, version, domain);
-
-        // data: config bytes
+        _verifyService(service, version, domain);
         _createRelease(service.getFunctionConfigs());
-
-        //setTargetClosed(service, true);
         
         nftId = _registry.registerService(info, version, domain);
 
@@ -175,17 +171,16 @@ contract ReleaseManager is AccessManaged
         IRegistry.ObjectInfo memory info = _getAndVerifyContractInfo(service, SERVICE(), msg.sender);
         VersionPart version = getNextVersion();
         ObjectType domain = _release[version].domains[_awaitingRegistration];// reversed registration order of services specified in RegistryService config
-        _verifyServiceInfo(info, version, domain);
+        _verifyService(service, version, domain);
 
         // setup and grant unique role if service does registrations
-        bytes4[] memory selector = new bytes4[](1);
-        selector[0] = _selector[version][domain];
+        bytes4[] memory selectors = _selectors[version][domain];
         address registryService = _registry.getServiceAddress(REGISTRY(), version);
-        if(selector[0] != 0) {
+        if(selectors.length > 0) {
             _accessManager.setAndGrantUniqueRole(
                 address(service), 
                 registryService, 
-                selector);
+                selectors);
         }
         
         _awaitingRegistration--;
@@ -267,8 +262,8 @@ contract ReleaseManager is AccessManaged
         }
     }
 
-    function _verifyServiceInfo(
-        IRegistry.ObjectInfo memory info,
+    function _verifyService(
+        IService service,
         VersionPart expectedVersion,
         ObjectType expectedDomain
     )
@@ -276,20 +271,15 @@ 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(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
@@ -306,21 +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); } 
 
+            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,9 +26,19 @@ 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
@@ -40,9 +50,8 @@ contract TokenRegistry is
         IRegistry registry = IRegistry(registryAddress);
         // TODO use _latest instead of _initial -> but _latest is 0 before first release activation
         address registryServiceAddress = registry.getServiceAddress(REGISTRY(), registry.getNextVersion());
-        //address registryServiceAddress = registry.getServiceAddress(REGISTRY(), registry.getInitialVersion());
 
-        _linkToNftOwnable(registryAddress, registryServiceAddress);
+        _linkToNftOwnable(registryServiceAddress);
     }
 
     /// @dev token state is informative, registry have no clue about used tokens
@@ -60,7 +69,7 @@ contract TokenRegistry is
         // verify valid major version
         // ensure major version increments is one
         uint256 version = majorVersion.toInt();
-        if (!_registry.isValidRelease(majorVersion)) {
+        if (!getRegistry().isValidRelease(majorVersion)) {
             revert TokenMajorVersionInvalid(majorVersion);
         }
 
@@ -93,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,12 +1,12 @@
 // 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";
 
-interface IRegisterable is IERC165, INftOwnable {
+interface IRegisterable is
+    INftOwnable
+{
 
     function getInitialInfo() 
         external 

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);
-
 }