本文首发于深刻浅出区块链社区前端
原文连接:一步步教你开发、部署第一个去中心化应用(Dapp) - 宠物商店原文已更新,请读者前往原文阅读node
今天咱们来编写一个完整的去中心化(区块链)应用(Dapps), 本文能够和编写智能合约结合起来看。git
阅读本文前,你应该对以太坊、智能合约有所了解,若是你还不了解,建议你先看以太坊是什么 除此以外,你最好还了解一些HTML及JavaScript知识。github
本文经过实例教你们来开发去中心化应用,应用效果如图: web
从本文,你能够学习到:shell
小专栏用户在教程结尾处能够下载完整的Dapp代码。npm
Pete有一个宠物店,有16只宠物,他想开发一个去中心化应用,让你们来领养宠物。 在truffle box中,已经提供了pet-shop的网站部分的代码,咱们只须要编写合约及交互部分。json
Ganache(或Ganache CLI)已经取代了 testrpc。数组
> mkdir pet-shop-tutorial
> cd pet-shop-tutorial
复制代码
> truffle unbox pet-shop
Downloading...
Unpacking...
Setting up...
Unbox successful. Sweet!
Commands:
Compile: truffle compile
Migrate: truffle migrate
Test contracts: truffle test
Run dev server: npm run dev
复制代码
这一步须要等待一会浏览器
也可使用truffle init 来建立一个全新的项目。
contracts/
智能合约的文件夹,全部的智能合约文件都放置在这里,里面包含一个重要的合约Migrations.sol(稍后再讲) migrations/
用来处理部署(迁移)智能合约 ,迁移是一个额外特别的合约用来保存合约的变化。 test/
智能合约测试用例文件夹 truffle.js/
配置文件
其余代码能够暂时不用管
智能合约承担着分布式应用的后台逻辑和存储。智能合约使用solidity编写,可阅读 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字节码才能运行。 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.js
Deploying Migrations...
... 0x3076b7dac65afc44ec51508bf6f2b6894f833f0f9560ecad2d6d41ed98a4679f
Migrations: 0x8cdaf0cd259887258bc13a92c0a6da92698644c0
Saving successful migration to network...
... 0xd7bc86d31bee32fa3988f1c1eabce403a1b5d570340a3a9cdba53a472ee8c956
Saving artifacts...
Running migration: 2_deploy_contracts.js
Deploying Adoption...
... 0x2c6ab4471c225b5473f2079ee42ca1356007e51d5bb57eb80bfeb406acc35cd4
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的测试用例
在终端中,执行
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来和合约进行交互。
接下来,咱们来编辑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和咱们的dapp进行交互是个很好的选择,经过此连接安装,安装完成后,浏览器工具条会显示一个小狐狸图标。
在接受隐私说明后,会出现页面以下:
这里咱们经过还原一个Ganache为咱们建立好的钱包,做为咱们的开发测试钱包。点击页面的** Import Existing DEN**,输入Ganache显示的助记词。
candy maple cake sugar pudding cream honey rich smooth crumble sweet treat
复制代码
而后本身想要的密码,点击OK。 如图:
默认链接的是以太坊主网(左上角显示),选择Custom RPC,添加一个网络:http://127.0.0.1:7545,点返回后,显示以下:
至此MetaMask的安装,配置已经完成。
接下来须要本地的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
> npm run dev
复制代码
会自动打开浏览器显示咱们的dapp,如本文的第一张图。 如今领养一直宠物看看,当咱们点击Adopt时,MetaMask会提示咱们交易的确认,如图:
点击Submit确认后,就能够看到成功领养了此次宠物。
在MetaMask中,也能够看到交易的清单:
好了,恭喜你,即将成为一名去中心化式应用开发者的你已经成为迈出了坚实的一步。
若是学习中遇到问题,欢迎来个人知识星球交流。
深刻浅出区块链 - 系统学习区块链,打造最好的区块链技术博客。