@etherisc/gif-next 0.0.2-efdb520-159 → 0.0.2-efef0ea-320

package/contracts/instance/{InstanceBase.sol → base/InstanceBase.sol}

@@ -1,28 +1,35 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {Versionable} from "../shared/Versionable.sol";
-import {Registerable} from "../shared/Registerable.sol";
-// import {IRegistry} from "../registry/IRegistry.sol";
+import {Versionable} from "../../shared/Versionable.sol";
+import {Registerable} from "../../shared/Registerable.sol";
 
-// import {IInstance} from "./IInstance.sol";
-import {ObjectType, INSTANCE} from "../types/ObjectType.sol";
-import {NftId} from "../types/NftId.sol";
-import {Version, VersionPart, toVersion, toVersionPart} from "../types/Version.sol";
+import {ObjectType, INSTANCE} from "../../types/ObjectType.sol";
+import {Key32} from "../../types/Key32.sol";
+import {NftId} from "../../types/NftId.sol";
+import {StateId} from "../../types/StateId.sol";
+import {Version, VersionPart, VersionLib} from "../../types/Version.sol";
 
-import {IComponentOwnerService} from "./service/IComponentOwnerService.sol";
-import {IProductService} from "./service/IProductService.sol";
-import {IPoolService} from "./service/IPoolService.sol";
+import {IComponentOwnerService} from "../service/IComponentOwnerService.sol";
+import {IDistributionService} from "../service/IDistributionService.sol";
+import {IProductService} from "../service/IProductService.sol";
+import {IPoolService} from "../service/IPoolService.sol";
 
-import {IServiceLinked} from "./IServiceLinked.sol";
-import {IInstance} from "./IInstance.sol";
+import {IKeyValueStore} from "./IKeyValueStore.sol";
+import {IInstance} from "../IInstance.sol";
+import {IInstanceBase} from "./IInstanceBase.sol";
+
+import {KeyValueStore} from "./KeyValueStore.sol";
 
 abstract contract InstanceBase is
     Versionable,
     Registerable,
