用 Python 中的 web3.py 库开发 Dapp

什么是 DApp

“DApp”代表去中心化应用程序。与传统应用程序一样，去中心化应用程序也有前端（客户端）和后端（服务器端）。DApp 的用户界面可以用任何语言编写（就像传统应用程序一样），并且可以调用其后端。那么，Dapps 与传统应用程序有何不同？DApp 的后端代码运行在分散的对等网络（即区块链）上。您可能听说过 BitTorrent、Tor、Popcorn Time——它们是在点对点网络上运行但不在区块链上运行的 DApp。区块链 DApp 有自己的后端代码，称为智能合约，可以部署到区块链（最常见的是以太坊）。智能合约定义了整个 DApp 的逻辑。它是使用区块链作为后端的命脉。那么Python 开发人员可以在哪里利用它？重点来了——web3。Web3 是一组库，允许您与本地或远程以太坊区块链进行交互。简单地说，web3 是与您的后端（区块链）通信的桥梁。幸运的是，以太坊开发人员已经制作了一个 python 库 web3.py 用于与以太坊进行交互。它的 API 源自 web3 的 JavaScript 版本。因此，除了 web3.js，我们也可以通过 web3.py 库与区块链进行交互。

Dapps 开发包括三个简单的步骤：

在区块链网络上部署智能合约
从部署的智能合约中读取数据
将交易发送到部署的智能合约, \; S! G" S* e. B. ^, O

我们将在带有 web3.py 库的 python 环境中一步一步地进行这三个操作要与区块链交互，我们必须连接到任何完全同步的节点。在本教程中，我们指向一个 Infura 节点。确保你有一个以太坊钱包（使用 Metamask chrome 扩展或 myetherwallet 创建以太坊钱包并安全地存储你的私钥）并在其中添加一些测试 Ether 以进行操作。

安装

Python 2.7 +
Node.js
Truffle

npm install -g truffle
Pip
npm i pip
web3.py
pip install web3

Infura 项目 API
前往 Infura 网站并注册。创建一个新项目并复制 Ropsten Infura RPC URL。我们将把我们的智能合约部署到 Ropsten 测试网络。

智能合约

每个程序员都用他们最喜欢的编程语言执行了一个“hello world”程序，以了解运行该语言的基础知识。这是我们使用 Solidity 语言编写的简单的“hello world”版本的智能合约，我们可以在区块链上添加问候语并检索它。Solidity 是编写智能合约最常用的语言，它编译为可以在节点上运行的以太坊虚拟机上执行的字节码。

pragma solidity ^0.5.7;
1 y/ U8 C$ F, C6 @, C* v
contract greeter{
\* T' R' T, S6 J) {5 ]
string greeting;
5 v3 a9 R1 G6 d. ?. x; r h) V- s* E
function greet(string memory _greeting)public{2 S! `$ N' A4 B% }: d" {( ]
greeting=_greeting;
3 d, ?- K8 O! E9 `8 I( H# {
}
$ ?2 l' H! ?% C% ^# c" B! q" C
function getGreeting() public view returns(string memory) {. n$ Y7 s; g* I0 y& {+ X$ j" j5 |
return greeting;8 B/ e( x7 V9 o
}3 Z# A9 w6 X% J/ W* m0 l" {3 u. F
}+ F2 C3 V3 R+ d0 v$ j, }- g

复制代码

您可以通过传递字符串值使用 greet() 方法添加问候语，并使用 getGreting() 方法检索问候语。

1. 在区块链网络上部署智能合约

a) 创建项目：

mkdir pythonDapp
cd pythonDapp
truffle init

成功初始化项目后，转到您的文件夹并在 /contracts目录中创建 greeter.sol 文件。在网络上部署合约之前，我们必须编译它并构建工件。

b) 智能合约的编译：因此，对于编译，我们将使用 Truffle solc 编译器。在您的主目录中，运行以下命令：

truffle compile
(or)
truffle.cmd compile #(for windows only)

上面的命令将在 /contracts 目录中编译你的合约，并在 /build 目录中创建二进制工件文件 greeter.json。

c) 部署合约：打开您的 Python IDLE 编辑器，并在主目录 deploy.py 中使用以下代码创建一个新文件，然后在您的目录中运行 py deploy.py。

