@etherisc/gif-next 0.0.2-dd8c542-531 → 0.0.2-ddc9ec2-570

package/contracts/shared/Versionable.sol

@@ -1,147 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
-
-import {Blocknumber, blockNumber} from "../types/Blocknumber.sol";
-import {Timestamp, TimestampLib} from "../types/Timestamp.sol";
-import {Version, VersionPart, VersionLib} from "../types/Version.sol";
-
-import {IVersionable} from "./IVersionable.sol";
-
-
-
-abstract contract Versionable is 
-    Initializable,
-    IVersionable 
-{
-    // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.shared.Versionable.sol")) - 1)) & ~bytes32(uint256(0xff))
-    bytes32 private constant VERSIONABLE_LOCATION_V1 = 0x4f61291a8ac3d020d0a7d919a76b8592aa88385744dee3f8b4f3873b969ed900;
-
-
-    /// @custom:storage-location erc7201:gif-next.contracts.shared.Versionable.sol
-    struct VersionableStorage {
-        mapping(Version version => VersionInfo info) _versionHistory;
-        Version [] _versions;
-        Version _v1;
-    }
-
-
-    constructor() {
-        _disableInitializers();
-    }
-    // TODO write test where new version of private _updateVersionHistory is added and used... 
-    function initialize(
-        address implementation,
-        address activatedBy,
-        bytes memory data
-    )
-        public
-        initializer
-    {
-        _updateVersionHistory(implementation, activatedBy);
-        _initialize(activatedBy, data);
-    }
-
-    // TODO activatedBy MUST ALWAYS be an owner?
-    function upgrade(
-        address implementation,
-        address activatedBy,
-        bytes memory data
-    )
-        external
-        reinitializer(VersionLib.toUint64(getVersion()))
-    {
-        _updateVersionHistory(implementation, activatedBy);
-        _upgrade(data);
-    }
-
-    function isInitialized(Version _version) public override view returns(bool) {
-        return _getVersionableStorage()._versionHistory[_version].activatedIn.toInt() > 0;
-    }
-
-    function getVersion() public pure virtual returns(Version);
-
-    function getVersionCount() public view override returns(uint256) {
-        return _getVersionableStorage()._versions.length;
-    }
-
-    function getVersion(uint256 idx) public view override returns(Version) {
-        return _getVersionableStorage()._versions[idx];
-    }
-
-    function getVersionInfo(Version _version) public override view returns(VersionInfo memory) {
-        return _getVersionableStorage()._versionHistory[_version];
-    }
-
-    function getInitializedVersion() public view returns(uint64) {
-        return _getInitializedVersion();
-    }
-
-
-
-    // IMPORTANT each version must implement this function 
-    // each implementation MUST use onlyInitialising modifier
-    // each implementation MUST call intializers of all base contracts...
-    function _initialize(address owner, bytes memory data) 
-        internal
-        onlyInitializing
-        virtual 
-    {
-        revert();
-    }
-
-
-    // IMPORTANT each version except version "1" must implement this function 
-    // each implementation MUST use onlyInitialising modifier
-    function _upgrade(bytes memory data)
-        internal
-        onlyInitializing
-        virtual
-    {
-        revert();
-    }
-
-    function _getVersionableStorage() private pure returns (VersionableStorage storage $) {
-        assembly {
-            $.slot := VERSIONABLE_LOCATION_V1
-        }
-    }
-
-    // can only be called once per contract
-    // needs to be called inside the proxy upgrade tx
-    // TODO run reinitializer(version().toUint64()) modifier after "version()" is checked, 
-    function _updateVersionHistory(
-        address implementation,
-        address activatedBy
-    )
-        private
-        onlyInitializing
-    {
-        VersionableStorage storage $ = _getVersionableStorage();
-
-        uint64 version = _getInitializedVersion();
-
-        Version thisVersion = getVersion();
-
-        if(version == 1) {
-            // thisVersion is alias to version "1"
-            $._v1 = thisVersion;
-        }
-        else {
-            require(thisVersion > $._v1, "INVALID VERSION");
-        }
-
-        // update version history
-        $._versions.push(thisVersion);
-        $._versionHistory[thisVersion] = VersionInfo(
-            thisVersion,
-            implementation,
-            activatedBy,
-            TimestampLib.blockTimestamp(),
-            blockNumber()
-        );
-
-        emit LogVersionableInitialized(thisVersion, implementation, activatedBy);
-    }
-}

package/contracts/test/TestFee.sol

@@ -1,25 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {UFixed, UFixedLib} from "../types/UFixed.sol";
-import {Fee, FeeLib} from "../types/Fee.sol";
-
-contract TestFee {
-
-    function createFee(
-        uint256 fractionalValue,
-        int8 exponent,
-        uint256 fixedValue
-    )
-        external 
-        pure 
-        returns(Fee memory fee)
-    {
-        return FeeLib.toFee(UFixedLib.toUFixed(fractionalValue, exponent), fixedValue);
-    }
-
-    function getZeroFee() external pure returns(Fee memory fee) {
-        return FeeLib.zeroFee();
-    }
-
-}

package/contracts/test/TestRegisterable.sol

