MetadataProviderBase.sol

Metadata provider base contract for storing canonical IP metadata.

contract IIPAssetRegistry IP_ASSET_REGISTRY

Returns the protocol-wide IP Asset registry.

contract IMetadataProvider upgradeProvider

Returns the new metadata provider IP Assets may migrate to.

mapping(address => bytes) _ipMetadata

Maps IP Assets (via their IP ID) to their canonical metadata.

modifier onlyIPAssetRegistry()

Restricts calls to only originate from a protocol-authorized caller.

constructor(address ipAssetRegistry) internal

function getMetadata(address ipId) external view virtual returns (bytes)

Gets the metadata associated with an IP Asset.

Name	Type	Description
ipId	address	The address identifier of the IP Asset.

Name	Type	Description
[0]	bytes	metadata The encoded metadata associated with the IP Asset.

function setUpgradeProvider(address provider) external

Sets an upgrade provider for users to migrate their metadata to.

Name	Type	Description
provider	address	The address of the new metadata provider to migrate to.

function upgrade(address payable ipId, bytes metadata) external

Updates the provider used by the IP Asset, migrating existing metadata to the new provider, and adding
new metadata.

Name	Type	Description
ipId	address payable	The address identifier of the IP Asset.
metadata	bytes	Additional metadata in bytes used by the new metadata provider.

function setMetadata(address ipId, bytes metadata) external virtual

Sets the metadata associated with an IP Asset.

Enforced to be only callable by the IP Asset registry.

Name	Type	Description
ipId	address	The address identifier of the IP Asset.
metadata	bytes	The metadata in bytes to associate with the IP Asset.

function _verifyMetadata(bytes metadata) internal virtual

Checks that the data conforms to the canonical metadata standards.

Name	Type	Description
metadata	bytes	The canonical metadata in bytes to verify.

function _compatible(bytes m1, bytes m2) internal pure virtual returns (bool)

Checks whether two sets of metadata are compatible with one another.

Name	Type	Description
m1	bytes	The first set of bytes metadata being compared.
m2	bytes	The second set of bytes metadata being compared.