Smart contracts breakdown
Concepts to keep in mind
Stateless contracts
Aragon Govern's contracts hold very little state; this is to keep gas costs as low as possible and to keep the architecture lean. Akin to Stateless Ethereum, to witness all state transitions and ensure all data is forever available for querying and retrieval in an easy manner, we rely on our subgraph, which stores all actions and executions regarding Govern DAOs. Please refer to the subgraph docs to have more insight on which events are we tracking, and how.
Govern Smart Contracts
ERC3000 specific contracts haven't been included here. To browse them, go to the corresponding package.
GovernRegistry.sol
The
ERC3000Registry contract serves as the central registry for all Govern DAOs. Every DAO spawned through a properly-implemented GovernFactory will register the new DAO in the "official" registry. The registry takes care of doing these things:- Keep track* of every
Govern⟷GovernQueuepair assigning it a name on the blockchain. This means that instead of assigning an ENS name, this is left to the user, as the name itself will be saved in the contract's storage. - Setting metadata, which means you can include an IPFS CID to talk about your DAO, and include relevant links.
Think of it as...
A book which keeps track of every DAO and its core relevant info, which will be accessible through a subgraph.
* Due to the stateless nature of these contracts, it actually only emits an event, and registers the DAO name to the contract's storage so it cannot be overwritten. We rely on the subgraph to get this information.
GovernFactory.sol & GovernQueueFactory.sol
GovernFactory and GovernQueueFactory produce their respective contract instances: Govern and GovernQueue. The intended usage is to create a new GovernQueue, and feed the resulting address, along with an ERC3000Registry address to GovernFactory. The latter will then produce a new Govern contract, register it to the desired ERC3000Registry with the chosen name, and set up a standard set of permissions.Think of it as...
Templates; these could be modified and extended to set up more specific permissions and change the collateral needed to execute actions. This would be easy to do even for solidity beginners, considering these contracts don't inherit from other ones, and all permissions are already laid out.
Govern.sol
Govern is the DAO's executor and vault of the organization. It will be responsible for executing the actions that have been scheduled through the queue and holding the organization's funds. While the smart contract is extremely simple (<80 LOC), it can effectively call any external smart contract, which means it's basically a smart account which is governed by the DAO.GovernQueue.sol
GovernQueue is by far the most critical contract to understand, as it's the main point of interaction with the DAO and the Aragon Protocol. This is what most users will interact with directly—it holds the DAOs configuration parameters, and its where actors can schedule, execute, veto and challenge actions.GovernQueue can be configured, meaning you can change these parameters:1
struct Config {
2
uint256 executionDelay;
3
Collateral scheduleDeposit;
4
Collateral challengeDeposit;
5
address resolver;
6
bytes rules;
7
}
8
9
struct Collateral {
10
address token;
11
uint256 amount;
12
}
Copied!
The intended workflow for actions would be as follows, assuming the action was sent on chain to the optimistic queue (note that we're able to do this through
GovernQueue only):- 1.The action is scheduled. A time window opens for disputing this action.
- 1.If the action is challenged, the execution is paused and the action is sent to the arbitrator (Aragon Protocol) to resolve the dispute
- 2.If it is disputed in favor of the submitter, it will release the collateral to the submitter and execute the action(s).
- 3.If it is disputed in favor of the challenger, it will cancel the execution of the action(s) and release the collateral to the challenger.
- 2.The action has successfully passed the time window for challenges, and can be executed.
- 3.Anyone with the necessary permissions calls the
executemethod andGovernQueuewill make the Govern contract execute the actions.
Actions can be vetoed, which might be useful for projects which are venturing into further decentralizing but still desire a multisig for the time being, or want a way for its community to cancel a vote.
ACL.sol
The ACL from govern is a much leaner implementation of the original ACL from aragonOS, but still very powerful, having the ability to grant, revoke, and freeze roles. There are a couple of differences:
- Is devised to be as an inheritable contract. Instead of being a single contract that binds the whole organization together, both
GovernQueueandGovernhave their own ACLs. - It has a handy bulk function to set multiple permissions at once.
- The address for freezing a role is
0x0000000000000000000000000000000000000001. - The address for giving the permission to everyone is
0xffffffffffffffffffffffffffffffffffffffff
Last modified 3mo ago