Liqwid-Labs/agora fork — vote-redeemer-lookup fix
Find a file
2022-08-13 21:41:13 +02:00
agora remove pvalidatorHashToTokenName 2022-08-12 05:01:35 +08:00
agora-bench fix compilation errors 2022-08-12 04:56:19 +08:00
agora-purescript-bridge parameterize scripts over AgoraScripts 2022-08-12 05:01:34 +08:00
agora-scripts parameterize scripts over AgoraScripts 2022-08-12 05:01:34 +08:00
agora-specs speed up test execution by precompiling scripts 2022-08-12 05:01:35 +08:00
agora-test remove Agora.MultiSig 2022-08-03 23:42:21 +08:00
agora-testlib/Test speed up test execution by precompiling scripts 2022-08-12 05:01:35 +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 bump version in agora.cabal 2022-08-13 15:02:43 +02:00
bench.csv update benchmark 2022-08-12 05:01:36 +08:00
cabal.project remove unused development flag 2022-08-12 19:13:28 +08:00
CHANGELOG.md add changelog entry for 0.2.0 2022-08-13 15:00:04 +02:00
CONTRIBUTING.md add links to git policy in README and CONTRIBUTING 2022-05-27 21:16:32 +02:00
flake.lock use liqwid-nix; enable checks for CI 2022-08-12 04:56:14 +08:00
flake.nix use liqwid-nix; enable checks for CI 2022-08-12 04:56:14 +08: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 refactor makefile 2022-08-12 04:56:18 +08:00
README.md Update README.md 2022-08-06 12:35:16 -04:00

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 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 liqwid-plutarch-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

Available support channels info

You can find help, more information and ongoing discusion about the project here: