@etherisc/gif-next 0.0.2-b9b3e89 → 0.0.2-c4efd5e

package/contracts/experiment/errors/Require.sol

@@ -0,0 +1,38 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+contract Require {
+    error AsmallerThanB_S();
+    error AsmallerThanB_M(uint a);
+    error AsmallerThanB_L(uint a, uint b);
+
+    uint256 private _b;
+
+    constructor() {
+        _b = 42;
+    }
+
+    function isAlargerThanBRequire_S(
+        uint a
+    ) external view returns (bool isLarger) {
+        require(a > _b, "ERROR:ABC-001");
+
+        return true;
+    }
+
+    function isAlargerThanBRequire_M(
+        uint a
+    ) external view returns (bool isLarger) {
+        require(a > _b, "ERROR:ABC-002:A_IS_SMALLER");
+
+        return true;
+    }
+
+    function isAlargerThanBRequire_L(
+        uint a
+    ) external view returns (bool isLarger) {
+        require(a > _b, "ERROR:ABC-003:A_IS_SMALLER_THAN_B");
+
+        return true;
+    }
+}

package/contracts/experiment/errors/Revert.sol

@@ -0,0 +1,44 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+contract Revert {
+    error AsmallerThanB_S();
+    error AsmallerThanB_M(uint a);
+    error AsmallerThanB_L(uint a, uint b);
+
+    uint256 private _b;
+
+    constructor() {
+        _b = 42;
+    }
+
+    function isAlargerThanBRevert_S(
+        uint a
+    ) external view returns (bool isLarger) {
+        if (a <= _b) {
+            revert AsmallerThanB_S();
+        }
+
+        return true;
+    }
+
+    function isAlargerThanBRevert_M(
+        uint a
+    ) external view returns (bool isLarger) {
+        if (a <= _b) {
+            revert AsmallerThanB_M(a);
+        }
+
+        return true;
+    }
+
+    function isAlargerThanBRevert_L(
+        uint a
+    ) external view returns (bool isLarger) {
+        if (a <= _b) {
+            revert AsmallerThanB_L(a, _b);
+        }
+
+        return true;
+    }
+}

package/contracts/experiment/inheritance/A.sol

@@ -0,0 +1,53 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IA, ISharedA} from "./IA.sol";
+import {B} from "./B.sol";
+import {C} from "./C.sol";
+
+/* 
+
+# dependency graph
+
+   B <...+
+   ^     |
+   |     |
+   A --> C
+
+   - A is the main contract
+   - A provides functionality implemented by modules B and C
+   - B and C rely on functionality shared by A
+   - C accesses functionality of module B
+
+# chisel session
+
+import {A} from "./contracts/experiment/A.sol";
+A a = new A();
+uint(a.getA())
+uint(a.getB()))
+uint(a.getC())
+uint(a.getAfromB())
+uint(a.getAfromC())
+uint(a.getBfromC())
+a.setA(100);
+a.setB(10);
+a.setC(20);
+ */
+
+contract AShared is ISharedA {
+    uint256 private _x;
+
+    constructor() {
+        _x = 42;
+    }
+
+    function getA() external view override returns (uint256) {
+        return _x;
+    }
+
+    function setA(uint256 newA) external override {
+        _x = newA;
+    }
+}
+
+contract A is AShared, B, C, IA {}

package/contracts/experiment/inheritance/B.sol

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {ISharedA} from "./IA.sol";
+import {IB} from "./IB.sol";
+
+abstract contract B is ISharedA, IB {
+    // names of private variables can be re-used in inheritance
+    uint256 private _x;
+
+    constructor() {
+        _x = 1;
+    }
+
+    // access own state
+    function getB() external view override returns (uint256) {
+        return _x;
+    }
+
+    function setB(uint256 newB) external override {
+        _x = newB;
+    }
+
+    // access state from parent contract A
+    function getAfromB() external view override returns (uint256) {
+        return this.getA();
+    }
+}

package/contracts/experiment/inheritance/C.sol

@@ -0,0 +1,34 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {ISharedA} from "./IA.sol";
+import {IB} from "./IB.sol";
+import {IC} from "./IC.sol";
+
+abstract contract C is ISharedA, IC {
+    uint256 private _x;
+
+    constructor() {
+        _x = 2;
+    }
+
+    // access own state
+    function getC() external view override returns (uint256) {
+        return _x;
+    }
+
+    function setC(uint256 newC) external override {
+        _x = newC;
+    }
+
+    // access state from parent contract A
+    function getAfromC() external view override returns (uint256) {
+        return this.getA();
+    }
+
+    // access state from other module B
+    function getBfromC() external view override returns (uint256) {
+        IB b = IB(address(this));
+        return b.getB();
+    }
+}

package/contracts/experiment/inheritance/IA.sol

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IB} from "./IB.sol";
+import {IC} from "./IC.sol";
+
+interface ISharedA {
+    function getA() external view returns (uint256);
+
+    function setA(uint256 newA) external;
+}
+
+interface IA is ISharedA, IB, IC {}

package/contracts/experiment/inheritance/IB.sol

@@ -0,0 +1,10 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+interface IB {
+    function getAfromB() external view returns (uint256);
+
+    function getB() external view returns (uint256);
+
+    function setB(uint256 newA) external;
+}

package/contracts/experiment/inheritance/IC.sol

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+interface IC {
+    function getAfromC() external view returns (uint256);
+
+    function getBfromC() external view returns (uint256);
+
+    function getC() external view returns (uint256);
+
+    function setC(uint256 newA) external;
+}

package/contracts/experiment/types/TypeA.sol

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

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

@@ -8,13 +8,11 @@ import {IProductModule} from "./product/IProductService.sol";
 import {IPolicyModule} from "./policy/IPolicy.sol";
 import {IPoolModule} from "./pool/IPoolModule.sol";
 
-
 interface IInstance is
     IRegisterable,
     IAccessModule,
-    IComponentModule,
-    IProductModule,
     IPolicyModule,
-    IPoolModule
-{ }
-
+    IPoolModule,
+    IComponentModule,
+    IProductModule
+{}

package/contracts/instance/Instance.sol

@@ -11,17 +11,17 @@ import {PolicyModule} from "./policy/PolicyModule.sol";
 import {PoolModule} from "./pool/PoolModule.sol";
 
 import {IInstance} from "./IInstance.sol";
+import {NftId, toNftId} from "../types/NftId.sol";
 
 contract Instance is
     Registerable,
     AccessModule,
-    ComponentModule, 
-    PolicyModule, 
+    ComponentModule,
+    PolicyModule,
     PoolModule,
-    ProductModule, 
+    ProductModule,
     IInstance
 {
-
     constructor(
         address registry,
         address componentOwnerService,
@@ -33,31 +33,32 @@ contract Instance is
         PolicyModule(productService)
         ProductModule(productService)
         PoolModule(productService)
-    { }
+    {}
 
     // 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 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 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) {
+    function getType() external view override returns (uint256 objectType) {
         return _registry.INSTANCE();
     }
 
     // from registerable
-    function getData() external view override returns(bytes memory data) {
+    function getData() external view 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;
-
-        
     }
 }