Fix Typos and Improve Comments Across Multiple Files (#169)

* Update IOrgStoryNFTFactory.sol * Update IStoryBadgeNFT.sol * Update Errors.sol * Update MetadataHelper.sol * Update PermissionHelper.sol * Update CachableNFT.sol * Update OrgStoryNFTFactory.sol * Update StoryBadgeNFT.sol * Update SPGNFT.sol
storyprotocol · Feb 4, 2025 · 8ae5562 · 8ae5562
1 parent 5b19dbe
commit 8ae5562
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 9 deletions.
diff --git a/contracts/SPGNFT.sol b/contracts/SPGNFT.sol
@@ -15,7 +15,7 @@ import { SPGNFTLib } from "./lib/SPGNFTLib.sol";
 contract SPGNFT is ISPGNFT, ERC721URIStorageUpgradeable, AccessControlUpgradeable {
     using SafeERC20 for IERC20;
 
-    /// @dev Storage structure for the SPGNFTSotrage.
+    /// @dev Storage structure for the SPGNFTStorage.
     /// @param _maxSupply The maximum supply of the collection.
     /// @param _totalSupply The total minted supply of the collection.
     /// @param _mintFee The fee to mint an NFT from the collection.

diff --git a/contracts/interfaces/story-nft/IOrgStoryNFTFactory.sol b/contracts/interfaces/story-nft/IOrgStoryNFTFactory.sol
@@ -14,7 +14,7 @@ interface IOrgStoryNFTFactory {
     /// @param signature The signature that is invalid.
     error OrgStoryNFTFactory__InvalidSignature(bytes signature);
 
-    /// @notice NftTemplate is not whitelisted to be used as a OrgStoryNFT.
+    /// @notice NftTemplate is not whitelisted to be used as an OrgStoryNFT.
     /// @param nftTemplate The NFT template that is not whitelisted.
     error OrgStoryNFTFactory__NftTemplateNotWhitelisted(address nftTemplate);
 
@@ -35,7 +35,7 @@ interface IOrgStoryNFTFactory {
     /// @param orgIpId The ID of the organization IP that is not found.
     error OrgStoryNFTFactory__OrgNotFoundByOrgIpId(address orgIpId);
 
-    /// @notice Signature is already used to deploy a OrgStoryNFT.
+    /// @notice Signature is already used to deploy an OrgStoryNFT.
     /// @param signature The signature that is already used.
     error OrgStoryNFTFactory__SignatureAlreadyUsed(bytes signature);
 
@@ -84,7 +84,7 @@ interface IOrgStoryNFTFactory {
     /// @return orgNft The address of the organization NFT.
     /// @return orgTokenId The token ID of the organization NFT.
     /// @return orgIpId The ID of the organization IP.
-    /// @return orgStoryNft The address of the dployed OrgStoryNFT
+    /// @return orgStoryNft The address of the deployed OrgStoryNFT
     function deployOrgStoryNft(
         address orgStoryNftTemplate,
         address orgNftRecipient,
@@ -106,7 +106,7 @@ interface IOrgStoryNFTFactory {
     /// @return orgNft The address of the organization NFT.
     /// @return orgTokenId The token ID of the organization NFT.
     /// @return orgIpId The ID of the organization IP.
-    /// @return orgStoryNft The address of the dployed OrgStoryNFT
+    /// @return orgStoryNft The address of the deployed OrgStoryNFT
     function deployOrgStoryNftByAdmin(
         address orgStoryNftTemplate,
         address orgNftRecipient,

diff --git a/contracts/lib/Errors.sol b/contracts/lib/Errors.sol
@@ -1,3 +1,4 @@
+
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.26;
 
@@ -71,7 +72,7 @@ library Errors {
     /// @notice Zero address provided as a param to the RoyaltyTokenDistributionWorkflows.
     error RoyaltyTokenDistributionWorkflows__ZeroAddressParam();
 
-    /// @notice Total percentage exceed the current balance of the IP account.
+    /// @notice Total percentage exceeds the current balance of the IP account.
     error RoyaltyTokenDistributionWorkflows__TotalSharesExceedsIPAccountBalance(
         uint32 totalShares,
         uint32 ipAccountBalance

diff --git a/contracts/story-nft/CachableNFT.sol b/contracts/story-nft/CachableNFT.sol
@@ -48,7 +48,7 @@ abstract contract CachableNFT is OwnableUpgradeable {
         $.autoCacheBaseFeeThreshold = threshold;
     }
 
-    /// @notice Mints NFTs to the cache.
+    /// @notice Mints NFTs and adds them to the cache.
     /// @param amount The number of NFTs to mint.
     function mintToCache(uint256 amount) external onlyOwner {
         // mint NFT to cache

diff --git a/contracts/story-nft/OrgStoryNFTFactory.sol b/contracts/story-nft/OrgStoryNFTFactory.sol
@@ -122,7 +122,7 @@ contract OrgStoryNFTFactory is IOrgStoryNFTFactory, AccessManagedUpgradeable, UU
     /// @return orgNft The address of the organization NFT.
     /// @return orgTokenId The token ID of the organization NFT.
     /// @return orgIpId The ID of the organization IP.
-    /// @return orgStoryNft The address of the dployed OrgStoryNFT
+    /// @return orgStoryNft The address of the deployed OrgStoryNFT
     function deployOrgStoryNft(
         address orgStoryNftTemplate,
         address orgNftRecipient,
@@ -154,7 +154,7 @@ contract OrgStoryNFTFactory is IOrgStoryNFTFactory, AccessManagedUpgradeable, UU
     /// @return orgNft The address of the organization NFT.
     /// @return orgTokenId The token ID of the organization NFT.
     /// @return orgIpId The ID of the organization IP.
-    /// @return orgStoryNft The address of the dployed OrgStoryNFT
+    /// @return orgStoryNft The address of the deployed OrgStoryNFT
     function deployOrgStoryNftByAdmin(
         address orgStoryNftTemplate,
         address orgNftRecipient,