@etherisc/gif-next 0.0.2-de0a1d3-009 → 0.0.2-de7c770-422

package/contracts/experiment/statemachine/SimpleStateMachine.sol

@@ -1,31 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {StateId, toStateId} from "../../types/StateId.sol";
-import {SM} from "./SM.sol";
-
-contract SimpleStateMachine is SM {
-    uint8 public constant STATE_ACTIVE = 10;
-    uint8 public constant STATE_PAUSED = 20;
-    uint8 public constant STATE_ARCHIVED = 30;
-
-    constructor() {
-        addTransition(ACTIVE(), PAUSED());
-        addTransition(PAUSED(), ACTIVE());
-        addTransition(PAUSED(), ARCHIVED());
-
-        setInitialState(ACTIVE());
-    }
-
-    function ACTIVE() public pure returns (StateId stateId) {
-        return toStateId(STATE_ACTIVE);
-    }
-
-    function PAUSED() public pure returns (StateId stateId) {
-        return toStateId(STATE_PAUSED);
-    }
-
-    function ARCHIVED() public pure returns (StateId stateId) {
-        return toStateId(STATE_ARCHIVED);
-    }
-}

package/contracts/experiment/types/TypeA.sol

@@ -1,47 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-/*
-# chisel session for user defined types
-
-import {TypeA, toTypeA} from "./contracts/experiment/types/TypeA.sol";
-TypeA a = toTypeA(1);
-TypeA b = toTypeA(2);
-uint(a.toInt())
-uint(b.toInt())
-a == b
-a != b
-
-import {TypeB, toTypeB} from "./contracts/experiment/types/TypeB.sol";
-TypeB x = toTypeB(33);
-uint(x.toInt())
-a == x; // -> error
-a.toInt() == x.toInt() // -> no error
- */
-
-// bytes5 allows for chain ids up to 13 digits
-type TypeA is uint248;
-
-// type bindings
-using {eqTypeA as ==, neTypeA as !=, TypeALib.toInt} for TypeA global;
-
-// general pure free functions
-function toTypeA(uint256 typeA) pure returns (TypeA) {
-    return TypeA.wrap(uint248(typeA));
-}
-
-// pure free functions for operators
-function eqTypeA(TypeA a, TypeA b) pure returns (bool isSame) {
-    return TypeA.unwrap(a) == TypeA.unwrap(b);
-}
-
-function neTypeA(TypeA a, TypeA b) pure returns (bool isDifferent) {
-    return TypeA.unwrap(a) != TypeA.unwrap(b);
-}
-
-// library functions that operate on user defined type
-library TypeALib {
-    function toInt(TypeA typeA) internal pure returns (uint256) {
-        return uint256(TypeA.unwrap(typeA));
-    }
-}

package/contracts/experiment/types/TypeB.sol

@@ -1,29 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-// bytes5 allows for chain ids up to 13 digits
-type TypeB is uint248;
-
-// type bindings
-using {eqTypeB as ==, addTypeB as +, TypeBLib.toInt} for TypeB global;
-
-// general pure free functions
-function toTypeB(uint256 x) pure returns (TypeB) {
-    return TypeB.wrap(uint248(x));
-}
-
-// pure free functions for operators
-function eqTypeB(TypeB a, TypeB b) pure returns (bool isSame) {
-    return TypeB.unwrap(a) == TypeB.unwrap(b);
-}
-
-function addTypeB(TypeB a, TypeB b) pure returns (TypeB sum) {
-    return TypeB.wrap(TypeB.unwrap(a) + TypeB.unwrap(b));
-}
-
-// library functions that operate on user defined type
-library TypeBLib {
-    function toInt(TypeB b) internal pure returns (uint256) {
-        return uint256(TypeB.unwrap(b));
-    }
-}

package/contracts/instance/IInstanceLinked.sol

@@ -1,8 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IInstance} from "./IInstance.sol";
-
-interface IInstanceLinked {
-    function getInstance() external view returns (IInstance instance);
-}

package/contracts/instance/base/ComponentServiceBase.sol

@@ -1,42 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IRegistry} from "../../registry/IRegistry.sol";
-import {IInstance} from "../../instance/IInstance.sol";
-import {ObjectType, INSTANCE, PRODUCT, POOL} from "../../types/ObjectType.sol";
-import {NftId, NftIdLib} from "../../types/NftId.sol";
-
-import {ServiceBase} from "./ServiceBase.sol";
-
-abstract contract ComponentServiceBase is ServiceBase {
-
-    constructor(
-        address registry,
-        NftId registryNftId
-    )
-        ServiceBase(registry, registryNftId)
-    // solhint-disable-next-line no-empty-blocks
-    {
-    }
-
-
-    function _getAndVerifyComponentInfoAndInstance(
-        ObjectType objectType
-    )
-        internal
-        view
-        returns(
-            IRegistry.ObjectInfo memory info, 
-            IInstance instance
-        )
-    {
-        NftId componentNftId = _registry.getNftId(msg.sender);
-        require(componentNftId.gtz(), "ERROR_COMPONENT_UNKNOWN");
-
-        info = _registry.getObjectInfo(componentNftId);
-        require(info.objectType == objectType, "OBJECT_TYPE_INVALID");
-
-        address instanceAddress = _registry.getObjectInfo(info.parentNftId).objectAddress;
-        instance = IInstance(instanceAddress);
-    }
-}

