Fix typographical errors in smart contract documentation (#168)

* fix typo * fix typos * fix typos * fix typos * fix typos
storyprotocol · Jan 21, 2025 · 8c6473d · 8c6473d
1 parent e567e8a
commit 8c6473d
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 5 deletions.
diff --git a/contracts/interfaces/story-nft/IOrgStoryNFTFactory.sol b/contracts/interfaces/story-nft/IOrgStoryNFTFactory.sol
@@ -78,7 +78,7 @@ 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 genreated by
+    /// @param signature The signature from the OrgStoryNFTFactory's whitelist signer. This signautre 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.

diff --git 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 genreated by having the whitelist
+    /// @param signature The signature from the whitelist signer. This signautre 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/interfaces/workflows/IRoyaltyWorkflows.sol b/contracts/interfaces/workflows/IRoyaltyWorkflows.sol
@@ -4,7 +4,7 @@ pragma solidity 0.8.26;
 /// @title Royalty Workflows Interface
 /// @notice Interface for IP royalty workflows.
 interface IRoyaltyWorkflows {
-    /// @notice Transfers all avaiable royalties from various royalty policies to the royalty
+    /// @notice Transfers all available royalties from various royalty policies to the royalty
     ///         vault of an ancestor IP, and claims all the revenue for each currency token
     ///         from the ancestor IP's royalty vault to the claimer.
     /// @param ancestorIpId The address of the ancestor IP from which the revenue is being claimed.

diff --git a/contracts/workflows/RegistrationWorkflows.sol b/contracts/workflows/RegistrationWorkflows.sol
@@ -87,7 +87,7 @@ contract RegistrationWorkflows is
     }
 
     /// @dev Upgrades the NFT contract beacon. Restricted to only the protocol access manager.
-    /// @param newNftContract The address of the new NFT contract implemenetation.
+    /// @param newNftContract The address of the new NFT contract implementation.
     function upgradeCollections(address newNftContract) public restricted {
         // UpgradeableBeacon checks for newImplementation.bytecode.length > 0, so no need to check for zero address.
         UpgradeableBeacon(_getRegistrationWorkflowsStorage().nftContractBeacon).upgradeTo(newNftContract);

diff --git a/contracts/workflows/RoyaltyWorkflows.sol b/contracts/workflows/RoyaltyWorkflows.sol
@@ -43,7 +43,7 @@ contract RoyaltyWorkflows is IRoyaltyWorkflows, MulticallUpgradeable, AccessMana
         __UUPSUpgradeable_init();
     }
 
-    /// @notice Transfers all avaiable royalties from various royalty policies to the royalty
+    /// @notice Transfers all available royalties from various royalty policies to the royalty
     ///         vault of an ancestor IP, and claims all the revenue for each currency token
     ///         from the ancestor IP's royalty vault to the claimer.
     /// @param ancestorIpId The address of the ancestor IP from which the revenue is being claimed.