@etherisc/gif-next 0.0.2-f080b71-868 → 0.0.2-f083368-470

package/contracts/instance/InstanceAuthorizationsLib.sol

@@ -1,299 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {ADMIN_ROLE, INSTANCE_OWNER_ROLE, DISTRIBUTION_OWNER_ROLE, POOL_OWNER_ROLE, PRODUCT_OWNER_ROLE, INSTANCE_SERVICE_ROLE, DISTRIBUTION_SERVICE_ROLE, POOL_SERVICE_ROLE, PRODUCT_SERVICE_ROLE, APPLICATION_SERVICE_ROLE, POLICY_SERVICE_ROLE, CLAIM_SERVICE_ROLE, BUNDLE_SERVICE_ROLE, INSTANCE_ROLE} from "../types/RoleId.sol";
-import {INSTANCE, BUNDLE, APPLICATION, POLICY, CLAIM, PRODUCT, DISTRIBUTION, REGISTRY, POOL} from "../types/ObjectType.sol";
-import {VersionPart} from "../types/Version.sol";
-
-import {IRegistry} from "../registry/IRegistry.sol";
-
-import {Instance} from "./Instance.sol";
-import {InstanceAccessManager} from "./InstanceAccessManager.sol";
-import {InstanceReader} from "./InstanceReader.sol";
-import {BundleManager} from "./BundleManager.sol";
-import {AccessManagerUpgradeableInitializeable} from "./AccessManagerUpgradeableInitializeable.sol";
-import {InstanceStore} from "./InstanceStore.sol";
-
-
-library InstanceAuthorizationsLib
-{
-    function grantInitialAuthorizations(
-        InstanceAccessManager clonedAccessManager,
-        Instance clonedInstance,
-        BundleManager clonedBundleManager,
-        InstanceStore clonedInstanceStore,
-        address instanceOwner,
-        IRegistry registry,
-        VersionPart majorVersion)
-            external
-    {
-        _createCoreAndGifRoles(clonedAccessManager);
-        _createCoreTargets(clonedAccessManager, clonedInstance, clonedBundleManager, clonedInstanceStore);
-        _grantDistributionServiceAuthorizations(clonedAccessManager, clonedInstanceStore, registry, majorVersion);
-        _grantPoolServiceAuthorizations(clonedAccessManager, clonedInstanceStore, registry, majorVersion);
-        _grantProductServiceAuthorizations(clonedAccessManager, clonedInstanceStore, registry, majorVersion);
-        _grantApplicationServiceAuthorizations(clonedAccessManager, clonedInstanceStore, registry, majorVersion);
-        _grantPolicyServiceAuthorizations(clonedAccessManager, clonedInstanceStore, registry, majorVersion);
-        _grantClaimServiceAuthorizations(clonedAccessManager, clonedInstanceStore, registry, majorVersion);
-        _grantBundleServiceAuthorizations(clonedAccessManager, clonedInstanceStore, clonedBundleManager, registry, majorVersion);
-        _grantInstanceServiceAuthorizations(clonedAccessManager, clonedInstance, registry, majorVersion);
-        _grantInstanceAuthorizations(clonedAccessManager, registry, majorVersion);
-        _grantInstanceOwnerAuthorizations(clonedAccessManager, clonedInstance, registry, majorVersion);
-    }
-
-    function _createCoreAndGifRoles(InstanceAccessManager clonedAccessManager) private {
-        // default roles controlled by ADMIN_ROLE -> core roles
-        // all set/granted only once during cloning (the only exception is INSTANCE_OWNER_ROLE, hooked to instance nft)
-        clonedAccessManager.createCoreRole(INSTANCE_SERVICE_ROLE(), "InstanceServiceRole");
-        clonedAccessManager.createCoreRole(DISTRIBUTION_SERVICE_ROLE(), "DistributionServiceRole");
-        clonedAccessManager.createCoreRole(POOL_SERVICE_ROLE(), "PoolServiceRole");
-        clonedAccessManager.createCoreRole(APPLICATION_SERVICE_ROLE(), "ApplicationServiceRole");
-        clonedAccessManager.createCoreRole(PRODUCT_SERVICE_ROLE(), "ProductServiceRole");
-        clonedAccessManager.createCoreRole(CLAIM_SERVICE_ROLE(), "ClaimServiceRole");
-        clonedAccessManager.createCoreRole(POLICY_SERVICE_ROLE(), "PolicyServiceRole");
-        clonedAccessManager.createCoreRole(BUNDLE_SERVICE_ROLE(), "BundleServiceRole");
-        // default roles controlled by INSTANCE_OWNER_ROLE -> gif roles
-        clonedAccessManager.createGifRole(DISTRIBUTION_OWNER_ROLE(), "DistributionOwnerRole", INSTANCE_OWNER_ROLE());
-        clonedAccessManager.createGifRole(POOL_OWNER_ROLE(), "PoolOwnerRole", INSTANCE_OWNER_ROLE());
-        clonedAccessManager.createGifRole(PRODUCT_OWNER_ROLE(), "ProductOwnerRole", INSTANCE_OWNER_ROLE());
-    }
-
-    function _createCoreTargets(
-        InstanceAccessManager clonedAccessManager,
-        Instance clonedInstance,
-        BundleManager clonedBundleManager,
-        InstanceStore clonedInstanceStore)
-        private
-    {
-        clonedAccessManager.createCoreTarget(address(clonedAccessManager), "InstanceAccessManager");// TODO create in instance access manager initializer?
-        clonedAccessManager.createCoreTarget(address(clonedInstance), "Instance");// TODO create in instance access manager initializer?
-        clonedAccessManager.createCoreTarget(address(clonedBundleManager), "BundleManager");
-        clonedAccessManager.createCoreTarget(address(clonedInstanceStore), "InstanceStore");
-    }
-
-    function _grantDistributionServiceAuthorizations(
-        InstanceAccessManager clonedAccessManager,
-        InstanceStore clonedInstanceStore,
-        IRegistry registry,
-        VersionPart majorVersion)
-        private
-    {
-        // configure authorization for distribution service on instance
-        address distributionServiceAddress = registry.getServiceAddress(DISTRIBUTION(), majorVersion);
-        clonedAccessManager.grantRole(DISTRIBUTION_SERVICE_ROLE(), distributionServiceAddress);
-        bytes4[] memory instanceDistributionServiceSelectors = new bytes4[](11);
-        instanceDistributionServiceSelectors[0] = clonedInstanceStore.createDistributionSetup.selector;
-        instanceDistributionServiceSelectors[1] = clonedInstanceStore.updateDistributionSetup.selector;
-        instanceDistributionServiceSelectors[2] = clonedInstanceStore.createDistributorType.selector;
-        instanceDistributionServiceSelectors[3] = clonedInstanceStore.updateDistributorType.selector;
-        instanceDistributionServiceSelectors[4] = clonedInstanceStore.updateDistributorTypeState.selector;
-        instanceDistributionServiceSelectors[5] = clonedInstanceStore.createDistributor.selector;
-        instanceDistributionServiceSelectors[6] = clonedInstanceStore.updateDistributor.selector;
-        instanceDistributionServiceSelectors[7] = clonedInstanceStore.updateDistributorState.selector;
-        instanceDistributionServiceSelectors[8] = clonedInstanceStore.createReferral.selector;
-        instanceDistributionServiceSelectors[9] = clonedInstanceStore.updateReferral.selector;
-        instanceDistributionServiceSelectors[10] = clonedInstanceStore.updateReferralState.selector;
-        clonedAccessManager.setCoreTargetFunctionRole(
-            "InstanceStore",
-            instanceDistributionServiceSelectors,
-            DISTRIBUTION_SERVICE_ROLE());
-    }
-
-    function _grantPoolServiceAuthorizations(
-        InstanceAccessManager clonedAccessManager,
-        InstanceStore clonedInstanceStore,
-        IRegistry registry,
-        VersionPart majorVersion)
-        private
-    {
-        // configure authorization for pool service on instance
-        address poolServiceAddress = registry.getServiceAddress(POOL(), majorVersion);
-        clonedAccessManager.grantRole(POOL_SERVICE_ROLE(), address(poolServiceAddress));
-        bytes4[] memory instancePoolServiceSelectors = new bytes4[](4);
-        instancePoolServiceSelectors[0] = clonedInstanceStore.createPoolSetup.selector;
-        instancePoolServiceSelectors[1] = clonedInstanceStore.updatePoolSetup.selector;
-        clonedAccessManager.setCoreTargetFunctionRole(
-            "InstanceStore",
-            instancePoolServiceSelectors,
-            POOL_SERVICE_ROLE());
-    }
-
-    function _grantProductServiceAuthorizations(
-        InstanceAccessManager clonedAccessManager,
-        InstanceStore clonedInstanceStore,
-        IRegistry registry,
-        VersionPart majorVersion)
-        private
-    {
-        // configure authorization for product service on instance
-        address productServiceAddress = registry.getServiceAddress(PRODUCT(), majorVersion);
-        clonedAccessManager.grantRole(PRODUCT_SERVICE_ROLE(), address(productServiceAddress));
-        bytes4[] memory instanceProductServiceSelectors = new bytes4[](5);
-        instanceProductServiceSelectors[0] = clonedInstanceStore.createProductSetup.selector;
-        instanceProductServiceSelectors[1] = clonedInstanceStore.updateProductSetup.selector;
-        instanceProductServiceSelectors[2] = clonedInstanceStore.createRisk.selector;
-        instanceProductServiceSelectors[3] = clonedInstanceStore.updateRisk.selector;
-        instanceProductServiceSelectors[4] = clonedInstanceStore.updateRiskState.selector;
-        clonedAccessManager.setCoreTargetFunctionRole(
-            "InstanceStore",
-            instanceProductServiceSelectors,
-            PRODUCT_SERVICE_ROLE());
-    }
-
-    function _grantApplicationServiceAuthorizations(
-        InstanceAccessManager clonedAccessManager,
-        InstanceStore clonedInstanceStore,
-        IRegistry registry,
-        VersionPart majorVersion)
-        private
-    {
-        // configure authorization for application services on instance
-        address applicationServiceAddress = registry.getServiceAddress(APPLICATION(), majorVersion);
-        clonedAccessManager.grantRole(APPLICATION_SERVICE_ROLE(), applicationServiceAddress);
-        bytes4[] memory instanceApplicationServiceSelectors = new bytes4[](3);
-        instanceApplicationServiceSelectors[0] = clonedInstanceStore.createApplication.selector;
-        instanceApplicationServiceSelectors[1] = clonedInstanceStore.updateApplication.selector;
-        instanceApplicationServiceSelectors[2] = clonedInstanceStore.updateApplicationState.selector;
-        clonedAccessManager.setCoreTargetFunctionRole(
-            "InstanceStore",
-            instanceApplicationServiceSelectors,
-            APPLICATION_SERVICE_ROLE());
-    }
-
-    function _grantPolicyServiceAuthorizations(
-        InstanceAccessManager clonedAccessManager,
-        InstanceStore clonedInstanceStore,
-        IRegistry registry,
-        VersionPart majorVersion)
-        private
-    {
-        // configure authorization for policy services on instance
-        address policyServiceAddress = registry.getServiceAddress(POLICY(), majorVersion);
-        clonedAccessManager.grantRole(POLICY_SERVICE_ROLE(), policyServiceAddress);
-        bytes4[] memory instancePolicyServiceSelectors = new bytes4[](2);
-        instancePolicyServiceSelectors[0] = clonedInstanceStore.updatePolicy.selector;
-        instancePolicyServiceSelectors[1] = clonedInstanceStore.updatePolicyState.selector;
-        clonedAccessManager.setCoreTargetFunctionRole(
-            "InstanceStore",
-            instancePolicyServiceSelectors,
-            POLICY_SERVICE_ROLE());
-    }
-
-    function _grantClaimServiceAuthorizations(
-        InstanceAccessManager clonedAccessManager,
-        InstanceStore clonedInstanceStore,
-        IRegistry registry,
-        VersionPart majorVersion)
-        private
-    {
-        // configure authorization for claim/payout services on instance
-        address claimServiceAddress = registry.getServiceAddress(CLAIM(), majorVersion);
-        clonedAccessManager.grantRole(POLICY_SERVICE_ROLE(), claimServiceAddress);
-        // TODO add claims function authz
-        bytes4[] memory instanceClaimServiceSelectors = new bytes4[](0);
-        // instanceClaimServiceSelectors[0] = clonedInstanceStore.updatePolicy.selector;
-        // instanceClaimServiceSelectors[1] = clonedInstanceStore.updatePolicyState.selector;
-        clonedAccessManager.setCoreTargetFunctionRole(
-            "InstanceStore",
-            instanceClaimServiceSelectors,
-            CLAIM_SERVICE_ROLE());
-    }
-
-    function _grantBundleServiceAuthorizations(
-        InstanceAccessManager clonedAccessManager,
-        InstanceStore clonedInstanceStore,
-        BundleManager clonedBundleManager,
-        IRegistry registry,
-        VersionPart majorVersion)
-        private
-    {
-        // configure authorization for bundle service on instance
-        address bundleServiceAddress = registry.getServiceAddress(BUNDLE(), majorVersion);
-        clonedAccessManager.grantRole(BUNDLE_SERVICE_ROLE(), address(bundleServiceAddress));
-        bytes4[] memory instanceBundleServiceSelectors = new bytes4[](3);
-        instanceBundleServiceSelectors[0] = clonedInstanceStore.createBundle.selector;
-        instanceBundleServiceSelectors[1] = clonedInstanceStore.updateBundle.selector;
-        instanceBundleServiceSelectors[2] = clonedInstanceStore.updateBundleState.selector;
-        clonedAccessManager.setCoreTargetFunctionRole(
-            "InstanceStore",
-            instanceBundleServiceSelectors,
-            BUNDLE_SERVICE_ROLE());
-
-        // configure authorization for bundle service on bundle manager
-        bytes4[] memory bundleManagerBundleServiceSelectors = new bytes4[](5);
-        bundleManagerBundleServiceSelectors[0] = clonedBundleManager.linkPolicy.selector;
-        bundleManagerBundleServiceSelectors[1] = clonedBundleManager.unlinkPolicy.selector;
-        bundleManagerBundleServiceSelectors[2] = clonedBundleManager.add.selector;
-        bundleManagerBundleServiceSelectors[3] = clonedBundleManager.lock.selector;
-        bundleManagerBundleServiceSelectors[4] = clonedBundleManager.unlock.selector;
-        clonedAccessManager.setCoreTargetFunctionRole(
-            "BundleManager",
-            bundleManagerBundleServiceSelectors,
-            BUNDLE_SERVICE_ROLE());
-    }
-
-    function _grantInstanceServiceAuthorizations(
-        InstanceAccessManager clonedAccessManager,
-        Instance clonedInstance,
-        IRegistry registry,
-        VersionPart majorVersion)
-        private
-    {
-        // configure authorization for instance service on instance
-        address instanceServiceAddress = registry.getServiceAddress(INSTANCE(), majorVersion);
-        clonedAccessManager.grantRole(INSTANCE_SERVICE_ROLE(), instanceServiceAddress);
-        bytes4[] memory instanceInstanceServiceSelectors = new bytes4[](1);
-        instanceInstanceServiceSelectors[0] = clonedInstance.setInstanceReader.selector;
-        clonedAccessManager.setCoreTargetFunctionRole(
-            "Instance",
-            instanceInstanceServiceSelectors,
-            INSTANCE_SERVICE_ROLE());
-
-        // configure authorizations for instance service on instance access manager
-        bytes4[] memory accessManagerInstanceServiceSelectors = new bytes4[](3);
-        accessManagerInstanceServiceSelectors[0] = clonedAccessManager.createGifTarget.selector;
-        accessManagerInstanceServiceSelectors[1] = clonedAccessManager.setTargetLockedByService.selector;
-        accessManagerInstanceServiceSelectors[2] = clonedAccessManager.setCoreTargetFunctionRole.selector;
-        clonedAccessManager.setCoreTargetFunctionRole(
-            "InstanceAccessManager",
-            accessManagerInstanceServiceSelectors,
-            INSTANCE_SERVICE_ROLE());
-    }
-
-    function _grantInstanceAuthorizations(
-        InstanceAccessManager clonedAccessManager,
-        IRegistry registry,
-        VersionPart majorVersion)
-        private
-    {
-        bytes4[] memory accessManagerInstanceSelectors = new bytes4[](4);
-        accessManagerInstanceSelectors[0] = clonedAccessManager.createRole.selector;
-        accessManagerInstanceSelectors[1] = clonedAccessManager.createTarget.selector;
-        accessManagerInstanceSelectors[2] = clonedAccessManager.setTargetFunctionRole.selector;
-        accessManagerInstanceSelectors[3] = clonedAccessManager.setTargetLockedByInstance.selector;
-        clonedAccessManager.setCoreTargetFunctionRole(
-            "InstanceAccessManager",
-            accessManagerInstanceSelectors,
-            INSTANCE_ROLE());
-    }
-
-    function _grantInstanceOwnerAuthorizations(
-        InstanceAccessManager clonedAccessManager,
-        Instance clonedInstance,
-        IRegistry registry,
-        VersionPart majorVersion) 
-        private 
-    {
-        // configure authorization for instance owner on instance access manager
-        // instance owner role is granted/revoked ONLY by INSTANCE_ROLE
-        bytes4[] memory instanceInstanceOwnerSelectors = new bytes4[](4);
-        instanceInstanceOwnerSelectors[0] = clonedInstance.createRole.selector;
-        instanceInstanceOwnerSelectors[1] = clonedInstance.createTarget.selector;
-        instanceInstanceOwnerSelectors[2] = clonedInstance.setTargetFunctionRole.selector;
-        instanceInstanceOwnerSelectors[3] = clonedInstance.setTargetLocked.selector;
-        clonedAccessManager.setCoreTargetFunctionRole(
-            "Instance",
-            instanceInstanceOwnerSelectors,
-            INSTANCE_OWNER_ROLE());
-    }
-}

