第一个去中心应用—以太坊宠物商店

阅读本篇本章,你将体验到

  • 搭建第一个去中心化应用的过程
  • 编写智能合约
  • 编译和部署智能合约到区块链
  • 通过web3和智能合约交互
  • MetaMask的使用

准备开发环境

开始之前确保你的电脑有以下环境:

  • Node.js v8+
  • npm(记得换淘宝的源)
  • Ganache或者Ganache-CLI

然后你需要安装Truffle框架。

npm install -g truffle

什么是truffle?
参考资料

Truffle 是一个世界级的开发环境、测试框架,以太坊的资源管理通道,致力于让以太坊上的开发变得简单,Truffle将提供:

  • 内置的智能合约的编译,链接,部署,和二进制文件的管理
  • 针对快速迭代开发的自动化合约测试
  • 可脚本化,可扩展的部署与迁移框架
  • 用于部署到任意数量的公网或私网的网络环境管理
  • 使用EthPM&NPM提供的包管理,使用ERC190标准
  • 与合约直接通信的交互控制台
  • 可配的构建流程,支持紧密集成
  • 在Truffle环境里支持执行外部的脚本

创建项目并使用Truffle Box

创建项目文件夹

创建项目文件夹

mkdir pet-shop
cd pet-shop

初始化项目

使用Truffle Unbox初始化项目,针对不同类型的应用,Truffle提供了一些已经创建好的Box,相当于给我们提供了一些实例代码。

turffle unbox pet-shop

目录结构

默认的Truffle的结构是这样的

  • contracts/: 里边包含Solidity的源文件,默认有一个合约文件Migrations.sol,这个是部署用的,不需要修改它,自己写的合约都放在这个文件夹里
  • migrations/: 里边包含部署合约的js文件,用来部署合约到链上
  • test/:包含测试合约的内容
  • tuffle.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 下

truffle complie

输出

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

部署

编译之后就可以部署到区块链上,在 migrations文件夹下已经有一个1_initial_migration.js脚本,它是用来部署Migrations.sol

我们来创建一个部署Adoption.sol的脚本,创建部署脚本2_deploy_contracts.js

复制以下内容:

var Adoption = artifacts.require("Adoption");

module.exports = function(deployer) {
  deployer.deploy(Adoption);
};

在执行部署之前,必须要确保有一个正在运行中的区块链。

打开Ganache开启一个私链进行开发测试,默认会在7545端口运行一个开发链,打开后会是这样的:

ganache.png

接下来执行部署命令:

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,这说明我们的智能合约已经部署好了

测试

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 目录。

在终端执行:

truffle test

如果测试通过,终端会输出:

Using network 'develop'.

Compiling ./contracts/Adoption.sol...
Compiling ./test/TestAdoption.sol...
Compiling truffle/Assert.sol...
Compiling truffle/DeployedAddresses.sol...


  TestAdoption
    ✓ testUserCanAdoptPet (76ms)
    ✓ testGetAdopterAddressByPetId (65ms)
    ✓ testGetAdopterAddressByPetIdInArray (73ms)


  3 passing (522ms)

与智能合约交互

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

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

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

初始化web3

修改app.js 中的 initWeb3():

initWeb3: function() {

  // Modern dapp browsers...
  if (window.ethereum) {
    App.web3Provider = window.ethereum;
    try {
      // Request account access
      await 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 Ganache
  else {
    App.web3Provider = new Web3.providers.HttpProvider('http://localhost:7545');
  }
  web3 = new Web3(App.web3Provider);

  return App.initContract();
}

实例化合约

修改 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);
    });
  });
}

.then是js中Promise的用法,具体可以自行学习。

在浏览器中运行

安装MetaMask

MetaMask 是一款插件形式的以太坊轻客户端,开发过程中使用 MetaMask 和我们的 dapp 进行交互是个很好的选择,通过此链接安装,安装完成后,浏览器工具条会显示一个小狐狸图标。

配置钱包

第一打开MetaMask是这样的:

metaMask1.png

选择从助记词还原,然后输入在Ganache中的12个单词,设置个密码,点击 restore

连接私有网络

默认连接的是以太坊的主网,在右上角选择 Custom RPC,添加一个网络:http://127.0.0.1:7545,然后显示就算切入到自己的开发私有链了。

启动服务

在项目的根目录下执行:

npm run dev

如果顺利的话,自动会打开浏览器显示我们的第一个去中心化应用。

如果点击Adopt的话,MetaMask会提示我们的交易确认,点击确认,就成功领养宠物了。

至此,我们的第一个去中心化的应用大搭建完成!

参考资料:trufflesuite

文章名: 《第一个去中心应用—以太坊宠物商店》
文章链接:http://hrhr7.cn/index.php/archives/25/
联系方式:tensor7@163.com
除特别注明外,文章均为Cupidr原创,转载时请注明本文出处及文章链接
Last modification:August 4th, 2019 at 08:05 pm
如果觉得我的文章对你有用,请随意赞赏

Leave a Comment