Cardonnay
Cardonnay is a command-line tool for setting up and managing local Cardano testnets.
It supports multiple preconfigured testnet types and makes it easy to inspect and control their lifecycle.
🚀 Getting Started
1. Create a local_fast testnet
$ cardonnay create -t local_fast
Starting the testnet cluster with `/var/tmp/cardonnay-of-user/cluster0_local_fast/start-cluster`:
[...]
Cluster started 🚀
ℹ️ Pro Tip: Add
-bto create the testnet in the background, or-c "comment"to add a comment.
2. List running testnet instances
$ cardonnay control ls
[
{
"instance": 0,
"type": "local_fast",
"state": "started",
"comment": null
}
]
3. Inspect the testnet faucet
$ cardonnay inspect faucet -i 0
{
"address": "addr_test1vpgm9cj9u3k63642vju9jqgeqy393upttt0qtwptlesy08gx620qd",
"vkey_file": "/var/tmp/cardonnay-of-user/state-cluster0/shelley/genesis-utxo.vkey",
"skey_file": "/var/tmp/cardonnay-of-user/state-cluster0/shelley/genesis-utxo.skey"
}
4. Work with the testnet
source <(cardonnay control print-env -i 0)
cardano-cli query tip --testnet-magic 42
5. Stop all running testnet instances
$ cardonnay control stop-all
Stopping the testnet cluster with `/var/tmp/cardonnay-of-user/state-cluster0/stop-cluster`:
[...]
Cluster terminated!
🛠️ Installation
Option 1: Using Nix
If you use Nix, you can spin up a development shell with all dependencies:
nix develop
This will provide a fully set-up environment, including Python, Cardano binaries, and jq.
ℹ️ NOTE: To use the latest
masterbranch ofcardano-node, run
nix flake update --accept-flake-config --override-input cardano-node github:IntersectMBO/cardano-node/master
nix develop --accept-flake-config
Option 2: Using pip
Ensure the following dependencies are installed and available in your PATH:
python3jqcardano-nodecardano-cli- optional:
cardano-submit-api
Then install Cardonnay in a virtual environment:
# Create and activate a virtual environment
python3 -m venv .venv
source .venv/bin/activate
# Install Cardonnay
pip install -U --require-virtualenv cardonnay
# (Optional) Enable shell completions for Bash
source completions/cardonnay.bash-completion
⚙️ db-sync (optional)
db-sync is started automatically when DBSYNC_SCHEMA_DIR points to the
cardano-db-sync schema directory
(cardano-db-sync must be on your PATH). It stays off otherwise.
Set these env vars before cardonnay create:
| Env var | Effect |
|---|---|
DBSYNC_SCHEMA_DIR |
Path to the db-sync schema dir; enables db-sync. |
SMASH |
Truthy (1/true/yes/on) also starts a SMASH server. |
DBSYNC_ALLOW_PRIVATE_OFFCHAIN_URLS |
Truthy lets db-sync fetch off-chain anchor data (pool/governance metadata) served from localhost. Needed on a local testnet; off by default. |
export DBSYNC_SCHEMA_DIR=/path/to/cardano-db-sync/schema
export DBSYNC_ALLOW_PRIVATE_OFFCHAIN_URLS=true
cardonnay create -t local_fast
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cardonnay-0.4.3.tar.gz.
File metadata
- Download URL: cardonnay-0.4.3.tar.gz
- Upload date:
- Size: 101.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
13c5cf797f933c76dca765b4ecf0d4f83934493e52899e8ca7957cccf654466b
|
|
| MD5 |
5401bfed0df9e16d3a919e34ff12906f
|
|
| BLAKE2b-256 |
80369efccb9119a1b30790eb9c01ffdb357d8be385684d2895c5f8d4cdb8545f
|
File details
Details for the file cardonnay-0.4.3-py3-none-any.whl.
File metadata
- Download URL: cardonnay-0.4.3-py3-none-any.whl
- Upload date:
- Size: 105.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
84d37f92ae2bff4e633957def4bd9999fc81d3715ed06e38f28872f9b84a9c2a
|
|
| MD5 |
1818649c56575f45ba64497a9811a6bf
|
|
| BLAKE2b-256 |
4475682c9713ba21d4ef8bee590bc4a999475b8a98587a69e3edbef502b63181
|
