@etherisc/gif-next 0.0.2-ce8407f-016 → 0.0.2-ce87da3-250

package/contracts/instance/InstanceAccessManager.sol

@@ -1,95 +1,54 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {EnumerableSet} from "@openzeppelin5/contracts/utils/structs/EnumerableSet.sol";
-import {ShortString, ShortStrings} from "@openzeppelin5/contracts/utils/ShortStrings.sol";
-
-import {AccessManagedSimple} from "./AccessManagedSimple.sol";
-import {AccessManagerSimple} from "./AccessManagerSimple.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 {NumberId} from "../types/NumberId.sol";
-import {ObjectType, BUNDLE, DISTRIBUTION, POLICY, POOL, ROLE, PRODUCT, TARGET} 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 {Timestamp, TimestampLib} from "../types/Timestamp.sol";
+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 {RoleId, RoleIdLib } from "../types/RoleId.sol";
+import {TimestampLib} from "../types/Timestamp.sol";
+import {IAccess} from "./module/IAccess.sol";
 
 contract InstanceAccessManager is
-    AccessManagedSimple
+    AccessManagedUpgradeable
 {
+    using RoleIdLib for RoleId;
+
     string public constant ADMIN_ROLE_NAME = "AdminRole";
     string public constant PUBLIC_ROLE_NAME = "PublicRole";
 
     uint64 public constant CUSTOM_ROLE_ID_MIN = 10000;
     uint32 public constant EXECUTION_DELAY = 0;
 
-    struct RoleInfo {
-        ShortString name;
-        bool isCustom;
-        bool isLocked;
-        Timestamp createdAt;
-        Timestamp updatedAt;
-    }
-
-    struct TargetInfo {
-        ShortString name;
-        bool isCustom;
-        bool isLocked;
-        Timestamp createdAt;
-        Timestamp updatedAt;
-    }
-
-    error ErrorRoleIdInvalid(RoleId roleId);
-    error ErrorRoleIdTooBig(RoleId roleId);
-    error ErrorRoleIdTooSmall(RoleId roleId);
-    error ErrorRoleIdAlreadyExists(RoleId roleId, ShortString name);
-    error ErrorRoleIdNotActive(RoleId roleId);
-    error ErrorRoleNameEmpty(RoleId roleId);
-    error ErrorRoleNameNotUnique(RoleId roleId, ShortString name);
-    error ErrorRoleInvalidUpdate(RoleId roleId, bool isCustom);
-    error ErrorRoleIsCustomIsImmutable(RoleId roleId, bool isCustom, bool isCustomExisting);
-    error ErrorSetLockedForNonexstentRole(RoleId roleId);
-    error ErrorGrantNonexstentRole(RoleId roleId);
-    error ErrorRevokeNonexstentRole(RoleId roleId);
-    error ErrorRenounceNonexstentRole(RoleId roleId);
-
-    error ErrorTargetAddressZero();
-    error ErrorTargetAlreadyExists(address target, ShortString name);
-    error ErrorTargetNameEmpty(address target);
-    error ErrorTargetNameExists(address target, address existingTarget, ShortString name);
-    error ErrorSetLockedForNonexstentTarget(address target);
-
     // role specific state
-    mapping(RoleId roleId => RoleInfo info) internal _role;
+    mapping(RoleId roleId => IAccess.RoleInfo info) internal _role;
     mapping(RoleId roleId => EnumerableSet.AddressSet roleMembers) internal _roleMembers; 
     mapping(ShortString name => RoleId roleId) internal _roleForName;
     RoleId [] internal _roles;
 
     // target specific state
-    mapping(address target => TargetInfo info) internal _target;
+    mapping(address target => IAccess.TargetInfo info) internal _target;
     mapping(ShortString name => address target) internal _targetForName;
     address [] internal _targets;
 
-    AccessManagerSimple internal _accessManager;
+    AccessManager internal _accessManager;
 
-    constructor(address accessManager)
-        AccessManagedSimple(accessManager)
+    function initialize(address initialAdmin) external initializer
     {
-        _accessManager = AccessManagerSimple(accessManager);
+        // if size of the contract gets too large, this can be externalized which will reduce the contract size considerably
+        _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));
 
         _createRole(RoleIdLib.toRoleId(_accessManager.ADMIN_ROLE()), ADMIN_ROLE_NAME, false, false);
         _createRole(RoleIdLib.toRoleId(_accessManager.PUBLIC_ROLE()), PUBLIC_ROLE_NAME, false, false);
     }
 
     //--- Role ------------------------------------------------------//
