Liqwid-Labs/agora fork — vote-redeemer-lookup fix
Find a file
2022-06-29 12:25:01 +02:00
.github/workflows Restore GH actions as Hydra fails 2022-06-28 09:06:30 -05:00
agora add better server error messages, cbor vs raw hex 2022-06-28 21:13:56 +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 command line options 2022-06-29 10:44:33 +02:00
agora-specs fix broken test cases 2022-06-28 18:31:54 +08: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 add better server error messages, cbor vs raw hex 2022-06-28 21:13:56 +02:00
bench.csv efficiently encode proposal datum on chain 2022-06-28 22:41:06 +08:00
cabal.project create credentials using blake2b_224 2022-06-28 17:25:13 +08: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 bump liqwid-plutarch-extra 2022-06-28 22:41:05 +08:00
flake.nix create initial POC script generating API 2022-06-28 21:13:56 +02: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 add agora-scripts explainer in README.md 2022-06-29 11:36:13 +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.

agora-scripts HTTP export server

To use scripts in a frontend, you can use the agora-scripts executable which allows you to query them on-demand.

The CTL repo agora-offchain already has the setup prepared for this feature.

In order to run the server, simply run the following command:

cabal run agora-scripts -- --enable-cors-middleware

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