如何使用Ethers.js在以太坊上構(gòu)建出完整的DApps

你在以太坊上構(gòu)建DApps時(shí)，你很可能最常使用Web3.js來(lái)構(gòu)建javascript前端。Ethers.js是一個(gè)輕量級(jí)的JavaScript庫(kù)，可以用來(lái)替代Web3.js來(lái)構(gòu)建javascript前端并與以太坊區(qū)塊鏈進(jìn)行交互。這篇文章/教程中，我將展示如何使用Ethers.js構(gòu)建一個(gè)簡(jiǎn)單的DApp。我希望這有助于您評(píng)估并開始使用Ethers.js進(jìn)行下一個(gè)項(xiàng)目。

在本教程中，我們將創(chuàng)建一個(gè)簡(jiǎn)單的Voting dapp。Solidity合同將是相同的，但我們將使用Ethers.js而不是Web3.js作為前端。申請(qǐng)非常簡(jiǎn)單，只需初始化一組候選人，讓任何人投票給那些候選人并顯示每位候選人收到的總票數(shù)。

本教程的目標(biāo)是：

1.設(shè)置開發(fā)環(huán)境。

2.學(xué)習(xí)編寫合同、編譯合同和在開發(fā)環(huán)境中部署合同的過程。

3.通過nodejs控制臺(tái)使用ethers.js與合同交互。

4.在簡(jiǎn)單的網(wǎng)頁(yè)中使用ethers.js與合同互動(dòng)，以顯示投票計(jì)數(shù)并通過頁(yè)面對(duì)候選人進(jìn)行投票。

這就是我們將要構(gòu)建的應(yīng)用程序的流程圖。

搭建開發(fā)環(huán)境

我們將使用名為ganache的內(nèi)存區(qū)塊鏈（將其視為區(qū)塊鏈模擬器），而不是針對(duì)實(shí)時(shí)區(qū)塊鏈開發(fā)應(yīng)用程序。 下面是在MacOS上安裝Ganache、EthersJS、Solc（編譯我們的合同）和啟動(dòng)測(cè)試區(qū)塊鏈的步驟。同樣的指令也適用于Linux。

zastrin@macbook$ brew update

zastrin@macbook$ brew install nodejs

zastrin@macbook$ mkdir -p ethereum_voTIng_dapp/chapter1-ethersjs

zastrin@macbook$ cd ethereum_voTIng_dapp/chapter1-ethersjs

zastrin@macbook$ npm install ganache-cli ethers solc@0.5.3

zastrin@macbook$ node_modules/.bin/ganache-cli

Ganache CLI v6.0.3 （ganache-core： 2.0.2）

Available Accounts

==================

（0） 0x5c252a0c0475f9711b56ab160a1999729eccce97

（1） 0x353d310bed379b2d1df3b727645e200997016ba3

（2） 0xa3ddc09b5e49d654a43e161cae3f865261cabd23

（3） 0xa8a188c6d97ec8cf905cc1dd1cd318e887249ec5

（4） 0xc0aa5f8b79db71335dacc7cd116f357d7ecd2798

（5） 0xda695959ff85f0581ca924e549567390a0034058

（6） 0xd4ee63452555a87048dcfe2a039208d113323790

（7） 0xc60c8a7b752d38e35e0359e25a2e0f6692b10d14

（8） 0xba7ec95286334e8634e89760fab8d2ec1226bf42

（9） 0x208e02303fe29be3698732e92ca32b88d80a2d36

Private Keys

==================

（0） a6de9563d3db157ed9926a993559dc177be74a23fd88ff5776ff0505d21fed2b

（1） 17f71d31360fbafbc90cad906723430e9694daed3c24e1e9e186b4e3ccf4d603

（2） ad2b90ce116945c11eaf081f60976d5d1d52f721e659887fcebce5c81ee6ce99

（3） 68e2288df55cbc3a13a2953508c8e0457e1e71cd8ae62f0c78c3a5c929f35430

（4） 9753b05bd606e2ffc65a190420524f2efc8b16edb8489e734a607f589f0b67a8

（5） 6e8e8c468cf75fd4de0406a1a32819036b9fa64163e8be5bb6f7914ac71251cc

（6） c287c82e2040d271b9a4e071190715d40c0b861eb248d5a671874f3ca6d978a9

（7） cec41ef9ccf6cb3007c759bf3fce8ca485239af1092065aa52b703fd04803c9d

（8） c890580206f0bbea67542246d09ab4bef7eeaa22c3448dcb7253ac2414a5362a

（9） eb8841a5ae34ff3f4248586e73fcb274a7f5dd2dc07b352d2c4b71132b3c73f

