Liqwid-Labs/agora fork — vote-redeemer-lookup fix
Leaving some comments/questions from my first read-through (starting in alphabetical order in `tech-design`). I'll probably have answered most of these by the time I'm finished going through all the docs, but it will do us well to make this as easy to read straight through as possible. General comments: ----- - It'd be good to pick an entry-point/give an overview in the README. This way you can keep track of when different concepts are introduced, and contributors to the spec will have a better idea of what they can assume their audience knows. - These docs are Liqwid-centric (and I believe I've skimmed earlier versions in the `liqwid-specs` repo) right now. We should decide whether we want to keep these specs focused on Liqwid, or if it would make sense to build up a small, hypothetical, minimum-viable-example that gets extended with Agora. The benefits of the former are that you can point to a real-world example of Agora's principles and implementation in practice; the latter could be more useful in a "here's how to integrate Agora into a project" tutorial |
||
|---|---|---|
| docs | ||
| src/Agora | ||
| test | ||
| .gitignore | ||
| .hlint.yaml | ||
| agora.cabal | ||
| cabal.project | ||
| CHANGELOG.md | ||
| flake.lock | ||
| flake.nix | ||
| fourmolu.yaml | ||
| hie.yaml | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| shell.nix | ||
agora
Agora is a set of Plutus scripts that compose together to form a Governance system.
What is Agora
Goals:
- Agora aims to reduce duplication in Liqwid and LiqwidX and to serve as a one-size-fits-all governance library for projects on the Cardano Network.
- Agora aims to be modular and allow customizing specific needs, but presents an opinionated architecture.
Non-goals:
- Agora is not a DAO. It doesn't have tokenomics or even a token. It is simply a library for governance.
- Agora doesn't aim to provide any primitive tools for plutus that are not governance-specific. For this, see plutus-extra.
Project setup
An up to date nix (>=2.3) is required to build this project. For information on how to install, see the nixos website. Important: See also this section on binary caches.
Open a dev-shell with nix develop, and build with cabal build.
Documentation
See documentation of the agora architecture in docs.