Python wrapper for cardano-cli for working with cardano cluster
Project description
README for cardano-clusterlib
Python wrapper for cardano-cli for working with cardano cluster.
Installation
# create and activate virtual env
$ python3 -m venv .env
$ . .env/bin/activate
# install it from PyPI
$ pip install cardano-clusterlib
# - OR - install it in develop mode together with dev requirements
$ make install
Usage
Needs working cardano-cli (the command is available on PATH, cardano-node is running, CARDANO_NODE_SOCKET_PATH is set). In state_dir it expects "shelley/genesis.json".
from cardano_clusterlib import clusterlib
# instantiate `ClusterLib`
cluster = clusterlib.ClusterLib(state_dir="path/to/cluster/state_dir")
# specify where to send funds and amounts to send
destinations = [clusterlib.TxOut(address=dst_address, amount=amount_lovelace)]
# provide keys needed for signing the transaction
tx_files = clusterlib.TxFiles(signing_key_files=[src_skey_file])
# build, sign and submit the transaction
tx_raw_output = cluster.send_funds(
src_address=src_address,
destinations=destinations,
tx_name="send_funds",
tx_files=tx_files,
)
# wait for two new blocks to make sure the transaction is on the ledger
cluster.wait_for_new_block(new_blocks=2)
# check that the funds were received
cluster.get_utxo(dst_address)
See cardano-node-tests for more examples, e.g. minting new tokens.
Source Documentation
https://cardano-clusterlib-py.readthedocs.io/en/latest/cardano_clusterlib.html
Contributing
Install this package and its dependencies as described above.
Run pre-commit install to set up the git hook scripts that will check you changes before every commit. Alternatively run make lint manually before pushing your changes.
Follow the Google Python Style Guide, with the exception that formatting is handled automatically by Black (through pre-commit command).
Release history Release notifications | RSS feed
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
File details
Details for the file cardano-clusterlib-0.3.0rc2.tar.gz.
File metadata
- Download URL: cardano-clusterlib-0.3.0rc2.tar.gz
- Upload date:
- Size: 38.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | aee00dcb8dfab01c84f9deba2e35bcd4f315c0a6e63f01e06cba52f79f38800c |
|
| MD5 | 51873968503ead4b1549379d8faf08fc |
|
| BLAKE2b-256 | 68bc6e2024c084751372bf0ee9b3e23ba82d56eca734edff5d285477d90c5d04 |
File details
Details for the file cardano_clusterlib-0.3.0rc2-py3-none-any.whl.
File metadata
- Download URL: cardano_clusterlib-0.3.0rc2-py3-none-any.whl
- Upload date:
- Size: 33.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 19d40a3b280dff9267eef404d5144c7b16f675c44e10b3c763a7ff5b9bf93563 |
|
| MD5 | 1402616dd4fb13ae857a2e99555ee592 |
|
| BLAKE2b-256 | 891b2f911d4df0b343e01d2ede63896fc2410feb6ce2d39bbeb81c1c342795d8 |
