@etherisc/gif-next 0.0.2-ed4dd55 → 0.0.2-f619be3-760

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/experiment/types/TypeA.sol

@@ -23,20 +23,25 @@ a.toInt() == x.toInt() // -> no error
 type TypeA is uint248;
 
 // type bindings
-using {
-    eqTypeA as ==,
-    neTypeA as !=,
-    TypeALib.toInt
-} for TypeA global;
+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)); }
+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); }
+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)); }
+    function toInt(TypeA typeA) internal pure returns (uint256) {
+        return uint256(TypeA.unwrap(typeA));
+    }
 }

package/contracts/experiment/types/TypeB.sol

@@ -5,20 +5,25 @@ pragma solidity ^0.8.19;
 type TypeB is uint248;
 
 // type bindings
-using {
-    eqTypeB as ==,
-    addTypeB as +,
-    TypeBLib.toInt
-} for TypeB global;
+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)); }
+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)); }
+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)); }
+    function toInt(TypeB b) internal pure returns (uint256) {
+        return uint256(TypeB.unwrap(b));
+    }
 }

package/contracts/instance/IInstance.sol

@@ -3,18 +3,23 @@ pragma solidity ^0.8.19;
 
 import {IRegisterable} from "../registry/IRegistry.sol";
 import {IAccessModule} from "./access/IAccess.sol";
+import {ILifecycleModule} from "./lifecycle/ILifecycle.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 {ITreasuryModule} from "./treasury/ITreasury.sol";
 
-
+// solhint-disable-next-line no-empty-blocks
 interface IInstance is
     IRegisterable,
     IAccessModule,
+    ILifecycleModule,
     IPolicyModule,
     IPoolModule,
     IComponentModule,
-    IProductModule
-{ }
+    IProductModule,
+    ITreasuryModule
+{
 
+}

package/contracts/instance/Instance.sol

@@ -5,23 +5,28 @@ import {Registerable} from "../registry/Registry.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 
 import {IAccessModule, AccessModule} from "./access/Access.sol";
+import {LifecycleModule} from "./lifecycle/LifecycleModule.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 {TreasuryModule} from "./treasury/TreasuryModule.sol";
 
 import {IInstance} from "./IInstance.sol";
+import {ObjectType, INSTANCE} from "../types/ObjectType.sol";
+import {NftId, toNftId} from "../types/NftId.sol";
 
 contract Instance is
     Registerable,
     AccessModule,
-    ComponentModule, 
-    PolicyModule, 
+    LifecycleModule,
+    ComponentModule,
+    PolicyModule,
     PoolModule,
