@etherisc/gif-next 0.0.2-7340474-070 → 0.0.2-742eda3-807

package/contracts/shared/ComponentService.sol

@@ -11,7 +11,7 @@ import {IInstance} from "../instance/IInstance.sol";
 import {IAccess} from "../instance/module/IAccess.sol";
 import {NftId} from "../type/NftId.sol";
 import {ObjectType, REGISTRY, COMPONENT, DISTRIBUTION, INSTANCE, ORACLE, POOL, PRODUCT} from "../type/ObjectType.sol";
-import {RoleId, DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE, POLICY_SERVICE_ROLE, PRODUCT_SERVICE_ROLE} from "../type/RoleId.sol";
+import {RoleId, DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE} from "../type/RoleId.sol";
 import {KEEP_STATE} from "../type/StateId.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IComponentService} from "./IComponentService.sol";
@@ -102,12 +102,6 @@ contract ComponentService is
         virtual
     {
         address contractAddress = msg.sender;
-        RoleId[] memory roles = new RoleId[](1);
-        bytes4[][] memory selectors = new bytes4[][](1);
-
-        // authorizaion for distribution owner
-        roles[0] = PRODUCT_OWNER_ROLE();
-        selectors[0] = _createSelectors(IProductComponent.setFees.selector);
 
         // register/create component setup
         (
@@ -117,9 +111,7 @@ contract ComponentService is
         ) = _register(
             contractAddress,
             PRODUCT(),
-            PRODUCT_OWNER_ROLE(),
-            roles,
-            selectors);
+            PRODUCT_OWNER_ROLE());
 
         // create product info
         IComponents.ProductInfo memory productInfo = IProductComponent(contractAddress).getInitialProductInfo();
@@ -193,24 +185,12 @@ contract ComponentService is
         virtual
     {
         address contractAddress = msg.sender;
-        RoleId[] memory roles = new RoleId[](2);
-        bytes4[][] memory selectors = new bytes4[][](2);
-
-        // authorizaion for distribution owner
-        roles[0] = DISTRIBUTION_OWNER_ROLE();
-        selectors[0] = _createSelectors(IDistributionComponent.setFees.selector);
-
-        // authorizaion for product service
-        roles[1] = PRODUCT_SERVICE_ROLE();
-        selectors[1] = _createSelectors(IDistributionComponent.processRenewal.selector);
 
         // register/create component info
         _register(
             contractAddress,
             DISTRIBUTION(),
-            DISTRIBUTION_OWNER_ROLE(),
-            roles,
-            selectors);
+            DISTRIBUTION_OWNER_ROLE());
     }
 
 
@@ -282,8 +262,6 @@ contract ComponentService is
         virtual
     {
         address contractAddress = msg.sender;
-        RoleId[] memory roles = new RoleId[](0);
-        bytes4[][] memory selectors = new bytes4[][](0);
 
         // register/create component setup
         (
@@ -293,9 +271,7 @@ contract ComponentService is
         ) = _register(
             contractAddress,
             ORACLE(),
-            ORACLE_OWNER_ROLE(),
-            roles,
-            selectors);            
+            ORACLE_OWNER_ROLE());            
     }
 
     //-------- pool ---------------------------------------------------------//
@@ -305,16 +281,6 @@ contract ComponentService is
         virtual
     {
         address contractAddress = msg.sender;
-        RoleId[] memory roles = new RoleId[](2);
-        bytes4[][] memory selectors = new bytes4[][](2);
-
-        // authorizaion for pool owner
-        roles[0] = POOL_OWNER_ROLE();
-        selectors[0] = _createSelectors(IPoolComponent.setFees.selector);
-
-        // authorizaion for product service
-        roles[1] = POLICY_SERVICE_ROLE();
-        selectors[1] = _createSelectors(IPoolComponent.verifyApplication.selector);
 
         // register/create component setup
         (
@@ -324,14 +290,13 @@ contract ComponentService is
         ) = _register(
             contractAddress,
             POOL(),
-            POOL_OWNER_ROLE(),
-            roles,
-            selectors);            
+            POOL_OWNER_ROLE());            
 
         // create info
         instanceStore.createPool(
             componentNftId, 
-            IPoolComponent(contractAddress).getInitialPoolInfo());
+            IPoolComponent(
+                contractAddress).getInitialPoolInfo());
     }
 
 
@@ -461,9 +426,7 @@ contract ComponentService is
     function _register(
         address componentAddress, // address of component to register
         ObjectType requiredType, // required type for component for registration
-        RoleId requiredRole, // role required for comonent owner for registration
-        RoleId[] memory roles, // roles with write access to component
-        bytes4[][] memory selectors // authorized functions per role with write access
+        RoleId requiredRole // role required for comonent owner for registration
     )
         internal
         virtual
@@ -490,21 +453,23 @@ contract ComponentService is
 
         component.linkToRegisteredNftId();
 
+        // setup initial component authorization
+        _instanceService.initializeAuthorization(
+            instance.getNftId(),
+            component);
+
         // save amended component info with instance
         instanceReader = instance.getInstanceReader();
         instanceStore = instance.getInstanceStore();
 
         IComponents.ComponentInfo memory componentInfo = component.getComponentInfo();
         componentInfo.tokenHandler = new TokenHandler(address(componentInfo.token));
-        instanceStore.createComponent(component.getNftId(), componentInfo);
-
-        // configure instance authorization
-        _instanceService.createComponentTarget(
-            instance.getNftId(), 
-            componentAddress, 
-            component.getName(), 
-            selectors, 
-            roles);
+
+        instanceStore.createComponent(
+            component.getNftId(), 
+            componentInfo);
+
+        // TODO add logging
     }
 
 
@@ -605,8 +570,7 @@ contract ComponentService is
         instance = _getInstance(info.parentNftId);
         owner = info.initialOwner;
 
-        (bool hasRole,) = instance.getInstanceAccessManager().hasRole(requiredRole.toInt(), owner);
-        if(!hasRole) {
+        if(!instance.getInstanceAdmin().hasRole(owner, requiredRole)) {
             revert ErrorComponentServiceExpectedRoleMissing(info.parentNftId, requiredRole, owner);
         }
     }

package/contracts/shared/ComponentVerifyingService.sol

@@ -87,7 +87,7 @@ abstract contract ComponentVerifyingService is
 
         // ensure component is not locked
         if (onlyActive) {
-            if (instance.getInstanceAccessManager().isTargetClosed(info.objectAddress)) {
+            if (instance.getInstanceAdmin().isTargetLocked(info.objectAddress)) {
                 revert ErrorComponentVerifyingServiceComponentIsLocked(componentNftId);
             }
         }

package/contracts/shared/IInstanceLinkedComponent.sol

@@ -5,6 +5,7 @@ import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessMana
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
 import {IComponent} from "../shared/IComponent.sol";
+import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IInstance} from "../instance/IInstance.sol";
 import {IInstanceService} from "../instance/IInstanceService.sol";
@@ -43,4 +44,7 @@ interface IInstanceLinkedComponent is
     /// this is only relevant for pool and distribution components
     function getProductNftId() external view returns (NftId productNftId);
 
+    /// @dev returns the initial component authorization specification.
+    function getAuthorization() external view returns (IAuthorization authorization);
+
 }

package/contracts/shared/IKeyValueStore.sol

