@etherisc/gif-next 0.0.2-efdb520-159 → 0.0.2-efef0ea-320

package/contracts/shared/VersionableUpgradeable.sol

@@ -0,0 +1,136 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Initializable} from "@openzeppelin5/contracts/proxy/utils/Initializable.sol";
+
+import {Blocknumber, blockNumber} from "../types/Blocknumber.sol";
+import {Timestamp, blockTimestamp} from "../types/Timestamp.sol";
+import {Version, VersionPart, VersionLib} from "../types/Version.sol";
+
+import {IVersionable} from "./IVersionable.sol";
+
+abstract contract VersionableUpgradeable is 
+    Initializable,
+    IVersionable 
+{
+    /// @custom:storage-location erc7201:gif-next.contracts.shared.Versionable.sol
+    struct VersionableStorage {
+        mapping(Version version => VersionInfo info) _versionHistory;
+        Version [] _versions;
+        Version _v1;
+    }
+
+    // keccak256(abi.encode(uint256(keccak256("gif-next.contracts.shared.Versionable.sol")) - 1)) & ~bytes32(uint256(0xff))
+    bytes32 private constant VersionableStorageLocation = 0x4f61291a8ac3d020d0a7d919a76b8592aa88385744dee3f8b4f3873b969ed900;
+    
+    function _getVersionableStorage() private pure returns (VersionableStorage storage $) {
+        assembly {
+            $.slot := VersionableStorageLocation
+        }
+    }
+
+    constructor() {
+        _disableInitializers();
+    }
+
+    function initialize(
+        address implementation,
+        address activatedBy, // TODO can it be a msg.sender ? 
+        bytes memory data
+    )
+        public
+        virtual 
+        initializer
+    {
+        _activate(implementation, activatedBy);
+        _initialize(data);
+    }
+    function upgrade(
+        address implementation,
+        address activatedBy,
+        bytes memory data
+    )
+        external
+        virtual
+        reinitializer(VersionLib.toUint64(getVersion()))
+    {
+        _activate(implementation, activatedBy);
+        _upgrade(data);
+    }
+    // IMPORTANT each version must implement this function 
+    // each implementation MUST use onlyInitialising modifier
+    function _initialize(bytes memory data) virtual internal;
+
+    // IMPORTANT each version except version "1" must implement this function 
+    // each implementation MUST use onlyInitialising modifier
+    function _upgrade(bytes memory data) virtual internal
+    {
+        revert();
+    }
+
+    // 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 _activate(
+        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 {
+            //Version initializedVersion = VersionLib.toVersion(version);
+            //require(initializedVersion == thisVersion, "");
+            require(thisVersion > $._v1, "");
+        }
+
+        // update version history
+        $._versions.push(thisVersion);
+        $._versionHistory[thisVersion] = VersionInfo(
+            thisVersion,
+            implementation,
+            activatedBy,
+            blockTimestamp(),
+            blockNumber()
+        );
+
+        emit LogVersionableActivated(thisVersion, implementation, activatedBy);
+    }
+
+    // TODO previous version(s) can not be active -> check that _version is the current one
+    function isActivated(Version _version) public override view returns(bool) {
+        return _getVersionableStorage()._versionHistory[_version].activatedIn.toInt() > 0;
+    }
+
+
+    function getVersion() public pure virtual returns(Version);
+
+
+    function getVersionCount() external view override returns(uint256) {
+        return _getVersionableStorage()._versions.length;
+    }
+
+    function getVersion(uint256 idx) external view override returns(Version) {
+        return _getVersionableStorage()._versions[idx];
+    }
+
+
+    function getVersionInfo(Version _version) external override view returns(VersionInfo memory) {
+        return _getVersionableStorage()._versionHistory[_version];
+    }
+
+    function getInitializedVersion() external view returns(uint64)
+    {
+        return _getInitializedVersion();
+    }
+}

package/contracts/test/TestDistribution.sol

@@ -0,0 +1,21 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {Fee} from "../../contracts/types/Fee.sol";
+import {NftId} from "../../contracts/types/NftId.sol";
+import {Distribution} from "../../contracts/components/Distribution.sol";
+
+
+contract TestDistribution is Distribution {
+
+    constructor(
+        address registry,
+        NftId instanceNftid,
+        address token,
+        bool isVerifying,
+        Fee memory distributionFee
+    )
+        Distribution(registry, instanceNftid, token, isVerifying, distributionFee)
+    // solhint-disable-next-line no-empty-blocks
+    {}
+}

package/contracts/test/TestFee.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.19;
 
 import {UFixed, UFixedMathLib} from "../types/UFixed.sol";
