Migrated to OZ v5 (#6)

* Migrated to OZ v5

* integrated with new versions of solarity and openzeppelin

* updated package-lock

* switched to custom errors

* cleaned up

* refactored error naming

* renamed claimTopicKey to contextKey, claimTopic to handleTopic

* fixed typos

* fixed inits in example

* returned accidentally missing part

* updated examples folder

* Added erc721 (#7)

* created transaction context for both nft and token

* added NFT F initial version

* updated naming

* updated dependencies

* fixed typo

* updated readme

* added example of NFTF contract

* review fixes

* handle topic -> handler topic

* updated package-lock files

* fixed typos

* created IAssetF interface for Context and common errors

* added onlyInitializing to init functions

* updated minimal solidity version to ^0.8.21

* added storage buckets to the modules

* updated the architecture diagram

* updated version to 0.3.0

* added tokenURI to NFTF

* updated diagram to capture ERC20 and ERC721

* updated dependency

* fixed diagram

* few fixes

* moved TokenF and NFTF contracts from core folder

* updated diagram

* calldata -> memory in public functions

* TransferLimitsModule -> ERC20TransferLimitsModule

* EquityNFT -> LandNFT

* added ERC721TransferLimitsModule

* added LandERC721TransferLimitsModule to examples

* added INFTF to supported interfaces

* updated scripts

* added AbstractAssetF contract

* order consistency fix

* fixed ERC721TransferLimitsModule formula

* cleaned up ERC721TransferLimitsModule test

* review fix

* updated diagram

* fix

---------

Co-authored-by: aritkulova <94910987+aritkulova@users.noreply.github.com>
Co-authored-by: Artem Chystiakov <artem.ch31@gmail.com>

Author: 3 people

.env.example

@@ -1,12 +1 @@
-# Deployer private key
-PRIVATE_KEY=YOUR PRIVATE KEY
-
-# RPC Endpoints
-INFURA_KEY=INFURA PROJECT ID
-
-# Additional keys
-ETHERSCAN_KEY=ETHERSCAN API KEY
-BSCSCAN_KEY=BSCSCAN API KEY
-POLYGONSCAN_KEY=POLYGONSCAN API KEY
-AVALANCHE_KEY=AVALANCHE API KEY
 COINMARKETCAP_KEY=COINMARKETCAP API KEY

.solhint.json

@@ -9,6 +9,8 @@
     "func-visibility": "off",
     "max-states-count": "off",
     "not-rely-on-time": "off",
-    "compiler-version": "off"
+    "compiler-version": "off",
+    "func-name-mixedcase": "off",
+    "no-inline-assembly": "off"
   }
 }

README.md

@@ -5,25 +5,29 @@
 
 Bring Real World Assets (RWA) on-chain via flexible tokenization framework - TokenF.
 
-!["TokenF Architecture"](https://github.com/dl-tokenf/core-contracts/assets/47551140/9e912d07-bc4d-407d-bf25-859e0da40f32)
+TokenF and NFTF architecture:
+
+!["AssetF Architecture"](https://github.com/user-attachments/assets/5594c199-db9b-4aa3-b16a-5b464621311c)
+
+Built with [Solarity](https://github.com/dl-solarity), [OpenZeppelin](https://github.com/OpenZeppelin/openzeppelin-contracts), and aspiration to perfection.
 
-Built with [Solarity](https://github.com/dl-solarity), [Openzeppelin](https://github.com/OpenZeppelin/openzeppelin-contracts), and aspiration to perfection.
 
 ## Application
 
-TokenF is an on-chain framework that enables development, management, and deployment of permissioned ERC-20-compatible assets on EVM networks. TokenF enables custom rules to be configured for RWA tokens, providing flexible KYC/AML and regulatory compliance checks for the users to abide during interaction with the smart contracts.
+TokenF is an on-chain framework that enables development, management, and deployment of permissioned ERC-20-compatible and ERC-721-compatible assets on EVM networks. TokenF enables custom rules to be configured for RWA tokens, providing flexible KYC/AML and regulatory compliance checks for the users to abide during interaction with the smart contracts.
 
-TokenF is built with certain levels of abstraction in mind: 
+TokenF is built with certain levels of abstraction in mind:
 
 - ERC-2535 Diamond beating heart that allows extensibility and upgradeability.
 - Support of custom compliance modules to be plugged in the TokenF core.
 - Rich configuration of check/hooks/behavior with imagination being the only limit.
 
-| **What TokenF Is ✅**                        | **What TokenF Is Not ❌**        |
-| :-----------------------------------------:  | :------------------------------: |
-| On-chain tokenization framework              | Fullstack tokenization framework |
-| Smart contracts to configure RWA behavior    | RWA launchpad/RWA consulting set |
-| Reimagined and enhanced ERC-3643 alternative | Yet another ERC-3643 copy        |
+| **What TokenF Is ✅**                        | **What TokenF Is Not ❌**           |
+| :-----------------------------------------:  | :---------------------------------: |
+| On-chain tokenization framework              | Fullstack tokenization framework    |
+| Smart contracts to configure RWA behavior    | RWA launchpad/RWA consulting set    |
+| Built from scratch ERC-3643 alternative      | Yet another ERC-3643 copy           |
+| Support of both ERC-20 and ERC-721 standards | Currently does not support ERC-1155 |
 
 > [!NOTE]
 > TokenF is at the early stage of development, many breaking changes are foreseen.
@@ -41,13 +45,20 @@ npm install @tokenf/contracts
 You will then be able to start using TokenF:
 
 ```solidity
-pragma solidity ^0.8.20;
+pragma solidity ^0.8.21;
 
-import {TokenF} from "@tokenf/contracts/core/TokenF.sol";
+import {TokenF} from "@tokenf/contracts/TokenF.sol";
+import {NFTF} from "@tokenf/contracts/NFTF.sol";
 
 contract EquityToken is TokenF {
     . . .
 }
+
+// or
+
+contract LandNft is NFTF {
+    . . .
+}
 ```
 
 > [!TIP]

contracts/AbstractAssetF.sol

@@ -0,0 +1,82 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.21;
+
+import {Diamond} from "@solarity/solidity-lib/diamond/Diamond.sol";
+
+import {IAssetF} from "./interfaces/IAssetF.sol";
+import {IKYCCompliance} from "./interfaces/core/IKYCCompliance.sol";
+import {IRegulatoryCompliance} from "./interfaces/core/IRegulatoryCompliance.sol";
+
+import {AgentAccessControl} from "./core/AgentAccessControl.sol";
+import {RegulatoryComplianceStorage} from "./storages/core/RegulatoryComplianceStorage.sol";
+import {KYCComplianceStorage} from "./storages/core/KYCComplianceStorage.sol";
+
+abstract contract AbstractAssetF is IAssetF, Diamond, AgentAccessControl {
+    bytes4 public constant RECOVERY_SELECTOR = this.recovery.selector;
+
+    function __AbstractAssetF_init(
+        address regulatoryCompliance_,
+        address kycCompliance_,
+        bytes memory initRegulatory_,
+        bytes memory initKYC_
+    ) internal virtual onlyInitializing {
+        bytes4[] memory rComplianceSelectors_ = new bytes4[](6);
+        rComplianceSelectors_[0] = IRegulatoryCompliance.addRegulatoryModules.selector;
+        rComplianceSelectors_[1] = IRegulatoryCompliance.removeRegulatoryModules.selector;
+        rComplianceSelectors_[2] = IRegulatoryCompliance.transferred.selector;
+        rComplianceSelectors_[3] = IRegulatoryCompliance.canTransfer.selector;
+        rComplianceSelectors_[4] = RegulatoryComplianceStorage.getRegulatoryModules.selector;
+        rComplianceSelectors_[5] = RegulatoryComplianceStorage.getRegulatoryModulesCount.selector;
+
+        bytes4[] memory kycComplianceSelectors_ = new bytes4[](5);
+        kycComplianceSelectors_[0] = IKYCCompliance.addKYCModules.selector;
+        kycComplianceSelectors_[1] = IKYCCompliance.removeKYCModules.selector;
+        kycComplianceSelectors_[2] = IKYCCompliance.isKYCed.selector;
+        kycComplianceSelectors_[3] = KYCComplianceStorage.getKYCModules.selector;
+        kycComplianceSelectors_[4] = KYCComplianceStorage.getKYCModulesCount.selector;
+
+        Facet[] memory facets_ = new Facet[](2);
+        facets_[0] = Facet(regulatoryCompliance_, FacetAction.Add, rComplianceSelectors_);
+        facets_[1] = Facet(kycCompliance_, FacetAction.Add, kycComplianceSelectors_);
+
+        _diamondCut(facets_, address(0), "");
+        _diamondCut(new Facet[](0), regulatoryCompliance_, initRegulatory_);
+        _diamondCut(new Facet[](0), kycCompliance_, initKYC_);
+    }
+
+    /// @inheritdoc IAssetF
+    function diamondCut(
+        Facet[] memory modules_
+    ) public virtual override onlyRole(_diamondCutRole()) {
+        diamondCut(modules_, address(0), "");
+    }
+
+    /// @inheritdoc IAssetF
+    function diamondCut(
+        Facet[] memory modules_,
+        address initModule_,
+        bytes memory initData_
+    ) public virtual override onlyRole(_diamondCutRole()) {
+        _diamondCut(modules_, initModule_, initData_);
+    }
+
+    function _mintRole() internal view virtual returns (bytes32) {
+        return AGENT_ROLE;
+    }
+
+    function _burnRole() internal view virtual returns (bytes32) {
+        return AGENT_ROLE;
+    }
+
+    function _forcedTransferRole() internal view virtual returns (bytes32) {
+        return AGENT_ROLE;
+    }
+
+    function _recoveryRole() internal view virtual returns (bytes32) {
+        return AGENT_ROLE;
+    }
+
+    function _diamondCutRole() internal view virtual returns (bytes32) {
+        return AGENT_ROLE;
+    }
+}