refactor: add extraData to UTXO model

Signed-off-by: MASDXI <sirawitt42@gmail.com>

Author: MASDXI

contracts/abstracts/UTXOToken.sol

@@ -39,13 +39,15 @@ abstract contract UTXOToken is ERC20, IUTXOERC20 {
      * @param tokenId The identifier of the token transaction.
      * @param value The amount of tokens to transfer.
      * @param signature The signature associated with the transaction.
+     * @param extraData The extra data for transaction output.
      */
     function _transfer(
         address from,
         address to,
         bytes32 tokenId,
         uint256 value,
-        bytes memory signature
+        bytes memory signature,
+        bytes32 extraData
     ) internal virtual {
         uint256 txvalue = _UTXO.transactionValue(tokenId);
         if (txvalue < value) {
@@ -58,7 +60,8 @@ abstract contract UTXOToken is ERC20, IUTXOERC20 {
                 UnspentTransactionOutput.TransactionOutput(value, to),
                 tokenId,
                 UnspentTransactionOutput.calculateTransactionHash(from, _UTXO.transactionCount(from)),
-                from
+                from,
+                extraData
             );
         }
         _update(from, to, value);
@@ -68,13 +71,15 @@ abstract contract UTXOToken is ERC20, IUTXOERC20 {
      * @dev Internal function to mint tokens and create a transaction for the minted tokens.
      * @param account The address that will receive the minted tokens.
      * @param value The amount of tokens to mint and transfer.
+     * @param extraData The extra data for transaction output.
      */
-    function _mintTransaction(address account, uint256 value) internal {
+    function _mintTransaction(address account, uint256 value, bytes32 extraData) internal {
         _UTXO.createTransaction(
             UnspentTransactionOutput.TransactionOutput(value, account),
             bytes32(0),
             UnspentTransactionOutput.calculateTransactionHash(address(0), _UTXO.transactionCount(address(0))),
-            address(0)
+            address(0),
+            extraData
         );
         _mint(account, value);
     }
@@ -84,8 +89,9 @@ abstract contract UTXOToken is ERC20, IUTXOERC20 {
      * @param account The address from which tokens will be burned.
      * @param tokenId The identifier of the token transaction to be burned.
      * @param value The amount of tokens to burn.
+     * @param extraData The extra data for transaction output.
      */
-    function _burnTransaction(address account, bytes32 tokenId, uint256 value) internal {
+    function _burnTransaction(address account, bytes32 tokenId, uint256 value, bytes32 extraData) internal {
         if (value == _UTXO.transactionValue(tokenId)) {
             _UTXO.consumeTransaction(tokenId, account);
         } else {
@@ -94,7 +100,8 @@ abstract contract UTXOToken is ERC20, IUTXOERC20 {
                 UnspentTransactionOutput.TransactionOutput(value, account),
                 tokenId,
                 UnspentTransactionOutput.calculateTransactionHash(account, _UTXO.transactionCount(account)),
-                account
+                account,
+                extraData
             );
         }
         _burn(account, value);
@@ -145,6 +152,15 @@ abstract contract UTXOToken is ERC20, IUTXOERC20 {
         return _UTXO.transactionOwner(tokenId);
     }
 
+    /**
+     * @dev Function to fetch the extra data of a UTXO transaction identified by its token ID.
+     * @param tokenId The identifier of the UTXO transaction.
+     * @return The extra data of the UTXO associated with the specified token ID.
+     */
+    function transactionExtraData(bytes32 tokenId) public view returns (bytes32) {
+        return _UTXO.transactionExtraData(tokenId);
+    }
+
     /**
      * @dev Function to checks whether a UTXO transaction has been spent, identified by its token ID.
      * @param tokenId The identifier of the UTXO transaction.
@@ -170,7 +186,7 @@ abstract contract UTXOToken is ERC20, IUTXOERC20 {
         uint256 value,
         bytes memory signature
     ) public virtual override returns (bool) {
-        _transfer(msg.sender, to, tokenId, value, signature);
+        _transfer(msg.sender, to, tokenId, value, signature, bytes32(""));
         return true;
     }
 
@@ -192,7 +208,7 @@ abstract contract UTXOToken is ERC20, IUTXOERC20 {
         bytes memory signature
     ) public virtual override returns (bool) {
         _spendAllowance(from, msg.sender, value);
-        _transfer(from, to, tokenId, value, signature);
+        _transfer(from, to, tokenId, value, signature, bytes32(""));
         return true;
     }
 }

contracts/libraries/UTXO.sol

@@ -235,6 +235,16 @@ library UnspentTransactionOutput {
         return self.transactions[id].owner;
     }
 
+    /**
+     * @notice Retrieves the owner of a transaction in the UTXO.
+     * @param self The UTXO storage.
+     * @param id The identifier of the transaction.
+     * @return The extraData  of the transaction.
+     */
+    function transactionExtraData(UTXO storage self, bytes32 id) internal view returns (bytes32) {
+        return self.transactions[id].extraData;
+    }
+
     /**
      * @notice Retrieves the number of transactions associated with an account in the UTXO.
      * @param self The UTXO storage.

contracts/mocks/MockForest.sol

@@ -22,25 +22,25 @@ contract MockForest is ForestToken, FreezeAddress, FreezeBalance, FreezeToken {
 
     // TODO
     // modifier checkFrozenLevel(bytes32 tokenId) {
-        // check equal
+        // check root equal check equal
         // _;
     // }
 
     // TODO
     // modifier checkFrozenBeforeLevel(bytes32 tokenId)  
-        // check less than
+        // check root equal and check less than
         // _;
     // }
 
     // TODO
     // modifier checkFrozenAfterLevel(bytes32 tokenId)  
-        // check greater than
+        // check root equal check greater than
         // _;
     // }
 
     // TODO
     // modifier checkFrozenInBetweenLevel(bytes32 tokenId)
-        // check greater than 'x' and less than 'y'
+        // check root equal check greater than 'x' and less than 'y'
         // _;
     // }
 

contracts/mocks/MockUtxo.sol

@@ -9,28 +9,63 @@ import "../abstracts/extensions/FreezeToken.sol";
 contract MockUtxo is UTXOToken, FreezeAddress, FreezeBalance, FreezeToken {
     constructor(string memory name_, string memory symbol_) UTXOToken(name_, symbol_) {}
 
-    function _transfer(
+    function transfer(
+        address to,
+        bytes32 tokenId,
+        uint256 value,
+        bytes memory signature
+    )
+        public
+        virtual
+        override
+        checkFrozenBalance(msg.sender, balanceOf(msg.sender))
+        checkFrozenAddress(msg.sender, to)
+        checkFrozenToken(tokenId)
+        returns (bool)
+    {
+        bytes32 extraData = transactionExtraData(tokenId);
+        if (extraData == bytes32("")) {
+            extraData = tokenId;
+        }
+        _transfer(msg.sender, to, tokenId, value, signature, extraData);
+
+        return true;
+    }
+
+    function transferFrom(
         address from,
         address to,
         bytes32 tokenId,
         uint256 value,
         bytes memory signature
     )
-        internal
+        public
         virtual
         override
         checkFrozenBalance(from, balanceOf(from))
         checkFrozenAddress(from, to)
         checkFrozenToken(tokenId)
+        returns (bool)
     {
-        super._transfer(from, to, tokenId, value, signature);
+        _spendAllowance(from, msg.sender, value);
+        bytes32 extraData = transactionExtraData(tokenId);
+        if (extraData == bytes32("")) {
+            extraData = tokenId;
+        }
+        _transfer(msg.sender, to, tokenId, value, signature, extraData);
+
+        return true;
     }
 
     function mint(address account, uint256 value) public {
-        _mintTransaction(account, value);
+        _mintTransaction(account, value, bytes32(""));
     }
 
     function burn(address account, bytes32 tokenId, uint256 value) public {
-        _burnTransaction(account, tokenId, value);
+        bytes32 extraData = transactionExtraData(tokenId);
+        if (extraData == bytes32("")) {
+            extraData = tokenId;
+        }
+        _burnTransaction(account, tokenId, value, extraData);
     }
 }