@etherisc/gif-next 0.0.2-e37834a-021 → 0.0.2-e43a6c3-340

package/contracts/test/TestRoleId.sol

@@ -4,7 +4,7 @@ pragma solidity ^0.8.19;
 import {RoleId, RoleIdLib, PRODUCT_OWNER_ROLE_NAME, PRODUCT_OWNER_ROLE, POOL_OWNER_ROLE_NAME, POOL_OWNER_ROLE} from "../../contracts/types/RoleId.sol";
 
 contract TestRoleId {
-    function getRole(string memory roleName) external pure returns (RoleId) { return RoleIdLib.toRoleId(roleName); }
+    function getRole(uint256 roleNum) external pure returns (RoleId) { return RoleIdLib.toRoleId(roleNum); }
 
     function getProductOwnerRoleName() external pure returns (string memory) { return PRODUCT_OWNER_ROLE_NAME(); }
     function getProductOwnerRole() external pure returns (RoleId) { return PRODUCT_OWNER_ROLE(); } 

package/contracts/test/TestService.sol

@@ -3,21 +3,19 @@ pragma solidity ^0.8.19;
 
 import {NftId} from "../../contracts/types/NftId.sol";
 import {Version, VersionLib} from "../../contracts/types/Version.sol";
-import {ServiceBase} from "../../contracts/instance/base/ServiceBase.sol";
+import {Service} from "../../contracts/shared/Service.sol";
 
 import {IVersionable} from "../../contracts/shared/IVersionable.sol";
 import {Versionable} from "../../contracts/shared/Versionable.sol";
 
-//import {IService} from "../../contracts/instance/base/IService.sol";
-
-contract TestService is ServiceBase {
+contract TestService is Service {
 
     string public constant NAME = "TestService";
 
     constructor(address registry, NftId registryNftId, address initialOwner)
     // solhint-disable-next-line no-empty-blocks
     {
-        _initializeServiceBase(registry, registryNftId, initialOwner);
+        _initializeService(registry, initialOwner);
     }
 
     function getName() public pure override returns(string memory name) {

package/contracts/types/DistributorType.sol

@@ -0,0 +1,55 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {NftId} from "./NftId.sol";
+import {DISTRIBUTION_TYPE} from "./ObjectType.sol";
+
+type DistributorType is bytes8;
+
+// type bindings
+using {
+    eqDistributorType as ==,
+    neDistributorType as !=,
+    DistributorTypeLib.toKey32
+} for DistributorType global;
+
+// general pure free functions
+
+// pure free functions for operators
+function eqDistributorType(
+    DistributorType a, 
+    DistributorType b
+) pure returns (bool isSame) {
+    return DistributorType.unwrap(a) == DistributorType.unwrap(b);
+}
+
+function neDistributorType(
+    DistributorType a,
+    DistributorType b
+) pure returns (bool isDifferent) {
+    return DistributorType.unwrap(a) != DistributorType.unwrap(b);
+}
+
+// library functions that operate on user defined type
+library DistributorTypeLib {
+
+    function zero() public pure returns (DistributorType) {
+        return DistributorType.wrap(bytes8(0));
+    }
+
+    // @dev Converts a referral string into an id.
+    function toDistributorType(NftId distributionNftId, string memory name) public pure returns (DistributorType) {
+        return DistributorType.wrap(bytes8(keccak256(abi.encode(distributionNftId, name))));
+    }
+
+    /// @dev Returns the key32 value for the specified nft id and object type.
+    function toKey32(DistributorType id) public pure returns (Key32 key) {
+        return Key32Lib.toKey32(DISTRIBUTION_TYPE(), toKeyId(id));
+    }
+
+    /// @dev Returns the key id value for the specified nft id
+    function toKeyId(DistributorType id) public pure returns (KeyId keyId) {
+        return KeyId.wrap(bytes31(DistributorType.unwrap(id)));
+    }
+}

package/contracts/types/Fee.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {UFixed, UFixedMathLib} from "./UFixed.sol";
+import {UFixed, UFixedLib} from "./UFixed.sol";
 
 struct Fee {
     UFixed fractionalFee;
@@ -21,7 +21,7 @@ library FeeLib {
             uint256 netAmount
         )
     {
-        UFixed fractionalAmount = UFixedMathLib.toUFixed(amount) *
+        UFixed fractionalAmount = UFixedLib.toUFixed(amount) *
             fee.fractionalFee;
         feeAmount = fractionalAmount.toInt() + fee.fixedFee;
         netAmount = amount - feeAmount;
@@ -37,7 +37,7 @@ library FeeLib {
 
     /// @dev Return the percent fee struct (x%, 0)
     function percentageFee(uint8 percent) public pure returns (Fee memory fee) {
-        return Fee(UFixedMathLib.toUFixed(percent, -2), 0);
+        return Fee(UFixedLib.toUFixed(percent, -2), 0);
     }
 
     /// @dev Return a zero fee struct (0, 0)

package/contracts/types/Key32.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 import {ObjectType} from "./ObjectType.sol";
 
@@ -10,7 +10,8 @@ type KeyId is bytes31;
 using {
     eqKey32 as ==, 
     neKey32 as !=,
-    Key32Lib.toKey
+    Key32Lib.toKeyId,
+    Key32Lib.toObjectType
 } for Key32 global;
 
 // @dev Returns true iff keys are identical
@@ -37,9 +38,13 @@ library Key32Lib {
         return Key32.wrap(bytes32(uintKey));
     }
 
-    function toKey(Key32 key) public pure returns (ObjectType objectType, KeyId id) {
+    function toObjectType(Key32 key) public pure returns (ObjectType objectType) {
         bytes32 key32 = Key32.unwrap(key);
         objectType = ObjectType.wrap(uint8(uint256(key32 & TYPE_MASK) >> TYPE_SHIFT));
+    }
+
+    function toKeyId(Key32 key) public pure returns (KeyId id) {
+        bytes32 key32 = Key32.unwrap(key);
         id = KeyId.wrap(bytes31((key32 & ID_MASK) << ID_SHIFT));
     }
 }

package/contracts/types/NumberId.sol

@@ -0,0 +1,52 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+// uint32 allows for 4'294'967'296 individual items
+type NumberId is uint32;
+
+// type bindings
+using {
+    eqNumberId as ==, 
+    neNumberId as !=, 
+    NumberIdLib.eqz,
+    NumberIdLib.gtz,
+    NumberIdLib.toInt
+} for NumberId global;
+
+
+// pure free functions for operators
+function eqNumberId(NumberId a, NumberId b) pure returns (bool isSame) {
+    return NumberId.unwrap(a) == NumberId.unwrap(b);
+}
+
+function neNumberId(NumberId a, NumberId b) pure returns (bool isDifferent) {
+    return NumberId.unwrap(a) != NumberId.unwrap(b);
+}
+
+// library functions that operate on user defined type
+library NumberIdLib {
+    /// @dev Converts the NumberId to a uint.
+    function zero() public pure returns (NumberId) {
+        return NumberId.wrap(0);
+    }
+
+    /// @dev Converts an uint into a NumberId.
+    function toNumberId(uint256 a) public pure returns (NumberId) {
+        return NumberId.wrap(uint32(a));
+    }
+
+    /// @dev Converts the NumberId to a uint.
+    function toInt(NumberId a) public pure returns (uint32) {
+        return uint32(NumberId.unwrap(a));
+    }
+
+    /// @dev Returns true if the value is non-zero (> 0).
+    function gtz(NumberId a) public pure returns (bool) {
+        return NumberId.unwrap(a) > 0;
+    }
+
+    /// @dev Returns true if the value is zero (== 0).
+    function eqz(NumberId a) public pure returns (bool) {
+        return NumberId.unwrap(a) == 0;
+    }
+}

package/contracts/types/ObjectType.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 type ObjectType is uint8;
 
@@ -17,34 +17,47 @@ function PROTOCOL() pure returns (ObjectType) {
     return toObjectType(10);
 }
 
-function REGISTRY() pure returns (ObjectType) {
+function ROLE() pure returns (ObjectType) {
     return toObjectType(20);
 }
 
-function TOKEN() pure returns (ObjectType) {
+function TARGET() pure returns (ObjectType) {
     return toObjectType(30);
 }
 
-function SERVICE() pure returns (ObjectType) {
+function REGISTRY() pure returns (ObjectType) {
     return toObjectType(40);
 }
 
-function INSTANCE() pure returns (ObjectType) {
+function TOKEN() pure returns (ObjectType) {
     return toObjectType(50);
 }
 
-function STAKE() pure returns (ObjectType) {
+function SERVICE() pure returns (ObjectType) {
     return toObjectType(60);
 }
 
+function INSTANCE() pure returns (ObjectType) {
+    return toObjectType(70);
+}
+
+function STAKE() pure returns (ObjectType) {
+    return toObjectType(80);
+}
+
 function COMPONENT() pure returns (ObjectType) {
     return toObjectType(100);
 }
 
+// TODO replace by PRODUCT_SETUP
 function TREASURY() pure returns (ObjectType) {
     return toObjectType(101);
 }
 
+function PRODUCT_SETUP() pure returns (ObjectType) {
+    return toObjectType(101);
+}
+
 function PRODUCT() pure returns (ObjectType) {
     return toObjectType(110);
 }
@@ -53,6 +66,18 @@ function DISTRIBUTION() pure returns (ObjectType) {
     return toObjectType(120);
 }
 
+function DISTRIBUTION_TYPE() pure returns (ObjectType) {
+    return toObjectType(121);
+}
+
+function DISTRIBUTOR() pure returns (ObjectType) {
+    return toObjectType(122);
+}
+
+function REFERRAL() pure returns (ObjectType) {
+    return toObjectType(123);
+}
+
 function ORACLE() pure returns (ObjectType) {
     return toObjectType(130);
 }
@@ -69,20 +94,16 @@ function POLICY() pure returns (ObjectType) {
     return toObjectType(210);
 }
 
-function REFERRAL() pure returns (ObjectType) {
-    return toObjectType(212);
+function BUNDLE() pure returns (ObjectType) {
+    return toObjectType(220);
 }
 
 function CLAIM() pure returns (ObjectType) {
-    return toObjectType(214);
+    return toObjectType(211);
 }
 
 function PAYOUT() pure returns (ObjectType) {
-    return toObjectType(216);
-}
-
-function BUNDLE() pure returns (ObjectType) {
-    return toObjectType(220);
+    return toObjectType(212);
 }
 
 /// @dev Converts the uint8 to a ObjectType.

package/contracts/types/Referral.sol

@@ -0,0 +1,85 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {NftId} from "./NftId.sol";
+import {REFERRAL} from "./ObjectType.sol";
+
+type ReferralId is bytes8;
+type ReferralStatus is uint8;
+
+// type bindings
+using {
+    eqReferralId as ==, 
+    neReferralId as !=,
+    ReferralLib.toKey32
+} for ReferralId global;
+
+using {
+    eqReferralStatus as ==, 
+    neReferralStatus as !=
+} for ReferralStatus global;
+
+// general pure free functions
+
+// @dev Returns true iff a and b are identical
+function eqReferralId(ReferralId a, ReferralId b) pure returns (bool isSame) {
+    return ReferralId.unwrap(a) == ReferralId.unwrap(b);
+}
+
+// @dev Returns true iff a and b are different
+function neReferralId(ReferralId a, ReferralId b) pure returns (bool isDifferent) {
+    return ReferralId.unwrap(a) != ReferralId.unwrap(b);
+}
+
+// @dev Returns true iff a and b are identical
+function eqReferralStatus(ReferralStatus a, ReferralStatus b) pure returns (bool isSame) {
+    return ReferralStatus.unwrap(a) == ReferralStatus.unwrap(b);
+}
+
+// @dev Returns true iff a and b are different
+function neReferralStatus(ReferralStatus a, ReferralStatus b) pure returns (bool isDifferent) {
+    return ReferralStatus.unwrap(a) != ReferralStatus.unwrap(b);
+}
+
+function REFERRAL_OK() pure returns (ReferralStatus) {
+    return ReferralStatus.wrap(10);
+}
+
+function REFERRAL_ERROR_UNKNOWN() pure returns (ReferralStatus) {
+    return ReferralStatus.wrap(100);
+}
+
+function REFERRAL_ERROR_EXPIRED() pure returns (ReferralStatus) {
+    return ReferralStatus.wrap(110);
+}
+
+function REFERRAL_ERROR_EXHAUSTED() pure returns (ReferralStatus) {
+    return ReferralStatus.wrap(120);
+}
+
+library ReferralLib {
+
+    function zero() public pure returns (ReferralId) {
+        return ReferralId.wrap(bytes8(0));
+    }
+
+    // @dev Converts a referral string into an id.
+    function toReferralId(NftId distributionNftId, string memory referral) public pure returns (ReferralId) {
+        return ReferralId.wrap(bytes8(keccak256(abi.encode(distributionNftId, referral))));
+    }
+
+    function toReferralStatus(uint8 status) public pure returns (ReferralStatus) {
+        return ReferralStatus.wrap(status);
+    }
+
+    /// @dev Returns the key32 value for the specified nft id and object type.
+    function toKey32(ReferralId id) public pure returns (Key32 key) {
+        return Key32Lib.toKey32(REFERRAL(), toKeyId(id));
+    }
+
+    /// @dev Returns the key id value for the specified nft id
+    function toKeyId(ReferralId id) public pure returns (KeyId keyId) {
+        return KeyId.wrap(bytes31(ReferralId.unwrap(id)));
+    }
+}

package/contracts/types/RoleId.sol

@@ -1,12 +1,19 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-type RoleId is bytes8;
+import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {ROLE} from "./ObjectType.sol";
+
+type RoleId is uint64;
 
 // type bindings
 using {
     eqRoleId as ==, 
-    neRoleId as !=
+    neRoleId as !=,
+    RoleIdLib.eqz,
+    RoleIdLib.gtz,
+    RoleIdLib.toInt,
+    RoleIdLib.toKey32
 } for RoleId global;
 
 // general pure free functions
@@ -15,10 +22,24 @@ function ORACLE_OWNER_ROLE_NAME() pure returns (string memory) { return "OracleO
 function POOL_OWNER_ROLE_NAME() pure returns (string memory) { return "PoolOwnerRole"; }
 function PRODUCT_OWNER_ROLE_NAME() pure returns (string memory) { return "ProductOwnerRole"; }
 
-function DISTRIBUTION_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId("DistributionOwnerRole"); }
-function ORACLE_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId("OracleOwnerRole"); }
-function POOL_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId("PoolOwnerRole"); }
-function PRODUCT_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId("ProductOwnerRole"); }
+function ADMIN_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(0); }
+
+// TODO correct numbers (maybe they are already defined in RegistryService)
+function DISTRIBUTION_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(100); }
+function ORACLE_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(200); }
+function POOL_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(300); }
+function PRODUCT_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(400); }
+
+function DISTRIBUTION_REGISTRAR_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1000); }
+function POLICY_REGISTRAR_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1100); }
+function BUNDLE_REGISTRAR_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1200); }
+function POOL_REGISTRAR_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1300); }
+function PRODUCT_REGISTRAR_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1400); }
+
+function DISTRIBUTION_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(10000); }
+function POOL_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(10100); }
+
+function INSTANCE_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(11000); }
 
 // @dev Returns true iff role ids a and b are identical
 function eqRoleId(RoleId a, RoleId b) pure returns (bool isSame) {
@@ -31,8 +52,38 @@ function neRoleId(RoleId a, RoleId b) pure returns (bool isDifferent) {
 }
 
 library RoleIdLib {
-    // @dev Converts a role string into a role id.
-    function toRoleId(string memory role) public pure returns (RoleId) {
-        return RoleId.wrap(bytes8(keccak256(abi.encode(role))));
+/// @dev Converts the RoleId to a uint.
+    function zero() public pure returns (RoleId) {
+        return RoleId.wrap(0);
+    }
+
+    /// @dev Converts an uint into a RoleId.
+    function toRoleId(uint256 a) public pure returns (RoleId) {
+        return RoleId.wrap(uint64(a));
+    }
+
+    /// @dev Converts the RoleId to a uint.
+    function toInt(RoleId a) public pure returns (uint64) {
+        return uint64(RoleId.unwrap(a));
+    }
+
+    /// @dev Returns true if the value is non-zero (> 0).
+    function gtz(RoleId a) public pure returns (bool) {
+        return RoleId.unwrap(a) > 0;
+    }
+
+    /// @dev Returns true if the value is zero (== 0).
+    function eqz(RoleId a) public pure returns (bool) {
+        return RoleId.unwrap(a) == 0;
+    }
+
+    /// @dev Returns the key32 value for the specified id and object type.
+    function toKey32(RoleId a) public pure returns (Key32 key) {
+        return Key32Lib.toKey32(ROLE(), toKeyId(a));
+    }
+
+    /// @dev Returns the key id value for the specified id
+    function toKeyId(RoleId a) public pure returns (KeyId keyId) {
+        return KeyId.wrap(bytes31(uint248(RoleId.unwrap(a))));
     }
 }

package/contracts/types/StateId.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
 // uint96 allows for chain ids up to 13 digits
 type StateId is uint8;
@@ -58,6 +58,10 @@ function PAID() pure returns (StateId) {
     return toStateId(220);
 }
 
+function KEEP_STATE() pure returns (StateId) {
+    return toStateId(type(uint8).max);
+}
+
 /// @dev Converts the uint8 to a StateId.
 function toStateId(uint256 id) pure returns (StateId) {
     return StateId.wrap(uint8(id));

package/contracts/types/Timestamp.sol

@@ -50,9 +50,9 @@ 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) {
@@ -60,6 +60,10 @@ function zeroTimestamp() pure returns (Timestamp) {
 }
 
 library TimestampLib {
+    function blockTimestamp() public view returns (Timestamp) {
+        return Timestamp.wrap(uint40(block.timestamp));
+    }
+    
     /// @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);