@etherisc/gif-next 0.0.2-c4efd5e → 0.0.2-c576a00-897

package/contracts/experiment/kvstore/KvStore.sol

@@ -0,0 +1,195 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+/*
+fa = {'from': accounts[0]}
+tl = TimestampLib.deploy(fa)
+kv = KvStore.deploy(fa)
+r1 = kv.createRiskInfo(kv.s2b('risk spec 1'))
+b1 = kv.createBundleInfo(123456, 10000000, kv.s2b('bundle filter 1'))
+
+(r1k, r1v) = kv.riskInfoToKeyValue(3, r1)
+
+kv.toKey(r1k)
+
+*/
+
+import {NftId, toNftId} from "../../types/NftId.sol";
+import {RiskId, toRiskId} from "../../types/RiskId.sol";
+import {ObjectType, BUNDLE, RISK} from "../../types/ObjectType.sol";
+import {VersionPart} from "../../types/Version.sol";
+import {StateId, ACTIVE} from "../../types/StateId.sol";
+import {Timestamp, blockTimestamp, zeroTimestamp} from "../../types/Timestamp.sol";
+import {Blocknumber, blockNumber} from "../../types/Blocknumber.sol";
+import {IBundle} from "./IBundle.sol";
+import {IRisk} from "../../instance/module/risk/IRisk.sol";
+
+type KeyId is bytes31;
+
+contract KvStore {
+
+    uint8 public constant TYPE_SHIFT = 31 * 8;
+    bytes32 public constant TYPE_MASK = bytes32(bytes1(type(uint8).max)); // first byte in bytes32
+    bytes32 public constant ID_MASK = bytes32(~TYPE_MASK); // remaining bytes in bytes32
+
+    struct Key {
+        ObjectType objectType;
+        KeyId id;
+    }
+
+    struct Value {
+        VersionPart majorVersion;
+        bytes data;
+    }
+
+    mapping(bytes32 key => Value value) private _store;
+    bytes32[] private _keys;
+
+    function toKey32(RiskId riskId) public pure returns (bytes32 key) {
+        uint256 objectType = uint256(ObjectType.unwrap(RISK()));
+        uint256 id = uint96(RiskId.unwrap(riskId));
+        return bytes32(objectType << TYPE_SHIFT + id);
+    }
+
+    function toKey(bytes32 key32) public pure returns (Key memory key) {
+        ObjectType objectType = ObjectType.wrap(uint8(uint256(key32 & TYPE_MASK) >> TYPE_SHIFT));
+        KeyId id = KeyId.wrap(bytes31(key32 & ID_MASK));
+        return Key(objectType, id);
+    }
+
+    function toBytes32(uint256 value) public pure returns(bytes32) { return bytes32(value); }
+
+    // key store functions
+    function create(bytes32 key, Value memory value) public {
+        // add only store
+        require(VersionPart.unwrap(_store[key].majorVersion) == 0, "ERROR_KEY_USED");
+        _store[key] = value;
+        _keys.push(key);
+    }
+
+    function update(bytes32 key, Value memory value) public {
+        // add only store
+        require(VersionPart.unwrap(_store[key].majorVersion) > 0, "ERROR_KEY_UNKNOWN");
+        _store[key] = value;
+    }
+
+    function getIdMask() public pure returns (bytes32) { return ID_MASK; }
+    function getTypeMask() public pure returns (bytes32) { return TYPE_MASK; }
+
+    function get(bytes32 key) public view returns (Value memory value) {
+        return _store[key];
+    }
+
+    function exists(bytes32 key) public view returns (bool) {
+        return VersionPart.unwrap(_store[key].majorVersion) > 0;
+    }
+
+    function getKeyCount() public view returns (uint256 keyCount) {
+        return _keys.length;
+    }
+
+    function getKey(uint256 index) public view returns (bytes32 key) {
+        return _keys[index];
+    }
+
+    function s2b(string memory s) public pure returns (bytes memory b) {
+        return abi.encodePacked(s);
+    }
+
+    function b2s(bytes memory b) public pure returns (string memory s) {
+        return abi.decode(b, (string));
+    }
+
+    // risk related functions
+
+    function keyToRiskId(Key memory key) public pure returns (RiskId id) {
+        require(key.objectType == RISK(), "ERROR_NOT_RISK_KEY");
+        return RiskId.wrap(bytes12(KeyId.unwrap(key.id)));
+    }
+
+    function createRiskInfo(
+        bytes memory specification
+    )
+        public 
+        view
+        returns(IRisk.RiskInfo memory info)
+    {
+        RiskId riskId = toRiskId(specification);
+        return IRisk.RiskInfo(
+            riskId,
+            ACTIVE(),
+            specification,
+            blockTimestamp(), // createdAt
+            blockNumber()); // updatedIn
+    }
+
+    function riskIdToKey(RiskId riskId) public pure returns(bytes32 key) {
+        return keccak256(abi.encode(RISK(), riskId));
+    }
+
+    function encodeRiskInfo(IRisk.RiskInfo memory info) public pure returns (bytes memory data) {
+        return abi.encode(info);
+    }
+
+    function decodeRiskInfo(bytes memory data) public pure returns (IRisk.RiskInfo memory info) {
+        return abi.decode(data, (IRisk.RiskInfo));
+    }
+
+    function riskInfoToKeyValue(VersionPart majorVersion, IRisk.RiskInfo memory info) public pure returns (bytes32 key, Value memory value) {
+        return (
+            toKey32(info.id),
+            Value(majorVersion, abi.encode(info))
+        );
+    }
+
+    function valueToRiskInfo(Value memory value) public pure returns (IRisk.RiskInfo memory info) {
+        return abi.decode(value.data, (IRisk.RiskInfo));
+    }
+
+    // bundle related functions
+    function createBundleInfo(
+        NftId bundleNftId,
+        uint256 amount,
+        bytes calldata filter
+    )
+        public 
+        view
+        returns(IBundle.BundleInfo memory info)
+    {
+        uint256 lifetime = 30 * 24 * 3600;
+        return IBundle.BundleInfo(
+            bundleNftId,
+            toNftId(123456),
+            ACTIVE(),
+            filter,
+            amount,
+            0,
+            amount,
+            blockTimestamp().addSeconds(lifetime), // expiredAt
+            zeroTimestamp()); // closedAt
+    }
+
+    function nftIdToKey(NftId nftId) public pure returns(bytes32 key) {
+        return keccak256(abi.encode(BUNDLE(), nftId));
+    }
+
+    function nftIdToKeyPacked(NftId nftId) public pure returns(bytes32 key) {
+        return keccak256(abi.encodePacked(BUNDLE(), nftId));
+    }
+
+    function bundleInfoToValue(VersionPart majorVersion, IBundle.BundleInfo memory info) public pure returns (Value memory value) {
+        return Value(majorVersion, abi.encode(info));
+    }
+
+    function valueToBundleInfo(Value memory value) public pure returns (IBundle.BundleInfo memory info) {
+        return abi.decode(value.data, (IBundle.BundleInfo));
+    }
+
+    function encodeBundleInfo(IBundle.BundleInfo memory info) public pure returns (bytes memory data) {
+        return abi.encode(info);
+    }
+
+    function decodeBundleInfo(bytes memory data) public pure returns (IBundle.BundleInfo memory info) {
+        return abi.decode(data, (IBundle.BundleInfo));
+    }
+}

