Readme (#243)

* readme * renamed mvp folder to legacy * fix image --------- Co-authored-by: Raul <[email protected]>
storyprotocol · Dec 8, 2023 · eded37b · eded37b
1 parent b01f704
commit eded37b
Show file tree

Hide file tree

Showing 40 changed files with 13 additions and 168 deletions.
diff --git a/README.md b/README.md
@@ -1,178 +1,21 @@
-🚧🚧🚧🚧 **Repo in active development, expect things to break and change.** 🚧🚧🚧🚧
+🚧🚧🚧🚧 ** Alpha deployment. This code is in active development and unaudited. Do not use in Production ** 🚧🚧🚧🚧
 
-# Story Protocol Contracts
-
-# Architecture Diagram
-![image](https://github.com/storyprotocol/protocol-contracts/assets/2632384/ce60fecc-1904-4c35-a4c1-577c90060feb)
-
-# Core Components
-
-In Story Protocol, the basic unit of intellectual property is the IPAsset, representing a well defined item that will be subject to a set of rules defined in each Franchise.
-IPAssets will have many categories corresponding to different domains of intellectual property, starting with Narrative Universes.
-
-The starting IPAsset types are:
-- Story
-- Character
-- Item
-- Location
-- Art
-- Group
-
-They have mediaURL, an off chain file identifying the IPA medium, duration, divisions, authorship and other characteristics.
-
-IPAssets can be combined together to form more rich intellectual property, and can be remixed and extended within the legal parameters defined on each Franchise.
-
-## FranchiseRegistry
-
-ERC721 that registers all the narrative franchises in Story Protocol.
-When registering a new franchise, along with minting an NFT to identify the Franchise Owner, all contracts required to represent the IPAssets, their IP rights, licenses, etc will be deployed by a factory.
-
-Ownership of a Franchise Registry token implies the power to:
-- Configure the licensing rules for the IPAssets created in the Franchise
-- Define possible Relationships between IPAssets of the same franchise 🚧
-
-Since this is an ERC721, ownership of the Franchise could be determined by an EOA, Multisig, Governor contracts or whatever available web3 coordination tool.
-
-
-## IPAssetRegistry
-
-ERC721 NFT where IPAssets are minted. There is 1 IPAssetRegistry per Franchise registered in Story Protocol.
-
-When minted, an IPAsset will also:
-1. Set it's metadata
-2. Set the parent IPA id, in case it is a remix
-3. Assign the licenses representing its IP Rights, as defined by the Franchise Owner in the Licensing Module.
-4. Configure it's collectible 🚧
-
-
-## IPAssetRegistryFactory
-
-Factory contract responsible for, when triggered by a Franchise registration, deploying an instance of the contracts required to represent and run said Franchise:
-- IPAssetRegistry
-- LicenseRegistry
-
-To save in gas, these contracts will be proxies, currently BeaconProxy clones 🚧
-
-# Modules
-
-We have represented the IP with our Core Components. Now let's look into the contracts that add utility and features to manage IP in Story Protocol:
-
-
-## Relationships
-
-A Relationship is an on-chain directional association between 2 IPAssets (or an IPAsset and an external NFT), identified by an ID and a set of pre conditions that gives it meaning.
-
-Relationships can have **previous steps**, defined by **RelationshipProcessor** contracts, that can be built to:
-
-- Check ownership over IPAssets being related.
-- Require payment in native currency, ERC20s...
-- Require the approval of the owner of one of the IPA
-- Any other interaction with other protocols, oracles...
-
-Since they are on-chain, they help compose with other modules or external protocols/contracts:
-- They can be created as a result of the execution of other modules (e.g agreeing on the Licensing terms for a Character creates an APPEARS_IN relationship between Character and Story)
-- They can be a condition for the correct execution of a module (IPA owner can emit commercial license of a Character IPA if said IPA has a EXTERNAL_PFP relation)
-- They can just have narrative meaning within the Franchise (two characters DID_HOOKUP, a story IS_SEQUEL of another) or some other community interation.
-
-There is going to be 2 levels for Relationships:
-- Protocol-wide relationships, defined by Governance and with interaction with protocol modules
-- Franchise level relationships, to be defined by Franchise Owner 🚧
-
-Protocol-wide relationships need to be proposed through a governance process, [like this one](https://github.com/storyprotocol/protocol-contracts/issues/33)
-
-A system to dispute and revoke Relationships is in the works 🚧
+[See Alpha agreement if you are going to use these contracts](https://github.com/storyprotocol/protocol-contracts/blob/main/StoryProtocol-AlphaTestingAgreement-17942166.3.pdf)
 
-## Licensing
+![Logo](image.png)
 
-The Licensing Module is at the heart of Story Protocol. It aims to create a transparent, public and fair legal environment for Franchise Owners and Creators to develop an IP while capturing the value and ownership among different contributors in a novel way.
-
-It has several component contracts:
-
-### RightsManager
-Every IPAssetRegistry is a RightsManager, which implements a modified version of [draft EIP-5218](https://eips.ethereum.org/EIPS/eip-5218).
-
-It manages trees of License structs and all their sublicenses. If a License is revoked (every License has a revoker address), all the licenses down the tree will be too.
-
-Every License can have none or many on-chain an off-chain terms, and both will be able to be composed from many "License Legos" 🚧
-- **Off-chain terms** are given by the License metadata and legal text files linked to the License struct (in the works, based in the Token Bound License)🚧. Off-chain terms will be enforced via a market of licensing flagger/revoker services, individuals and oracles or in worst case scenario, the legacy legal system.
-- **On-chain terms** are TermsProcessor contracts, that must be executed by the current License Holder in order to activate the License. These can include:
-    - Time limitations, with or without renewal.
-    - Setting revenue splits in the Royalty Module.
-    - Payment.
-    - Approval of the content by the licensor.
-    - Creation or check for existance of a Relationship between assets.
-    - External NFT ownership
-    - KYC Oracle
-    - Other cases build by the community
-
-A RightsManager allows us to grant 2 **type of License:**
-
-1. **Rights**: Licenses tied to a tokenId (IPAsset id), in which the license holder is always the owner of said tokenId. Each tokenId can have commercial or non commercial license tied to it. Transfering an IPAsset transfers the Rights too, so the previous owner will lose the ownership of the righst along the IPA.
-2. **Tradeable Licenses**: The license holder is the owner of the correspondent LicenseRegistry NFT. They are either:
-
-    a. **Franchise root license**: license minted by a Franchise owner to govern commercial or non commercial rights for all the IPAssetRegistries.
-
-    b. **Sublicense**: a license coming from IPA Rights or other Licenses, minted as an ERC721 by the parent license owner. These would be the future "movie adaptation to my story" or "merchandise rights for my PFP" type licenses that can be transferred or sold in NFT markets.
-
-### LicenseRegistry
-
-Simple ERC721 NFT wrapper for Tradeable Licenses registered in a RightsManager. Each IPAssetRegistry have its correspondent LicenseRegistry.
-
-### Licensing Module
-
-Networked IPs with multiple stakeholders need to have compatible licensing terms and characteristics in order to be commercially develop in a feasible way.
-The Licensing Module contract is where Franchise Owners define this common legal framework.
-
-By design, with the idea of growing the IP, every IPA will have a license that will **allow remixing it as long as the remixer**:
-- Attributes the original creator
-- It's for non commercial (or within reasonable commercial assumptions 🚧)
-- It's minted back to the Franchise as a child IPA with the same non commercial terms
-
-Root IPAs have optional commercial rights, meaning that a commercial License might be bought/requested from the owner of the rights, to do a commercial remixes, adaptations, merch, etc, with benefits traversing as defined by revenue/royalty modules. 
-
-**The configurable options are:**
-
-- For both commercial and non commercial rights of IPAs
-  - can they sublicense (remix)?
-  - do they have a Franchise level root License from which all the rights stem from?
-- Terms for both commercial and non commercial rights
-- Do root IPA have commercial rights on mint or not?
-- URI pointing to the Franchise Commercial Rights license text.
-
-We are going to have several **ready-made templates** for Franchise creators 🚧:
-
-- **Tight narrative/commercial direction:**
-  - Commercial Licenses can only be granted by the owner of the Root Commercial License (minted by Franchise Owner)
-  - Users can add and remix IPAs under Non Commercial terms.
-  - If Franchise Owner wants to emit commercial licenses from IPAs, an agreement must be made between IPA and Franchise owners (inclusion in upside/revenue, up front payment, voting rights, combination of some of all...)
-
-- **Loose narrative/commercial direction:**
-  - Every root IPA has commercial rights (under some terms, e.g owner of IPA is owner of external PFP NFT) and can emit commercial licenses around that IPA.
-
-
-## Collect
-
-Collect module allows users to mint duplicates of an IPA as a memento, way of supporting the creators, engagement metric...
-
-- Each IPA can configure custom CollectNFTs as result of the Collect action
-- Programable pre conditions for collection will be possible 🚧 (payment, approval)
-
-
-## Royalties Module
-
-Although revenue/royalties is a complicated subject, we are building infrastructure to make it easier for proyects, since correct incentivization of participants in IP creation is such a core issue in web3 and the off chain enternainment industry.
-
-NOTE: We are using royalties and revenue in an informal and interchangeable way. This is a system to distribute shares of value, the technical source of it is out of scope at the moment. 🚧
-
-The first obvious case that can be enforced with these contracts are on-chain revenue and royalties, but we expect the community to build bridges to more traditional platforms and payment rails that can route value here.
+# Story Protocol Contracts
 
-The RoyaltyDistributor contract allows IPAsset owners and license TermsProcessors to set revenue/royal shares.
+Story Protocol is a decentralized IP protocol for powering the next wave of creative innovation on the Internet. By providing a decentralized IP registry and a set of powerful modules centered around IP licensing, Story Protocol enables creators to build new forms of IP without the friction imposed by traditional processes.
 
-How the shares are configured is up to RoyaltyPolicies, and the actual shares are given by our RoyaltyNFT, an ERC-1155 wrapper over the [Split contracts of 0xSplits](https://www.0xsplits.xyz/)
+## Documentation
+[See Documenentation](https://docs.storyprotocol.xyz/docs/overview-2)
 
+## Guidelines
+[See our contribution guidelines](./GUIDELINES.md)
 
 # Deployed Contracts
-- [Goerli addresses](https://github.com/storyprotocol/protocol-contracts/blob/main/deployment-5.json)
+- [Sepolia addresses](https://github.com/storyprotocol/protocol-contracts/deployment-11155111.json)
 
 # Installing
 
@@ -282,7 +125,9 @@ make anvil
 This will spin up a local blockchain with a determined private key, so you can use the same private key each time.
 
 # Code Style
-We employed solhint to check code style.
+
+Defined in our [Guidelines](./GUIDELINES.md)
+
 To check code style with solhint run:
 ```
 make lint

diff --git a/image.png b/image.png
diff --git a/...nterfaces/ip-accounts/IERC6551Account.sol → ...nterfaces/ip-accounts/IERC6551Account.sol b/...nterfaces/ip-accounts/IERC6551Account.sol → ...nterfaces/ip-accounts/IERC6551Account.sol
diff --git a/...cts/interfaces/ip-accounts/IIPAccount.sol → ...cts/interfaces/ip-accounts/IIPAccount.sol b/...cts/interfaces/ip-accounts/IIPAccount.sol → ...cts/interfaces/ip-accounts/IIPAccount.sol
diff --git a/...rfaces/ip-accounts/IIPAccountRegistry.sol → ...rfaces/ip-accounts/IIPAccountRegistry.sol b/...rfaces/ip-accounts/IIPAccountRegistry.sol → ...rfaces/ip-accounts/IIPAccountRegistry.sol
diff --git a/...rfaces/modules/collect/ICollectModule.sol → ...rfaces/modules/collect/ICollectModule.sol b/...rfaces/modules/collect/ICollectModule.sol → ...rfaces/modules/collect/ICollectModule.sol
diff --git a/...nterfaces/modules/collect/ICollectNFT.sol → ...nterfaces/modules/collect/ICollectNFT.sol b/...nterfaces/modules/collect/ICollectNFT.sol → ...nterfaces/modules/collect/ICollectNFT.sol
diff --git a/...modules/collect/ICollectPaymentModule.sol → ...modules/collect/ICollectPaymentModule.sol b/...modules/collect/ICollectPaymentModule.sol → ...modules/collect/ICollectPaymentModule.sol
diff --git a/...modules/royalties/IRoyaltyDistributor.sol → ...modules/royalties/IRoyaltyDistributor.sol b/...modules/royalties/IRoyaltyDistributor.sol → ...modules/royalties/IRoyaltyDistributor.sol
diff --git a/...aces/modules/royalties/IRoyaltyPolicy.sol → ...aces/modules/royalties/IRoyaltyPolicy.sol b/...aces/modules/royalties/IRoyaltyPolicy.sol → ...aces/modules/royalties/IRoyaltyPolicy.sol
diff --git a/...terfaces/modules/royalties/ISplitMain.sol → ...terfaces/modules/royalties/ISplitMain.sol b/...terfaces/modules/royalties/ISplitMain.sol → ...terfaces/modules/royalties/ISplitMain.sol
diff --git a/...les/royalties/policies/IRoyaltyPolicy.sol → ...les/royalties/policies/IRoyaltyPolicy.sol b/...les/royalties/policies/IRoyaltyPolicy.sol → ...les/royalties/policies/IRoyaltyPolicy.sol
diff --git a/mvp/contracts/ip-accounts/IPAccountImpl.sol → ...y/contracts/ip-accounts/IPAccountImpl.sol b/mvp/contracts/ip-accounts/IPAccountImpl.sol → ...y/contracts/ip-accounts/IPAccountImpl.sol
diff --git a/...ntracts/ip-accounts/IPAccountRegistry.sol → ...ntracts/ip-accounts/IPAccountRegistry.sol b/...ntracts/ip-accounts/IPAccountRegistry.sol → ...ntracts/ip-accounts/IPAccountRegistry.sol
diff --git a/...cts/modules/collect/CollectModuleBase.sol → ...cts/modules/collect/CollectModuleBase.sol b/...cts/modules/collect/CollectModuleBase.sol → ...cts/modules/collect/CollectModuleBase.sol
diff --git a/...ules/collect/CollectPaymentModuleBase.sol → ...ules/collect/CollectPaymentModuleBase.sol b/...ules/collect/CollectPaymentModuleBase.sol → ...ules/collect/CollectPaymentModuleBase.sol
diff --git a/...s/modules/collect/SimpleCollectModule.sol → ...s/modules/collect/SimpleCollectModule.sol b/...s/modules/collect/SimpleCollectModule.sol → ...s/modules/collect/SimpleCollectModule.sol
diff --git a/...ts/modules/collect/nft/CollectNFTBase.sol → ...ts/modules/collect/nft/CollectNFTBase.sol b/...ts/modules/collect/nft/CollectNFTBase.sol → ...ts/modules/collect/nft/CollectNFTBase.sol
diff --git a/mvp/contracts/modules/collect/nft/ERC721.sol → .../contracts/modules/collect/nft/ERC721.sol b/mvp/contracts/modules/collect/nft/ERC721.sol → .../contracts/modules/collect/nft/ERC721.sol
diff --git a/.../modules/royalties/RoyaltyDistributor.sol → .../modules/royalties/RoyaltyDistributor.sol b/.../modules/royalties/RoyaltyDistributor.sol → .../modules/royalties/RoyaltyDistributor.sol
diff --git a/...ontracts/modules/royalties/RoyaltyNFT.sol → ...ontracts/modules/royalties/RoyaltyNFT.sol b/...ontracts/modules/royalties/RoyaltyNFT.sol → ...ontracts/modules/royalties/RoyaltyNFT.sol
diff --git a/...s/modules/royalties/RoyaltyNFTFactory.sol → ...s/modules/royalties/RoyaltyNFTFactory.sol b/...s/modules/royalties/RoyaltyNFTFactory.sol → ...s/modules/royalties/RoyaltyNFTFactory.sol
diff --git a/...licies/MutableRoyaltyProportionPolicy.sol → ...licies/MutableRoyaltyProportionPolicy.sol b/...licies/MutableRoyaltyProportionPolicy.sol → ...licies/MutableRoyaltyProportionPolicy.sol
diff --git a/mvp/test/foundry/IPAccount.t.sol → legacy/test/foundry/IPAccount.t.sol b/mvp/test/foundry/IPAccount.t.sol → legacy/test/foundry/IPAccount.t.sol
diff --git a/mvp/test/foundry/IPAccountRegistry.t.sol → legacy/test/foundry/IPAccountRegistry.t.sol b/mvp/test/foundry/IPAccountRegistry.t.sol → legacy/test/foundry/IPAccountRegistry.t.sol
diff --git a/mvp/test/foundry/RoyaltyDistributor.t.sol → legacy/test/foundry/RoyaltyDistributor.t.sol b/mvp/test/foundry/RoyaltyDistributor.t.sol → legacy/test/foundry/RoyaltyDistributor.t.sol
diff --git a/...test/foundry/RoyaltyDistributorFork.t.sol → ...test/foundry/RoyaltyDistributorFork.t.sol b/...test/foundry/RoyaltyDistributorFork.t.sol → ...test/foundry/RoyaltyDistributorFork.t.sol
diff --git a/...modules/collect/BaseCollectModuleTest.sol → ...modules/collect/BaseCollectModuleTest.sol b/...modules/collect/BaseCollectModuleTest.sol → ...modules/collect/BaseCollectModuleTest.sol
diff --git a/...es/collect/CollectPaymentModuleBase.t.sol → ...es/collect/CollectPaymentModuleBase.t.sol b/...es/collect/CollectPaymentModuleBase.t.sol → ...es/collect/CollectPaymentModuleBase.t.sol
diff --git a/...modules/collect/SimpleCollectModule.t.sol → ...modules/collect/SimpleCollectModule.t.sol b/...modules/collect/SimpleCollectModule.t.sol → ...modules/collect/SimpleCollectModule.t.sol
diff --git a/...ld_modules/collect/nft/BaseERC721Test.sol → ...ld_modules/collect/nft/BaseERC721Test.sol b/...ld_modules/collect/nft/BaseERC721Test.sol → ...ld_modules/collect/nft/BaseERC721Test.sol
diff --git a/..._modules/collect/nft/CollectNFTBase.t.sol → ..._modules/collect/nft/CollectNFTBase.t.sol b/..._modules/collect/nft/CollectNFTBase.t.sol → ..._modules/collect/nft/CollectNFTBase.t.sol
diff --git a/...dry/_old_modules/collect/nft/ERC721.t.sol → ...dry/_old_modules/collect/nft/ERC721.t.sol b/...dry/_old_modules/collect/nft/ERC721.t.sol → ...dry/_old_modules/collect/nft/ERC721.t.sol
diff --git a/mvp/test/foundry/mocks/MockCollectModule.sol → .../test/foundry/mocks/MockCollectModule.sol b/mvp/test/foundry/mocks/MockCollectModule.sol → .../test/foundry/mocks/MockCollectModule.sol
diff --git a/...foundry/mocks/MockCollectModuleERC721.sol → ...foundry/mocks/MockCollectModuleERC721.sol b/...foundry/mocks/MockCollectModuleERC721.sol → ...foundry/mocks/MockCollectModuleERC721.sol
diff --git a/mvp/test/foundry/mocks/MockCollectNFT.sol → legacy/test/foundry/mocks/MockCollectNFT.sol b/mvp/test/foundry/mocks/MockCollectNFT.sol → legacy/test/foundry/mocks/MockCollectNFT.sol
diff --git a/...oundry/mocks/MockCollectPaymentModule.sol → ...oundry/mocks/MockCollectPaymentModule.sol b/...oundry/mocks/MockCollectPaymentModule.sol → ...oundry/mocks/MockCollectPaymentModule.sol
diff --git a/mvp/test/foundry/mocks/MockIPAccount.sol → legacy/test/foundry/mocks/MockIPAccount.sol b/mvp/test/foundry/mocks/MockIPAccount.sol → legacy/test/foundry/mocks/MockIPAccount.sol
diff --git a/mvp/test/foundry/mocks/MockSplit.sol → legacy/test/foundry/mocks/MockSplit.sol b/mvp/test/foundry/mocks/MockSplit.sol → legacy/test/foundry/mocks/MockSplit.sol
diff --git a/mvp/test/foundry/mocks/MockSplitMain.sol → legacy/test/foundry/mocks/MockSplitMain.sol b/mvp/test/foundry/mocks/MockSplitMain.sol → legacy/test/foundry/mocks/MockSplitMain.sol