HD Wallet

==================

Mnemonic： cancel better shock lady capable main crunch alcohol derive alarm duck umbrella

Base HD Path： m/44‘/60’/0‘/0/{account_index}

Listening on localhost:8545

請(qǐng)注意，GANACHE CLI創(chuàng)建了10個(gè)要自動(dòng)使用的測(cè)試帳戶。這些帳戶預(yù)裝了100（測(cè)試）以太。

簡(jiǎn)單投票合同

我們將使用可靠性編程語(yǔ)言來(lái)編寫我們的合同。如果您熟悉面向?qū)ο缶幊蹋敲磳W(xué)習(xí)編寫可靠性合同應(yīng)該是輕而易舉的。我們將使用一個(gè)構(gòu)造函數(shù)編寫一個(gè)智能合約（將合同視為您最喜歡的OOP語(yǔ)言中的類），該構(gòu)造函數(shù)初始化一組候選項(xiàng)。我們將編寫2個(gè)方法，一個(gè)用于返回候選人收到的總票數(shù)，另一個(gè)用于增加候選人的投票數(shù)。

注意：在將合同部署到區(qū)塊鏈時(shí)，只調(diào)用一次構(gòu)造函數(shù)。與Web代碼中每次部署代碼都覆蓋舊代碼的情況不同，區(qū)塊鏈中部署的代碼是不可變的。即如果您更新合同并再次部署，舊合同仍將保留區(qū)塊鏈以及存儲(chǔ)在其中的所有數(shù)據(jù)，新部署將創(chuàng)建合同的新實(shí)例。

下面是帶內(nèi)聯(lián)注釋解釋的投票合同代碼：

pragma solidity 》=0.4.0 《0.6.0;

// We have to specify what version of compiler this code will compile with

contract VoTIng {

/* mapping field below is equivalent to an associaTIve array or hash.

The key of the mapping is candidate name stored as type bytes32 and value is

an unsigned integer to store the vote count

*/

mapping （bytes32 =》 uint256） public votesReceived;

/* Solidity doesn’t let you pass in an array of strings in the constructor （yet）。

We will use an array of bytes32 instead to store the list of candidates

*/

bytes32［］ public candidateList;

/* This is the constructor which will be called once when you

deploy the contract to the blockchain. When we deploy the contract，

we will pass an array of candidates who will be contesting in the election

*/

constructor（bytes32［］ memory candidateNames） public {

candidateList = candidateNames;

}

// This function returns the total votes a candidate has received so far

function totalVotesFor（bytes32 candidate） view public returns （uint256） {

require（validCandidate（candidate））;

return votesReceived［candidate］;

}

// This function increments the vote count for the specified candidate. This

// is equivalent to casting a vote

function voteForCandidate（bytes32 candidate） public {

require（validCandidate（candidate））;

votesReceived［candidate］ += 1;

}

function validCandidate（bytes32 candidate） view public returns （bool） {

for（uint i = 0; i 《 candidateList.length; i++） {

if （candidateList［i］ == candidate） {

return true;

}

}

return false;

}

}

將以上代碼復(fù)制到ethereum_voting_dapp / chapter1-ethersjs目錄中名為Voting.sol的文件中。 現(xiàn)在讓我們編譯代碼并將其部署到ganache區(qū)塊鏈。 按照以下命令編譯合同。

zastrin@macbook$ node_modules/.bin/solcjs — bin — abi Voting.sol

zastrin@macbook$ ls

Voting.sol Voting_sol_Voting.abi Voting_sol_Voting.bin

當(dāng)您使用上述命令成功編譯代碼時(shí)，編譯器輸出2個(gè)文件，這些文件對(duì)于理解：

1. Voting_sol_Voting.bin：這是編譯Voting.sol中的源代碼時(shí)得到的字節(jié)碼。 這是將部署到區(qū)塊鏈的代碼。

2. Voting_sol_Voting.abi：這是合同的接口或模板（稱為abi），它告訴合同用戶合同中有哪些方法可用。 每當(dāng)您將來(lái)必須與合同進(jìn)行交互時(shí)，您將需要此abi定義。

我們現(xiàn)在將使用ethersjs庫(kù)來(lái)部署我們的應(yīng)用程序并與之交互。

首先，在終端中運(yùn)行‘node’命令以進(jìn)入節(jié)點(diǎn)控制臺(tái)并初始化ethers對(duì)象。 下面的所有代碼片段都需要在節(jié)點(diǎn)控制臺(tái)中輸入。 要編譯合同，請(qǐng)將字節(jié)碼和abi從文件系統(tǒng)加載到如下所示的字符串中

