@etherisc/gif-next 0.0.2-e6a90b9 → 0.0.2-e6ad61d-739

package/contracts/registry/Registry.sol

@@ -3,102 +3,105 @@ pragma solidity ^0.8.19;
 
 import {IChainNft} from "./IChainNft.sol";
 import {IRegistry, IRegistryLinked, IRegisterable} from "./IRegistry.sol";
+import {NftId, toNftId, NftIdLib} from "../types/NftId.sol";
+import {ObjectType, INSTANCE, POLICY, BUNDLE} from "../types/ObjectType.sol";
 
 contract RegistryLinked is IRegistryLinked {
-
     IRegistry internal _registry;
-    
+
     constructor(address registry) {
         _registry = IRegistry(registry);
     }
 
-    function getRegistry() external view override returns(IRegistry registry) {
+    function getRegistry() external view override returns (IRegistry registry) {
         return _registry;
     }
-
 }
 
-
-abstract contract Registerable is 
-    RegistryLinked,
-    IRegisterable
-{
+abstract contract Registerable is RegistryLinked, IRegisterable {
+    using NftIdLib for NftId;
 
     address private _initialOwner;
-    
-    constructor(address registry)
-        RegistryLinked(registry)
-    {
+
+    constructor(address registry) RegistryLinked(registry) {
         _initialOwner = msg.sender;
     }
 
     // getType, getData and register need to be implemented by concrete contract
 
-    function isRegisterable() external pure override returns(bool) {
+    function isRegisterable() external pure override returns (bool) {
         return true;
     }
 
-    function getInitialOwner() public view override returns(address deployer) {
+    function getInitialOwner() public view override returns (address deployer) {
         return _initialOwner;
     }
 
-    function isRegistered() public view override returns(bool) {
-        return _registry.getNftId(address(this)) > 0;
+    function isRegistered() public view override returns (bool) {
+        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));
+    function getOwner() public view override returns (address owner) {
+        NftId id = _registry.getNftId(address(this));
         owner = _registry.getOwner(id);
         return owner != address(0) ? owner : _initialOwner;
     }
-
 }
 
 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;
 
     function initialize(address chainNft) external {
-        require(address(_chainNft) == address(0), "ERROR:REG-001:ALREADY_INITIALIZED");
+        require(
+            address(_chainNft) == address(0),
+            "ERROR:REG-001:ALREADY_INITIALIZED"
+        );
         _chainNft = IChainNft(chainNft);
     }
 
-    function TOKEN() public pure override returns(uint256) { return 30; }
-    function INSTANCE() public pure override returns(uint256) { return 40; }
-    function PRODUCT() public pure override returns(uint256) { return 50; }
-    function ORACLE() public pure override returns(uint256) { return 60; }
-    function POOL() public pure override returns(uint256) { return 70; }
-    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");
+        require(
+            registerable.isRegisterable(),
+            "ERROR:REG-003:NOT_REGISTERABLE"
+        );
 
         // 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");
+        if (registerable.getType() != INSTANCE()) {
+            RegistryInfo memory parentInfo = _info[
+                registerable.getParentNftId()
+            ];
+            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(
-            registerable.getInitialOwner(), 
-            EMPTY_URI);
-    
+        uint256 mintedTokenId = _chainNft.mint(
+            registerable.getInitialOwner(),
+            EMPTY_URI
+        );
+        nftId = toNftId(mintedTokenId);
+
         RegistryInfo memory info = RegistryInfo(
             nftId,
             registerable.getParentNftId(),
@@ -108,30 +111,31 @@ contract Registry is IRegistry {
         );
 
         _info[nftId] = info;
-        _idByAddress[objectAddress] = nftId;
+        _nftIdByAddress[objectAddress] = nftId;
 
         // add logging
     }
 
-
     function registerObjectForInstance(
-        uint256 parentNftId,
-        uint256 objectType,
+        NftId parentNftId,
+        ObjectType objectType,
         address initialOwner
     )
-        external 
+        external
         override
-        // TODO add onlyRegisteredInstance
-        returns(uint256 nftId)
+        returns (
+            // TODO add onlyRegisteredInstance
+            NftId nftId
+        )
     {
         // TODO add more validation
         require(
             objectType == POLICY() || objectType == BUNDLE(),
-            "ERROR:REG-005:TYPE_INVALID");
+            "ERROR:REG-005:TYPE_INVALID"
+        );
 
-        nftId = _chainNft.mint(
-            initialOwner,
-            EMPTY_URI);
+        uint256 mintedTokenId = _chainNft.mint(initialOwner, EMPTY_URI);
+        nftId = toNftId(mintedTokenId);
 
         RegistryInfo memory info = RegistryInfo(
             nftId,
@@ -146,31 +150,33 @@ contract Registry is IRegistry {
         // add logging
     }
 
-
-    function getObjectCount() external view override returns(uint256) {
+    function getObjectCount() external view override returns (uint256) {
         return _chainNft.totalSupply();
     }
 
-
-    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;
+    function isRegistered(
+        address object
+    ) external view override returns (bool) {
+        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) {
+    function getNftAddress() external view override returns (address nft) {
         return address(_chainNft);
     }
 }

package/contracts/types/Blocknumber.sol

@@ -0,0 +1,118 @@
+// 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,24 +1,38 @@
 // 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
-using {
-    eqChainId as ==,
-    neChainId as !=,
-    ChainIdLib.toInt
-} for ChainId global;
+using {eqChainId as ==, neChainId as !=, ChainIdLib.toInt} for ChainId global;
 
 // general pure free functions
-function toChainId(uint256 chainId) pure returns(ChainId) { return ChainId.wrap(bytes5(uint40(chainId))); }
+/// @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
-function eqChainId(ChainId a, ChainId b) pure returns(bool isSame) { return ChainId.unwrap(a) == ChainId.unwrap(b); }
-function neChainId(ChainId a, ChainId b) pure returns(bool isDifferent) { return ChainId.unwrap(a) != ChainId.unwrap(b); }
+/// @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 {
-    function toInt(ChainId chainId) internal pure returns(uint256) { return uint256(uint40(ChainId.unwrap(chainId))); }
+    /// @dev Converts the ChainId to a uint256.
+    function toInt(ChainId chainId) internal pure returns (uint256) {
+        return uint256(uint40(ChainId.unwrap(chainId)));
+    }
 }

package/contracts/types/Fee.sol

@@ -0,0 +1,32 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {UFixed} 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);
+}
+
+/// @dev Return the NftId zero (0)
+function zeroFee() pure returns (Fee memory fee) {
+    return Fee(UFixed.wrap(0), 0);
+}
+
+// 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;
+}
+
+function feeIsZero(Fee memory fee) pure returns (bool) {
+    return fee.fixedFee == 0 && UFixed.unwrap(fee.fractionalFee) == 0;
+}

package/contracts/types/NftId.sol

@@ -5,21 +5,47 @@ pragma solidity ^0.8.19;
 type NftId is uint96;
 
 // type bindings
-using {
-    eqNftId as ==,
-    neNftId as !=,
-    NftIdLib.toInt
-} for NftId global;
+using {eqNftId as ==, neNftId as !=, NftIdLib.toInt} for NftId global;
 
 // general pure free functions
-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 Converts the uint256 to a NftId.
+function toNftId(uint256 id) pure returns (NftId) {
+    return NftId.wrap(uint96(id));
+}
+
+/// @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); }
-function neNftId(NftId a, NftId b) pure returns(bool isDifferent) { return NftId.unwrap(a) != NftId.unwrap(b); }
+function eqNftId(NftId a, NftId b) pure returns (bool isSame) {
+    return NftId.unwrap(a) == NftId.unwrap(b);
+}
+
+function neNftId(NftId a, NftId b) pure returns (bool isDifferent) {
+    return NftId.unwrap(a) != NftId.unwrap(b);
+}
 
 // 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/ObjectType.sol

@@ -0,0 +1,107 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+// uint96 allows for chain ids up to 13 digits
+type ObjectType is uint8;
+
+// type bindings
+using {
+    eqObjectType as ==,
+    neObjectType as !=,
+    ObjectTypeLib.toInt
+} for ObjectType global;
+
+// general pure free functions
+
+function PROTOCOL() pure returns (ObjectType) {
+    return toObjectType(10);
+}
+
+function CHAIN() pure returns (ObjectType) {
+    return toObjectType(20);
+}
+
+function REGISTRY() pure returns (ObjectType) {
+    return toObjectType(30);
+}
+
+function TOKEN() pure returns (ObjectType) {
+    return toObjectType(40);
+}
+
+function INSTANCE() pure returns (ObjectType) {
+    return toObjectType(50);
+}
+
+function PRODUCT() pure returns (ObjectType) {
+    return toObjectType(60);
+}
+
+function ORACLE() pure returns (ObjectType) {
+    return toObjectType(70);
+}
+
+function POOL() pure returns (ObjectType) {
+    return toObjectType(80);
+}
+
+function BUNDLE() pure returns (ObjectType) {
+    return toObjectType(81);
+}
+
+function POLICY() pure returns (ObjectType) {
+    return toObjectType(90);
+}
+
+function CLAIM() pure returns (ObjectType) {
+    return toObjectType(91);
+}
+
+function PAYOUT() pure returns (ObjectType) {
+    return toObjectType(92);
+}
+
+/// @dev Converts the uint8 to a ObjectType.
+function toObjectType(uint256 objectType) pure returns (ObjectType) {
+    return ObjectType.wrap(uint8(objectType));
+}
+
+/// @dev Return the ObjectType zero (0)
+function zeroObjectType() pure returns (ObjectType) {
+    return ObjectType.wrap(0);
+}
+
+// pure free functions for operators
+function eqObjectType(ObjectType a, ObjectType b) pure returns (bool isSame) {
+    return ObjectType.unwrap(a) == ObjectType.unwrap(b);
+}
+
+function neObjectType(
+    ObjectType a,
+    ObjectType b
+) pure returns (bool isDifferent) {
+    return ObjectType.unwrap(a) != ObjectType.unwrap(b);
+}
+
+// library functions that operate on user defined type
+library ObjectTypeLib {
+    /// @dev Converts the NftId to a uint256.
+    function toInt(ObjectType objectType) public pure returns (uint96) {
+        return uint96(ObjectType.unwrap(objectType));
+    }
+
+    /// @dev Returns true if the value is non-zero (> 0).
+    function gtz(ObjectType a) public pure returns (bool) {
+        return ObjectType.unwrap(a) > 0;
+    }
+
+    /// @dev Returns true if the value is zero (== 0).
+    function eqz(ObjectType a) public pure returns (bool) {
+        return ObjectType.unwrap(a) == 0;
+    }
+
+    /// @dev Returns true if the values are equal (==).
+    function eq(ObjectType a, ObjectType b) public pure returns (bool isSame) {
+        return eqObjectType(a, b);
+    }
+}