@@ -1,18 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {NftId} from "../../contracts/types/NftId.sol";
-import {ObjectType, TOKEN} from "../../contracts/types/ObjectType.sol";
-import {IRegistry} from "../../contracts/registry/IRegistry.sol";
-import {Registerable} from "../../contracts/shared/Registerable.sol";
-
-contract TestRegisterable is Registerable {
-
-    constructor(address registry, NftId registryNftId, ObjectType objectType, bool isInterceptor, address initialOwner)
-        //Registerable(registry, registryNftId)
-    // solhint-disable-next-line no-empty-blocks
-    {
-        bytes memory data = "";
-        _initializeRegisterable(registry, registryNftId, objectType, isInterceptor, initialOwner, data);
-    }
-}

package/contracts/test/TestRoleId.sol

@@ -1,14 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-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(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(); } 
-
-    function getPoolOwnerRoleName() external pure returns (string memory) { return POOL_OWNER_ROLE_NAME(); }
-    function getPoolOwnerRole() external pure returns (RoleId) { return POOL_OWNER_ROLE(); } 
-}

package/contracts/test/TestService.sol

@@ -1,25 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {ObjectType, PRODUCT} from "../../contracts/types/ObjectType.sol";
-import {NftId} from "../../contracts/types/NftId.sol";
-import {Version, VersionLib} from "../../contracts/types/Version.sol";
-import {Service} from "../../contracts/shared/Service.sol";
-
-import {IVersionable} from "../../contracts/shared/IVersionable.sol";
-import {Versionable} from "../../contracts/shared/Versionable.sol";
-
-contract TestService is Service {
-
-    string public constant NAME = "TestService";
-
-    constructor(address registry, NftId registryNftId, address initialOwner)
-    // solhint-disable-next-line no-empty-blocks
-    {
-        _initializeService(registry, initialOwner);
-    }
-
-    function getDomain() public pure override returns(ObjectType) {
-        return PRODUCT();
-    }
-}

package/contracts/test/TestToken.sol

@@ -1,26 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
-
-contract TestUsdc is ERC20 {
-
-    // https://etherscan.io/token/0xc719d010b63e5bbf2c0551872cd5316ed26acd83#readContract
-    string public constant NAME = "USDC - Test";
-    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/test/TestVersion.sol

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

package/contracts/test/TestVersionable.sol

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

package/contracts/types/ChainId.sol

@@ -1,38 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-/// @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;
-
-// 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/NumberId.sol

@@ -1,52 +0,0 @@
-// 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,152 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-type ObjectType is uint8;
-
-// type bindings
-using {
-    eqObjectType as ==,
-    neObjectType as !=,
-    ObjectTypeLib.toInt,
-    ObjectTypeLib.gtz
-} for ObjectType global;
-
-// general pure free functions
-
-function PROTOCOL() pure returns (ObjectType) {
-    return toObjectType(10);
-}
-
-function ROLE() pure returns (ObjectType) {
-    return toObjectType(20);
-}
-
-function TARGET() pure returns (ObjectType) {
-    return toObjectType(30);
-}
-
-function REGISTRY() pure returns (ObjectType) {
-    return toObjectType(40);
-}
-
-function TOKEN() pure returns (ObjectType) {
-    return toObjectType(50);
-}
-
-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);
-}
-
-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);
-}
-
-function POOL() pure returns (ObjectType) {
-    return toObjectType(140);
-}
-
-function RISK() pure returns (ObjectType) {
-    return toObjectType(200);
-}
-
-function POLICY() pure returns (ObjectType) {
-    return toObjectType(210);
-}
-
-function BUNDLE() pure returns (ObjectType) {
-    return toObjectType(220);
-}
-
-function CLAIM() pure returns (ObjectType) {
-    return toObjectType(211);
-}
-
-function PAYOUT() pure returns (ObjectType) {
-    return toObjectType(212);
-}
-
-/// @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/RoleId.sol

@@ -1,91 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {Key32, KeyId, Key32Lib} from "./Key32.sol";
-import {ROLE} from "./ObjectType.sol";
-
-type RoleId is uint64;
-
-// type bindings
-using {
-    eqRoleId as ==, 
-    neRoleId as !=,
-    RoleIdLib.eqz,
-    RoleIdLib.gtz,
-    RoleIdLib.toInt,
-    RoleIdLib.toKey32
-} for RoleId global;
-
-// general pure free functions
-function DISTRIBUTION_OWNER_ROLE_NAME() pure returns (string memory) { return "DistributionOwnerRole"; }
-function ORACLE_OWNER_ROLE_NAME() pure returns (string memory) { return "OracleOwnerRole"; }
-function POOL_OWNER_ROLE_NAME() pure returns (string memory) { return "PoolOwnerRole"; }
-function PRODUCT_OWNER_ROLE_NAME() pure returns (string memory) { return "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_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(10000); }
-function POOL_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(10100); }
-function PRODUCT_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(10200); }
-function POLICY_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(10300); }
-function BUNDLE_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(10400); }
-
-function INSTANCE_SERVICE_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(11000); }
-
-function REGISTRY_SERVICE_ADMIN_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1500); } 
-function REGISTRY_SERVICE_MANAGER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1600); } 
-function RELEASE_MANAGER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId(1700); } 
-
-// @dev Returns true iff role ids a and b are identical
-function eqRoleId(RoleId a, RoleId b) pure returns (bool isSame) {
-    return RoleId.unwrap(a) == RoleId.unwrap(b);
-}
-
-// @dev Returns true iff role ids a and b are different
-function neRoleId(RoleId a, RoleId b) pure returns (bool isDifferent) {
-    return RoleId.unwrap(a) != RoleId.unwrap(b);
-}
-
-library RoleIdLib {
-/// @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))));
-    }
-}