-import {Fee, toFee, zeroFee} from "../types/Fee.sol";
+import {Fee, FeeLib} from "../types/Fee.sol";
 
 contract TestFee {
 
@@ -15,11 +15,11 @@ contract TestFee {
         pure 
         returns(Fee memory fee)
     {
-        return toFee(UFixedMathLib.toUFixed(fractionalValue, exponent), fixedValue);
+        return FeeLib.toFee(UFixedMathLib.toUFixed(fractionalValue, exponent), fixedValue);
     }
 
     function getZeroFee() external pure returns(Fee memory fee) {
-        return zeroFee();
+        return FeeLib.zeroFee();
     }
 
 }

package/contracts/test/TestPool.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.19;
 
 import {NftId} from "../../contracts/types/NftId.sol";
 import {UFixed} from "../../contracts/types/UFixed.sol";
-import {Fee, zeroFee} from "../../contracts/types/Fee.sol";
+import {Fee} from "../../contracts/types/Fee.sol";
 import {Pool} from "../../contracts/components/Pool.sol";
 
 
@@ -14,9 +14,12 @@ contract TestPool is Pool {
         NftId instanceNftid,
         address token,
         bool isVerifying,
-        UFixed collateralizationLevel
+        UFixed collateralizationLevel,
+        Fee memory poolFee,
+        Fee memory stakingFee,
+        Fee memory performanceFee
     )
-        Pool(registry, instanceNftid, token, isVerifying, collateralizationLevel)
+        Pool(registry, instanceNftid, token, isVerifying, collateralizationLevel, poolFee, stakingFee, performanceFee)
     // solhint-disable-next-line no-empty-blocks
     {}
 }

package/contracts/test/TestProduct.sol

@@ -3,33 +3,61 @@ pragma solidity ^0.8.19;
 
 import {Product} from "../../contracts/components/Product.sol";
 import {NftId, toNftId} from "../../contracts/types/NftId.sol";
+import {ReferralId} from "../types/ReferralId.sol";
+import {RiskId} from "../../contracts/types/RiskId.sol";
 import {Timestamp, blockTimestamp} from "../../contracts/types/Timestamp.sol";
-import {Fee, zeroFee} from "../../contracts/types/Fee.sol";
+import {Fee} from "../../contracts/types/Fee.sol";
 
 contract TestProduct is Product {
 
     event LogTestProductSender(address sender);
 
-    constructor(address registry, NftId instanceNftid, address token, address pool)
-        Product(registry, instanceNftid, token, pool)
+    string public constant DEFAULT_RISK_NAME = "DEFAULT_RISK";
+    bool private defaultRiskCreated;
+
+    constructor(
+        address registry,
+        NftId instanceNftid,
+        address token,
+        address pool,
+        address distribution,
+        Fee memory productFee,
+        Fee memory processingFee
+    )
+        Product(registry, instanceNftid, token, pool, distribution, productFee, processingFee)
     // solhint-disable-next-line no-empty-blocks
-    {}
+    {
+    }
+
+    function getDefaultRiskId() public pure returns (RiskId) {
+        return _toRiskId(DEFAULT_RISK_NAME);
+    }
 
     function applyForPolicy(
         uint256 sumInsuredAmount,
-        uint256 premiumAmount,
         uint256 lifetime,
-        NftId bundleNftId
+        NftId bundleNftId,
+        ReferralId referralId
     )
         external
         returns(NftId nftId)
     {
+        RiskId riskId = getDefaultRiskId();
+        bytes memory applicationData = "";
+
+        if (!defaultRiskCreated) {
+            _createRisk(riskId, "");
+            defaultRiskCreated = true;
+        }
+
         nftId = _createApplication(
             msg.sender, // policy holder
+            riskId,
             sumInsuredAmount,
-            premiumAmount,
             lifetime,
-            bundleNftId
+            applicationData,
+            bundleNftId,
+            referralId
         );
     }
 

package/contracts/test/TestRoleId.sol

@@ -1,10 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {RoleId, toRoleId, PRODUCT_OWNER_ROLE_NAME, PRODUCT_OWNER_ROLE, POOL_OWNER_ROLE_NAME, POOL_OWNER_ROLE} from "../../contracts/types/RoleId.sol";
+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 toRoleId(roleName); }
+    function getRole(string memory roleName) external pure returns (RoleId) { return RoleIdLib.toRoleId(roleName); }
 
     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

@@ -2,8 +2,8 @@
 pragma solidity ^0.8.19;
 
 import {NftId} from "../../contracts/types/NftId.sol";
