@etherisc/gif-next 0.0.2-e5a2253-213 → 0.0.2-e69072e-892

package/contracts/instance/Instance.sol

@@ -1,42 +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 {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 {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, 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 {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 {NumberId} from "../types/NumberId.sol";
-import {ObjectType, BUNDLE, DISTRIBUTION, INSTANCE, POLICY, POOL, ROLE, PRODUCT, TARGET, COMPONENT} from "../types/ObjectType.sol";
-import {RiskId} from "../types/RiskId.sol";
-import {StateId} from "../types/StateId.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 {IPolicyService} from "./service/IPolicyService.sol";
 import {IBundleService} from "./service/IBundleService.sol";
-import {VersionPart} from "../types/Version.sol";
-import {InstanceBase} from "./InstanceBase.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;
@@ -51,18 +61,12 @@ contract Instance is
 
     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 = InstanceAccessManager(accessManagerAddress);
         
-        _initializeRegisterable(registryAddress, registryNftId, INSTANCE(), false, initialOwner, "");
-
-        _registerInterface(type(IInstance).interfaceId);    
-        _initialized = true;
+        initializeRegisterable(registryAddress, registryNftId, INSTANCE(), false, initialOwner, "");
+        registerInterface(type(IInstance).interfaceId);    
     }
 
     //--- ProductSetup ------------------------------------------------------//
@@ -104,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 ------------------------------------------------------------//
@@ -169,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);
     }
@@ -183,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);
     }
 
@@ -200,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);
     }
 
@@ -221,38 +234,54 @@ contract Instance is
         return policyNftId.toKey32(POLICY());
     }
 
+    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(DISTRIBUTION(), VersionPart.wrap(3)));
+        return IDistributionService(getRegistry().getServiceAddress(DISTRIBUTION(), VersionPart.wrap(3)));
     }
 
     function getProductService() external view returns (IProductService) {
-        return IProductService(_registry.getServiceAddress(PRODUCT(), VersionPart.wrap(3)));
+        return IProductService(getRegistry().getServiceAddress(PRODUCT(), VersionPart.wrap(3)));
     }
 
     function getPoolService() external view returns (IPoolService) {
-        return IPoolService(_registry.getServiceAddress(POOL(), VersionPart.wrap(3)));
+        return IPoolService(getRegistry().getServiceAddress(POOL(), VersionPart.wrap(3)));
     }
 
     function getPolicyService() external view returns (IPolicyService) {
-        return IPolicyService(_registry.getServiceAddress(POLICY(), VersionPart.wrap(3)));
+        return IPolicyService(getRegistry().getServiceAddress(POLICY(), VersionPart.wrap(3)));
     }
 
     function getBundleService() external view returns (IBundleService) {
-        return IBundleService(_registry.getServiceAddress(BUNDLE(), VersionPart.wrap(3)));
+        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");
         _bundleManager = bundleManager;
     }
 

package/contracts/instance/InstanceAccessManager.sol

@@ -1,11 +1,11 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {AccessManager} from "@openzeppelin/contracts/access/manager/AccessManager.sol";
+import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
 import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
 import {ShortString, ShortStrings} from "@openzeppelin/contracts/utils/ShortStrings.sol";
-import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
 
-import {AccessManagerUpgradeableInitializeable} from "../../contracts/instance/AccessManagerUpgradeableInitializeable.sol";
 import {RoleId, RoleIdLib } from "../types/RoleId.sol";
 import {TimestampLib} from "../types/Timestamp.sol";
 import {IAccess} from "./module/IAccess.sol";
@@ -32,14 +32,13 @@ contract InstanceAccessManager is
     mapping(ShortString name => address target) internal _targetForName;
     address [] internal _targets;
 
-    AccessManagerUpgradeableInitializeable internal _accessManager;
+    AccessManager internal _accessManager;
 
-    function __InstanceAccessManager_initialize(address initialAdmin) external initializer
+    function initialize(address initialAdmin) external initializer
     {
         // if size of the contract gets too large, this can be externalized which will reduce the contract size considerably
-        _accessManager = new AccessManagerUpgradeableInitializeable();
-        // this service required adin rights to access manager to be able to grant/revoke roles
-        _accessManager.__AccessManagerUpgradeableInitializeable_init(address(this));
+        _accessManager = new AccessManager(address(this));
+        // this service required admin rights to access manager to be able to grant/revoke roles
         _accessManager.grantRole(_accessManager.ADMIN_ROLE(), initialAdmin, 0);
 
         __AccessManaged_init(address(_accessManager));
@@ -59,7 +58,7 @@ contract InstanceAccessManager is
 
     function setRoleLocked(RoleId roleId, bool locked) external restricted() {
         if (!roleExists(roleId)) {
-            revert IAccess.ErrorIAccessSetLockedForNonexstentRole(roleId);
+            revert IAccess.ErrorIAccessRoleIdInvalid(roleId);
         }
 
         _role[roleId].isLocked = locked;
@@ -72,7 +71,7 @@ contract InstanceAccessManager is
 
     function grantRole(RoleId roleId, address member) external restricted() returns (bool granted) {
         if (!roleExists(roleId)) {
-            revert IAccess.ErrorIAccessGrantNonexstentRole(roleId);
+            revert IAccess.ErrorIAccessRoleIdInvalid(roleId);
         }
 
         if (_role[roleId].isLocked) {
@@ -162,7 +161,7 @@ contract InstanceAccessManager is
         address target = _targetForName[ShortStrings.toShortString(targetName)];
         
         if (target == address(0)) {
-            revert IAccess.ErrorIAccessSetLockedForNonexstentTarget(target);
+            revert IAccess.ErrorIAccessTargetDoesNotExist(ShortStrings.toShortString(targetName));
         }
 
         _target[target].isLocked = locked;
@@ -237,7 +236,7 @@ contract InstanceAccessManager is
         }
 
         if (_target[target].createdAt.gtz()) {
-            revert IAccess.ErrorIAccessTargetAlreadyExists(target, _target[target].name);
+            revert IAccess.ErrorIAccessTargetExists(target, _target[target].name);
         }
         if (_targetForName[ShortStrings.toShortString(name)] != address(0)) {
             revert IAccess.ErrorIAccessTargetNameExists(target, _targetForName[ShortStrings.toShortString(name)], ShortStrings.toShortString(name));
@@ -259,32 +258,27 @@ contract InstanceAccessManager is
         // TODO: implement
     }
 
-    function setTargetFunctionRole(
-        address target,
-        bytes4[] calldata selectors,
-        uint64 roleId
-    ) public virtual restricted() {
-        _accessManager.setTargetFunctionRole(target, selectors, roleId);
-    }
-
     function setTargetFunctionRole(
         string memory targetName,
         bytes4[] calldata selectors,
         RoleId roleId
     ) public virtual restricted() {
         address target = _targetForName[ShortStrings.toShortString(targetName)];
+        
+        if (target == address(0)) {
+            revert IAccess.ErrorIAccessTargetDoesNotExist(ShortStrings.toShortString(targetName));
+        }
+        if (! roleExists(roleId)) {
+            revert IAccess.ErrorIAccessRoleIdInvalid(roleId);
+        }
         uint64 roleIdInt = RoleId.unwrap(roleId);
         _accessManager.setTargetFunctionRole(target, selectors, roleIdInt);
     }
 
-    function getAccessManager() public restricted() returns (AccessManagerUpgradeableInitializeable) {
-        return _accessManager;
-    }
-
     function setTargetClosed(string memory targetName, bool closed) public restricted() {
         address target = _targetForName[ShortStrings.toShortString(targetName)];
         if (target == address(0)) {
-            revert IAccess.ErrorIAccessTargetAddressZero();
+            revert IAccess.ErrorIAccessTargetDoesNotExist(ShortStrings.toShortString(targetName));
         }
         _accessManager.setTargetClosed(target, closed);
     }

package/contracts/instance/InstanceReader.sol

@@ -31,39 +31,21 @@ contract InstanceReader {
     bool private _initialized;
 
     IRegistry internal _registry;
-    NftId internal _instanceNftId;
     IInstance internal _instance;
     IKeyValueStore internal _store;
 
-    constructor(
-        address registry, 
-        NftId instanceNftId
-    )
-    {
-        initialize(registry, instanceNftId);
-    }
-
-    function initialize(address registry, NftId instanceNftId) public {
+    function initialize(address registry, address instance) public {
         require(!_initialized, "ERROR:CRD-000:ALREADY_INITIALIZED");
 
         require(
             address(registry) != address(0),
             "ERROR:CRD-001:REGISTRY_ZERO");
 
-        require(
-            instanceNftId.gtz(),
-            "ERROR:CRD-002:NFT_ID_ZERO");
 
         _registry = IRegistry(registry);
-        _instanceNftId = instanceNftId;
-        IRegistry.ObjectInfo memory instanceInfo = _registry.getObjectInfo(_instanceNftId);
 
-        require(
-            instanceInfo.objectType == INSTANCE(), 
-            "ERROR:CRD-003:PARENT_NOT_INSTANCE");
-
-        _instance = IInstance(instanceInfo.objectAddress);
-        _store = IKeyValueStore(instanceInfo.objectAddress);
+        _instance = IInstance(instance);
+        _store = IKeyValueStore(instance);
 
         _initialized = true;
     }
@@ -301,10 +283,6 @@ contract InstanceReader {
         return _store;
     }
 
-    function getInstanceNftId() external view returns (NftId nftId) {
-        return _instanceNftId;
-    }
-
     function toUFixed(uint256 value, int8 exp) public pure returns (UFixed) {
         return UFixedLib.toUFixed(value, exp);
     }