@etherisc/gif-next 0.0.2-e6a90b9 → 0.0.2-eb7397c

package/contracts/registry/Registry.sol

@@ -3,6 +3,8 @@ pragma solidity ^0.8.19;
 
 import {IChainNft} from "./IChainNft.sol";
 import {IRegistry, IRegistryLinked, IRegisterable} from "./IRegistry.sol";
+import {NftId, toNftId} from "../types/NftId.sol";
+import {NftIdLib} from "../types/NftId.sol";
 
 contract RegistryLinked is IRegistryLinked {
 
@@ -23,6 +25,7 @@ abstract contract Registerable is
     RegistryLinked,
     IRegisterable
 {
+    using NftIdLib for NftId;
 
     address private _initialOwner;
     
@@ -43,15 +46,16 @@ abstract contract Registerable is
     }
 
     function isRegistered() public view override returns(bool) {
-        return _registry.getNftId(address(this)) > 0;
+        NftId nftId = _registry.getNftId(address(this));
+        return nftId.gtz();
     }
 
-    function getNftId() public view override returns(uint256 id) {
+    function getNftId() public view override returns(NftId nftId) {
         return _registry.getNftId(address(this));
     }
 
     function getOwner() public view override returns(address owner) {
-        uint256 id = _registry.getNftId(address(this));
+        NftId id = _registry.getNftId(address(this));
         owner = _registry.getOwner(id);
         return owner != address(0) ? owner : _initialOwner;
     }
@@ -59,12 +63,12 @@ abstract contract Registerable is
 }
 
 contract Registry is IRegistry {
-
+    using NftIdLib for NftId;
     string public constant EMPTY_URI = "";
 
-    mapping(uint256 id => RegistryInfo info) private _info;
-    mapping(uint256 id => address owner) private _owner;
-    mapping(address object => uint256 id) private _idByAddress;
+    mapping(NftId nftId => RegistryInfo info) private _info;
+    mapping(NftId nftId => address owner) private _owner;
+    mapping(address object => NftId nftId) private _nftIdByAddress;
 
     IChainNft private _chainNft;
 
@@ -81,8 +85,8 @@ contract Registry is IRegistry {
     function POLICY() public pure override returns(uint256) { return 80; }
     function BUNDLE() public pure override returns(uint256) { return 90; }
 
-    function register(address objectAddress) external override returns(uint256 nftId) {
-        require(_idByAddress[objectAddress] == 0, "ERROR:REG-002:ALREADY_REGISTERED");
+    function register(address objectAddress) external override returns(NftId nftId) {
+        require(_nftIdByAddress[objectAddress].eqz(), "ERROR:REG-002:ALREADY_REGISTERED");
 
         IRegisterable registerable = IRegisterable(objectAddress);
         require(registerable.isRegisterable(), "ERROR:REG-003:NOT_REGISTERABLE");
@@ -90,14 +94,15 @@ contract Registry is IRegistry {
         // check parent exists (for objects not instances)
         if(registerable.getType() != INSTANCE()) {
             RegistryInfo memory parentInfo = _info[registerable.getParentNftId()];
-            require(parentInfo.nftId > 0, "ERROR:REG-004:PARENT_NOT_FOUND");
+            require(parentInfo.nftId.gtz(), "ERROR:REG-004:PARENT_NOT_FOUND");
             // check validity of parent relation, valid relations are
             // policy -> product, bundle -> pool, product -> instance, pool -> instance
         }
 
-        nftId = _chainNft.mint(
+        uint256 mintedTokenId = _chainNft.mint(
             registerable.getInitialOwner(), 
             EMPTY_URI);
+        nftId = toNftId(mintedTokenId);
     
         RegistryInfo memory info = RegistryInfo(
             nftId,
@@ -108,30 +113,31 @@ contract Registry is IRegistry {
         );
 
         _info[nftId] = info;
-        _idByAddress[objectAddress] = nftId;
+        _nftIdByAddress[objectAddress] = nftId;
 
         // add logging
     }
 
 
     function registerObjectForInstance(
-        uint256 parentNftId,
+        NftId parentNftId,
         uint256 objectType,
         address initialOwner
     )
         external 
         override
         // TODO add onlyRegisteredInstance
-        returns(uint256 nftId)
+        returns(NftId nftId)
     {
         // TODO add more validation
         require(
             objectType == POLICY() || objectType == BUNDLE(),
             "ERROR:REG-005:TYPE_INVALID");
 
-        nftId = _chainNft.mint(
+        uint256 mintedTokenId = _chainNft.mint(
             initialOwner,
             EMPTY_URI);
+        nftId = toNftId(mintedTokenId);
 
         RegistryInfo memory info = RegistryInfo(
             nftId,
@@ -152,22 +158,22 @@ contract Registry is IRegistry {
     }
 
 
-    function getNftId(address object) external view override returns(uint256 id) {
-        return _idByAddress[object];
+    function getNftId(address object) external view override returns(NftId id) {
+        return _nftIdByAddress[object];
     }
 
 
     function isRegistered(address object) external view override returns(bool) {
-        return _idByAddress[object] > 0;
+        return _nftIdByAddress[object].gtz();
     }
 
 
-    function getInfo(uint256 nftId) external view override returns(RegistryInfo memory info) {
+    function getInfo(NftId nftId) external view override returns(RegistryInfo memory info) {
         return _info[nftId];
     }
 
-    function getOwner(uint256 nftId) external view override returns(address) {
-        return _chainNft.ownerOf(nftId);
+    function getOwner(NftId nftId) external view override returns(address) {
+        return _chainNft.ownerOf(nftId.toInt());
     }
 
     function getNftAddress() external view override returns(address nft) {

package/contracts/types/Blocknumber.sol

@@ -0,0 +1,60 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+type Blocknumber is uint32;
+
+using {
+    gtBlocknumber as >,
+    gteBlocknumber as >=,
+    ltBlocknumber as <,
+    lteBlocknumber as <=,
+    eqBlocknumber as ==,
+    neBlocknumber as !=,
+    BlocknumberLib.toInt
+} for Blocknumber global;
+
+/// @dev return true if Blocknumber a is greater than Blocknumber b
+function gtBlocknumber(Blocknumber a, Blocknumber b) pure returns(bool) { return Blocknumber.unwrap(a) > Blocknumber.unwrap(b); }
+/// @dev return true if Blocknumber a is greater than or equal to Blocknumber b
+function gteBlocknumber(Blocknumber a, Blocknumber b) pure returns(bool) { return Blocknumber.unwrap(a) >= Blocknumber.unwrap(b); }
+
+/// @dev return true if Blocknumber a is less than Blocknumber b
+function ltBlocknumber(Blocknumber a, Blocknumber b) pure returns(bool) { return Blocknumber.unwrap(a) < Blocknumber.unwrap(b); }
+/// @dev return true if Blocknumber a is less than or equal to Blocknumber b
+function lteBlocknumber(Blocknumber a, Blocknumber b) pure returns(bool) { return Blocknumber.unwrap(a) <= Blocknumber.unwrap(b); }
+
+/// @dev return true if Blocknumber a is equal to Blocknumber b
+function eqBlocknumber(Blocknumber a, Blocknumber b) pure returns(bool) { return Blocknumber.unwrap(a) == Blocknumber.unwrap(b); }
+/// @dev return true if Blocknumber a is not equal to Blocknumber b
+function neBlocknumber(Blocknumber a, Blocknumber b) pure returns(bool) { return Blocknumber.unwrap(a) != Blocknumber.unwrap(b); }
+
+/// @dev Converts the uint256 to a Blocknumber.
+function toBlocknumber(uint256 blocknum) pure returns(Blocknumber) { return Blocknumber.wrap(uint32(blocknum)); }
+
+function blockBlocknumber() view returns(Blocknumber) { return toBlocknumber(block.number); }
+
+/// @dev Return the Blocknumber zero (0)
+function zeroBlocknumber() pure returns(Blocknumber) { return toBlocknumber(0); }
+
+/// @dev Return the current block number
+function blockNumber() view returns(Blocknumber) { return toBlocknumber(block.number); }
+
+library BlocknumberLib {
+    /// @dev return true if Blocknumber a is greater than Blocknumber b
+    function gt(Blocknumber a, Blocknumber b) public pure returns(bool isAfter) { return gtBlocknumber(a, b); }
+    /// @dev return true if Blocknumber a is greater than or equal to Blocknumber b
+    function gte(Blocknumber a, Blocknumber b) public pure returns(bool isAfterOrSame) { return gteBlocknumber(a, b); }
+    
+    /// @dev return true if Blocknumber a is less than Blocknumber b
+    function lt(Blocknumber a, Blocknumber b) public pure returns(bool isBefore) { return ltBlocknumber(a, b); }
+    /// @dev return true if Blocknumber a is less than or equal to Blocknumber b
+    function lte(Blocknumber a, Blocknumber b) public pure returns(bool isBeforeOrSame) { return lteBlocknumber(a, b); }
+
+    /// @dev return true if Blocknumber a is equal to Blocknumber b
+    function eq(Blocknumber a, Blocknumber b) public pure returns(bool isSame) { return eqBlocknumber(a, b); }
+    /// @dev return true if Blocknumber a is not equal to Blocknumber b
+    function ne(Blocknumber a, Blocknumber b) public pure returns(bool isDifferent) { return neBlocknumber(a, b); }
+
+    /// @dev converts the Blocknumber to a uint256
+    function toInt(Blocknumber blocknumber) public pure returns(uint256) { return uint256(uint32(Blocknumber.unwrap(blocknumber))); }
+}

package/contracts/types/ChainId.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-// bytes5 (uint40) allows for chain ids up to 13 digits
+/// @dev bytes5 (uint40) allows for chain ids up to 13 digits
 type ChainId is bytes5;
 
 // type bindings
@@ -12,13 +12,19 @@ using {
 } for ChainId global;
 
 // general pure free functions
+/// @dev Converts the uint256 to a ChainId.
 function toChainId(uint256 chainId) pure returns(ChainId) { return ChainId.wrap(bytes5(uint40(chainId))); }
+/// @dev Return the ChainId for the chain the contract is deployed to
+function thisChainId() view returns(ChainId) { return toChainId(block.chainid); }
 
 // pure free functions for operators
+/// @dev Returns true if the values are equal (==).
 function eqChainId(ChainId a, ChainId b) pure returns(bool isSame) { return ChainId.unwrap(a) == ChainId.unwrap(b); }
+/// @dev Returns true if the values are not equal (!=).
 function neChainId(ChainId a, ChainId b) pure returns(bool isDifferent) { return ChainId.unwrap(a) != ChainId.unwrap(b); }
 
 // library functions that operate on user defined type
 library ChainIdLib {
+    /// @dev Converts the ChainId to a uint256.
     function toInt(ChainId chainId) internal pure returns(uint256) { return uint256(uint40(ChainId.unwrap(chainId))); }
 }

package/contracts/types/NftId.sol

@@ -12,8 +12,11 @@ using {
 } for NftId global;
 
 // general pure free functions
+/// @dev Converts the uint256 to a NftId.
 function toNftId(uint256 id) pure returns(NftId) { return NftId.wrap(uint96(id)); }
-function gtz(NftId a) pure returns(bool) { return NftId.unwrap(a) > 0; }
+
+/// @dev Return the NftId zero (0)
+function zeroNftId() pure returns(NftId) { return NftId.wrap(0); }
 
 // pure free functions for operators
 function eqNftId(NftId a, NftId b) pure returns(bool isSame) { return NftId.unwrap(a) == NftId.unwrap(b); }
@@ -21,5 +24,12 @@ function neNftId(NftId a, NftId b) pure returns(bool isDifferent) { return NftId
 
 // library functions that operate on user defined type
 library NftIdLib {
-    function toInt(NftId nftId) internal pure returns(uint256) { return uint256(NftId.unwrap(nftId)); }
+    /// @dev Converts the NftId to a uint256.
+    function toInt(NftId nftId) public pure returns(uint96) { return uint96(NftId.unwrap(nftId)); }
+    /// @dev Returns true if the value is non-zero (> 0).
+    function gtz(NftId a) public pure returns(bool) { return NftId.unwrap(a) > 0; }
+    /// @dev Returns true if the value is zero (== 0).
+    function eqz(NftId a) public pure returns(bool) { return NftId.unwrap(a) == 0; }
+    /// @dev Returns true if the values are equal (==).
+    function eq(NftId a, NftId b) public pure returns(bool isSame) { return eqNftId(a, b); }
 }

package/contracts/types/Timestamp.sol

@@ -0,0 +1,55 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+type Timestamp is uint40;
+
+using {
+    gtTimestamp as >,
+    gteTimestamp as >=,
+    ltTimestamp as <,
+    lteTimestamp as <=,
+    eqTimestamp as ==,
+    neTimestamp as !=
+} for Timestamp global;
+
+/// @dev return true if Timestamp a is after Timestamp b
+function gtTimestamp(Timestamp a, Timestamp b) pure returns(bool) { return Timestamp.unwrap(a) > Timestamp.unwrap(b); }
+/// @dev return true if Timestamp a is after or equal to Timestamp b
+function gteTimestamp(Timestamp a, Timestamp b) pure returns(bool) { return Timestamp.unwrap(a) >= Timestamp.unwrap(b); }
+
+/// @dev return true if Timestamp a is before Timestamp b
+function ltTimestamp(Timestamp a, Timestamp b) pure returns(bool) { return Timestamp.unwrap(a) < Timestamp.unwrap(b); }
+/// @dev return true if Timestamp a is before or equal to Timestamp b
+function lteTimestamp(Timestamp a, Timestamp b) pure returns(bool) { return Timestamp.unwrap(a) <= Timestamp.unwrap(b); }
+
+/// @dev return true if Timestamp a is equal to Timestamp b
+function eqTimestamp(Timestamp a, Timestamp b) pure returns(bool) { return Timestamp.unwrap(a) == Timestamp.unwrap(b); }
+/// @dev return true if Timestamp a is not equal to Timestamp b
+function neTimestamp(Timestamp a, Timestamp b) pure returns(bool) { return Timestamp.unwrap(a) != Timestamp.unwrap(b); }
+
+/// @dev Converts the uint256 to a Timestamp.
+function toTimestamp(uint256 timestamp) pure returns(Timestamp) { return Timestamp.wrap(uint40(timestamp));}
+
+function blockTimestamp() view returns(Timestamp) { return toTimestamp(block.timestamp); }
+
+/// @dev Return the Timestamp zero (0)
+function zeroTimestamp() pure returns(Timestamp) { return toTimestamp(0); }
+
+library TimestampLib {
+    /// @dev return true if Timestamp a is after Timestamp b
+    function gt(Timestamp a, Timestamp b) public pure returns(bool isAfter) { return gtTimestamp(a, b); }
+    /// @dev return true if Timestamp a is after or the same than Timestamp b
+    function gte(Timestamp a, Timestamp b) public pure returns(bool isAfterOrSame) { return gteTimestamp(a, b); }
+
+    /// @dev return true if Timestamp a is before Timestamp b
+    function lt(Timestamp a, Timestamp b) public pure returns(bool isBefore) { return ltTimestamp(a, b); }
+    /// @dev return true if Timestamp a is before or the same than Timestamp b
+    function lte(Timestamp a, Timestamp b) public pure returns(bool isBeforeOrSame) { return lteTimestamp(a, b); }
+
+    /// @dev return true if Timestamp a is equal to Timestamp b
+    function eq(Timestamp a, Timestamp b) public pure returns(bool isSame) { return eqTimestamp(a, b); }
+    /// @dev return true if Timestamp a is not equal to Timestamp b
+    function ne(Timestamp a, Timestamp b) public pure returns(bool isDifferent) { return neTimestamp(a, b); }
+
+    function toInt(Timestamp timestamp) public pure returns(uint256) { return uint256(uint40(Timestamp.unwrap(timestamp))); }
+}

package/contracts/types/UFixed.sol

@@ -0,0 +1,207 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import { Math } from "@openzeppelin/contracts/utils/math/Math.sol";
+
+/// @dev UFixed is a fixed point number with 18 decimals precision.
+type UFixed is uint256;
+
+using {
+    addUFixed as +,
+    subUFixed as -,
+    mulUFixed as *,
+    divUFixed as /,
+    gtUFixed as >,
+    gteUFixed as >=,
+    ltUFixed as <,
+    lteUFixed as <=,
+    eqUFixed as ==
+} for UFixed global;
+
+function addUFixed(UFixed a, UFixed b) pure returns(UFixed) {
+    return UFixed.wrap(UFixed.unwrap(a) + UFixed.unwrap(b));
+}
+
+function subUFixed(UFixed a, UFixed b) pure returns(UFixed) {
+    require(a >= b, "ERROR:UFM-010:NEGATIVE_RESULT");
+    return UFixed.wrap(UFixed.unwrap(a) - UFixed.unwrap(b));
+}
+
+function mulUFixed(UFixed a, UFixed b) pure returns(UFixed) {
+    return UFixed.wrap(Math.mulDiv(UFixed.unwrap(a), UFixed.unwrap(b), 10 ** 18));
+}
+
+function divUFixed(UFixed a, UFixed b) pure returns(UFixed) {
+    require(UFixed.unwrap(b) > 0, "ERROR:UFM-020:DIVISOR_ZERO");
+
+    return UFixed.wrap(
+        Math.mulDiv(
+            UFixed.unwrap(a), 
+            10 ** 18,
+            UFixed.unwrap(b)));
+}
+
+function gtUFixed(UFixed a, UFixed b) pure returns(bool isGreaterThan) {
+    return UFixed.unwrap(a) > UFixed.unwrap(b);
+}
+
+function gteUFixed(UFixed a, UFixed b) pure returns(bool isGreaterThan) {
+    return UFixed.unwrap(a) >= UFixed.unwrap(b);
+}
+
+function ltUFixed(UFixed a, UFixed b) pure returns(bool isGreaterThan) {
+    return UFixed.unwrap(a) < UFixed.unwrap(b);
+}
+
+function lteUFixed(UFixed a, UFixed b) pure returns(bool isGreaterThan) {
+    return UFixed.unwrap(a) <= UFixed.unwrap(b);
+}
+
+function eqUFixed(UFixed a, UFixed b) pure returns(bool isEqual) {
+    return UFixed.unwrap(a) == UFixed.unwrap(b);
+}
+
+function gtzUFixed(UFixed a) pure returns(bool isZero) {
+    return UFixed.unwrap(a) > 0;
+}
+
+function eqzUFixed(UFixed a) pure returns(bool isZero) {
+    return UFixed.unwrap(a) == 0;
+}
+
+function deltaUFixed(UFixed a, UFixed b) pure returns(UFixed) {
+    if(a > b) {
+        return a - b;
+    }
+
+    return b - a;
+}
+
+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 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);
+    }
+
+    /// @dev Converts the uint256 to a UFixed.
+    function itof(uint256 a)
+        public
+        pure
+        returns(UFixed)
+    {
+        return UFixed.wrap(a * MULTIPLIER);
+    }
+
+    /// @dev Converts the uint256 to a UFixed with given exponent.
+    function itof(uint256 a, int8 exp)
+        public
+        pure
+        returns(UFixed)
+    {
+        require(EXP + exp >= 0, "ERROR:FM-010:EXPONENT_TOO_SMALL");
+        require(EXP + exp <= 2 * EXP, "ERROR:FM-011:EXPONENT_TOO_LARGE");
+
+        return UFixed.wrap(a * 10 ** uint8(EXP + exp));
+    }
+
+    /// @dev Converts a UFixed to a uint256.
+    function ftoi(UFixed a)
+        public
+        pure
+        returns(uint256)
+    {
+        return ftoi(a, ROUNDING_DEFAULT);
+    }
+
+    /// @dev Converts a UFixed to a uint256 with given rounding mode.
+    function ftoi(UFixed a, Rounding rounding)
+        public
+        pure
+        returns(uint256)
+    {
+        if(rounding == Rounding.HalfUp) {
+            return Math.mulDiv(UFixed.unwrap(a) + MULTIPLIER_HALF, 1, MULTIPLIER, Math.Rounding.Down);
+        } else if(rounding == Rounding.Down) {
+            return Math.mulDiv(UFixed.unwrap(a), 1, MULTIPLIER, Math.Rounding.Down);
+        } else {
+            return Math.mulDiv(UFixed.unwrap(a), 1, MULTIPLIER, Math.Rounding.Up);
+        }
+    }
+
+    /// @dev adds two UFixed numbers
+    function add(UFixed a, UFixed b) public pure returns(UFixed) {
+        return addUFixed(a, b);
+    }
+
+    /// @dev subtracts two UFixed numbers
+    function sub(UFixed a, UFixed b) public pure returns(UFixed) {
+        return subUFixed(a, b);
+    }
+
+    /// @dev multiplies two UFixed numbers
+    function mul(UFixed a, UFixed b) public pure returns(UFixed) {
+        return mulUFixed(a, b);
+    }
+
+    /// @dev divides two UFixed numbers
+    function div(UFixed a, UFixed b) public pure returns(UFixed) {
+        return divUFixed(a, b);
+    }
+
+    /// @dev return true if UFixed a is greater than UFixed b
+    function gt(UFixed a, UFixed b) public pure returns(bool isGreaterThan) {
+        return gtUFixed(a, b);
+    }
+
+    /// @dev return true if UFixed a is greater than or equal to UFixed b
+    function gte(UFixed a, UFixed b) public pure returns(bool isGreaterThan) {
+        return gteUFixed(a, b);
+    }
+
+    /// @dev return true if UFixed a is less than UFixed b
+    function lt(UFixed a, UFixed b) public pure returns(bool isGreaterThan) {
+        return ltUFixed(a, b);
+    }
+
+    /// @dev return true if UFixed a is less than or equal to UFixed b
+    function lte(UFixed a, UFixed b) public pure returns(bool isGreaterThan) {
+        return lteUFixed(a, b);
+    }
+
+    /// @dev return true if UFixed a is equal to UFixed b
+    function eq(UFixed a, UFixed b) public pure returns(bool isEqual) {
+        return eqUFixed(a, b);
+    }
+
+    /// @dev return true if UFixed a is not zero
+    function gtz(UFixed a) public pure returns(bool isZero) {
+        return gtzUFixed(a);
+    }
+
+    /// @dev return true if UFixed a is zero
+    function eqz(UFixed a) public pure returns(bool isZero) {
+        return eqzUFixed(a);
+    }
+
+    /// @dev return the absolute delta between two UFixed numbers
+    function delta(UFixed a, UFixed b) public pure returns(UFixed) {
+        return deltaUFixed(a, b);
+    }
+}

package/package.json

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