Python 的 Geth 封装库 PyGeth

PyGeth 是一个 Python 封装库，用来作为子进程运行 geth。

系统依赖

该库需要 geth 可执行文件。

安装

pip install py-geth

快速启动

运行连接到 mainnet 的 geth

>>> from geth import LiveGethProcess
>>> geth = LiveGethProcess()
>>> geth.start()

或者是用于测试的私人本地区块链。这就要求你给他们一个名字。

>>> from geth import DevGethProcess
>>> geth = DevGethProcess('testing')
>>> geth.start()

默认情况下，DevGethProcess 在 geth 使用的默认 datadir 设置测试链。如果要更改这些测试链的位置，可以指定替代 base_dir。

>>> geth = DevGethProcess('testing', '/tmp/some-other-base-dir/')
>>> geth.start()

每个实例都有一些方便的属性。

>>> geth.data_dir
"~/.ethereum"
>>> geth.rpc_port
8545
>>> geth.ipc_path
"~/.ethereum/geth.ipc"
>>> geth.accounts
['0xd3cda913deb6f67967b99d67acdfa1712c293601']
>>> geth.is_alive
False
>>> geth.is_running
False
>>> geth.is_stopped
False
>>> geth.start()
>>> geth.is_alive
True  # 表示子进程尚未退出
>>> geth.is_running
True  # 表示调用了start(),但是没有stop()
>>> geth.is_stopped
False
>>> geth.stop()
>>> geth.is_alive
False
>>> geth.is_running
False
>>> geth.is_stopped
True

在测试时，可以很好地查看 geth 进程生成的日志记录输出。py-geth 提供了一个 mixin 类，可用于将 stdout 和 stderr 输出记录到日志文件中。

>>> from geth import LoggingMixin, DevGethProcess
>>> class MyGeth(LoggingMixin, DevGethProcess):
...     pass
>>> geth = MyGeth()
>>> geth.start()

所有日志都将写入当前目录./logs/ 中的日志文件。

底层 geth 进程可能需要额外的时间来打开 RPC 或 IPC 连接，以及在需要生成 DAG 时开始挖掘。你可以使用以下接口来查询这些接口是否已准备就绪。

>>> geth.is_rpc_ready
True
>>> geth.wait_for_rpc(timeout=30)  # 等待最多30秒，以便打开RPC连接。
>>> geth.is_ipc_ready
True
>>> geth.wait_for_ipc(timeout=30)  # 等待最多30秒，以便IPC套接字打开。
>>> geth.is_dag_generated
True
>>> geth.is_mining
True
>>> geth.wait_for_dag(timeout=600)  # 等待最多10分钟，以便生成DAG。

DAG 功能目前仅适用于 epoch 0。

安装特定版本的 geth

此功能是实验性的，可能会发生重大变化。

可以使用 py-geth 在列出的平台上安装以下任何版本的 geth 。

v1.5.6 (linux/osx)
v1.5.7 (linux/osx)
v1.5.8 (linux/osx)
v1.5.9 (linux/osx)
v1.6.0 (linux/osx)
v1.6.1 (linux/osx)
v1.6.2 (linux/osx)
v1.6.3 (linux/osx)
v1.6.4 (linux/osx)
v1.6.5 (linux/osx)
v1.6.6 (linux/osx)
v1.6.7 (linux/osx)
v1.7.0 (linux/osx)
v1.7.2 (linux/osx)
v1.8.1 (linux/osx)

可以通过命令行完成安装：

$ python -m geth.install v0.4.12

或者使用 install_geth 函数从 python 安装。

>>> from geth import install_geth
>>> install_geth('v1.7.0')

已安装的二进制文件可以在 $HOME/.py-geth 目录下找到。v1.7.0 二进制文件位于 $HOME/.py-geth/geth-v1.7.0/bin/geth。

关于 DevGethProcess

DevGethProcess 旨在促进测试。在这方面，它预先配置如下。

创建一个帐户并分配 10 亿以太。
在 rpc 和 ipc 接口上都启用了所有 API。
帐户 0 已解锁。
网络配置为不查找或连接到任何对等方。
使用 1234 的 networkid。
测试程度设为 5（DEBUG）
使用单个线程启用挖掘。
RPC 接口尝试绑定到 8545，但如果此端口不可用，则会找到一个开放端口。
DevP2P 接口尝试绑定到 30303，但如果此端口不可用，将找到一个开放端口。

Gotchas

如果你在启用 mining 情况下运行（这是 DevGethProcess 默认设置，那么你可能需要手动生成 DAG。如果不这样做，那么它将在你第一次运行该过程时自动生成，这需要一段时间。

要手动生成它：

$ geth makedag 0 ~/.ethash

这在像 Travis-CI 这样的 CI 环境中尤其重要，在这种情况下，你的流程可能会在生成期间超时。

开发

克隆存储库然后运行：

pip install -e . -r requirements-dev.txt

运行测试

可以使用以下命令运行测试：

py.test tests

或者你可以安装 tox 来运行完整的测试套件。

发布

需要 Pandoc 才能将 markdown README 转换为正确的格式，以便在 pypi 上正确呈现。

对于类似 Debian 的系统：

apt install pandoc

或者在 OSX 上：

brew install pandoc

要发布新版本：

make release bump=$$VERSION_PART_TO_BUMP$$

如何 bump 版本

此 repo 的版本格式为 {major}.{minor}.{patch} 表示 stable，{major}.{minor}.{patch} {major}.{minor}.{patch}-{stage}.{devnum} 表示 unstable（stage 可以是 alpha 或 beta）。

要在行中发布下一个版本，请指定要 bump 的部分，例如 make release bump=minor 或 make release bump=devnum。

如果你处于测试版，则 make release bump=stage 将切换为稳定版。

要在当前版本稳定时发出不稳定版本，请明确指定新版本，例如 make release bump="--new-version 4.0.0-alpha.1 devnum"