-    ProductModule, 
+    ProductModule,
+    TreasuryModule,
     IInstance
 {
-
     constructor(
         address registry,
         address componentOwnerService,
@@ -33,31 +38,35 @@ contract Instance is
         PolicyModule(productService)
         ProductModule(productService)
         PoolModule(productService)
-    { }
+    // solhint-disable-next-line no-empty-blocks
+    {
+
+    }
 
     // from registerable
-    function register() external override returns(uint256 id) {
-        require(address(_registry) != address(0), "ERROR:PRD-001:REGISTRY_ZERO");
+    function register() external override returns (NftId nftId) {
+        require(
+            address(_registry) != address(0),
+            "ERROR:PRD-001:REGISTRY_ZERO"
+        );
         return _registry.register(address(this));
     }
 
     // from registerable
-    function getParentNftId() public view override returns(uint256) {
+    function getParentNftId() public pure 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 0;
+        // eg 0 <- chain(mainnet) <- global registry <- chain registry <- instance <- component <- policy/bundle
+        return toNftId(0);
     }
 
     // from registerable
-    function getType() external view override returns(uint256 objectType) {
-        return _registry.INSTANCE();
+    function getType() external pure override returns (ObjectType objectType) {
+        return INSTANCE();
     }
 
     // from registerable
-    function getData() external view override returns(bytes memory data) {
+    function getData() external pure override returns (bytes memory data) {
         return bytes(abi.encode(0));
     }
-
-
 }

package/contracts/instance/access/Access.sol

@@ -7,26 +7,24 @@ import "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
 
 import {IAccessModule} from "./IAccess.sol";
 
-
-abstract contract AccessModule is
-    IAccessModule
-{
-    string constant public PRODUCT_OWNER = "ProductOwner";
-    string constant public ORACLE_OWNER = "OracleOwner";
-    string constant public POOL_OWNER = "PoolOwner";
+abstract contract AccessModule is IAccessModule {
+    string public constant PRODUCT_OWNER = "ProductOwner";
+    string public constant ORACLE_OWNER = "OracleOwner";
+    string public constant POOL_OWNER = "PoolOwner";
 
     using EnumerableSet for EnumerableSet.AddressSet;
 
     event LogAccessRoleGranted(bytes32 role, address member, bool isMember);
 
     mapping(bytes32 role => RoleInfo info) private _info;
-    bytes32 [] private _roles;
+    bytes32[] private _roles;
 
     bytes32 private immutable _productOwnerRole;
     bytes32 private immutable _oracleOwnerRole;
     bytes32 private immutable _poolOwnerRole;
 
-    mapping(bytes32 role => mapping(address member => bool isMember)) private _isRoleMember;
+    mapping(bytes32 role => mapping(address member => bool isMember))
+        private _isRoleMember;
     mapping(bytes32 role => EnumerableSet.AddressSet) private _roleMembers;
 
     modifier onlyOwner() {
@@ -40,70 +38,54 @@ abstract contract AccessModule is
         _poolOwnerRole = _createRole(POOL_OWNER);
     }
 
-    function PRODUCT_OWNER_ROLE() public view override returns(bytes32 role) { return _productOwnerRole; }
-    function ORACLE_OWNER_ROLE() public view override returns(bytes32 role) { return _oracleOwnerRole; }
-    function POOL_OWNER_ROLE() public view override returns(bytes32 role) { return _poolOwnerRole; }
+    function PRODUCT_OWNER_ROLE() public view override returns (bytes32 role) {
+        return _productOwnerRole;
+    }
+
+    function ORACLE_OWNER_ROLE() public view override returns (bytes32 role) {
+        return _oracleOwnerRole;
+    }
 
+    function POOL_OWNER_ROLE() public view override returns (bytes32 role) {
+        return _poolOwnerRole;
+    }
 
-    function createRole(string memory roleName) 
-        external
-        override
-        onlyOwner
-        returns(bytes32 role)
-    {
+    function createRole(
+        string memory roleName
+    ) external override onlyOwner returns (bytes32 role) {
         return _createRole(roleName);
     }
 
-    function _createRole(string memory roleName) 
-        internal
-        returns(bytes32 role)
-    {
-        RoleInfo memory info = RoleInfo(
-            0,
-            roleName,
-            true
-        );
+    function _createRole(
+        string memory roleName
+    ) internal returns (bytes32 role) {
+        RoleInfo memory info = RoleInfo(0, roleName, true);
 
         role = _setRoleInfo(info);
-
-        
     }
 
     // TODO move to module
-    function disableRole(bytes32 role) 
-        external
-        override
-        onlyOwner
-    {
+    function disableRole(bytes32 role) external override onlyOwner {
         RoleInfo memory info = _info[role];
         require(info.id == role, "ERROR:AOS-001:ROLE_DOES_NOT_EXIST");
 
         info.isActive = false;
         _setRoleInfo(info);
-
-        
-    }   
+    }
 
     // TODO move to module
-    function enableRole(bytes32 role) 
-        external
-        override       
-        onlyOwner
-    {
+    function enableRole(bytes32 role) external override onlyOwner {
         RoleInfo memory info = _info[role];
         require(info.id == role, "ERROR:AOS-002:ROLE_DOES_NOT_EXIST");
 
         info.isActive = true;
         _setRoleInfo(info);
+    }
 
-        
-    }   
-
-    function grantRole(bytes32 role, address member) 
-        external
-        override     
-        onlyOwner
-    {
+    function grantRole(
+        bytes32 role,
+        address member
+    ) external override onlyOwner {
         require(_info[role].id == role, "ERROR:ACM-010:ROLE_NOT_EXISTING");
         require(_info[role].isActive, "ERROR:ACM-011:ROLE_NOT_ACTIVE");
 
@@ -113,106 +95,71 @@ abstract contract AccessModule is
         emit LogAccessRoleGranted(role, member, _isRoleMember[role][member]);
     }
 
-
-    function revokeRole(bytes32 role, address member) 
-        external
-        override     
-        onlyOwner
-    {
+    function revokeRole(
+        bytes32 role,
+        address member
+    ) external override onlyOwner {
         require(_info[role].id == role, "ERROR:ACM-020:ROLE_NOT_EXISTING");
 
         _isRoleMember[role][member] = false;
         _roleMembers[role].remove(member);
-
-        
     }
 
-
-    function hasRole(bytes32 role, address member)
-        external
-        view
-        override
-        returns(bool)
-    {
+    function hasRole(
+        bytes32 role,
+        address member
+    ) external view override returns (bool) {
         return _isRoleMember[role][member];
     }
 
-
-    function getRoleInfo(bytes32 role)
-        external
-        override
-        view
-        returns(RoleInfo memory info)
-    {
+    function getRoleInfo(
+        bytes32 role
+    ) external view override returns (RoleInfo memory info) {
         return _info[role];
     }
 
-
-    function getRole(uint256 idx)
-        external
-        override
-        view
-        returns(bytes32 role)
-    {
+    function getRole(
+        uint256 idx
+    ) external view override returns (bytes32 role) {
         return _roles[idx];
     }
 
-
-    function getRoleCount()
-        external
-        override
-        view
-        returns(uint256 roles)
-    {
+    function getRoleCount() external view override returns (uint256 roles) {
         return _roles.length;
-    }        
-
-    function getRoleMemberCount(bytes32 role)
-        public
-        override
-        view
-        returns(uint256 roleMembers)
-    {
+    }
+
+    function getRoleMemberCount(
+        bytes32 role
+    ) public view override returns (uint256 roleMembers) {
         return _roleMembers[role].length();
     }
 
-    function getRoleMember(bytes32 role, uint256 idx)
-        public
-        override
-        view
-        returns(address roleMembers)
-    {
+    function getRoleMember(
+        bytes32 role,
+        uint256 idx
+    ) public view override returns (address roleMembers) {
         return _roleMembers[role].at(idx);
     }
 
-    function getRoleForName(string memory roleName)
-        public
-        override
-        pure
-        returns(bytes32 role)
-    {
+    function getRoleForName(
+        string memory roleName
+    ) public pure override returns (bytes32 role) {
         return keccak256(abi.encode(roleName));
     }
 
-
-    function _setRoleInfo(RoleInfo memory info)
-        internal
-        returns(bytes32 role)
-    {
+    function _setRoleInfo(
+        RoleInfo memory info
+    ) internal returns (bytes32 role) {
         role = info.id;
 
-        if(role == bytes32(0)) {
+        if (role == bytes32(0)) {
             role = getRoleForName(info.name);
             // TODO check that this is a new role id
 
             info.id = role;
             _roles.push(role);
-
-            
         }
 
         _info[role] = info;
-
-        
     }
 }