Skip to main content

Python module for handling Cardano cryptocurrency

Project description

This software is in early development phase. Please consider it experimental and don’t rely on any API to be stable in the future.

There’s release 0.4.2 available for those brave enough to try it.

This module is the implementation of the idea submitted to Catalyst Project.

Prerequisites

  1. You need to have a cardano-node running.

  2. You need to have a cardano-wallet running and connected to the node.

  3. The rest you find in the documentation.

Please note it is most safe to run both node and wallet software on your local machine. The network security is well beyond the scope of this documentation, though. Also, I strongly recommend using the Cardano testnet for any software development and testing.

Roadmap

The roadmap is delayed from what I posted originally in the proposal. This is because I’ve mistaken the voting dates and during the work I also learned that some of the ideas aren’t as easy as I thought them to be (surprise ;)

I started the work even though the vote was still underway. As for today, it is confirmed the project would receive funding.

The following timeline is still subject to reassessment, hopefully minimal.

date

version

features

2021-03-16

0.1

  • classes for Wallet, Address and Transaction

  • create wallet from seed

  • retrieve wallet

  • check balance

  • list historical transactions

  • send transfer

2021-03-28

0.2

  • fixed transaction API

  • listing native assets (other than ADA)

  • docs for 0.1 features

2021-04-11

0.3

  • add metadata to transactions

  • docs for 0.2 features

2021-04-18

0.4

  • fee estimation

2021-04-25

0.5

  • stake

  • unstake

  • docs for 0.4 features

2021-05-04

0.6

  • UTXO stats

  • coin selection

  • address validation

  • docs for 0.5 + 0.6 features

Also, there are optional features that aren’t included in the Catalyst proposal. I’ll try to implement them if time permits, otherwise the list below will become a TODO once the Catalyst-funded phase concludes.

  • key operations (HD wallet key generation)

  • seed to key and vice versa conversion

  • advanced filtering of incoming and outgoing transfers

  • transaction forgetting

  • handling of Byron wallets

  • Goguen features (smart contracts?)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cardano-0.4.2.tar.gz (13.8 kB view hashes)

Uploaded Source

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