MetadataExtensionUpgradeable

Abstract contract · src/common/utils/metadata/MetadataExtensionUpgradeable.sol

Author: Aragon X - 2024

Inherits: ERC165Upgradeable, DaoAuthorizableUpgradeable

An abstract, upgradeable contract for managing and retrieving metadata associated with a plugin.

Dev: Due to the requirements that already existing upgradeable plugins need to start inheritting from this, we're required to use hardcoded/specific slots for storage instead of sequential slots with gaps.

security-contact: sirt@aragon.org

Functions

dao

function dao() external view returns (IDAO)

Selector: 0x4162169f

Returns the DAO contract.

Returns	Type	Description
[0]	IDAO

getMetadata

function getMetadata() external view returns (bytes)

Selector: 0x7a5b4f59

Returns the metadata currently applied.

setMetadata

function setMetadata(bytes _metadata) external

Selector: 0xee57e36f

Allows to update only the metadata.

Parameter	Type	Description
_metadata	bytes	The utf8 bytes of a content addressing cid that stores plugin's information.

supportsInterface

function supportsInterface(bytes4 _interfaceId) external view returns (bool)

Selector: 0x01ffc9a7

Checks if this or the parent contract supports an interface by its ID.

Parameter	Type	Description
_interfaceId	bytes4	The ID of the interface.

Events

Initialized

event Initialized(uint8 version)

Dev: Triggered when the contract has been initialized or reinitialized.

MetadataSet

event MetadataSet(bytes metadata)

Emitted when metadata is updated.

Errors

DaoUnauthorized

error DaoUnauthorized(address dao, address where, address who, bytes32 permissionId)

Thrown if a call is unauthorized in the associated DAO.

Parameter	Type	Description
dao	address	The associated DAO.
where	address	The context in which the authorization reverted.
who	address	The address (EOA or contract) missing the permission.
permissionId	bytes32	The permission identifier.

Constants

Public, so each is also readable through a generated getter.

SET_METADATA_PERMISSION_ID

bytes32 public constant SET_METADATA_PERMISSION_ID = keccak256("SET_METADATA_PERMISSION");

Value: 0x4707e94b25cfce1a7c363508fbb838c35864388ad77284b248282b9746982b9b

The ID of the permission required to call the setMetadata function.

Structs

MetadataExtensionStorage

struct MetadataExtensionStorage {
    bytes metadata;
}