@etherisc/gif-next 0.0.2-a04040f-684 → 0.0.2-a196164-289

package/artifacts/contracts/types/Version.sol/VersionLib.json

@@ -0,0 +1,177 @@
+{
+  "_format": "hh-sol-artifact-1",
+  "contractName": "VersionLib",
+  "sourceName": "contracts/types/Version.sol",
+  "abi": [
+    {
+      "inputs": [
+        {
+          "internalType": "Version",
+          "name": "version",
+          "type": "uint24"
+        }
+      ],
+      "name": "toInt",
+      "outputs": [
+        {
+          "internalType": "uint256",
+          "name": "",
+          "type": "uint256"
+        }
+      ],
+      "stateMutability": "pure",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "Version",
+          "name": "version",
+          "type": "uint24"
+        }
+      ],
+      "name": "toMajorPart",
+      "outputs": [
+        {
+          "internalType": "VersionPart",
+          "name": "major",
+          "type": "uint8"
+        }
+      ],
+      "stateMutability": "pure",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "Version",
+          "name": "version",
+          "type": "uint24"
+        }
+      ],
+      "name": "toUint64",
+      "outputs": [
+        {
+          "internalType": "uint64",
+          "name": "",
+          "type": "uint64"
+        }
+      ],
+      "stateMutability": "pure",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "uint256",
+          "name": "major",
+          "type": "uint256"
+        },
+        {
+          "internalType": "uint256",
+          "name": "minor",
+          "type": "uint256"
+        },
+        {
+          "internalType": "uint256",
+          "name": "patch",
+          "type": "uint256"
+        }
+      ],
+      "name": "toVersion",
+      "outputs": [
+        {
+          "internalType": "Version",
+          "name": "",
+          "type": "uint24"
+        }
+      ],
+      "stateMutability": "pure",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "uint64",
+          "name": "versionNumber",
+          "type": "uint64"
+        }
+      ],
+      "name": "toVersion",
+      "outputs": [
+        {
+          "internalType": "Version",
+          "name": "",
+          "type": "uint24"
+        }
+      ],
+      "stateMutability": "pure",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "uint256",
+          "name": "versionPart",
+          "type": "uint256"
+        }
+      ],
+      "name": "toVersionPart",
+      "outputs": [
+        {
+          "internalType": "VersionPart",
+          "name": "",
+          "type": "uint8"
+        }
+      ],
+      "stateMutability": "pure",
+      "type": "function"
+    },
+    {
+      "inputs": [
+        {
+          "internalType": "Version",
+          "name": "version",
+          "type": "uint24"
+        }
+      ],
+      "name": "toVersionParts",
+      "outputs": [
+        {
+          "internalType": "VersionPart",
+          "name": "major",
+          "type": "uint8"
+        },
+        {
+          "internalType": "VersionPart",
+          "name": "minor",
+          "type": "uint8"
+        },
+        {
+          "internalType": "VersionPart",
+          "name": "patch",
+          "type": "uint8"
+        }
+      ],
+      "stateMutability": "pure",
+      "type": "function"
+    },
+    {
+      "inputs": [],
+      "name": "zeroVersion",
+      "outputs": [
+        {
+          "internalType": "Version",
+          "name": "",
+          "type": "uint24"
+        }
+      ],
+      "stateMutability": "pure",
+      "type": "function"
+    }
+  ],
+  "bytecode": "0x61039161003a600b82828239805160001a60731461002d57634e487b7160e01b600052600060045260246000fd5b30600052607381538281f3fe73000000000000000000000000000000000000000030146080604052600436106100925760003560e01c80638e4ad86c116100655780638e4ad86c1461012157806394aa449c14610144578063a123b37c14610152578063c9e66e291461017957600080fd5b806304b8f6c5146100975780632efe0113146100b357806349a7111a146100c657806355601007146100fd575b600080fd5b60005b60405162ffffff90911681526020015b60405180910390f35b61009a6100c136600461026e565b610190565b6100d96100d436600461029a565b610231565b6040805160ff948516815292841660208401529216918101919091526060016100aa565b61011361010b36600461029a565b62ffffff1690565b6040519081526020016100aa565b61013261012f3660046102c6565b90565b60405160ff90911681526020016100aa565b61009a61012f3660046102df565b61016061010b36600461029a565b60405167ffffffffffffffff90911681526020016100aa565b61013261018736600461029a565b60101c60ff1690565b6000610100841080156101a4575061010083105b80156101b1575061010082105b61020c5760405162461bcd60e51b815260206004820152602260248201527f4552524f523a5652532d3031303a56455253494f4e5f504152545f544f4f5f42604482015261494760f01b606482015260840160405180910390fd5b8161021f600885901b601087901b61031f565b610229919061031f565b949350505050565b600080808360ff601082901c166102488383610338565b915061ffff600883901c16600061025f8185610338565b92989197509195509350505050565b60008060006060848603121561028357600080fd5b505081359360208301359350604090920135919050565b6000602082840312156102ac57600080fd5b813562ffffff811681146102bf57600080fd5b9392505050565b6000602082840312156102d857600080fd5b5035919050565b6000602082840312156102f157600080fd5b813567ffffffffffffffff811681146102bf57600080fd5b634e487b7160e01b600052601160045260246000fd5b8082018082111561033257610332610309565b92915050565b62ffffff82811682821603908082111561035457610354610309565b509291505056fea26469706673582212208f9511a0a2a546b8c04a7a10d6336736c2c01718b45d7da4362c9eb1545731ca64736f6c63430008140033",
+  "deployedBytecode": "0x73000000000000000000000000000000000000000030146080604052600436106100925760003560e01c80638e4ad86c116100655780638e4ad86c1461012157806394aa449c14610144578063a123b37c14610152578063c9e66e291461017957600080fd5b806304b8f6c5146100975780632efe0113146100b357806349a7111a146100c657806355601007146100fd575b600080fd5b60005b60405162ffffff90911681526020015b60405180910390f35b61009a6100c136600461026e565b610190565b6100d96100d436600461029a565b610231565b6040805160ff948516815292841660208401529216918101919091526060016100aa565b61011361010b36600461029a565b62ffffff1690565b6040519081526020016100aa565b61013261012f3660046102c6565b90565b60405160ff90911681526020016100aa565b61009a61012f3660046102df565b61016061010b36600461029a565b60405167ffffffffffffffff90911681526020016100aa565b61013261018736600461029a565b60101c60ff1690565b6000610100841080156101a4575061010083105b80156101b1575061010082105b61020c5760405162461bcd60e51b815260206004820152602260248201527f4552524f523a5652532d3031303a56455253494f4e5f504152545f544f4f5f42604482015261494760f01b606482015260840160405180910390fd5b8161021f600885901b601087901b61031f565b610229919061031f565b949350505050565b600080808360ff601082901c166102488383610338565b915061ffff600883901c16600061025f8185610338565b92989197509195509350505050565b60008060006060848603121561028357600080fd5b505081359360208301359350604090920135919050565b6000602082840312156102ac57600080fd5b813562ffffff811681146102bf57600080fd5b9392505050565b6000602082840312156102d857600080fd5b5035919050565b6000602082840312156102f157600080fd5b813567ffffffffffffffff811681146102bf57600080fd5b634e487b7160e01b600052601160045260246000fd5b8082018082111561033257610332610309565b92915050565b62ffffff82811682821603908082111561035457610354610309565b509291505056fea26469706673582212208f9511a0a2a546b8c04a7a10d6336736c2c01718b45d7da4362c9eb1545731ca64736f6c63430008140033",
+  "linkReferences": {},
+  "deployedLinkReferences": {}
+}

