Truffle Web3.js -开发、部署第一个去中心化应用(Dapp – 宠物商店

阅读本文前，你应该对以太坊、智能合约有所了解，如果你还不了解，建议你先看以太坊是什么除此之外，你最好还了解一些 HTML 及
JavaScript 知识。

修改后完整源代码: 下载 pet-shop-tutorial.zip
本文通过实例教大家来开发去中心化应用，应用效果如图：

从本文，你可以学习到：

搭建智能合约开发环境

创建 Truffle 项目

编写智能合约

编译和部署智能合约到区块链

如何通过 Web3 和智能合约交互

MetaMask 的使用

项目背景

Pete 有一个宠物店，有 16 只宠物，他想开发一个去中心化应用，让大家来领养宠物。
在 truffle box 中，已经提供了 pet-shop 的网站部分的代码，我们只需要编写合约及交互部分。

环境搭建

安装 Node
安装 Truffle ：npm install -g truffle
安装 Ganache

Ganache（或 Ganache CLI）已经取代了 testrpc

创建项目

> mkdir pet-shop-tutorial
> cd pet-shop-tutorial

2.使用 truffle unbox 创建项目

 > truffle unbox pet-shopDownloading...Unpacking...Setting up...Unbox successful. Sweet!Commands:Compile:        truffle compileMigrate:        truffle migrateTest contracts: truffle testRun dev server: npm run dev

这一步需要等待一会

项目目录结构

contracts/ 智能合约的文件夹，所有的智能合约文件都放置在这里，里面包含一个重要的合约 Migrations.sol（稍后再讲）
migrations/ 用来处理部署（迁移）智能合约，迁移是一个额外特别的合约用来保存合约的变化。
test/ 智能合约测试用例文件夹
truffle.js/ 配置文件

其他代码可以暂时不用管

编写智能合约

智能合约承担着分布式应用的后台逻辑和存储。智能合约使用 solidity 编写.

在 contracts 目录下，添加合约文件 Adoption.sol

pragma solidity ^0.5.0;contract Adoption {address[16] public adopters;  // 保存领养者的地址// 领养宠物function adopt(uint petId) public returns (uint) {require(petId >= 0 && petId <= 15);  // 确保id在数组长度内adopters[petId] = msg.sender;        // 保存调用这地址return petId;}// 返回领养者function getAdopters() public view returns (address[16] memory) {return adopters;}}

编译部署智能合约

Truffle 集成了一个开发者控制台，可用来生成一个开发链用来测试和部署智能合约。

编译

Solidity 是编译型语言，需要把可读的 Solidity 代码编译为 EVM 字节码才能运行。
dapp 的根目录 pet-shop-tutorial 下

> truffle compile

输出

Compiling ./contracts/Adoption.sol...
Writing artifacts to ./build/contracts

部署

编译之后，就可以部署到区块链上。
在 migrations 文件夹下已经有一个 1_initial_migration.js 部署脚本，用来部署 Migrations.sol 合约。
Migrations.sol 用来确保不会部署相同的合约。

现在我们来创建一个自己的部署脚本 2_deploy_contracts.js

var Adoption = artifacts.require("Adoption");module.exports = function(deployer) {deployer.deploy(Adoption);
};

在执行部署之前，需要确保有一个区块链运行，可以使用
Ganache 来开启一个私链来进行开发测试，默认会在 7545 端口上运行一个开发链。
Ganache 启动之后是这样：

接下来执行部署命令：

> truffle  migrate

执行后，有一下类似的输出，

Using network 'develop'.Running migration: 1_initial_migration.jsDeploying Migrations...... 0x3076b7dac65afc44ec51508bf6f2b6894f833f0f9560ecad2d6d41ed98a4679fMigrations: 0x8cdaf0cd259887258bc13a92c0a6da92698644c0
Saving successful migration to network...... 0xd7bc86d31bee32fa3988f1c1eabce403a1b5d570340a3a9cdba53a472ee8c956
Saving artifacts...
Running migration: 2_deploy_contracts.jsDeploying Adoption...... 0x2c6ab4471c225b5473f2079ee42ca1356007e51d5bb57eb80bfeb406acc35cd4Adoption: 0x345ca3e014aaf5dca488057592ee47305d9b3e10
Saving successful migration to network...... 0xf36163615f41ef7ed8f4a8f192149a0bf633fe1a2398ce001bf44c43dc7bdda0
Saving artifacts...

在打开的 Ganache 里可以看到区块链状态的变化，现在产生了多个新的区块。

这时说明已经智能合约已经部署好了。

测试

现在我们来测试一下智能合约，测试用例可以用 JavaScript 或 Solidity 来编写，这里使用 Solidity。

在 test 目录下新建一个 TestAdoption.sol，编写测试合约

pragma solidity ^0.5.0;import "truffle/Assert.sol";   // 引入的断言
import "truffle/DeployedAddresses.sol";  // 用来获取被测试合约的地址
import "../contracts/Adoption.sol";      // 被测试合约contract TestAdoption {Adoption adoption = Adoption(DeployedAddresses.Adoption());// 领养测试用例function testUserCanAdoptPet() public {uint returnedId = adoption.adopt(8);uint expected = 8;Assert.equal(returnedId, expected, "Adoption of pet ID 8 should be recorded.");}// 宠物所有者测试用例function testGetAdopterAddressByPetId() public {// 期望领养者的地址就是本合约地址，因为交易是由测试合约发起交易，address expected = this;address adopter = adoption.adopters(8);Assert.equal(adopter, expected, "Owner of pet ID 8 should be recorded.");}// 测试所有领养者function testGetAdopterAddressByPetIdInArray() public {// 领养者的地址就是本合约地址address expected = this;address[16] memory adopters = adoption.getAdopters();Assert.equal(adopters[8], expected, "Owner of pet ID 8 should be recorded.");}
}

提示：Assert.sol 及 DeployedAddresses.sol 是 Truffle 框架提供，在 test 目录下并不提供
truffle 目录。

TestAdoption 合约中添加 adopt 的测试用例。

运行测试用例

在终端中，执行

truffle test

如果测试通过，则终端输出：

Using network 'develop'.Compiling ./contracts/Adoption.sol...
Compiling ./test/TestAdoption.sol...
Compiling truffle/Assert.sol...
Compiling truffle/DeployedAddresses.sol...TestAdoption✓ testUserCanAdoptPet (62ms)✓ testGetAdopterAddressByPetId (53ms)✓ testGetAdopterAddressByPetIdInArray (73ms)3 passing (554ms)

创建用户接口和智能合约交互

我们已经编写和部署及测试好了我们的合约，接下我们为合约编写 UI，让合约真正可以用起来。

在 Truffle Box pet-shop 里，已经包含了应用的前端代码，代码在 src/ 文件夹下。

在编辑器中打开 src/js/app.js

可以看到用来管理整个应用的 App 对象，init 函数加载宠物信息，就初始化 web3.
web3 是一个实现了与以太坊节点通信的库，我们利用 web3 来和合约进行交互。

初始化 web3

接下来，我们来编辑 app.js 修改 initWeb3():
删除注释，修改为：

  initWeb3: async function() {// Modern dapp browsers...if (window.ethereum) {App.web3Provider = window.ethereum;try {// Request account accessawait window.ethereum.enable();} catch (error) {// User denied account access...console.error("User denied account access")}}// Legacy dapp browsers...else if (window.web3) {App.web3Provider = window.web3.currentProvider;}// If no injected web3 instance is detected, fall back to Ganacheelse {App.web3Provider = new Web3.providers.HttpProvider('http://localhost:7545');}web3 = new Web3(App.web3Provider);return App.initContract();}

新的 Dapp 浏览器或 MetaMask 的新版本，注入了一个 ethereum 对象到 window 对象里，应该优先使用 ethereum 来构造 web3，同时使用 ethereum.enable() 来请求用户授权访问链接账号。

代码中优先使用 Mist 或 MetaMask 提供的 web3 实例，如果没有则从本地环境创建一个。

实例化合约

使用 truffle-contract 会帮我们保存合约部署的信息，就不需要我们手动修改合约地址，修改 initContract()代码如下：

initContract: function() {// 加载Adoption.json，保存了Adoption的ABI（接口说明）信息及部署后的网络(地址)信息，它在编译合约的时候生成ABI，在部署的时候追加网络信息$.getJSON('Adoption.json', function(data) {// 用Adoption.json数据创建一个可交互的TruffleContract合约实例。var AdoptionArtifact = data;App.contracts.Adoption = TruffleContract(AdoptionArtifact);// Set the provider for our contractApp.contracts.Adoption.setProvider(App.web3Provider);// Use our contract to retrieve and mark the adopted petsreturn App.markAdopted();});return App.bindEvents();
}

处理领养

修改 markAdopted()代码：

  markAdopted: function(adopters, account) {var adoptionInstance;App.contracts.Adoption.deployed().then(function(instance) {adoptionInstance = instance;// 调用合约的getAdopters(), 用call读取信息不用消耗gasreturn adoptionInstance.getAdopters.call();}).then(function(adopters) {for (i = 0; i < adopters.length; i++) {if (adopters[i] !== '0x0000000000000000000000000000000000000000') {$('.panel-pet').eq(i).find('button').text('Success').attr('disabled', true);}}}).catch(function(err) {console.log(err.message);});}

修改 handleAdopt()代码：

 handleAdopt: function(event) {event.preventDefault();var petId = parseInt($(event.target).data('id'));var adoptionInstance;// 获取用户账号web3.eth.getAccounts(function(error, accounts) {if (error) {console.log(error);}var account = accounts[0];App.contracts.Adoption.deployed().then(function(instance) {adoptionInstance = instance;// 发送交易领养宠物return adoptionInstance.adopt(petId, {from: account});}).then(function(result) {return App.markAdopted();}).catch(function(err) {console.log(err.message);});});}