aleph-sdk-python

Python SDK for the Aleph.im network, next generation network of decentralized big data applications.

Development follows the Aleph Whitepaper.

Documentation

Documentation (albeit still vastly incomplete as it is a work in progress) can be found at http://aleph-sdk-python.readthedocs.io/ or built from this repo with:

$ python setup.py docs

Requirements

Linux

Some cryptographic functionalities use curve secp256k1 and require installing libsecp256k1.

$ apt-get install -y python3-pip libsecp256k1-dev

Using some chains may also require installing libgmp3-dev.

macOs

This project does not support Python 3.12 on macOS. Please use Python 3.11 instead.

$ brew tap cuber/homebrew-libsecp256k1
$ brew install libsecp256k1

Installation

Using pip and PyPI:

$ pip install aleph-sdk-python[ethereum,solana,tezos]

Installation for development

To install from source and still be able to modify the source code:

$ pip install -e .[testing]

or

$ python setup.py develop

Usage with LedgerHQ hardware

The SDK supports signatures using app-ethereum, the Ethereum app for the Ledger hardware wallets.

This has been tested successfully on Linux (amd64). Let us know if it works for you on other operating systems.

Using a Ledger device on Linux requires root access or the setup of udev rules.

Unlocking the device is required before using the relevant SDK functions.

Debian / Ubuntu

Install ledger-wallets-udev.

sudo apt-get install ledger-wallets-udev

On NixOS

Configure hardware.ledger.enable = true.

Other Linux systems

See https://github.com/LedgerHQ/udev-rules