开发基于以太坊智能合约的DApp
星火车品
发表于 2022-12-18 02:06:40
117
0
0
以太坊节点本来提供了rpc的访问方式,但是因为以太坊节点的地址不确定,并且DApp需要访问钱包,所以用web3.js直接访问以太坊节点的rpc服务是不现实的。/ p2 {. ?8 k+ Y1 G& x3 S5 @
ganache-cli模拟了一个以太坊的测试节点并提供对外的rpc访问方式(就是例子里经常说的http://localhost:7545或者http://localhost:8545)。同时在其中内置了M个以太坊帐号,用于测试。
MetaMask是一个以太坊的网络钱包插件,它也提供了web3的访问方式。而且可以通过这个插件指定后面的以太坊节点是什么。因为MetaMask是个钱包插件,所以解决了DApp中的支付问题。所以现在的DApp都依赖它。# H4 p& l5 j' M+ A9 J! ~6 C
有一个以太坊教程,是在线学习的,大家可以去看看,如果自己本机上搞,开发DApp的基本过程都是一样的如下:; x! b4 X2 Z5 l! y, [7 t/ ]5 c
1、安装NodeJS
2、安装truffle:一个开发DApp的开发框架
nmp install -g truffle
3、安装Ganache(原来用testrpc):在内存中模拟以太坊运行并对外提供rpc服务。
npm install -g ganache-cli8 \. i# K# A+ I* W
4、运行ganache-cli6 _: b) O! ^) a- c
ganache-cli6 M Q# ~3 a. @: `5 f1 f
5、生成一个DApp的项目" x/ b- a' A' i( d% _4 _" O
mkdir project1
truffle init
如果想用truffle中的某个例子,可以用3 h$ Z$ q: \, N1 f
truffle unbox pet-shop& K) l8 [: [6 c' [- [# k
“pet-shop”是例子名称2 K9 y* e! V$ K/ n* \. c
6、编写智能合约
具体如何用solidity编写智能合约可参考各种文章,这里不再重复。
编写好的智能合约的Project1.sol文件放到contracts目录下
7、编译和部署智能合约4 q. N4 Q e0 ]7 ?' @8 f' Y# h, `
在migrations目录下创建文件2_deploy_contracts.js:
var Project1 = artifacts.require("Project1");. w6 i" M5 d# k4 X3 a/ V1 I
module.exports = function(deployer) {- U- m' K; X! f6 W/ G
deployer.deploy(Project1);
};; `% l! b% l: v( k- f5 x
之后执行:8 G+ d, ]9 U" g+ H$ H0 m6 _- |2 R# r
truffle compile; q- l" x- J2 w
truffle migrate; y$ R/ |/ N' H+ H
如果你的智能合约没有问题的话,现在你的以太坊智能合约应该已经部署到你用来测试的ganache中去了。
这里可能遇到的问题是:默认的truffle生成的项目,测试用的ganache的地址和端口会被设置成http://localhost:7545,而实际上执行ganache-cli之后的服务端口是http://localhost:8545,需要在truffle.js中修改一下:
module.exports = {
// See ! r8 g) S& D b; t
// for more about customizing your Truffle configuration!
networks: {6 S# Y6 ^6 Z$ C: A! m5 Y# C
development: {# R/ R4 J- }: L$ c; c5 V- p
host: “127.0.0.1”,. S, g: g5 L7 F% ], L
port: 7545, //改成8545) ?+ @7 L* \. S9 A) T! w; P( N
network_id: “*” // Match any network id
}
}
};, J: d+ q# Y" s& s% U
8、编写前端的js代码跟以太坊交互
通常需要如下的辅助js库:
R9 Z. K8 D' w: Q2 v8 T
在此基础上,编辑你自己业务逻辑的js,通常命名为app.js,app.js的框架如下:
App = {
web3Provider: null,8 J& x! O2 p$ J/ Q1 b3 i+ j
contracts: {},0 X5 R: D6 G' {
init: function() {3 L3 F9 z4 n, [. {6 M9 c' M" y
//初始化你自己的页面、变量等
return App.initWeb3();
},8 x. N6 p9 Z8 E4 M( I* \6 b
initWeb3: function() {9 T! ~8 C! G& Y3 g2 o+ C
/*
* 初始化web3:( }0 i% r! Q0 x) b3 z' [8 g, _9 l
*/0 Q# l& q: V1 r
if (typeof web3 !== ‘undefined’){$ V" m1 Q1 D( \; w! G) Z7 d& B
//如果你的浏览器安装了MetaMask的钱包插件,那么插件会赋值web3.currentProvider8 P* w, D' k4 j G m Y1 G
App.web3Provider = web3.currentProvider;
}. F0 f1 s8 K6 `# v1 Q* J! h( G4 F
else9 N4 i G2 i. C0 [4 I* s% C
{
//如果没装插件,那么创建一个基于Http的provider,这里用到的就是用ganache-cli启动所提供的rpc服务,因为ganache-cli启动的时候绑定的是localhost,所以测试所使用的浏览器也要在本机。(如何让ganache-cli绑定其他地址我还没找到)
App.web3Provider = new Web3.providers.HttpProvider(‘http://localhost:8545’);8 ~7 \0 A3 p( }$ ]. A( y& R
}
web3 = new Web3(App.web3Provider);
return App.initContract();% I% c" E4 i L
},5 W# n* i. D) S3 W' O/ V4 a
initContract: function() {
/*
* 初始化智能合约,实际上就是为你的智能合约创建一个对应的js对象,方便后续调用
*/9 d/ ]5 ?$ m: t6 T% D
//通常的做法是使用你的智能合约编译之后生成的abi的json文件,该文件在用truffle compile之后,生成在build/contracts/目录下,因为我用了一个Division.sol,所以用Division.json,你可以根据你的实际情况来写。9 @; L. V0 T( i- k/ f, a+ A, w7 N
$.getJSON(‘Division.json‘, function(data) {* M! y4 [) ~( ~* r" L/ m, N
var DivisionArtifact = data;
App.contracts.Division = TruffleContract(DivisionArtifact);
App.contracts.Division.setProvider(App.web3Provider);3 q( ~4 n8 _" g( _# z
//用智能合约中的信息来更新你的web应用,App.refreshPlots()是我例子中获取智能合约中信息并更新UI的函数
return App.refreshPlots();
});/ B" @ Q- I1 S
return App.bindEvents();
},# \, T9 c+ F0 O" `! n
bindEvents: function() {3 V8 \, a0 w6 B0 S6 h E& y: ]
/*. e2 E8 B. z1 m' N7 ]' ]. Y
* 事件绑定,这个可以根据你的UI来设置,例子中就是绑定一个button的点击操作
*/) h) s1 p! t2 v& |6 t# m# I$ O
$(document).on(‘click’, ‘.btn-adopt’, App.handlePlot);
},1 N; s/ K f3 J! L
refreshPlots: function(plots, account) {
/*6 P Z: R, [" K: y: t# ~6 l
* 这个函数就是上面initContract中调用的用智能合约更新页面2 f, M! X* a( u8 l7 k
*/
//继续使用division这个智能合约做例子! @/ S* m* e. m; P* |5 c
var divisionInstance;( }1 d, q0 j1 z8 D" b7 }
App.contracts.Division.deployed().then(function(instance){9 t. X& i+ b* X9 D7 y ]) L l
divisionInstance = instance;. N, A/ }2 ]2 G @) o! {9 p2 W* f. M
//getGenPlots是Division的这个智能合约的一个查询函数(不需要gas),需要3个参数; B* c5 z* g$ o i! |) ?
return divisionInstance.getGenPlots(0,0,2);
}).then(function(results){ g5 w# _2 }$ D4 ]
//注意:这个地方有点意思,我原先理解也有问题,后来打印输出才搞明白
//智能合约返回的多个结果变量在这里就是一个results数组, o+ i. N$ y/ Z; h+ `
//数组的每个成员就是智能合约返回的每个结果变量9 q `$ X: \: b1 D2 S; ~2 [
//以getGenPlots为例,Division.json中定义如下:
/*"name": "getGenPlots",4 Q, [4 S5 M$ u# ~6 m; e4 }2 m
"outputs": [
{: M3 R8 U6 G B( Z- D
"name": "",
"type": "uint64[]"
},9 v6 q( j+ f( O: h" n1 m* C, I
{1 m$ o9 |+ x& G* F1 n
"name": "",
"type": "address[]"
},$ ? A7 P5 C A8 U3 K. x/ U
{ o6 Z) k% V$ _
"name": "",
"type": "uint256[]"- m# p+ ~1 r) G* \0 k: P2 q. l
},) A4 I: \; n; W9 d Q, `
{( g+ H$ H* ]9 }: |2 ^ V
"name": "", `9 Q6 p; F$ a; l. C
"type": "uint8[]"8 z- G3 J2 g! }+ N2 G5 Y' s0 m
}
],* |! [. H- B+ i5 a! g8 j0 F
"payable": false,/ T W& l4 e9 L9 ?
"stateMutability": "view",
"type": "function"
*/
//那么:results[0]是uint64[]
// results[1]是address[]...
console.log(results[0].length);- f( ]. r) z, }$ b
}).catch(function(err){+ @) P/ r A4 W# S6 g9 k
console.log(err.message);
});
},
handlePlot: function(event) {4 ~) U/ u, S1 ^3 r* c
/*6 f v% X0 w9 |4 o. w# S7 w% {* ^
* 这个函数就是上面bindEvents中调用的响应函数,演示要花eth的函数调用9 F# m( C' M; X* X! p4 i' h/ o
*/
event.preventDefault();0 w% m5 B/ {) c6 \
//从event中获取参数,这是jquery的东西,跟web3无关
var plotId = parseInt($(event.target).data('id'));
var divisionInstance;( p3 o, b6 v+ @# l
//获取以太坊帐号信息5 a6 n9 R- D7 `% D* P
web3.eth.getAccounts(function(error,accounts){2 P1 i+ {- r# f" s9 q9 e1 z3 A! `- B
if(error)
{/ O" _5 c7 w1 J9 ?; ~* b
console.log(error);
}2 H( B6 z7 M4 s
//我随便取帐号列表里的第3个帐号。. S5 M* z) S3 U2 R" b. u! M
//因为我们连的是ganache-cli的rpc模拟服务,0 d) y: u1 H7 x
//其中给我们预制了几个有eth的帐号. [, K8 M3 X1 ?: ?/ C" `
//如果安装了MetaMask插件,应该获得的就是MetaMask里的帐号6 S8 v. b( a: O& m. b
var account = accounts[2];+ k" c0 N/ K3 o6 }; m1 J8 q
App.contracts.Division.deployed().then(function(instance){. j% W8 @6 y& U! i1 x0 X8 D
divisionInstance = instance;0 l$ B: x& a5 I4 Q& s* N
//调用智能合约的buyPlot函数,该函数需要2个参数,* F. B1 g+ [; N
//后面的{}中的内容跟发起以太坊交易的时候所带的默认值。
//from: 使用哪个以太坊帐号
//value: 要使用的eth数量,以wei为单位(1eth=10^18wei)
//gas: 矿工费,以wei为单位) @9 [" |5 }+ Y3 H& m6 k4 X( I$ I
return divisionInstance.buyPlot(plotId, 3, {from: account, value: 100000000000000000, gas:6000000});( f( m: y3 Q1 d
}).then(function(result){
//返回结果后重新更新UI" \9 i, ^" X1 Z( o( b4 S7 N: b
return App.refreshPlots();# N S+ m$ D$ x
}).catch(function(error){: N6 u; [9 N0 \5 d2 h5 m" C
console.log(error.message);0 R' X& C7 [9 u( E4 b9 ^- G5 X
});4 x% s+ [# ]/ z8 O) N+ F! U
});
}' x* }+ K5 U" }, x
};( w. X! H0 w% }6 U
测试你的基于Web的DApp是否正常,可以使用nodejs里面提供的lite-server模块来当简单的webserver来用。
安装lite-server,在你的truffle项目目录下,执行:
npm install lite-server
安装完之后会在项目目录下声称node_modules目录,lite-server以及依赖的模块都在该目录下了。5 O" x5 L* G1 S# d& V- Z4 ?4 M
要运行lite-server,还需要编写项目目录下的package.json文件:$ W! F& g% Z9 x/ i
{
"name": "项目名称",6 r) P8 i0 g3 h5 I
"version": "1.0.0",. T) X% L" I) }9 F
"description": "",
"main": "truffle.js",
"directories": {
"test": "test". b8 j( c$ k/ b( @9 r
},: j8 t( a* H3 h1 ]% H9 H8 r
"scripts": {; Q" ^+ N4 V: F( T; |* {& Z
"dev": "lite-server",
"test": "echo \"Error: no test specified\" && exit 1". j0 S: f6 Y1 J( _0 R
},- x2 a. y! Q6 j9 u7 M
"author": "",1 k; T+ X/ v6 @- [3 X1 j
"license": "ISC",
"devDependencies": {
"lite-server": "^2.3.0"
},
"dependencies": {2 Q: M! R( n( v# o+ [- ^% x
"liteserver": "^0.3.0"" S w/ D2 B- ~( }; K( b! [( ]3 H
}& b. ^# P9 x* [8 v; S* q
}
还需要编写bs-config.json来配置一下lite-server
{
"server": {0 o/ x0 }3 Z- b- R
"baseDir": ["./src", "./build/contracts"]6 y% g' ?" D3 i2 d' P' S4 [
}. S% S3 _. X- N: U& t
}
baseDir是用来设置lite-server所提供的web服务的文件路径的。这个设置表明你可以把你上面写的app.js,依赖的各种js放到./src目录下,然后写index.html,把app.js等集成进去,就大功告成了。4 a+ I2 Y7 c s4 B+ R; s) D3 `
启动lite-server,执行:' ?* R$ ]+ d5 g
npm run dev% ~6 h" [ n/ _) i/ r* z& W% k
不仅启动了lite-server,而且会启动一个浏览器去打开页面。! K8 U& [5 s0 E; l/ e/ N, O
本文的目的是为了澄清一下写DApp的各项工具之间的架构关系,帮助技术人员更快的理解和实现自己的项目。% r, n7 F9 r8 w& u' g
具体的例子网上多如牛毛,就不去写业务的具体代码了。
成为第一个吐槽的人