Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 0.1.0 #125

Merged
merged 6 commits into from
Jun 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,8 @@

This format is based on [Keep A Changelog](https://keepachangelog.com/en/1.0.0).

## Unreleased
## 0.1.0 -- 2022-06-22

### Added

* First release
71 changes: 8 additions & 63 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,78 +35,23 @@ If you are a protocol wanting to use Agora, read [Using Agora](https://liqwid.no

Please read [CONTRIBUTING.md](./CONTRIBUTING.md). Additionally, please follow the [Git policy](https://liqwid.notion.site/Git-Policy-9a7979b2fd5d4604b6d042b084e7e14f) when contributing to this project.

## Overview of components

<p align="center">
<img src="/docs/diagrams/gov-overview.svg"/>
</p>

## Road-map

### v1

- [x] Governor
- [x] Treasury
- [ ] Staking pool
- [ ] Proposals
- [x] Stakes
- [x] Proposals
- [x] Effects

### v2

- [ ] Rewards distribution
- [ ] Escrow staking pool solution

### Beyond

- [ ] ...


# Governance concepts

This section seeks to introduce to the reader the concept of governance systems on Cardano and acquaint them with the core components of a generic governance system.

## Simple questions, simple answers

### Q: What's a 'governance'?

A: A _governance system_ is a component of a Cardano system, that allows for its community to issue and vote on proposals.

### Q: What can be proposed?

A: That depends on the Cardano protocol in-question. An example for a proposal could suggest that funds be released from a community treasury. Another might propose an alteration to some parameter in the wider-system.

### Q: Who can vote?

A: The right to vote is conferred by the _staking_ of some designated _governance token_ (GT). If one owns the relevant token, they may 'stake' some of it to vote in favour of, or opposition to, some proposal.

## Overview of components

<p align="center">
<img src="/docs/diagrams/gov-overview.svg"/>
</p>

More-detailed information on individual components will be included in their own, specific documentation. This section provides brief descriptions on the purpose of each component.

### Users

A user is a member of the DAO (decentralised autonomous organisation), who
may choose to redeem governance tokens (GT) from the treasury and stake those GT
to vote in favour of, or opposition to, proposals.

### Governance tokens

Governance tokens (GTs) are a currency, which confer the right to vote on proposals.

### Treasury

The treasury of a governance system is responsible for determining which users are entitled to what GT rewards and when. If a user is eligible for a reward, it they must claim it from the treasury. A treasury can also serve as a form of 'DAO wallet', storing and saving funds that can be later spent by the community.

### Stakes

Users are required to 'lock' their GT in stakes, so that the system has some idea of their eligibility to vote on proposal.

### Proposal

A proposal suggests for some specified changes to be made to a Cardano system. It is voted upon by the community and, if passed, its effects are applied to the system.

### Effects

Proposals may have one or many 'effects', which represent the concrete, individual changes the proposal would make to the system. If their corresponding proposals have been passed, each effect is granted a _governance authority token_ (GAT) by the governor. This token permits the effect to alter the system.

### Governor

The governor is responsible for validating whether proposals have passed. If they have, it issues GATs to the proposals' effects.
24 changes: 0 additions & 24 deletions agora-purescript-bridge/src/Agora/AuthorityToken.purs

This file was deleted.

28 changes: 0 additions & 28 deletions agora-purescript-bridge/src/Agora/Effect/GovernorMutation.purs

This file was deleted.

29 changes: 0 additions & 29 deletions agora-purescript-bridge/src/Agora/Effect/TreasuryWithdrawal.purs

This file was deleted.

89 changes: 0 additions & 89 deletions agora-purescript-bridge/src/Agora/Governor.purs

This file was deleted.

28 changes: 0 additions & 28 deletions agora-purescript-bridge/src/Agora/MultiSig.purs

This file was deleted.

Loading