zastrin@macbook$ node

》 ethers = require（‘ethers’）

》 bytecode = fs.readFileSync（‘Voting_sol_Voting.bin’）.toString（）

》 abi = JSON.parse（fs.readFileSync（‘Voting_sol_Voting.abi’）.toString（））

接下來(lái)是初始化程序，它是連接到區(qū)塊鏈的通用接口。 由于我們?cè)诒镜剡\(yùn)行區(qū)塊鏈，我們將使用JsonRPCProvider連接到它。 如果您想連接到生產(chǎn)的區(qū)塊鏈上，您還有許多其他提供選項(xiàng)。 連接后，您可以通過查詢ganache并列出所有帳戶來(lái)測(cè)試連接。 在nodejs控制臺(tái)中運(yùn)行以下命令應(yīng)該列出10個(gè)帳戶。

》 provider = new ethers.providers.JsonRpcProvider（）

》 provider.listAccounts（）.then（result =》 console.log（result））

下一步是初始化用于簽署事務(wù)的簽名者。 我們可以通過將索引傳遞給getSigner來(lái)選擇我們想要使用的帳戶（我們?cè)谠O(shè)置中有10個(gè)帳戶ganache），如下所示。 錢包初始化后，創(chuàng)建合同庫(kù)并按所示部署合同。 deploy函數(shù)接受一組傳遞給合同構(gòu)造函數(shù)的參數(shù)。 在我們的案例中，我們傳遞候選人的姓名。 我們必須顯式地將字符串轉(zhuǎn)換為bytes32，因?yàn)槲覀兊闹悄芎霞s將bytes32作為參數(shù)。

》 signer = provider.getSigner（0）

》 factory = new ethers.ContractFactory（abi， bytecode， signer）

》 contract = null

》 factory.deploy（［ethers.utils.formatBytes32String（‘Rama’）， ethers.utils.formatBytes32String（‘Nick’）， ethers.utils.formatBytes32String（‘Jose’）］）.then（? =》 { contract = c}）

如果您成功部署了合同，則您的合同對(duì)象應(yīng)具有已部署合同的所有詳細(xì)信息。 區(qū)塊鏈上部署了數(shù)十萬(wàn)份合同。 那么，你如何識(shí)別區(qū)塊鏈中的合同？ 答案：contract.address。 當(dāng)您必須與合同進(jìn)行交互時(shí)，您需要我們之前談到的這個(gè)部署地址和abi定義。

在nodejs控制臺(tái)中與合同交互

》 contract.totalVotesFor（ethers.utils.formatBytes32String（‘Rama’））。

then（（f） =》 console.log（f.toNumber（）））

》 contract.voteForCandidate（ethers.utils.formatBytes32String（‘Rama’））。

then（（f） =》 console.log（f））

》 contract.totalVotesFor（ethers.utils.formatBytes32String（‘Rama’））。

then（（f） =》 console.log（f.toNumber（）））

在節(jié)點(diǎn)控制臺(tái)中嘗試上述命令，您應(yīng)該看到投票計(jì)數(shù)增量。 每次投票給候選人時(shí)，都會(huì)得到一個(gè)交易ID：例如：

‘0xdedc7ae544c3dde74ab5a0b07422c5a51b5240603d31074f5b75c0ebc786bf53’。 此事務(wù)ID是此事務(wù)發(fā)生的證據(jù)，您可以在將來(lái)的任何時(shí)間再參考此事務(wù)。 此事務(wù)是不可變的。

連接到區(qū)塊鏈的投票網(wǎng)頁(yè)

現(xiàn)在大部分工作已經(jīng)完成，我們現(xiàn)在要做的就是創(chuàng)建一個(gè)帶有候選名稱的簡(jiǎn)單html文件，并在js文件中調(diào)用投票命令（我們已在nodejs控制臺(tái)中嘗試和測(cè)試過）。 您可以在下面找到html代碼和js文件。 將它們都放在ethereum_voting_dapp / chapter1-ethersjs目錄中，然后在瀏覽器中打開index.html。

《！DOCTYPE html》

《html》

《head》

《title》Hello World DApp《/title》

《link href=‘https://fonts.googleapis.com/css？family=Open Sans:400，700’ rel=‘stylesheet’ type=‘text/css’》

《link href=‘https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css’ rel=‘stylesheet’ type=‘text/css’》

《/head》

《body class=“container”》

《h1》A Simple Hello World Voting Application《/h1》

《div class=“table-responsive”》

《table class=“table table-bordered”》

《thead》

《tr》

《th》Candidate《/th》

《th》Votes《/th》

《/tr》

《/thead》

