@etherisc/gif-next 0.0.2-da77c50-824 → 0.0.2-dc7e4cb-141

package/contracts/shared/Versionable.sol

@@ -3,13 +3,12 @@ pragma solidity ^0.8.19;
 
 import {Blocknumber, blockNumber} from "../types/Blocknumber.sol";
 import {Timestamp, blockTimestamp} from "../types/Timestamp.sol";
-import {Version, VersionPart, zeroVersion} from "../types/Version.sol";
+import {Version, VersionPart} from "../types/Version.sol";
 
 import {IVersionable} from "./IVersionable.sol";
 
 abstract contract Versionable is IVersionable {
 
-
     mapping(Version version => VersionInfo info) private _versionHistory;
     Version [] private _versions;
 
@@ -58,8 +57,8 @@ abstract contract Versionable is IVersionable {
             thisVersion,
             implementation,
             activatedBy,
-            blockNumber(),
-            blockTimestamp()
+            blockTimestamp(),
+            blockNumber()
         );
 
         emit LogVersionableActivated(thisVersion, implementation, activatedBy);
@@ -80,13 +79,11 @@ abstract contract Versionable is IVersionable {
 
 
     function getVersion(uint256 idx) external view override returns(Version) {
-        require(idx < _versions.length, "ERROR:VRN-010:INDEX_TOO_LARGE");
         return _versions[idx];
     }
 
 
     function getVersionInfo(Version _version) external override view returns(VersionInfo memory) {
-        require(isActivated(_version), "ERROR:VRN-020:VERSION_UNKNOWN");
         return _versionHistory[_version];
     }
 }

package/contracts/test/TestFee.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.19;
 
 import {UFixed, UFixedMathLib} from "../types/UFixed.sol";
-import {Fee, toFee, zeroFee} from "../types/Fee.sol";
+import {Fee, FeeLib} from "../types/Fee.sol";
 
 contract TestFee {
 
@@ -15,11 +15,11 @@ contract TestFee {
         pure 
         returns(Fee memory fee)
     {
-        return toFee(UFixedMathLib.toUFixed(fractionalValue, exponent), fixedValue);
+        return FeeLib.toFee(UFixedMathLib.toUFixed(fractionalValue, exponent), fixedValue);
     }
 
     function getZeroFee() external pure returns(Fee memory fee) {
-        return zeroFee();
+        return FeeLib.zeroFee();
     }
 
 }

package/contracts/test/TestPool.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.19;
 
 import {NftId} from "../../contracts/types/NftId.sol";
 import {UFixed} from "../../contracts/types/UFixed.sol";
-import {Fee, zeroFee} from "../../contracts/types/Fee.sol";
+import {Fee} from "../../contracts/types/Fee.sol";
 import {Pool} from "../../contracts/components/Pool.sol";
 
 

package/contracts/test/TestProduct.sol

@@ -4,7 +4,7 @@ pragma solidity ^0.8.19;
 import {Product} from "../../contracts/components/Product.sol";
 import {NftId, toNftId} from "../../contracts/types/NftId.sol";
 import {Timestamp, blockTimestamp} from "../../contracts/types/Timestamp.sol";
-import {Fee, zeroFee} from "../../contracts/types/Fee.sol";
+import {Fee} from "../../contracts/types/Fee.sol";
 
 contract TestProduct is Product {
 

package/contracts/test/TestService.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.19;
 
 import {NftId} from "../../contracts/types/NftId.sol";
-import {Version, toVersion, toVersionPart} from "../../contracts/types/Version.sol";
+import {Version, VersionLib} from "../../contracts/types/Version.sol";
 import {ServiceBase} from "../../contracts/instance/service/ServiceBase.sol";
 
 import {IVersionable} from "../../contracts/shared/IVersionable.sol";
@@ -23,10 +23,7 @@ contract TestService is ServiceBase {
         virtual override (IVersionable, Versionable)
         returns(Version)
     {
-        return toVersion(
-            toVersionPart(3),
-            toVersionPart(0),
-            toVersionPart(0));
+        return VersionLib.toVersion(3,0,0);
     }
 
     function getName() external pure override returns(string memory name) {

package/contracts/test/TestVersion.sol

@@ -1,19 +1,16 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {Version, VersionPart, toVersion, toVersionPart, zeroVersion} from "../types/Version.sol";
+import {Version, VersionPart, VersionLib} from "../types/Version.sol";
 
 contract TestVersion {
 
     function createVersion(uint major, uint minor, uint patch) external pure returns(Version) {
-        return toVersion(
-            toVersionPart(uint8(major)),
-            toVersionPart(uint8(minor)),
-            toVersionPart(uint8(patch)));
+        return VersionLib.toVersion(major, minor, patch);
     }
 
     function createVersionPart(uint versionPart) external pure returns(VersionPart) {
-        return toVersionPart(uint8(versionPart));
+        return VersionLib.toVersionPart(uint8(versionPart));
     }
 
     function getVersionParts(Version version)
@@ -33,7 +30,7 @@ contract TestVersion {
     }
 
     function getZeroVersion() external pure returns(Version) {
-        return zeroVersion();
+        return VersionLib.zeroVersion();
     }
 
     function isSameVersion(Version a, Version b) external pure returns(bool) {

package/contracts/test/TestVersionable.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {Version, toVersion, toVersionPart} from "../../contracts/types/Version.sol";
+import {Version, VersionLib} from "../../contracts/types/Version.sol";
 import {Versionable} from "../../contracts/shared/Versionable.sol";
 
 contract TestVersionable is Versionable {
@@ -12,9 +12,6 @@ contract TestVersionable is Versionable {
         virtual override
         returns(Version)
     {
-        return toVersion(
-            toVersionPart(3),
-            toVersionPart(0),
-            toVersionPart(0));
+        return VersionLib.toVersion(3,0,0);
     }
 }

package/contracts/test/Usdc.sol

@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
+
+contract USDC is ERC20 {
+
+    // https://etherscan.io/token/0xc719d010b63e5bbf2c0551872cd5316ed26acd83#readContract
+    string public constant NAME = "USDC - DUMMY";
+    string public constant SYMBOL = "USDC";
+    uint8 public constant DECIMALS = 6;
+    uint256 public constant INITIAL_SUPPLY = 10**9 * 10**DECIMALS; // 1 Billion 1'000'000'000
+    // decimals == 18 (openzeppelin erc20 default)
+    constructor()
+        ERC20(NAME, SYMBOL)
+    {
+        _mint(
+            _msgSender(),
+            INITIAL_SUPPLY
+        );   
+    }
+
+    function decimals() public pure override returns(uint8) {
+        return DECIMALS;
+    }
+}

package/contracts/types/Fee.sol

@@ -1,32 +1,51 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {UFixed} from "./UFixed.sol";
+import {UFixed, UFixedMathLib} from "./UFixed.sol";
 
 struct Fee {
     UFixed fractionalFee;
     uint256 fixedFee;
 }
 
-// general pure free functions
-/// @dev Converts the uint256 to a NftId.
-function toFee(
-    UFixed fractionalFee,
-    uint256 fixedFee
-) pure returns (Fee memory fee) {
-    return Fee(fractionalFee, fixedFee);
-}
+library FeeLib {
 
-/// @dev Return the NftId zero (0)
-function zeroFee() pure returns (Fee memory fee) {
-    return Fee(UFixed.wrap(0), 0);
-}
+    function calculateFee(
+        uint256 amount,
+        Fee memory fee
+    )
+        public
+        pure
+        returns (
+            uint256 feeAmount, 
+            uint256 netAmount
+        )
+    {
+        UFixed fractionalAmount = UFixedMathLib.toUFixed(amount) *
+            fee.fractionalFee;
+        feeAmount = fractionalAmount.toInt() + fee.fixedFee;
+        netAmount = amount - feeAmount;
+    }
 
-// pure free functions for operators
-function feeIsSame(Fee memory a, Fee memory b) pure returns (bool isSame) {
-    return a.fixedFee == b.fixedFee && a.fractionalFee == b.fractionalFee;
-}
+    /// @dev Converts the uint256 to a fee struct.
+    function toFee(
+        UFixed fractionalFee,
+        uint256 fixedFee
+    ) public pure returns (Fee memory fee) {
+        return Fee(fractionalFee, fixedFee);
+    }
 
-function feeIsZero(Fee memory fee) pure returns (bool) {
-    return fee.fixedFee == 0 && UFixed.unwrap(fee.fractionalFee) == 0;
-}
+    /// @dev Return the zero fee struct (0, 0)
+    function zeroFee() public pure returns (Fee memory fee) {
+        return Fee(UFixed.wrap(0), 0);
+    }
+
+    // pure free functions for operators
+    function feeIsSame(Fee memory a, Fee memory b) public pure returns (bool isSame) {
+        return a.fixedFee == b.fixedFee && a.fractionalFee == b.fractionalFee;
+    }
+
+    function feeIsZero(Fee memory fee) public pure returns (bool) {
+        return fee.fixedFee == 0 && UFixed.unwrap(fee.fractionalFee) == 0;
+    }
+}

package/contracts/types/UFixed.sol

@@ -77,19 +77,25 @@ function deltaUFixed(UFixed a, UFixed b) pure returns (UFixed) {
 }
 
 library UFixedMathLib {
-    enum Rounding {
-        /// @dev Round down - floor(value)
-        Down,
-        /// @dev Round up - ceil(value)
-        Up,
-        /// @dev Round half up - round(value)
-        HalfUp
-    }
-
     int8 public constant EXP = 18;
     uint256 public constant MULTIPLIER = 10 ** uint256(int256(EXP));
     uint256 public constant MULTIPLIER_HALF = MULTIPLIER / 2;
 
+    /// @dev returns the rounding mode DOWN - 0.4 becomes 0, 0.5 becomes 0, 0.6 becomes 0
+    function ROUNDING_DOWN() public pure returns (uint8) {
+        return uint8(0);
+    }
+
+    /// @dev returns the rounding mode UP - 0.4 becomes 1, 0.5 becomes 1, 0.6 becomes 1
+    function ROUNDING_UP() public pure returns (uint8) {
+        return uint8(1);
+    }
+
+    /// @dev returns the rounding mode HALF_UP - 0.4 becomes 0, 0.5 becomes 1, 0.6 becomes 1
+    function ROUNDING_HALF_UP() public pure returns (uint8) {
+        return uint8(2);
+    }
+
     /// @dev Converts the uint256 to a UFixed.
     function toUFixed(uint256 a) public pure returns (UFixed) {
         return UFixed.wrap(a * MULTIPLIER);
@@ -103,9 +109,6 @@ library UFixedMathLib {
         return UFixed.wrap(a * 10 ** uint8(EXP + exp));
     }
 
-    /// @dev Default rounding mode used by ftoi is HalfUp
-    Rounding public constant ROUNDING_DEFAULT = Rounding.HalfUp;
-
     /// @dev returns the decimals precision of the UFixed type
     function decimals() public pure returns (uint256) {
         return uint8(EXP);
@@ -113,12 +116,12 @@ library UFixedMathLib {
 
     /// @dev Converts a UFixed to a uint256.
     function toInt(UFixed a) public pure returns (uint256) {
-        return toIntWithRounding(a, ROUNDING_DEFAULT);
+        return toIntWithRounding(a, ROUNDING_HALF_UP());
     }
 
     /// @dev Converts a UFixed to a uint256 with given rounding mode.
-    function toIntWithRounding(UFixed a, Rounding rounding) public pure returns (uint256) {
-        if (rounding == Rounding.HalfUp) {
+    function toIntWithRounding(UFixed a, uint8 rounding) public pure returns (uint256) {
+        if (rounding == ROUNDING_HALF_UP()) {
             return
                 Math.mulDiv(
                     UFixed.unwrap(a) + MULTIPLIER_HALF,
@@ -126,7 +129,7 @@ library UFixedMathLib {
                     MULTIPLIER,
                     Math.Rounding.Down
                 );
-        } else if (rounding == Rounding.Down) {
+        } else if (rounding == ROUNDING_DOWN()) {
             return
                 Math.mulDiv(
                     UFixed.unwrap(a),

package/contracts/types/Version.sol

@@ -12,7 +12,6 @@ using {
 
 function versionPartGt(VersionPart a, VersionPart b) pure returns(bool isGreaterThan) { return VersionPart.unwrap(a) > VersionPart.unwrap(b); }
 function versionPartEq(VersionPart a, VersionPart b) pure returns(bool isSame) { return VersionPart.unwrap(a) == VersionPart.unwrap(b); }
-function toVersionPart(uint8 versionPart) pure returns(VersionPart) { return VersionPart.wrap(versionPart); }
 
 library VersionPartLib {
     function toInt(VersionPart x) external pure returns(uint) { return VersionPart.unwrap(x); }
@@ -32,27 +31,6 @@ using {
 function versionGt(Version a, Version b) pure returns(bool isGreaterThan) { return Version.unwrap(a) > Version.unwrap(b); }
 function versionEq(Version a, Version b) pure returns(bool isSame) { return Version.unwrap(a) == Version.unwrap(b); }
 
-function toVersion(
-    VersionPart major,
-    VersionPart minor,
-    VersionPart patch
-)
-    pure
-    returns(Version)
-{
-    uint majorInt = major.toInt();
-    uint minorInt = minor.toInt();
-    uint patchInt = patch.toInt();
-
-    return Version.wrap(
-        uint24(
-            (majorInt << 16) + (minorInt << 8) + patchInt));
-}
-
-function zeroVersion() pure returns(Version) {
-    return toVersion(toVersionPart(0), toVersionPart(0), toVersionPart(0));
-}
-
 library VersionLib {
     function toInt(Version version) external pure returns(uint) { return Version.unwrap(version); }
 
@@ -83,9 +61,35 @@ library VersionLib {
         uint8 patchInt = uint8(versionInt - (minorInt << 8));
 
         return (
-            toVersionPart(majorInt),
-            toVersionPart(minorInt),
-            toVersionPart(patchInt)
+            VersionPart.wrap(majorInt),
+            VersionPart.wrap(minorInt),
+            VersionPart.wrap(patchInt)
         );
     }
+
+    function toVersionPart(uint256 versionPart) external pure returns(VersionPart) { 
+        return VersionPart.wrap(uint8(versionPart)); 
+    }
+
+    function toVersion(
+        uint256 major,
+        uint256 minor,
+        uint256 patch
+    )
+        external
+        pure
+        returns(Version)
+    {
+        require(
+            major < 256 && minor < 256 && patch < 256,
+            "ERROR:VRS-010:VERSION_PART_TOO_BIG");
+
+        return Version.wrap(
+            uint24(
+                (major << 16) + (minor << 8) + patch));
+    }
+
+    function zeroVersion() external pure returns(Version) {
+        return Version.wrap(0);
+    }
 }

package/package.json

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

package/artifacts/contracts/instance/module/product/IProductModule.sol/IProductModule.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../../build-info/73036ef8d3587a4d497b53a8e5f6bc33.json"
-}

package/artifacts/contracts/instance/module/product/ProductModule.sol/ProductModule.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../../build-info/73036ef8d3587a4d497b53a8e5f6bc33.json"
-}

package/contracts/instance/module/product/ProductModule.sol

@@ -1,8 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {IProductService} from "../../service/IProductService.sol";
-import {IProductModule} from "./IProductModule.sol";
-
-abstract contract ProductModule is IProductModule {
-}