package/contracts/instance/base/IInstanceBase.sol

@@ -1,22 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {Key32} from "../../types/Key32.sol";
-import {StateId} from "../../types/StateId.sol";
-
-import {IKeyValueStore} from "./IKeyValueStore.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";
-
-interface IInstanceBase {
-    function getKeyValueStore() external view returns (IKeyValueStore keyValueStore);
-    function updateState(Key32 key, StateId state) external;
-    function getState(Key32 key) external view returns (StateId state);
-
-    function getComponentOwnerService() external view returns(IComponentOwnerService service);
-    function getDistributionService() external view returns(IDistributionService);
-    function getProductService() external view returns(IProductService service);
-    function getPoolService() external view returns(IPoolService service);
-}

package/contracts/instance/base/IKeyValueStore.sol

@@ -1,50 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {Blocknumber, blockBlocknumber, zeroBlocknumber} from "../../types/Blocknumber.sol";
-import {Key32, KeyId} from "../../types/Key32.sol";
-import {NftId} from "../../types/NftId.sol";
-import {ObjectType} from "../../types/ObjectType.sol";
-import {StateId} from "../../types/StateId.sol";
-
-import {ILifecycle} from "./ILifecycle.sol";
-
-interface IKeyValueStore is ILifecycle {
-
-    struct Key {
-        ObjectType objectType;
-        KeyId id;
-    }
-
-    struct Value {
-        Metadata metadata;
-        bytes data;
-    }
-
-    struct Metadata {
-        ObjectType objectType;
-        StateId state;
-        address updatedBy;
-        Blocknumber updatedIn;
-        Blocknumber createdIn;
-    }
-
-    event LogInfoCreated(Key key, StateId state, address createdBy, address txOrigin);
-    event LogInfoUpdated(Key key, StateId state, address updatedBy, address txOrigin, Blocknumber lastUpdatedIn);
-    event LogStateUpdated(Key key, StateId stateOld, StateId stateNew, address updatedBy, address txOrigin, Blocknumber lastUpdatedIn);
-
-    // generic state changing functions
-    function create(Key32 key, ObjectType objectType, bytes memory data) external;
-    function update(Key32 key, StateId state, bytes memory data) 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);
-    function toKey(Key32 key32) external pure returns(Key memory key);
-}

package/contracts/instance/base/IService.sol

@@ -1,15 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {VersionPart} from "../../types/Version.sol";
-
-import {IRegisterable} from "../../shared/IRegisterable.sol";
-import {IVersionable} from "../../shared/IVersionable.sol";
-
-interface IService is 
-    IRegisterable,
-    IVersionable
-{
-    function getName() external pure returns(string memory name);
-    function getMajorVersion() external view returns(VersionPart majorVersion);
-}

package/contracts/instance/base/InstanceBase.sol

@@ -1,91 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {Versionable} from "../../shared/Versionable.sol";
-import {Registerable} from "../../shared/Registerable.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 {IDistributionService} from "../service/IDistributionService.sol";
-import {IProductService} from "../service/IProductService.sol";
-import {IPoolService} from "../service/IPoolService.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,
-    IInstanceBase
-{
-    IKeyValueStore internal _keyValueStore;
-
-    IComponentOwnerService internal _componentOwnerService;
-    IDistributionService internal _distributionService;
-    IProductService internal _productService;
-    IPoolService internal _poolService;
-
-    constructor(
-        address registry,
-        NftId registryNftId
-    )
-        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 
-        pure 
-        virtual override
-        returns(Version)
-    {
-        return VersionLib.toVersion(3,0,0);
-    }
-
-    // from registerable
-    function getType() external pure override returns (ObjectType objectType) {
-        return INSTANCE();
-    }
-
-
-    // internal / private functions
-    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));
-    }
-
-    function _getAndCheck(string memory serviceName, VersionPart majorVersion) internal view returns (address serviceAddress) {
-        serviceAddress = _registry.getServiceAddress(serviceName, majorVersion);
-        require(
-            serviceAddress != address(0),
-            "ERROR:INS-001:NOT_REGISTERED"
-        );
-    }
-}

package/contracts/instance/base/KeyValueStore.sol

@@ -1,161 +0,0 @@
-// 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/base/Lifecycle.sol

@@ -1,100 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-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 Lifecycle is ILifecycle {
-    mapping(ObjectType objectType => StateId initialState)
-        private _initialState;
-
-    mapping(ObjectType objectType => mapping(StateId stateFrom => mapping(StateId stateTo => bool isValid)))
-        private _isValidTransition;
-
-    constructor() {
-        _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 checkTransition(
-        ObjectType objectType,
-        StateId fromId,
-        StateId toId
-    )
-        public
-        view
-    {
-        // return if no life cycle support
-        if (_initialState[objectType].eqz()) {
-            return;
-        }
-
-        // enforce valid state transition
-        if (!_isValidTransition[objectType][fromId][toId]) {
-            revert ErrorInvalidStateTransition(objectType, fromId, toId);
-        }
-    }
-
-    function isValidTransition(
-        ObjectType objectType,
-        StateId fromId,
-        StateId toId
-    ) 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()][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()][UNDERWRITTEN()] = true;
-        _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

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