《tbody》

《tr》

《td》Rama《/td》

《td id=“candidate-1”》《/td》

《/tr》

《tr》

《td》Nick《/td》

《td id=“candidate-2”》《/td》

《/tr》

《tr》

《td》Jose《/td》

《td id=“candidate-3”》《/td》

《/tr》

《/tbody》

《/table》

《/div》

《input type=“text” id=“candidate” /》

《a href=“#” onclick=“voteForCandidate（）” class=“btn btn-primary”》Vote《/a》

《/body》

《script charset=“utf-8”

src=“https://cdn.ethers.io/scripts/ethers-v4.min.js”

type=“text/javascript”》《/script》

《script src=“https://code.jquery.com/jquery-3.1.1.slim.min.js”》《/script》

《script src=“。/index.js”》《/script》

《/html》

index.html

abi = JSON.parse（‘［{“constant”：true，“inputs”：［{“name”：“candidate”，“type”：“bytes32”}］，“name”：“totalVotesFor”，“outputs”：［{“name”：“”，“type”：“uint8”}］，“payable”：false，“stateMutability”：“view”，“type”：“function”}，{“constant”：true，“inputs”：［{“name”：“candidate”，“type”：“bytes32”}］，“name”：“validCandidate”，“outputs”：［{“name”：“”，“type”：“bool”}］，“payable”：false，“stateMutability”：“view”，“type”：“function”}，{“constant”：true，“inputs”：［{“name”：“”，“type”：“bytes32”}］，“name”：“votesReceived”，“outputs”：［{“name”：“”，“type”：“uint8”}］，“payable”：false，“stateMutability”：“view”，“type”：“function”}，{“constant”：true，“inputs”：［{“name”：“”，“type”：“uint256”}］，“name”：“candidateList”，“outputs”：［{“name”：“”，“type”：“bytes32”}］，“payable”：false，“stateMutability”：“view”，“type”：“function”}，{“constant”：false，“inputs”：［{“name”：“candidate”，“type”：“bytes32”}］，“name”：“voteForCandidate”，“outputs”：［］，“payable”：false，“stateMutability”：“nonpayable”，“type”：“function”}，{“inputs”：［{“name”：“candidateNames”，“type”：“bytes32［］”}］，“payable”：false，“stateMutability”：“nonpayable”，“type”：“constructor”}］’）

provider = new ethers.providers.JsonRpcProvider（）

signer = provider.getSigner（0）;

contract = new ethers.Contract（‘0x5735731eEbDA5BE1eEe9f0b119B9374a63b0f507’， abi， signer）

candidates = {“Rama”： “candidate-1”， “Nick”： “candidate-2”， “Jose”： “candidate-3”}

function voteForCandidate（candidate） {

candidateName = $（“#candidate”）.val（）;

console.log（candidateName）;

contract.voteForCandidate（ethers.utils.formatBytes32String（candidateName））.then（（f） =》 {

let div_id = candidates［candidateName］;

contract.totalVotesFor（ethers.utils.formatBytes32String（candidateName））.then（（f） =》 {

$（“#” + div_id）.html（f）;

}）

}）;

}

$（document）.ready（function（） {

candidateNames = Object.keys（candidates）;

for（var i=0; i《candidateNames.length; i++） {

let name = candidateNames［i］;

contract.totalVotesFor（ethers.utils.formatBytes32String（name））.then（（f） =》 {

$（“#” + candidates［name］）.html（f）;

}）

}

}）;

index.js

您現(xiàn)在應(yīng)該看到投票計(jì)數(shù)，您還應(yīng)該能夠投票給候選人。

如果您使用Metamask之類的錢包，則需要使用Web3提供程序而不是之前使用的JsonRPCProvider。 要做到這一點(diǎn)，只需將index.js中的提供程序更改為：

provider = new ethers.providers.Web3Provider（web3.currentProvider）;

如果您想通過Metamask進(jìn)行交互，則不能再打開index.html并在瀏覽器中進(jìn)行交互。 您必須通過服務(wù)器來(lái)服務(wù)該文件。 所以安裝一個(gè)簡(jiǎn)單的網(wǎng)絡(luò)服務(wù)器，然后如下所示

zastrin@macbook$ npm install http-server

zastrin@macbook$ http-server

您現(xiàn)在可以轉(zhuǎn)到localhost：8080并與您的應(yīng)用程序進(jìn)行交互。 下面是一個(gè)快速演示，其中包括將測(cè)試以太網(wǎng)帳戶加載到元掩碼中。

我希望你能夠順利搭建應(yīng)用程序并正常運(yùn)行，好，教程就到此結(jié)束。