Introducing Core Metadata Module and View Module

[kingster-will]

This PR introduces the CoreMetadataModule and CoreMetadataViewModule to the Story Protocol. These modules enable IP asset owners to set common metadata for their IP assets post-registration. Once set, this core metadata is immutable and cannot be changed. The CoreMetadataViewModule facilitates the retrieval of this core metadata and generates a JSON metadata string representing it.

CoreMetadataModule

The CoreMetadataModule allows IP asset owners to set essential metadata attributes such as name, description, and content hash. These attributes are critical for identifying and describing the IP assets within the Story Protocol ecosystem. The module ensures that each piece of metadata can only be set once, enforcing immutability and preserving the integrity of the IP asset's core information.

Key Features

• Immutability: IP Owner can freeze metadata, once the metadata was frozen, the core metadata attributes cannot be changed.
• Security: Integrates with the Story Protocol's access control mechanisms to ensure that only the IP asset owner or authorized parties can set metadata.

CoreMetadataViewModule

The CoreMetadataViewModule provides functionalities to retrieve the core metadata of IP assets and generate a JSON string representing all core metadata. This module is essential for external integrations and user interfaces that require access to an IP asset's metadata in a standardized format.

Key Features

• Metadata Retrieval: Allows fetching core metadata attributes like name, description, and content hash.
• JSON Metadata Generation: Generates a JSON string of all core metadata for IP assets, facilitating easy integration with external systems.

[LeoHChen]

So the core metadata come from two places ? One in the IPA, another in the registry?

[Ramarti]

Is this going to replace IPAssetRegistry?
In which step will this contract be called in the registration process?

[jdubpark]

Noting for future PRs, for the core vs periphery division, I strongly see the view modules as periphery modules as they interact with core components (and none of our core modules interact with view modules).

[kingster-will]

So the core metadata come from two places ? One in the IPA, another in the registry?

All core metadata come from IPAccount, while just under two namespaces, one is under namespace of IPAssetRegistry.

[kingster-will]

Is this going to replace IPAssetRegistry? In which step will this contract be called in the registration process?

Nope, it is not for replacing IPAssetRegistry. This contract is supposed to be called after the IPA is registered with IPAssetRegitry.

[kingster-will]

Noting for future PRs, for the core vs periphery division, I strongly see the view modules as periphery modules as they interact with core components (and none of our core modules interact with view modules).

Agree the future View Modules will be created in the periphery repo. Only the CoreMetadtaViewModule is needed in the core repo.

[jdubpark]

All core metadata come from IPAccount, while just under two namespaces, one is under namespace of IPAssetRegistry.

What's the difference between metadata under this namespace and under IPAssetRegistry? Would it be the type of metadata stored?

[jdubpark]

Looks good, requesting natspec comment changes

metadata scope