@etherisc/gif-next 0.0.2-b060f43-287 → 0.0.2-b1059a4-617

package/contracts/instance/Instance.sol

@@ -1,45 +1,52 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
-import {ShortString, ShortStrings} from "@openzeppelin/contracts/utils/ShortStrings.sol";
-import {Initializable} from "@openzeppelin/contracts/proxy/utils/Initializable.sol";
 import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
-import {AccessManagerUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagerUpgradeable.sol";
 
-import {IAccess} from "./module/IAccess.sol";
-import {IBundle} from "./module/IBundle.sol";
-import {IPolicy} from "./module/IPolicy.sol";
-import {IRisk} from "./module/IRisk.sol";
-import {ISetup} from "./module/ISetup.sol";
 import {Key32, KeyId, Key32Lib} from "../types/Key32.sol";
-import {KeyValueStore} from "./base/KeyValueStore.sol";
-import {IInstance} from "./IInstance.sol";
-import {InstanceReader} from "./InstanceReader.sol";
-import {BundleManager} from "./BundleManager.sol";
 import {NftId} from "../types/NftId.sol";
+import {ClaimId} from "../types/ClaimId.sol";
 import {NumberId} from "../types/NumberId.sol";
-import {ObjectType, BUNDLE, DISTRIBUTION, INSTANCE, POLICY, POOL, ROLE, PRODUCT, TARGET} from "../types/ObjectType.sol";
+import {ObjectType, BUNDLE, DISTRIBUTION, INSTANCE, POLICY, POOL, ROLE, PRODUCT, TARGET, COMPONENT, DISTRIBUTOR, DISTRIBUTOR_TYPE} from "../types/ObjectType.sol";
 import {RiskId, RiskIdLib} from "../types/RiskId.sol";
 import {RoleId, RoleIdLib} from "../types/RoleId.sol";
 import {StateId, ACTIVE} from "../types/StateId.sol";
+import {TimestampLib} from "../types/Timestamp.sol";
+import {VersionPart} from "../types/Version.sol";
+
 import {ERC165} from "../shared/ERC165.sol";
 import {Registerable} from "../shared/Registerable.sol";
-import {ComponentOwnerService} from "./service/ComponentOwnerService.sol";
-import {IComponentOwnerService} from "./service/IComponentOwnerService.sol";
+
+import {IInstance} from "./IInstance.sol";
+import {InstanceReader} from "./InstanceReader.sol";
+import {InstanceAccessManager} from "./InstanceAccessManager.sol";
+import {BundleManager} from "./BundleManager.sol";
+
+import {KeyValueStore} from "./base/KeyValueStore.sol";
+
+import {IAccess} from "./module/IAccess.sol";
+import {IBundle} from "./module/IBundle.sol";
+import {IDistribution} from "./module/IDistribution.sol";
+import {IPolicy} from "./module/IPolicy.sol";
+import {IRisk} from "./module/IRisk.sol";
+import {ISetup} from "./module/ISetup.sol";
+
 import {IDistributionService} from "./service/IDistributionService.sol";
 import {IPoolService} from "./service/IPoolService.sol";
 import {IProductService} from "./service/IProductService.sol";
-import {VersionPart} from "../types/Version.sol";
-import {InstanceBase} from "./InstanceBase.sol";
+import {IPolicyService} from "./service/IPolicyService.sol";
+import {IBundleService} from "./service/IBundleService.sol";
+import {VersionPart, VersionPartLib} from "../types/Version.sol";
 
 contract Instance is
-    AccessManagedUpgradeable,
     IInstance,
-    // Initializable,
-    InstanceBase
+    AccessManagedUpgradeable,
+    Registerable,
+    KeyValueStore
 {
 
+    uint256 public constant GIF_MAJOR_VERSION = 3;
+
     uint64 public constant ADMIN_ROLE = type(uint64).min;
     uint64 public constant PUBLIC_ROLE = type(uint64).max;
     uint64 public constant CUSTOM_ROLE_ID_MIN = 10000;
@@ -48,152 +55,18 @@ contract Instance is
 
     bool private _initialized;
 
-    mapping(ShortString name => RoleId roleId) internal _role;
-    mapping(RoleId roleId => EnumerableSet.AddressSet roleMembers) internal _roleMembers; 
-    RoleId [] internal _roles;
-
-    mapping(ShortString name => address target) internal _target;
-
-    AccessManagerUpgradeable internal _accessManager;
+    InstanceAccessManager internal _accessManager;
     InstanceReader internal _instanceReader;
     BundleManager internal _bundleManager;
 
     function initialize(address accessManagerAddress, address registryAddress, NftId registryNftId, address initialOwner) 
         public 
-        initializer
+        initializer()
     {
-        require(!_initialized, "Contract instance has already been initialized");
-
         __AccessManaged_init(accessManagerAddress);
-                
-        _accessManager = AccessManagerUpgradeable(accessManagerAddress);
-        _createRole(RoleIdLib.toRoleId(ADMIN_ROLE), "AdminRole", false, false);
-        _createRole(RoleIdLib.toRoleId(PUBLIC_ROLE), "PublicRole", false, false);
-
-        _initializeRegisterable(registryAddress, registryNftId, INSTANCE(), false, initialOwner, "");
-
-        _registerInterface(type(IInstance).interfaceId);    
-        _initialized = true;
-    }
-
-    //--- Role ------------------------------------------------------//
-    function createStandardRole(RoleId roleId, string memory name) external restricted() {
-        _createRole(roleId, name, false, true);
-    }
-
-    function createCustomRole(RoleId roleId, string memory name) external restricted() {
-        _createRole(roleId, name, true, true);
-    }
-
-    function updateRole(RoleId roleId, string memory name, StateId newState) external restricted() {
-        (bool isCustom,) = _validateRoleParameters(roleId, name, false);
-        IAccess.RoleInfo memory role = _toRole(roleId, name, isCustom);
-        update(toRoleKey32(roleId), abi.encode(role), newState);
-    }
-
-    function updateRoleState(RoleId roleId, StateId newState) external restricted() {
-        updateState(toRoleKey32(roleId), newState);
-    }
-
-    function grantRole(RoleId roleId, address member) external restricted() returns (bool granted) {
-        Key32 roleKey = toRoleKey32(roleId);
-
-        if (!exists(roleKey)) {
-            revert IAccess.ErrorGrantNonexstentRole(roleId);
-        }
-
-        if (getState(roleKey) != ACTIVE()) {
-            revert IAccess.ErrorRoleIdNotActive(roleId);
-        }
-
-        if (!EnumerableSet.contains(_roleMembers[roleId], member)) {
-            _accessManager.grantRole(roleId.toInt(), member, EXECUTION_DELAY);
-            EnumerableSet.add(_roleMembers[roleId], member);
-            return true;
-        }
-
-        return false;
-    }
-
-    function revokeRole(RoleId roleId, address member) external restricted() returns (bool revoked) {
-        Key32 roleKey = toRoleKey32(roleId);
-
-        if (!exists(roleKey)) {
-            revert IAccess.ErrorRevokeNonexstentRole(roleId);
-        }
-
-        if (EnumerableSet.contains(_roleMembers[roleId], member)) {
-            _accessManager.revokeRole(roleId.toInt(), member);
-            EnumerableSet.remove(_roleMembers[roleId], member);
-            return true;
-        }
-
-        return false;
-    }
-
-    /// @dev not restricted function by intention
-    /// the restriction to role members is already enforced by the call to the access manger
-    function renounceRole(RoleId roleId) external returns (bool revoked) {
-        address member = msg.sender;
-        Key32 roleKey = toRoleKey32(roleId);
-
-        if (!exists(roleKey)) {
-            revert IAccess.ErrorRenounceNonexstentRole(roleId);
-        }
-
-        if (EnumerableSet.contains(_roleMembers[roleId], member)) {
-            _accessManager.renounceRole(roleId.toInt(), member);
-            EnumerableSet.remove(_roleMembers[roleId], member);
-            return true;
-        }
-
-        return false;
-    }
-
-    function roles() external view returns (uint256 numberOfRoles) {
-        return _roles.length;
-    }
-
-    function getRoleId(uint256 idx) external view returns (RoleId roleId) {
-        return _roles[idx];
-    }
-
-    function getRole(RoleId roleId) external view returns (IAccess.RoleInfo memory role) {
-        return abi.decode(getData(roleId.toKey32()), (IAccess.RoleInfo));
-    }
-
-    function roleMembers(RoleId roleId) external view returns (uint256 numberOfMembers) {
-        return EnumerableSet.length(_roleMembers[roleId]);
-    }
-
-    function getRoleMember(RoleId roleId, uint256 idx) external view returns (address roleMember) {
-        return EnumerableSet.at(_roleMembers[roleId], idx);
-    }
-
-    function _createRole(RoleId roleId, string memory name, bool isCustom, bool validateParameters) internal {
-        if (validateParameters) {
-            _validateRoleParameters(roleId, name, isCustom);
-        }
-
-        IAccess.RoleInfo memory role = _toRole(roleId, name, isCustom);
-        _role[role.name] = roleId;
-        _roles.push(roleId);
-
-        create(toRoleKey32(roleId), abi.encode(role));
-    }
-
-    //--- Target ------------------------------------------------------//
-    function createTarget(address target, IAccess.TargetInfo memory targetInfo) external restricted() {
-        _validateTargetParameters(target, targetInfo);
-        create(toTargetKey32(target), abi.encode(targetInfo));
-    }
-
-    function setTargetClosed(address target, bool closed) external restricted() {
-        if (!exists(toTargetKey32(target))) {
-            revert IAccess.ErrorTargetDoesNotExist(target);
-        }
-
-        _accessManager.setTargetClosed(target, closed);
+        
+        initializeRegisterable(registryAddress, registryNftId, INSTANCE(), false, initialOwner, "");
+        registerInterface(type(IInstance).interfaceId);    
     }
 
     //--- ProductSetup ------------------------------------------------------//
@@ -235,43 +108,43 @@ contract Instance is
         updateState(_toNftKey32(poolNftId, POOL()), newState);
     }
 
-    //--- DistributorType ---------------------------------------------------//
-    function createDistributorType(NftId policyNftId, NumberId payoutId, IPolicy.PayoutInfo memory payout) external restricted() {
-        create(toPolicyKey32(policyNftId), abi.encode(payout));
+    //--- DistributorType -------------------------------------------------------//
+    function createDistributorType(Key32 distributorKey, IDistribution.DistributorTypeInfo memory info) external restricted() {
+        create(distributorKey, abi.encode(info));
     }
 
-    function updateDistributorType(NftId policyNftId, NumberId payoutId, IPolicy.PayoutInfo memory payout, StateId newState) external restricted() {
-        update(toPolicyKey32(policyNftId), abi.encode(payout), newState);
+    function updateDistributorType(Key32 distributorKey, IDistribution.DistributorTypeInfo memory info, StateId newState) external restricted() {
+        update(distributorKey, abi.encode(info), newState);
     }
 
-    function updateDistributorTypeState(NftId policyNftId, StateId newState) external restricted() {
-        updateState(toPolicyKey32(policyNftId), newState);
+    function updateDistributorTypeState(Key32 distributorKey, StateId newState) external restricted() {
+        updateState(distributorKey, newState);
     }
 
     //--- Distributor -------------------------------------------------------//
-    function createDistributor(NftId policyNftId, NumberId payoutId, IPolicy.PayoutInfo memory payout) external restricted() {
-        create(toPolicyKey32(policyNftId), abi.encode(payout));
+    function createDistributor(NftId nftId, IDistribution.DistributorInfo memory info) external restricted() {
+        create(toDistributorKey32(nftId), abi.encode(info));
     }
 
-    function updateDistributor(NftId policyNftId, NumberId payoutId, IPolicy.PayoutInfo memory payout, StateId newState) external restricted() {
-        update(toPolicyKey32(policyNftId), abi.encode(payout), newState);
+    function updateDistributor(NftId nftId, IDistribution.DistributorInfo memory info, StateId newState) external restricted() {
+        update(toDistributorKey32(nftId), abi.encode(info), newState);
     }
 
-    function updateDistributorState(NftId policyNftId, StateId newState) external restricted() {
-        updateState(toPolicyKey32(policyNftId), newState);
+    function updateDistributorState(NftId nftId, StateId newState) external restricted() {
+        updateState(toDistributorKey32(nftId), newState);
     }
 
     //--- Referral ----------------------------------------------------------//
-    function createReferral(NftId policyNftId, NumberId payoutId, IPolicy.PayoutInfo memory payout) external restricted() {
-        create(toPolicyKey32(policyNftId), abi.encode(payout));
+    function createReferral(Key32 referralKey, IDistribution.ReferralInfo memory referralInfo) external restricted() {
+        create(referralKey, abi.encode(referralInfo));
     }
 
-    function updateReferral(NftId policyNftId, NumberId payoutId, IPolicy.PayoutInfo memory payout, StateId newState) external restricted() {
-        update(toPolicyKey32(policyNftId), abi.encode(payout), newState);
+    function updateReferral(Key32 referralKey, IDistribution.ReferralInfo memory referralInfo, StateId newState) external restricted() {
+        update(referralKey, abi.encode(referralInfo), newState);
     }
 
-    function updateReferralState(NftId policyNftId, StateId newState) external restricted() {
-        updateState(toPolicyKey32(policyNftId), newState);
+    function updateReferralState(Key32 referralKey, StateId newState) external restricted() {
+        updateState(referralKey, newState);
     }
 
     //--- Bundle ------------------------------------------------------------//
@@ -300,11 +173,20 @@ contract Instance is
         updateState(riskId.toKey32(), newState);
     }
 
-    //--- Policy ------------------------------------------------------------//
-    function createPolicy(NftId policyNftId, IPolicy.PolicyInfo memory policy) external restricted() {
-        create(toPolicyKey32(policyNftId), abi.encode(policy));
+    //--- Application (Policy) ----------------------------------------------//
+    function createApplication(NftId applicationNftId, IPolicy.PolicyInfo memory policy) external restricted() {
+        create(toPolicyKey32(applicationNftId), abi.encode(policy));
+    }
+
+    function updateApplication(NftId applicationNftId, IPolicy.PolicyInfo memory policy, StateId newState) external restricted() {
+        update(toPolicyKey32(applicationNftId), abi.encode(policy), newState);
+    }
+
+    function updateApplicationState(NftId applicationNftId, StateId newState) external restricted() {
+        updateState(toPolicyKey32(applicationNftId), newState);
     }
 
+    //--- Policy ------------------------------------------------------------//
     function updatePolicy(NftId policyNftId, IPolicy.PolicyInfo memory policy, StateId newState) external restricted() {
         update(toPolicyKey32(policyNftId), abi.encode(policy), newState);
     }
@@ -314,15 +196,15 @@ contract Instance is
     }
 
     //--- Claim -------------------------------------------------------------//
-    function createClaim(NftId policyNftId, NumberId claimId, IPolicy.ClaimInfo memory claim) external restricted() {
+    function createClaim(NftId policyNftId, ClaimId claimId, IPolicy.ClaimInfo memory claim) external restricted() {
         create(toPolicyKey32(policyNftId), abi.encode(claim));
     }
 
-    function updateClaim(NftId policyNftId, NumberId claimId, IPolicy.ClaimInfo memory claim, StateId newState) external restricted() {
+    function updateClaim(NftId policyNftId, ClaimId claimId, IPolicy.ClaimInfo memory claim, StateId newState) external restricted() {
         update(toPolicyKey32(policyNftId), abi.encode(claim), newState);
     }
 
-    function updateClaimState(NftId policyNftId, StateId newState) external restricted() {
+    function updateClaimState(NftId policyNftId, ClaimId claimId, StateId newState) external restricted() {
         updateState(toPolicyKey32(policyNftId), newState);
     }
 
@@ -331,7 +213,7 @@ contract Instance is
         create(toPolicyKey32(policyNftId), abi.encode(payout));
     }
 
-    function updateClaim(NftId policyNftId, NumberId payoutId, IPolicy.PayoutInfo memory payout, StateId newState) external restricted() {
+    function updatePayout(NftId policyNftId, NumberId payoutId, IPolicy.PayoutInfo memory payout, StateId newState) external restricted() {
         update(toPolicyKey32(policyNftId), abi.encode(payout), newState);
     }
 
@@ -340,71 +222,6 @@ contract Instance is
     }
 
     //--- internal view/pure functions --------------------------------------//
-    function _toRole(RoleId roleId, string memory name, bool isCustom)
-        internal
-        pure
-        returns (IAccess.RoleInfo memory role)
-    {
-        return IAccess.RoleInfo(
-            ShortStrings.toShortString(name), 
-            isCustom);
-    }
-
-    function _validateRoleParameters(
-        RoleId roleId, 
-        string memory name, 
-        bool isCustom
-    )
-        internal
-        view 
-        returns (
-            bool roleExists,
-            bool roleIsCustom
-        )
-    {
-        Key32 roleKey = toRoleKey32(roleId);
-        roleExists = exists(roleKey);
-        if (roleExists) {
-            roleIsCustom = abi.decode(getData(roleKey), (IAccess.RoleInfo)).isCustom;
-        } else {
-            roleIsCustom = isCustom;
-        }
-
-        // check role id
-        uint64 roleIdInt = RoleId.unwrap(roleId);
-        if(roleIdInt == ADMIN_ROLE || roleIdInt == PUBLIC_ROLE) {
-            revert IAccess.ErrorRoleIdInvalid(roleId); 
-        }
-
-        if (roleIsCustom && roleIdInt < CUSTOM_ROLE_ID_MIN) {
-            revert IAccess.ErrorRoleIdTooSmall(roleId); 
-        } else if (roleIsCustom && roleIdInt >= CUSTOM_ROLE_ID_MIN) {
-            revert IAccess.ErrorRoleIdTooBig(roleId); 
-        }
-
-        // role name checks
-        ShortString nameShort = ShortStrings.toShortString(name);
-        if (ShortStrings.byteLength(nameShort) == 0) {
-            revert IAccess.ErrorRoleNameEmpty(roleId);
-        }
-
-        if (_role[nameShort] != RoleIdLib.zero() && _role[nameShort] != roleId) {
-            revert IAccess.ErrorRoleNameNotUnique(_role[nameShort], nameShort);
-        }
-    }
-
-    function _validateTargetParameters(address target, IAccess.TargetInfo memory targetInfo) internal view {
-
-    }
-
-    function toRoleKey32(RoleId roleId) public pure returns (Key32) {
-        return roleId.toKey32();
-    }
-
-    function toTargetKey32(address target) public pure returns (Key32) {
-        return Key32Lib.toKey32(TARGET(), KeyId.wrap(bytes20(target)));
-    }
-
     function _toNftKey32(NftId nftId, ObjectType objectType) internal pure returns (Key32) {
         return nftId.toKey32(objectType);
     }
@@ -417,35 +234,54 @@ contract Instance is
         return policyNftId.toKey32(POLICY());
     }
 
-    function getComponentOwnerService() external view returns (IComponentOwnerService) {
-        return ComponentOwnerService(_registry.getServiceAddress("ComponentOwnerService", VersionPart.wrap(3)));
+    function toDistributionKey32(NftId distNftId) public pure returns (Key32) {
+        return distNftId.toKey32(DISTRIBUTION());
     }
 
+    function toDistributorTypeKey32(NftId distNftId) public pure returns (Key32) {
+        return distNftId.toKey32(DISTRIBUTOR_TYPE());
+    }
+
+    function toDistributorKey32(NftId distNftId) public pure returns (Key32) {
+        return distNftId.toKey32(DISTRIBUTOR());
+    }
+    
     function getDistributionService() external view returns (IDistributionService) {
-        return IDistributionService(_registry.getServiceAddress("DistributionService", VersionPart.wrap(3)));
+        return IDistributionService(getRegistry().getServiceAddress(DISTRIBUTION(), VersionPart.wrap(3)));
     }
 
     function getProductService() external view returns (IProductService) {
-        return IProductService(_registry.getServiceAddress("ProductService", VersionPart.wrap(3)));
+        return IProductService(getRegistry().getServiceAddress(PRODUCT(), VersionPart.wrap(3)));
     }
 
     function getPoolService() external view returns (IPoolService) {
-        return IPoolService(_registry.getServiceAddress("PoolService", VersionPart.wrap(3)));
+        return IPoolService(getRegistry().getServiceAddress(POOL(), VersionPart.wrap(3)));
+    }
+
+    function getPolicyService() external view returns (IPolicyService) {
+        return IPolicyService(getRegistry().getServiceAddress(POLICY(), VersionPart.wrap(3)));
+    }
+
+    function getBundleService() external view returns (IBundleService) {
+        return IBundleService(getRegistry().getServiceAddress(BUNDLE(), VersionPart.wrap(3)));
     }
 
     function setInstanceReader(InstanceReader instanceReader) external restricted() {
-        require(address(_instanceReader) == address(0), "InstanceReader is set");
-        require(instanceReader.getInstanceNftId() == getNftId(), "NFT ID of InstanceReader does not match");
+        require(instanceReader.getInstance() == Instance(this), "InstanceReader instance mismatch");
         _instanceReader = instanceReader;
     }
 
+    function getMajorVersion() external pure returns (VersionPart majorVersion) {
+        return VersionPartLib.toVersionPart(GIF_MAJOR_VERSION);
+    }
+
     function getInstanceReader() external view returns (InstanceReader) {
         return _instanceReader;
     }
     
     function setBundleManager(BundleManager bundleManager) external restricted() {
         require(address(_bundleManager) == address(0), "BundleManager is set");
-        require(bundleManager.getInstanceNftId() == getNftId(), "NFT ID of BundleManager does not match");
+        require(bundleManager.getInstance() == Instance(this), "BundleManager instance mismatch");
         _bundleManager = bundleManager;
     }