通信服務提供接口是web3如何與區(qū)塊鏈交互的關鍵。接口接受JSON-RPC請求并返回響應。這通常通過將請求提交給基于HTTP或IPC套接字的服務器來完成咒锻。
如果你已經(jīng)愉快地連接到你的以太坊節(jié)點,那么你可以跳過這部分內(nèi)容角骤。
選擇如何連接到你的節(jié)點
大多數(shù)節(jié)點都有多種連接方式投蝉。如果你尚未確定要使用哪種節(jié)點养葵,請轉到如何選擇要使用的節(jié)點?
連接節(jié)點的最常用方法是:
- 1.IPC(使用本地文件系統(tǒng):最快瘩缆,最安全)
- 2.Websockets(遠程工作关拒,比HTTP更快)
- 3.HTTP(更多節(jié)點支持它)
如果你不確定如何決定,請選擇以下方式:
- 如果你可以選擇在與節(jié)點相同的計算機上運行Web3.py庸娱,請選擇IPC着绊。
- 如果必須連接到其他計算機上的節(jié)點,請使用Websockets熟尉。
- 如果你的節(jié)點不支持Websockets归露,請使用HTTP。
大多數(shù)節(jié)點都有“關閉”連接選項的方法斤儿。我們建議你關閉所有未使用的連接選項剧包。這提供了更安全的設置:它減少了惡意黑客可以試圖竊取你的以太幣的方式。
確定連接后往果,可以使用通信服務提供接口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對象將在幾個標準位置查找以太坊節(jié)點掉缺。初始化時會發(fā)生自動檢測:
from web3.auto import w3
# which is equivalent to:
from web3 import Web3
w3 = Web3()
有時,web3無法自動檢測節(jié)點的位置戈擒。
- 如果你不確定使用哪種連接方法眶明,請看上文。
- 如果你知道連接方法峦甩,但不知道連接所需的其他信息(如IPC文件的路徑),則需要在節(jié)點的配置中查找該信息。
- 如果你不確定使用的是哪個節(jié)點凯傲,請參閱如何選擇要使用的節(jié)點犬辰?。
要深入了解自動檢測的工作原理冰单,請接著看:
自動檢測如何工作
Web3嘗試按以下順序連接到節(jié)點幌缝,使用它可以進行的第一個成功連接:
- 由環(huán)境變量指定的連接。
-
IPCProvider
诫欠,它查找?guī)讉€IPC文件位置涵卵。 -
HTTPProvider
,嘗試連接到http://localhost:8545
荒叼。 - 如果沒有提供者成功轿偎,你仍然可以使用不需要連接的Web3 API,例如:
- 類型轉化(Type Conversions)被廓。
- 貨幣單位轉換(Currency Conversions)坏晦。
- 地址相關(Addresses)。
- 使用本地私鑰(Local Private Keys)嫁乘。
- 等等昆婿。
使用自動檢測的示例
一些節(jié)點提供超出標準的API。有時蜓斧,跨節(jié)點以不同方式提供相同的信息仓蛆。如果要編寫跨多個節(jié)點工作的代碼,可能需要查找連接到的節(jié)點類型挎春。
例如看疙,以下內(nèi)容檢索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
通過環(huán)境變量
或者,你可以在啟動腳本之前設置環(huán)境變量WEB3_PROVIDER_URI
搂蜓,web3將首先查找這種方式狼荞。
此環(huán)境變量的有效格式為:
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遠程節(jié)點帮碰,如果你沒有https://infura.io/signup相味,請先注冊免費的API密鑰。
然后使用你的API密鑰設置環(huán)境變量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
內(nèi)置通信服務提供接口
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
這應該是關鍵字參數(shù)的字典投慈,它將被傳遞到http/https請求承耿。
>>> from web3 import Web3
>>> web3 = Web3(Web3.HTTPProvider("http://127.0.0.1:8545"))
請注意,每個python進程只應創(chuàng)建一個HTTPProvider
伪煤,因為HTTPProvider會回收底層TCP/IP網(wǎng)絡連接加袋,以獲得更好的性能。
HTTPProvider使用python請求庫來發(fā)出請求抱既。如果你想修改請求的方式职烧,可以使用request_kwargs
來執(zhí)行此操作。一個常見的用例是增加每個請求的超時防泵。
>>> 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套接字的文件系統(tǒng)路徑。: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
應該是關鍵字參數(shù)的字典,它將被傳遞到ws/wss websocket
連接贱纠。
>>> from web3 import Web3
>>> web3 = Web3(Web3.WebsocketProvider("ws://127.0.0.1:8546"))
WebsocketProvider
使用python websockets庫來發(fā)出請求响蕴。如果你想修改請求的方式谆焊,可以使用websocket_kwargs
來執(zhí)行此操作。一個常見的用例是增加每個請求的超時浦夷。
>>> from web3 import Web3
>>> web3 = Web3(Web3.WebsocketProvider("http://127.0.0.1:8546", websocket_kwargs={'timeout': 60}))
======================================================================
分享一些以太坊、EOS劈狐、比特幣等區(qū)塊鏈相關的交互式在線編程實戰(zhàn)教程:
python以太坊,主要是針對python工程師使用web3.py進行區(qū)塊鏈以太坊開發(fā)的詳解肥缔。
- java以太坊開發(fā)教程莲兢,主要是針對java和android程序員進行區(qū)塊鏈以太坊開發(fā)的web3j詳解。
- php以太坊续膳,主要是介紹使用php進行智能合約開發(fā)交互,進行賬號創(chuàng)建坟岔、交易、轉賬承疲、代幣開發(fā)以及過濾器和交易等內(nèi)容。
- 以太坊入門教程燕鸽,主要介紹智能合約與dapp應用開發(fā),適合入門绵咱。
- 以太坊開發(fā)進階教程熙兔,主要是介紹使用node.js、mongodb麸锉、區(qū)塊鏈舆声、ipfs實現(xiàn)去中心化電商DApp實戰(zhàn),適合進階媳握。
- C#以太坊,主要講解如何使用C#開發(fā)基于.Net的以太坊應用娩脾,包括賬戶管理打毛、狀態(tài)與交易、智能合約開發(fā)與交互碰声、過濾器和交易等熬甫。
- EOS教程,本課程幫助你快速入門EOS區(qū)塊鏈去中心化應用的開發(fā)罗珍,內(nèi)容涵蓋EOS工具鏈、賬戶與錢包蘸朋、發(fā)行代幣扣唱、智能合約開發(fā)與部署藕坯、使用代碼與智能合約交互等核心知識點,最后綜合運用各知識點完成一個便簽DApp的開發(fā)吐根。
- java比特幣開發(fā)教程辐马,本課程面向初學者,內(nèi)容即涵蓋比特幣的核心概念冗疮,例如區(qū)塊鏈存儲檩帐、去中心化共識機制、密鑰與腳本湃密、交易與UTXO等,同時也詳細講解如何在Java代碼中集成比特幣支持功能拔妥,例如創(chuàng)建地址达箍、管理錢包、構造裸交易等兜畸,是Java工程師不可多得的比特幣開發(fā)學習課程碘梢。
- php比特幣開發(fā)教程,本課程面向初學者煞躬,內(nèi)容即涵蓋比特幣的核心概念,例如區(qū)塊鏈存儲在扰、去中心化共識機制雷客、密鑰與腳本、交易與UTXO等皱卓,同時也詳細講解如何在Php代碼中集成比特幣支持功能,例如創(chuàng)建地址娜汁、管理錢包、構造裸交易等怜械,是Php工程師不可多得的比特幣開發(fā)學習課程傅事。
匯智網(wǎng)原創(chuàng)翻譯,轉載請標明出處。這里是原文