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

refactor(metadata): merge nftMetadata into struct IPMetadata #37

Merged
merged 1 commit into from
Aug 23, 2024
+75 −84
Merged

refactor(metadata): merge nftMetadata into struct IPMetadata #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 9 additions & 9 deletions contracts/SPGNFT.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,26 +112,26 @@ contract SPGNFT is ISPGNFT, ERC721URIStorageUpgradeable, AccessControlUpgradeabl

/// @notice Mints an NFT from the collection. Only callable by the minter role.
/// @param to The address of the recipient of the minted NFT.
/// @param nftMetadata OPTIONAL. The desired metadata for the newly minted NFT.
/// @param nftMetadataURI OPTIONAL. The URI of the desired metadata for the newly minted NFT.
/// @return tokenId The ID of the minted NFT.
function mint(
address to,
string calldata nftMetadata
string calldata nftMetadataURI
) public virtual onlyRole(SPGNFTLib.MINTER_ROLE) returns (uint256 tokenId) {
tokenId = _mintToken({ to: to, payer: msg.sender, nftMetadata: nftMetadata });
tokenId = _mintToken({ to: to, payer: msg.sender, nftMetadataURI: nftMetadataURI });
}

/// @notice Mints an NFT from the collection. Only callable by the SPG.
/// @param to The address of the recipient of the minted NFT.
/// @param payer The address of the payer for the mint fee.
/// @param nftMetadata OPTIONAL. The desired metadata for the newly minted NFT.
/// @param nftMetadataURI OPTIONAL. The URI of the desired metadata for the newly minted NFT.
/// @return tokenId The ID of the minted NFT.
function mintBySPG(
address to,
address payer,
string calldata nftMetadata
string calldata nftMetadataURI
) public virtual onlySPG returns (uint256 tokenId) {
tokenId = _mintToken({ to: to, payer: payer, nftMetadata: nftMetadata });
tokenId = _mintToken({ to: to, payer: payer, nftMetadataURI: nftMetadataURI });
}

