@etherisc/gif-next 0.0.2-f78c672-338 → 0.0.2-f78f882-351

package/contracts/shared/ComponentVerifyingService.sol

@@ -1,128 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {IInstance} from "../instance/IInstance.sol";
-import {InstanceReader} from "../instance/InstanceReader.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
-import {NftId} from "../type/NftId.sol";
-import {ObjectType, COMPONENT, DISTRIBUTION, ORACLE, POOL, PRODUCT, STAKING} from "../type/ObjectType.sol";
-import {Service} from "../shared/Service.sol";
-
-
-abstract contract ComponentVerifyingService is 
-    Service
-{
-    error ErrorComponentVerifyingServiceComponentTypeInvalid(NftId componentNftId, ObjectType expectedType, ObjectType actualType);
-    error ErrorComponentVerifyingServiceComponentIsLocked(NftId componentNftId);
-
-    /// @dev based on the sender address returns the corresponding components nft id, info and instance.
-    /// the function reverts iff:
-    /// - there is no such component
-    /// - the component has the wrong object type
-    /// - the component is locked
-    function _getAndVerifyActiveComponent(
-        ObjectType expectedType // assume always of `component` type
-    )
-        internal
-        view
-        returns(
-            NftId componentNftId,
-            IRegistry.ObjectInfo memory objectInfo, 
-            IInstance instance
-        )
-    {
-        componentNftId = getRegistry().getNftIdForAddress(msg.sender);
-        (objectInfo, instance) = _getAndVerifyComponentInfo(
-            componentNftId, 
-            expectedType,
-            true); // only active
-    }
-
-
-    /// @dev returns the component info and instance contract reference given a component nft id
-    /// the function reverts iff:
-    /// - there is no such component
-    /// - the component has the wrong object type
-    function _getAndVerifyComponentInfo(
-        NftId componentNftId,
-        ObjectType expectedType, // assume always of `component` type
-        bool onlyActive
-    )
-        internal
-        virtual
-        view
-        returns(
-            IRegistry.ObjectInfo memory info, 
-            IInstance instance
-        )
-    {
-        IRegistry registry = getRegistry();
-        info = registry.getObjectInfo(componentNftId);
-
-        // if not COMPONENT require exact match
-        if(expectedType != COMPONENT()) {
-            // ensure component is of expected type
-            if(info.objectType != expectedType) {
-                revert ErrorComponentVerifyingServiceComponentTypeInvalid(
-                    componentNftId,
-                    expectedType,
-                    info.objectType);
-            }
-        } else {
-            if(!(info.objectType == PRODUCT()
-                || info.objectType == POOL()
-                || info.objectType == DISTRIBUTION()
-                || info.objectType == ORACLE()
-            ))
-            {
-                revert ErrorComponentVerifyingServiceComponentTypeInvalid(
-                    componentNftId,
-                    expectedType,
-                    info.objectType);
-            }
-        }
-
-        if (info.objectType == STAKING()) {
-            return (info, instance);
-        }
-        
-        if (info.objectType == PRODUCT()) {
-            instance = _getInstance(registry, info.parentNftId);
-        } else {
-            instance = _getInstanceForComponent(registry, info.parentNftId);
-        }
-
-        // ensure component is not locked
-        if (onlyActive) {
-            if (instance.getInstanceAdmin().isTargetLocked(info.objectAddress)) {
-                revert ErrorComponentVerifyingServiceComponentIsLocked(componentNftId);
-            }
-        }
-    }
-
-
-    function _getInstanceForComponent(IRegistry registry, NftId productNftId)
-        internal
-        view
-        returns (IInstance instance)
-    {
-        return _getInstance(
-                registry,
-                registry.getObjectInfo(
-                    productNftId).parentNftId);
-    }
-
-
-    /// @dev returns the product nft id from the registry.
-    /// assumes the component nft id is valid and represents a product linked component.
-    function _getProductNftId(NftId componentNftId) internal view returns (NftId productNftId) {
-        productNftId = getRegistry().getParentNftId(componentNftId);
-    }
-
-
-    /// @dev returns an IInstance contract reference for the specified instance nft id
-    function _getInstance(IRegistry registry, NftId instanceNftId) internal view returns (IInstance) {
-        return IInstance(
-            registry.getObjectAddress(instanceNftId));
-    }
-}

package/contracts/shared/IKeyValueStore.sol

