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"

安利个以太坊区块链相关的交互式在线编程实战教程：
python以太坊，主要是针对python工程师使用web3.py进行区块链以太坊开发的详解。

汇智网原创翻译，转载请标明出处。这里是Python的Geth封装库PyGeth

本作品采用《CC 协议》，转载必须注明作者和本文链接