Sulkta-Coop/agora
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Liqwid-Labs/agora fork — vote-redeemer-lookup fix
822 commits 2 branches 0 tags 3.2 MiB
Find a file
Emily Martins 8d06e8b93e get rid of redundant docs, update README a little
2022-09-16 16:13:27 +02:00
agora workaround CTL validity range inclusiveness issue 2022-09-15 22:30:30 +08:00
agora-bench explicit imports for core agora modules 2022-08-18 16:52:53 +02:00
agora-purescript-bridge fix treasury implementation and tests 2022-09-01 20:45:42 +02:00
agora-scripts Add the effect validator to the API 2022-09-02 15:58:58 +02:00
agora-specs fix #174 2022-09-15 20:01:06 +08:00
agora-test remove Agora.MultiSig 2022-08-03 23:42:21 +08:00
agora-testlib/Test fix tests 2022-09-13 20:24:29 +08:00
docs/diagrams get rid of redundant docs, update README a little 2022-09-16 16:13:27 +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 standalone stake redeemers 2022-09-13 22:21:18 +08:00
bench.csv workaround CTL validity range inclusiveness issue 2022-09-15 22:30:30 +08:00
cabal.project remove unused development flag 2022-08-12 19:13:28 +08:00
CHANGELOG.md update changelog 2022-09-15 22:38:56 +08:00
CONTRIBUTING.md Update CONTRIBUTING.md 2022-08-31 18:18:32 -05:00
flake.lock bump plutarch-script-export for correct V2 scripts 2022-09-14 13:28:47 +02:00
flake.nix bump plutarch/LPE/PCB; point plutarch to master branch 2022-09-13 20:24:20 +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 infer system for make ci 2022-08-24 18:33:38 +02:00
README.md get rid of redundant docs, update README a little 2022-09-16 16:13:27 +02:00

README.md

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 XplorerDAO 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.

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

  • Flexible scripts using TxT pattern integrated with governance
  • Different voting mechanisms

Available support channels info

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