@etherisc/gif-next 0.0.2-d02cb80-460 → 0.0.2-d086e6d-456

package/contracts/instance/IInstanceService.sol

@@ -8,8 +8,9 @@ import {IService} from "../shared/IService.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 
 import {IRegisterable} from "../shared/IRegisterable.sol";
-import {IBaseComponent} from "../components/IBaseComponent.sol";
+import {IComponent} from "../components/IComponent.sol";
 
+import {AccessManagerUpgradeableInitializeable} from "./AccessManagerUpgradeableInitializeable.sol";
 import {InstanceAccessManager} from "./InstanceAccessManager.sol";
 import {Instance} from "./Instance.sol";
 import {InstanceReader} from "./InstanceReader.sol";
@@ -17,26 +18,55 @@ import {BundleManager} from "./BundleManager.sol";
 
 interface IInstanceService is IService {
 
+    error ErrorInstanceServiceMasterInstanceAlreadySet();
+    error ErrorInstanceServiceMasterOzAccessManagerAlreadySet();
+    error ErrorInstanceServiceMasterInstanceAccessManagerAlreadySet();
+    error ErrorInstanceServiceMasterBundleManagerAlreadySet();
+    error ErrorInstanceServiceInstanceAddressZero();
+
+    error ErrorInstanceServiceMasterInstanceReaderNotSet();
+    error ErrorInstanceServiceInstanceReaderAddressZero();
+    error ErrorInstanceServiceInstanceReaderSameAsMasterInstanceReader();
+    error ErrorInstanceServiceInstanceReaderInstanceMismatch();
+
+    error ErrorInstanceServiceOzAccessManagerZero();
+    error ErrorInstanceServiceInstanceAccessManagerZero();
+    error ErrorInstanceServiceInstanceReaderZero();
+    error ErrorInstanceServiceBundleManagerZero();
+
+    error ErrorInstanceServiceInstanceAuthorityMismatch();
+    error ErrorInstanceServiceBundleManagerAuthorityMismatch();
+    error ErrorInstanceServiceInstanceReaderInstanceMismatch2();
+    error ErrorInstanceServiceBundleMangerInstanceMismatch();
+
     error ErrorInstanceServiceRequestUnauhorized(address caller);
     error ErrorInstanceServiceNotInstanceOwner(address caller, NftId instanceNftId);
-
-    event LogInstanceCloned(address clonedAccessManagerAddress, address clonedInstanceAddress, address clonedInstanceReaderAddress, NftId clonedInstanceNftId);
+    error ErrorInstanceServiceNotInstance(NftId nftId);
+    error ErrorInstanceServiceComponentNotRegistered(address componentAddress);
+    error ErrorInstanceServiceInstanceComponentMismatch(NftId instanceNftId, NftId componentNftId);
+    error ErrorInstanceServiceInvalidComponentType(address componentAddress, ObjectType expectedType, ObjectType componentType);
+    
+    event LogInstanceCloned(address clonedOzAccessManager, address clonedInstanceAccessManager, address clonedInstance, address clonedBundleManager, address clonedInstanceReader, NftId clonedInstanceNftId);
 
     function createInstanceClone()
         external 
         returns (
-            InstanceAccessManager clonedAccessManager, 
+            AccessManagerUpgradeableInitializeable clonedOzAccessManager,
+            InstanceAccessManager clonedInstanceAccessManager, 
             Instance clonedInstance,
             NftId instanceNftId,
             InstanceReader clonedInstanceReader,
             BundleManager clonedBundleManager
         );
 
-    function createRole(RoleId role, string memory name, NftId instanceNftId) external;
-
-    function grantRole(RoleId role, address member, NftId instanceNftId) external;
-
-    function hasRole(address account, RoleId role, address instanceAddress) external returns (bool);
+    function createGifTarget(
+        NftId instanceNftId,
+        address targetAddress,
+        string memory targetName,
+        bytes4[][] memory selectors,
+        RoleId[] memory roles
+    ) external;
 
+    function setComponentLocked(bool locked) external;
 }
 

package/contracts/instance/Instance.sol

@@ -1,48 +1,56 @@
 // 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 {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 {InstanceAccessManager} from "./InstanceAccessManager.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 {RoleId, RoleIdLib, INSTANCE_ROLE, INSTANCE_OWNER_ROLE} from "../types/RoleId.sol";
 import {StateId, ACTIVE} from "../types/StateId.sol";
 import {TimestampLib} from "../types/Timestamp.sol";
+import {VersionPart, VersionPartLib} 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 {IRegistry} from "../registry/IRegistry.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 {IComponents} from "./module/IComponents.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 {IPolicyService} from "./service/IPolicyService.sol";
 import {IBundleService} from "./service/IBundleService.sol";
-import {VersionPart} from "../types/Version.sol";
-import {InstanceBase} from "./InstanceBase.sol";
+import {TokenHandler} from "../shared/TokenHandler.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;
@@ -55,20 +63,24 @@ contract Instance is
     InstanceReader internal _instanceReader;
     BundleManager internal _bundleManager;
 
