@etherisc/gif-next 0.0.2-81f8acb → 0.0.2-836a512-798

package/contracts/types/Blocknumber.sol

@@ -14,47 +14,105 @@ using {
 } 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); }
+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); }
+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); }
+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); }
+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); }
+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); }
+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 toBlocknumber(uint256 blocknum) pure returns (Blocknumber) {
+    return Blocknumber.wrap(uint32(blocknum));
+}
 
-function blockBlocknumber() view returns(Blocknumber) { return toBlocknumber(block.number); }
+function blockBlocknumber() view returns (Blocknumber) {
+    return toBlocknumber(block.number);
+}
 
 /// @dev Return the Blocknumber zero (0)
-function zeroBlocknumber() pure returns(Blocknumber) { return toBlocknumber(0); }
+function zeroBlocknumber() pure returns (Blocknumber) {
+    return toBlocknumber(0);
+}
 
 /// @dev Return the current block number
-function blockNumber() view returns(Blocknumber) { return toBlocknumber(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); }
+    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); }
-    
+    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); }
+    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); }
+    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); }
+    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); }
+    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))); }
+    function toInt(Blocknumber blocknumber) public pure returns (uint256) {
+        return uint256(uint32(Blocknumber.unwrap(blocknumber)));
+    }
 }

package/contracts/types/ChainId.sol

@@ -5,26 +5,34 @@ pragma solidity ^0.8.19;
 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
 /// @dev Converts the uint256 to a ChainId.
-function toChainId(uint256 chainId) pure returns(ChainId) { return ChainId.wrap(bytes5(uint40(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); }
+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); }
+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); }
+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))); }
+    function toInt(ChainId chainId) internal pure returns (uint256) {
+        return uint256(uint40(ChainId.unwrap(chainId)));
+    }
 }

package/contracts/types/Fee.sol

@@ -0,0 +1,30 @@
+// 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,31 +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
 /// @dev Converts the uint256 to a NftId.
-function toNftId(uint256 id) pure returns(NftId) { return NftId.wrap(uint96(id)); }
+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); }
+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 {
     /// @dev Converts the NftId to a uint256.
-    function toInt(NftId nftId) public pure returns(uint96) { return uint96(NftId.unwrap(nftId)); }
+    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; }
+    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; }
+    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); }
+    function eq(NftId a, NftId b) public pure returns (bool isSame) {
+        return eqNftId(a, b);
+    }
 }

package/contracts/types/ObjectType.sol

@@ -0,0 +1,50 @@
+// 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); }
+}

package/contracts/types/StateId.sol

@@ -0,0 +1,46 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+// uint96 allows for chain ids up to 13 digits
+type StateId is uint8;
+
+// type bindings
+using {
+    eqStateId as ==,
+    neStateId as !=,
+    StateIdLib.toInt
+} for StateId global;
+
+// general pure free functions
+function APPLIED() pure returns(StateId) { return toStateId(10); }
+function REVOKED() pure returns(StateId) { return toStateId(20); }
+function DECLINED() pure returns(StateId) { return toStateId(30); }
+function CONFIRMED() pure returns(StateId) { return toStateId(40); }
+function EXPECTED() pure returns(StateId) { return toStateId(50); }
+function ACTIVE() pure returns(StateId) { return toStateId(100); }
+function PAUSED() pure returns(StateId) { return toStateId(110); }
+function CLOSED() pure returns(StateId) { return toStateId(200); }
+function ARCHIVED() pure returns(StateId) { return toStateId(210); }
+function PAID() pure returns(StateId) { return toStateId(220); }
+
+/// @dev Converts the uint8 to a StateId.
+function toStateId(uint256 id) pure returns(StateId) { return StateId.wrap(uint8(id)); }
+
+/// @dev Return the StateId zero (0)
+function zeroStateId() pure returns(StateId) { return StateId.wrap(0); }
+
+// pure free functions for operators
+function eqStateId(StateId a, StateId b) pure returns(bool isSame) { return StateId.unwrap(a) == StateId.unwrap(b); }
+function neStateId(StateId a, StateId b) pure returns(bool isDifferent) { return StateId.unwrap(a) != StateId.unwrap(b); }
+
+// library functions that operate on user defined type
+library StateIdLib {
+    /// @dev Converts the NftId to a uint256.
+    function toInt(StateId stateId) public pure returns(uint96) { return uint96(StateId.unwrap(stateId)); }
+    /// @dev Returns true if the value is non-zero (> 0).
+    function gtz(StateId a) public pure returns(bool) { return StateId.unwrap(a) > 0; }
+    /// @dev Returns true if the value is zero (== 0).
+    function eqz(StateId a) public pure returns(bool) { return StateId.unwrap(a) == 0; }
+    /// @dev Returns true if the values are equal (==).
+    function eq(StateId a, StateId b) public pure returns(bool isSame) { return eqStateId(a, b); }
+}

package/contracts/types/Timestamp.sol

@@ -13,43 +13,90 @@ using {
 } 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); }
+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); }
+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); }
+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); }
+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); }
+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); }
+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 toTimestamp(uint256 timestamp) pure returns (Timestamp) {
+    return Timestamp.wrap(uint40(timestamp));
+}
 
-function blockTimestamp() view returns(Timestamp) { return toTimestamp(block.timestamp); }
+function blockTimestamp() view returns (Timestamp) {
+    return toTimestamp(block.timestamp);
+}
 
 /// @dev Return the Timestamp zero (0)
-function zeroTimestamp() pure returns(Timestamp) { return toTimestamp(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); }
+    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); }
+    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); }
+    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); }
+    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); }
+    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 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))); }
+    function toInt(Timestamp timestamp) public pure returns (uint256) {
+        return uint256(uint40(Timestamp.unwrap(timestamp)));
+    }
 }