/// @dev Withdraws the contract's token balance to the recipient.
Expand All @@ -152,9 +152,9 @@ contract SPGNFT is ISPGNFT, ERC721URIStorageUpgradeable, AccessControlUpgradeabl
/// @dev Mints an NFT from the collection.
/// @param to The address of the recipient of the minted NFT.
/// @param payer The address of the payer for the mint fee.
/// @param nftMetadata OPTIONAL. The desired metadata for the newly minted NFT.
/// @param nftMetadataURI OPTIONAL. The URI of the desired metadata for the newly minted NFT.
/// @return tokenId The ID of the minted NFT.
function _mintToken(address to, address payer, string calldata nftMetadata) internal returns (uint256 tokenId) {
function _mintToken(address to, address payer, string calldata nftMetadataURI) internal returns (uint256 tokenId) {
SPGNFTStorage storage $ = _getSPGNFTStorage();
if ($.totalSupply + 1 > $.maxSupply) revert Errors.SPGNFT__MaxSupplyReached();

Expand All @@ -165,7 +165,7 @@ contract SPGNFT is ISPGNFT, ERC721URIStorageUpgradeable, AccessControlUpgradeabl
tokenId = ++$.totalSupply;
_mint(to, tokenId);

if (bytes(nftMetadata).length > 0) _setTokenURI(tokenId, nftMetadata);
if (bytes(nftMetadataURI).length > 0) _setTokenURI(tokenId, nftMetadataURI);
}

//
Expand Down
49 changes: 29 additions & 20 deletions contracts/StoryProtocolGateway.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,17 +157,19 @@ contract StoryProtocolGateway is IStoryProtocolGateway, ERC721Holder, AccessMana
/// @dev Caller must have the minter role for the provided SPG NFT.
/// @param nftContract The address of the NFT collection.
/// @param recipient The address of the recipient of the minted NFT.
/// @param nftMetadata OPTIONAL. The desired metadata for the newly minted NFT.
/// @param ipMetadata OPTIONAL. The desired metadata for the newly registered IP.
/// @param ipMetadata OPTIONAL. The desired metadata for the newly minted NFT and registered IP.
/// @return ipId The ID of the registered IP.
/// @return tokenId The ID of the minted NFT.
function mintAndRegisterIp(
address nftContract,
address recipient,
string calldata nftMetadata,
IPMetadata calldata ipMetadata
) external onlyCallerWithMinterRole(nftContract) returns (address ipId, uint256 tokenId) {
tokenId = ISPGNFT(nftContract).mintBySPG({ to: address(this), payer: msg.sender, nftMetadata: nftMetadata });
tokenId = ISPGNFT(nftContract).mintBySPG({
to: address(this),
payer: msg.sender,
nftMetadataURI: ipMetadata.nftMetadataURI
});
ipId = IP_ASSET_REGISTRY.register(block.chainid, nftContract, tokenId);
_setMetadata(ipMetadata, ipId);
ISPGNFT(nftContract).safeTransferFrom(address(this), recipient, tokenId, "");
Expand Down Expand Up @@ -205,20 +207,22 @@ contract StoryProtocolGateway is IStoryProtocolGateway, ERC721Holder, AccessMana
/// @dev Caller must have the minter role for the provided SPG NFT.
/// @param nftContract The address of the NFT collection.
/// @param recipient The address of the recipient of the minted NFT.
/// @param nftMetadata OPTIONAL. The desired metadata for the newly minted NFT.
/// @param ipMetadata OPTIONAL. The desired metadata for the newly registered IP.
/// @param ipMetadata OPTIONAL. The desired metadata for the newly minted NFT and registered IP.
/// @param terms The PIL terms to be registered.
/// @return ipId The ID of the registered IP.
/// @return tokenId The ID of the minted NFT.
/// @return licenseTermsId The ID of the registered PIL terms.
function mintAndRegisterIpAndAttachPILTerms(
address nftContract,
address recipient,
string calldata nftMetadata,
IPMetadata calldata ipMetadata,
PILTerms calldata terms
) external onlyCallerWithMinterRole(nftContract) returns (address ipId, uint256 tokenId, uint256 licenseTermsId) {
tokenId = ISPGNFT(nftContract).mintBySPG({ to: address(this), payer: msg.sender, nftMetadata: nftMetadata });
tokenId = ISPGNFT(nftContract).mintBySPG({
to: address(this),
payer: msg.sender,
nftMetadataURI: ipMetadata.nftMetadataURI
});
ipId = IP_ASSET_REGISTRY.register(block.chainid, nftContract, tokenId);
_setMetadata(ipMetadata, ipId);

Expand Down Expand Up @@ -261,19 +265,21 @@ contract StoryProtocolGateway is IStoryProtocolGateway, ERC721Holder, AccessMana
/// @dev Caller must have the minter role for the provided SPG NFT.
/// @param nftContract The address of the NFT collection.
/// @param derivData The derivative data to be used for registerDerivative.
/// @param nftMetadata OPTIONAL. The desired metadata for the newly minted NFT.
/// @param ipMetadata OPTIONAL. The desired metadata for the newly registered IP.
/// @param ipMetadata OPTIONAL. The desired metadata for the newly minted NFT and registered IP.
/// @param recipient The address to receive the minted NFT.
/// @return ipId The ID of the registered IP.
/// @return tokenId The ID of the minted NFT.
function mintAndRegisterIpAndMakeDerivative(
address nftContract,
MakeDerivative calldata derivData,
string calldata nftMetadata,
IPMetadata calldata ipMetadata,
address recipient
) external onlyCallerWithMinterRole(nftContract) returns (address ipId, uint256 tokenId) {
tokenId = ISPGNFT(nftContract).mintBySPG({ to: address(this), payer: msg.sender, nftMetadata: nftMetadata });
tokenId = ISPGNFT(nftContract).mintBySPG({
to: address(this),
payer: msg.sender,
nftMetadataURI: ipMetadata.nftMetadataURI
});
ipId = IP_ASSET_REGISTRY.register(block.chainid, nftContract, tokenId);
_setMetadata(ipMetadata, ipId);

Expand Down Expand Up @@ -344,22 +350,24 @@ contract StoryProtocolGateway is IStoryProtocolGateway, ERC721Holder, AccessMana
/// @param nftContract The address of the NFT collection.
/// @param licenseTokenIds The IDs of the license tokens to be burned for linking the IP to parent IPs.
/// @param royaltyContext The context for royalty module, should be empty for Royalty Policy LAP.
/// @param nftMetadata OPTIONAL. The desired metadata for the newly minted NFT.
/// @param ipMetadata OPTIONAL. The desired metadata for the newly registered IP.
/// @param ipMetadata OPTIONAL. The desired metadata for the newly minted NFT and newly registered IP.
/// @param recipient The address to receive the minted NFT.
/// @return ipId The ID of the registered IP.
/// @return tokenId The ID of the minted NFT.
function mintAndRegisterIpAndMakeDerivativeWithLicenseTokens(
address nftContract,
uint256[] calldata licenseTokenIds,
bytes calldata royaltyContext,
string calldata nftMetadata,
IPMetadata calldata ipMetadata,
address recipient
) external onlyCallerWithMinterRole(nftContract) returns (address ipId, uint256 tokenId) {
_collectLicenseTokens(licenseTokenIds);

tokenId = ISPGNFT(nftContract).mintBySPG({ to: address(this), payer: msg.sender, nftMetadata: nftMetadata });
tokenId = ISPGNFT(nftContract).mintBySPG({
to: address(this),
payer: msg.sender,
nftMetadataURI: ipMetadata.nftMetadataURI
});
ipId = IP_ASSET_REGISTRY.register(block.chainid, nftContract, tokenId);
_setMetadata(ipMetadata, ipId);

Expand Down Expand Up @@ -446,19 +454,20 @@ contract StoryProtocolGateway is IStoryProtocolGateway, ERC721Holder, AccessMana
);
}

/// @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 ipMetadata The metadata to set.
/// @param ipId The ID of the IP.
function _setMetadata(IPMetadata calldata ipMetadata, address ipId) internal {
if (
keccak256(abi.encodePacked(ipMetadata.metadataURI)) != keccak256("") ||
ipMetadata.metadataHash != bytes32(0) ||
keccak256(abi.encodePacked(ipMetadata.ipMetadataURI)) != keccak256("") ||
ipMetadata.ipMetadataHash != bytes32(0) ||
ipMetadata.nftMetadataHash != bytes32(0)
) {
CORE_METADATA_MODULE.setAll(
ipId,
ipMetadata.metadataURI,
ipMetadata.metadataHash,
ipMetadata.ipMetadataURI,
ipMetadata.ipMetadataHash,
ipMetadata.nftMetadataHash
);
}
Expand Down
8 changes: 4 additions & 4 deletions contracts/interfaces/ISPGNFT.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,16 @@ interface ISPGNFT is IAccessControl, IERC721, IERC721Metadata {

/// @notice Mints an NFT from the collection. Only callable by the minter role.
/// @param to The address of the recipient of the minted NFT.
/// @param nftMetadata OPTIONAL. The desired metadata for the newly minted NFT.
/// @param nftMetadataURI OPTIONAL. The desired metadata for the newly minted NFT.
/// @return tokenId The ID of the minted NFT.
function mint(address to, string calldata nftMetadata) external returns (uint256 tokenId);
function mint(address to, string calldata nftMetadataURI) external returns (uint256 tokenId);

/// @notice Mints an NFT from the collection. Only callable by the SPG.
/// @param to The address of the recipient of the minted NFT.
/// @param payer The address of the payer for the mint fee.
/// @param nftMetadata OPTIONAL. The desired metadata for the newly minted NFT.
/// @param nftMetadataURI OPTIONAL. The desired metadata for the newly minted NFT.
/// @return tokenId The ID of the minted NFT.
function mintBySPG(address to, address payer, string calldata nftMetadata) external returns (uint256 tokenId);
function mintBySPG(address to, address payer, string calldata nftMetadataURI) external returns (uint256 tokenId);

/// @dev Withdraws the contract's token balance to the recipient.
/// @param recipient The token to withdraw.
Expand Down
29 changes: 12 additions & 17 deletions contracts/interfaces/IStoryProtocolGateway.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,16 @@ interface IStoryProtocolGateway {
/// @param nftContract The address of the newly created NFT collection.
event CollectionCreated(address indexed nftContract);

/// @notice Struct for metadata for an IP.
/// @param metadataURI The URI of the metadata for the IP.
/// @param metadataHash The hash of the metadata for the IP.
/// @notice Struct for metadata for NFT minting and IP registration.
/// @dev Leave the nftMetadataURI empty if not minting an NFT.
/// @param ipMetadataURI The URI of the metadata for the IP.
/// @param ipMetadataHash The hash of the metadata for the IP.
/// @param nftMetadataURI The URI of the metadata for the NFT.
/// @param nftMetadataHash The hash of the metadata for the IP NFT.
struct IPMetadata {
string metadataURI;
bytes32 metadataHash;
string ipMetadataURI;
bytes32 ipMetadataHash;
string nftMetadataURI;
bytes32 nftMetadataHash;
}

Expand Down Expand Up @@ -61,14 +64,12 @@ interface IStoryProtocolGateway {
/// @dev Caller must have the minter role for the provided SPG NFT.
/// @param nftContract The address of the NFT collection.
/// @param recipient The address of the recipient of the minted NFT.
/// @param nftMetadata OPTIONAL. The desired metadata for the newly minted NFT.
/// @param ipMetadata OPTIONAL. The desired metadata for the newly registered IP.
/// @param ipMetadata OPTIONAL. The desired metadata for the newly minted NFT and registered IP.
/// @return ipId The ID of the registered IP.
/// @return tokenId The ID of the minted NFT.
function mintAndRegisterIp(
address nftContract,
address recipient,
string calldata nftMetadata,
IPMetadata calldata ipMetadata
) external returns (address ipId, uint256 tokenId);

Expand Down Expand Up @@ -96,16 +97,14 @@ interface IStoryProtocolGateway {
/// @dev Caller must have the minter role for the provided SPG NFT.
/// @param nftContract The address of the NFT collection.
/// @param recipient The address of the recipient of the minted NFT.
/// @param nftMetadata OPTIONAL. The desired metadata for the newly minted NFT.
/// @param ipMetadata OPTIONAL. The desired metadata for the newly registered IP.
/// @param ipMetadata OPTIONAL. The desired metadata for the newly minted NFT and registered IP.
/// @param terms The PIL terms to be registered.
/// @return ipId The ID of the registered IP.
/// @return tokenId The ID of the minted NFT.
/// @return licenseTermsId The ID of the registered PIL terms.
function mintAndRegisterIpAndAttachPILTerms(
address nftContract,
address recipient,
string calldata nftMetadata,
IPMetadata calldata ipMetadata,
PILTerms calldata terms
) external returns (address ipId, uint256 tokenId, uint256 licenseTermsId);
Expand Down Expand Up @@ -134,15 +133,13 @@ interface IStoryProtocolGateway {
/// @dev Caller must have the minter role for the provided SPG NFT.
/// @param nftContract The address of the NFT collection.
/// @param derivData The derivative data to be used for registerDerivative.
/// @param nftMetadata OPTIONAL. The desired metadata for the newly minted NFT.
/// @param ipMetadata OPTIONAL. The desired metadata for the newly registered IP.
/// @param ipMetadata OPTIONAL. The desired metadata for the newly minted NFT and registered IP.
/// @param recipient The address to receive the minted NFT.
/// @return ipId The ID of the registered IP.
/// @return tokenId The ID of the minted NFT.
function mintAndRegisterIpAndMakeDerivative(
address nftContract,
MakeDerivative calldata derivData,
string calldata nftMetadata,
IPMetadata calldata ipMetadata,
address recipient
) external returns (address ipId, uint256 tokenId);
Expand All @@ -169,16 +166,14 @@ interface IStoryProtocolGateway {
/// @param nftContract The address of the NFT collection.
/// @param licenseTokenIds The IDs of the license tokens to be burned for linking the IP to parent IPs.
/// @param royaltyContext The context for royalty module, should be empty for Royalty Policy LAP.
/// @param nftMetadata OPTIONAL. The desired metadata for the newly minted NFT.
/// @param ipMetadata OPTIONAL. The desired metadata for the newly registered IP.
/// @param ipMetadata OPTIONAL. The desired metadata for the newly minted NFT and registered IP.
/// @param recipient The address to receive the minted NFT.
/// @return ipId The ID of the registered IP.
/// @return tokenId The ID of the minted NFT.
function mintAndRegisterIpAndMakeDerivativeWithLicenseTokens(
address nftContract,
uint256[] calldata licenseTokenIds,
bytes calldata royaltyContext,
string calldata nftMetadata,
IPMetadata calldata ipMetadata,
address recipient
) external returns (address ipId, uint256 tokenId);
Expand Down
Loading
Loading