forked from storyprotocol/protocol-periphery
-
Notifications
You must be signed in to change notification settings - Fork 25
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
Introduce Story NFT #87
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sebsadface
force-pushed
the
badge
branch
13 times, most recently
from
October 5, 2024 15:56
2124337
to
725e774
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good PR!
sebsadface
force-pushed
the
badge
branch
6 times, most recently
from
October 8, 2024 05:46
32f0857
to
0f65ea5
Compare
sebsadface
commented
Oct 9, 2024
kingster-will
approved these changes
Oct 9, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces the Story NFT contracts, enabling developers to quickly bootstrap an NFT contract with built-in functionality for IP and derivative registration.
Overview of New Interfaces and Contracts
OrgNFT
&IOrgNFT
: Represents organizations deploying Story NFTs. Each organization is assigned a uniqueOrgNFT
token, which establish a one-to-one mapping between the organization and its instance of a Story NFT contract.IStoryNFTFactory
&StoryNFTFactory
: Serve as the entry point for registering organizations and deploying new Story NFT contracts. The factory allows easy Story NFT creation and ensures proper linkage between organizations and their NFTs.IStoryNFT
&BaseStoryNFT
: An interface and abstract contract defining standard functions and behaviors for all Story NFTs. Custom Story NFTs needs to inherit these to ensure compatibility across different Story NFT contracts.IERC5192
: A minimal interface for soulbound NFTs (non-transferable tokens), implemented by theStoryBadgeNFT
contract.IStoryBadgeNFT
&StoryBadgeNFT
: Provide a default implementation ofIStoryNFT
andBaseStoryNFT
, serving as the default template for Story NFTs created via theStoryNFTFactory
.IP Relationships
Upon minting, each token in
OrgNFT
and instances ofStoryNFTs
is registered as an IP, with relationships defined as follows:The ancestor of all Story NFT IPs is the
OrgNFT
token of Story (token ID 0).All other
OrgNFT
tokens, representing different organizations, are considered derivatives of Story's Org token.Tokens minted through each
StoryNFT
contract instance are considered derivatives of theOrgNFT
associated with that specific contract.Additional Changes
Test Plan
test/story-nft
).