README for cardano-clusterlib¶
Python wrapper for cardano-cli for working with cardano cluster.
# 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
cardano-cli (the command is available on
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)
Install this package and its dependencies as described above.
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.