@@ -1,54 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {Blocknumber, blockBlocknumber, zeroBlocknumber} from "../type/Blocknumber.sol";
-import {Key32, KeyId} from "../type/Key32.sol";
-import {NftId} from "../type/NftId.sol";
-import {ObjectType} from "../type/ObjectType.sol";
-import {StateId} from "../type/StateId.sol";
-
-import {ILifecycle} from "./ILifecycle.sol";
-
-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);
-
-    event LogInfoCreated(ObjectType objectType, KeyId keyId, StateId state, address createdBy, address txOrigin);
-    event LogInfoUpdated(ObjectType objectType, KeyId keyId, StateId state, address updatedBy, address txOrigin, Blocknumber lastUpdatedIn);
-    event LogStateUpdated(ObjectType objectType, KeyId keyId, StateId stateOld, StateId stateNew, address updatedBy, address txOrigin, Blocknumber lastUpdatedIn);
-
-    struct Value {
-        Metadata metadata;
-        bytes data;
-    }
-
-    struct Metadata {
-        ObjectType objectType;
-        StateId state;
-        // TODO updatedBy needs concept that says what value should go here
-        // eg account outside gif objects that initiated the tx
-        // implies the caller needs to be propagated through all calls up to key values store itself
-        // to always have the instance address there doesn't seem to make sense
-        // address updatedBy;
-        Blocknumber updatedIn;
-        Blocknumber createdIn;
-    }
-
-    // generic state changing functions
-    // function create(Key32 key, bytes memory data) external;
-    // function update(Key32 key, bytes memory data, StateId state) external;
-    // function updateData(Key32 key, bytes memory data) external;
-    // function updateState(Key32 key, StateId state) external;
-
-    function exists(Key32 key) external view returns (bool);
-    function get(Key32 key) external view returns (Value memory value);
-    function getData(Key32 key) external view returns (bytes memory data);
-    function getMetadata(Key32 key) external view returns (Metadata memory metadata);
-    function getState(Key32 key) external view returns (StateId state);
-
-    function toKey32(ObjectType objectType, KeyId id) external pure returns(Key32);
-}

package/contracts/shared/KeyValueStore.sol

@@ -1,131 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {Blocknumber, blockBlocknumber, zeroBlocknumber} from "../type/Blocknumber.sol";
-import {Key32, KeyId, Key32Lib} from "../type/Key32.sol";
-import {NftId} from "../type/NftId.sol";
-import {ObjectType} from "../type/ObjectType.sol";
-import {StateId, ACTIVE, KEEP_STATE} from "../type/StateId.sol";
-import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
-
-import {Lifecycle} from "./Lifecycle.sol";
-import {IKeyValueStore} from "./IKeyValueStore.sol";
-
-abstract contract KeyValueStore is
-    Lifecycle, 
-    IKeyValueStore
-{
-
-    mapping(Key32 key32 => Value value) private _value;
-
-    function _create(
-        Key32 key32, 
-        bytes memory data
-    )
-        internal
-    {
-        ObjectType objectType = key32.toObjectType();
-        if (objectType.eqz()) {
-            revert ErrorKeyValueStoreTypeUndefined(objectType);
-        }
-
-        Metadata storage metadata = _value[key32].metadata;
-        if (metadata.state.gtz()) {
-            revert ErrorKeyValueStoreAlreadyCreated(key32, objectType);
-        }
-
-        if(!hasLifecycle(objectType)) {
-            revert ErrorKeyValueStoreNoLifecycle(objectType);
-        }
-
-        Blocknumber blocknumber = blockBlocknumber();
-        StateId initialState = getInitialState(objectType);
-
-        // set metadata
-        metadata.objectType = objectType;
-        metadata.state = initialState;
-        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, msg.sender, tx.origin);
-    }
-
-
-    function _update(
-        Key32 key32, 
-        bytes memory data,
-        StateId state
-    ) 
-        internal
-    {
-        // update state
-        Blocknumber lastUpdatedIn = _updateState(key32, state);
-
-        // update data
-        _value[key32].data = data;
-
-        // solhint-disable-next-line avoid-tx-origin
-        emit LogInfoUpdated(key32.toObjectType(), key32.toKeyId(), state, msg.sender, tx.origin, lastUpdatedIn);
-    }
-
-
-    function _updateState(
-        Key32 key32, 
-        StateId state
-    )
-        internal
-        returns (Blocknumber lastUpdatedIn)
-    {
-        if (state.eqz()) {
-            revert ErrorKeyValueStoreStateZero(key32);
-        }
-
-        Metadata storage metadata = _value[key32].metadata;
-        StateId stateOld = metadata.state;
-        lastUpdatedIn = metadata.updatedIn;
-
-        if (stateOld.eqz()) {
-            revert ErrorKeyValueStoreNotExisting(key32);
-        }
-
-        // update state 
-        if(state != KEEP_STATE()) {
-            checkTransition(stateOld, metadata.objectType, stateOld, state);
-            metadata.state = state;
-
-            // solhint-disable-next-line avoid-tx-origin
-            emit LogStateUpdated(key32.toObjectType(), key32.toKeyId(), stateOld, state, msg.sender, tx.origin, lastUpdatedIn);
-        }
-
-        // update metadata
-        metadata.updatedIn = blockBlocknumber();
-    }
-
-    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);
-    }
-}

package/contracts/staking/StakingLifecycle.sol

@@ -1,23 +0,0 @@
-// 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());
-    }
-}