python經過web3py連接以太坊區塊鏈節點的幾種方式

通訊服務提供接口是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:
• \.\pipe\geth.ipc
• \.\pipe\jsonrpc.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進行區塊鏈以太坊開發的詳解。

匯智網原創翻譯，轉載請標明出處。這裏是原文