Liqwid-Labs/agora fork — vote-redeemer-lookup fix
Find a file
2022-06-22 21:57:26 +02:00
.github/workflows don't need to add ssh key in ci workflow anymore 2022-06-16 23:48:54 +08:00
agora fix Agora's PTryFrom instances through orphans 2022-06-22 21:57:26 +02:00
agora-bench use LF as record separator in bench.csv 2022-06-22 00:14:37 +08:00
agora-purescript-bridge remove purescript-bridge generated files 2022-06-22 21:57:25 +02:00
agora-scripts update scripts 2022-06-16 20:50:24 +08:00
agora-specs Governor policy property 2022-06-22 11:53:32 -05:00
agora-test governorDatumValid property 2022-06-17 13:39:18 -05:00
agora-testlib/Test improve readability of test code 2022-06-20 21:49:39 +08:00
docs update dead link in docs/README.md 2022-06-02 16:28:14 +02:00
.gitignore Initialised skeleton for treasury 2022-03-01 12:53:39 +00:00
.hlint.yaml initial commit 2022-01-13 00:06:37 +01:00
agora.cabal fix Agora's PTryFrom instances through orphans 2022-06-22 21:57:26 +02:00
bench.csv use LF as record separator in bench.csv 2022-06-22 00:14:37 +08:00
cabal.project add missing asserts to Stake policy 2022-02-18 23:11:43 +01:00
CHANGELOG.md add @since tags to everything 2022-06-22 21:57:26 +02:00
CONTRIBUTING.md add links to git policy in README and CONTRIBUTING 2022-05-27 21:16:32 +02:00
flake.lock Governor policy property 2022-06-22 11:53:32 -05:00
flake.nix Moved samples to PCB 2022-06-17 12:35:33 -05:00
fourmolu.yaml initial commit 2022-01-13 00:06:37 +01:00
hie.yaml add proposalDatumValid 2022-04-27 12:51:01 +02:00
LICENSE add stubbed out test suite, CHANGELOG, LICENSE 2022-01-13 16:31:00 +01:00
Makefile add command make scripts 2022-06-16 20:50:23 +08:00
README.md rid ourselves of old component docs 2022-06-22 21:57:26 +02:00

Agora 🏛️

integrate.yaml badge

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 blockchain.
  • Agora aims to be modular and flexible for 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 version of the Nix package manager (>=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 development shell with nix develop and build the project with cabal build. Those pained by the need to remember to enter a Nix shell may consider using nix-direnv.

Documentation

Documentation for Agora is hosted on Notion. You can find the specs here.

Haddock is deployed on GitHub Pages here.

Using Agora for your protocol

If you are a protocol wanting to use Agora, read Using Agora.

Contributing

Please read CONTRIBUTING.md. Additionally, please follow the Git policy when contributing to this project.

Overview of components

Road-map

v1

  • Governor
  • Treasury
  • Stakes
  • Proposals
  • Effects

v2

  • Rewards distribution
  • Escrow staking pool solution