aleph-sdk-python

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

开发遵循Aleph白皮书.

文档

最新文档虽然不完整，但可在https://docs.aleph.im/libraries/python-sdk/找到。

对于完整文档，请参阅源代码中的docstrings。

需求

Linux

一些加密功能使用curve secp256k1曲线，需要安装libsecp256k1。

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

使用某些链可能还需要安装libgmp3-dev。

macOs

此项目不支持macOS上的Python 3.12。请使用Python 3.11代替。

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

安装

使用pip和PyPI

$ pip install aleph-sdk-python

其他依赖项

某些功能需要其他依赖项。它们可以像这样安装

$ pip install aleph-sdk-python[solana, dns]

以下额外的依赖项可用

• solana 用于Solana账户和签名
• cosmos 用于Substrate/Cosmos账户和签名
• nuls2 用于NULS2账户和签名
• polkadot 用于Polkadot账户和签名
• ledger 用于Ledger硬件钱包支持，请参阅使用LedgerHQ硬件
• mqtt 用于与MQTT相关的功能，请参阅examples/mqtt.py
• docs 用于构建文档，请参阅文档
• dns 用于与DNS相关的功能
• all 安装所有额外的依赖项

开发版安装

使用hatch设置虚拟环境

$ hatch shell

然后使用所有额外的依赖项从源代码安装SDK

$ pip install -e .[all]

运行测试和Hatch脚本

您可以使用hatch定义的测试环境来运行测试

$ hatch run testing:run

有关所有环境和它们的脚本的信息，请参阅hatch env show

生成文档 [已弃用]

文档使用Sphinx构建。

要构建文档，请使用包含docs额外依赖项的SDK安装

$ pip install -e .[docs]

然后构建文档

$ cd docs
$ make html

与LedgerHQ硬件一起使用

SDK支持使用app-ethereum进行签名，这是用于Ledger硬件钱包的以太坊应用。

这已在Linux (amd64)上成功测试。如果它在其他操作系统上工作，请告诉我们。

在Linux上使用Ledger设备需要root权限或设置udev规则。

在使用相关SDK函数之前需要解锁设备。

Debian / Ubuntu

安装ledger-wallets-udev。

sudo apt-get install ledger-wallets-udev

在NixOS上

配置hardware.ledger.enable = true。

其他Linux系统

请参阅https://github.com/LedgerHQ/udev-rules