package/contracts/experiment/statemachine/Dummy.sol

@@ -0,0 +1,27 @@
+// 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

@@ -0,0 +1,25 @@
+// 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

@@ -0,0 +1,112 @@
+# 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

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

@@ -0,0 +1,31 @@
+// 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/instance/IInstance.sol

@@ -1,18 +1,53 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {IRegisterable} from "../registry/IRegistry.sol";
-import {IAccessModule} from "./access/IAccess.sol";
-import {IComponentModule} from "./component/IComponent.sol";
-import {IProductModule} from "./product/IProductService.sol";
-import {IPolicyModule} from "./policy/IPolicy.sol";
-import {IPoolModule} from "./pool/IPoolModule.sol";
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 
+
+import {IVersionable} from "../shared/IVersionable.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {IOwnable} from "../shared/IOwnable.sol";
+import {RoleId} from "../types/RoleId.sol";
+
+import {IAccessModule} from "./module/access/IAccess.sol";
+import {IBundleModule} from "./module/bundle/IBundle.sol";
+import {ICompensationModule} from "./module/compensation/ICompensation.sol";
+import {ILifecycleModule} from "./module/lifecycle/ILifecycle.sol";
+import {IComponentModule} from "./module/component/IComponent.sol";
+import {IPolicyModule} from "./module/policy/IPolicy.sol";
+import {IPoolModule} from "./module/pool/IPoolModule.sol";
+import {IRiskModule} from "./module/risk/IRisk.sol";
+import {ITreasuryModule} from "./module/treasury/ITreasury.sol";
+
+import {IRegistry, IRegistryLinked} from "../registry/IRegistryLinked.sol";
+import {IServiceLinked} from "./IServiceLinked.sol";
+
+import {IComponentOwnerService} from "./service/IComponentOwnerService.sol";
+import {IProductService} from "./service/IProductService.sol";
+import {IPoolService} from "./service/IPoolService.sol";
+
+
+// solhint-disable-next-line no-empty-blocks
 interface IInstance is
