feat: mr suggestions, combining, renaming methods, specifying type in docs (#198)

Signed-off-by: Mariusz Jasuwienas <mariusz.jasuwienas@arianelabs.com>

Author: arianejasuwienas

contracts/HtsSystemContract.sol

@@ -15,7 +15,7 @@ contract HtsSystemContract is IHederaTokenService {
     /**
      * The slot's value contains the next token ID to use when a token is being created.
      *
-     * This slot is used in the `0x167` address. 
+     * This slot is used in the `0x167` address.
      * It cannot be used as a state variable directly.
      * This is because JS' `getHtsStorageAt` implementation assumes all state variables
      * declared here are part of the token address space.
@@ -28,7 +28,7 @@ contract HtsSystemContract is IHederaTokenService {
     // See `__redirectForToken` for more details.
     //
     // Moreover, these variables must match the slots defined in `SetTokenInfo`.
-    string internal tokenType; 
+    string internal tokenType;
     uint8 internal decimals;
     TokenInfo internal _tokenInfo;
 
@@ -412,18 +412,10 @@ contract HtsSystemContract is IHederaTokenService {
     function getNonFungibleTokenInfo(address token, int64 serialNumber)
         htsCall external
         returns (int64, NonFungibleTokenInfo memory) {
-        (int64 responseCode, TokenInfo memory tokenInfo) = getTokenInfo(token);
-        require(responseCode == HederaResponseCodes.SUCCESS, "getNonFungibleTokenInfo: failed to get token data");
-        (, NonFungibleTokenInfo memory nonFungibleTokenInfo) = IHederaTokenService(token).getNonFungibleTokenInfo(
+        return IHederaTokenService(token).getNonFungibleTokenInfo(
             token,
             serialNumber
         );
-        nonFungibleTokenInfo.tokenInfo = tokenInfo;
-        nonFungibleTokenInfo.serialNumber = serialNumber;
-        nonFungibleTokenInfo.spenderId = IERC721(token).getApproved(uint256(uint64(serialNumber)));
-        nonFungibleTokenInfo.ownerId = IERC721(token).ownerOf(uint256(uint64(serialNumber)));
-
-        return (responseCode, nonFungibleTokenInfo);
     }
 
     function isToken(address token) htsCall external returns (int64, bool) {
@@ -595,11 +587,16 @@ contract HtsSystemContract is IHederaTokenService {
             if (selector == this.getNonFungibleTokenInfo.selector) {
                 require(msg.data.length >= 92, "getNonFungibleTokenInfo: Not enough calldata");
                 uint256 serialId = uint256(bytes32(msg.data[60:92]));
-                NonFungibleTokenInfo memory info;
+                NonFungibleTokenInfo memory nonFungibleTokenInfo;
                 (int64 creationTime, bytes memory metadata) = __nftInfo(serialId);
-                info.creationTime = creationTime;
-                info.metadata = metadata;
-                return abi.encode(HederaResponseCodes.SUCCESS, info);
+                nonFungibleTokenInfo.tokenInfo = _tokenInfo;
+                nonFungibleTokenInfo.serialNumber = int64(int256(serialId));
+                nonFungibleTokenInfo.ownerId = __ownerOf(serialId);
+                nonFungibleTokenInfo.creationTime = creationTime;
+                nonFungibleTokenInfo.metadata = metadata;
+                nonFungibleTokenInfo.spenderId = __getApproved(serialId);
+
+                return abi.encode(HederaResponseCodes.SUCCESS, nonFungibleTokenInfo);
             }
             if (selector == this._update.selector) {
                 require(msg.data.length >= 124, "update: Not enough calldata");

contracts/HtsSystemContractJson.sol

@@ -456,20 +456,24 @@ contract HtsSystemContractJson is HtsSystemContract {
     function _tokenUriSlot(uint32 serialId) internal override virtual returns (bytes32) {
         bytes32 slot = super._tokenUriSlot(serialId);
         if (_shouldFetch(slot)) {
-            string memory metadata = mirrorNode().getNftMetadata(address(this), serialId);
+            (string memory metadata, ) = mirrorNode().getNftMetadataAndCreatedTimestamp(address(this), serialId);
             string memory uri = string(decode(metadata));
             storeString(address(this), uint256(slot), uri);
+            vm.store(_scratchAddr(), slot, bytes32(uint(1)));
         }
         return slot;
     }
 
     function __nftInfoSlot(uint32 serialId) internal override virtual returns (bytes32) {
         bytes32 slot = super.__nftInfoSlot(serialId);
         if (_shouldFetch(slot)) {
-            string memory metadata = mirrorNode().getNftMetadata(address(this), serialId);
-            string memory createdTimestamp = mirrorNode().getNftCreatedTimestamp(address(this), serialId);
+            (string memory metadata, string memory createdTimestamp) = mirrorNode().getNftMetadataAndCreatedTimestamp(
+                address(this),
+                serialId
+            );
             int64 creationTime = int64(vm.parseInt(vm.split(createdTimestamp, ".")[0]));
             storeBytes(address(this), uint256(slot), abi.encode(creationTime, bytes(metadata)));
+            vm.store(_scratchAddr(), slot, bytes32(uint(1)));
         }
         return slot;
     }

contracts/MirrorNode.sol

@@ -30,26 +30,24 @@ abstract contract MirrorNode {
 
     function fetchTokenRelationshipOfAccount(string memory account, address token) external virtual returns (string memory json);
 
-    function fetchNonFungibleToken(address token, uint32 serial) external virtual returns (string memory json);
+    function fetchNonFungibleTokenSerial(address token, uint32 serial) external virtual returns (string memory json);
 
-    function getNftMetadata(address token, uint32 serial) external returns (string memory) {
-        string memory json = this.fetchNonFungibleToken(token, serial);
+    function getNftMetadataAndCreatedTimestamp(address token, uint32 serial) external returns (string memory metadata, string memory createdTimestamp) {
+        string memory json = this.fetchNonFungibleTokenSerial(token, serial);
         if (vm.keyExistsJson(json, ".metadata")) {
-            return vm.parseJsonString(json, ".metadata");
+            metadata = vm.parseJsonString(json, ".metadata");
+        } else {
+            metadata = "";
         }
-        return "";
-    }
-
-    function getNftCreatedTimestamp(address token, uint32 serial) external returns (string memory) {
-        string memory json = this.fetchNonFungibleToken(token, serial);
         if (vm.keyExistsJson(json, ".created_timestamp")) {
-            return vm.parseJsonString(json, ".created_timestamp");
+            createdTimestamp = vm.parseJsonString(json, ".created_timestamp");
+        } else {
+            createdTimestamp = "";
         }
-        return "";
     }
 
     function getNftOwner(address token, uint32 serial) external returns (address) {
-        string memory json = this.fetchNonFungibleToken(token, serial);
+        string memory json = this.fetchNonFungibleTokenSerial(token, serial);
         if (vm.keyExistsJson(json, ".account_id")) {
             string memory owner = vm.parseJsonString(json, ".account_id");
             return getAccountAddress(owner);
@@ -58,7 +56,7 @@ abstract contract MirrorNode {
     }
 
     function getNftSpender(address token, uint32 serial) external returns (address) {
-        string memory json = this.fetchNonFungibleToken(token, serial);
+        string memory json = this.fetchNonFungibleTokenSerial(token, serial);
         if (vm.keyExistsJson(json, ".spender")) {
             string memory spender = vm.parseJsonString(json, ".spender");
             return getAccountAddress(spender);

contracts/MirrorNodeFFI.sol

@@ -80,7 +80,7 @@ contract MirrorNodeFFI is MirrorNode {
         ));
     }
 
-    function fetchNonFungibleToken(address token, uint32 serial) isValid(token) external override returns (string memory) {
+    function fetchNonFungibleTokenSerial(address token, uint32 serial) isValid(token) external override returns (string memory) {
         return _get(string.concat(
             "tokens/0.0.",
             vm.toString(uint160(token)),

src/index.js

@@ -248,7 +248,7 @@ async function getHtsStorageAt(address, requestedSlot, blockNumber, mirrorNodeCl
             tokenId,
             blockNumber,
             nrequestedSlot,
-            atob(metadata),
+            Buffer.from(metadata, 'base64').toString(),
             't_string_storage'
         );
     }
@@ -273,7 +273,7 @@ async function getHtsStorageAt(address, requestedSlot, blockNumber, mirrorNodeCl
                 `Failed to get the metadata of the NFT ${tokenId}#${serialId}`
             );
         const timestamp = Number(created_timestamp.split('.')[0]).toString(16).padStart(64, '0');
-        const metadataEncoded = Buffer.from(metadata).toString('hex');
+        const metadataEncoded = Buffer.from(metadata, 'utf-8').toString('hex');
         const metadataLength = metadata.length.toString(16).padStart(64, '0');
         const stringTypeIndicator = '40'.padStart(64, '0');
         const bytes = `${timestamp}${stringTypeIndicator}${metadataLength}${metadataEncoded}`;

src/slotmap.js

@@ -316,7 +316,7 @@ class PersistentStorageMap {
      * @param {number} blockNumber
      * @param {bigint} slot
      * @param {Value} value
-     * @param {string} type
+     * @param {'t_string_storage' | 't_bytes_storage'} type
      */
     store(tokenId, blockNumber, slot, value, type) {
         visit(

test/lib/MirrorNodeMock.sol

@@ -58,7 +58,7 @@ contract MirrorNodeMock is MirrorNode {
         return vm.readFile(path);
     }
 
-    function fetchNonFungibleToken(address token, uint32 serial) external override view returns (string memory) {
+    function fetchNonFungibleTokenSerial(address token, uint32 serial) external override view returns (string memory) {
         string memory symbol = _symbolOf[token];
         string memory serialId = vm.toString(serial);
         string memory path = string.concat("./test/data/", symbol, "/getNonFungibleToken_", serialId, ".json");