package/contracts/instance/base/ComponentService.sol

@@ -1,147 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IComponent} from "../../components/IComponent.sol";
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {IRegistryService} from "../../registry/IRegistryService.sol";
-import {IInstance} from "../../instance/IInstance.sol";
-import {IAccess} from "../module/IAccess.sol";
-import {ObjectType, INSTANCE, REGISTRY} from "../../types/ObjectType.sol";
-import {NftId} from "../../types/NftId.sol";
-import {RoleId} from "../../types/RoleId.sol";
-
-import {Service} from "../../shared/Service.sol";
-import {InstanceService} from "../InstanceService.sol";
-import {InstanceAccessManager} from "../InstanceAccessManager.sol";
-
-abstract contract ComponentService is Service {
-
-    error ErrorComponentServiceNotComponent(address component);
-    error ErrorComponentServiceInvalidType(address component, ObjectType requiredType, ObjectType componentType);
-    error ErrorComponentServiceSenderNotOwner(address component, address initialOwner, address sender);
-    error ErrorComponentServiceExpectedRoleMissing(NftId instanceNftId, RoleId requiredRole, address sender);
-    error ErrorComponentServiceComponentLocked(address component);
-    error ErrorComponentServiceSenderNotService(address sender);
-    error ErrorComponentServiceComponentTypeInvalid(address component, ObjectType expectedType, ObjectType foundType);
-
-    /// @dev modifier to check if caller is a registered service
-    modifier onlyService() {
-        address caller = msg.sender;
-        if(!getRegistry().isRegisteredService(caller)) {
-            revert ErrorComponentServiceSenderNotService(caller);
-        }
-        _;
-    }
-
-    // view functions
-
-    function getRegistryService() public view virtual returns (IRegistryService) {
-        return IRegistryService(_getServiceAddress(REGISTRY()));
-    }
-
-    function getInstanceService() public view returns (InstanceService) {
-        return InstanceService(_getServiceAddress(INSTANCE()));
-    }
-
-    // internal functions
-    function _checkComponentForRegistration(
-        address componentAddress,
-        ObjectType requiredType,
-        RoleId requiredRole
-    )
-        internal
-        view
-        returns (
-            IComponent component,
-            address owner,
-            IInstance instance,
-            NftId instanceNftId
-        )
-    {
-        // component may only be registerd by initial owner of component
-        owner = msg.sender;
-
-        // check this is a component
-        component = IComponent(componentAddress);
-        if(!component.supportsInterface(type(IComponent).interfaceId)) {
-            revert ErrorComponentServiceNotComponent(componentAddress);
-        }
-
-        // check component is of required type
-        IRegistry.ObjectInfo memory componentInfo = component.getInitialInfo();
-        if(componentInfo.objectType != requiredType) {
-            revert ErrorComponentServiceInvalidType(componentAddress, requiredType, componentInfo.objectType);
-        }
-
-        // check msg.sender is component owner
-        address initialOwner = componentInfo.initialOwner;
-        if(owner != initialOwner) {
-            revert ErrorComponentServiceSenderNotOwner(componentAddress, componentInfo.initialOwner, owner);
-        }
-
-        // check instance has assigned required role to owner
-        instanceNftId = componentInfo.parentNftId;
-        instance = _getInstance(instanceNftId);
-        if(!instance.getInstanceAccessManager().hasRole(requiredRole, owner)) {
-            revert ErrorComponentServiceExpectedRoleMissing(instanceNftId, requiredRole, owner);
-        }
-    }
-
-    // internal view functions
-    function _getAndVerifyCallingComponentAndInstance(
-        ObjectType expectedType // assume always of `component` type
-    )
-        internal
-        view
-        returns(
-            NftId componentNftId,
-            IRegistry.ObjectInfo memory componentInfo, 
-            IInstance instance
-        )
-    {
-        componentNftId = getRegistry().getNftId(msg.sender);
-        (componentInfo, instance) = _getAndVerifyComponentInfoAndInstance(componentNftId, expectedType);
-
-        if (instance.getInstanceAccessManager().isTargetLocked(componentInfo.objectAddress)) {
-            revert IAccess.ErrorIAccessTargetLocked(componentInfo.objectAddress);
-        }
-    }
-
-    function _getAndVerifyComponentInfoAndInstance(
-        NftId componentNftId,
-        ObjectType expectedType // assume always of `component` type
-    )
-        internal
-        view
-        returns(
-            IRegistry.ObjectInfo memory componentInfo, 
-            IInstance instance
-        )
-    {
-        componentInfo = getRegistry().getObjectInfo(componentNftId);
-        if(componentInfo.objectType != expectedType) {
-            revert ErrorComponentServiceComponentTypeInvalid(
-                componentInfo.objectAddress, 
-                expectedType, 
-                componentInfo.objectType);
-        }
-
-        instance = _getInstance(componentInfo.parentNftId);
-    }
-    // assume componentNftId is always of `instance` type
-    function _getInstance(NftId instanceNftId) internal view returns (IInstance) {
-        return IInstance(
-            getRegistry().getObjectInfo(
-                instanceNftId).objectAddress);
-    }
-    // assume componentNftId is always of `component` type
-    /*function _getInstanceForComponent(NftId componentNftId) internal view returns (IInstance) {
-        NftId instanceNftId = getRegistry().getObjectInfo(componentNftId).parentNftId;
-        address instanceAddress = getRegistry().getObjectInfo(instanceNftId).objectAddress;
-        return IInstance(instanceAddress);
-    }*/
-
-    function _getServiceAddress(ObjectType domain) internal view returns (address) {
-        return getRegistry().getServiceAddress(domain, getVersion().toMajorPart());
-    }
-}

