Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Typos and Improve Comments Across Multiple Files #169

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion contracts/SPGNFT.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
12 changes: 6 additions & 6 deletions contracts/interfaces/story-nft/IOrgStoryNFTFactory.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand All @@ -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);

Expand All @@ -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.
Expand All @@ -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,
Expand All @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion contracts/interfaces/story-nft/IStoryBadgeNFT.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion contracts/lib/Errors.sol
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

// SPDX-License-Identifier: MIT
pragma solidity 0.8.26;

Expand Down Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion contracts/lib/MetadataHelper.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion contracts/lib/PermissionHelper.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion contracts/story-nft/CachableNFT.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions contracts/story-nft/OrgStoryNFTFactory.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion contracts/story-nft/StoryBadgeNFT.sol
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down