-import {Version, toVersion, toVersionPart} from "../../contracts/types/Version.sol";
-import {ServiceBase} from "../../contracts/instance/service/ServiceBase.sol";
+import {Version, VersionLib} from "../../contracts/types/Version.sol";
+import {ServiceBase} from "../../contracts/instance/base/ServiceBase.sol";
 
 import {IVersionable} from "../../contracts/shared/IVersionable.sol";
 import {Versionable} from "../../contracts/shared/Versionable.sol";
@@ -23,10 +23,7 @@ contract TestService is ServiceBase {
         virtual override (IVersionable, Versionable)
         returns(Version)
     {
-        return toVersion(
-            toVersionPart(3),
-            toVersionPart(0),
-            toVersionPart(0));
+        return VersionLib.toVersion(3,0,0);
     }
 
     function getName() external pure override returns(string memory name) {

package/contracts/test/TestVersion.sol

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

package/contracts/test/TestVersionable.sol

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

package/contracts/test/Usdc.sol

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

@@ -1,32 +1,56 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
-import {UFixed} from "./UFixed.sol";
+import {UFixed, UFixedMathLib} 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);
-}
+library FeeLib {
 
-/// @dev Return the NftId zero (0)
-function zeroFee() pure returns (Fee memory fee) {
-    return Fee(UFixed.wrap(0), 0);
-}
+    function calculateFee(
+        Fee memory fee,
+        uint256 amount
+    )
+        public
+        pure
+        returns (
+            uint256 feeAmount, 
+            uint256 netAmount
+        )
+    {
+        UFixed fractionalAmount = UFixedMathLib.toUFixed(amount) *
+            fee.fractionalFee;
+        feeAmount = fractionalAmount.toInt() + fee.fixedFee;
+        netAmount = amount - feeAmount;
+    }
 
-// 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;
-}
+    /// @dev Converts the uint256 to a fee struct.
+    function toFee(
+        UFixed fractionalFee,
+        uint256 fixedFee
+    ) public pure returns (Fee memory fee) {
+        return Fee(fractionalFee, fixedFee);
+    }
 
-function feeIsZero(Fee memory fee) pure returns (bool) {
-    return fee.fixedFee == 0 && UFixed.unwrap(fee.fractionalFee) == 0;
-}
+    /// @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);
+    }
+
+    /// @dev Return a zero fee struct (0, 0)
+    function zeroFee() public pure returns (Fee memory fee) {
+        return Fee(UFixed.wrap(0), 0);
+    }
+
+    // pure free functions for operators
+    function feeIsSame(Fee memory a, Fee memory b) public pure returns (bool isSame) {
+        return a.fixedFee == b.fixedFee && a.fractionalFee == b.fractionalFee;
+    }
+
+    function feeIsZero(Fee memory fee) public pure returns (bool) {
+        return fee.fixedFee == 0 && UFixed.unwrap(fee.fractionalFee) == 0;
+    }
+}

package/contracts/types/Key32.sol

@@ -0,0 +1,45 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {ObjectType} from "./ObjectType.sol";
+
+type Key32 is bytes32;
+type KeyId is bytes31;
+
+// type bindings
+using {
+    eqKey32 as ==, 
+    neKey32 as !=,
+    Key32Lib.toKey
+} for Key32 global;
+
+// @dev Returns true iff keys are identical
+function eqKey32(Key32 a, Key32 b) pure returns (bool isSame) {
+    return Key32.unwrap(a) == Key32.unwrap(b);
+}
+
+// @dev Returns true iff keys are different
+function neKey32(Key32 a, Key32 b) pure returns (bool isDifferent) {
+    return Key32.unwrap(a) != Key32.unwrap(b);
+}
+
+library Key32Lib {
+
+    uint8 public constant TYPE_SHIFT = 31 * 8;
+    uint8 public constant ID_SHIFT = uint8(32 * 8 - TYPE_SHIFT);
+    bytes32 public constant TYPE_MASK = bytes32(bytes1(type(uint8).max)); // first byte in bytes32
+    bytes32 public constant ID_MASK = bytes32(~TYPE_MASK); // remaining bytes in bytes32
+
+    function toKey32(ObjectType objectType, KeyId id) public pure returns (Key32) {
+        uint256 uintObjectType = ObjectType.unwrap(objectType);
+        uint256 uintId = uint248(KeyId.unwrap(id));
+        uint256 uintKey = (uintObjectType << TYPE_SHIFT) + uintId;
+        return Key32.wrap(bytes32(uintKey));
+    }
+
+    function toKey(Key32 key) public pure returns (ObjectType objectType, KeyId id) {
+        bytes32 key32 = Key32.unwrap(key);
+        objectType = ObjectType.wrap(uint8(uint256(key32 & TYPE_MASK) >> TYPE_SHIFT));
+        id = KeyId.wrap(bytes31((key32 & ID_MASK) << ID_SHIFT));
+    }
+}

