initial commit

.gitignore

@@ -0,0 +1,18 @@
+# Cabal builds
+dist/
+dist-newstyle/
+
+# Nix build results
+result
+result-*
+
+# Editors
+.vscode/
+.idea
+tags
+.nvimrc
+
+*.tix
+
+# Plutus dumped .flat files
+*.flat

.hlint.yaml

@@ -0,0 +1,7 @@
+# Ignored Rules
+- ignore: {name: "Unused LANGUAGE pragma"}
+- ignore: {name: "Use <$>"}
+
+# Extra warnings
+- warn: {name: Use explicit module import list}
+- warn: {name: Use module export list}

Makefile

@@ -0,0 +1,20 @@
+SHELL := /usr/bin/env bash
+
+.PHONY: hoogle format usage
+
+usage:
+	@echo "usage: make <command> [OPTIONS]"
+	@echo
+	@echo "Available commands:"
+	@echo "  hoogle -- Start local hoogle"
+	@echo "  format -- Format the project"
+
+HOOGLE_PORT=8081
+hoogle:
+	hoogle server --local --port $(HOOGLE_PORT)
+
+FORMAT_EXTENSIONS := -o -XQuasiQuotes -o -XTemplateHaskell -o -XTypeApplications -o -XImportQualifiedPost -o -XPatternSynonyms -o -fplugin=RecordDotPreprocessor
+format:
+	find -name '*.hs' -not -path './dist-*/*' | xargs fourmolu $(FORMAT_EXTENSIONS) -m inplace
+	git ls-tree -r HEAD --full-tree --name-only | grep -E '.*\.nix' | xargs nixfmt
+	git ls-tree -r HEAD --full-tree --name-only | grep -E '.*\.cabal' | xargs cabal-fmt

README.md

@@ -0,0 +1,19 @@
+# `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](see github.com/Liqwid-Labs/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](https://nixos.org/download.html). Important: See also [this section](https://github.com/input-output-hk/plutus#nix-advice) on binary caches.
+
+Open a dev-shell with `nix develop`, and build with `cabal build`.

agora.cabal

@@ -0,0 +1,88 @@
+cabal-version:      2.4
+name:               agora
+version:            0.1.0.0
+extra-source-files: CHANGELOG.md
+
+--------------------------------------------------------------------------------
+-- Common Stanza Declarations
+
+-- Language options, warnings, some options for plutus
+common lang
+  default-language:   Haskell2010
+  default-extensions:
+    NoImplicitPrelude
+    BangPatterns
+    BinaryLiterals
+    ConstraintKinds
+    DataKinds
+    DeriveAnyClass
+    DeriveFunctor
+    DeriveGeneric
+    DeriveTraversable
+    DerivingStrategies
+    DerivingVia
+    DuplicateRecordFields
+    EmptyCase
+    FlexibleContexts
+    FlexibleInstances
+    GADTs
+    GeneralizedNewtypeDeriving
+    HexFloatLiterals
+    ImportQualifiedPost
+    InstanceSigs
+    KindSignatures
+    LambdaCase
+    MultiParamTypeClasses
+    NumericUnderscores
+    OverloadedStrings
+    QuasiQuotes
+    ScopedTypeVariables
+    StandaloneDeriving
+    TupleSections
+    TypeApplications
+    TypeFamilies
+    TypeOperators
+    TypeSynonymInstances
+    UndecidableInstances
+
+  ghc-options:
+    -Wall -Wcompat -Wincomplete-uni-patterns -Wredundant-constraints
+    -Wmissing-export-lists -Werror -Wincomplete-record-updates
+    -fno-ignore-interface-pragmas -fno-omit-interface-pragmas
+    -fobject-code -fno-strictness -fplugin=RecordDotPreprocessor
+    -fplugin-opt PlutusTx.Plugin:dump-uplc
+
+-- Common external deps
+common deps
+  build-depends:
+    , base                     >=4.9 && <5
+    , ansi-terminal
+    , aeson
+    , base-compat
+    , bytestring
+    , cardano-prelude
+    , containers
+    , data-default
+    , data-default-class
+    , plutarch
+    , plutus-core
+    , plutus-ledger-api
+    , plutus-tx
+    , prettyprinter
+    , record-dot-preprocessor
+    , record-hasfield
+    , recursion-schemes
+    , template-haskell
+    , text
+
+--------------------------------------------------------------------------------
+
+library
+  import:          lang
+  import:          deps
+  exposed-modules:
+    Agora.AuthorityToken
+
+  other-modules:
+
+  hs-source-dirs:  src

