@etherisc/gif-next 0.0.2-78bf628-134 → 0.0.2-790d44b-698

package/contracts/shared/Proxy.sol

@@ -0,0 +1,94 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Ownable} from "@openzeppelin5/contracts/access/Ownable.sol";
+import {ProxyAdmin} from "@openzeppelin5/contracts/proxy/transparent/ProxyAdmin.sol";
+import {TransparentUpgradeableProxy, ITransparentUpgradeableProxy} from "@openzeppelin5/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
+
+import {IVersionable} from "./IVersionable.sol";
+
+contract ProxyWithProxyAdminGetter is TransparentUpgradeableProxy {
+
+    constructor(address implementation, address initialProxyAdminOwner, bytes memory data)
+        TransparentUpgradeableProxy(implementation, initialProxyAdminOwner, data)
+    {}
+
+    function getProxyAdmin() external returns (ProxyAdmin) { return ProxyAdmin(_proxyAdmin()); }
+}
+
+// renamed because of name collision with OZ Proxy -> local proxy type was missing in typechain-types
+contract ProxyDeployer is Ownable {
+
+    event ProxyDeployed(address indexed proxy);
+
+    // TODO use contract functions selectors ???
+    string public constant INITIALIZE_SIGNATURE = "initialize(address,address,bytes)";
+    string public constant UPGRADE_SIGNATURE = "upgrade(address,address,bytes)";
+
+    ProxyWithProxyAdminGetter private _proxy;
+    bool private _isDeployed;
+
+    /// @dev only used to capture proxy owner
+    constructor()
+        Ownable(msg.sender)
+    {
+    }
+
+    function getDeployData(address implementation, address proxyOwner, bytes memory deployData) public pure returns (bytes memory data) {
+        return abi.encodeWithSignature(INITIALIZE_SIGNATURE, implementation, proxyOwner, deployData);
+    }
+
+    function getUpgradeData(address implementation, address proxyOwner, bytes memory upgradeData) public pure returns (bytes memory data) {
+        return abi.encodeWithSignature(UPGRADE_SIGNATURE, implementation, proxyOwner, upgradeData);
+    }
+
+    /// @dev deploy initial contract
+    function deploy(address initialImplementation, bytes memory deployData)
+        external
+        onlyOwner()
+        returns (IVersionable versionable)
+    {
+        require(!_isDeployed, "ERROR:PRX-010:ALREADY_DEPLOYED");
+
+        address currentProxyOwner = owner();
+        address initialProxyAdminOwner = address(this);
+        bytes memory data = getDeployData(initialImplementation, currentProxyOwner, deployData);
+        
+        _proxy = new ProxyWithProxyAdminGetter(
+            initialImplementation,
+            initialProxyAdminOwner,
+            data
+        );
+
+        _isDeployed = true;
+        versionable = IVersionable(address(_proxy));
+
+        emit ProxyDeployed(address(_proxy));
+    }
+
+    /// @dev upgrade existing contract
+    function upgrade(address newImplementation, bytes memory upgradeData)
+        external
+        onlyOwner
+        returns (IVersionable versionable)
+    {
+        require(_isDeployed, "ERROR:PRX-020:NOT_YET_DEPLOYED");
+
+        address currentProxyOwner = owner();
+        // ProxyAdmin proxyAdmin = _proxy.getProxyAdmin();
+        ProxyAdmin proxyAdmin = getProxyAdmin();
+        ITransparentUpgradeableProxy proxy = ITransparentUpgradeableProxy(address(_proxy));
+        bytes memory data = getUpgradeData(newImplementation, currentProxyOwner, upgradeData);
+
+        proxyAdmin.upgradeAndCall(
+            proxy,
+            newImplementation, 
+            data);
+
+        versionable = IVersionable(address(_proxy));
+    }
+
+    function getProxyAdmin() public returns (ProxyAdmin) {
+        return _proxy.getProxyAdmin();
+    }
+}

package/contracts/shared/Versionable.sol

@@ -1,59 +1,107 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+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} from "../types/Version.sol";
+import {Version, VersionPart, VersionLib} from "../types/Version.sol";
 
 import {IVersionable} from "./IVersionable.sol";
 
-abstract contract Versionable is IVersionable {
 
-    mapping(Version version => VersionInfo info) private _versionHistory;
-    Version [] private _versions;
 
+abstract contract Versionable 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
+        }
+    }
 
-    // controlled activation for controller contract
     constructor() {
-        _activate(address(0), msg.sender);
+        _disableInitializers();
     }
 
