ERC20 wrapper

docs/facets/IAdminFacet.md

@@ -249,3 +249,15 @@ Gets the System context ID.
 | --- | --- |
 |`System` | Identifier|
 <br></br>
+### isObjectTokenizable
+Check if object can be tokenized
+```solidity
+  function isObjectTokenizable(
+    bytes32 _objectId
+  ) external returns (bool)
+```
+#### Arguments:
+| Argument | Type | Description |
+| --- | --- | --- |
+|`_objectId` | bytes32 | ID of the object|
+<br></br>

docs/facets/IEntityFacet.md

@@ -40,14 +40,16 @@ Enable an entity to be tokenized
 ```solidity
   function enableEntityTokenization(
     bytes32 _entityId,
-    string _symbol
+    string _symbol,
+    string _name
   ) external
 ```
 #### Arguments:
 | Argument | Type | Description |
 | --- | --- | --- |
 |`_entityId` | bytes32 | ID of the entity
-|`_symbol` | string | The symbol assigned to the entity token|
+|`_symbol` | string | The symbol assigned to the entity token
+|`_name` | string | The name assigned to the entity token|
 <br></br>
 ### startTokenSale
 Start token sale of `_amount` tokens for total price of `_totalPrice`
@@ -66,6 +68,18 @@ Entity tokens are minted when the sale is started
 |`_amount` | uint256 | amount of entity tokens to put on sale
 |`_totalPrice` | uint256 | total price of the tokens|
 <br></br>
+### isTokenWrapped
+Check if an entity token is wrapped as ERC20
+```solidity
+  function isTokenWrapped(
+    bytes32 _entityId
+  ) external returns (bool)
+```
+#### Arguments:
+| Argument | Type | Description |
+| --- | --- | --- |
+|`_entityId` | bytes32 | ID of the entity|
+<br></br>
 ### updateEntity
 Update entity metadata
 ```solidity

docs/facets/ISystemFacet.md

@@ -56,7 +56,7 @@ Get meta of given object.
 ```solidity
   function getObjectMeta(
     bytes32 _id
-  ) external returns (bytes32 parent, bytes32 dataHash, bytes32 tokenSymbol)
+  ) external returns (bytes32 parent, bytes32 dataHash, string tokenSymbol, string tokenName, address tokenWrapper)
 ```
 #### Arguments:
 | Argument | Type | Description |
@@ -69,5 +69,19 @@ Get meta of given object.
 | --- | --- |
 |`parent` | object parent
 |`dataHash` | object data hash
-|`tokenSymbol` | object token symbol|
+|`tokenSymbol` | object token symbol
+|`tokenName` | object token name
+|`tokenWrapper` | object token ERC20 wrapper address|
+<br></br>
+### wrapToken
+Wrap an object token as ERC20
+```solidity
+  function wrapToken(
+    bytes32 _objectId
+  ) external
+```
+#### Arguments:
+| Argument | Type | Description |
+| --- | --- | --- |
+|`_objectId` | bytes32 | ID of the tokenized object|
 <br></br>

docs/facets/ITokenizedVaultFacet.md

@@ -58,11 +58,11 @@ Total supply of platform asset
 | --- | --- |
 |`current` | balance|
 <br></br>
-### internalTransfer
+### internalTransferFromEntity
 Internal transfer of `amount` tokens
 Transfer tokens internally
 ```solidity