package/contracts/instance/base/KeyValueStore.sol

@@ -1,180 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-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, KEEP_STATE} from "../../types/StateId.sol";
-import {Timestamp, TimestampLib} 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;
-
-    function create(
-        Key32 key32, 
-        bytes memory data
-    )
-        internal
-    {
-        _create(key32, data);
-    }
-
-    function _create(
-        Key32 key32, 
-        bytes memory data
-    )
-        internal
-    {
-        ObjectType objectType = key32.toObjectType();
-        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(key32.toObjectType(), key32.toKeyId(), initialState, createdBy, tx.origin);
-    }
-
-    function update(
-        Key32 key32, 
-        bytes memory data,
-        StateId state
-    ) 
-        internal
-    {
-        _update(key32, data, state);
-    }
-
-    function _update(
-        Key32 key32, 
-        bytes memory data,
-        StateId state
-    ) 
-        internal
-    {
-        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 state 
-        if(state != KEEP_STATE()) {
-            metadata.state = state;
-        }
-
-        // update reest of metadata
-        address updatedBy = msg.sender;
-        Blocknumber lastUpdatedIn = metadata.updatedIn;
-
-        metadata.updatedBy = updatedBy;
-        metadata.updatedIn = blockBlocknumber();
-
-        // create log entries
-        // solhint-disable avoid-tx-origin
-        emit LogStateUpdated(key32.toObjectType(), key32.toKeyId(), stateOld, state, updatedBy, tx.origin, lastUpdatedIn);
-        emit LogInfoUpdated(key32.toObjectType(), key32.toKeyId(), state, updatedBy, tx.origin, lastUpdatedIn);
-        // solhing-enable
-    }
-
-    function updateData(Key32 key32, bytes memory data) 
-        internal
-    {
-        _updateData(key32, data);
-    }
-
-    function _updateData(Key32 key32, bytes memory data) 
-        internal
-    {
-        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
-        // solhint-disable-next-line avoid-tx-origin
-        emit LogInfoUpdated(key32.toObjectType(), key32.toKeyId(), state, updatedBy, tx.origin, lastUpdatedIn);
-    }
-
-    function updateState(Key32 key32, StateId state)
-        internal
-    {
-        _updateState(key32, state);
-    }
-
-    function _updateState(Key32 key32, StateId state)
-        internal
-    {
-        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");
-
-        // ensure state transistion is valid
-        checkTransition(metadata.objectType, stateOld, state);
-
-        // update metadata (and state)
-        address updatedBy = msg.sender;
-        Blocknumber lastUpdatedIn = metadata.updatedIn;
-        metadata.state = state;
-        metadata.updatedBy = updatedBy;
-        metadata.updatedIn = blockBlocknumber();
-
-        // create log entry
-        // solhint-disable-next-line avoid-tx-origin
-        emit LogStateUpdated(key32.toObjectType(), key32.toKeyId(), stateOld, state, 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);
-    }
-}