-    // IMPORTANT this function needs to be implemented by each new version
-    // and needs to call internal function call _activate() 
-    function activate(address implementation, address activatedBy)
+    function initialize(
+        address implementation,
+        address activatedBy, // TODO can it be a msg.sender ? 
+        bytes memory data
+    )
+        public
+        initializer
+    {
+        _updateVersionHistory(implementation, activatedBy);
+        _initialize(data);
+    }
+    function upgrade(
+        address implementation,
+        address activatedBy,
+        bytes memory data
+    )
         external
-        override
-    { 
-        _activate(implementation, activatedBy);
+        reinitializer(VersionLib.toUint64(getVersion()))
+    {
+        _updateVersionHistory(implementation, activatedBy);
+        _upgrade(data);
     }
+    // IMPORTANT each version must implement this function 
+    // each implementation MUST use onlyInitialising modifier
+    function _initialize(bytes memory data) 
+        internal
+        onlyInitializing
+        virtual 
+    {}
 
+    // 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();
+    }
 
     // can only be called once per contract
-    // needs bo be called inside the proxy upgrade tx
-    function _activate(
+    // 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
     )
-        internal
+        private
+        onlyInitializing
     {
+        VersionableStorage storage $ = _getVersionableStorage();
+
+        uint64 version = _getInitializedVersion();
+
         Version thisVersion = getVersion();
-        require(
-            !isActivated(thisVersion),
-            "ERROR:VRN-001:VERSION_ALREADY_ACTIVATED"
-        );
-        
-        // require increasing version number
-        if(_versions.length > 0) {
-            Version lastVersion = _versions[_versions.length - 1];
-            require(
-                thisVersion > lastVersion,
-                "ERROR:VRN-002:VERSION_NOT_INCREASING"
-            );
+
+        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(
+        $._versions.push(thisVersion);
+        $._versionHistory[thisVersion] = VersionInfo(
             thisVersion,
             implementation,
             activatedBy,
@@ -61,12 +109,12 @@ abstract contract Versionable is IVersionable {
             blockNumber()
         );
 
-        emit LogVersionableActivated(thisVersion, implementation, activatedBy);
+        emit LogVersionableInitialized(thisVersion, implementation, activatedBy);
     }
 
-
-    function isActivated(Version _version) public override view returns(bool) {
-        return _versionHistory[_version].activatedIn.toInt() > 0;
+    // TODO previous version(s) can not be active -> check that _version is the latest one
+    function isInitialized(Version _version) public override view returns(bool) {
+        return _getVersionableStorage()._versionHistory[_version].activatedIn.toInt() > 0;
     }
 
 
@@ -74,16 +122,20 @@ abstract contract Versionable is IVersionable {
 
 
     function getVersionCount() external view override returns(uint256) {
-        return _versions.length;
+        return _getVersionableStorage()._versions.length;
     }
 
-
     function getVersion(uint256 idx) external view override returns(Version) {
-        return _versions[idx];
+        return _getVersionableStorage()._versions[idx];
     }
 
 
     function getVersionInfo(Version _version) external override view returns(VersionInfo memory) {
-        return _versionHistory[_version];
+        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/TestPool.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,6 +3,8 @@ 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} from "../../contracts/types/Fee.sol";
 
@@ -10,26 +12,52 @@ 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/types/Fee.sol

@@ -11,8 +11,8 @@ struct Fee {
 library FeeLib {
 
     function calculateFee(
-        uint256 amount,
-        Fee memory fee
+        Fee memory fee,
+        uint256 amount
     )
         public
         pure
@@ -35,7 +35,12 @@ library FeeLib {
         return Fee(fractionalFee, fixedFee);
     }
 
-    /// @dev Return the zero fee struct (0, 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);
     }

package/contracts/types/ObjectType.sol

@@ -41,11 +41,15 @@ function COMPONENT() pure returns (ObjectType) {
     return toObjectType(100);
 }
 
+function TREASURY() pure returns (ObjectType) {
+    return toObjectType(101);
+}
+
 function PRODUCT() pure returns (ObjectType) {
     return toObjectType(110);
 }
 
-function COMPENSATION() pure returns (ObjectType) {
+function DISTRIBUTION() pure returns (ObjectType) {
     return toObjectType(120);
 }
 
@@ -57,20 +61,28 @@ function POOL() pure returns (ObjectType) {
     return toObjectType(140);
 }
 
-function POLICY() pure returns (ObjectType) {
+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)));
+    }
+}

package/contracts/types/RiskId.sol

@@ -0,0 +1,43 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {Key32, KeyId, Key32Lib} from "./Key32.sol";
+import {RISK} from "./ObjectType.sol";
+
+type RiskId is bytes8;
+
+// type bindings
+using {
+    eqRiskId as ==, 
+    neRiskId as !=,
+    RiskIdLib.toKey32
+} for RiskId global;
+
+// general pure free functions
+
+// @dev Returns true iff risk ids a and b are identical
+function eqRiskId(RiskId a, RiskId b) pure returns (bool isSame) {
+    return RiskId.unwrap(a) == RiskId.unwrap(b);
+}
+
+// @dev Returns true iff risk ids a and b are different
+function neRiskId(RiskId a, RiskId b) pure returns (bool isDifferent) {
+    return RiskId.unwrap(a) != RiskId.unwrap(b);
+}
+
+library RiskIdLib {
+    // @dev Converts a role string into a role id.
+    function toRiskId(string memory risk) public pure returns (RiskId) {
+        return RiskId.wrap(bytes8(keccak256(abi.encode(risk))));
+    }
+
+    /// @dev Returns the key32 value for the specified nft id and object type.
+    function toKey32(RiskId id) public pure returns (Key32 key) {
+        return Key32Lib.toKey32(RISK(), toKeyId(id));
+    }
+
+    /// @dev Returns the key id value for the specified nft id
+    function toKeyId(RiskId id) public pure returns (KeyId keyId) {
+        return KeyId.wrap(bytes31(RiskId.unwrap(id)));
+    }
+}

package/contracts/types/RoleId.sol

@@ -10,12 +10,12 @@ using {
 } for RoleId global;
 
 // general pure free functions
-function DISTRIBUTOR_OWNER_ROLE_NAME() pure returns (string memory) { return "DistributorOwnerRole"; }
+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 DISTRIBUTOR_OWNER_ROLE() pure returns (RoleId) { return RoleIdLib.toRoleId("DistributorOwnerRole"); }
+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"); }

package/contracts/types/Version.sol

@@ -23,6 +23,7 @@ using {
     versionGt as >,
     versionEq as ==,
     VersionLib.toInt,
+    VersionLib.toUint64,
     VersionLib.toMajorPart,
     VersionLib.toVersionParts
 }
@@ -34,6 +35,8 @@ function versionEq(Version a, Version b) pure returns(bool isSame) { return Vers
 library VersionLib {
     function toInt(Version version) external pure returns(uint) { return Version.unwrap(version); }
 
+    function toUint64(Version version) external pure returns(uint64) { return Version.unwrap(version); }
+
     function toMajorPart(Version version)
         external    
         pure 
@@ -89,6 +92,11 @@ library VersionLib {
                 (major << 16) + (minor << 8) + patch));
     }
 
+    // TODO check for overflow?
+    function toVersion(uint64 versionNumber) external pure returns(Version) {
+        return Version.wrap(uint24(versionNumber));
+    }
+
     function zeroVersion() external pure returns(Version) {
         return Version.wrap(0);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherisc/gif-next",
-  "version": "0.0.2-78bf628-134",
+  "version": "0.0.2-790d44b-698",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {

package/artifacts/contracts/instance/module/compensation/CompensationModule.sol/CompensationModule.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../../build-info/8e55ece999861400da8a6ef1228e2169.json"
-}

package/artifacts/contracts/instance/module/compensation/CompensationModule.sol/CompensationModule.json

@@ -1,10 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "CompensationModule",
-  "sourceName": "contracts/instance/module/compensation/CompensationModule.sol",
-  "abi": [],
-  "bytecode": "0x6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea2646970667358221220e083bd536daa38f4ab2da87a47489460180ca9e737890e3707e2279d6bddbb1d64736f6c63430008140033",
-  "deployedBytecode": "0x6080604052600080fdfea2646970667358221220e083bd536daa38f4ab2da87a47489460180ca9e737890e3707e2279d6bddbb1d64736f6c63430008140033",
-  "linkReferences": {},
-  "deployedLinkReferences": {}
-}

package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensation.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../../build-info/8e55ece999861400da8a6ef1228e2169.json"
-}

package/artifacts/contracts/instance/module/compensation/ICompensation.sol/ICompensationModule.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../../build-info/8e55ece999861400da8a6ef1228e2169.json"
-}

package/contracts/instance/module/compensation/CompensationModule.sol

@@ -1,8 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-import {ICompensationModule} from "./ICompensation.sol";
-
-contract CompensationModule is ICompensationModule {
-    
-}

package/contracts/instance/module/compensation/ICompensation.sol

@@ -1,10 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
-
-interface ICompensation {
-
-}
-
-interface ICompensationModule is ICompensation {
-    
-}