@etherisc/gif-next 0.0.2-d13bb9e-069 → 0.0.2-d18e1c5-511

package/contracts/authorization/IModuleAuthorization.sol

@@ -1,21 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {IAccess} from "./IAccess.sol";
-import {IAuthorization} from "./IAuthorization.sol";
-import {ObjectType} from "../type/ObjectType.sol";
-import {RoleId} from "../type/RoleId.sol";
-import {Str} from "../type/String.sol";
-
-interface IModuleAuthorization is 
-     IAccess,
-     IAuthorization 
-{
-
-     /// @dev Returns the list of service targets.
-     function getServiceDomains() external view returns(ObjectType[] memory serviceDomains);
-
-     /// @dev Returns the service target for the specified domain.
-     function getServiceTarget(ObjectType serviceDomain) external view returns(Str serviceTarget);
-}
-

package/contracts/authorization/ModuleAuthorization.sol

@@ -1,78 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {Authorization} from "./Authorization.sol";
-import {IAccess} from "./IAccess.sol";
-import {IModuleAuthorization} from "./IModuleAuthorization.sol";
-import {ObjectType, ObjectTypeLib} from "../type/ObjectType.sol";
-import {RoleId, RoleIdLib, ADMIN_ROLE} from "../type/RoleId.sol";
-import {SelectorLib} from "../type/Selector.sol";
-import {Str, StrLib} from "../type/String.sol";
-import {TimestampLib} from "../type/Timestamp.sol";
-import {VersionPart} from "../type/Version.sol";
-
-contract ModuleAuthorization is
-     Authorization,
-     IModuleAuthorization
-{
-
-     ObjectType[] internal _serviceDomains;
-     mapping(ObjectType domain => Str target) internal _serviceTarget;
-
-     constructor(string memory moduleName)
-          Authorization(moduleName)
-     { }
-
-     function getServiceDomains() external view returns(ObjectType[] memory serviceDomains) {
-          return _serviceDomains;
-     }
-
-     function getServiceTarget(ObjectType serviceDomain) external view returns(Str serviceTarget) {
-          return _serviceTarget[serviceDomain];
-     }
-
-     /// @dev Add a GIF role for the provided role id and name.
-     function _addGifRole(RoleId roleId, string memory name) internal returns (RoleInfo memory info) {
-          _addRole(
-               roleId,
-               _toRoleInfo(
-                    ADMIN_ROLE(),
-                    RoleType.Gif,
-                    type(uint32).max,
-                    name));
-     }
-
-     /// @dev Add the service target role for the specified service domain
-     function _addServiceTargetWithRole(ObjectType serviceDomain) internal {
-          // add service domain
-          _serviceDomains.push(serviceDomain);
-
-          // get versioned target name
-          string memory serviceTargetName = ObjectTypeLib.toVersionedName(
-                    ObjectTypeLib.toName(serviceDomain), 
-                    "Service", 
-                    getRelease().toInt());
-
-          _serviceTarget[serviceDomain] = StrLib.toStr(serviceTargetName);
-
-          RoleId serviceRoleId = getServiceRole(serviceDomain);
-          string memory serviceRoleName = ObjectTypeLib.toVersionedName(
-                    ObjectTypeLib.toName(serviceDomain), 
-                    "ServiceRole", 
-                    getRelease().toInt());
-
-          _addTargetWithRole(
-               serviceTargetName,
-               serviceRoleId,
-               serviceRoleName);
-     }
-
-     /// @dev role id for targets registry, staking and instance
-     function _getTargetRoleId(ObjectType targetDomain) 
-          internal
-          returns (RoleId targetRoleId)
-     {
-          return RoleIdLib.roleForType(targetDomain);
-     }
-}
-

package/contracts/instance/module/IAccess.sol

@@ -1,46 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {ShortString, ShortStrings} from "@openzeppelin/contracts/utils/ShortStrings.sol";
-
-import {NftId} from "../../type/NftId.sol";
-import {RoleId} from "../../type/RoleId.sol";
-import {Timestamp} from "../../type/Timestamp.sol";
-
-interface IAccess {
-
-    enum Type {
-        NotInitialized,
-        Core,
-        Gif,
-        Custom        
-    }
-
-    struct RoleInfo {
-        ShortString name;
-        Type rtype;
-        //bool isLocked;
-        RoleId admin;
-        Timestamp createdAt;
-        Timestamp updatedAt;
-    }
-
-    struct TargetInfo {
-        ShortString name;
-        Type ttype;
-        bool isLocked;
-        Timestamp createdAt;
-        Timestamp updatedAt;
-    }
-
-    error ErrorIAccessRoleIdTooBig(RoleId roleId);
-    error ErrorIAccessRoleIdTooSmall(RoleId roleId);
-    error ErrorIAccessRoleTypeInvalid(RoleId roleId, Type rtype);
-
-    error ErrorIAccessTargetAddressZero();
-    error ErrorIAccessTargetTypeInvalid(address target, Type ttype);
-    error ErrorIAccessTargetLocked(address target);
-    error ErrorIAccessTargetNotRegistered(address target);
-    error ErrorIAccessTargetAuthorityInvalid(address target, address targetAuthority);
-    error ErrorIAccessTargetInstanceMismatch(address target, NftId targetParentNftId, NftId instanceNftId);
-}

package/contracts/shared/ComponentVerifyingService.sol

