pet-shop Box項目地址：http://truffleframework.com/boxes/pet-shop
pet-shop Box官方教程：http://truffleframework.com/tutorials/pet-shop
原文：一步步教你開發、部署第一個去中心化應用(Dapp) - 寵物商店
作者： Tiny熊
本文在原文基于Truffle Box中的pet-shop Box代碼，使用圖形化的Ganache以及插件形式的以太坊輕客戶端MetaMask，編寫一個去中心化的寵物商店的基礎上，加入了在實際操作過程中解決遇到的問題。例如頁面無法正常顯示的問題。
項目背景
Pete有一個寵物店，有16只寵物，他想開發一個去中心化應用，讓大家來領養寵物。
在truffle box中，已經提供了pet-shop的網站部分的代碼，我們只需要編寫合約及交互部分。
環境搭建
- 安裝Node
- 安裝 Truffle
第1，2步驟請查看區塊鏈開發(一)Truffle入門指南 - 安裝Ganache
創建項目
- 建立項目目錄并進入
yuyangdeMacBook-Pro:~ yuyang$ mkdir pet-shop-tutorial
yuyangdeMacBook-Pro:~ yuyang$ cd pet-shop-tutorial
- 使用truffle unbox 創建項目
yuyangdeMacBook-Pro:pet-shop-tutorial yuyang$ truffle unbox pet-shop
這一步需要等待一會。
也可以使用truffle init 來創建一個全新的項目。
項目目錄結構
contracts/ 智能合約的文件夾，所有的智能合約文件都放置在這里，里面包含一個重要的合約Migrations.sol（稍后再講）。
migrations/ 用來處理部署（遷移）智能合約 ，遷移是一個額外特別的合約用來保存合約的變化。
test/ 智能合約測試用例文件夾。
truffle.js/ 配置文件。
其他代碼可以暫時不用管。
編寫智能合約
智能合約承擔著分布式應用的后臺邏輯和存儲。智能合約使用solidity編寫。
在contracts目錄下，添加合約文件Adoption.sol
pragma solidity ^0.4.17;
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]) {
return adopters;
}
}
編譯部署智能合約
Truffle集成了一個開發者控制臺，可用來生成一個開發鏈用來測試和部署智能合約。
編譯
Solidity是編譯型語言，需要把可讀的Solidity代碼編譯為EVM字節碼才能運行。
yuyangdeMacBook-Pro:pet-shop-tutorial yuyang$ truffle compile
輸出
Compiling ./contracts/Migrations.sol...
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 啟動之后是這樣：
接下來執行部署命令:
yuyangdeMacBook-Pro:pet-shop-tutorial yuyang$ truffle migrate
執行后，有以下類似的輸出:
Using network 'development'.
Running migration: 1_initial_migration.js
Deploying Migrations...
... 0x3f72ba590249446eea8e90d124450b341fe58505b6976c0ab334cb413b64257b
Migrations: 0x8cdaf0cd259887258bc13a92c0a6da92698644c0
Saving successful migration to network...
... 0xd7bc86d31bee32fa3988f1c1eabce403a1b5d570340a3a9cdba53a472ee8c956
Saving artifacts...
Running migration: 2_deploy_contracts.js
Deploying Adoption...
... 0xe85b10cb23f3e026b5252a8666393c074ad3f32d1e66f2d42eca034f5bfb1cc4
Adoption: 0x345ca3e014aaf5dca488057592ee47305d9b3e10
Saving successful migration to network...
... 0xf36163615f41ef7ed8f4a8f192149a0bf633fe1a2398ce001bf44c43dc7bdda0
Saving artifacts...
在打開的Ganache里可以看到區塊鏈狀態的變化，現在產生了4個區塊。
這時說明已經智能合約已經部署好了。
測試
現在我們來測試一下智能合約，測試用例可以用 JavaScript or Solidity來編寫，這里使用Solidity。
在test目錄下新建一個TestAdoption.sol，編寫測試合約。
pragma solidity ^0.4.17;
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的測試用例。
運行測試用例
在終端中，執行:
yuyangdeMacBook-Pro:pet-shop-tutorial yuyang$ truffle test
如果測試通過，則終端輸出：
Using network 'development'.
Compiling ./contracts/Adoption.sol...
Compiling ./test/TestAdoption.sol...
Compiling truffle/Assert.sol...
Compiling truffle/DeployedAddresses.sol...
TestAdoption
? testUserCanAdoptPet (62ms)
? testGetAdopterAddressByPetId (43ms)
? testGetAdopterAddressByPetIdInArray (119ms)
3 passing (539ms)
創建用戶接口和智能合約交互
我們已經編寫和部署及測試好了我們的合約，接下我們為合約編寫UI，讓合約真正可以用起來。
在Truffle Box pet-shop里，已經包含了應用的前端代碼，代碼在src/文件夾下。
在編輯器中打開src/js/app.js
可以看到用來管理整個應用的App對象，init函數加載寵物信息，就初始化web3。
web3是一個實現了與以太坊節點通信的庫，我們利用web3來和合約進行交互。
初始化web3
接下來，我們來編輯app.js修改initWeb3():
刪除注釋，修改為：
initWeb3: function() {
// Is there an injected web3 instance?
if (typeof web3 !== 'undefined') {
App.web3Provider = web3.currentProvider;
} else {
// If no injected web3 instance is detected, fall back to Ganache
App.web3Provider = new Web3.providers.HttpProvider('http://localhost:7545');
}
web3 = new Web3(App.web3Provider);
return App.initContract();
}
代碼中優先使用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 contract
App.contracts.Adoption.setProvider(App.web3Provider);
// Use our contract to retrieve and mark the adopted pets
return App.markAdopted();
});
return App.bindEvents();
}
處理領養
修改markAdopted()代碼：
markAdopted: function(adopters, account) {
var adoptionInstance;
App.contracts.Adoption.deployed().then(function(instance) {
adoptionInstance = instance;
// 調用合約的getAdopters(), 用call讀取信息不用消耗gas
return 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);
});
});
}
在瀏覽器中運行
安裝 MetaMask
MetaMask 是一款插件形式的以太坊輕客戶端，開發過程中使用MetaMask和我們的dapp進行交互是個很好的選擇，通過此鏈接安裝，安裝完成后，瀏覽器工具條會顯示一個小狐貍圖標。
配置錢包
在接受隱私說明后，會出現頁面如下：
這里我們通過還原一個Ganache為我們創建好的錢包，作為我們的開發測試錢包。點擊頁面的 Import Existing DEN，輸入Ganache顯示的助記詞。
candy maple cake sugar pudding cream honey rich smooth crumble sweet treat
連接開發區塊鏈網絡
默認連接的是以太坊主網（左上角顯示），選擇Custom RPC，添加一個網絡：http://127.0.0.1:7545，點返回后，顯示如下：
這時左上角顯示為Private Network，賬號是Ganache中默認的第一個賬號。
至此MetaMask的安裝，配置已經完成。
安裝和配置lite-server
接下來需要本地的web 服務器提供服務的訪問， Truffle Box pet-shop里提供了一個lite-server可以直接使用，我們看看它是如何工作的。
bs-config.json指示了lite-server的工作目錄。
{
"server": {
"baseDir": ["./src", "./build/contracts"]
}
}
./src 是網站文件目錄
./build/contracts是合約輸出目錄
以此同時，在package.json文件的scripts中添加了dev命令：
"scripts": {
"dev": "lite-server",
"test": "echo \"Error: no test specified\" && exit 1"
},
當運行npm run dev的時候，就會啟動lite-server
啟動服務
yuyangdeMacBook-Pro:pet-shop-tutorial yuyang$ npm run dev
會自動打開瀏覽器顯示我們的dapp。
注：這里可能會遇到頁面無法正常顯示的問題，例如只顯示Pete's Pet Shop標題，而不顯示內容。原因在于
src/index.html引用了Google的jQuery文件被墻：
<!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
<!-- <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script> -->
解決方法有三種：
- 翻墻。
- 使用百度的庫文件地址替換。
<script src="http://libs.baidu.com/jquery/2.0.0/jquery.min.js"> </script>`。
- 下載jQuery文件放在
src/js/下，然后修改index.html文件。
<script src="js/jquery-2.1.0.min.js"></script>
現在領養一直寵物看看，當我們點擊Adopt時，MetaMask會提示我們交易的確認，如圖：
點擊Submit確認后，就可以看到成功領養了這次寵物。
在MetaMask中，也可以看到交易的清單：
