@etherisc/gif-next 0.0.2-8459327 → 0.0.2-84ca396-317

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": "0x61039161003a600b82828239805160001a60731461002d57634e487b7160e01b600052600060045260246000fd5b30600052607381538281f3fe73000000000000000000000000000000000000000030146080604052600436106100925760003560e01c80638e4ad86c116100655780638e4ad86c1461012157806394aa449c14610144578063a123b37c14610152578063c9e66e291461017957600080fd5b806304b8f6c5146100975780632efe0113146100b357806349a7111a146100c657806355601007146100fd575b600080fd5b60005b60405162ffffff90911681526020015b60405180910390f35b61009a6100c136600461026e565b610190565b6100d96100d436600461029a565b610231565b6040805160ff948516815292841660208401529216918101919091526060016100aa565b61011361010b36600461029a565b62ffffff1690565b6040519081526020016100aa565b61013261012f3660046102c6565b90565b60405160ff90911681526020016100aa565b61009a61012f3660046102df565b61016061010b36600461029a565b60405167ffffffffffffffff90911681526020016100aa565b61013261018736600461029a565b60101c60ff1690565b6000610100841080156101a4575061010083105b80156101b1575061010082105b61020c5760405162461bcd60e51b815260206004820152602260248201527f4552524f523a5652532d3031303a56455253494f4e5f504152545f544f4f5f42604482015261494760f01b606482015260840160405180910390fd5b8161021f600885901b601087901b61031f565b610229919061031f565b949350505050565b600080808360ff601082901c166102488383610338565b915061ffff600883901c16600061025f8185610338565b92989197509195509350505050565b60008060006060848603121561028357600080fd5b505081359360208301359350604090920135919050565b6000602082840312156102ac57600080fd5b813562ffffff811681146102bf57600080fd5b9392505050565b6000602082840312156102d857600080fd5b5035919050565b6000602082840312156102f157600080fd5b813567ffffffffffffffff811681146102bf57600080fd5b634e487b7160e01b600052601160045260246000fd5b8082018082111561033257610332610309565b92915050565b62ffffff82811682821603908082111561035457610354610309565b509291505056fea264697066735822122096e4b37266f82e0aaf6f30afa90c545c35f82576ca3b67d630233921e58f525b64736f6c63430008140033",
+  "deployedBytecode": "0x73000000000000000000000000000000000000000030146080604052600436106100925760003560e01c80638e4ad86c116100655780638e4ad86c1461012157806394aa449c14610144578063a123b37c14610152578063c9e66e291461017957600080fd5b806304b8f6c5146100975780632efe0113146100b357806349a7111a146100c657806355601007146100fd575b600080fd5b60005b60405162ffffff90911681526020015b60405180910390f35b61009a6100c136600461026e565b610190565b6100d96100d436600461029a565b610231565b6040805160ff948516815292841660208401529216918101919091526060016100aa565b61011361010b36600461029a565b62ffffff1690565b6040519081526020016100aa565b61013261012f3660046102c6565b90565b60405160ff90911681526020016100aa565b61009a61012f3660046102df565b61016061010b36600461029a565b60405167ffffffffffffffff90911681526020016100aa565b61013261018736600461029a565b60101c60ff1690565b6000610100841080156101a4575061010083105b80156101b1575061010082105b61020c5760405162461bcd60e51b815260206004820152602260248201527f4552524f523a5652532d3031303a56455253494f4e5f504152545f544f4f5f42604482015261494760f01b606482015260840160405180910390fd5b8161021f600885901b601087901b61031f565b610229919061031f565b949350505050565b600080808360ff601082901c166102488383610338565b915061ffff600883901c16600061025f8185610338565b92989197509195509350505050565b60008060006060848603121561028357600080fd5b505081359360208301359350604090920135919050565b6000602082840312156102ac57600080fd5b813562ffffff811681146102bf57600080fd5b9392505050565b6000602082840312156102d857600080fd5b5035919050565b6000602082840312156102f157600080fd5b813567ffffffffffffffff811681146102bf57600080fd5b634e487b7160e01b600052601160045260246000fd5b8082018082111561033257610332610309565b92915050565b62ffffff82811682821603908082111561035457610354610309565b509291505056fea264697066735822122096e4b37266f82e0aaf6f30afa90c545c35f82576ca3b67d630233921e58f525b64736f6c63430008140033",
+  "linkReferences": {},
+  "deployedLinkReferences": {}
+}

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

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

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

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

