python以太坊类库web3.py概览

与web3.py库交互的共同入口是web3对象。web3对象提供API,用于python开发的应用与以太坊区块链进行交互,通常是通过连接JSON-RPC服务器进行。

Providers提供者

Providers使web3连接到区块链上。Web3.py库带有以下内置的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

示例代码如下:

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

基本API

web3类提供了以下十分便利的基本API:

类型转换

web3.toHex

1
Web3.toHex(primitive=None, hexstr=None, text=None)

获取各种输入并以十六进制表示形式返回它。它遵循在JSON-RPC规范中转换为十六进制的规则。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
>>> 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

1
Web3.toText(primitive=None, hexstr=None, text=None)

获取各种输入并返回其字符串等效项。文本被解码为UTF-8。

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

1
Web3.toBytes(primitive=None, hexstr=None, text=None)

接受各种输入并返回等效字节。文本被编码为UTF-8。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
>>> 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

1
Web3.toInt(primitive=None, hexstr=None, text=None)

接受各种输入并返回其整数等效项。

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

币值转换

Web3.toWei

1
Web3.toWei(value, currency)

返回转换为wei的由currency参数指定的面额中的值。

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

Web3.fromWei

1
Web3.fromWei(value, currency)

返回wei转换为给定货币的值。该值以Decimal返回,以确保精度降至wei。

1
2
>>> web3.fromWei(1000000000000000000, 'ether')
Decimal('1')

地址

Web3.isAddress

1
Web3.isAddress(value)

如果该值是已识别的地址格式之一,则返回true。 - 允许0x前缀和没有前缀的值。 - 如果地址包含混合的大小写字符,则该函数还进行地址校验和是否符合EIP55

1
2
>>> web3.isAddress('0xd3CdA913deB6f67967B99D67aCDFa1712C293601')
True

Web3.isChecksumAddress

1
Web3.isChecksumAddress(value)

如果该值符合EIP55而且是有效的地址,则返回true

1
2
3
4
>>> web3.isChecksumAddress('0xd3CdA913deB6f67967B99D67aCDFa1712C293601')
True
>>> web3.isChecksumAddress('0xd3cda913deb6f67967b99d67acdfa1712c293601')
False

Web3.toChecksumAddress

1
Web3.toChecksumAddress(value)

返回带有EIP55校验和给定地址。

1
2
>>> Web3.toChecksumAddress('0xd3cda913deb6f67967b99d67acdfa1712c293601')
'0xd3CdA913deB6f67967B99D67aCDFa1712C293601'

加密hash

Web3.sha3

1
classmethod Web3.sha3(primitive=None, hexstr=None, text=None)

返回给定值的Keccak SHA256。在计算哈希之前,文本被编码到UTF-8,就像solidity一样。下列任何一种方式都是有效和一样的:

1
2
3
4
5
6
>>> Web3.sha3(0x747874)
>>> Web3.sha3(b'\x74\x78\x74')
>>> Web3.sha3(hexstr='0x747874')
>>> Web3.sha3(hexstr='747874')
>>> Web3.sha3(text='txt')
HexBytes('0xd7278090a36507640ea6b7a0034b69b0d240766fa3f98e3722be93c613b29d2e')

Web3.soliditySha3

classmethod Web3.soliditySha3(abi_types, value)

返回Sha3,它将根据所提供的valueabi_types通过soliditySha3函数计算。abi_types应该是对应于所提供的每个值的solidity类型字符串的列表。

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

web3.py在JSON-RPC功能在多个模块上进行了分割,这些模块松散地对应于JSON-RPC方法的命名空间。


希望快速开始进行python开发以太坊学习的可以看看这个: python以太坊,主要是针对python工程师使用web3.py进行区块链以太坊开发的详解。

其他以太坊相关教程:

  • web3j教程,主要是针对java和android程序员进行区块链以太坊开发的web3j详解。
  • 以太坊教程,主要介绍智能合约与dapp应用开发,适合入门。
  • 以太坊开发,主要是介绍使用node.js、mongodb、区块链、ipfs实现去中心化电商DApp实战,适合进阶。
  • php以太坊,主要是介绍使用php进行智能合约开发交互,进行账号创建、交易、转账、代币开发以及过滤器和事件等内容。

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