+    IERC165,
+    IVersionable,
     IRegisterable,
     IAccessModule,
+    ILifecycleModule,
     IPolicyModule,
     IPoolModule,
+    IBundleModule,
     IComponentModule,
-    IProductModule
-{}
+    ITreasuryModule,
+    ICompensationModule,
+    IServiceLinked
+{
+    function getRegistry() external view override (IBundleModule, IComponentModule, IPolicyModule, IRegisterable) returns (IRegistry registry);
+    function hasRole(RoleId role, address member) external view override (IAccessModule, IComponentModule) returns (bool hasRole);    
+
+    function getComponentOwnerService() external view override (IServiceLinked, IComponentModule) returns(IComponentOwnerService);
+    function getProductService() external view override (IServiceLinked, IBundleModule, IPolicyModule) returns(IProductService);
+    function getPoolService() external view override (IServiceLinked, IBundleModule, IPoolModule) returns(IPoolService);
+
+    function getOwner() external view override (IOwnable, IAccessModule) returns(address owner);
+}

package/contracts/instance/IInstanceLinked.sol

@@ -0,0 +1,8 @@
+// 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/IServiceLinked.sol

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IComponentOwnerService} from "./service/IComponentOwnerService.sol";
+import {IProductService} from "./service/IProductService.sol";
+import {IPoolService} from "./service/IPoolService.sol";
+
+interface IServiceLinked {
+    function getComponentOwnerService() external view returns(IComponentOwnerService service);
+    function getProductService() external view returns(IProductService service);
+    function getPoolService() external view returns(IPoolService service);
+}

package/contracts/instance/Instance.sol

@@ -1,64 +1,66 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {Registerable} from "../registry/Registry.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
+import {NftId} from "../types/NftId.sol";
+import {RoleId} from "../types/RoleId.sol";
+
+import {InstanceBase} from "./InstanceBase.sol";
+import {AccessModule} from "./module/access/Access.sol";
+import {CompensationModule} from "./module/compensation/CompensationModule.sol";
+import {LifecycleModule} from "./module/lifecycle/LifecycleModule.sol";
+import {ComponentModule} from "./module/component/ComponentModule.sol";
+import {PolicyModule} from "./module/policy/PolicyModule.sol";
+import {PoolModule} from "./module/pool/PoolModule.sol";
+import {RiskModule} from "./module/risk/RiskModule.sol";
+import {BundleModule} from "./module/bundle/BundleModule.sol";
+import {TreasuryModule} from "./module/treasury/TreasuryModule.sol";
 
