@etherisc/gif-next 0.0.2-9e6b423-414 → 0.0.2-9f1b659-471

package/contracts/registry/TokenRegistry.sol

@@ -6,8 +6,9 @@ import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IER
 
 import {IRegistry} from "./IRegistry.sol";
 import {IRegistryLinked} from "../shared/IRegistryLinked.sol";
+import {IStaking} from "../staking/IStaking.sol";
 
-import {ReleaseRegistry} from "./ReleaseRegistry.sol";
+import {ChainId, ChainIdLib} from "../type/ChainId.sol";
 import {RegistryAdmin} from "./RegistryAdmin.sol";
 import {VersionPart} from "../type/Version.sol";
 
@@ -17,42 +18,41 @@ contract TokenRegistry is
     AccessManaged,
     IRegistryLinked
 {
-    event LogTokenRegistryTokenRegistered(uint256 chainId, address token, uint256 decimals, string symbol);
-    event LogTokenRegistryTokenGlobalStateSet(uint256 chainId, address token, bool active);
-    event LogTokenRegistryTokenStateSet(uint256 chainId, address token, VersionPart majorVersion, bool active);
+    event LogTokenRegistryTokenRegistered(ChainId chainId, address token, uint256 decimals, string symbol);
+    event LogTokenRegistryTokenGlobalStateSet(ChainId chainId, address token, bool active);
+    event LogTokenRegistryTokenStateSet(ChainId chainId, address token, VersionPart release, bool active);
 
     error ErrorTokenRegistryChainIdZero();
     error ErrorTokenRegistryTokenAddressZero();
 
-    error ErrorTokenRegistryNotRemoteToken(uint256 chainId, address token);
-    error ErrorTokenRegistryTokenAlreadyRegistered(uint256 chainId, address token);
-    error ErrorTokenRegistryTokenNotContract(uint256 chainId, address token);
-    error ErrorTokenRegistryTokenNotErc20(uint256 chainId, address token);
+    error ErrorTokenRegistryNotRemoteToken(ChainId chainId, address token);
+    error ErrorTokenRegistryTokenAlreadyRegistered(ChainId chainId, address token);
+    error ErrorTokenRegistryTokenNotContract(ChainId chainId, address token);
+    error ErrorTokenRegistryTokenNotErc20(ChainId chainId, address token);
 
-    error ErrorTokenRegistryTokenNotRegistered(uint256 chainId, address token);
-    error ErrorTokenRegistryMajorVersionInvalid(VersionPart majorVersion);
+    error ErrorTokenRegistryTokenNotRegistered(ChainId chainId, address token);
+    error ErrorTokenRegistryMajorVersionInvalid(VersionPart release);
 
     struct TokenInfo {
         // slot 0
-        uint256 chainId;
+        ChainId chainId; // 96
+        address token; // 20
+        uint8 decimals; // 8
+        bool active;
         // slot 1
         string symbol;
-        // slot 2
-        address token;
-        uint8 decimals;
-        bool active;
     }
 
-    mapping(uint256 chainId => mapping(address token => TokenInfo info)) internal _tokenInfo;
-    mapping(uint256 chainId => mapping(address token => mapping(VersionPart majorVersion => bool isActive))) internal _active;
+    mapping(ChainId chainId => mapping(address token => TokenInfo info)) internal _tokenInfo;
+    mapping(ChainId chainId => mapping(address token => mapping(VersionPart release => bool isActive))) internal _active;
     TokenInfo [] internal _token;
 
     IRegistry internal _registry;
-    ReleaseRegistry internal _releaseRegistry;
+    ChainId internal _chainId = ChainIdLib.current();
     IERC20Metadata internal _dipToken;
 
     /// @dev enforces msg.sender is owner of nft (or initial owner of nft ownable)
-    modifier onlyRegisteredToken(uint256 chainId, address token) {
+    modifier onlyRegisteredToken(ChainId chainId, address token) {
         if (!isRegistered(chainId, token)) {
             revert ErrorTokenRegistryTokenNotRegistered(chainId, token);
         }
@@ -67,12 +67,13 @@ contract TokenRegistry is
         setAuthority(authority);
         
         _registry = registry;
+
+        // TODO deal with chains without a dip token
         _dipToken = _verifyOnchainToken(address(dipToken));
 
         // register dip token
-        uint256 chainId = block.chainid;
         _registerToken(
-            chainId, 
+            _chainId, 
             address(_dipToken), 
             _dipToken.decimals(), 
             _dipToken.symbol());
@@ -86,15 +87,18 @@ contract TokenRegistry is
         external
         restricted()
     {
+        // checks
         IERC20Metadata token = _verifyOnchainToken(tokenAddress);
-        _registerToken(block.chainid, tokenAddress, token.decimals(), token.symbol());
+
+        // effects
+        _registerToken(_chainId, tokenAddress, token.decimals(), token.symbol());
     }
 
 
     /// @dev register the remote token with the provided attributes.
     /// this function may not be used for tokens when chainId == block.chainid.
     function registerRemoteToken(
-        uint256 chainId,
+        ChainId chainId,
         address token,
         uint8 decimals,
         string memory symbol
@@ -102,7 +106,7 @@ contract TokenRegistry is
         external
         restricted()
     {
-        if (chainId == block.chainid) {
+        if (chainId == _chainId) {
             revert ErrorTokenRegistryNotRemoteToken(chainId, token);
         }
 
@@ -114,7 +118,7 @@ contract TokenRegistry is
     /// when setting a token to active=false isActive will return false
     /// regardless of release specific active value.
     function setActive(
-        uint256 chainId, 
+        ChainId chainId, 
         address token, 
         bool active
     )
@@ -127,32 +131,32 @@ contract TokenRegistry is
     }
 
 
-    /// @dev sets active state for specified token and major version.
+    /// @dev sets active state for specified token and release (major version).
     /// internally calls setActiveWithVersionCheck() with enforcing version check.
     /// token state is informative, registry have no clue about used tokens
     /// component owner is responsible for token selection and operations
     /// service MUST deny registration of component with inactive token.
     function setActiveForVersion(
-        uint256 chainId, 
+        ChainId chainId, 
         address token, 
-        VersionPart majorVersion, 
+        VersionPart release, 
         bool active
     )
         external
         restricted()
         onlyRegisteredToken(chainId, token)
     {
-        _setActiveWithVersionCheck(chainId, token, majorVersion, active, true);
+        _setActiveWithVersionCheck(chainId, token, release, active, true);
     }
 
 
     /// @dev as setActiveForVersion() with the option to skip the version check.
     /// enforcing the version check checks if the provided major version with the release manager. 
-    /// the function reverts if the provided majorVersion is unknown to the release manager.
+    /// the function reverts if the provided release is unknown to the release manager.
     function setActiveWithVersionCheck(
-        uint256 chainId, 
+        ChainId chainId, 
         address token, 
-        VersionPart majorVersion, 
+        VersionPart release, 
         bool active,
         bool enforceVersionCheck
     )
@@ -160,14 +164,14 @@ contract TokenRegistry is
         restricted()
         onlyRegisteredToken(chainId, token)
     {
-        _setActiveWithVersionCheck(chainId, token, majorVersion, active, enforceVersionCheck);
+        _setActiveWithVersionCheck(chainId, token, release, active, enforceVersionCheck);
     }
 
 
     function _setActiveWithVersionCheck(
-        uint256 chainId, 
+        ChainId chainId, 
         address token, 
-        VersionPart majorVersion, 
+        VersionPart release, 
         bool active,
         bool enforceVersionCheck
     )
@@ -175,15 +179,15 @@ contract TokenRegistry is
     {
         // verify valid major version
         if(enforceVersionCheck) {
-            uint256 version = majorVersion.toInt();
-            if (!getRegistry().isActiveRelease(majorVersion)) {
-                revert ErrorTokenRegistryMajorVersionInvalid(majorVersion);
+            uint256 version = release.toInt();
+            if (!getRegistry().isActiveRelease(release)) {
+                revert ErrorTokenRegistryMajorVersionInvalid(release);
             }
         }
 
-        _active[chainId][token][majorVersion] = active;
+        _active[chainId][token][release] = active;
 
-        emit LogTokenRegistryTokenStateSet(chainId, token, majorVersion, active);
+        emit LogTokenRegistryTokenStateSet(chainId, token, release, active);
     }
 
     /// @dev returns the dip token for this chain
@@ -202,17 +206,17 @@ contract TokenRegistry is
     }
 
     /// @dev returns the token info for the specified token coordinates.
-    function getTokenInfo(uint256 chainId, address token) external view returns (TokenInfo memory tokenInfo) {
+    function getTokenInfo(ChainId chainId, address token) external view returns (TokenInfo memory tokenInfo) {
         return _tokenInfo[chainId][token];
     }
 
     /// @dev returns true iff the specified token has been registered for this TokenRegistry contract.
-    function isRegistered(uint256 chainId, address token) public view returns (bool) {
-        return _tokenInfo[chainId][token].chainId > 0;
+    function isRegistered(ChainId chainId, address token) public view returns (bool) {
+        return _tokenInfo[chainId][token].chainId.gtz();
     }
 
     /// @dev returns true iff both the token is active for the specfied release and the global token state is active
-    function isActive(uint256 chainId, address token, VersionPart release) external view returns (bool) {
+    function isActive(ChainId chainId, address token, VersionPart release) external view returns (bool) {
         if(!_tokenInfo[chainId][token].active) {
             return false;
         }
@@ -243,16 +247,15 @@ contract TokenRegistry is
         returns (IERC20Metadata token)
     {
         token = IERC20Metadata(tokenAddress);
-        uint256 chainId = block.chainid;
 
         // MUST be contract
         if(tokenAddress.code.length == 0) {
-            revert ErrorTokenRegistryTokenNotContract(chainId, tokenAddress);
+            revert ErrorTokenRegistryTokenNotContract(ChainIdLib.current(), tokenAddress);
         }
 
         // MUST implement required erc20 view functions
         if(!_implementsErc20Functions(token)) {
-            revert ErrorTokenRegistryTokenNotErc20(chainId, tokenAddress);
+            revert ErrorTokenRegistryTokenNotErc20(ChainIdLib.current(), tokenAddress);
         }
     }
 
@@ -285,13 +288,13 @@ contract TokenRegistry is
     /// - token not yet registered
     /// - chainId not zero
     /// - token address not zero
-    function _registerToken(uint256 chainId, address token, uint8 decimals, string memory symbol) internal {
+    function _registerToken(ChainId chainId, address token, uint8 decimals, string memory symbol) internal {
 
         if (isRegistered(chainId, token)) {
             revert ErrorTokenRegistryTokenAlreadyRegistered(chainId, token);
         }
 
-        if(chainId == 0) {
+        if(chainId.eqz()) {
             revert ErrorTokenRegistryChainIdZero();
         }
 

package/contracts/shared/Component.sol

@@ -4,7 +4,7 @@ pragma solidity ^0.8.20;
 import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 
-import {Amount} from "../type/Amount.sol";
+import {Amount, AmountLib} from "../type/Amount.sol";
 import {IComponent} from "./IComponent.sol";
 import {IComponents} from "../instance/module/IComponents.sol";
 import {IComponentService} from "./IComponentService.sol";
@@ -46,7 +46,7 @@ abstract contract Component is
     }
 
 
-    function _initializeComponent(
+    function __Component_init(
         address authority,
         address registry,
         NftId parentNftId,
@@ -152,7 +152,11 @@ abstract contract Component is
     function _approveTokenHandler(IERC20Metadata token, Amount amount)
         internal
         virtual
+        returns (Amount oldAllowanceAmount)
     {
+        oldAllowanceAmount = AmountLib.toAmount(
+            token.allowance(address(getTokenHandler()), address(this)));
+
         _getComponentStorage()._componentService.approveTokenHandler(
             token, 
             amount);

package/contracts/shared/ComponentService.sol

@@ -11,19 +11,21 @@ import {IInstanceLinkedComponent} from "./IInstanceLinkedComponent.sol";
 import {InstanceAdmin} from "../instance/InstanceAdmin.sol";
 import {InstanceReader} from "../instance/InstanceReader.sol";
 import {InstanceStore} from "../instance/InstanceStore.sol";
-import {IInstanceService} from "../instance/IInstanceService.sol";
 import {IPoolComponent} from "../pool/IPoolComponent.sol";
 import {IProductComponent} from "../product/IProductComponent.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IRegistryService} from "../registry/IRegistryService.sol";
+import {IStaking} from "../staking/IStaking.sol";
+import {IStakingService} from "../staking/IStakingService.sol";
 
 import {AccessManagerCloneable} from "../authorization/AccessManagerCloneable.sol";
 import {Amount, AmountLib} from "../type/Amount.sol";
+import {ChainIdLib} from "../type/ChainId.sol";
 import {ContractLib} from "../shared/ContractLib.sol";
 import {Fee, FeeLib} from "../type/Fee.sol";
 import {KEEP_STATE} from "../type/StateId.sol";
 import {NftId, NftIdLib} from "../type/NftId.sol";
-import {ObjectType, ACCOUNTING, REGISTRY, COMPONENT, DISTRIBUTION, INSTANCE, ORACLE, POOL, PRODUCT} from "../type/ObjectType.sol";
+import {ObjectType, ACCOUNTING, REGISTRY, COMPONENT, DISTRIBUTION, INSTANCE, ORACLE, POOL, PRODUCT, STAKING} from "../type/ObjectType.sol";
 import {Service} from "../shared/Service.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
 import {TokenHandlerDeployerLib} from "../shared/TokenHandlerDeployerLib.sol";
@@ -38,7 +40,7 @@ contract ComponentService is
 
     IAccountingService private _accountingService;
     IRegistryService private _registryService;
-    IInstanceService private _instanceService;
+    IStaking private _staking;
 
     function _initialize(
         address owner, 
@@ -57,7 +59,7 @@ contract ComponentService is
 
         _accountingService = IAccountingService(_getServiceAddress(ACCOUNTING()));
         _registryService = IRegistryService(_getServiceAddress(REGISTRY()));
-        _instanceService = IInstanceService(_getServiceAddress(INSTANCE()));
+        _staking = IStakingService(_getServiceAddress(STAKING())).getStaking();
 
         _registerInterface(type(IComponentService).interfaceId);
     }
@@ -142,6 +144,7 @@ contract ComponentService is
         instance.getInstanceAdmin().setComponentLocked(
             component, 
             locked);
+        emit LogComponentServiceComponentLocked(component, locked);
     }
 
 
@@ -219,10 +222,16 @@ contract ComponentService is
         }
 
         IInstance instance = IInstance(msg.sender);
+        NftId instanceNftId = registry.getNftIdForAddress(msg.sender);
         productNftId = _verifyAndRegister(
             instance, 
             productAddress, 
-            instance.getNftId(), // instance is parent of product to be registered 
+            instanceNftId, // instance is parent of product to be registered 
+            token);
+
+        // add product specific token for product to staking
+        _staking.addTargetToken(
+            instanceNftId, 
             token);
     }
 
@@ -560,8 +569,8 @@ contract ComponentService is
             // check if provided token is whitelisted and active
             if (!ContractLib.isActiveToken(
                 getRegistry().getTokenRegistryAddress(), 
+                ChainIdLib.current(), 
                 token, 
-                block.chainid, 
                 AccessManagerCloneable(authority()).getRelease())
             ) {
                 revert ErrorComponentServiceTokenInvalid(token);

package/contracts/shared/ContractLib.sol

@@ -9,6 +9,7 @@ import {IPolicyHolder} from "../shared/IPolicyHolder.sol";
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IService} from "../shared/IService.sol";
 
+import {ChainId} from "../type/ChainId.sol";
 import {NftId} from "../type/NftId.sol";
 import {ObjectType, INSTANCE, PRODUCT, DISTRIBUTION, ORACLE, POOL} from "../type/ObjectType.sol";
 import {VersionPart} from "../type/Version.sol";
@@ -22,7 +23,7 @@ interface IInstanceAdminHelper {
 }
 
 interface ITokenRegistryHelper {
-    function isActive(uint256 chainId, address token, VersionPart release) external view returns (bool);
+    function isActive(ChainId chainId, address token, VersionPart release) external view returns (bool);
 }
 
 library ContractLib {
@@ -114,8 +115,8 @@ library ContractLib {
 
     function isActiveToken(
         address tokenRegistryAddress,
+        ChainId chainId, 
         address token,
-        uint256 chainId, 
         VersionPart release
     )
         external 

package/contracts/shared/IComponent.sol

@@ -40,7 +40,7 @@ interface IComponent is
     function getTokenHandler() external view returns (TokenHandler tokenHandler);
 
     /// @dev defines the wallet address used to hold the ERC20 tokens related to this component
-    /// the default address is the component token address
+    /// the default address is the token handler address
     function getWallet() external view returns (address walletAddress);
 
     /// @dev returns true iff this compoent intercepts nft minting and transfers for objects registered by this component

package/contracts/shared/IComponentService.sol

@@ -45,6 +45,7 @@ interface IComponentService is
     error ErrorComponentServiceWithdrawAmountExceedsLimit(Amount withdrawnAmount, Amount withdrawLimit);
     error ErrorComponentServiceWalletAllowanceTooSmall(address wallet, address spender, uint256 allowance, uint256 amount);
 
+    event LogComponentServiceComponentLocked(address component, bool locked);
     event LogComponentServiceRegistered(NftId instanceNftId, NftId componentNftId, ObjectType componentType, address component, address token, address initialOwner); 
     event LogComponentServiceWalletAddressChanged(NftId componentNftId, address currentWallet, address newWallet);
     event LogComponentServiceWalletTokensTransferred(NftId componentNftId, address currentWallet, address newWallet, uint256 currentBalance);

package/contracts/shared/IKeyValueStore.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Blocknumber, blockBlocknumber, zeroBlocknumber} from "../type/Blocknumber.sol";
+import {Blocknumber} from "../type/Blocknumber.sol";
 import {Key32, KeyId} from "../type/Key32.sol";
 import {NftId} from "../type/NftId.sol";
 import {ObjectType} from "../type/ObjectType.sol";

package/contracts/shared/INftOwnable.sol

@@ -11,6 +11,8 @@ interface INftOwnable is
     IERC165,
     IRegistryLinked
 {
+    event LogNftOwnableNftLinkedToAddress(NftId nftId, address owner);
+    
     error ErrorNftOwnableInitialOwnerZero();
     error ErrorNftOwnableNotOwner(address account);
     error ErrorNftOwnableInvalidType(NftId nftId, ObjectType expectedObjectType);

package/contracts/shared/InstanceLinkedComponent.sol

@@ -52,12 +52,12 @@ abstract contract InstanceLinkedComponent is
     }
 
     /// @inheritdoc IInstanceLinkedComponent
-    function getInstance() public view override returns (IInstance instance) {
+    function getInstance() public view virtual override returns (IInstance instance) {
         return _getInstanceLinkedComponentStorage()._instance;
     }
 
     /// @inheritdoc IInstanceLinkedComponent
-    function getAuthorization() external view returns (IAuthorization authorization) {
+    function getAuthorization() external view virtual returns (IAuthorization authorization) {
         return _getInstanceLinkedComponentStorage()._initialAuthorization;
     }
 
@@ -67,7 +67,7 @@ abstract contract InstanceLinkedComponent is
         }
     }
 
-    function _initializeInstanceLinkedComponent(
+    function __InstanceLinkedComponent_init(
         address registry,
         NftId parentNftId,
         string memory name,
@@ -93,7 +93,7 @@ abstract contract InstanceLinkedComponent is
             IRegistry(registry).getObjectAddress(instanceNftId));
 
         // set component specific parameters
-        _initializeComponent(
+        __Component_init(
             $._instance.authority(), // instance linked components need to point to instance admin
             registry, 
             parentNftId, 

package/contracts/shared/KeyValueStore.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Blocknumber, blockBlocknumber, zeroBlocknumber} from "../type/Blocknumber.sol";
+import {Blocknumber, BlocknumberLib} from "../type/Blocknumber.sol";
 import {Key32, KeyId, Key32Lib} from "../type/Key32.sol";
 import {NftId} from "../type/NftId.sol";
 import {ObjectType} from "../type/ObjectType.sol";
@@ -38,7 +38,7 @@ abstract contract KeyValueStore is
             revert ErrorKeyValueStoreNoLifecycle(objectType);
         }
 
-        Blocknumber blocknumber = blockBlocknumber();
+        Blocknumber blocknumber = BlocknumberLib.current();
         StateId initialState = getInitialState(objectType);
 
         // set metadata
@@ -102,7 +102,7 @@ abstract contract KeyValueStore is
         }
 
         // update metadata
-        metadata.updatedIn = blockBlocknumber();
+        metadata.updatedIn = BlocknumberLib.current();
     }
 
     function exists(Key32 key32) public view returns (bool) {

package/contracts/shared/NftOwnable.sol

@@ -114,6 +114,8 @@ contract NftOwnable is
 
         $._nftId = getRegistry().getNftIdForAddress(nftOwnableAddress);
 
+        emit LogNftOwnableNftLinkedToAddress($._nftId, getOwner());
+
         return $._nftId;
     }
 

package/contracts/shared/PolicyHolder.sol

@@ -3,12 +3,13 @@ pragma solidity ^0.8.20;
 
 import {IERC721Receiver} from "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
 
+import {IPolicyHolder} from "./IPolicyHolder.sol";
+
 import {Amount} from "../type/Amount.sol";
 import {ClaimId} from "../type/ClaimId.sol";
 import {InitializableERC165} from "./InitializableERC165.sol";
-import {IPolicyHolder} from "./IPolicyHolder.sol";
 import {NftId} from "../type/NftId.sol";
-import {PayoutId, PayoutIdLib} from "../type/PayoutId.sol";
+import {PayoutId} from "../type/PayoutId.sol";
 import {RegistryLinked} from "./RegistryLinked.sol";
 import {Timestamp} from "../type/Timestamp.sol";