Project Registry
What role does the Project Registry play in Allo?
The Project Registry is a universal, on-chain registry of projects that can apply for any Round on the Allo Protocol.
A project is any group that wishes to apply and receive funding. They are identified by an on-chain address (usually a multi-sig) and given a unique ID in the registry that maps to their off-chain metadata.
Every project in the registry is represented with a unique ID and some meta data. The metadata is made up of a protocol id (i.e.
1 for IPFS) and a pointer to data off-chain (i.e. QmPMERYmqZtbHmqd2UzRhX9F4cixnMQU2GFa2hYAsQ6J3D).The Project Registry has a method for adding a project to the registry, the signature for which is:
createProject(MetaPtr), where MetaPtr is the following struct:struct MetaPtr {
/// @notice Protocol ID corresponding to a specific protocol.
/// More info at https://github.com/gitcoinco/grants-round/tree/main/packages/contracts/docs/MetaPtrProtocol.md
uint256 protocol;
/// @notice Pointer to fetch metadata for the specified protocol
string pointer;
}
A group that wishes to receive grant funding from any round on the Allo protocol must first register their project in the Project Registry.
The Project Registry exposes a method for updating the metadata for a project in the registry (
updateProjectMetadata(uint256,MetaPtr)).A project can only be updated by one of its owners. Owners can be added and removed through the
addProjectOwner(uint256,address) and removeProjectOwner(uint256,address,address) methods, respectively.Data on projects, like when they register and when they update their metadata, is exposed via events and indexed in a subgraph. If you want to build something that leverages the data in the Project Registry, we recommend using this subgraph.
Last modified 1d ago