Skip to main content

Python wrapper for cardano-cli for working with cardano cluster

Project description

Documentation Status PyPi Version Code style: black

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).

Project details


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

cardano-clusterlib-0.3.0rc9.tar.gz (39.6 kB view details)

Uploaded Source

Built Distribution

cardano_clusterlib-0.3.0rc9-py3-none-any.whl (34.9 kB view details)

Uploaded Python 3

File details

Details for the file cardano-clusterlib-0.3.0rc9.tar.gz.

File metadata

  • Download URL: cardano-clusterlib-0.3.0rc9.tar.gz
  • Upload date:
  • Size: 39.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for cardano-clusterlib-0.3.0rc9.tar.gz
Algorithm Hash digest
SHA256 0b805f54048e0d69070b21e29ac17128d52f376e04e3a6abac4e783a28601cbc
MD5 576c830e4228a82ee8bfc27a9f94d2be
BLAKE2b-256 8e087a428c2a3811907c6c5a58e2af5bbb18ee10e11cc0ecd0cbf3005e30262b

See more details on using hashes here.

File details

Details for the file cardano_clusterlib-0.3.0rc9-py3-none-any.whl.

File metadata

File hashes

Hashes for cardano_clusterlib-0.3.0rc9-py3-none-any.whl
Algorithm Hash digest
SHA256 5e56b318a3edb387ea19a0e4533f4f4a2c4f15401066c61c4f845513e4d73215
MD5 933d288b2efcc233675be7f90e3b1d44
BLAKE2b-256 c90fc55aeb943db7d4e0fa53d4d4200a1e37dfde4ed959ae605158959cd5c5dc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page