Python 的 Geth 封裝庫 PyGeth

geeker發表於2019-01-07
Python封裝

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 協議》，轉載必須註明作者和本文連結

相關文章