History

Jack Hodgkinson 4d84c73a40 initiated effects		2022-02-03 14:59:47 +00:00
..
diagrams	removed redundant staking pool diagrams	2022-02-02 15:33:56 +00:00
meta	Added current status to staking pool	2022-02-02 15:04:48 +00:00
tech-design	initiated effects	2022-02-03 14:59:47 +00:00
README.md	minor changes	2022-01-26 14:45:49 +00:00

README.md

Spec Status	Impl Status	Last Revision
WIP	WIP	v0.1 22/01/26

Spec Ownership: Jack Hodgkinson

Authors: Jack Hodgkinson

Current Status:

Agora specification and documentation

This folder contains all of the specification and architecture documentation of Agora.

Technical design

The tech-design/ subdirectory contains high level descriptions of architecture involved in building Agora's governance system.

Implementation

Agora makes extensive use of Plutarch. So it's prerequisite for understanding the implementation. Plutarch features an extensive guide, which explains many intricacies of Plutarch and its use.

Glossary

The following is a list of terms that are used frequently:

Governance Token (GT): The token that holds value within the protocol and is used for voting, rewards, etc. Examples: Liqwid's LQ.
Authority Token (GAT): A token that delegates authority of a particular script / token. See tech-design/authority-token.md
Effect: The result of a proposal, enforced by an effect script.