开发基于以太坊智能合约的DApp
星火车品
发表于 2022-12-18 02:06:40
119
0
0
以太坊节点本来提供了rpc的访问方式,但是因为以太坊节点的地址不确定,并且DApp需要访问钱包,所以用web3.js直接访问以太坊节点的rpc服务是不现实的。
ganache-cli模拟了一个以太坊的测试节点并提供对外的rpc访问方式(就是例子里经常说的http://localhost:7545或者http://localhost:8545)。同时在其中内置了M个以太坊帐号,用于测试。& t3 [* h8 C6 N# h
MetaMask是一个以太坊的网络钱包插件,它也提供了web3的访问方式。而且可以通过这个插件指定后面的以太坊节点是什么。因为MetaMask是个钱包插件,所以解决了DApp中的支付问题。所以现在的DApp都依赖它。
有一个以太坊教程,是在线学习的,大家可以去看看,如果自己本机上搞,开发DApp的基本过程都是一样的如下:; v9 }: n Y/ V' a" h* A4 `: P
1、安装NodeJS) P) E3 M3 n: C# \) M+ a
2、安装truffle:一个开发DApp的开发框架
nmp install -g truffle
3、安装Ganache(原来用testrpc):在内存中模拟以太坊运行并对外提供rpc服务。7 F5 x5 I& D7 }% ~! y
npm install -g ganache-cli
4、运行ganache-cli
ganache-cli
5、生成一个DApp的项目: a) s# P* H5 X) f2 G$ r9 i6 k4 U+ u
mkdir project1
truffle init+ \9 U9 z- t3 G8 ]" O6 h
如果想用truffle中的某个例子,可以用
truffle unbox pet-shop
“pet-shop”是例子名称
6、编写智能合约
具体如何用solidity编写智能合约可参考各种文章,这里不再重复。4 o( [# V5 }. u7 v' `) a: [* e0 ]
编写好的智能合约的Project1.sol文件放到contracts目录下
7、编译和部署智能合约
在migrations目录下创建文件2_deploy_contracts.js:
var Project1 = artifacts.require("Project1");
module.exports = function(deployer) {
deployer.deploy(Project1);
};
之后执行:; G# S. N7 T* {; U& o
truffle compile" a" N: {0 O3 M8 M8 J& q
truffle migrate
如果你的智能合约没有问题的话,现在你的以太坊智能合约应该已经部署到你用来测试的ganache中去了。
这里可能遇到的问题是:默认的truffle生成的项目,测试用的ganache的地址和端口会被设置成http://localhost:7545,而实际上执行ganache-cli之后的服务端口是http://localhost:8545,需要在truffle.js中修改一下:+ b4 @1 O8 k6 Y+ w
module.exports = {
// See ( E8 G) }9 a% A% @' {4 n. u
// for more about customizing your Truffle configuration!, Q- j& z: y8 Q$ { s* @9 U
networks: {
development: {
host: “127.0.0.1”,
port: 7545, //改成85458 f7 [/ W, u. T+ {3 k
network_id: “*” // Match any network id, I2 v3 j! z- \% q1 G. V" }. u' ~
}/ P3 Q2 k* c& N9 R/ X& o
}
};
8、编写前端的js代码跟以太坊交互7 p% l. w% ]5 Y/ t
通常需要如下的辅助js库:
在此基础上,编辑你自己业务逻辑的js,通常命名为app.js,app.js的框架如下:1 i7 z& S/ n! j# |$ X. Z: J& f6 O
App = {) Z, @6 @+ S7 ^6 P* X3 Z. e0 q
web3Provider: null,6 H0 c( ^! V1 Z% P; s- Z0 P& X4 |
contracts: {},
init: function() {
//初始化你自己的页面、变量等) y/ L: H7 K, W$ N* T
return App.initWeb3();" F9 i* ]8 q/ V; w9 x n
},
initWeb3: function() {. F i( ~2 ?# z3 h$ V
/*
* 初始化web3:! Q6 O6 k. J: a3 j
*/0 f' Y Q* @" O* V
if (typeof web3 !== ‘undefined’){3 Q0 ~( Q+ Z, {$ x6 ?
//如果你的浏览器安装了MetaMask的钱包插件,那么插件会赋值web3.currentProvider
App.web3Provider = web3.currentProvider;
}# g3 _- q$ g, ?5 s0 O
else$ E7 K1 t; O7 G$ Z+ }( p
{3 W2 |) r$ @1 H& t6 q H- }! g
//如果没装插件,那么创建一个基于Http的provider,这里用到的就是用ganache-cli启动所提供的rpc服务,因为ganache-cli启动的时候绑定的是localhost,所以测试所使用的浏览器也要在本机。(如何让ganache-cli绑定其他地址我还没找到)" E2 O. {( T% V9 i1 R- N" R
App.web3Provider = new Web3.providers.HttpProvider(‘http://localhost:8545’);3 W# u! s4 d, E8 v
}, N& x4 \/ `/ O |; R$ G! [
web3 = new Web3(App.web3Provider);' T: r6 ?) M2 C# \; w, f
return App.initContract();2 v- s/ N8 f+ k X" R/ z
},; v, l: l6 c/ E4 h9 ~
initContract: function() {
/*
* 初始化智能合约,实际上就是为你的智能合约创建一个对应的js对象,方便后续调用) }3 p Q0 {/ y# y8 @9 ]# L2 D
*/$ Y" t! C7 ]4 ]+ q
//通常的做法是使用你的智能合约编译之后生成的abi的json文件,该文件在用truffle compile之后,生成在build/contracts/目录下,因为我用了一个Division.sol,所以用Division.json,你可以根据你的实际情况来写。" E9 ~7 r+ U, P: X
$.getJSON(‘Division.json‘, function(data) {
var DivisionArtifact = data;
App.contracts.Division = TruffleContract(DivisionArtifact);
App.contracts.Division.setProvider(App.web3Provider);* \- n [4 H1 z+ r1 B
//用智能合约中的信息来更新你的web应用,App.refreshPlots()是我例子中获取智能合约中信息并更新UI的函数 D) H) i+ B6 M U# `4 X4 E
return App.refreshPlots();7 C! s. w# ^0 P: N: h/ m
});
return App.bindEvents();4 }: L) N) W$ ~/ `& l
},9 }0 a9 ^9 y3 ?
bindEvents: function() {
/** X: g% l) w, ^' T* F4 T7 U7 C- b) |
* 事件绑定,这个可以根据你的UI来设置,例子中就是绑定一个button的点击操作( {$ j2 i5 P2 ~6 N- k, H
*/
$(document).on(‘click’, ‘.btn-adopt’, App.handlePlot);
},
refreshPlots: function(plots, account) { N- m0 \ z2 Z# I1 p# U
/*
* 这个函数就是上面initContract中调用的用智能合约更新页面
*/
//继续使用division这个智能合约做例子
var divisionInstance;
App.contracts.Division.deployed().then(function(instance){
divisionInstance = instance;- C+ ^; \4 N1 ^ y- V5 t
//getGenPlots是Division的这个智能合约的一个查询函数(不需要gas),需要3个参数
return divisionInstance.getGenPlots(0,0,2);
}).then(function(results){
//注意:这个地方有点意思,我原先理解也有问题,后来打印输出才搞明白
//智能合约返回的多个结果变量在这里就是一个results数组
//数组的每个成员就是智能合约返回的每个结果变量
//以getGenPlots为例,Division.json中定义如下:
/*"name": "getGenPlots",, f. P/ ?9 }$ J8 e% O- o! s2 U
"outputs": [
{: D+ Q, V: m1 {; h3 o' A$ t
"name": "",
"type": "uint64[]"8 ?0 }, |6 o- }0 H9 w. }/ n4 |
},
{ P2 u1 B2 z- `1 _
"name": "",
"type": "address[]"' |2 r2 Y ?1 O+ s5 c) W( I
},: K& A V/ m+ U) c" Q
{
"name": "",
"type": "uint256[]"5 [6 q) T' j' q2 D$ ?
},. ]) n- v( ?% I T
{
"name": "",9 D, @. J9 n. ]2 T+ O, g- c
"type": "uint8[]"$ D- X/ {5 C8 v. X2 w- b% a
}
],
"payable": false,. f8 J9 d8 A3 F5 [; B( q0 z
"stateMutability": "view",3 S4 d W; e! A5 S& l
"type": "function". ?/ |; z) N# m( s; Z( X4 _
*/
//那么:results[0]是uint64[]& a5 x3 S7 L9 Y( h
// results[1]是address[]...- S( G1 P" U/ Q7 r, A$ O) N
console.log(results[0].length);
}).catch(function(err){4 t, W$ U' [) T q2 x& S
console.log(err.message);
});
},
handlePlot: function(event) {
/*6 p- _% z; Z& a! ]& Q8 U# _
* 这个函数就是上面bindEvents中调用的响应函数,演示要花eth的函数调用
*/
event.preventDefault();2 }1 \/ a. Q& V" R2 q4 e
//从event中获取参数,这是jquery的东西,跟web3无关
var plotId = parseInt($(event.target).data('id'));, c" B C. j2 Z4 T5 K
var divisionInstance;
//获取以太坊帐号信息
web3.eth.getAccounts(function(error,accounts){
if(error)
{. A. j' M1 [% |
console.log(error);! ?5 R; |) n4 C' _; T* h5 O
}
//我随便取帐号列表里的第3个帐号。4 v9 K: \; ?, z7 i5 j
//因为我们连的是ganache-cli的rpc模拟服务,4 h6 o+ R& h6 Y" c' }( ]+ z
//其中给我们预制了几个有eth的帐号; ?2 Y/ p* p$ x
//如果安装了MetaMask插件,应该获得的就是MetaMask里的帐号# O8 g- B( |" E; X9 x/ o( b; o3 @
var account = accounts[2];
App.contracts.Division.deployed().then(function(instance){9 x. [% |4 r2 y
divisionInstance = instance;, e# [4 t+ } i0 Q( y8 V5 O
//调用智能合约的buyPlot函数,该函数需要2个参数,( A6 l# [3 g5 @: _; s9 i- U
//后面的{}中的内容跟发起以太坊交易的时候所带的默认值。
//from: 使用哪个以太坊帐号1 Z' a. a" M( o1 b- S% C
//value: 要使用的eth数量,以wei为单位(1eth=10^18wei)+ m5 B1 {% J9 U& `! f
//gas: 矿工费,以wei为单位/ ?- l1 K/ d% f( F% ~; a
return divisionInstance.buyPlot(plotId, 3, {from: account, value: 100000000000000000, gas:6000000});
}).then(function(result){
//返回结果后重新更新UI
return App.refreshPlots();% u m% U, h6 H2 i0 `9 D; ^
}).catch(function(error){" p$ t7 H3 C5 T# } r+ y
console.log(error.message);
});6 M7 j# e7 K4 C! A, Y3 v/ v
});
}, n/ l, A6 I4 q w% ~, A! \) a, Z$ `
};0 e# @4 k: ^! x" N) |% i6 @
测试你的基于Web的DApp是否正常,可以使用nodejs里面提供的lite-server模块来当简单的webserver来用。3 J9 e8 H7 v7 |
安装lite-server,在你的truffle项目目录下,执行:
npm install lite-server
安装完之后会在项目目录下声称node_modules目录,lite-server以及依赖的模块都在该目录下了。& v. g. P, c6 ]+ F0 G' I
要运行lite-server,还需要编写项目目录下的package.json文件:( ]7 J& I) t! p5 S. C
{- s- \' U2 X, I& q% M. b
"name": "项目名称",5 F3 B' G C+ f# J( L2 ?2 _
"version": "1.0.0",
"description": "",
"main": "truffle.js",
"directories": {; U% F+ p0 K2 o+ s+ b
"test": "test"
},
"scripts": {
"dev": "lite-server",8 V# C/ ^% }9 Q8 {0 j
"test": "echo \"Error: no test specified\" && exit 1"7 F) F. y; l( p+ X" ~
},( F# r& ^, b- H' u% j) @
"author": "",! J, ~7 P" b9 W; y s/ I
"license": "ISC",
"devDependencies": {2 ~6 v- S2 A0 S( j
"lite-server": "^2.3.0"3 y- V# v, p- G* u' D7 M& E
},* U+ p) a1 Y' g3 K7 G! |6 F! l
"dependencies": {
"liteserver": "^0.3.0"
}
}
还需要编写bs-config.json来配置一下lite-server/ ?' {) H8 w5 d. v, H
{ M! k7 U5 p) V5 y! G
"server": {
"baseDir": ["./src", "./build/contracts"]
}
}9 i6 h% Q, H" g" |
baseDir是用来设置lite-server所提供的web服务的文件路径的。这个设置表明你可以把你上面写的app.js,依赖的各种js放到./src目录下,然后写index.html,把app.js等集成进去,就大功告成了。
启动lite-server,执行:
npm run dev4 H! z* O7 \, o8 @
不仅启动了lite-server,而且会启动一个浏览器去打开页面。
本文的目的是为了澄清一下写DApp的各项工具之间的架构关系,帮助技术人员更快的理解和实现自己的项目。; C/ _0 A. z9 r# o
具体的例子网上多如牛毛,就不去写业务的具体代码了。
成为第一个吐槽的人