package/artifacts/contracts/types/Version.sol/VersionPartLib.dbg.json

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

package/artifacts/contracts/types/Version.sol/VersionPartLib.json

@@ -0,0 +1,30 @@
+{
+  "_format": "hh-sol-artifact-1",
+  "contractName": "VersionPartLib",
+  "sourceName": "contracts/types/Version.sol",
+  "abi": [
+    {
+      "inputs": [
+        {
+          "internalType": "VersionPart",
+          "name": "x",
+          "type": "uint8"
+        }
+      ],
+      "name": "toInt",
+      "outputs": [
+        {
+          "internalType": "uint256",
+          "name": "",
+          "type": "uint256"
+        }
+      ],
+      "stateMutability": "pure",
+      "type": "function"
+    }
+  ],
+  "bytecode": "0x60b9610039600b82828239805160001a60731461002c57634e487b7160e01b600052600060045260246000fd5b30600052607381538281f3fe730000000000000000000000000000000000000000301460806040526004361060335760003560e01c8063ac43d834146038575b600080fd5b60496043366004605b565b60ff1690565b60405190815260200160405180910390f35b600060208284031215606c57600080fd5b813560ff81168114607c57600080fd5b939250505056fea2646970667358221220c9c379b3b5ac83b5051ce617e894b84028046aca89e19f78215b3a3e8442fad464736f6c63430008140033",
+  "deployedBytecode": "0x730000000000000000000000000000000000000000301460806040526004361060335760003560e01c8063ac43d834146038575b600080fd5b60496043366004605b565b60ff1690565b60405190815260200160405180910390f35b600060208284031215606c57600080fd5b813560ff81168114607c57600080fd5b939250505056fea2646970667358221220c9c379b3b5ac83b5051ce617e894b84028046aca89e19f78215b3a3e8442fad464736f6c63430008140033",
+  "linkReferences": {},
+  "deployedLinkReferences": {}
+}