package/contracts/types/NftId.sol

@@ -1,6 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.19;
 
+import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {ObjectType} from "./ObjectType.sol";
+
 // uint96 allows for chain ids up to 13 digits
 type NftId is uint96;
 
@@ -10,7 +13,9 @@ using {
     neNftId as !=, 
     NftIdLib.toInt,
     NftIdLib.gtz,
-    NftIdLib.eqz
+    NftIdLib.eqz,
+    NftIdLib.toKeyId,
+    NftIdLib.toKey32
 } for NftId global;
 
 // general pure free functions
@@ -54,4 +59,14 @@ library NftIdLib {
     function eq(NftId a, NftId b) public pure returns (bool isSame) {
         return eqNftId(a, b);
     }
+
+    /// @dev Returns the key32 value for the specified nft id and object type.
+    function toKey32(NftId id, ObjectType objectType) public pure returns (Key32 key) {
+        return Key32Lib.toKey32(objectType, toKeyId(id));
+    }
+
+    /// @dev Returns the key id value for the specified nft id
+    function toKeyId(NftId id) public pure returns (KeyId keyId) {
+        return KeyId.wrap(bytes31(uint248(NftId.unwrap(id))));
+    }
 }

package/contracts/types/ObjectType.sol

@@ -37,36 +37,52 @@ function STAKE() pure returns (ObjectType) {
     return toObjectType(60);
 }
 
-function PRODUCT() pure returns (ObjectType) {
+function COMPONENT() pure returns (ObjectType) {
     return toObjectType(100);
 }
 
-function DISTRIBUTOR() pure returns (ObjectType) {
+function TREASURY() pure returns (ObjectType) {
+    return toObjectType(101);
+}
+
+function PRODUCT() pure returns (ObjectType) {
     return toObjectType(110);
 }
 
-function ORACLE() pure returns (ObjectType) {
+function DISTRIBUTION() pure returns (ObjectType) {
     return toObjectType(120);
 }
 
-function POOL() pure returns (ObjectType) {
+function ORACLE() pure returns (ObjectType) {
     return toObjectType(130);
 }
 
-function POLICY() pure returns (ObjectType) {
+function POOL() pure returns (ObjectType) {
+    return toObjectType(140);
+}
+
+function RISK() pure returns (ObjectType) {
     return toObjectType(200);
 }
 
-function BUNDLE() pure returns (ObjectType) {
+function POLICY() pure returns (ObjectType) {
     return toObjectType(210);
 }
 
+function REFERRAL() pure returns (ObjectType) {
+    return toObjectType(212);
+}
+
 function CLAIM() pure returns (ObjectType) {
-    return toObjectType(201);
+    return toObjectType(214);
 }
 
 function PAYOUT() pure returns (ObjectType) {
-    return toObjectType(202);
+    return toObjectType(216);
+}
+
+function BUNDLE() pure returns (ObjectType) {
+    return toObjectType(220);
 }
 
 /// @dev Converts the uint8 to a ObjectType.

package/contracts/types/ReferralId.sol

@@ -0,0 +1,48 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {REFERRAL} from "./ObjectType.sol";
+
+type ReferralId is bytes8;
+
+// type bindings
+using {
+    eqReferralId as ==, 
+    neReferralId as !=,
+    ReferralIdLib.toKey32
+} for ReferralId global;
+
+// general pure free functions
+
+// @dev Returns true iff risk ids 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 risk ids a and b are different
+function neReferralId(ReferralId a, ReferralId b) pure returns (bool isDifferent) {
+    return ReferralId.unwrap(a) != ReferralId.unwrap(b);
+}
+
+library ReferralIdLib {
+
+    function zeroReferralId() public pure returns (ReferralId) {
+        return ReferralId.wrap(bytes8(0));
+    }
+
+    // @dev Converts a role string into a role id.
+    function toReferralId(string memory referral) public pure returns (ReferralId) {
+        return ReferralId.wrap(bytes8(keccak256(abi.encode(referral))));
+    }
+
+    /// @dev Returns the key32 value for the specified id
+    function toKey32(ReferralId id) public pure returns (Key32 key) {
+        return Key32Lib.toKey32(REFERRAL(), toKeyId(id));
+    }
+
+    /// @dev Returns the key id value for the specified id
+    function toKeyId(ReferralId id) public pure returns (KeyId keyId) {
+        return KeyId.wrap(bytes31(ReferralId.unwrap(id)));
+    }
+}