@etherisc/gif-next 0.0.2-f034782-101 → 0.0.2-f080b71-868

package/contracts/registry/ReleaseManager.sol

@@ -6,7 +6,7 @@ import {AccessManaged} from "@openzeppelin/contracts/access/manager/AccessManage
 import {NftId} from "../types/NftId.sol";
 import {RoleId} from "../types/RoleId.sol";
 import {ObjectType, ObjectTypeLib, zeroObjectType, REGISTRY, SERVICE} from "../types/ObjectType.sol";
-import {VersionPart, VersionPartLib} from "../types/Version.sol";
+import {Version, VersionLib, VersionPart, VersionPartLib} from "../types/Version.sol";
 import {Timestamp, TimestampLib} from "../types/Timestamp.sol";
 
 import {IService} from "../shared/IService.sol";
@@ -55,19 +55,19 @@ contract ReleaseManager is AccessManaged
     RegistryAccessManager private immutable _accessManager;
     IRegistry private immutable _registry;
 
-    VersionPart immutable _initial;// first active version    
-    VersionPart _latest;// latest active version
-    VersionPart _next;// version to create and activate 
+    VersionPart immutable _initial;// first active major version    
+    VersionPart _latest;// latest active major version
+    VersionPart _next;// major version to create and activate 
 
-    mapping(VersionPart version => IRegistry.ReleaseInfo info) _release;
+    mapping(VersionPart majorVersion => IRegistry.ReleaseInfo info) _release;
 
-    mapping(VersionPart version => mapping(ObjectType serviceDomain => bytes4[])) _selectors; // registry service function selector assigned to domain 
+    mapping(VersionPart majorVersion => mapping(ObjectType serviceDomain => bytes4[])) _selectors; // registry service function selector assigned to domain 
 
     uint _awaitingRegistration; // "services left to register" counter
 
     mapping(address registryService => bool isActive) _active;
 
-    mapping(VersionPart version => bool isValid) _valid; // TODO refactor to use _active only
+    mapping(VersionPart majorVersion => bool isValid) _valid; // TODO refactor to use _active only
 
     constructor(
         RegistryAccessManager accessManager, 
@@ -146,12 +146,12 @@ contract ReleaseManager is AccessManaged
 
         IRegistry.ObjectInfo memory info = _getAndVerifyContractInfo(service, SERVICE(), msg.sender);
 
-        VersionPart version = _next;
+        VersionPart majorVersion = _next;
         ObjectType domain = REGISTRY();
-        _verifyService(service, version, domain);
+        _verifyService(service, majorVersion, domain);
         _createRelease(service.getFunctionConfigs());
         
-        nftId = _registry.registerService(info, version, domain);
+        nftId = _registry.registerService(info, majorVersion, domain);
 
         // external call
         service.linkToRegisteredNftId();
@@ -169,13 +169,13 @@ contract ReleaseManager is AccessManaged
         }
 
         IRegistry.ObjectInfo memory info = _getAndVerifyContractInfo(service, SERVICE(), msg.sender);
-        VersionPart version = getNextVersion();
-        ObjectType domain = _release[version].domains[_awaitingRegistration];// reversed registration order of services specified in RegistryService config
-        _verifyService(service, version, domain);
+        VersionPart majorVersion = getNextVersion();
+        ObjectType domain = _release[majorVersion].domains[_awaitingRegistration];// reversed registration order of services specified in RegistryService config
+        _verifyService(service, majorVersion, domain);
 
         // setup and grant unique role if service does registrations