@@ -13,6 +13,7 @@ interface IKeyValueStore is ILifecycle {
 
     error ErrorKeyValueStoreTypeUndefined(ObjectType objectType);
     error ErrorKeyValueStoreAlreadyCreated(Key32 key, ObjectType objectType);
+    error ErrorKeyValueStoreNoLifecycle(ObjectType objectType);
     error ErrorKeyValueStoreStateZero(Key32 key);
     error ErrorKeyValueStoreNotExisting(Key32 key);
 

package/contracts/shared/ILifecycle.sol

@@ -1,13 +1,12 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {NftId} from "../type/NftId.sol";
 import {ObjectType} from "../type/ObjectType.sol";
 import {StateId} from "../type/StateId.sol";
 
 interface ILifecycle {
 
-    error ErrorNoLifecycle(NftId nftId, ObjectType objectType);
+    error ErrorNoLifecycle(ObjectType objectType);
     error ErrorInvalidStateTransition(
         ObjectType objectType,
         StateId fromStateId,

package/contracts/shared/InstanceLinkedComponent.sol

@@ -9,10 +9,10 @@ import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol
 import {Component} from "./Component.sol";
 import {IComponentService} from "./IComponentService.sol";
 import {IInstanceLinkedComponent} from "./IInstanceLinkedComponent.sol";
+import {IAuthorization} from "../authorization/IAuthorization.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IInstanceService} from "../instance/IInstanceService.sol";
 import {IInstance} from "../instance/IInstance.sol";
-import {InstanceAdmin} from "../instance/InstanceAdmin.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {NftId} from "../type/NftId.sol";
@@ -35,6 +35,27 @@ abstract contract InstanceLinkedComponent is
     struct InstanceLinkedComponentStorage {
         IInstance _instance; // instance for this component
         InstanceReader _instanceReader; // instance reader for this component
+        IAuthorization _initialAuthorization;
+    }
+
+    function lock() external onlyOwner {
+        IInstanceService(_getServiceAddress(INSTANCE())).setComponentLocked(true);
+    }
+    
+    function unlock() external onlyOwner {
+        IInstanceService(_getServiceAddress(INSTANCE())).setComponentLocked(false);
+    }
+
+    function getInstance() public view override returns (IInstance instance) {
+        return _getInstanceLinkedComponentStorage()._instance;
+    }
+
+    function getProductNftId() public view override returns (NftId productNftId) {
+        return getComponentInfo().productNftId;
+    }
+
+    function getAuthorization() external view returns (IAuthorization authorization) {
+        return _getInstanceLinkedComponentStorage()._initialAuthorization;
     }
 
     function _getInstanceLinkedComponentStorage() private pure returns (InstanceLinkedComponentStorage storage $) {
@@ -43,18 +64,19 @@ abstract contract InstanceLinkedComponent is
         }
     }
 
-    function initializeInstanceLinkedComponent(
+    function _initializeInstanceLinkedComponent(
         address registry,
         NftId instanceNftId,
         string memory name,
         address token,
         ObjectType componentType,
+        IAuthorization authorization,
         bool isInterceptor,
         address initialOwner,
         bytes memory registryData, // writeonly data that will saved in the object info record of the registry
         bytes memory componentData // data that will saved with the component info in the instance store
     )
-        public
+        internal
         virtual
         onlyInitializing()
     {
@@ -82,6 +104,7 @@ abstract contract InstanceLinkedComponent is
 
         // set component state
         $._instanceReader = $._instance.getInstanceReader();
+        $._initialAuthorization = authorization;
 
         registerInterface(type(IAccessManaged).interfaceId);
         registerInterface(type(IInstanceLinkedComponent).interfaceId);
@@ -93,22 +116,6 @@ abstract contract InstanceLinkedComponent is
         IComponentService(_getServiceAddress(COMPONENT())).setWallet(newWallet);
     }
 
-    function lock() external onlyOwner {
-        IInstanceService(_getServiceAddress(INSTANCE())).setComponentLocked(true);
-    }
-    
-    function unlock() external onlyOwner {
-        IInstanceService(_getServiceAddress(INSTANCE())).setComponentLocked(false);
-    }
-
-    function getInstance() public view override returns (IInstance instance) {
-        return _getInstanceLinkedComponentStorage()._instance;
-    }
-
-    function getProductNftId() public view override returns (NftId productNftId) {
-        return getComponentInfo().productNftId;
-    }
-
 
     function _getComponentInfo() internal virtual override view returns (IComponents.ComponentInfo memory info) {
         NftId componentNftId = getRegistry().getNftId(address(this));

package/contracts/shared/KeyValueStore.sol

@@ -11,7 +11,7 @@ import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
 import {Lifecycle} from "./Lifecycle.sol";
 import {IKeyValueStore} from "./IKeyValueStore.sol";
 
-contract KeyValueStore is
+abstract contract KeyValueStore is
     Lifecycle, 
     IKeyValueStore
 {
@@ -34,8 +34,12 @@ contract KeyValueStore is
             revert ErrorKeyValueStoreAlreadyCreated(key32, objectType);
         }
 
+        if(!hasLifecycle(objectType)) {
+            revert ErrorKeyValueStoreNoLifecycle(objectType);
+        }
+
         Blocknumber blocknumber = blockBlocknumber();
-        StateId initialState = hasLifecycle(objectType) ? getInitialState(objectType) : ACTIVE();
+        StateId initialState = getInitialState(objectType);
 
         // set metadata
         metadata.objectType = objectType;

package/contracts/shared/Lifecycle.sol

@@ -1,15 +1,11 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
-
-import {NftId} from "../type/NftId.sol";
-import {ObjectType, COMPONENT, BUNDLE, POLICY, REQUEST, RISK, CLAIM, PAYOUT} from "../type/ObjectType.sol";
-import {StateId, ACTIVE, PAUSED, ARCHIVED, CLOSED, APPLIED, COLLATERALIZED, REVOKED, SUBMITTED, CONFIRMED, DECLINED, EXPECTED, PAID, FULFILLED, FAILED, CANCELLED} from "../type/StateId.sol";
+import {ObjectType} from "../type/ObjectType.sol";
+import {StateId, zeroStateId} from "../type/StateId.sol";
 import {ILifecycle} from "./ILifecycle.sol";
 
-contract Lifecycle is
-    Initializable,
+abstract contract Lifecycle is
     ILifecycle
 {
     mapping(ObjectType objectType => StateId initialState)
@@ -18,16 +14,17 @@ contract Lifecycle is
     mapping(ObjectType objectType => mapping(StateId stateFrom => mapping(StateId stateTo => bool isValid)))
         private _isValidTransition;
 
-    function initializeLifecycle()
-        public
-        onlyInitializing
-    {
-        _setupBundleLifecycle();
-        _setupComponentLifecycle();
-        _setupPolicyLifecycle();
-        _setupClaimAndPayoutLifecycle();
-        _setupRiskLifecycle();
-        _setupRequestLifecycle();
+    /// @dev child class must implement and CALL setup func at deployment/initializaton time
+    function _setupLifecycle() internal virtual;
+
+    function setInitialState(ObjectType ttype, StateId state) internal virtual {
+        assert(_initialState[ttype] == zeroStateId());
+        _initialState[ttype] = state;
+    }
+
+    function setStateTransition(ObjectType ttype, StateId oldState, StateId newState) internal virtual {
+        assert(_isValidTransition[ttype][oldState][newState] == false);
+        _isValidTransition[ttype][oldState][newState] = true;
     }
 
     function hasLifecycle(
@@ -59,9 +56,9 @@ contract Lifecycle is
         public
         view
     {
-        // return if no life cycle support
+        // revert if no life cycle support
         if (_initialState[objectType].eqz()) {
-            return;
+            revert ErrorNoLifecycle(objectType);
         }
 
         // enforce valid state transition
@@ -77,54 +74,4 @@ contract Lifecycle is
     ) public view returns (bool) {
         return _isValidTransition[objectType][fromId][toId];
     }
-
-    function _setupComponentLifecycle() internal {
-        _initialState[COMPONENT()] = ACTIVE();
-        _isValidTransition[COMPONENT()][ACTIVE()][PAUSED()] = true;
-        _isValidTransition[COMPONENT()][PAUSED()][ACTIVE()] = true;
-        _isValidTransition[COMPONENT()][PAUSED()][ARCHIVED()] = true;
-    }
-
-    function _setupBundleLifecycle() internal {
-        _initialState[BUNDLE()] = ACTIVE();
-        _isValidTransition[BUNDLE()][ACTIVE()][PAUSED()] = true;
-        _isValidTransition[BUNDLE()][ACTIVE()][CLOSED()] = true;
-        _isValidTransition[BUNDLE()][PAUSED()][ACTIVE()] = true;
-        _isValidTransition[BUNDLE()][PAUSED()][CLOSED()] = true;
-    }
-
-    function _setupPolicyLifecycle() internal {
-        _initialState[POLICY()] = APPLIED();
-        _isValidTransition[POLICY()][APPLIED()][REVOKED()] = true;
-        _isValidTransition[POLICY()][APPLIED()][DECLINED()] = true;
-        _isValidTransition[POLICY()][APPLIED()][COLLATERALIZED()] = true;
-        _isValidTransition[POLICY()][APPLIED()][ACTIVE()] = true;
-        _isValidTransition[POLICY()][COLLATERALIZED()][ACTIVE()] = true;
-        _isValidTransition[POLICY()][ACTIVE()][CLOSED()] = true;
-    }
-
-    function _setupClaimAndPayoutLifecycle() internal {
-        _initialState[CLAIM()] = SUBMITTED();
-        _isValidTransition[CLAIM()][SUBMITTED()][CONFIRMED()] = true;
-        _isValidTransition[CLAIM()][SUBMITTED()][DECLINED()] = true;
-        _isValidTransition[CLAIM()][CONFIRMED()][CLOSED()] = true;
-
-        _initialState[PAYOUT()] = EXPECTED();
-        _isValidTransition[PAYOUT()][EXPECTED()][PAID()] = true;
-    }
-
-    function _setupRiskLifecycle() internal {
-        _initialState[RISK()] = ACTIVE();
-        _isValidTransition[RISK()][ACTIVE()][PAUSED()] = true;
-        _isValidTransition[RISK()][PAUSED()][ACTIVE()] = true;
-        _isValidTransition[RISK()][PAUSED()][ARCHIVED()] = true;
-    }
-
-    function _setupRequestLifecycle() internal {
-        _initialState[REQUEST()] = ACTIVE();
-        _isValidTransition[REQUEST()][ACTIVE()][FULFILLED()] = true;
-        _isValidTransition[REQUEST()][ACTIVE()][FAILED()] = true;
-        _isValidTransition[REQUEST()][FAILED()][FULFILLED()] = true;
-        _isValidTransition[REQUEST()][ACTIVE()][CANCELLED()] = true;
-    }
 }

package/contracts/staking/StakingLifecycle.sol

@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {TARGET, COMPONENT, STAKE} from "../type/ObjectType.sol";
+import {INITIAL} from "../type/StateId.sol";
+import {Lifecycle} from "../shared/Lifecycle.sol";
+
+contract StakingLifecycle is
+    Lifecycle
+{
+    constructor() {
+        _setupLifecycle();
+    }
+
+    function _setupLifecycle()
+        internal
+        override
+    {
+        setInitialState(TARGET(), INITIAL());
+        setInitialState(COMPONENT(), INITIAL());
+        setInitialState(STAKE(), INITIAL());
+    }
+}

package/contracts/staking/StakingStore.sol

@@ -28,11 +28,13 @@ import {Version, VersionLib} from "../type/Version.sol";
 import {Versionable} from "../shared/Versionable.sol";
 
 import {RegistryAdmin} from "../registry/RegistryAdmin.sol";
+import {StakingLifecycle} from "./StakingLifecycle.sol";
 
 
 contract StakingStore is 
     AccessManaged,
-    KeyValueStore
+    KeyValueStore,
+    StakingLifecycle
 {
 
     event LogStakingStoreReserveBalanceIncreased(NftId targetNftId, Amount dipAmount, Amount reserveBalance, Blocknumber lastUpdatedIn);

package/contracts/type/ObjectType.sol

@@ -137,6 +137,8 @@ function neObjectType(ObjectType a, ObjectType b) pure returns (bool isSame) {
 // library functions that operate on user defined type
 library ObjectTypeLib {
 
+    error ErrorVersionTooBig(uint256 version);
+
     function zero() public pure returns (ObjectType) {
         return ObjectType.wrap(0);
     }
@@ -209,6 +211,38 @@ library ObjectTypeLib {
                     toInt(objectType))));
     }
 
+    function toVersionedName(
+        string memory name, 
+        string memory suffix, 
+        uint256 version
+    )
+        external
+        pure
+        returns (string memory versionedName)
+    {
+        if (version > maxNumReleases()) {
+            revert ErrorVersionTooBig(version);
+        }
+
+        string memory versionName = "_v0";
+
+        if (version >= 10) {
+            versionName = "_v";
+        }
+
+        versionedName = string(
+            abi.encodePacked(
+                name,
+                suffix,
+                versionName,
+                toString(version)));
+    }
+
+    /// @dev returns the max number of releases (major versions) this gif setup can handle.
+    function maxNumReleases() public pure returns (uint8) {
+        return 99;
+    }
+
     /// @dev returns the provied int as a string
     function toString(uint256 value) public pure returns (string memory name) {