cabal.project

@@ -0,0 +1,31 @@
+index-state: 2021-10-20T00:00:00Z
+
+packages: ./.
+
+-- Always build tests and benchmarks.
+tests: true
+benchmarks: true
+
+-- The only sensible test display option
+test-show-details: direct
+
+allow-newer:
+           -- Pins to an old version of Template Haskell, unclear if/when it will be updated
+           size-based:template-haskell
+           , ouroboros-consensus-byron:formatting
+           , beam-core:aeson
+           , beam-sqlite:aeson
+           , beam-sqlite:dlist
+           , beam-migrate:aeson
+
+package cardano-ledger-alonzo
+  optimization: False
+package ouroboros-consensus-shelley
+  optimization: False
+package ouroboros-consensus-cardano
+  optimization: False
+package cardano-api
+  optimization: False
+
+package plutarch
+  flags: +development

flake.nix

@@ -0,0 +1,254 @@
+{
+  description = "agora";
+
+  inputs.haskell-nix.url =
+    "github:input-output-hk/haskell.nix?rev=4aeeba8d713d0b98c92c8c717df24da17d463c1d";
+  inputs.nixpkgs.follows = "haskell-nix/nixpkgs-unstable";
+  inputs.haskell-nix.inputs.nixpkgs.follows = "haskell-nix/nixpkgs-2105";
+
+  inputs.plutus.url =
+    "github:input-output-hk/plutus?rev=6d8d25d1e84b2a4278da1036aab23da4161b8df8";
+
+  inputs.plutarch.url =
+    "github:Plutonomicon/plutarch?rev=c9a6760f780046018536dc088afaa0657d130ba2";
+
+  inputs.goblins.url =
+    "github:input-output-hk/goblins?rev=cde90a2b27f79187ca8310b6549331e59595e7ba";
+  inputs.goblins.flake = false;
+
+  inputs.cardano-addresses.url =
+    "github:input-output-hk/cardano-addresses?rev=d2f86caa085402a953920c6714a0de6a50b655ec";
+  inputs.cardano-addresses.flake = false;
+
+  inputs.optparse-applicative.url =
+    "github:input-output-hk/optparse-applicative?rev=7497a29cb998721a9068d5725d49461f2bba0e7a";
+  inputs.optparse-applicative.flake = false;
+
+  inputs.ouroboros-network.url =
+    "github:input-output-hk/ouroboros-network?rev=1f4973f36f689d6da75b5d351fb124d66ef1057d";
+  inputs.ouroboros-network.flake = false;
+
+  inputs.cardano-ledger-specs.url =
+    "github:input-output-hk/cardano-ledger-specs?rev=bf008ce028751cae9fb0b53c3bef20f07c06e333";
+  inputs.cardano-ledger-specs.flake = false;
+
+  inputs.iohk-monitoring-framework.url =
+    "github:input-output-hk/iohk-monitoring-framework?rev=46f994e216a1f8b36fe4669b47b2a7011b0e153c";
+  inputs.iohk-monitoring-framework.flake = false;
+
+  inputs.cardano-prelude.url =
+    "github:input-output-hk/cardano-prelude?rev=fd773f7a58412131512b9f694ab95653ac430852";
+  inputs.cardano-prelude.flake = false;
+
+  inputs.cardano-base.url =
+    "github:input-output-hk/cardano-base?rev=4ea7e2d927c9a7f78ddc69738409a5827ab66b98";
+  inputs.cardano-base.flake = false;
+
+  inputs.cardano-crypto.url =
+    "github:input-output-hk/cardano-crypto?rev=07397f0e50da97eaa0575d93bee7ac4b2b2576ec";
+  inputs.cardano-crypto.flake = false;
+
+  inputs.flat.url =
+    "github:Quid2/flat?rev=d32c2c0c0c3c38c41177684ade9febe92d279b06";
+  inputs.flat.flake = false;
+
+  inputs.Win32-network.url =
+    "github:input-output-hk/Win32-network?rev=3825d3abf75f83f406c1f7161883c438dac7277d";
+  inputs.Win32-network.flake = false;
+
+  outputs = inputs@{ self, nixpkgs, haskell-nix, plutus, ... }:
+    let
+      supportedSystems = with nixpkgs.lib.systems.supported;
+        tier1 ++ tier2 ++ tier3;
+
+      perSystem = nixpkgs.lib.genAttrs supportedSystems;
+
+      nixpkgsFor = system:
+        import nixpkgs {
+          inherit system;
+          overlays = [ haskell-nix.overlay ];
+          inherit (haskell-nix) config;
+        };
+
+      deferPluginErrors = true;
+
+      projectFor = system:
+        let pkgs = nixpkgsFor system;
+        in (nixpkgsFor system).haskell-nix.cabalProject' {
+          src = ./.;
+          compiler-nix-name = "ghc8107";
+          cabalProjectFileName = "cabal.project";
+
+          # This essentially replaces 'cabal-haskell.nix.project'
+          extraSources = [
+            {
+              src = inputs.cardano-prelude;
+              subdirs = [ "cardano-prelude" "cardano-prelude-test" ];
+            }
+            {
+              src = inputs.cardano-base;
+              subdirs = [
+                "base-deriving-via"
+                "binary"
+                "binary/test"
+                "cardano-crypto-class"
+                "cardano-crypto-praos"
+                "cardano-crypto-tests"
+                "measures"
+                "orphans-deriving-via"
+                "slotting"
+                "strict-containers"
+              ];
+            }
+
+            {
+              src = inputs.iohk-monitoring-framework;
+              subdirs = [
+                "iohk-monitoring"
+                "tracer-transformers"
+                "contra-tracer"
+                "plugins/backend-aggregation"
+                "plugins/backend-ekg"
+                "plugins/backend-monitoring"
+                "plugins/backend-trace-forwarder"
+                "plugins/scribe-systemd"
+              ];
+            }
+            {
+              src = inputs.cardano-ledger-specs;
+              subdirs = [
+                "byron/ledger/impl"
+                "cardano-ledger-core"
+                "cardano-protocol-tpraos"
+                "eras/alonzo/impl"
+                "eras/byron/chain/executable-spec"
+                "eras/byron/crypto"
+                "eras/byron/crypto/test"
+                "eras/byron/ledger/executable-spec"
+                "eras/byron/ledger/impl/test"
+                "eras/shelley/impl"
+                "eras/shelley-ma/impl"
+                "eras/shelley/chain-and-ledger/executable-spec"
+                "eras/shelley/test-suite"
+                "shelley/chain-and-ledger/shelley-spec-ledger-test"
+                "libs/non-integral"
+                "libs/small-steps"
+                "libs/cardano-ledger-pretty"
+                "semantics/small-steps-test"
+              ];
+            }
+            {
+              src = inputs.ouroboros-network;
+              subdirs = [
+                "monoidal-synchronisation"
+                "typed-protocols"
+                "typed-protocols-cborg"
+                "typed-protocols-examples"
+                "ouroboros-network"
+                "ouroboros-network-testing"
+                "ouroboros-network-framework"
+                "ouroboros-consensus"
+                "ouroboros-consensus-byron"
+                "ouroboros-consensus-cardano"
+                "ouroboros-consensus-shelley"
+                "io-sim"
+                "io-classes"
+                "network-mux"
+                "ntp-client"
+              ];
+            }
+
+            {
+              src = inputs.plutarch;
+              subdirs = [ "." ];
+            }
+            {
+              src = inputs.cardano-addresses;
+              subdirs = [ "core" "command-line" ];
+            }
+            {
+              src = inputs.goblins;
+              subdirs = [ "." ];
+            }
+            {
+              src = inputs.optparse-applicative;
+              subdirs = [ "." ];
+            }
+            {
+              src = inputs.cardano-crypto;
+              subdirs = [ "." ];
+            }
+            {
+              src = inputs.Win32-network;
+              subdirs = [ "." ];
+            }
+            {
+              src = inputs.flat;
+              subdirs = [ "." ];
+            }
+            {
+              src = inputs.plutus;
+              subdirs = [
+                "plutus-benchmark"
+                "plutus-core"
+                "plutus-errors"
+                "plutus-ledger-api"
+                "plutus-metatheory"
+                "plutus-tx"
+                "plutus-tx-plugin"
+                "prettyprinter-configurable"
+                "word-array"
+                "stubs/plutus-ghc-stub"
+              ];
+            }
+          ];
+          modules = [{
+            packages = {
+              plutus-ledger.flags.defer-plugin-errors = deferPluginErrors;
+              cardano-crypto-praos.components.library.pkgconfig =
+                nixpkgs.lib.mkForce
+                [ [ (import plutus { inherit system; }).pkgs.libsodium-vrf ] ];
+              cardano-crypto-class.components.library.pkgconfig =
+                nixpkgs.lib.mkForce
+                [ [ (import plutus { inherit system; }).pkgs.libsodium-vrf ] ];
+            };
+          }];
+          shell = {
+            withHoogle = true;
+
+            exactDeps = true;
+
+            nativeBuildInputs = with pkgs; [
+              cabal-install
+              hlint
+              haskellPackages.fourmolu
+              nixfmt
+              haskellPackages.cabal-fmt
+              haskellPackages.apply-refact
+              haskellPackages.record-dot-preprocessor
+              entr
+              gnumake
+            ];
+
+            additional = ps: [ ps.plutarch ];
+          };
+        };
+    in {
+      project = perSystem projectFor;
+      flake = perSystem (system: (projectFor system).flake { });
+
+      packages = perSystem (system: self.flake.${system}.packages);
+      checks = perSystem (system: self.flake.${system}.checks);
+      check = perSystem (system:
+        (nixpkgsFor system).runCommand "combined-test" {
+          nativeBuildInputs = builtins.attrValues self.checks.${system};
+        } "touch $out");
+      apps = perSystem (system: self.flake.${system}.apps);
+      devShell = perSystem (system:
+        self.flake.${system}.devShell.overrideAttrs (oldAttrs: {
+          buildInputs = (nixpkgsFor system).lib.unique oldAttrs.buildInputs;
+        }));
+      defaultPackage = perSystem
+        (system: self.flake.${system}.packages."liqwid-agora:lib:liqwid-agora");
+    };
+}