-  function internalTransfer(
+  function internalTransferFromEntity(
     bytes32 to,
     bytes32 tokenId
   ) external
@@ -73,6 +73,23 @@ Transfer tokens internally
 |`to` | bytes32 | token receiver
 |`tokenId` | bytes32 | Internal ID of the token|
 <br></br>
+### wrapperInternalTransferFrom
+Internal transfer of `amount` tokens `from` -> `to`
+Transfer tokens internally between two IDs
+```solidity
+  function wrapperInternalTransferFrom(
+    bytes32 from,
+    bytes32 to,
+    bytes32 tokenId
+  ) external
+```
+#### Arguments:
+| Argument | Type | Description |
+| --- | --- | --- |
+|`from` | bytes32 | token sender
+|`to` | bytes32 | token receiver
+|`tokenId` | bytes32 | Internal ID of the token|
+<br></br>
 ### internalBurn
 No description
 ```solidity

src/diamonds/nayms/AppStorage.sol

@@ -16,7 +16,9 @@ struct AppStorage {
     mapping(bytes32 => bool) existingObjects; // objectId => is an object?
     mapping(bytes32 => bytes32) objectParent; // objectId => parentId
     mapping(bytes32 => bytes32) objectDataHashes;
-    mapping(bytes32 => bytes32) objectTokenSymbol;
+    mapping(bytes32 => string) objectTokenSymbol;
+    mapping(bytes32 => string) objectTokenName;
+    mapping(bytes32 => address) objectTokenWrapper;
     mapping(bytes32 => bool) existingEntities; // entityId => is an entity?
     mapping(bytes32 => bool) existingSimplePolicies; // simplePolicyId => is a simple policy?
     //// ENTITY ////

src/diamonds/nayms/Modifiers.sol

@@ -56,4 +56,10 @@ contract Modifiers {
         require(LibACL._isInGroup(_objectId, _contextId, _group), "not in group");
         _;
     }
+
+    modifier assertERC20Wrapper(bytes32 _tokenId) {
+        (, , , , address erc20Wrapper) = LibObject._getObjectMeta(_tokenId);
+        require(msg.sender == erc20Wrapper, "only wrapper calls allowed");
+        _;
+    }
 }

src/diamonds/nayms/facets/AdminFacet.sol

@@ -191,4 +191,8 @@ contract AdminFacet is Modifiers {
     function getSystemId() external pure returns (bytes32) {
         return LibAdmin._getSystemId();
     }
+
+    function isObjectTokenizable(bytes32 _objectId) external view returns (bool) {
+        return LibObject._isObjectTokenizable(_objectId);
+    }
 }

src/diamonds/nayms/facets/EntityFacet.sol

@@ -50,9 +50,14 @@ contract EntityFacet is Modifiers, ReentrancyGuard {
      * @notice Enable an entity to be tokenized
      * @param _objectId ID of the entity
      * @param _symbol The symbol assigned to the entity token
+     * @param _name The name assigned to the entity token
      */
-    function enableEntityTokenization(bytes32 _objectId, string memory _symbol) external assertSysAdmin {
-        LibObject._enableObjectTokenization(_objectId, _symbol);
+    function enableEntityTokenization(
+        bytes32 _objectId,
+        string memory _symbol,
+        string memory _name
+    ) external assertSysAdmin {
+        LibObject._enableObjectTokenization(_objectId, _symbol, _name);
     }
 
     /**
@@ -70,6 +75,14 @@ contract EntityFacet is Modifiers, ReentrancyGuard {
         LibEntity._startTokenSale(_entityId, _amount, _totalPrice);
     }
 
+    /**
+     * @notice Check if an entity token is wrapped as ERC20
+     * @param _entityId ID of the entity
+     */
+    function isTokenWrapped(bytes32 _entityId) external view returns (bool) {
+        return LibObject._isObjectTokenWrapped(_entityId);
+    }
+
     /**
      * @notice Update entity metadata
      * @param _entityId ID of the entity

src/diamonds/nayms/facets/SystemFacet.sol

@@ -9,13 +9,14 @@ import { LibHelpers } from "../libs/LibHelpers.sol";
 import { LibObject } from "../libs/LibObject.sol";
 import { LibACL } from "../libs/LibACL.sol";
 import { LibEntity } from "../libs/LibEntity.sol";
+import { ReentrancyGuard } from "../../../utils/ReentrancyGuard.sol";
 
 /**
  * @title System
  * @notice Use it to perform system level operations
  * @dev Use it to perform system level operations
  */
-contract SystemFacet is Modifiers {
+contract SystemFacet is Modifiers, ReentrancyGuard {
     /**
      * @notice Create an entity
      * @dev An entity can be created with a zero max capacity! This is in the event where an entity cannot write any policies.
@@ -56,16 +57,28 @@ contract SystemFacet is Modifiers {
      * @return parent object parent
      * @return dataHash object data hash
      * @return tokenSymbol object token symbol
+     * @return tokenName object token name
+     * @return tokenWrapper object token ERC20 wrapper address
      */
     function getObjectMeta(bytes32 _id)
         external
         view
         returns (
             bytes32 parent,
             bytes32 dataHash,
-            bytes32 tokenSymbol
+            string memory tokenSymbol,
+            string memory tokenName,
+            address tokenWrapper
         )
     {
         return LibObject._getObjectMeta(_id);
     }
+
+    /**
+     * @notice Wrap an object token as ERC20
+     * @param _objectId ID of the tokenized object
+     */
+    function wrapToken(bytes32 _objectId) external nonReentrant assertSysMgr {
+        LibObject._wrapToken(_objectId);
+    }
 }

src/diamonds/nayms/facets/TokenizedVaultFacet.sol

@@ -7,6 +7,7 @@ import { LibHelpers } from "../libs/LibHelpers.sol";
 import { LibTokenizedVault } from "../libs/LibTokenizedVault.sol";
 import { LibObject } from "../libs/LibObject.sol";
 import { LibEntity } from "../libs/LibEntity.sol";
+import { ReentrancyGuard } from "../../../utils/ReentrancyGuard.sol";
 
 /**
  * @title Token Vault
@@ -15,7 +16,7 @@ import { LibEntity } from "../libs/LibEntity.sol";
  * @dev Adaptation of ERC-1155 that uses AppStorage and aligns with Nayms ACL implementation.
  * https://github.com/OpenZeppelin/openzeppelin-contracts/tree/master/contracts/token/ERC1155
  */
-contract TokenizedVaultFacet is Modifiers {
+contract TokenizedVaultFacet is Modifiers, ReentrancyGuard {
     /**
      * @notice Gets balance of an account within platform
      * @dev Internal balance for given account
@@ -43,18 +44,32 @@ contract TokenizedVaultFacet is Modifiers {
      * @param to token receiver
      * @param tokenId Internal ID of the token
      */
-    function internalTransfer(
+    function internalTransferFromEntity(
         bytes32 to,
         bytes32 tokenId,
         uint256 amount
-    ) external assertEntityAdmin(LibObject._getParent(LibHelpers._getSenderId())) {
-        // require(LibTokenizedVault._internalBalanceOf(senderId, tokenId) >= amount, "internalTransfer: insufficient balance");
-        bytes32 senderId = LibHelpers._getIdForAddress(msg.sender);
-        bytes32 senderEntityId = LibObject._getParent(senderId);
+    ) external nonReentrant assertEntityAdmin(LibObject._getParentFromAddress(msg.sender)) {
+        bytes32 senderEntityId = LibObject._getParentFromAddress(msg.sender);
         require(LibHelpers._stringToBytes32(LibConstants.STM_IDENTIFIER) != tokenId, "internalTransfer: can't transfer internal veNAYM");
         LibTokenizedVault._internalTransfer(senderEntityId, to, tokenId, amount);
     }
 
+    /**
+     * @notice Internal transfer of `amount` tokens `from` -> `to`
+     * @dev Transfer tokens internally between two IDs
+     * @param from token sender
+     * @param to token receiver
+     * @param tokenId Internal ID of the token
+     */
+    function wrapperInternalTransferFrom(
+        bytes32 from,
+        bytes32 to,
+        bytes32 tokenId,
+        uint256 amount
+    ) external nonReentrant assertERC20Wrapper(tokenId) {
+        LibTokenizedVault._internalTransfer(from, to, tokenId, amount);
+    }
+
     function internalBurn(
         bytes32 from,
         bytes32 tokenId,

src/diamonds/nayms/interfaces/IAdminFacet.sol

@@ -136,4 +136,10 @@ interface IAdminFacet {
      * @return System Identifier
      */
     function getSystemId() external pure returns (bytes32);
+
+    /**
+     * @notice Check if object can be tokenized
+     * @param _objectId ID of the object
+     */
+    function isObjectTokenizable(bytes32 _objectId) external returns (bool);
 }

src/diamonds/nayms/interfaces/IEntityFacet.sol

@@ -37,8 +37,13 @@ interface IEntityFacet {
      * @notice Enable an entity to be tokenized
      * @param _entityId ID of the entity
      * @param _symbol The symbol assigned to the entity token
+     * @param _name The name assigned to the entity token
      */
-    function enableEntityTokenization(bytes32 _entityId, string memory _symbol) external;
+    function enableEntityTokenization(
+        bytes32 _entityId,
+        string memory _symbol,
+        string memory _name
+    ) external;
 
     /**
      * @notice Start token sale of `_amount` tokens for total price of `_totalPrice`
@@ -53,6 +58,12 @@ interface IEntityFacet {
         uint256 _totalPrice
     ) external;
 
+    /**
+     * @notice Check if an entity token is wrapped as ERC20
+     * @param _entityId ID of the entity
+     */
+    function isTokenWrapped(bytes32 _entityId) external view returns (bool);
+
     /**
      * @notice Update entity metadata
      * @param _entityId ID of the entity

src/diamonds/nayms/interfaces/ISystemFacet.sol

@@ -43,13 +43,23 @@ interface ISystemFacet {
      * @return parent object parent
      * @return dataHash object data hash
      * @return tokenSymbol object token symbol
+     * @return tokenName object token name
+     * @return tokenWrapper object token ERC20 wrapper address
      */
     function getObjectMeta(bytes32 _id)
         external
         view
         returns (
             bytes32 parent,
             bytes32 dataHash,
-            bytes32 tokenSymbol
+            string memory tokenSymbol,
+            string memory tokenName,
+            address tokenWrapper
         );
+
+    /**
+     * @notice Wrap an object token as ERC20
+     * @param _objectId ID of the tokenized object
+     */
+    function wrapToken(bytes32 _objectId) external;
 }

src/diamonds/nayms/interfaces/ITokenizedVaultFacet.sol

@@ -33,7 +33,21 @@ interface ITokenizedVaultFacet {
      * @param to token receiver
      * @param tokenId Internal ID of the token
      */
-    function internalTransfer(
+    function internalTransferFromEntity(
+        bytes32 to,
+        bytes32 tokenId,
+        uint256 amount
+    ) external;
+
+    /**
+     * @notice Internal transfer of `amount` tokens `from` -> `to`
+     * @dev Transfer tokens internally between two IDs
+     * @param from token sender
+     * @param to token receiver
+     * @param tokenId Internal ID of the token
+     */
+    function wrapperInternalTransferFrom(
+        bytes32 from,
         bytes32 to,
         bytes32 tokenId,
         uint256 amount

src/diamonds/nayms/libs/LibEntity.sol

@@ -24,7 +24,7 @@ library LibEntity {
     event EntityCreated(bytes32 entityId, bytes32 entityAdmin);
     event EntityUpdated(bytes32 entityId);
     event SimplePolicyCreated(bytes32 indexed id, bytes32 entityId);
-    event TokenSaleStarted(bytes32 indexed entityId, uint256 offerId);
+    event TokenSaleStarted(bytes32 indexed entityId, uint256 offerId, string tokenSymbol, string tokenName);
 
     /**
      * @dev If an entity passes their checks to create a policy, ensure that the entity's capacity is appropriately decreased by the amount of capital that will be tied to the new policy being created.
@@ -123,6 +123,7 @@ library LibEntity {
     ) internal {
         require(_amount > 0, "mint amount must be > 0");
         require(_totalPrice > 0, "total price must be > 0");
+        require(LibObject._isObjectTokenizable(_entityId), "must be tokenizable");
 
         AppStorage storage s = LibAppStorage.diamondStorage();
         Entity memory entity = s.entities[_entityId];
@@ -131,7 +132,7 @@ library LibEntity {
 
         (uint256 offerId, , ) = LibMarket._executeLimitOffer(_entityId, _entityId, _amount, entity.assetId, _totalPrice, LibConstants.FEE_SCHEDULE_STANDARD);
 
-        emit TokenSaleStarted(_entityId, offerId);
+        emit TokenSaleStarted(_entityId, offerId, s.objectTokenSymbol[_entityId], s.objectTokenName[_entityId]);
     }
 
     function _createEntity(