cape.cabal

cabal-version: 3.4
name:          cape
version:       1.0.0
synopsis:      UPLC-CAPE benchmark framework and measurement tools
description:
  The UPLC-CAPE (Untyped Plutus Core - Comparative Artifact Performance Evaluation)
  framework provides tools for benchmarking and measuring UPLC smart contract
  performance across different compilers. This package includes measurement tools,
  benchmark implementations using Plinth (PlutusTx), and test suites.

author:        UPLC-CAPE Project
maintainer:    UPLC-CAPE Project
category:      Blockchain
license:       Apache-2.0

flag preview
  description:
    Enable preview modules (requires plutus-tx-plugin with BuiltinCasing support)

  default:     False
  manual:      True

common common-deps
  build-depends:
    , aeson
    , aeson-pretty
    , base               >=4.16
    , bytestring
    , flat
    , plutus-core        ^>=1.45
    , plutus-ledger-api  ^>=1.45
    , plutus-tx          ^>=1.45
    , plutus-tx-plugin   ^>=1.45
    , relude             ^>=1.2.2
    , serialise
    , text
    , time

-- Shared language settings (warnings, mixins, default extensions). Carries
-- no build-depends so a stanza can opt in to the project's house style
-- without pulling the heavy plutus-tx-plugin dep that lives in common-deps.
common common-language-base
  ghc-options:
    -Wall -Wcompat -Wincomplete-uni-patterns -Wredundant-constraints
    -Wmissing-export-lists -Wmissing-deriving-strategies
    -Wpartial-fields

  default-language:   Haskell2010
  mixins:
    base hiding (Prelude),
    relude (Relude as Prelude)

  default-extensions:
    BangPatterns
    BlockArguments
    DataKinds
    DeriveAnyClass
    DeriveGeneric
    DerivingStrategies
    FlexibleContexts
    FlexibleInstances
    GeneralizedNewtypeDeriving
    ImportQualifiedPost
    LambdaCase
    MultiParamTypeClasses
    MultiWayIf
    NamedFieldPuns
    NoImplicitPrelude
    NumericUnderscores
    OverloadedStrings
    PatternSynonyms
    QuasiQuotes
    ScopedTypeVariables
    Strict
    TemplateHaskell
    TypeApplications
    TypeFamilies
    UndecidableInstances
    ViewPatterns

common common-language
  import: common-language-base
  import: common-deps

-- Core measurement and benchmark library
library
  import:          common-language
  exposed-modules:
    Cape.Compile
    Cape.Data.Decode
    Cape.Data.PlutusJson
    Cape.Data.UplcText
    Cape.Error
    Cape.Fixture
    Cape.PrettyResult
    Cape.Protocol.Parameters
    Cape.ScriptContextBuilder
    Cape.Tests
    Cape.Verify
    Cape.WritePlc
    Ecd
    Factorial
    Fibonacci
    FibonacciIterative
    HTLC
    HTLC.Fixture
    LinearVesting
    LinearVesting.Fixture
    TwoPartyEscrow
    TwoPartyEscrow.Fixture

  build-depends:
    , aeson
    , aeson-pretty
    , base16-bytestring
    , bytestring
    , containers
    , directory
    , filepath
    , flat
    , megaparsec
    , mtl
    , plutus-core
    , plutus-ledger-api
    , plutus-tx
    , plutus-tx-plugin
    , process
    , relude
    , serialise
    , some
    , text
    , time

  hs-source-dirs:  lib

-- UPLC measurement tool
executable measure
  import:         common-language
  main-is:        Main.hs
  other-modules:  Cape.Cli
  build-depends:
    , ansi-terminal
    , cape
    , optparse-applicative

  hs-source-dirs: measure-app

-- Preview measurement tool (built against newer plutus-core)
-- Build with: cabal --project-file=cabal.project.preview build measure-preview
executable measure-preview
  import:         common-language
  main-is:        Main.hs
  other-modules:  Cape.Cli

  if !flag(preview)
    buildable: False

  build-depends:
    , ansi-terminal
    , cape
    , optparse-applicative

  hs-source-dirs: measure-app

-- Preview modules: re-compiled with BuiltinCasing (requires plutus-tx-plugin >= 1.46)
-- Build with: cabal --project-file=cabal.project.preview -f preview build plinth-submissions
library cape-preview
  import:          common-language
  visibility:      private

  if !flag(preview)
    buildable: False

  exposed-modules:
    Preview.Ecd
    Preview.Factorial
    Preview.Fibonacci
    Preview.FibonacciIterative
    Preview.HTLC
    Preview.LinearVesting
    Preview.TwoPartyEscrow

  other-modules:
    Ecd
    Factorial
    Fibonacci
    FibonacciIterative
    HTLC
    LinearVesting
    TwoPartyEscrow
    TwoPartyEscrow.Fixture

  build-depends:
    , cape
    , plutus-core
    , plutus-tx
    , plutus-tx-plugin

  hs-source-dirs:  lib

-- UPLC-CAPE Plinth submissions generator (production, Plinth 1.45).
-- Writes only 1.45 submission paths. Run with the default cabal project:
--   cabal run plinth-submissions
executable plinth-submissions
  import:         common-language
  main-is:        Main.hs
  build-depends:
    , base
    , cape
    , mtl
    , plutus-core
    , plutus-tx
    , plutus-tx-plugin

  hs-source-dirs: plinth-submissions-app

-- UPLC-CAPE Plinth submissions generator (preview, Plinth 1.61 + BuiltinCasing).
-- Writes only 1.61 submission paths. Run with:
--   cabal run --project-file=cabal.project.preview -f preview plinth-submissions-preview
executable plinth-submissions-preview
  import:         common-language
  main-is:        Main.hs

  if !flag(preview)
    buildable: False

  build-depends:
    , base
    , cape
    , cape:cape-preview
    , mtl
    , plutus-core
    , plutus-tx
    , plutus-tx-plugin

  hs-source-dirs: plinth-submissions-preview-app

-- UPLC textual pretty-printer used by treefmt as the *.uplc formatter.
-- Imports common-language-base (warnings, mixins, extensions) but not
-- common-deps, so the build path stays free of plutus-tx-plugin / Plinth
-- and the dev shell can ship the binary cheaply.
executable pretty-uplc
  import:         common-language-base
  main-is:        Main.hs
  hs-source-dirs: pretty-uplc-app
  build-depends:
    , base                  >=4.16
    , mtl
    , optparse-applicative
    , plutus-core           ^>=1.45
    , relude                ^>=1.2.2
    , text

-- Test suite
test-suite cape-tests
  import:             common-language
  type:               exitcode-stdio-1.0
  main-is:            Spec.hs
  other-modules:
    Cape.Data.PlutusJsonSpec
    Cape.Data.UplcTextSpec
    Cape.Protocol.ParametersSpec
    Cape.ScriptContextBuilderSpec
    Cape.TestsSpec
    EcdSpec
    FactorialSpec
    FibonacciSpec
    HTLCSpec
    HTLCSpec.Fixture
    LinearVestingSpec
    LinearVestingSpec.Fixture
    TwoPartyEscrowSpec
    TwoPartyEscrowSpec.Fixture
    ValidatorHelpers

  build-depends:
    , aeson
    , bytestring
    , cape
    , containers
    , hspec
    , megaparsec
    , mtl
    , plutus-ledger-api
    , plutus-tx
    , plutus-tx:plutus-tx-testlib
    , string-interpolate
    , vector

  hs-source-dirs:     test
  ghc-options:        -threaded -rtsopts -with-rtsopts=-N
  build-tool-depends: hspec-discover:hspec-discover