search

storyprotocol / protocol-periphery-v1

Periphery contract for story protocol, mainnet repo
MIT License
28 stars 20 forks source link

feat(spg-nft): add support for setting metadata for SPG NFT #20

Closed sebsadface closed 2 months ago

sebsadface commented 2 months ago

Description

This PR adds support for setting metadata for SPG NFT, including:

Tests

Related Issue

This PR closes #17

Notes

An additional nftMetadata argument is now required for SPG functions with minting functionality (e.g., mintAndRegisterIp, mintAndRegisterIpAndAttachPILTerms) and direct SPG NFT mint calls.

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent changes to the SPGNFT and StoryProtocolGateway contracts significantly enhance their metadata handling capabilities. The minting functions now allow for explicit metadata input during NFT creation, providing greater flexibility and clarity. By restructuring metadata parameters and supporting off-chain storage options, these updates improve usability and pave the way for more robust NFT management.

Changes

Files Change Summary
contracts/SPGNFT.sol, contracts/interfaces/ISPGNFT.sol Updated mint and mintBySPG functions to include nftMetadata parameter for better metadata management during NFT minting.
contracts/StoryProtocolGateway.sol, contracts/interfaces/IStoryProtocolGateway.sol Split metadata parameter into nftMetadata and ipMetadata for clarity in minting and registration functions, enhancing the contract's usability.
test/SPGNFT.t.sol, test/StoryProtocolGateway.t.sol Introduced new metadata variables in tests, adjusting assertions and minting calls to reflect changes in metadata handling for NFTs and IPs.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SPGNFT
    participant StoryProtocolGateway

    User->>SPGNFT: mint(address to, string nftMetadata)
    SPGNFT->>SPGNFT: _mintToken(to, nftMetadata)
    SPGNFT->>User: Return tokenId

    User->>StoryProtocolGateway: mintAndRegisterIp(address nftContract, address recipient, string nftMetadata, IPMetadata ipMetadata)
    StoryProtocolGateway->>StoryProtocolGateway: Process minting and registration
    StoryProtocolGateway->>User: Return confirmation

Assessment against linked issues

Objective Addressed Explanation
SPG NFT supports set metadata (#17) ✅
Ability to specify tokenURI during minting ✅
Support for off-chain metadata storage option ❌ Current changes do not implement off-chain metadata storage.

Poem

🐰 In the meadow where the NFTs play,
Metadata dances in a bright array.
With every mint, a story to tell,
Off-chain whispers, we know it well.
Hopping through code, our joy we proclaim,
In the land of tokens, we play the game! 🌼✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.