-    IServiceLinked
+    IInstanceBase
 {
+    IKeyValueStore internal _keyValueStore;
+
     IComponentOwnerService internal _componentOwnerService;
+    IDistributionService internal _distributionService;
     IProductService internal _productService;
     IPoolService internal _poolService;
 
@@ -33,10 +40,22 @@ abstract contract InstanceBase is
         Registerable(registry, registryNftId)
         Versionable()
     {
+        _keyValueStore = new KeyValueStore();
+
         _registerInterface(type(IInstance).interfaceId);
         _linkToServicesInRegistry();
     }
 
+    function getKeyValueStore() public view virtual override returns (IKeyValueStore keyValueStore) { return _keyValueStore; }
+
+    function updateState(Key32 key, StateId state) external override {
+        _keyValueStore.updateState(key, state);
+    }
+
+    function getState(Key32 key) external view override returns (StateId state) {
+        return _keyValueStore.getState(key);
+    }
+
     // from versionable
     function getVersion()
         public 
@@ -44,10 +63,7 @@ abstract contract InstanceBase is
         virtual override
         returns(Version)
     {
-        return toVersion(
-            toVersionPart(3),
-            toVersionPart(0),
-            toVersionPart(0));
+        return VersionLib.toVersion(3,0,0);
     }
 
     // from registerable
@@ -60,6 +76,7 @@ abstract contract InstanceBase is
     function _linkToServicesInRegistry() internal {
         VersionPart majorVersion = getVersion().toMajorPart();
         _componentOwnerService = IComponentOwnerService(_getAndCheck("ComponentOwnerService", majorVersion));
+        _distributionService = IDistributionService(_getAndCheck("DistributionService", majorVersion));
         _productService = IProductService(_getAndCheck("ProductService", majorVersion));
         _poolService = IPoolService(_getAndCheck("PoolService", majorVersion));
     }

package/contracts/instance/base/KeyValueStore.sol

@@ -0,0 +1,161 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {Blocknumber, blockBlocknumber, zeroBlocknumber} from "../../types/Blocknumber.sol";
+import {Key32, KeyId, Key32Lib} from "../../types/Key32.sol";
+import {NftId} from "../../types/NftId.sol";
+import {ObjectType} from "../../types/ObjectType.sol";
+import {StateId, ACTIVE} from "../../types/StateId.sol";
+import {Timestamp, blockTimestamp, zeroTimestamp} from "../../types/Timestamp.sol";
+
+import {Lifecycle} from "./Lifecycle.sol";
+import {IKeyValueStore} from "./IKeyValueStore.sol";
+
+contract KeyValueStore is Lifecycle, IKeyValueStore {
+
+    mapping(Key32 key32 => Value value) private _value;
+    address private _owner;
+
+    modifier onlyOwner() {
+        require(
+            msg.sender == _owner,
+            "ERROR:KVS-001:NOT_OWNER");
+        _;
+    }
+
+    constructor() {
+        _owner = msg.sender;
+    }
+
+    function create(
+        Key32 key32, 
+        ObjectType objectType, 
+        bytes memory data
+    )
+        public
+        onlyOwner
+    {
+        require(objectType.gtz(), "ERROR:KVS-010:TYPE_UNDEFINED");
+
+        Metadata storage metadata = _value[key32].metadata;
+        require(metadata.state.eqz(), "ERROR:KVS-012:ALREADY_CREATED");
+
+        address createdBy = msg.sender;
+        Blocknumber blocknumber = blockBlocknumber();
+        StateId initialState = hasLifecycle(objectType) ? getInitialState(objectType) : ACTIVE();
+
+        // set metadata
+        metadata.objectType = objectType;
+        metadata.state = initialState;
+        metadata.updatedBy = createdBy;
+        metadata.updatedIn = blocknumber;
+        metadata.createdIn = blocknumber;
+
+        // set data
+        _value[key32].data = data;
+
+        // solhint-disable-next-line avoid-tx-origin
+        emit LogInfoCreated(toKey(key32), initialState, createdBy, tx.origin);
+    }
+
+    function update(Key32 key32, StateId state, bytes memory data) 
+        public
+        onlyOwner
+    {
+        require(state.gtz(), "ERROR:KVS-020:STATE_UNDEFINED");
+        Metadata storage metadata = _value[key32].metadata;
+        StateId stateOld = metadata.state;
+        require(stateOld.gtz(), "ERROR:KVS-021:NOT_EXISTING");
+
+        // update data
+        _value[key32].data = data;
+
+        // update metadata (and state)
+        address updatedBy = msg.sender;
+        Blocknumber lastUpdatedIn = metadata.updatedIn;
+        metadata.state = state;
+        metadata.updatedBy = updatedBy;
+        metadata.updatedIn = blockBlocknumber();
+
+        // create log entries
+        Key memory key = toKey(key32);
+        // solhint-disable-next-line avoid-tx-origin
+        emit LogStateUpdated(key, state, stateOld, updatedBy, tx.origin, lastUpdatedIn);
+        // solhint-disable-next-line avoid-tx-origin
+        emit LogInfoUpdated(key, state, updatedBy, tx.origin, lastUpdatedIn);
+    }
+
+    function updateData(Key32 key32, bytes memory data) 
+        public
+        onlyOwner
+    {
+        Metadata storage metadata = _value[key32].metadata;
+        StateId state = metadata.state;
+        require(state.gtz(), "ERROR:KVS-030:NOT_EXISTING");
+
+        // update data
+        _value[key32].data = data;
+
+        // update metadata
+        address updatedBy = msg.sender;
+        Blocknumber lastUpdatedIn = metadata.updatedIn;
+        metadata.updatedBy = updatedBy;
+        metadata.updatedIn = blockBlocknumber();
+
+        // create log entry
+        Key memory key = toKey(key32);
+        // solhint-disable-next-line avoid-tx-origin
+        emit LogInfoUpdated(key, state, updatedBy, tx.origin, lastUpdatedIn);
+    }
+
+    function updateState(Key32 key32, StateId state)
+        public
+        onlyOwner
+    {
+        require(state.gtz(), "ERROR:KVS-040:STATE_UNDEFINED");
+        Metadata storage metadata = _value[key32].metadata;
+        StateId stateOld = metadata.state;
+        require(stateOld.gtz(), "ERROR:KVS-041:NOT_EXISTING");
+
+        // update metadata (and state)
+        address updatedBy = msg.sender;
+        Blocknumber lastUpdatedIn = metadata.updatedIn;
+        metadata.state = state;
+        metadata.updatedBy = updatedBy;
+        metadata.updatedIn = blockBlocknumber();
+
+        // create log entry
+        Key memory key = toKey(key32);
+        // solhint-disable-next-line avoid-tx-origin
+        emit LogStateUpdated(key, state, stateOld, updatedBy, tx.origin, lastUpdatedIn);
+    }
+
+    function exists(Key32 key32) public view returns (bool) {
+        return _value[key32].metadata.state.gtz();
+    }
+
+    function get(Key32 key32) public view returns (Value memory value) {
+        return _value[key32];
+    }
+
+    function getMetadata(Key32 key32) public view returns (Metadata memory metadata) {
+        return _value[key32].metadata;
+    }
+
+    function getData(Key32 key32) public view returns (bytes memory data) {
+        return _value[key32].data;
+    }
+
+    function getState(Key32 key32) public view returns (StateId state) {
+        return _value[key32].metadata.state;
+    }
+
+    function toKey32(ObjectType objectType, KeyId id) external pure override returns(Key32) {
+        return Key32Lib.toKey32(objectType, id);
+    }
+
+    function toKey(Key32 key32) public pure override returns (Key memory key) {
+        (ObjectType objectType, KeyId id) = key32.toKey();
+        return Key(objectType, id);
+    }
+}

package/contracts/instance/{module/lifecycle/LifecycleModule.sol → base/Lifecycle.sol}

@@ -1,12 +1,12 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {NftId} from "../../../types/NftId.sol";
-import {ObjectType, PRODUCT, ORACLE, POOL, BUNDLE, POLICY} from "../../../types/ObjectType.sol";
-import {StateId, ACTIVE, PAUSED, ARCHIVED, CLOSED, APPLIED, UNDERWRITTEN, REVOKED, DECLINED} from "../../../types/StateId.sol";
-import {ILifecycleModule} from "./ILifecycle.sol";
+import {NftId} from "../../types/NftId.sol";
+import {ObjectType, COMPONENT, BUNDLE, POLICY, RISK} from "../../types/ObjectType.sol";
+import {StateId, ACTIVE, PAUSED, ARCHIVED, CLOSED, APPLIED, UNDERWRITTEN, REVOKED, DECLINED} from "../../types/StateId.sol";
+import {ILifecycle} from "./ILifecycle.sol";
 
-contract LifecycleModule is ILifecycleModule {
+contract Lifecycle is ILifecycle {
     mapping(ObjectType objectType => StateId initialState)
         private _initialState;
 
@@ -14,46 +14,50 @@ contract LifecycleModule is ILifecycleModule {
         private _isValidTransition;
 
     constructor() {
-        _setupComponentLifecycle(PRODUCT());
-        _setupComponentLifecycle(ORACLE());
-        _setupComponentLifecycle(POOL());
-
         _setupBundleLifecycle();
+        _setupComponentLifecycle();
         _setupPolicyLifecycle();
+        _setupRiskLifecycle();
+    }
+
+    function hasLifecycle(
+        ObjectType objectType
+    )
+        public
+        view
+        override
+        returns (bool)
+    {
+        return _initialState[objectType].gtz();
+    }
+
+    function getInitialState(
+        ObjectType objectType
+    )
+        public
+        view
+        returns (StateId)
+    {
+        return _initialState[objectType];
     }
 
-    function checkAndLogTransition(
-        NftId nftId,
+    function checkTransition(
         ObjectType objectType,
         StateId fromId,
         StateId toId
-    ) public returns (StateId) // add only currentcontract? would that work?
+    )
+        public
+        view
     {
-        if (!_isValidTransition[objectType][fromId][toId]) {
-            revert ErrorInvalidStateTransition(nftId, objectType, fromId, toId);
+        // return if no life cycle support
+        if (_initialState[objectType].eqz()) {
+            return;
         }
 
-        if (objectType == POLICY()) {
-            emit LogPolicyStateChanged(nftId, fromId, toId);
-        } else if (objectType == BUNDLE()) {
-            emit LogBundleStateChanged(nftId, fromId, toId);
-        } else if (
-            objectType == PRODUCT() ||
-            objectType == ORACLE() ||
-            objectType == POOL()
-        ) {
-            emit LogComponentStateChanged(nftId, objectType, fromId, toId);
-        } else {
-            revert ErrorNoLifecycle(nftId, objectType);
+        // enforce valid state transition
+        if (!_isValidTransition[objectType][fromId][toId]) {
+            revert ErrorInvalidStateTransition(objectType, fromId, toId);
         }
-
-        return toId;
-    }
-
-    function getInitialState(
-        ObjectType objectType
-    ) public view returns (StateId) {
-        return _initialState[objectType];
     }
 
     function isValidTransition(
@@ -64,11 +68,11 @@ contract LifecycleModule is ILifecycleModule {
         return _isValidTransition[objectType][fromId][toId];
     }
 
-    function _setupComponentLifecycle(ObjectType objectType) internal {
-        _initialState[objectType] = ACTIVE();
-        _isValidTransition[objectType][ACTIVE()][PAUSED()] = true;
-        _isValidTransition[objectType][PAUSED()][ACTIVE()] = true;
-        _isValidTransition[objectType][PAUSED()][ARCHIVED()] = true;
+    function _setupComponentLifecycle() internal {
+        _initialState[COMPONENT()] = ACTIVE();
+        _isValidTransition[COMPONENT()][ACTIVE()][PAUSED()] = true;
+        _isValidTransition[COMPONENT()][PAUSED()][ACTIVE()] = true;
+        _isValidTransition[COMPONENT()][PAUSED()][ARCHIVED()] = true;
     }
 
     function _setupBundleLifecycle() internal {
@@ -86,4 +90,11 @@ contract LifecycleModule is ILifecycleModule {
         _isValidTransition[POLICY()][UNDERWRITTEN()][ACTIVE()] = true;
         _isValidTransition[POLICY()][ACTIVE()][CLOSED()] = true;
     }
+
+    function _setupRiskLifecycle() internal {
+        _initialState[RISK()] = ACTIVE();
+        _isValidTransition[RISK()][ACTIVE()][PAUSED()] = true;
+        _isValidTransition[RISK()][PAUSED()][ACTIVE()] = true;
+        _isValidTransition[RISK()][PAUSED()][ARCHIVED()] = true;
+    }
 }

package/contracts/instance/base/ModuleBase.sol

@@ -0,0 +1,57 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IRegistry} from "../../registry/IRegistry.sol";
+
+import {Blocknumber, blockNumber} from "../../types/Blocknumber.sol";
+import {Key32, KeyId} from "../../types/Key32.sol";
+import {LibNftIdSet} from "../../types/NftIdSet.sol";
+import {NftId} from "../../types/NftId.sol";
+import {ObjectType, PRODUCT, ORACLE, POOL, BUNDLE, POLICY} from "../../types/ObjectType.sol";
+import {StateId, ACTIVE, PAUSED, ARCHIVED, CLOSED, APPLIED, REVOKED, DECLINED} from "../../types/StateId.sol";
+import {Timestamp, blockTimestamp, zeroTimestamp} from "../../types/Timestamp.sol";
+
+import {IKeyValueStore} from "./IKeyValueStore.sol";
+
+abstract contract ModuleBase {
+
+    IKeyValueStore private _store;
+
+    function _initialize(IKeyValueStore keyValueStore) internal {
+        _store = keyValueStore;
+    }
+
+    function _create(ObjectType objectType, Key32 key, bytes memory data) internal {
+        _store.create(
+            key, 
+            objectType,
+            data);
+    }
+
+    function _create(ObjectType objectType, NftId nftId, bytes memory data) internal {
+        _store.create(
+            nftId.toKey32(objectType), 
+            objectType,
+            data);
+    }
+
+    function _updateData(ObjectType objectType, NftId nftId, bytes memory data) internal {
+        _store.updateData(nftId.toKey32(objectType), data);
+    }
+
+    function _updateState(ObjectType objectType, NftId nftId, StateId state) internal {
+        _store.updateState(nftId.toKey32(objectType), state);
+    }
+
+    function _exists(ObjectType objectType, NftId nftId) internal view returns (bool hasData) {
+        return _store.exists(nftId.toKey32(objectType));
+    }
+
+    function _getData(ObjectType objectType, NftId nftId) internal view returns(bytes memory data) {
+        return _store.getData(nftId.toKey32(objectType));
+    }
+
+    function _getState(ObjectType objectType, NftId nftId) internal view returns(StateId) {
+        return _store.getState(nftId.toKey32(objectType));
+    }
+}

package/contracts/instance/{service → base}/ServiceBase.sol

@@ -1,11 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-// import {IRegistry} from "../../registry/IRegistry.sol";
-// import {ITreasury, ITreasuryModule, TokenHandler} from "../../instance/module/treasury/ITreasury.sol";
 import {NftId, zeroNftId} from "../../types/NftId.sol";
 import {ObjectType, SERVICE} from "../../types/ObjectType.sol";
-import {Version, VersionPart, toVersion, toVersionPart} from "../../types/Version.sol";
+import {Version, VersionPart} from "../../types/Version.sol";
 
 import {Registerable} from "../../shared/Registerable.sol";
 import {IVersionable} from "../../shared/IVersionable.sol";

package/contracts/instance/module/access/Access.sol

@@ -5,9 +5,9 @@ pragma solidity ^0.8.19;
 // import {AccessControlEnumerable} from "@openzeppelin/contracts/access/AccessControlEnumerable.sol";
 import "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
 
-import {RoleId, toRoleId} from "../../../types/RoleId.sol";
-import {DISTRIBUTOR_OWNER_ROLE, ORACLE_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE} from "../../../types/RoleId.sol";
-import {DISTRIBUTOR_OWNER_ROLE_NAME, ORACLE_OWNER_ROLE_NAME, POOL_OWNER_ROLE_NAME, PRODUCT_OWNER_ROLE_NAME} from "../../../types/RoleId.sol";
+import {RoleId, RoleIdLib} from "../../../types/RoleId.sol";
+import {DISTRIBUTION_OWNER_ROLE, ORACLE_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE} from "../../../types/RoleId.sol";
+import {DISTRIBUTION_OWNER_ROLE_NAME, ORACLE_OWNER_ROLE_NAME, POOL_OWNER_ROLE_NAME, PRODUCT_OWNER_ROLE_NAME} from "../../../types/RoleId.sol";
 import {IAccessModule} from "./IAccess.sol";
 
 abstract contract AccessModule is IAccessModule {
@@ -36,7 +36,7 @@ abstract contract AccessModule is IAccessModule {
     }
 
     constructor() {
-        _createRole(DISTRIBUTOR_OWNER_ROLE(), DISTRIBUTOR_OWNER_ROLE_NAME());
+        _createRole(DISTRIBUTION_OWNER_ROLE(), DISTRIBUTION_OWNER_ROLE_NAME());
         _createRole(ORACLE_OWNER_ROLE(), ORACLE_OWNER_ROLE_NAME());
         _createRole(POOL_OWNER_ROLE(), POOL_OWNER_ROLE_NAME());
         _createRole(PRODUCT_OWNER_ROLE(), PRODUCT_OWNER_ROLE_NAME());
@@ -45,7 +45,7 @@ abstract contract AccessModule is IAccessModule {
     function createRole(
         string memory roleName
     ) public override onlyAccessOwner returns (RoleId role) {
-        role = toRoleId(roleName);
+        role = RoleIdLib.toRoleId(roleName);
         require(
             !roleExists(role),
             "ERROR:ACS-010:ROLE_ALREADY_EXISTS");
@@ -95,7 +95,7 @@ abstract contract AccessModule is IAccessModule {
     }
 
     function getRoleId(string memory roleName) external pure override returns (RoleId role) {
-        return toRoleId(roleName);
+        return RoleIdLib.toRoleId(roleName);
     }
 
     function getRoleInfo(