-import {IAccessModule, AccessModule} from "./access/Access.sol";
-import {ComponentModule} from "./component/ComponentModule.sol";
-import {ProductModule} from "./product/ProductService.sol";
-import {PolicyModule} from "./policy/PolicyModule.sol";
-import {PoolModule} from "./pool/PoolModule.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {Registerable} from "../shared/Registerable.sol";
+import {IAccessModule} from "./module/access/IAccess.sol";
+import {IBundleModule} from "./module/bundle/IBundle.sol";
+import {IComponentModule} from "./module/component/IComponent.sol";
+import {IPoolModule} from "./module/pool/IPoolModule.sol";
+import {IPolicyModule} from "./module/policy/IPolicy.sol";
+import {IServiceLinked} from "./IServiceLinked.sol";
 
-import {IInstance} from "./IInstance.sol";
-import {NftId, toNftId} from "../types/NftId.sol";
+import {IComponentOwnerService} from "./service/IComponentOwnerService.sol";
+import {IProductService} from "./service/IProductService.sol";
+import {IPoolService} from "./service/IPoolService.sol";
 
 contract Instance is
-    Registerable,
+    InstanceBase,
     AccessModule,
+    BundleModule,
     ComponentModule,
+    CompensationModule,
+    LifecycleModule,
     PolicyModule,
     PoolModule,
-    ProductModule,
-    IInstance
+    RiskModule,
+    TreasuryModule
 {
     constructor(
         address registry,
-        address componentOwnerService,
-        address productService
+        NftId registryNftId
     )
-        Registerable(registry)
+        InstanceBase(registry, registryNftId)
         AccessModule()
-        ComponentModule(componentOwnerService)
-        PolicyModule(productService)
-        ProductModule(productService)
-        PoolModule(productService)
-    {}
-
-    // from registerable
-    function register() external override returns (NftId nftId) {
-        require(
-            address(_registry) != address(0),
-            "ERROR:PRD-001:REGISTRY_ZERO"
-        );
-        return _registry.register(address(this));
+        BundleModule()
+        ComponentModule()
+        PolicyModule()
+        PoolModule()
+        TreasuryModule()
+    {
     }
 
-    // from registerable
-    function getParentNftId() public view override returns (NftId) {
-        // TODO  add self registry and exchange 0 for_registry.getNftId();
-        // define parent tree for all registerables
-        // eg 0 <- chain(mainnet) <- global registry <- chain registry <- instance <- component <- policy/bundle
-        return toNftId(0);
-    }
+    function getRegistry() public view override (Registerable, IBundleModule, IComponentModule, IPolicyModule) returns (IRegistry registry) { return super.getRegistry(); }
 
-    // from registerable
-    function getType() external view override returns (uint256 objectType) {
-        return _registry.INSTANCE();
-    }
+    function hasRole(RoleId role, address member) public view override (AccessModule, IComponentModule) returns (bool) { return super.hasRole(role, member); }
 
-    // from registerable
-    function getData() external view override returns (bytes memory data) {
-        return bytes(abi.encode(0));
-    }
+    function getComponentOwnerService() external view override (IComponentModule, IServiceLinked) returns(IComponentOwnerService service) { return _componentOwnerService; }
+    function getProductService() external view override (IBundleModule, IPolicyModule, IServiceLinked) returns(IProductService service) { return _productService; }
+    function getPoolService() external view override (IBundleModule, IPoolModule, IServiceLinked) returns(IPoolService service) { return _poolService; }
+
+    function getOwner() public view override (IAccessModule, Registerable) returns(address owner) { return super.getOwner(); }
 }