开发基于以太坊智能合约的DApp
星火车品
发表于 2022-12-18 02:06:40
118
0
0
以太坊节点本来提供了rpc的访问方式,但是因为以太坊节点的地址不确定,并且DApp需要访问钱包,所以用web3.js直接访问以太坊节点的rpc服务是不现实的。" ], Y% `' T- p2 u; f. T5 [
ganache-cli模拟了一个以太坊的测试节点并提供对外的rpc访问方式(就是例子里经常说的http://localhost:7545或者http://localhost:8545)。同时在其中内置了M个以太坊帐号,用于测试。
MetaMask是一个以太坊的网络钱包插件,它也提供了web3的访问方式。而且可以通过这个插件指定后面的以太坊节点是什么。因为MetaMask是个钱包插件,所以解决了DApp中的支付问题。所以现在的DApp都依赖它。3 p8 s, V L! c4 W% u
有一个以太坊教程,是在线学习的,大家可以去看看,如果自己本机上搞,开发DApp的基本过程都是一样的如下:+ i) j, \: ]% I4 u6 {
1、安装NodeJS' ?8 l/ q1 F. |. [0 s' d
2、安装truffle:一个开发DApp的开发框架2 p ? ?" R1 t* N( h4 Y$ L
nmp install -g truffle
3、安装Ganache(原来用testrpc):在内存中模拟以太坊运行并对外提供rpc服务。3 R8 q; ~$ ~5 B d
npm install -g ganache-cli+ ?( x& R6 @! B b1 W0 ^0 W
4、运行ganache-cli
ganache-cli6 P' z- K ^) c% F9 L
5、生成一个DApp的项目
mkdir project17 m# j5 }# i+ }5 `
truffle init
如果想用truffle中的某个例子,可以用
truffle unbox pet-shop7 ~ f; [5 S s& w
“pet-shop”是例子名称
6、编写智能合约! g `6 w7 v- @
具体如何用solidity编写智能合约可参考各种文章,这里不再重复。
编写好的智能合约的Project1.sol文件放到contracts目录下$ @( c5 H: }4 d
7、编译和部署智能合约# W7 @! {- C6 Y r
在migrations目录下创建文件2_deploy_contracts.js:/ l8 r' f6 W Y# g4 f* R) f! H
var Project1 = artifacts.require("Project1");8 E, S! \* h. j; S- B! ?* O
module.exports = function(deployer) {8 i* I6 t1 o# w% P# V9 A& [
deployer.deploy(Project1);
};- Q @* D7 P% M+ L( Z9 |
之后执行:. Z- F5 X4 V2 v3 Y6 c( ?' p
truffle compile
truffle migrate) N+ V8 a" ?; Z. ^5 x7 L+ f- w
如果你的智能合约没有问题的话,现在你的以太坊智能合约应该已经部署到你用来测试的ganache中去了。
这里可能遇到的问题是:默认的truffle生成的项目,测试用的ganache的地址和端口会被设置成http://localhost:7545,而实际上执行ganache-cli之后的服务端口是http://localhost:8545,需要在truffle.js中修改一下:) [8 Y/ A( o$ i& ^
module.exports = {
// See & A/ t$ g, I+ X8 b
// for more about customizing your Truffle configuration!
networks: {+ ~4 L3 M8 K- E7 r) N( F1 j
development: {! B0 h1 f% k2 S. u- p7 N$ b$ ?, g
host: “127.0.0.1”,% y R) l3 d' b( ^. b1 S
port: 7545, //改成85456 E$ p7 @( D2 W9 i
network_id: “*” // Match any network id
}* B# @( A- ~2 w- B
}
};
8、编写前端的js代码跟以太坊交互/ t1 y5 F& L' g/ a
通常需要如下的辅助js库:' ?) E) w. H2 V: e5 {$ `5 @
; ^$ G8 ?# ]/ m8 u0 @
在此基础上,编辑你自己业务逻辑的js,通常命名为app.js,app.js的框架如下:
App = {- K/ O2 |1 D8 _/ S
web3Provider: null,& }0 X$ |- Z. c# ?& D: t
contracts: {},2 M9 `8 Y0 P5 `$ ?; p3 N6 r% L
init: function() {$ y3 ?/ y( G# {
//初始化你自己的页面、变量等/ [9 r, b, b: i P, b- |: u0 u
return App.initWeb3();
},
initWeb3: function() {- B+ b; v8 h7 F3 Z- ]/ y3 H& V
/*2 w4 S; ^8 n1 l: Y
* 初始化web3:: u' o6 g8 Z8 y* N
*/! w: B" j( s- R3 Y7 l8 T4 f c2 q
if (typeof web3 !== ‘undefined’){$ x! Y3 P! h1 U3 }% X+ i
//如果你的浏览器安装了MetaMask的钱包插件,那么插件会赋值web3.currentProvider3 e) u4 R N. t0 ]8 X+ `5 \; I
App.web3Provider = web3.currentProvider;5 v2 E# |; d9 o$ H k8 W- V& G
}
else
{2 o% x: A1 G3 ?) i' i; U& q9 P, q
//如果没装插件,那么创建一个基于Http的provider,这里用到的就是用ganache-cli启动所提供的rpc服务,因为ganache-cli启动的时候绑定的是localhost,所以测试所使用的浏览器也要在本机。(如何让ganache-cli绑定其他地址我还没找到)0 [# _! x. K$ h/ B; N
App.web3Provider = new Web3.providers.HttpProvider(‘http://localhost:8545’);
}: J8 O& i+ w7 D; R
web3 = new Web3(App.web3Provider);
return App.initContract();
},
initContract: function() {
/*
* 初始化智能合约,实际上就是为你的智能合约创建一个对应的js对象,方便后续调用
*/, V, r- l% R' p2 I8 V% P
//通常的做法是使用你的智能合约编译之后生成的abi的json文件,该文件在用truffle compile之后,生成在build/contracts/目录下,因为我用了一个Division.sol,所以用Division.json,你可以根据你的实际情况来写。
$.getJSON(‘Division.json‘, function(data) {4 S, S) e# v: w5 O8 y
var DivisionArtifact = data;/ A8 z2 B% J$ G, z: D
App.contracts.Division = TruffleContract(DivisionArtifact);
App.contracts.Division.setProvider(App.web3Provider);
//用智能合约中的信息来更新你的web应用,App.refreshPlots()是我例子中获取智能合约中信息并更新UI的函数
return App.refreshPlots();3 S& A! n' I* f+ \. h
});
return App.bindEvents();( ~* |5 d" L% E# v# o k
},- p. Z; ~1 V( P8 B
bindEvents: function() {5 ^8 h2 W. c( p. `: h: r
/*
* 事件绑定,这个可以根据你的UI来设置,例子中就是绑定一个button的点击操作
*/+ M6 O# j3 I# O) f9 d( U
$(document).on(‘click’, ‘.btn-adopt’, App.handlePlot);
},
refreshPlots: function(plots, account) {
/*
* 这个函数就是上面initContract中调用的用智能合约更新页面& E, n+ K! N4 J2 Y$ A; \
*/
//继续使用division这个智能合约做例子
var divisionInstance;
App.contracts.Division.deployed().then(function(instance){' Z1 k5 A- X# A" d- n0 a
divisionInstance = instance;6 f9 Q4 S" a' X( ?
//getGenPlots是Division的这个智能合约的一个查询函数(不需要gas),需要3个参数: Q; w* c- K: q
return divisionInstance.getGenPlots(0,0,2);
}).then(function(results){
//注意:这个地方有点意思,我原先理解也有问题,后来打印输出才搞明白
//智能合约返回的多个结果变量在这里就是一个results数组4 D" f% D7 W8 B& P k
//数组的每个成员就是智能合约返回的每个结果变量
//以getGenPlots为例,Division.json中定义如下:
/*"name": "getGenPlots",( b& K: k5 h& c+ l0 [; I! i: J! I
"outputs": [
{& G# \$ f* B, H8 L/ e9 I
"name": "",
"type": "uint64[]"1 {) _ R3 C; Q3 h- `/ T' U+ A
},; C; r/ }3 v) } Z
{$ ]3 S3 r* Z+ k3 H
"name": "",
"type": "address[]"3 @' r# p; a* a; b
},+ R5 Y7 S8 P# p4 H
{
"name": "",
"type": "uint256[]"# A m( t1 V' U9 _/ ~
},( V1 t4 V5 ?9 y! s' p
{
"name": "",& m- C! I2 X9 N! f6 j% ^) f
"type": "uint8[]"
}
],
"payable": false,
"stateMutability": "view",9 \( {* S1 ^0 c" ^' ]
"type": "function"
*/
//那么:results[0]是uint64[]
// results[1]是address[]... Q+ U+ L- c7 C- R
console.log(results[0].length);
}).catch(function(err){
console.log(err.message);' Y8 i0 ]/ U$ ?, D8 s- d6 o+ L5 L
});
},
handlePlot: function(event) {
/*
* 这个函数就是上面bindEvents中调用的响应函数,演示要花eth的函数调用
*/
event.preventDefault();3 Y$ Q! b7 [/ c B0 H+ ^
//从event中获取参数,这是jquery的东西,跟web3无关& I4 e: t' k; ?' T1 E
var plotId = parseInt($(event.target).data('id'));4 V1 k* D. k4 V+ U2 a
var divisionInstance;
//获取以太坊帐号信息- d2 W# Q, w/ h# [4 s8 Q
web3.eth.getAccounts(function(error,accounts){
if(error)
{
console.log(error);
}8 Z9 K% ^& I1 s0 M2 X1 j$ V, C
//我随便取帐号列表里的第3个帐号。
//因为我们连的是ganache-cli的rpc模拟服务,5 s$ R; @5 h# Z% Z8 I+ A! W
//其中给我们预制了几个有eth的帐号0 j6 k! w: C, k0 p" o5 k
//如果安装了MetaMask插件,应该获得的就是MetaMask里的帐号% r! W& q t$ L/ O5 \
var account = accounts[2];
App.contracts.Division.deployed().then(function(instance){
divisionInstance = instance;2 E7 \1 t6 B0 O$ v) H: @
//调用智能合约的buyPlot函数,该函数需要2个参数,
//后面的{}中的内容跟发起以太坊交易的时候所带的默认值。9 @+ b7 }8 b3 h9 D" _
//from: 使用哪个以太坊帐号
//value: 要使用的eth数量,以wei为单位(1eth=10^18wei)
//gas: 矿工费,以wei为单位7 S& U( \1 q( P4 h2 E% H
return divisionInstance.buyPlot(plotId, 3, {from: account, value: 100000000000000000, gas:6000000});* J( z: _( O! ^. A# \1 x% Z, d. X
}).then(function(result){. L: ^# u* e/ j: Y
//返回结果后重新更新UI
return App.refreshPlots();
}).catch(function(error){
console.log(error.message);6 f; H: o/ x3 @
});) t$ K- f4 W6 w! [* w' e
});+ {2 R; }/ y! n0 Z5 a2 [" C( v) Z% V
} B$ u8 W c" n$ A6 i7 m
};. i% ~ Z* Y9 \: l& y5 A0 f
测试你的基于Web的DApp是否正常,可以使用nodejs里面提供的lite-server模块来当简单的webserver来用。
安装lite-server,在你的truffle项目目录下,执行:
npm install lite-server
安装完之后会在项目目录下声称node_modules目录,lite-server以及依赖的模块都在该目录下了。
要运行lite-server,还需要编写项目目录下的package.json文件:
{1 B% N9 V. }% ^' E9 a
"name": "项目名称",
"version": "1.0.0",7 O. j( R2 y6 i* g1 P1 ^
"description": "",6 ~: Z) ^/ s% ]
"main": "truffle.js",
"directories": {3 p- F) N3 X2 q% D- p) R4 e' Z9 `
"test": "test"
},
"scripts": {
"dev": "lite-server",1 p1 W7 f( b2 p" Q V1 t# R
"test": "echo \"Error: no test specified\" && exit 1" u0 P; K: H" [: T! v8 {
},
"author": "",
"license": "ISC",0 S: _2 F7 c( d J
"devDependencies": {
"lite-server": "^2.3.0"' f% M1 k: \* R k p
},
"dependencies": {
"liteserver": "^0.3.0"
}7 o, o- Q( ~6 [
}) d: V, P% l/ y( }
还需要编写bs-config.json来配置一下lite-server
{5 o- {0 w: p2 S+ Y, T& d
"server": {3 N" e W7 {6 v+ L3 n, y- @5 f
"baseDir": ["./src", "./build/contracts"]
}" u2 G( q, }& ~, E: k; I( _
}
baseDir是用来设置lite-server所提供的web服务的文件路径的。这个设置表明你可以把你上面写的app.js,依赖的各种js放到./src目录下,然后写index.html,把app.js等集成进去,就大功告成了。
启动lite-server,执行:# Y2 ~* p5 }( v
npm run dev
不仅启动了lite-server,而且会启动一个浏览器去打开页面。
本文的目的是为了澄清一下写DApp的各项工具之间的架构关系,帮助技术人员更快的理解和实现自己的项目。+ J! x7 i; f5 p# o$ q
具体的例子网上多如牛毛,就不去写业务的具体代码了。
成为第一个吐槽的人