package/contracts/components/BaseComponent.sol

@@ -0,0 +1,94 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {Registerable} from "../shared/Registerable.sol";
+
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IInstance} from "../instance/IInstance.sol";
+
+import {IInstance} from "../instance/IInstance.sol";
+import {IComponent, IComponentModule} from "../instance/module/component/IComponent.sol";
+import {IComponentOwnerService} from "../instance/service/IComponentOwnerService.sol";
+import {IBaseComponent} from "./IBaseComponent.sol";
+import {Fee, FeeLib} from "../types/Fee.sol";
+import {NftId} from "../types/NftId.sol";
+
+abstract contract BaseComponent is
+    Registerable,
+    IBaseComponent
+{
+    IComponentOwnerService internal _componentOwnerService;
+
+    address internal _deployer;
+    address internal _wallet;
+    IERC20Metadata internal _token;
+    IInstance internal _instance;
+    bool internal _isRegistered;
+    Fee internal _zeroFee;
+
+    constructor(
+        address registry,
+        NftId instanceNftId,
+        address token
+    )
+        Registerable(registry, instanceNftId)
+    {
+        IRegistry.ObjectInfo memory instanceInfo = _registry.getObjectInfo(instanceNftId);
+        _instance = IInstance(instanceInfo.objectAddress);
+        require(
+            _instance.supportsInterface(type(IInstance).interfaceId),
+            ""
+        );
+
+        _componentOwnerService = _instance.getComponentOwnerService();
+        _wallet = address(this);
+        _token = IERC20Metadata(token);
+        _isRegistered = false;
+        _zeroFee = FeeLib.zeroFee();
+    }
+
+    // from registerable
+    function register() public override(IRegisterable, Registerable) returns (NftId componentId) {
+        require(msg.sender == getOwner(), "");
+        require(
+            address(_registry) != address(0),
+            "ERROR:COB-001:REGISTRY_ZERO"
+        );
+        require(
+            _registry.isRegistered(address(_instance)),
+            "ERROR:COB:INSTANCE_NOT_REGISTERED"
+        );
+
+        _isRegistered = true;
+        return _componentOwnerService.register(this);
+    }
+
+    // from component contract
+    function lock() external onlyOwner override {
+        _componentOwnerService.lock(this);
+    }
+
+    function unlock() external onlyOwner override {
+        _componentOwnerService.unlock(this);
+    }
+
+    function getWallet()
+        external
+        view
+        override
+        returns (address walletAddress)
+    {
+        return _wallet;
+    }
+
+    function getToken() external view override returns (IERC20Metadata token) {
+        return _token;
+    }
+
+    function getInstance() external view override returns (IInstance instance) {
+        return _instance;
+    }
+}

package/contracts/components/Distribution.sol

