Skip to content

Commit

Permalink
Add Governor to governance README (#1250)
Browse files Browse the repository at this point in the history
* feat: update README

* feat: add extensions
  • Loading branch information
ericnordelo authored Dec 6, 2024
1 parent cb41a36 commit 6449ed6
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions packages/governance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,21 @@ This crate includes primitives for on-chain governance.

### Interfaces

- [`IGovernor`](https://docs.openzeppelin.com/contracts-cairo/0.20.0-rc.0/api/governance#IGovernor)
- [`ITimelock`](https://docs.openzeppelin.com/contracts-cairo/0.20.0-rc.0/api/governance#ITimelock)
- [`IVotes`](https://docs.openzeppelin.com/contracts-cairo/0.20.0-rc.0/api/governance#IVotes)

### Components

- [`GovernorComponent`](https://docs.openzeppelin.com/contracts-cairo/0.20.0-rc.0/api/governance#GovernorComponent)
- [`TimelockControllerComponent`](https://docs.openzeppelin.com/contracts-cairo/0.20.0-rc.0/api/governance#TimelockControllerComponent)
- [`VotesComponent`](https://docs.openzeppelin.com/contracts-cairo/0.20.0-rc.0/api/governance#VotesComponent)

#### Governor Extensions

- [`GovernorCoreExecutionComponent`](https://docs.openzeppelin.com/contracts-cairo/0.20.0-rc.0/api/governance#GovernorCoreExecutionComponent)
- [`GovernorCountingSimpleComponent`](https://docs.openzeppelin.com/contracts-cairo/0.20.0-rc.0/api/governance#GovernorCountingSimpleComponent)
- [`GovernorSettingsComponent`](https://docs.openzeppelin.com/contracts-cairo/0.20.0-rc.0/api/governance#GovernorSettingsComponent)
- [`GovernorVotesComponent`](https://docs.openzeppelin.com/contracts-cairo/0.20.0-rc.0/api/governance#GovernorVotesComponent)
- [`GovernorVotesQuorumFractionComponent`](https://docs.openzeppelin.com/contracts-cairo/0.20.0-rc.0/api/governance#GovernorVotesQuorumFractionComponent)
- [`GovernorTimelockExecutionComponent`](https://docs.openzeppelin.com/contracts-cairo/0.20.0-rc.0/api/governance#GovernorTimelockExecutionComponent)

0 comments on commit 6449ed6

Please sign in to comment.