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.

Sign up for GitHub

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 in Organization NFT Contracts #149

Merged
merged 5 commits into from
Dec 19, 2024
Merged

Fix Typos in Organization NFT Contracts #149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2498f6b
typos IERC5192.sol
vipocenka Dec 19, 2024
78484bc
typos IOrgNFT.sol
vipocenka Dec 19, 2024
19ac6ab
typos IOrgNFT.sol
vipocenka Dec 19, 2024
daebf3f
typos OrgNFT.sol
vipocenka Dec 19, 2024
b5a1b67
typos OrgNFT.sol
vipocenka Dec 19, 2024
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/interfaces/story-nft/IERC5192.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ interface IERC5192 {
/// @param tokenId The identifier for a token.
event Unlocked(uint256 tokenId);

/// @notice Returns the locking status of an Soulbound Token
/// @notice Returns the locking status of a Soulbound Token
/// @dev SBTs assigned to zero address are considered invalid, and queries
/// about them do throw.
/// @param tokenId The identifier for an SBT.
Expand Down
6 changes: 3 additions & 3 deletions contracts/interfaces/story-nft/IOrgNFT.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { WorkflowStructs } from "../../lib/WorkflowStructs.sol";
/// @title Organization NFT Interface
/// @notice Each organization token represents a Story ecosystem project.
/// The root organization token represents Story.
/// Each organization token register as a IP on Story and is a derivative of the root organization IP.
/// Each organization token register as an IP on Story and is a derivative of the root organization IP.
interface IOrgNFT is IERC721Metadata {
////////////////////////////////////////////////////////////////////////////
// Errors //
Expand Down Expand Up @@ -35,7 +35,7 @@ interface IOrgNFT is IERC721Metadata {
////////////////////////////////////////////////////////////////////////////
// Events //
////////////////////////////////////////////////////////////////////////////
/// @notice Emitted when a organization token minted.
/// @notice Emitted when an organization token minted.
/// @param recipient The address of the recipient of the organization token.
/// @param orgNft The address of the organization NFT.
/// @param tokenId The ID of the minted organization token.
Expand All @@ -55,7 +55,7 @@ interface IOrgNFT is IERC721Metadata {
WorkflowStructs.IPMetadata calldata orgIpMetadata
) external returns (uint256 rootOrgTokenId, address rootOrgIpId);

/// @notice Mints a organization token, register it as an IP,
/// @notice Mints an organization token, register it as an IP,
/// and makes the IP as a derivative of the root organization IP.
/// @param recipient The address of the recipient of the minted organization token.
/// @param orgIpMetadata OPTIONAL. The desired metadata for the newly minted OrgNFT and registered IP.
Expand Down
6 changes: 3 additions & 3 deletions contracts/story-nft/OrgNFT.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import { WorkflowStructs } from "../lib/WorkflowStructs.sol";
/// @title Organization NFT
/// @notice Each organization token represents a Story ecosystem project.
/// The root organization token represents Story.
/// Each organization token register as a IP on Story and is a derivative of the root organization IP.
/// Each organization token register as an IP on Story and is a derivative of the root organization IP.
contract OrgNFT is IOrgNFT, ERC721URIStorageUpgradeable, AccessManagedUpgradeable, UUPSUpgradeable, ERC721Holder {
/// @custom:oz-upgrades-unsafe-allow state-variable-immutable

Expand Down Expand Up @@ -123,7 +123,7 @@ contract OrgNFT is IOrgNFT, ERC721URIStorageUpgradeable, AccessManagedUpgradeabl
_safeTransfer(address(this), recipient, rootOrgTokenId);
}

/// @notice Mints a organization token, register it as an IP,
/// @notice Mints an organization token, register it as an IP,
/// and makes the IP as a derivative of the root organization IP.
/// @dev This function is only callable by the OrgStoryNFTFactory contract.
/// @param recipient The address of the recipient of the minted organization token.
Expand Down Expand Up @@ -168,7 +168,7 @@ contract OrgNFT is IOrgNFT, ERC721URIStorageUpgradeable, AccessManagedUpgradeabl
_setTokenURI(tokenId, tokenURI_);
}

/// @notice Mints a organization token and register it as an IP.
/// @notice Mints an organization token and register it as an IP.
/// @param recipient The address of the recipient of the minted organization token.
/// @param orgIpMetadata OPTIONAL. The desired metadata for the newly minted OrgNFT and registered IP.
/// @return orgTokenId The ID of the minted organization token.
Expand Down
Loading