-
-    function createDefaultRole(RoleId roleId, string memory name) external restricted() {
+    function createGifRole(RoleId roleId, string memory name) external restricted() {
         _createRole(roleId, name, false, true);
     }
 
@@ -99,7 +58,7 @@ contract InstanceAccessManager is
 
     function setRoleLocked(RoleId roleId, bool locked) external restricted() {
         if (!roleExists(roleId)) {
-            revert ErrorSetLockedForNonexstentRole(roleId);
+            revert IAccess.ErrorIAccessRoleIdInvalid(roleId);
         }
 
         _role[roleId].isLocked = locked;
@@ -112,11 +71,11 @@ contract InstanceAccessManager is
 
     function grantRole(RoleId roleId, address member) external restricted() returns (bool granted) {
         if (!roleExists(roleId)) {
-            revert ErrorGrantNonexstentRole(roleId);
+            revert IAccess.ErrorIAccessRoleIdInvalid(roleId);
         }
 
         if (_role[roleId].isLocked) {
-            revert ErrorRoleIdNotActive(roleId);
+            revert IAccess.ErrorIAccessRoleIdNotActive(roleId);
         }
 
         if (!EnumerableSet.contains(_roleMembers[roleId], member)) {
@@ -130,7 +89,7 @@ contract InstanceAccessManager is
 
     function revokeRole(RoleId roleId, address member) external restricted() returns (bool revoked) {
         if (!roleExists(roleId)) {
-            revert ErrorRevokeNonexstentRole(roleId);
+            revert IAccess.ErrorIAccessRevokeNonexstentRole(roleId);
         }
 
         if (EnumerableSet.contains(_roleMembers[roleId], member)) {
@@ -148,7 +107,7 @@ contract InstanceAccessManager is
         address member = msg.sender;
 
         if (!roleExists(roleId)) {
-            revert ErrorRenounceNonexstentRole(roleId);
+            revert IAccess.ErrorIAccessRenounceNonexstentRole(roleId);
         }
 
         if (EnumerableSet.contains(_roleMembers[roleId], member)) {
@@ -173,7 +132,7 @@ contract InstanceAccessManager is
         return _roleForName[ShortStrings.toShortString(name)];
     }
 
-    function getRole(RoleId roleId) external view returns (RoleInfo memory role) {
+    function getRole(RoleId roleId) external view returns (IAccess.RoleInfo memory role) {
         return _role[roleId];
     }
 
@@ -190,13 +149,19 @@ contract InstanceAccessManager is
     }
 
     //--- Target ------------------------------------------------------//
+    function createGifTarget(address target, string memory name) external restricted() {
+        _createTarget(target, name, false, true);
+    }
+
     function createTarget(address target, string memory name) external restricted() {
         _createTarget(target, name, true, true);
     }
 
-    function setTargetLocked(address target, bool locked) external restricted() {
-        if (!targetExists(target)) {
-            revert ErrorSetLockedForNonexstentTarget(target);
+    function setTargetLocked(string memory targetName, bool locked) external restricted() {
+        address target = _targetForName[ShortStrings.toShortString(targetName)];
+        
+        if (target == address(0)) {
+            revert IAccess.ErrorIAccessTargetDoesNotExist(ShortStrings.toShortString(targetName));
         }
 
         _target[target].isLocked = locked;
@@ -214,7 +179,7 @@ contract InstanceAccessManager is
             _validateRoleParameters(roleId, name, isCustom);
         }
 
-        RoleInfo memory role = RoleInfo(
+        IAccess.RoleInfo memory role = IAccess.RoleInfo(
             ShortStrings.toShortString(name), 
             isCustom,
             false, // role un-locked,
@@ -233,35 +198,35 @@ contract InstanceAccessManager is
     )
         internal
         view 
-        returns (RoleInfo memory existingRole)
+        returns (IAccess.RoleInfo memory existingRole)
     {
         // check role id
         uint64 roleIdInt = RoleId.unwrap(roleId);
         if(roleIdInt == _accessManager.ADMIN_ROLE() || roleIdInt == _accessManager.PUBLIC_ROLE()) {
-            revert ErrorRoleIdInvalid(roleId); 
+            revert IAccess.ErrorIAccessRoleIdInvalid(roleId); 
         }
 
         // prevent changing isCustom for existing roles
         existingRole = _role[roleId];
 
         if (existingRole.createdAt.gtz() && isCustom != existingRole.isCustom) {
-            revert ErrorRoleIsCustomIsImmutable(roleId, isCustom, existingRole.isCustom); 
+            revert IAccess.ErrorIAccessRoleIsCustomIsImmutable(roleId, isCustom, existingRole.isCustom); 
         }
 
         if (isCustom && roleIdInt < CUSTOM_ROLE_ID_MIN) {
-            revert ErrorRoleIdTooSmall(roleId); 
+            revert IAccess.ErrorIAccessRoleIdTooSmall(roleId); 
         } else if (!isCustom && roleIdInt >= CUSTOM_ROLE_ID_MIN) {
-            revert ErrorRoleIdTooBig(roleId); 
+            revert IAccess.ErrorIAccessRoleIdTooBig(roleId); 
         }
 
         // role name checks
         ShortString nameShort = ShortStrings.toShortString(name);
         if (ShortStrings.byteLength(nameShort) == 0) {
-            revert ErrorRoleNameEmpty(roleId);
+            revert IAccess.ErrorIAccessRoleNameEmpty(roleId);
         }
 
         if (_roleForName[nameShort] != RoleIdLib.zero() && _roleForName[nameShort] != roleId) {
-            revert ErrorRoleNameNotUnique(_roleForName[nameShort], nameShort);
+            revert IAccess.ErrorIAccessRoleNameNotUnique(_roleForName[nameShort], nameShort);
         }
     }
 
@@ -270,7 +235,14 @@ contract InstanceAccessManager is
             _validateTargetParameters(target, name, isCustom);
         }
 
-        TargetInfo memory info = TargetInfo(
+        if (_target[target].createdAt.gtz()) {
+            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));
+        }
+
+        IAccess.TargetInfo memory info = IAccess.TargetInfo(
             ShortStrings.toShortString(name), 
             isCustom,
             _accessManager.isTargetClosed(target), // sync with state in access manager
@@ -283,6 +255,43 @@ contract InstanceAccessManager is
     }
 
     function _validateTargetParameters(address target, string memory name, bool isCustom) internal view {
+        // TODO: implement
+    }
+
+    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 setTargetClosed(string memory targetName, bool closed) public restricted() {
+        address target = _targetForName[ShortStrings.toShortString(targetName)];
+        if (target == address(0)) {
+            revert IAccess.ErrorIAccessTargetDoesNotExist(ShortStrings.toShortString(targetName));
+        }
+        _accessManager.setTargetClosed(target, closed);
+    }
+
+    function isTargetLocked(address target) public view returns (bool locked) {
+        return _accessManager.isTargetClosed(target);
+    }
 
+    function canCall(
+        address caller,
+        address target,
+        bytes4 selector
+    ) public view virtual returns (bool immediate, uint32 delay) {
+        return _accessManager.canCall(caller, target, selector);
     }
 }

package/contracts/instance/InstanceReader.sol

@@ -1,61 +1,56 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IERC20Metadata} from "@openzeppelin5/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {DistributorType} from "../types/DistributorType.sol";
 import {Fee, FeeLib} from "../types/Fee.sol";
 import {Key32} from "../types/Key32.sol";
 import {NftId} from "../types/NftId.sol";
-import {ObjectType, DISTRIBUTOR, INSTANCE, PRODUCT, POLICY, TREASURY} from "../types/ObjectType.sol";
+import {ObjectType, DISTRIBUTOR, DISTRIBUTION, INSTANCE, PRODUCT, POLICY, POOL, TREASURY, BUNDLE} from "../types/ObjectType.sol";
 import {ReferralId, ReferralStatus, ReferralLib, REFERRAL_OK, REFERRAL_ERROR_UNKNOWN, REFERRAL_ERROR_EXPIRED, REFERRAL_ERROR_EXHAUSTED} from "../types/Referral.sol";
 import {Registerable} from "../shared/Registerable.sol";
 import {RiskId} from "../types/RiskId.sol";
-import {UFixed, UFixedMathLib} from "../types/UFixed.sol";
+import {UFixed, MathLib, UFixedLib} from "../types/UFixed.sol";
 import {Version} from "../types/Version.sol";
+import {StateId} from "../types/StateId.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
+import {IBundle} from "../instance/module/IBundle.sol";
 import {IDistribution} from "../instance/module/IDistribution.sol";
 import {IInstance} from "./IInstance.sol";
 import {IKeyValueStore} from "../instance/base/IKeyValueStore.sol";
 import {IPolicy} from "../instance/module/IPolicy.sol";
 import {IRisk} from "../instance/module/IRisk.sol";
+import {ISetup} from "../instance/module/ISetup.sol";
 import {ITreasury} from "../instance/module/ITreasury.sol";
 import {TimestampLib} from "../types/Timestamp.sol";
 
 
 contract InstanceReader {
+    bool private _initialized;
 
     IRegistry internal _registry;
-    NftId internal _instanceNftId;
     IInstance internal _instance;
     IKeyValueStore internal _store;
 
-    constructor(
-        address registry, 
-        NftId instanceNftId
-    )
-    {
+    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(instance);
+        _store = IKeyValueStore(instance);
 
-        _instance = IInstance(instanceInfo.objectAddress);
-        _store = IKeyValueStore(instanceInfo.objectAddress);
+        _initialized = true;
     }
 
+
     // module specific functions
 
     function getPolicyInfo(NftId policyNftId)
@@ -69,6 +64,14 @@ contract InstanceReader {
         }
     }
 
+    function getPolicyState(NftId policyNftId)
+        public
+        view
+        returns (StateId state)
+    {
+        return _instance.getState(toPolicyKey(policyNftId));
+    }
+
     function getRiskInfo(RiskId riskId)
         public 
         view 
@@ -103,6 +106,17 @@ contract InstanceReader {
             return abi.decode(data, (ITreasury.TreasuryInfo));
         }
     }
+    
+    function getBundleInfo(NftId bundleNftId)
+        public 
+        view 
+        returns (IBundle.BundleInfo memory info)
+    {
+        bytes memory data = _store.getData(toBundleKey(bundleNftId));
+        if (data.length > 0) {
+            return abi.decode(data, (IBundle.BundleInfo));
+        }
+    }
 
     function getDistributorTypeInfo(DistributorType distributorType)
         public 
@@ -126,6 +140,38 @@ contract InstanceReader {
         }
     }
 
+    function getDistributionSetupInfo(NftId distributionNftId)
+        public
+        view
+        returns (ISetup.DistributionSetupInfo memory info)
+    {
+        bytes memory data = _store.getData(toDistributionKey(distributionNftId));
+        if (data.length > 0) {
+            return abi.decode(data, (ISetup.DistributionSetupInfo));
+        }
+    }
+
+    function getPoolSetupInfo(NftId poolNftId)
+        public
+        view
+        returns (ISetup.PoolSetupInfo memory info)
+    {
+        bytes memory data = _store.getData(toPoolKey(poolNftId));
+        if (data.length > 0) {
+            return abi.decode(data, (ISetup.PoolSetupInfo));
+        }
+    }
+
+    function getProductSetupInfo(NftId productNftId)
+        public
+        view
+        returns (ISetup.ProductSetupInfo memory info)
+    {
+        bytes memory data = _store.getData(toProductKey(productNftId));
+        if (data.length > 0) {
+            return abi.decode(data, (ISetup.ProductSetupInfo));
+        }
+    }
 
     function getReferralInfo(ReferralId referralId)
         public 
@@ -175,19 +221,19 @@ contract InstanceReader {
 
         if (info.expiryAt.eqz()) {
             return (
-                UFixedMathLib.zero(),
+                UFixedLib.zero(),
                 REFERRAL_ERROR_UNKNOWN());
         }
 
         if (info.expiryAt < TimestampLib.blockTimestamp()) {
             return (
-                UFixedMathLib.zero(),
+                UFixedLib.zero(),
                 REFERRAL_ERROR_EXPIRED());
         }
 
         if (info.usedReferrals >= info.maxReferrals) {
             return (
-                UFixedMathLib.zero(),
+                UFixedLib.zero(),
                 REFERRAL_ERROR_EXHAUSTED());
         }
 
@@ -212,6 +258,22 @@ contract InstanceReader {
         return distributorNftId.toKey32(DISTRIBUTOR());
     }
 
+    function toDistributionKey(NftId distributionNftId) public pure returns (Key32) { 
+        return distributionNftId.toKey32(DISTRIBUTION());
+    }
+
+    function toBundleKey(NftId poolNftId) public pure returns (Key32) { 
+        return poolNftId.toKey32(BUNDLE());
+    }
+
+    function toPoolKey(NftId poolNftId) public pure returns (Key32) { 
+        return poolNftId.toKey32(POOL());
+    }
+
+    function toProductKey(NftId productNftId) public pure returns (Key32) { 
+        return productNftId.toKey32(PRODUCT());
+    }
+
     // low level function
     function getInstance() external view returns (IInstance instance) {
         return _instance;
@@ -221,15 +283,11 @@ contract InstanceReader {
         return _store;
     }
 
-    function getInstanceNftId() external view returns (NftId nftId) {
-        return _instanceNftId;
-    }
-
     function toUFixed(uint256 value, int8 exp) public pure returns (UFixed) {
-        return UFixedMathLib.toUFixed(value, exp);
+        return UFixedLib.toUFixed(value, exp);
     }
 
     function toInt(UFixed value) public pure returns (uint256) {
-        return UFixedMathLib.toInt(value);
+        return UFixedLib.toInt(value);
     }
 }