-    function initialize(address accessManagerAddress, address registryAddress, NftId registryNftId, address initialOwner) 
+    modifier onlyChainNft() {
+        if(msg.sender != getRegistry().getChainNftAddress()) {
+            revert();
+        }
+        _;
+    }
+
+    function initialize(address authority, address registryAddress, address initialOwner) 
         public 
-        initializer
+        initializer()
     {
-        require(!_initialized, "Contract instance has already been initialized");
-
-        __AccessManaged_init(accessManagerAddress);
-                
-        _accessManager = InstanceAccessManager(accessManagerAddress);
+        __AccessManaged_init(authority);
         
-        _initializeRegisterable(registryAddress, registryNftId, INSTANCE(), false, initialOwner, "");
+        IRegistry registry = IRegistry(registryAddress);
+        initializeRegisterable(registryAddress, registry.getNftId(), INSTANCE(), true, initialOwner, "");
+        initializeLifecycle();
 
-        _registerInterface(type(IInstance).interfaceId);    
-        _initialized = true;
+        registerInterface(type(IInstance).interfaceId);    
     }
 
     //--- ProductSetup ------------------------------------------------------//
@@ -98,55 +110,55 @@ contract Instance is
     }
 
     //--- PoolSetup ------------------------------------------------------//
-    function createPoolSetup(NftId poolNftId, ISetup.PoolSetupInfo memory setup) external restricted() {
-        create(_toNftKey32(poolNftId, POOL()), abi.encode(setup));
+    function createPoolSetup(NftId poolNftId, IComponents.ComponentInfo memory info) external restricted() {
+        create(_toNftKey32(poolNftId, POOL()), abi.encode(info));
     }
 
-    function updatePoolSetup(NftId poolNftId, ISetup.PoolSetupInfo memory setup, StateId newState) external restricted() {
-        update(_toNftKey32(poolNftId, POOL()), abi.encode(setup), newState);
+    function updatePoolSetup(NftId poolNftId, IComponents.ComponentInfo memory info, StateId newState) external restricted() {
+        update(_toNftKey32(poolNftId, POOL()), abi.encode(info), newState);
     }
 
     function updatePoolSetupState(NftId poolNftId, StateId newState) external restricted() {
         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 ------------------------------------------------------------//
@@ -175,11 +187,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);
     }
@@ -189,15 +210,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);
     }
 
@@ -206,7 +227,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);
     }
 
@@ -214,6 +235,17 @@ contract Instance is
         updateState(toPolicyKey32(policyNftId), newState);
     }
 
+    //--- ITransferInterceptor ------------------------------------------------------------//
+    function nftMint(address to, uint256 tokenId) external onlyChainNft {
+        assert(_accessManager.roleMembers(INSTANCE_OWNER_ROLE()) == 0);// temp
+        assert(_accessManager.grantRole(INSTANCE_OWNER_ROLE(), to) == true);
+    }
+
+    function nftTransferFrom(address from, address to, uint256 tokenId) external onlyChainNft {
+        assert(_accessManager.revokeRole(INSTANCE_OWNER_ROLE(), from) == true);
+        assert(_accessManager.grantRole(INSTANCE_OWNER_ROLE(), to) == true);
+    }
+
     //--- internal view/pure functions --------------------------------------//
     function _toNftKey32(NftId nftId, ObjectType objectType) internal pure returns (Key32) {
         return nftId.toKey32(objectType);
@@ -227,50 +259,69 @@ 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(_registry.getServiceAddress("PolicyService", VersionPart.wrap(3)));
+        return IPolicyService(getRegistry().getServiceAddress(POLICY(), VersionPart.wrap(3)));
     }
 
     function getBundleService() external view returns (IBundleService) {
-        return IBundleService(_registry.getServiceAddress("BundleService", VersionPart.wrap(3)));
-    }
-
-    function getInstanceAccessManager() external view returns (InstanceAccessManager) {
-        return _accessManager;
+        return IBundleService(getRegistry().getServiceAddress(BUNDLE(), VersionPart.wrap(3)));
     }
 
     function setInstanceReader(InstanceReader instanceReader) external restricted() {
-        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");
+        require(bundleManager.authority() == authority(), "BundleManager authority mismatch");
         _bundleManager = bundleManager;
     }
 
     function getBundleManager() external view returns (BundleManager) {
         return _bundleManager;
     }
+
+    function setInstanceAccessManager(InstanceAccessManager accessManager) external restricted {
+        require(address(_accessManager) == address(0), "InstanceAccessManager is set");
+        require(accessManager.authority() == authority(), "InstanceAccessManager authority mismatch");  
+        _accessManager = accessManager;      
+    }
+
+    function getInstanceAccessManager() external view returns (InstanceAccessManager) {
+        return _accessManager;
+    }
 }