一、安装

shell> pip install web3

二、使用web3

1、本地Geth节点

对于本地运行的节点，IPC 连接是最安全的选项，但也可以使用 HTTP 和 websocket 配置。默认情况下，Geth 公开端口8545以服务 HTTP 请求和8546websocket 请求。可以按如下方式连接到本地节点：

>>> from web3 import Web3
# IPCProvider:用于连接到基于 ipc 套接字的 JSON-RPC 服务器。
>>> w3 = Web3(Web3.IPCProvider('./path/to/geth.ipc'))

# HTTPProvider:用于连接到基于 http 和 https 的 JSON-RPC 服务器。
>>> w3 = Web3(Web3.HTTPProvider('http://127.0.0.1:7545'))

# WebsocketProvider:用于连接到基于 ws 和 wss websocket 的 JSON-RPC 服务器。
>>> w3 = Web3(Web3.WebsocketProvider('ws://127.0.0.1:8546'))
>>> w3.isConnected()
True

2、使用Infura节点

与以太坊区块链交互的最快方式是使用远程节点提供商，如Infura。您可以通过指定端点连接到远程节点，就像前面的本地节点一样：

>>> from web3 import Web3
>>> w3 = Web3(Web3.HTTPProvider('https://mainnet.infura.io/v3/<infura-project-id>'))

三、 获取区块链信息

>>> w3.eth.get_block('latest')
AttributeDict({'number': 0, 'hash': HexBytes('0x0326c63177a38142328b9805f2158c80f754304d224f5403bc0f01042bf3aa75'), 'parentHash': HexBytes('0x0000000000000000000000000000000000000000000000000000000000000000'), 'mixHash': HexBytes('0x0000000000000000000000000000000000000000000000000000000000000000'), 'nonce': HexBytes('0x0000000000000000'), 'sha3Uncles': HexBytes('0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347'), 'logsBloom': HexBytes('0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'), 'transactionsRoot': HexBytes('0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421'), 'stateRoot': HexBytes('0xe55dc9bc23eb5a9acea79dc7a52e415c04bafe5430cf5828fa9397cbb95399eb'), 'receiptsRoot': HexBytes('0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421'), 'miner': '0x0000000000000000000000000000000000000000', 'difficulty': 0, 'totalDifficulty': 0, 'extraData': HexBytes('0x'), 'size': 1000, 'gasLimit': 6721975, 'gasUsed': 0, 'timestamp': 1623569434, 'transactions': [], 'uncles': []})

四、基础API

1、编码和解码

Web3.is_encodable()
如果一个值可以被编码为给定类型，则返回True。否则返回False

>>> from web3.auto.gethdev import w3
>>> w3.is_encodable('bytes2', b'12')
True
>>> w3.is_encodable('bytes2', b'1')
True
>>> w3.is_encodable('bytes2', b'123')
False

Web3.toBytes(primitive=None, hexstr=None, text=None)
接受各种输入并返回其等效字节

>>> Web3.toBytes(0)
b'\x00'
>>> Web3.toBytes(1)
b'\x01'
>>> Web3.toBytes(False)
b'\x00'
>>> Web3.toBytes(True)
b'\x01'

Web3.toInt(primitive=None, hexstr=None, text=None)
接受各种输入并返回其等效整数

>>> Web3.toInt(0)
0
>>> Web3.toInt(0x000F)
15
>>> Web3.toInt(False)
0
>>> Web3.toInt(True)
1

Web3.toJSON(obj)
接受各种输入并返回对应的JSON

>>> Web3.toJSON(5)
'5'
>>> Web3.toJSON({'one': 1})
'{"one": 1}'

Web3.toText(primitive=None, hexstr=None, text=None)
接受各种输入并返回其等效字符串

>>> Web3.toText(0x636f776dc3b6)
'cowmö'
>>> Web3.toText(b'cowm\xc3\xb6')
'cowmö'
>>> Web3.toText(hexstr='0x636f776dc3b6')
'cowmö'
>>> Web3.toText(text='cowmö')
'cowmö'

2、地址

Web3.isAddress(value)
如果该值是可识别的地址格式之一，则返回True。
允许0x前缀和非前缀值。
如果地址包含大小写混合字符，此函数还根据EIP55检查地址校验是否有效

>>>Web3.isAddress('0xd3CdA913deB6f67967B99D67aCDFa1712C293601')
True

Web3.isChecksumAddress(value)
如果值是有效的EIP55校验地址，则返回True

>>> Web3.isChecksumAddress('0xd3CdA913deB6f67967B99D67aCDFa1712C293601')
True
>>> Web3.isChecksumAddress('0xd3cda913deb6f67967b99d67acdfa1712c293601')
False

3、货币兑换

Web3.toWei(value, currency)
返回转换为wei的currency参数指定的面额值

>>> Web3.toWei(1, 'ether')
1000000000000000000

Web3.fromWei(value, currency)
返回转换为给定货币的wei值。该值以Decimal形式返回，以确保精确到wei

>>> Web3.fromWei(1000000000000000000, 'ether')
Decimal('1')