-        bytes4[] memory selectors = _selectors[version][domain];
-        address registryService = _registry.getServiceAddress(REGISTRY(), version);
+        bytes4[] memory selectors = _selectors[majorVersion][domain];
+        address registryService = _registry.getServiceAddress(REGISTRY(), majorVersion);
         if(selectors.length > 0) {
             _accessManager.setAndGrantUniqueRole(
                 address(service), 
@@ -185,7 +185,7 @@ contract ReleaseManager is AccessManaged
         
         _awaitingRegistration--;
 
-        nftId = _registry.registerService(info, version, domain);
+        nftId = _registry.registerService(info, majorVersion, domain);
 
         // external call
         service.linkToRegisteredNftId(); 
@@ -271,8 +271,10 @@ contract ReleaseManager is AccessManaged
         view
         returns(ObjectType)
     {
-        if(service.getMajorVersion() != expectedVersion) {
-            revert UnexpectedServiceVersion(expectedVersion, service.getMajorVersion());
+        Version version = service.getVersion();
+        VersionPart majorVersion = version.toMajorPart();
+        if(majorVersion != expectedVersion) {
+            revert UnexpectedServiceVersion(expectedVersion, majorVersion);
         }
 
         if(service.getDomain() != expectedDomain) {

package/contracts/shared/IService.sol

@@ -1,18 +1,16 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {VersionPart} from "../types/Version.sol";
-import {ObjectType} from "../types/ObjectType.sol";
+import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
 import {IRegisterable} from "./IRegisterable.sol";
 import {IVersionable} from "./IVersionable.sol";
+import {ObjectType} from "../types/ObjectType.sol";
 
 interface IService is 
     IRegisterable,
-    IVersionable
+    IVersionable,
+    IAccessManaged
 {
-    error ErrorIServiceCallerUnknown(address caller);
-    
     function getDomain() external pure returns(ObjectType serviceDomain);
-    function getMajorVersion() external view returns(VersionPart majorVersion);
 }

package/contracts/shared/Service.sol

@@ -1,7 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {ObjectType, SERVICE} from "../types/ObjectType.sol";
+import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
+import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
+
+import {ObjectType, REGISTRY, SERVICE} from "../types/ObjectType.sol";
 import {NftId, zeroNftId} from "../types/NftId.sol";
 import {Version, VersionPart, VersionLib, VersionPartLib} from "../types/Version.sol";
 
@@ -18,14 +21,11 @@ import {IRegistry} from "../registry/IRegistry.sol";
 abstract contract Service is 
     Registerable,
     Versionable,
+    AccessManagedUpgradeable,
     IService
 {
-    function getDomain() public pure virtual override returns(ObjectType);
 
-    // version major version MUST be consistent with major version of getVersion()
-    function getMajorVersion() public view virtual override returns(VersionPart majorVersion) {
-        return VersionPartLib.toVersionPart(3); 
-    }
+    uint8 private constant GIF_MAJOR_VERSION = 3;
 
     // from Versionable
     function getVersion()
@@ -34,11 +34,12 @@ abstract contract Service is
         virtual override (IVersionable, Versionable)
         returns(Version)
     {
-        return VersionLib.toVersion(3,0,0);
+        return VersionLib.toVersion(GIF_MAJOR_VERSION,0,0);
     }
 
     function initializeService(
         address registry, 
+        address authority, // real authority for registry service adress(0) for other services
         address initialOwner
     )
         public
@@ -53,6 +54,19 @@ abstract contract Service is
             initialOwner, 
             ""); // data
 
+        // externally provided authority
+        if(authority != address(0)) {
+            __AccessManaged_init(authority);
+        } else {
+            address registryServiceAddress = getRegistry().getServiceAddress(
+                REGISTRY(), 
+                VersionPartLib.toVersionPart(GIF_MAJOR_VERSION));
+
+            // copy authority from already registered registry services
+            __AccessManaged_init(IAccessManaged(registryServiceAddress).authority());
+        }
+
+        registerInterface(type(IAccessManaged).interfaceId);
         registerInterface(type(IService).interfaceId);
     }
 }

package/contracts/test/TestService.sol

@@ -16,7 +16,7 @@ contract TestService is Service {
     constructor(address registry, NftId registryNftId, address initialOwner)
     // solhint-disable-next-line no-empty-blocks
     {
-        initializeService(registry, initialOwner);
+        initializeService(registry, address(0), initialOwner);
     }
 
     function getDomain() public pure override returns(ObjectType) {

package/contracts/types/Amount.sol

@@ -0,0 +1,60 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {UFixed, UFixedLib} from "./UFixed.sol";
+
+type Amount is uint96;
+
+using {
+    AmountLib.eqz,
+    AmountLib.gtz,
+    AmountLib.toInt,
+    AmountLib.toUFixed
+} for Amount global;
+
+
+library AmountLib {
+
+    error ErrorAmountLibValueTooBig(uint256 amount);
+
+    function zero() public pure returns (Amount) {
+        return Amount.wrap(0);
+    }
+
+    function max() public pure returns (Amount) {
+        return Amount.wrap(_max());
+    }
+
+    /// @dev converts the uint amount into Amount
+    /// function reverts if value is exceeding max Amount value
+    function toAmount(uint256 amount) public pure returns (Amount) {
+        if(amount > _max()) {
+            revert ErrorAmountLibValueTooBig(amount);
+        }
+
+        return Amount.wrap(uint96(amount));
+    }
+
+    /// @dev return true if amount equals 0
+    function eqz(Amount amount) public pure returns (bool) {
+        return Amount.unwrap(amount) == 0;
+    }
+
+    /// @dev return true if amount is larger than 0
+    function gtz(Amount amount) public pure returns (bool) {
+        return Amount.unwrap(amount) > 0;
+    }
+
+    function toInt(Amount amount) public pure returns (uint256) {
+        return uint256(uint96(Amount.unwrap(amount)));
+    }
+
+    function toUFixed(Amount amount) public pure returns (UFixed) {
+        return UFixedLib.toUFixed(Amount.unwrap(amount));
+    }
+
+    function _max() internal pure returns (uint96) {
+        // IMPORTANT: type nees to match with actual definition for Amount
+        return type(uint96).max;
+    }
+}

package/contracts/types/Fee.sol

@@ -21,10 +21,13 @@ library FeeLib {
             uint256 netAmount
         )
     {
-        UFixed fractionalAmount = UFixedLib.toUFixed(amount) *
-            fee.fractionalFee;
-        feeAmount = fractionalAmount.toInt() + fee.fixedFee;
-        netAmount = amount - feeAmount;
+        netAmount = amount;
+        if(gtz(fee)) {
+            UFixed fractionalAmount = 
+                UFixedLib.toUFixed(amount) * fee.fractionalFee;
+            feeAmount = fractionalAmount.toInt() + fee.fixedFee;
+            netAmount -= feeAmount;
+        }
     }
 
     /// @dev Converts the uint256 to a fee struct.
@@ -51,7 +54,11 @@ library FeeLib {
         return a.fixedFee == b.fixedFee && a.fractionalFee == b.fractionalFee;
     }
 
-    function feeIsZero(Fee memory fee) public pure returns (bool) {
+    function gtz(Fee memory fee) public pure returns (bool) {
+        return UFixed.unwrap(fee.fractionalFee) > 0 || fee.fixedFee > 0;
+    }
+
+    function eqz(Fee memory fee) public pure returns (bool) {
         return fee.fixedFee == 0 && UFixed.unwrap(fee.fractionalFee) == 0;
     }
 }

package/contracts/types/ObjectType.sol

@@ -110,6 +110,10 @@ function PAYOUT() pure returns (ObjectType) {
     return toObjectType(212);
 }
 
+function PRICE() pure returns (ObjectType) {
+    return toObjectType(230);
+}
+
 /// @dev Converts the uint8 to a ObjectType.
 function toObjectType(uint256 objectType) pure returns (ObjectType) {
     return ObjectType.wrap(uint8(objectType));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherisc/gif-next",
-  "version": "0.0.2-f034782-101",
+  "version": "0.0.2-f080b71-868",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {