cardanopythonlib

Cardano Python lib to interact with the blockchain


Keywords
cardano, blockchain, python, backend
License
Apache-2.0
Install
pip install cardanopythonlib==1.2

Documentation

CardanoPythonLib

Cardano Python Library

This is a Python library to interact with Cardano Blockchain.


  • Prerequesites

    Minimum: Cardano-cli. You will be able to run offchain code, generate keys, create and sign transactions.

    Desired: Cardano-node running. You will be able to submit onchain and get confirmations from the blockchain.

Install poetry

curl -sSL https://install.python-poetry.org | python3 -

poetry new <project_name>

Add dependencies

poetry add cardanopythonlib

The library relies on a cardano_config.ini file which connects to Cardano testnet by default. If you want to overwrite some of the parameters, please create a new ini file in your folder:

[node]
KEYS_FILE_PATH = ./.priv/wallets
SCRIPTS_FILE_PATH = ./.priv/scripts
TRANSACTION_PATH_FILE = ./.priv/transactions
CARDANO_NETWORK = testnet
CARDANO_ERA = babbage-era
CARDANO_NETWORK_MAGIC = 2
CARDANO_CLI_PATH = cardano-cli
URL = http://localhost:8090/v2/wallets/
[logger]
LEVEL=INFO

When using CARDANO_NETOWRK = mainnet the CARDANO_NETWORK_MAGIC is ignored.

Instantiate the class as follows:

from cardanopythonlib import base

config_path = './cardano_config.ini' # Optional argument
node = base.Node(config_path) # Or with the default ini: node = base.Node()
node.query_tip_exec()

Working with the library

cardanopythonlib folder is the package that contains the main functionalities.

base.py file contains 3 classes.

  • Starter
  • Node
  • Keys

For usage please go to docs folder.

Credits:

Latest implementations related to Plutus are based on the following repo:

pycardano