web3.py的几种连接以太坊节点的方法

通信服务提供接口是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

配置通信服务提供接口程序后,如:

1
2
from web3 import Web3
my_provider = Web3.IPCProvider('/my/node/ipc/path')

然后你就可以初始化Web3实例了,如下所示:

1
w3 = Web3(my_provider)

这样,你就已准备好开始使用Web3.py.

自动与手动通信服务提供接口

如果未指定通信服务提供接口程序,Web3对象将在几个标准位置查找以太坊节点。初始化时会发生自动检测:

1
2
3
4
5
6
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端点:

1
2
3
4
5
6
7
8
9
10
11
12
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

1
$ export INFURA_API_KEY=YourApiKey
1
2
3
4
5
>>> from web3.auto.infura import w3

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

Geth dev PoA

要使用默认值连接到geth –dev PoA(Proof-of-authority)实例:

1
2
3
4
5
>>> from web3.auto.gethdev import w3

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

内置通信服务提供接口

Web3附带以下通信服务提供接口程序,这些通信服务提供接口程序适用于连接到本地和远程JSON-RPC服务器。

HTTPProvider

1
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请求。
1
2
>>> from web3 import Web3
>>> web3 = Web3(Web3.HTTPProvider("http://127.0.0.1:8545"))

请注意,每个python进程只应创建一个HTTPProvider,因为HTTPProvider会回收底层TCP/IP网络连接,以获得更好的性能。

HTTPProvider使用python请求库来发出请求。如果你想修改请求的方式,可以使用request_kwargs来执行此操作。一个常见的用例是增加每个请求的超时。

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

IPCProvider

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

此通信服务提供接口程序处理与基于IPC Socket的JSON-RPC服务器的交互。

  • ipc_path是IPC套接字的文件系统路径。:56
1
2
>>> 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

1
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连接。
1
2
>>> from web3 import Web3
>>> web3 = Web3(Web3.WebsocketProvider("ws://127.0.0.1:8546"))

WebsocketProvider使用python websockets库来发出请求。如果你想修改请求的方式,可以使用websocket_kwargs来执行此操作。一个常见的用例是增加每个请求的超时。

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

======================================================================

分享一些以太坊、EOS、比特币等区块链相关的交互式在线编程实战教程:

python以太坊,主要是针对python工程师使用web3.py进行区块链以太坊开发的详解。

  • java以太坊开发教程,主要是针对java和android程序员进行区块链以太坊开发的web3j详解。
  • php以太坊,主要是介绍使用php进行智能合约开发交互,进行账号创建、交易、转账、代币开发以及过滤器和交易等内容。
  • 以太坊入门教程,主要介绍智能合约与dapp应用开发,适合入门。
  • 以太坊开发进阶教程,主要是介绍使用node.js、mongodb、区块链、ipfs实现去中心化电商DApp实战,适合进阶。
  • C#以太坊,主要讲解如何使用C#开发基于.Net的以太坊应用,包括账户管理、状态与交易、智能合约开发与交互、过滤器和交易等。
  • EOS教程,本课程帮助你快速入门EOS区块链去中心化应用的开发,内容涵盖EOS工具链、账户与钱包、发行代币、智能合约开发与部署、使用代码与智能合约交互等核心知识点,最后综合运用各知识点完成一个便签DApp的开发。
  • java比特币开发教程,本课程面向初学者,内容即涵盖比特币的核心概念,例如区块链存储、去中心化共识机制、密钥与脚本、交易与UTXO等,同时也详细讲解如何在Java代码中集成比特币支持功能,例如创建地址、管理钱包、构造裸交易等,是Java工程师不可多得的比特币开发学习课程。
  • php比特币开发教程,本课程面向初学者,内容即涵盖比特币的核心概念,例如区块链存储、去中心化共识机制、密钥与脚本、交易与UTXO等,同时也详细讲解如何在Php代码中集成比特币支持功能,例如创建地址、管理钱包、构造裸交易等,是Php工程师不可多得的比特币开发学习课程。

汇智网原创翻译,转载请标明出处。这里是原文