package/contracts/components/Component.sol

@@ -1,60 +1,177 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.20;
 
-import {IRegistry, IRegisterable, IRegistryLinked} from "../registry/IRegistry.sol";
-import {Registerable} from "../registry/Registry.sol";
+import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {IComponent} from "./IComponent.sol";
+import {IProductService} from "../instance/service/IProductService.sol";
+import {IInstanceService} from "../instance/IInstanceService.sol";
 import {IInstance} from "../instance/IInstance.sol";
+import {InstanceAccessManager} from "../instance/InstanceAccessManager.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {NftId, zeroNftId, NftIdLib} from "../types/NftId.sol";
+import {ObjectType, INSTANCE, PRODUCT} from "../types/ObjectType.sol";
+import {VersionLib} from "../types/Version.sol";
+import {Registerable} from "../shared/Registerable.sol";
+import {RoleId, RoleIdLib} from "../types/RoleId.sol";
+import {IAccess} from "../instance/module/IAccess.sol";
 
-import {IInstanceLinked, IComponent, IComponentContract, IComponentModule, IComponentOwnerService} from "../instance/component/IComponent.sol";
-import {NftId} from "../types/NftId.sol";
+// TODO discuss to inherit from oz accessmanaged
+// TODO make contract upgradeable, then add ComponentUpradeable that also intherits from Versionable
+// same pattern as for Service which is also upgradeable
+abstract contract Component is
+    Registerable,
+    IComponent
+{
+    IInstanceService internal _instanceService;
+    IProductService internal _productService;
 
-contract InstanceLinked is IInstanceLinked {
     IInstance internal _instance;
+    IERC20Metadata internal _token;
+    address internal _wallet;
+    NftId internal _productNftId;
 
-    constructor(address instance) {
-        _instance = IInstance(instance);
+    modifier onlyProductService() {
+        if(msg.sender != address(_productService)) {
+            revert ErrorComponentNotProductService(msg.sender);
+        }
+        _;
     }
 
-    // function setInstance(address instance) public override {
-    //     require(address(_instance) == address(0), "ERROR:RGL-001:INSTANCE_ALREADY_SET");
-    //     _instance = IInstance(instance);
-    // }
-
-    function getInstance() public view override returns (IInstance instance) {
-        return _instance;
+    // TODO discuss replacement with modifier restricted from accessmanaged
+    modifier onlyInstanceRole(uint64 roleIdNum) {
+        RoleId roleId = RoleIdLib.toRoleId(roleIdNum);
+        InstanceAccessManager accessManager = InstanceAccessManager(_instance.authority());
+        if( !accessManager.hasRole(roleId, msg.sender)) {
+            revert ErrorComponentUnauthorized(msg.sender, roleIdNum);
+        }
+        _;
     }
-}
 
-abstract contract Component is
-    Registerable,
-    InstanceLinked,
-    IComponentContract
-{
-    address private _deployer;
+    // TODO discuss replacement with modifier restricted from accessmanaged
+    modifier isNotLocked() {
+        InstanceAccessManager accessManager = InstanceAccessManager(_instance.authority());
+        if (accessManager.isTargetLocked(address(this))) {
+            revert IAccess.ErrorIAccessTargetLocked(address(this));
+        }
+        _;
+    }
 
     constructor(
         address registry,
-        address instance
-    ) Registerable(registry) InstanceLinked(instance) {}
+        NftId instanceNftId,
+        address token,
+        ObjectType componentType,
+        bool isInterceptor,
+        address initialOwner
+    )
+    {
+        bytes memory data = "";
+        _initializeRegisterable(registry, instanceNftId, componentType, isInterceptor, initialOwner, data);
 
-    // from registerable
-    function register() public override returns (NftId componentId) {
-        require(msg.sender == getInitialOwner(), "");
-        require(
-            address(_registry) != address(0),
-            "ERROR:PRD-001:REGISTRY_ZERO"
-        );
+        IRegistry.ObjectInfo memory instanceInfo = _registry.getObjectInfo(instanceNftId);
+        _instance = IInstance(instanceInfo.objectAddress);
         require(
-            _registry.isRegistered(address(_instance)),
-            "ERROR:PRD-002:INSTANCE_NOT_REGISTERED"
+            _instance.supportsInterface(type(IInstance).interfaceId),
+            ""
         );
 
-        IComponentOwnerService cos = _instance.getComponentOwnerService();
-        componentId = cos.register(this);
+        _instanceService = IInstanceService(_registry.getServiceAddress(INSTANCE(), VersionLib.toVersion(3, 0, 0).toMajorPart()));
+        _productService = IProductService(_registry.getServiceAddress(PRODUCT(), VersionLib.toVersion(3, 0, 0).toMajorPart()));
+        _wallet = address(this);
+        _token = IERC20Metadata(token);
+
+        _registerInterface(type(IComponent).interfaceId);
+    }
+
+    // TODO discuss replacement with modifier restricted from accessmanaged
+    function lock() external onlyOwner override {
+        _instanceService.setTargetLocked(getName(), true);
+    }
+    
+    // TODO discuss replacement with modifier restricted from accessmanaged
+    function unlock() external onlyOwner override {
+        _instanceService.setTargetLocked(getName(), false);
+    }
+
+    // TODO discuss to split this base contract into a minimal component base (eg oracle)
+    // and a component base that is linked to a product component (all others in v3)
+    function setProductNftId(NftId productNftId)
+        external
+        override
+        onlyProductService() 
+    {
+        if(_productNftId.gtz()) {
+            revert ErrorComponentProductNftAlreadySet();
+        }
+
+        _productNftId = productNftId;
+    }
+
+    /// @dev Sets the wallet address for the component. 
+    /// if the current wallet has tokens, these will be transferred. 
+    /// if the new wallet address is externally owned, an approval from the 
+    /// owner of the external wallet for the component to move all tokens must exist. 
+    function setWallet(address newWallet) external override onlyOwner {
+        address currentWallet = _wallet;
+        uint256 currentBalance = _token.balanceOf(currentWallet);
+
+        // checks
+        if (newWallet == currentWallet) {
+            revert ErrorComponentWalletAddressIsSameAsCurrent(newWallet);
+        }
+
+        if (currentBalance > 0) {
+            if (currentWallet == address(this)) {
+                // move tokens from component smart contract to external wallet
+            } else {
+                // move tokens from external wallet to component smart contract or another external wallet
+                uint256 allowance = _token.allowance(currentWallet, address(this));
+                if (allowance < currentBalance) {
+                    revert ErrorComponentWalletAllowanceTooSmall(currentWallet, newWallet, allowance, currentBalance);
+                }
+            }
+        }
+
+        // effects
+        _wallet = newWallet;
+        emit LogComponentWalletAddressChanged(newWallet);
+
+        // interactions
+        if (currentBalance > 0) {
+            // transfer tokens from current wallet to new wallet
+            if (currentWallet == address(this)) {
+                // transferFrom requires self allowance too
+                _token.approve(address(this), currentBalance);
+            }
+            
+            SafeERC20.safeTransferFrom(_token, currentWallet, newWallet, currentBalance);
+            emit LogComponentWalletTokensTransferred(currentWallet, newWallet, currentBalance);
+        }
+    }
+
+    // TODO set name via constructor or initialization, pure function likely too restrictive
+    function getName() public pure virtual returns (string memory name);
+
+    function getWallet()
+        external
+        view
+        override
+        returns (address walletAddress)
+    {
+        return _wallet;
+    }
+
+    function getToken() public view override returns (IERC20Metadata token) {
+        return _token;
+    }
+
+    function getInstance() public view override returns (IInstance instance) {
+        return _instance;
     }
 
-    // from registerable
-    function getParentNftId() public view override returns (NftId) {
-        return getInstance().getNftId();
+    function getProductNftId() public view override returns (NftId productNftId) {
+        return _productNftId;
     }
 }

package/contracts/components/Distribution.sol

@@ -0,0 +1,154 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.19;
+
+import {DISTRIBUTION} from "../types/ObjectType.sol";
+import {IDistributionService} from "../instance/service/IDistributionService.sol";
+import {IProductService} from "../instance/service/IProductService.sol";
+import {NftId, zeroNftId, NftIdLib} from "../types/NftId.sol";
+import {ReferralId} from "../types/Referral.sol";
+import {Fee, FeeLib} from "../types/Fee.sol";
+import {Component} from "./Component.sol";
+import {IDistributionComponent} from "./IDistributionComponent.sol";
+import {IRegistry} from "../registry/IRegistry.sol";
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {ISetup} from "../instance/module/ISetup.sol";
+import {Registerable} from "../shared/Registerable.sol";
+import {TokenHandler} from "../shared/TokenHandler.sol";
+import {InstanceReader} from "../instance/InstanceReader.sol";
+
+abstract contract Distribution is
+    Component,
+    IDistributionComponent
+{
+    using NftIdLib for NftId;
+
+    Fee internal _initialDistributionFee;
+    bool internal _isVerifying;
+
+    TokenHandler internal _tokenHandler;
+
+    IDistributionService private _distributionService;
+
+    constructor(
+        address registry,
+        NftId instanceNftId,
+        // TODO refactor into tokenNftId
+        address token,
+        bool verifying,
+        Fee memory distributionFee,
+        address initialOwner
+    )
+        Component(registry, instanceNftId, token, DISTRIBUTION(), true, initialOwner)
+    {
+        _isVerifying = verifying;
+        _initialDistributionFee = distributionFee;
+
+        _tokenHandler = TokenHandler(token);
+        _distributionService = _instance.getDistributionService();
+
+        _registerInterface(type(IDistributionComponent).interfaceId);
+    }
+
+
+    function setFees(
+        Fee memory distributionFee
+    )
+        external
+        override
+    {
+        _distributionService.setFees(distributionFee);
+    }
+
+    function calculateFeeAmount(
+        ReferralId referralId,
+        uint256 netPremiumAmount
+    )
+        external
+        view
+        virtual override
+        returns (uint256 feeAmount)
+    {
+        ISetup.DistributionSetupInfo memory setupInfo = getSetupInfo();
+        Fee memory fee = setupInfo.distributionFee;
+        (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;
+    }
+
+    function getSetupInfo() public view returns (ISetup.DistributionSetupInfo memory setupInfo) {
+        InstanceReader reader = _instance.getInstanceReader();
+        return reader.getDistributionSetupInfo(getNftId());
+    }
+    
+
+    /// @dev returns true iff the component needs to be called when selling/renewing policis
+    function isVerifying() external view returns (bool verifying) {
+        return _isVerifying;
+    }
+
+    // from IRegisterable
+
+    function getInitialInfo() 
+        public 
+        view
+        override (IRegisterable, Registerable)
+        returns(IRegistry.ObjectInfo memory, bytes memory)
+    {
+        (
+            IRegistry.ObjectInfo memory info, 
+        ) = super.getInitialInfo();
+
+        return (
+            info,
+            abi.encode(
+                getName(),
+                ISetup.DistributionSetupInfo(
+                    _productNftId,
+                    _tokenHandler,
+                    _initialDistributionFee,
+                    _isVerifying,
+                    address(this)
+                )
+            )
+        );
+    }
+}

package/contracts/components/IComponent.sol

@@ -0,0 +1,37 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {IRegisterable} from "../shared/IRegisterable.sol";
+import {IInstance} from "../instance/IInstance.sol";
+import {NftId} from "../types/NftId.sol";
+
+interface IComponent is IRegisterable {
+
+    error ErrorComponentProductNftAlreadySet();
+    error ErrorComponentWalletAddressIsSameAsCurrent(address newWallet);
+    error ErrorComponentWalletAllowanceTooSmall(address oldWallet, address newWallet, uint256 allowance, uint256 balance);
+    error ErrorComponentUnauthorized(address caller, uint64 requiredRoleIdNum);
+    error ErrorComponentNotProductService(address caller);
+
+    event LogComponentWalletAddressChanged(address newWallet);
+    event LogComponentWalletTokensTransferred(address from, address to, uint256 amount);
+
+    function getName() external pure returns (string memory name);
+
+    // TODO remove and replace with accessmanaged target locking mechanism
+    function lock() external;
+    function unlock() external;
+
+    function getToken() external view returns (IERC20Metadata token);
+
+    function setWallet(address walletAddress) external;
+    function getWallet() external view returns (address walletAddress);
+
+    function getInstance() external view returns (IInstance instance);
+
+    function setProductNftId(NftId productNftId) external;
+    function getProductNftId() external view returns (NftId productNftId);
+
+}