Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emesik/cardano-python
Python module for handling Cardano cryptocurrency
https://github.com/emesik/cardano-python
blockchain cardano cryptocurrency payment wallet
Last synced: 13 days ago
JSON representation
Python module for handling Cardano cryptocurrency
- Host: GitHub
- URL: https://github.com/emesik/cardano-python
- Owner: emesik
- License: bsd-3-clause
- Created: 2021-03-01T11:03:56.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-04-27T11:25:16.000Z (over 2 years ago)
- Last Synced: 2024-10-23T07:52:11.281Z (21 days ago)
- Topics: blockchain, cardano, cryptocurrency, payment, wallet
- Language: Python
- Homepage:
- Size: 184 KB
- Stars: 114
- Watchers: 12
- Forks: 17
- Open Issues: 7
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.txt
Awesome Lists containing this project
README
Python Cardano module
=====================
**This software is in development phase. Please consider it experimental and don't rely on any
API to be stable before version 1.0 comes.**
There's release 0.8.2 available. It is usable for basic payment acceptance and spending but more
advanced features haven't been well tested yet.
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.
.. _`documentation`: http://cardano-python.readthedocs.io/en/latest/
Roadmap
-------
This module has been started as `an idea`_ submitted to the Catalyst Project. The funded part
concluded with version 0.7.
.. _`an idea`: https://cardano.ideascale.com/a/dtd/Python-module/333770-48088
+------------+---------+--------------------------------------------------------------------------+
| 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-17 | 0.6 | - UTXO stats |
| | | - docs for 0.5 + 0.6 features |
+------------+---------+--------------------------------------------------------------------------+
| 2021-08-08 | 0.7 | - advanced filtering of incoming and outgoing transfers |
| | | - native assets transfer |
+------------+---------+--------------------------------------------------------------------------+
| | | **End of the Catalyst-funded phase** |
+------------+---------+--------------------------------------------------------------------------+
| 2021-11-11 | 0.8 | - address validation |
+------------+---------+--------------------------------------------------------------------------+
| future | | - key operations (HD wallet key generation) |
| | | - seed to key and vice versa conversion |
| | | - offline address generation (#8) |
| | | - native assets minting and burning (#13) |
| | | - binary transaction backend (#10) |
| | | - coin selection |
| | | - transaction forgetting |
| | | - handling of Byron wallets |
| | | - Goguen features (smart contracts? #15) |
+------------+---------+--------------------------------------------------------------------------+
**Q:** Why the roadmap above differs so much from the plan presented in Catalyst proposal?
**A:** While developing the module I discovered that some of the features I had originally declared
were impossible to implement given the available tools. Also, the proposal lacked some features
that are important but somehow I missed them when proposing. The roadmap consists of items I found
both important and doable.
Donate
------
If you like to support the idea with a donation, the address is::
addr1qyjfql20ca09dnxrl3zdek40u24ylk6uqw3rf7p42p55xk8r26ptv047efk8fwmydynvawp4af7fr0xgjxqm7x9v32eq27496t
.. image:: donate.qr.png
Thank you.