@@ -0,0 +1,132 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {ObjectType, DISTRIBUTION} from "../types/ObjectType.sol";
+import {IDistributionService} from "../instance/service/IDistributionService.sol";
+import {IProductService} from "../instance/service/IProductService.sol";
+import {NftId} from "../types/NftId.sol";
+import {ReferralId} from "../types/ReferralId.sol";
+import {Fee, FeeLib} from "../types/Fee.sol";
+import {BaseComponent} from "./BaseComponent.sol";
+import {IDistributionComponent} from "./IDistributionComponent.sol";
+
+contract Distribution is
+    BaseComponent,
+    IDistributionComponent
+{
+
+    Fee internal _initialDistributionFee;
+    bool internal _isVerifying;
+
+    IDistributionService private _distributionService;
+    IProductService private _productService;
+
+    modifier onlyProductService() {
+        require(
+            msg.sender == address(_productService), 
+            "ERROR:POL-002:NOT_PRODUCT_SERVICE");
+        _;
+    }
+
+    constructor(
+        address registry,
+        NftId instanceNftId,
+        // TODO refactor into tokenNftId
+        address token,
+        bool verifying,
+        Fee memory distributionFee
+    )
+        BaseComponent(registry, instanceNftId, token)
+    {
+        _isVerifying = verifying;
+        _initialDistributionFee = distributionFee;
+
+        _distributionService = _instance.getDistributionService();
+        _productService = _instance.getProductService();
+    }
+
+
+    function setFees(
+        Fee memory distributionFee
+    )
+        external
+        override
+    {
+        _distributionService.setFees(distributionFee);
+    }
+
+    function calculateFeeAmount(
+        ReferralId referralId,
+        uint256 netPremiumAmount
+    )
+        external
+        view
+        virtual override
+        returns (uint256 feeAmount)
+    {
+        Fee memory fee = getDistributionFee();
+        (feeAmount,) = FeeLib.calculateFee(fee, netPremiumAmount);
+    }
+
+
+    function calculateRenewalFeeAmount(
+        ReferralId referralId,
+        uint256 netPremiumAmount
+    )
+        external
+        view
+        virtual override
+        returns (uint256 feeAmount)
+    {
+        // default is no fees
+        return 0 * netPremiumAmount;
+    }
+
+    function processSale(
+        ReferralId referralId,
+        uint256 feeAmount
+    )
+        external
+        onlyProductService
+        virtual override
+    {
+        // default is no action
+    }
+
+    function processRenewal(
+        ReferralId referralId,
+        uint256 feeAmount
+    )
+        external
+        onlyProductService
+        virtual override
+    {
+        // default is no action
+    }
+
+    function referralIsValid(ReferralId referralId) external view returns (bool isValid) {
+        // default is invalid
+        return false;
+    }
+
+    /// @dev default distribution fee, ie when not using any valid referralId
+    function getDistributionFee() public view returns (Fee memory distributionFee) {
+        NftId productNftId = _instance.getProductNftId(getNftId());
+        if (_instance.hasTreasuryInfo(productNftId)) {
+            return _instance.getTreasuryInfo(productNftId).distributionFee;
+        } else {
+            return _initialDistributionFee;
+        }
+    }
+
+
+    /// @dev returns true iff the component needs to be called when selling/renewing policis
+    function isVerifying() external view returns (bool verifying) {
+        return _isVerifying;
+    }
+
+    // from registerable
+    function getType() public pure override returns (ObjectType) {
+        return DISTRIBUTION();
+    }
+}

package/contracts/components/IBaseComponent.sol

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {IInstanceLinked} from "../instance/IInstanceLinked.sol";
+
+interface IBaseComponent is IRegisterable, IInstanceLinked {
+
+    function lock() external;
+
+    function unlock() external;
+
+    function getToken() external view returns (IERC20Metadata token);
+
+    function getWallet() external view returns (address walletAddress);
+
+}

package/contracts/components/IDistributionComponent.sol

