How storyprotocol/protocol-core-v1 works
Main Components
a) Core Layer:
• IPAsset Registry (fundamental storage)
• IPAccount Registry (ERC-6551 based accounts)
• Module Registry (functionality registration)
• License Registry (IP licensing management)
b) Access Control Layer:
• Access Controller
• Permission Table
• Permission Engine
c) Module Layer (organize in distinct sections):
• Dispute Modules
• Grouping Modules
• Licensing Modules
• Metadata Modules
• Royalty Modules (including LAP and LRP policies)
d) External Integrations:
• ERC-721/NFT Contracts
• UMA Protocol (for dispute resolution)
• Client Applications
[Application Layer (External dApps)]
• ↕
[Core Protocol Layer]
• Access Control Layer
• Registry Layer
• Module Layer
• ↕
[Blockchain Layer (Ethereum)]
Connection Types
• Double lines: Inheritance relationships
Key Relationships to Highlight
a) IPAccount Interactions:
• How IPAccounts interact with modules through execute() and executeWithSig()
• Demonstrate the relationship between NFTs and their IPAccounts
b) Module Dependencies:
• How modules interact with registries
• Permission flows through the Access Controller
c) Registry Relationships:
• Connections between different registries
• How they maintain global state
Implementation Details
Create subsections for complex components:
• Detailed view of the Permission System
• Module interaction patterns
• Registry data flow
• Licensing and royalty mechanics
Technical Notes
• Use of ERC-7201 for storage patterns
• Upgrade proxy pattern implementation
• Where external calls are made
• Critical security boundaries
Remember to emphasize the protocol's unique aspects:
• IP-centric architecture
• Modular design
• Permission-based access control
• Upgradeable components
This will provide a comprehensive view of the system while maintaining readability and usefulness for technical discussions.