diff --git a/contracts/SPGNFT.sol b/contracts/SPGNFT.sol index cb24395..9b78706 100644 --- a/contracts/SPGNFT.sol +++ b/contracts/SPGNFT.sol @@ -12,7 +12,7 @@ import { Errors } from "./lib/Errors.sol"; import { SPGNFTLib } from "./lib/SPGNFTLib.sol"; contract SPGNFT is ISPGNFT, ERC721URIStorageUpgradeable, AccessControlUpgradeable { - /// @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 index becb129..6e484d5 100644 --- 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); @@ -53,7 +53,7 @@ interface IOrgStoryNFTFactory { /// @param defaultOrgStoryNftTemplate The new default OrgStoryNFT template. event DefaultOrgStoryNftTemplateUpdated(address defaultOrgStoryNftTemplate); - /// @notice Emitted when a new orgnization NFT is minted and a new Organization StoryNFT associated with it is deployed. + /// @notice Emitted when a new organization NFT is minted and a new Organization StoryNFT associated with it is deployed. /// @param orgName The name of the organization. /// @param orgNft The address of the organization NFT. /// @param orgTokenId The token ID of the organization NFT. @@ -78,13 +78,13 @@ interface IOrgStoryNFTFactory { /// @param orgNftRecipient The address of the recipient of the organization NFT. /// @param orgName The name of the organization. /// @param orgIpMetadata OPTIONAL. The desired metadata for the newly minted OrgNFT and registered IP. - /// @param signature The signature from the OrgStoryNFTFactory's whitelist signer. This signautre is generated by + /// @param signature The signature from the OrgStoryNFTFactory's whitelist signer. This signature is generated by /// having the whitelist signer sign the caller's address (msg.sender) for this `deployOrgStoryNft` function. /// @param storyNftInitParams The initialization parameters for StoryNFT {see {IStoryNFT-StoryNftInitParams}}. /// @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/interfaces/story-nft/IStoryBadgeNFT.sol b/contracts/interfaces/story-nft/IStoryBadgeNFT.sol index 225971b..5e98338 100644 --- a/contracts/interfaces/story-nft/IStoryBadgeNFT.sol +++ b/contracts/interfaces/story-nft/IStoryBadgeNFT.sol @@ -60,7 +60,7 @@ interface IStoryBadgeNFT is IStoryNFT, IERC721Metadata, IERC5192 { /// @notice Mints a badge for the given recipient, registers it as an IP, /// and makes it a derivative of the organization IP. /// @param recipient The address of the recipient of the badge NFT. - /// @param signature The signature from the whitelist signer. This signautre is generated by having the whitelist + /// @param signature The signature from the whitelist signer. This signature is generated by having the whitelist /// signer sign the caller's address (msg.sender) for this `mint` function. /// @return tokenId The token ID of the minted badge NFT. /// @return ipId The ID of the badge NFT IP. diff --git a/contracts/lib/Errors.sol b/contracts/lib/Errors.sol index f477c33..b77bba3 100644 --- a/contracts/lib/Errors.sol +++ b/contracts/lib/Errors.sol @@ -1,3 +1,4 @@ + // SPDX-License-Identifier: MIT pragma solidity 0.8.26; @@ -59,7 +60,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/lib/MetadataHelper.sol b/contracts/lib/MetadataHelper.sol index cde76fd..5a8a292 100644 --- a/contracts/lib/MetadataHelper.sol +++ b/contracts/lib/MetadataHelper.sol @@ -35,7 +35,6 @@ library MetadataHelper { setMetadata(ipId, coreMetadataModule, ipMetadata); } - /// @dev Sets the metadata for the given IP if metadata is non-empty. /// @dev Sets the metadata for the given IP if metadata is non-empty. /// @param ipId The ID of the IP. /// @param coreMetadataModule The address of the Core Metadata Module. diff --git a/contracts/lib/PermissionHelper.sol b/contracts/lib/PermissionHelper.sol index 80a08e3..374c364 100644 --- a/contracts/lib/PermissionHelper.sol +++ b/contracts/lib/PermissionHelper.sol @@ -41,7 +41,7 @@ library PermissionHelper { ); } - /// @dev Sets batch permission via signature to allow this contract to interact with mutiple modules + /// @dev Sets batch permission via signature to allow this contract to interact with multiple modules /// on behalf of the provided IP Account. /// @param ipId The ID of the IP. /// @param accessController The address of the Access Controller contract. diff --git a/contracts/story-nft/CachableNFT.sol b/contracts/story-nft/CachableNFT.sol index b447044..d7331b4 100644 --- a/contracts/story-nft/CachableNFT.sol +++ b/contracts/story-nft/CachableNFT.sol @@ -50,7 +50,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 index 344ee15..cd5f1ed 100644 --- a/contracts/story-nft/OrgStoryNFTFactory.sol +++ b/contracts/story-nft/OrgStoryNFTFactory.sol @@ -116,13 +116,13 @@ contract OrgStoryNFTFactory is IOrgStoryNFTFactory, AccessManagedUpgradeable, UU /// @param orgNftRecipient The address of the recipient of the organization NFT. /// @param orgName The name of the organization. /// @param orgIpMetadata OPTIONAL. The desired metadata for the newly minted OrgNFT and registered IP. - /// @param signature The signature from the OrgStoryNFTFactory's whitelist signer. This signautre is genreated by + /// @param signature The signature from the OrgStoryNFTFactory's whitelist signer. This signature is genreated by /// having the whitelist signer sign the caller's address (msg.sender) for this `deployStoryNft` function. /// @param storyNftInitParams The initialization data for the OrgStoryNFT (see {IOrgStoryNFT-InitParams}). /// @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, diff --git a/contracts/story-nft/StoryBadgeNFT.sol b/contracts/story-nft/StoryBadgeNFT.sol index c7ad341..3df5792 100644 --- a/contracts/story-nft/StoryBadgeNFT.sol +++ b/contracts/story-nft/StoryBadgeNFT.sol @@ -81,7 +81,7 @@ contract StoryBadgeNFT is IStoryBadgeNFT, BaseOrgStoryNFT, CachableNFT, ERC721Ho /// @notice Mints a badge for the given recipient, registers it as an IP, /// and makes it a derivative of the organization IP. /// @param recipient The address of the recipient of the badge. - /// @param signature The signature from the whitelist signer. This signautre is genreated by having the whitelist + /// @param signature The signature from the whitelist signer. This signature is genreated by having the whitelist /// signer sign the caller's address (msg.sender) for this `mint` function. /// @return tokenId The token ID of the minted badge NFT. /// @return ipId The ID of the badge NFT IP.