Antaeus

Antaeus is a framework for end-to-end testing Cardano Haskell APIs. It leverages cardano-testnet to configure and launch a local Cardano testnet, and cardano-api to build transactions and query the ledger state. The primary focus of these tests is on functionality involving Plutus scripts.

Tests can be executed on either a local private testnet or any public network. They are grouped by target protocol version (e.g. Babbage PV8) and share an instance of private testnet for faster execution.

How to run on private testnet

By default, tests are configured to run on local private testnet environments with their supported protocol version.

1. Optionally, enter nix develop shell for dependencies.
2. Run cabal build all
3. Run cabal test e2e-tests

How to run on public testnet

Check these preconditions before following the private testnet steps above.

1. Create a directory containing at least the following two subdirectories:
   • utxo-keys, which includes two files: "test.skey" and "test.vkey" in text envelope PaymentKey format (no support for PaymentExtendedKey at the moment).
   • ipc, which contains the active node socket "node.socket"
2. Ensure your Cardano node is fully synced on a public network (e.g. preview testnet).
3. Have at least one ADA-only UTxO in the test account. Each test will spend a few ADA, so ensure sufficient funds are available.
4. Edit Testnet.hs so that LocalNodeOption's localEnvDir points to the directory containing your keys ("utxo-keys") and node socket ("ipc").
5. Edit Spec.hs to include localNodeTests in the TestTree. You can configure to run with or without the existing private testnet tests (e.g. pv8Tests).

How to run on cardano-node-emulator

Currently, the emulator is not implemented inline with the latest ledger. As a result, it is integrated and configured to run as part of the test suite on branch emulator. No additional configuration is required.

---

Status

Antaeus has a growing suite of tests covering:

• Plutus built-in functions:
  • verifySchnorrSecp256k1Signature and verifyEcdsaSecp256k1Signature across different protocol versions and expected outcomes (success or specific errors).
  • All 17 BLS builtin functions (e.g. bls12_381_finalVerify)
  • All builtin hashing functions (e.g. sha2_256)
• Spending locked funds using reference scripts, reference inputs, and providing datum as witness in the transaction body.
• Minting tokens using reference scripts and providing script witness in the transaction body.
• Examining fields in Plutus V1, V2 and V3 TxInfo.
• Governance functionality.

---

Test Report

After every test run a JUnit XML report is produced in e2e-tests/test-report-xml/test-results.xml. An existing report will be overwritten. Reports for each major cardano-node tag are stored. E.g e2e-tests/test-report-xml_8-7-2. Run allure serve <test-report-xml> to generate and host the Allure report.

Reports for each cardano-node tag are hosted alongside other end-to-end tests, for example here: https://tests.cardano.intersectmbo.org/test_results/node/tag_8_8_0.html

Planned Features

We're working on adding the following features to Antaeus:

• More Voltaire governance actions (coming in Conway era using PlutusV3 language version).
• CI execution with private testnet on commit (nix configuration coming soon).
• Nightly CI test execution would be useful in public environments.

---

Licensing

You are free to copy, modify, and distribute Antaeus under the terms of the Apache 2.0 license. See the LICENSE and NOTICE files for details.