@@ -1,116 +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} 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 componentInfo, 
-            IInstance instance
-        )
-    {
-        componentNftId = getRegistry().getNftIdForAddress(msg.sender);
-        (componentInfo, 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);
-            }
-        }
-
-        instance = _getInstance(info.parentNftId);
-
-        // ensure component is not locked
-        if (onlyActive) {
-            if (instance.getInstanceAdmin().isTargetLocked(info.objectAddress)) {
-                revert ErrorComponentVerifyingServiceComponentIsLocked(componentNftId);
-            }
-        }
-    }
-
-
-    /// @dev returns the linked product nft id for the specified component
-    function _getProductNftId(
-        InstanceReader instanceReader,
-        NftId componentNftId
-    )
-        internal
-        virtual
-        view
-        returns (NftId productNftId)
-    {
-        return instanceReader.getComponentInfo(componentNftId).productNftId;
-    }
-
-
-    /// @dev returns an IInstance contract reference for the specified instance nft id
-    function _getInstance(NftId instanceNftId) internal view returns (IInstance) {
-        return IInstance(
-            getRegistry().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/InitializableCustom.sol

@@ -1,177 +0,0 @@
-// SPDX-License-Identifier: MIT
-
-pragma solidity ^0.8.20;
-
-/**
- * @dev This is copy of OpenZeppelin's Contracts (last updated v5.0.0) (proxy/utils/Initializable.sol)
- * Changes:
- * 1. name is InitializableCustom
- * 2. no longer abstract
- * 3. have $._initializeOwner
- * 4. have constructor where sets _initializeOwner 
- * 5. initializer() in addition checks for _initializeOwner
- * 6. reinitializer() is deleted
- */
-abstract contract InitializableCustom {
-    /**
-     * @dev Storage of the initializable contract.
-     *
-     * It's implemented on a custom ERC-7201 namespace to reduce the risk of storage collisions
-     * when using with upgradeable contracts.
-     *
-     * @custom:storage-location erc7201:openzeppelin.storage.Initializable
-     */
-    struct InitializableCustomStorage {
-        /**
-         * @dev Indicates that the contract has been initialized.
-         */
-        uint64 _initialized;
-        /**
-         * @dev Indicates that the contract is in the process of being initialized.
-         */
-        bool _initializing;
-        /**
-         * @dev Indicates address that can call function with initializer() modifier.
-         */
-        address _initializeOwner;
-    }
-
-    // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.InitializableCustom")) - 1)) & ~bytes32(uint256(0xff))
-    bytes32 private constant INITIALIZABLE_CUSTOM_STORAGE = 0x46cd1d813423aaf613c34c7f348d15b2b5e71215e9145b09467e257ea2805a00;
-
-    /**
-     * @dev The contract is already initialized.
-     */
-    error InvalidInitialization();
-
-    /**
-     * @dev The contract initialization function caller is not authorized.
-     */
-    error InvalidInitializationCaller();
-
-    /**
-     * @dev The contract is not initializing.
-     */
-    error NotInitializing();
-
-    /**
-     * @dev Triggered when the contract has been initialized or reinitialized.
-     */
-    event Initialized(uint64 version);
-
-    /**
-     * @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
-     * `onlyInitializing` functions can be used to initialize parent contracts.
-     *
-     * Similar to `reinitializer(1)`, except that in the context of a constructor an `initializer` may be invoked any
-     * number of times. This behavior in the constructor can be useful during testing and is not expected to be used in
-     * production.
-     *
-     * Emits an {Initialized} event.
-     */
-    modifier initializer() virtual {
-        // solhint-disable-next-line var-name-mixedcase
-        InitializableCustomStorage storage $ = _getInitializableCustomStorage();
-
-        if($._initializeOwner != msg.sender) {
-            revert InvalidInitializationCaller();
-        }
-
-        // Cache values to avoid duplicated sloads
-        bool isTopLevelCall = !$._initializing;
-        uint64 initialized = $._initialized;
-
-        // Allowed calls:
-        // - initialSetup: the contract is not in the initializing state and no previous version was
-        //                 initialized
-        // - construction: the contract is initialized at version 1 (no reininitialization) and the
-        //                 current contract is just being deployed
-        bool initialSetup = initialized == 0 && isTopLevelCall;
-        bool construction = initialized == 1 && address(this).code.length == 0;
-
-        if (!initialSetup && !construction) {
-            revert InvalidInitialization();
-        }
-        $._initialized = 1;
-        if (isTopLevelCall) {
-            $._initializing = true;
-        }
-        _;
-        if (isTopLevelCall) {
-            $._initializing = false;
-            emit Initialized(1);
-        }
-    }
-
-    /**
-     * @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
-     * {initializer} and {reinitializer} modifiers, directly or indirectly.
-     */
-    modifier onlyInitializing() {
-        _checkInitializing();
-        _;
-    }
-
-    /**
-     * @dev Constructor sets the caller of protected initializer function.
-    */
-    constructor() {
-        // solhint-disable-previous-line var-name-mixedcase
-        InitializableCustomStorage storage $ = _getInitializableCustomStorage();
-        $._initializeOwner = msg.sender;
-    }
-
-    /**
-     * @dev Reverts if the contract is not in an initializing state. See {onlyInitializing}.
-     */
-    function _checkInitializing() internal view virtual {
-        if (!_isInitializing()) {
-            revert NotInitializing();
-        }
-    }
-
-    /**
-     * @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
-     * Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
-     * to any version. It is recommended to use this to lock implementation contracts that are designed to be called
-     * through proxies.
-     *
-     * Emits an {Initialized} event the first time it is successfully executed.
-     */
-    function _disableInitializers() internal virtual {
-        // solhint-disable-next-line var-name-mixedcase
-        InitializableCustomStorage storage $ = _getInitializableCustomStorage();
-
-        if ($._initializing) {
-            revert InvalidInitialization();
-        }
-        if ($._initialized != type(uint64).max) {
-            $._initialized = type(uint64).max;
-            emit Initialized(type(uint64).max);
-        }
-    }
-
-    /**
-     * @dev Returns the highest version that has been initialized. See {reinitializer}.
-     */
-    function _getInitializedVersion() internal view returns (uint64) {
-        return _getInitializableCustomStorage()._initialized;
-    }
-
-    /**
-     * @dev Returns `true` if the contract is currently initializing. See {onlyInitializing}.
-     */
-    function _isInitializing() internal view returns (bool) {
-        return _getInitializableCustomStorage()._initializing;
-    }
-
-    /**
-     * @dev Returns a pointer to the storage namespace.
-     */
-    // solhint-disable-next-line var-name-mixedcase
-    function _getInitializableCustomStorage() private pure returns (InitializableCustomStorage storage $) {
-        assembly {
-            $.slot := INITIALIZABLE_CUSTOM_STORAGE
-        }
-    }
-}

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(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());
-    }
-}