@@ -0,0 +1,47 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {Fee} from "../types/Fee.sol";
+import {ReferralId} from "../types/ReferralId.sol";
+import {NftId} from "../types/NftId.sol";
+import {IBaseComponent} from "./IBaseComponent.sol";
+
+interface IDistributionComponent is IBaseComponent {
+
+    function setFees(
+        Fee memory distributionFee
+    ) external;
+
+    function calculateFeeAmount(
+        ReferralId referralId,
+        uint256 netPremiumAmount
+    ) external view returns (uint256 feeAmount);
+
+    function calculateRenewalFeeAmount(
+        ReferralId referralId,
+        uint256 netPremiumAmount
+    ) external view returns (uint256 feeAmount);
+
+    /// @dev callback from product service when selling a policy for a specific referralId
+    /// the used referral id and the collected fee are provided as parameters
+    /// the component implementation can then process this information accordingly
+    function processSale(
+        ReferralId referralId,
+        uint256 feeAmount
+    ) external;
+
+    /// @dev callback from product service when a policy is renews for a specific referralId
+    function processRenewal(
+        ReferralId referralId,
+        uint256 feeAmount
+    ) external;
+
+    /// @dev returns true iff the referral id is valid
+    function referralIsValid(ReferralId referralId) external view returns (bool isValid);
+
+    /// @dev default distribution fee, ie when not using any valid referralId
+    function getDistributionFee() external view returns (Fee memory distributionFee);
+
+    /// @dev returns true iff the component needs to be called when selling/renewing policis
+    function isVerifying() external view returns (bool verifying);
+}

package/contracts/components/IPoolComponent.sol

@@ -0,0 +1,71 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {NftId} from "../types/NftId.sol";
+import {Fee} from "../types/Fee.sol";
+import {UFixed} from "../types/UFixed.sol";
+import {IBaseComponent} from "./IBaseComponent.sol";
+
+interface IPoolComponent is IBaseComponent {
+
+    event LogUnderwrittenByPool(NftId policyNftId, uint256 collateralizationAmount, address pool);
+
+    function setFees(
+        Fee memory poolFee,
+        Fee memory stakingFee,
+        Fee memory performanceFee
+    ) external;
+
+    /**
+     * @dev creates a new bundle for this pool.
+     */
+    function createBundle(
+        Fee memory fee,
+        uint256 initialAmount,
+        uint256 lifetime,
+        bytes memory filter
+    ) external returns(NftId bundleNftId);
+
+    function setBundleFee(
+        NftId policyNftId, 
+        Fee memory fee
+    ) external;
+
+    /** 
+     * @dev this is a callback function that is called by the product service when underwriting a policy.
+     * the pool has the option to check the details and object to underwriting by reverting.
+     * the function is only called for "active" pools that ask to be involved/notified
+     * by product related state changes.
+     */
+    function underwrite(
+        NftId policyNftId, 
+        bytes memory policyData,
+        bytes memory bundleFilter,
+        uint256 collateralizationAmount
+    ) external;
+
+    /**
+     * @dev returns true iff the policy application data in policyData matches
+     * with the bundle filter criteria encoded in bundleFilter. 
+     */
+    function policyMatchesBundle(
+        bytes memory policyData,
+        bytes memory bundleFilter
+    )
+        external
+        view
+        returns (bool isMatching);
+
+    function isVerifying() external view returns (bool verifying);
+
+    function getCollateralizationLevel() external view returns (UFixed collateralizationLevel);
+
+    function getPoolFee() external view returns (Fee memory poolFee);
+
+    function getStakingFee() external view returns (Fee memory stakingFee);
+
+    function getPerformanceFee()
+        external
+        view
+        returns (Fee memory performanceFee);
+}

package/contracts/components/IProductComponent.sol

@@ -0,0 +1,38 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {Fee} from "../types/Fee.sol";
+import {NftId} from "../types/NftId.sol";
+import {ReferralId} from "../types/ReferralId.sol";
+import {RiskId} from "../types/RiskId.sol";
+
+import {IBaseComponent} from "./IBaseComponent.sol";
+
+interface IProductComponent is IBaseComponent {
+    function setFees(
+        Fee memory productFee,
+        Fee memory processingFee
+    ) external;
+
+    function calculatePremium(
+        uint256 sumInsuredAmount,
+        RiskId riskId,
+        uint256 lifetime,
+        bytes memory applicationData,
+        ReferralId referralId,
+        NftId bundleNftId
+    ) external view returns (uint256 premiumAmount);
+
+    function calculateNetPremium(
+        uint256 sumInsuredAmount,
+        RiskId riskId,
+        uint256 lifetime,
+        bytes memory applicationData
+    ) external view returns (uint256 netPremiumAmount);    
+
+    function getProductFee() external view returns (Fee memory productFee);
+    function getProcessingFee() external view returns (Fee memory processingFee);
+
+    function getPoolNftId() external view returns (NftId poolNftId);
+    function getDistributionNftId() external view returns (NftId distributionNftId);
+}