import json
7 G4 M' e) B- g5 t$ y
from web3 importWeb3, HTTPProvider
7 ?6 D' C& T I! b* C9 r( \
from web3.contract importConciseContract
) ^* f# }8 H e' v
# web3.py instance
]- T; d: f6 c4 t4 e( N
w3 = Web3(HTTPProvider("https://ropsten.infura.io/v3/<API key>"))0 B; Y& J/ v: C' l2 v
print(w3.isConnected())
. w" z" O( @" M8 Q" w( I; }0 Q
key="<Private Key here with 0x prefix>"
3 y! I' t/ Q# ] s4 }' m
acct = w3.eth.account.privateKeyToAccount(key)3 W1 `, Z! x9 p$ O
# compile your smart contract with truffle first& c o6 T3 {0 S, H8 e! d* I
truffleFile = json.load(open('./build/contracts/greeter.json'))6 a* f1 \3 _' [' F# ?! n( d
abi = truffleFile['abi']
! `3 ?8 @/ e5 S1 L
bytecode = truffleFile['bytecode']
$ d! s9 [/ x' u7 G
contract= w3.eth.contract(bytecode=bytecode, abi=abi): n1 O, H& o* E: M$ l5 N. {" }& q
#building transaction
6 F3 D8 r# E- _5 X2 Y# w4 ^( S
construct_txn = contract.constructor().buildTransaction({
5 A) N7 c( F- o. S
'from': acct.address,9 y4 U- C+ K- z3 p/ c& W/ w
'nonce': w3.eth.getTransactionCount(acct.address),6 X" g! r( O! X2 O3 \
'gas': 1728712,
' @8 p8 m, R; i# V: E3 F8 j7 R( q- `
'gasPrice': w3.toWei('21', 'gwei')})
' L# W/ i) W9 I- [( w! I. U3 ^
signed = acct.signTransaction(construct_txn)% t5 A, x! k. |" l: j
tx_hash=w3.eth.sendRawTransaction(signed.rawTransaction)
; t4 @3 g, N7 X5 u/ D
print(tx_hash.hex())
9 }, b4 X, x2 |3 L/ |+ E
tx_receipt = w3.eth.waitForTransactionReceipt(tx_hash)
6 I9 o& Z' P ^, S `5 u
print("Contract Deployed At:", tx_receipt['contractAddress'])

复制代码

这是我所做的：

导入的 web3 库和所有其他必需的模块
通过指向 Ropsten Infura 节点启动 web3 提供程序
添加了用于签署交易的帐户地址和私钥。不要忘记在代码中添加您的凭据。
通过指向 Truffle 编译的工件文件greeter.json的abi和字节码启动合约实例
添加了带有随机数、gas、gasPrice 等参数的construct_txn。此处，gas 是指交易应在以太坊中使用和支付的最大计算资源量。gasPrice 是指在交易中使用该数量的 gas 时的最小 Ether 数量。to 指的是您发送交易的地址。仅当您将 Ether 发送到帐户或智能合约时才需要 to 参数。
使用我们的私钥签署交易并在网络上广播。
在控制台中记录交易哈希和部署的合约地址。根据以太坊的说法，事务处理时间 <20 秒。所以你必须等待 20 秒才能获得部署的合约地址。您的后端现在已成功部署在以太坊区块链上。现在您可以使用此地址与您的智能合约进行交互。复制此合约地址。
2. 向部署的合约发送交易

在我们的合约中，有一个方法greet()。我们可以单独使用这种方法在我们的合同中添加问候语。让我们看看我们如何使用 web3.py 来做到这一点。打开您的 Python IDLE 编辑器并使用以下代码创建一个新文件 sign.py。然后在您的目录中运行 py sign.py。

import json7 M, k, {! G- J; L) Q
from web3 importWeb3, HTTPProvider
; M6 {5 a1 k' l: B( @# }
from web3.contract importConciseContract
/ Z4 v* k" K' a' H$ X1 e
# compile your smart contract with truffle first2 \& F! u1 I V2 T3 ]7 G; I# H
truffleFile = json.load(open('./build/contracts/greeter.json'))
% Q Z; v; e- R( U! E5 k; S
abi = truffleFile['abi']
5 P3 W# e' q$ S3 W! m) l, ?
bytecode = truffleFile['bytecode']
8 s3 [ S* @0 n( E% L3 N
# web3.py instance" V+ @" E g* f9 F
w3 = Web3(HTTPProvider("https://ropsten.infura.io/v3/<API key>")) #modify
% y1 a3 Y. b' D: o* R
print(w3.isConnected())2 W: M5 o. E1 {0 t; }, V$ @2 T
contract_address = Web3.toChecksumAddress("<Deployed Contract Address here>") #modify# e8 _$ h8 j6 @/ e, i
key="<Private key with 0x prefix here>"#modify+ Y- P: a( y9 u4 u- J
acct = w3.eth.account.privateKeyToAccount(key)
( D6 f, S5 f& s0 H
account_address= acct.address2 G8 l* u/ p( b
# Instantiate and deploy contract
: k x# ~, H- D, P
contract = w3.eth.contract(abi=abi, bytecode=bytecode)( A! {& h" |0 i* P
# Contract instance$ l( ^2 j' i7 K- \, M P: d
contract_instance = w3.eth.contract(abi=abi, address=contract_address)- n! m" R+ B9 d( ^, C+ f
# Contract instance in concise mode4 v! c0 }+ x: N9 d. v
#contract_instance = w3.eth.contract(abi=abi, address=contract_address, ContractFactoryClass=ConciseContract) t( q! J7 u! c/ v% O' U
tx = contract_instance.functions.greet("Hello all my goody people").buildTransaction({'nonce': w3.eth.getTransactionCount(account_address)}) ~5 |9 w( _ P. y* `8 Y! D
#Get tx receipt to get contract address$ a6 X" j2 h& O5 H! s1 l3 ?6 J
signed_tx = w3.eth.account.signTransaction(tx, key)* A0 {+ Y; Y' r5 k8 Z; L0 s/ n
#tx_receipt = w3.eth.getTransactionReceipt(tx_hash)( c8 o! M. A0 V7 N9 e/ s. l2 u
hash= w3.eth.sendRawTransaction(signed_tx.rawTransaction)
. k( G" V$ [7 d- _- p+ @
print(hash.hex())

复制代码

这是我所做的：

导入的 web3 库和所有其他必需的模块
通过指向 Ropsten Infura 节点启动 web3 提供程序
添加了用于签署交易的帐户地址和私钥
通过指向 Truffle 编译的工件文件greeter.json的abi和字节码启动合约实例
创建 tx 对象以添加问候语“hello all my goody people”并建立交易
使用我们的私钥签署交易并在网络上广播。
在控制台中记录交易哈希。您可以使用您的交易哈希在 etherscan 上检查交易状态。一旦交易被矿工验证，我们的问候语将被添加到区块链上。您可以使用 getGreeting() 函数检索问候语，如下所述。
3. 从部署的智能合约中读取数据

在我们的合约中，有一个方法 getGreeting() 可以检索我们在区块链中添加的问候语。我们将使用 web3.py 调用此方法打开您的 Python IDLE 编辑器并使用以下代码创建一个新文件 read.py。运行 py read.py 读取问候语。

9 p' j+ H% V4 c& }% n% \+ j# P
import json. W; @" N( K2 q1 Y% r2 _: q8 R5 X: N
from web3 importWeb3, HTTPProvider$ l* R7 k) F+ T, g
from web3.contract importConciseContract
9 s I. m- i2 p. H# Q; D
# compile your smart contract with truffle first; H3 X1 ~- H: j N% H9 E- p
truffleFile = json.load(open('./build/contracts/greeter.json'))4 s# Y& d- G! H' f5 k' @& ]
abi = truffleFile['abi']
4 d9 w8 a+ m/ A f6 K& [; Z
bytecode = truffleFile['bytecode']8 v0 H6 ~: `; _( j* T
# web3.py instance6 t' w5 n8 g! U& u- e3 J# c- w
w3 = Web3(HTTPProvider("https://ropsten.infura.io/<ApI Key here>"))5 j9 Q/ X ~+ R% P4 l1 X2 L( d& W8 n
print(w3.isConnected())# O2 Y7 e) C' J! y6 m* j
contract_address = Web3.toChecksumAddress("<Deployed Contract Address here>")6 N, b3 ^" Q- [
# Instantiate and deploy contract: m6 n9 b$ f. ]" }0 x& K* x i
contract = w3.eth.contract(abi=abi, bytecode=bytecode)
( G; Y" w% @; H8 s9 b0 T2 _
# Contract instance, R7 |" R/ \+ _. B# b9 v1 G
contract_instance = w3.eth.contract(abi=abi, address=contract_address)6 Q" Z! Z. h' q
# Contract instance in concise mode
$ Y$ ^$ W1 H/ I/ N/ Q
#contract_instance = w3.eth.contract(abi=abi, address=contract_address, ContractFactoryClass=ConciseContract)+ b/ G( Z( @1 s) w* x5 P+ W5 l; O
# Getters + Setters for web3.eth.contract object ConciseContract/ h- t1 f* r( k4 C
#print(format(contract_instance.getGreeting())), J7 v( W! j" v4 v/ C8 D# V
print('Contract value: {}'.format(contract_instance.functions.getGreeting().call()))

复制代码

这是我所做的：

导入的 web3 库和所有其他必需的模块
通过指向 Ropsten Infura 节点启动 web3 提供程序
通过指向 abi 和 contract_Address 创建合约实例（来自上一步）
调用 getGreeting() 方法并在控制台打印结果
结论

您现在应该了解如何使用 web3.py 部署、交互和签署交易。让我们通过查看我使用 web3.py 创建的实时 DApp 并在此处使用 Flask 作为前端服务器来将所有部分组合在一起。它将帮助您更深入地了解使用 Python 进行 DApp 开发。

参考 @温室小书生室d 《python利用web3.py开发以太坊应用dapp的实战教程》

浏览过的版块