@etherisc/gif-next 0.0.2-d408403-475 → 0.0.2-d442a8c-073

package/contracts/experiment/statemachine/Dummy.sol

@@ -1,27 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {ObjectType} from "../../types/ObjectType.sol";
-import {StateId, toStateId, zeroStateId} from "../../types/StateId.sol";
-
-contract LifeCycleModule {
-    mapping(ObjectType objectType => StateId initialState)
-        private _initialState;
-
-    mapping(ObjectType objectType => mapping(StateId stateFrom => mapping(StateId stateTo => bool isValid)))
-        private _isValidTransition;
-
-    function getInitialState(
-        ObjectType objectType
-    ) external view returns (StateId) {
-        return _initialState[objectType];
-    }
-
-    function isValidTransition(
-        ObjectType objectType,
-        StateId fromId,
-        StateId toId
-    ) external view returns (bool) {
-        return _isValidTransition[objectType][fromId][toId];
-    }
-}

package/contracts/experiment/statemachine/ISM.sol

@@ -1,25 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {StateId} from "../../types/StateId.sol";
-
-interface ISMEE {
-    error ErrorInitialStateUndefined();
-    error ErrorStartStateUndefined();
-    error ErrorNextStateUndefined();
-    error ErrorStateChangeInvalid(StateId currentStateId, StateId newStateId);
-
-    event LogInitialStateSet(StateId initialStateId);
-    event LogStateChanged(StateId oldStateId, StateId newStateId);
-}
-
-interface ISM is ISMEE {
-    function changeToState(StateId newStateId) external;
-
-    function isValidTransition(
-        StateId currentStateId,
-        StateId newStateId
-    ) external view returns (bool isValid);
-
-    function getState() external view returns (StateId currentStateId);
-}

package/contracts/experiment/statemachine/README.md

@@ -1,112 +0,0 @@
-# State Machines
-
-Most GIF objects have a life cycle defined by a state machine.
-
-For each object type the set of possible states is defined together with its initial state and the set of valid state transitions.
-
-## Object Types without States
-
-* Protocol
-* Chains
-* Registries (both chain and main registry)
-
-## Object Types with States
-
-* Tokens
-* Instances
-* Products
-* Oracles
-* Pools
-* Bundles
-* Policies
-* Claim (non-NFT)
-* Payout (non-NFT)
-
-### Simple State Machine
-
-Valid states
-
-* Active (initial state)
-* Paused
-* Archived (final state)
-
-Valid state transitions:
-
-* Active -> Paused
-* Paused -> Active
-* Paused -> Archived
-
-
-Candidate object types for simple state machine
-
-* Token
-* Instance
-* Product
-* Oracle
-* Pool
-
-To discuss: 
-
-* Archived is final state
-* What mechanism should exist to revert an unintended transition to 'Archived' state. Should there be such a mechanism?
-* What mechanism should exist when the NFT of such an object is burned prematurely. Should there be such a mechanism
-
-### Bundle State Machine
-
-Valid states
-
-* Active (initial state)
-* Paused
-* Expired (implicit state)
-* Closed (final state)
-
-Expired is not an explicit state. 
-A bundle is expired for block.timestamp >= expiredAt
-
-### Policy State Machine
-
-Valid states
-
-* Applied (initial state)
-* Revoked (final state)
-* Declined (final state)
-* Active
-* Expired (implicit state)
-* Closed (final state)
-
-Expired is not an explicit state. 
-A policy is expired for block.timestamp >= expiredAt
-
-To discuss: 
-
-* Should 'Closed' be less explicit using a closedAt state variable? 
-* Or even more lighweight? ie. block.timestamp >= expiredAt and no open claims
-
-Valid state transitions:
-
-* Applied -> Revoked
-* Applied -> Declined
-* Applied -> Active
-* Active -> Closed (needs to be expired)
-
-### Claim State Machine
-
-Valid states
-* Applied (initial state)
-* Confirmed
-* Declined (final state)
-* Closed (final state)
-
-Valid state transitions:
-* Applied -> Confirmed
-* Applied -> Declined
-* Confirmed -> Closed
-
-### Payout State Machine
-
-Valid states
-* Expected
-* PaidOut
-
-Valid state transitions:
-* Expected -> PaidOut

package/contracts/experiment/statemachine/SM.sol

@@ -1,57 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {StateId, toStateId, zeroStateId} from "../../types/StateId.sol";
-import {ISM} from "./ISM.sol";
-
-contract SM is ISM {
-    mapping(StateId currentState => mapping(StateId newState => bool isValid))
-        private _isValidTransition;
-
-    StateId internal _state;
-
-    function setInitialState(StateId initialStateId) internal {
-        if (initialStateId == zeroStateId()) {
-            revert ErrorInitialStateUndefined();
-        }
-
-        _state = initialStateId;
-    }
-
-    function addTransition(
-        StateId currentStateId,
-        StateId nextStateId
-    ) internal {
-        if (currentStateId == zeroStateId()) {
-            revert ErrorStartStateUndefined();
-        }
-
-        if (nextStateId == zeroStateId()) {
-            revert ErrorNextStateUndefined();
-        }
-
-        _isValidTransition[currentStateId][nextStateId] = true;
-    }
-
-    function changeToState(StateId newStateId) external override {
-        if (!_isValidTransition[_state][newStateId]) {
-            revert ErrorStateChangeInvalid(_state, newStateId);
-        }
-
-        StateId stateOld = _state;
-        _state = newStateId;
-
-        emit LogStateChanged(stateOld, _state);
-    }
-
-    function isValidTransition(
-        StateId currentStateId,
-        StateId newStateId
-    ) external view override returns (bool isValid) {
-        return _isValidTransition[currentStateId][newStateId];
-    }
-
-    function getState() external view override returns (StateId state) {
-        return _state;
-    }
-}

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