python藉助web3py與以太坊區塊鏈節點互動的幾種方式

malakashi發表於2018-10-11
PythonWeb區塊鏈

通訊服務提供介面是web3如何與區塊鏈互動的關鍵。介面接受JSON-RPC請求並返回響應。這通常通過將請求提交給基於HTTP或IPC套接字的伺服器來完成。

如果你已經愉快地連線到你的以太坊節點，那麼你可以跳過這部分內容。

選擇如何連線到你的節點

大多數節點都有多種連線方式。如果你尚未確定要使用哪種節點，請轉到如何選擇要使用的節點？

連線節點的最常用方法是：

  • 1.IPC（使用本地檔案系統：最快，最安全）
  • 2.Websockets（遠端工作，比HTTP更快）
  • 3.HTTP（更多節點支援它）

如果你不確定如何決定，請選擇以下方式：

  • 如果你可以選擇在與節點相同的計算機上執行Web3.py，請選擇IPC。
  • 如果必須連線到其他計算機上的節點，請使用Websockets。
  • 如果你的節點不支援Websockets，請使用HTTP。

大多數節點都有“關閉”連線選項的方法。我們建議你關閉所有未使用的連線選項。這提供了更安全的設定：它減少了惡意黑客可以試圖竊取你的以太幣的方式。

確定連線後，可以使用通訊服務提供介面Provider指定詳細資訊。通訊服務提供介面Provider程式是為所需型別的連線配置的Web3.py類。

看這幾個：

  • IPCProvider
  • WebsocketProvider
  • HTTPProvider

配置通訊服務提供介面程式後，如：

from web3 import Web3
my_provider = Web3.IPCProvider(`/my/node/ipc/path`)

然後你就可以初始化Web3例項了，如下所示：

w3 = Web3(my_provider)

這樣，你就已準備好開始使用Web3.py.

自動與手動通訊服務提供介面

如果未指定通訊服務提供介面程式，Web3物件將在幾個標準位置查詢以太坊節點。初始化時會發生自動檢測：

from web3.auto import w3

# which is equivalent to:

from web3 import Web3
w3 = Web3()

有時，web3無法自動檢測節點的位置。

  • 如果你不確定使用哪種連線方法，請看上文。
  • 如果你知道連線方法，但不知道連線所需的其他資訊（如IPC檔案的路徑），則需要在節點的配置中查詢該資訊。
  • 如果你不確定使用的是哪個節點，請參閱如何選擇要使用的節點？。

要深入瞭解自動檢測的工作原理，請接著看：

自動檢測如何工作

Web3嘗試按以下順序連線到節點，使用它可以進行的第一個成功連線：

  • 由環境變數指定的連線。
  • IPCProvider，它查詢幾個IPC檔案位置。
  • HTTPProvider，嘗試連線到http://localhost:8545。

  • 如果沒有提供者成功，你仍然可以使用不需要連線的Web3 API，例如：

    • 型別轉化(Type Conversions)。
    • 貨幣單位轉換(Currency Conversions)。
    • 地址相關(Addresses)。
    • 使用本地私鑰(Local Private Keys)。
    • 等等。

使用自動檢測的示例

一些節點提供超出標準的API。有時，跨節點以不同方式提供相同的資訊。如果要編寫跨多個節點工作的程式碼，可能需要查詢連線到的節點型別。

例如，以下內容檢索geth和parity的客戶端enode端點：

from web3.auto import w3

connected = w3.isConnected()

if connected and w3.version.node.startswith(`Parity`):
    enode = w3.parity.enode

elif connected and w3.version.node.startswith(`Geth`):
    enode = w3.admin.nodeInfo[`enode`]

else:
    enode = None

通過環境變數

或者，你可以在啟動指令碼之前設定環境變數WEB3_PROVIDER_URI，web3將首先查詢這種方式。

此環境變數的有效格式為：

  • file:///path/to/node/rpc-json/file.ipc
  • http://192.168.1.2:8545
  • https://node.ontheweb.com
  • ws://127.0.0.1:8546

自動初始化的快捷方式

常見方法中有幾個自動初始化的快捷方式。

Infura Mainnet

要輕鬆連線到Infura Mainnet遠端節點，如果你沒有https://infura.io/signup，請先註冊免費的API金鑰。

然後使用你的API金鑰設定環境變數INFURA_API_KEY：

$ export INFURA_API_KEY=YourApiKey
>>> from web3.auto.infura import w3

# confirm that the connection succeeded
>>> w3.isConnected()
True

Geth dev PoA

要使用預設值連線到geth –dev PoA(Proof-of-authority)例項：

>>> from web3.auto.gethdev import w3

# confirm that the connection succeeded
>>> w3.isConnected()
True

內建通訊服務提供介面

Web3附帶以下通訊服務提供介面程式，這些通訊服務提供介面程式適用於連線到本地和遠端JSON-RPC伺服器。

HTTPProvider

 class web3.providers.rpc.HTTPProvider(endpoint_uri[, request_kwargs])

此通訊服務提供介面程式處理與基於HTTP或HTTPS的JSON-RPC伺服器的互動。

  • endpoint_uri應該是RPC端點的完整URI，例如`https://localhost:8545`。對於在埠80上執行的HTTP連線後面的RPC伺服器和在埠443上執行的HTTPS連線，可以從URI中省略該埠。
  • request_kwargs這應該是關鍵字引數的字典，它將被傳遞到http/https請求。
>>> from web3 import Web3
>>> web3 = Web3(Web3.HTTPProvider("http://127.0.0.1:8545"))

請注意，每個python程式只應建立一個HTTPProvider，因為HTTPProvider會回收底層TCP/IP網路連線，以獲得更好的效能。

HTTPProvider使用python請求庫來發出請求。如果你想修改請求的方式，可以使用request_kwargs來執行此操作。一個常見的用例是增加每個請求的超時。

>>> from web3 import Web3
>>> web3 = Web3(Web3.HTTPProvider("http://127.0.0.1:8545", request_kwargs={`timeout`: 60}))

IPCProvider

web3.providers.ipc.IPCProvider(ipc_path=None, testnet=False, timeout=10)

此通訊服務提供介面程式處理與基於IPC Socket的JSON-RPC伺服器的互動。

  • ipc_path是IPC套接字的檔案系統路徑。:56
>>> from web3 import Web3
>>> web3 = Web3(Web3.IPCProvider("~/Library/Ethereum/geth.ipc"))

如果沒有指定ipc_path，它將使用它可以從下表中找到的第一個IPC檔案：

  • On Linux and FreeBSD:

    • ~/.ethereum/geth.ipc
    • ~/.local/share/io.parity.ethereum/jsonrpc.ipc

  • On Mac OS:

    • ~/Library/Ethereum/geth.ipc
    • ~/Library/Application Support/io.parity.ethereum/jsonrpc.ipc

  • On Windows:

    • .pipegeth.ipc
    • .pipejsonrpc.ipc

WebsocketProvider

 class web3.providers.websocket.WebsocketProvider(endpoint_uri[, websocket_kwargs])

此通訊服務提供介面程式處理與基於WS或WSS的JSON-RPC伺服器的互動。

  • endpoint_uri應該是RPC端點的完整URI，例如ws://localhost:8546。
  • websocket_kwargs應該是關鍵字引數的字典，它將被傳遞到ws/wss websocket連線。
>>> from web3 import Web3
>>> web3 = Web3(Web3.WebsocketProvider("ws://127.0.0.1:8546"))

WebsocketProvider使用python websockets庫來發出請求。如果你想修改請求的方式，可以使用websocket_kwargs來執行此操作。一個常見的用例是增加每個請求的超時。

>>> from web3 import Web3
>>> web3 = Web3(Web3.WebsocketProvider("http://127.0.0.1:8546", websocket_kwargs={`timeout`: 60}))

分享個的互動式線上程式設計實戰教程：

python以太坊，主要是針對python工程師使用web3.py進行區塊鏈以太坊開發的詳解。

這裡是原文

相關文章