fourmolu.yaml

@@ -0,0 +1,8 @@
+indentation: 2
+comma-style: leading
+record-brace-space: true 
+indent-wheres: true
+diff-friendly-import-export: true 
+respectful: true 
+haddock-style: multi-line 
+newlines-between-decls: 1 

hie.yaml

@@ -0,0 +1,4 @@
+cradle:
+  cabal:
+    - path: "./src"
+      component: "lib:agora"

shell.nix

@@ -0,0 +1,6 @@
+# This file is no longer useful for normal nix-shell, as it has
+# been superseded by flake.nix However, this is still useful for
+# lorri to use automatically.
+{ system ? builtins.currentSystem }:
+
+(builtins.getFlake (toString ./.)).devShell.${system}

src/Agora/AuthorityToken.hs

@@ -0,0 +1,32 @@
+module Agora.AuthorityToken (authorityTokenPolicy, AuthorityToken (..)) where
+
+--------------------------------------------------------------------------------
+
+import Prelude
+
+--------------------------------------------------------------------------------
+
+import Plutus.V1.Ledger.Value (AssetClass)
+
+--------------------------------------------------------------------------------
+
+import Plutarch
+import Plutarch.Bool
+import Plutarch.Builtin
+import Plutarch.ScriptContext
+import Plutarch.Trace
+import Plutarch.Unit (PUnit (..))
+
+--------------------------------------------------------------------------------
+
+data AuthorityToken = AuthorityToken
+  { -- | Token that must move in order for minting this to be valid.
+    authorityAssetClass :: AssetClass
+  }
+
+--------------------------------------------------------------------------------
+
+authorityTokenPolicy :: AuthorityToken -> Term s (PData :--> PData :--> PScriptContext :--> PUnit)
+authorityTokenPolicy _params =
+  plam $ \_datum _redeemer _ctx ->
+    pif (pcon PTrue) (pcon PUnit) (ptraceError "Constraint failed")