Overview
与 Web3 库交互的通用入口点是 Web3 对象。 web3 对象提供用于与以太坊区块链交互的 API，通常通过连接到 JSON-RPC 服务器。
Providers
Providers 是 web3 如何连接到区块链。Web3 库附带以下内置 providers，应该适用于大多数正常用例。
- web3.HTTPProvider，用于连接到基于http和https的JSON-RPC服务器。
- web3.IPCProvider，用于连接到基于ipc套接字的JSON-RPC服务器。
- web3.WebsocketProvider，用于连接基于ws和wss websocket的JSON-RPC服务器。
HTTPProvider获取可以找到服务器的完整URI。对于本地开发，这将类似于http://localhost:8545。
IPCProvider采用可以找到IPC套接字的文件系统路径。如果未提供参数，则它将使用操作系统的默认路径。
WebsocketProvider获取可以找到服务器的完整URI。对于本地开发，这将类似于ws://127.0.0.1:8546。
>>> from web3 import Web3, HTTPProvider, IPCProvider, WebsocketProvider
# Note that you should create only one RPCProvider per
# process, as it recycles underlying TCP/IP network connections between
# your process and Ethereum node
>>> web3 = Web3(HTTPProvider('http://localhost:8545'))
# or for an IPC based connection
>>> web3 = Web3(IPCProvider())
# or for Websocket based connection
>>> web3 = Web3(WebsocketProvider('ws://127.0.0.1:8546'))
Base API
Web3 类提供了以下便利 API。
Type Conversions
Web3.toHex(primitive=None, hexstr=None, text=None)
采用各种输入并以十六进制表示形式返回。它遵循JSON-RPC规范中转换为十六进制的规则。
>>> Web3.toHex(0)
'0x0'
>>> Web3.toHex(1)
'0x1'
>>> Web3.toHex(0x0)
'0x0'
>>> Web3.toHex(0x000F)
'0xf'
>>> Web3.toHex(b'')
'0x'
>>> Web3.toHex(b'\x00\x0F')
'0x000f'
>>> Web3.toHex(False)
'0x0'
>>> Web3.toHex(True)
'0x1'
>>> Web3.toHex(hexstr='0x000F')
'0x000f'
>>> Web3.toHex(hexstr='000F')
'0x000f'
>>> Web3.toHex(text='')
'0x'
>>> Web3.toHex(text='cowmö')
'0x636f776dc3b6'
Web3.toText(primitive=None, hexstr=None, text=None)
采用各种输入并返回其字符串等效项。文本被解码为UTF-8。
>>> Web3.toText(0x636f776dc3b6)
'cowmö'
>>> Web3.toText(b'cowm\xc3\xb6')
'cowmö'
>>> Web3.toText(hexstr='0x636f776dc3b6')
'cowmö'
>>> Web3.toText(hexstr='636f776dc3b6')
'cowmö'
>>> Web3.toText(text='cowmö')
'cowmö'
Web3.toBytes(primitive=None, hexstr=None, text=None)
采用各种输入并返回其等效的字节。文本被编码为UTF-8。
>>> Web3.toBytes(0)
b'\x00'
>>> Web3.toBytes(0x000F)
b'\x0f'
>>> Web3.toBytes(b'')
b''
>>> Web3.toBytes(b'\x00\x0F')
b'\x00\x0f'
>>> Web3.toBytes(False)
b'\x00'
>>> Web3.toBytes(True)
b'\x01'
>>> Web3.toBytes(hexstr='0x000F')
b'\x00\x0f'
>>> Web3.toBytes(hexstr='000F')
b'\x00\x0f'
>>> Web3.toBytes(text='')
b''
>>> Web3.toBytes(text='cowmö')
b'cowm\xc3\xb6'
Web3.toInt(primitive=None, hexstr=None, text=None)
采用各种输入并返回其整数等价物。
>>> Web3.toInt(0)
0
>>> Web3.toInt(0x000F)
15
>>> Web3.toInt(b'\x00\x0F')
15
>>> Web3.toInt(False)
0
>>> Web3.toInt(True)
1
>>> Web3.toInt(hexstr='0x000F')
15
>>> Web3.toInt(hexstr='000F')
15
Currency Conversions
Web3.toWei(value, currency)
返回转换为wei的 currency 参数指定的面额中的值。
>>> Web3.toWei(1, 'ether')
1000000000000000000
Web3.fromWei(value, currency)
返回转换为给定货币的 wei 值。该值以十进制形式返回，以确保精确到 wei。
>>> web3.fromWei(1000000000000000000, 'ether')
Decimal('1')
Addresses
Web3.isAddress(value)
如果值是已识别的地址格式之一，则返回 True。
- 允许 0x 前缀和非 0x 前缀值。
- 如果地址包含混合的大小字符，则此函数还会根据 EIP55 检查地址校验和是否有效。
>>> web3.isAddress('0xd3CdA913deB6f67967B99D67aCDFa1712C293601')
True
Web3.isChecksumAddress(value)
如果值是有效的 EIP55 校验和地址，则返回 True。
>>> web3.isChecksumAddress('0xd3CdA913deB6f67967B99D67aCDFa1712C293601')
True
>>> web3.isChecksumAddress('0xd3cda913deb6f67967b99d67acdfa1712c293601')
False
Web3.toChecksumAddress(value)
使用 EIP55 校验和返回给定地址。
>>> Web3.toChecksumAddress('0xd3cda913deb6f67967b99d67acdfa1712c293601')
'0xd3CdA913deB6f67967B99D67aCDFa1712C293601'
Cryptographic Hashing
classmethod Web3.sha3(primitive=None, hexstr=None, text=None)
返回给定值的Keccak SHA256。在计算哈希值之前，文本被编码为UTF-8，就像Solidity一样。以下任何一项都是有效且等效的：
>>> Web3.sha3(0x747874)
>>> Web3.sha3(b'\x74\x78\x74')
>>> Web3.sha3(hexstr='0x747874')
>>> Web3.sha3(hexstr='747874')
>>> Web3.sha3(text='txt')
HexBytes('0xd7278090a36507640ea6b7a0034b69b0d240766fa3f98e3722be93c613b29d2e')
classmethod Web3.soliditySha3(abi_types, value)
返回 sha3，因为它将由提供的 value 和 abi_types 上的solidity sha3 函数计算。 abi_types 值应该是与每个提供的值对应的 solidity 类型字符串的列表。
>>> Web3.soliditySha3(['bool'], [True])
HexBytes("0x5fe7f977e71dba2ea1a68e21057beebb9be2ac30c6410aa38d4f3fbe41dcffd2")
>>> Web3.soliditySha3(['uint8', 'uint8', 'uint8'], [97, 98, 99])
HexBytes("0x4e03657aea45a94fc7d47ba826c8d667c0d1e6e33a64a036ec44f58fa12d6c45")
>>> Web3.soliditySha3(['uint8[]'], [[97, 98, 99]])
HexBytes("0x233002c671295529bcc50b76a2ef2b0de2dac2d93945fca745255de1a9e4017e")
>>> Web3.soliditySha3(['address'], ["0x49eddd3769c0712032808d86597b84ac5c2f5614"])
HexBytes("0x2ff37b5607484cd4eecf6d13292e22bd6e5401eaffcc07e279583bc742c68882")
>>> Web3.soliditySha3(['address'], ["ethereumfoundation.eth"])
HexBytes("0x913c99ea930c78868f1535d34cd705ab85929b2eaaf70fcd09677ecd6e5d75e9")
Modules
JSON-RPC功能分为多个模块，这些模块与底层JSON-RPC方法的名称空间松散对应。
项目源代码
项目源代码会逐步上传到 Github，地址为 https://github.com/windstamp/jsonrpc。
Contributor
- Windstamp, https://github.com/windstamp
Reference
- https://web3py.readthedocs.io/en/stable/
- http://web3py.readthedocs.io
- https://github.com/ethereum/web3.py