以太坊智能合约开发环境搭建及智能合约的编写、部署、测试

区块链技术区块链技术以太坊智能合约

字数统计: 2k阅读时长: 8 min

 2021/01/14 

这篇纪录一下智能合约开发环境(Remix-ide、Truffle、EthScan)的搭建以及Solidity语言的简单使用，并使用Truffle来创建、编译、部署、测试一个简单的合约demo，并用区块链浏览器查看区块信息来进一步加深理解。参考书籍：《以太坊智能合约开发实战》、《Solidity编程》

环境准备

安装nvm、nodejs、npm

nvm：强烈安利使用，可以便捷的切换node版本。
- windows下：Releases · coreybutler/nvm-windows (github.com)
linux下: Releases · nvm-sh/nvm (github.com)
node：
- 新建国内源的环境变量：
  - windows下：NVM_NODEJS_ORG_MIRROR=https://npm.taobao.org/mirrors/node
  - linux下：bashrc或者/etc/profile增加上述内容
- 安装指定版本nodejs，如nvm install 10.23.1。具体版本号可以用nvm list available查看或者官网https://nodejs.org/en/download/releases查看版本
npm：上述安装node后自动就有npm包管理器了，我们换一下国内源即可：npm config set registry https://registry.npm.taobao.org/。

安装Remix-ide

安装remix-ide的好处是你不用单独去安装solc或者solc.js编译器了，它自带，也不用折腾什么IDEA、vscode、Atom了，这个高亮和补全也还可以，而且自带很多功能。

这里不建议去github下源码编译安装，麻烦比较多，建议直接npm安装即可，并且版本请选择0.10.0或者<0.9.4，本人亲测0.10.1、0.10.2、0.10.3都有问题，需要对源码做改动，并且改完后还不能正常使用。

1	npm install -g remix-ide@0.10.0

安装好以后直接启动就可以了：

启动了后的结果：

使用EthScan区块链浏览器

区块链浏览器很多，我就随便找了一个EthScan，就是个html网页，很方便，主要是用来查看区块细节信息的，效果如图：

安装使用Truffle

Truffle可以认为是一个帮助你管理智能合约开发过程的工具，可以帮助以初始化、编译、调试、部署一个智能合约，和maven感觉有点像，反正好用的一匹。可以通过这个网址来学习。

1	npm install -g truffle

看一下Truffle的常用命令和对应含义：

Truffle v5.1.61 - a development framework for Ethereum

Usage: truffle <command> [options]

Commands:
  build     Execute build pipeline (if configuration present)	// 构建打包
  compile   Compile contract source files		// 编译合约文件(.sol)
  config    Set user-level configuration options
  console   Run a console with contract abstractions and commands available
  create    Helper to create new contracts, migrations and tests	// 用于创建文件，比如合约、测试等文件的模板
  debug     Interactively debug any transaction on the blockchain
  deploy    (alias for migrate)	// 部署合约(也可以使用migrate)
  develop   Open a console with a local development blockchain
  exec      Execute a JS module within this Truffle environment
  help      List all commands or provide information about a specific command
  init      Initialize new and empty Ethereum project	// 初始化一个Truffle项目
  install   Install a package from the Ethereum Package Registry
  migrate   Run migrations to deploy contracts	// 部署合约
  networks  Show addresses for deployed contracts on each network
  obtain    Fetch and cache a specified compiler
  opcode    Print the compiled opcodes for a given contract
  publish   Publish a package to the Ethereum Package Registry
  run       Run a third-party command
  test      Run JavaScript and Solidity tests	// 运行测试
  unbox     Download a Truffle Box, a pre-built Truffle project		// 可以从官网下载一个box项目使用
  version   Show version number and exit
  watch     Watch filesystem for changes and rebuild the project automatically	// 后台监视文件是否发生变化并自动编译

See more at http://trufflesuite.com/docs

使用Truffle与Solidity编写一个简单合约

初始化

我们新建并进入一个文件夹，运行Truffle init就好了：

初始化后的文件目录含义如下：

C:.
│  truffle-config.js	// 配置文件，用来配置如网络等信息
│
├─contracts		// 用来写合约文件
│      Migrations.sol
│
├─migrations	// 用来写合约部署的配置文件
│      1_initial_migration.js
│
└─test		// 用来写测试文件
        .gitkeep

我们先配置一下网络信息：

// truffle-config.js 文件里有具体的每一个参数的说明，这里不做说明
development: {
    host: "127.0.0.1",
    port: 8545,
    network_id: 666
}

我们这个网络名叫development，truffle编译的时候会默认使用这个网络的配置，我们也可以通过使用参数--network来指定网络，比如你定义了一个test网络，你就--network test就好了。不带参数就是使用的development。

编写合约

我们创建两个合约first.sol和second.sol：

// SPDX-License-Identifier: MIT
pragma solidity >=0.4.22 <0.9.0;

contract first {
    
    int public myData = 20;
    
    function get() public view returns (int) {	// 返回保存的数值
        return myData;
    }
}

// SPDX-License-Identifier: MIT
pragma solidity >=0.4.22 <0.9.0;
import "./first.sol";

contract second {
    address firstAddress;
    
    int public _data;
    
    constructor(address _first) public {
        firstAddress = _first;
    }
    
    function SetData() public {
        First h = First(firstAddress);
        _data = h.get();
    }
}

然后我们创建一个部署文件，定义我们的部署脚本文件：

// 2_custom.js	注意命名方式，是数字_描述.js
var hw1 = artifacts.require("first");	// 引入合约1

var hw2 = artifacts.require("second");	// 引入合约2

module.exports = function(deployer) {	// 先部署合约1再部署合约2
    deployer.deploy(hw1).then(
        function() {
            return deployer.deploy(hw2, hw1.address);
        }
    )
};

这样truffle在部署合约时就会按照我们指定的顺序来部署合约。下面我们先编译合约。

编译合约

然后我们启动私链，运行deploy命令，注意要开启挖矿模块，并且要解锁用户，不然会报错："Migrations" -- Returned error: authentication needed: password or unlock.

我们来看一下结果流程，首先编译合约，然后连接网络开始准备部署：

按照顺序(这就是为啥要要求命名规则是数字_描述)执行部署脚本

然后执行我们自定义的部署脚本：

最终部署完成，可以看到共进行了3次部署，花费的以太币也有计算。

同时我们的私链也有以下输出，可以看到hash值与上述哈希值是一样的：

测试合约

测试合约我们需要写一个js脚本，其实和单元测试比较像，主要是看程序的输出符不符合预期。Truffle中测试的脚本文件我们都放到test目录下就行，我们用javascript写一个测试脚本，内容如下：

var testFirst = artifacts.require("../contracts/first.sol");

contract("first", function () {
  it("first.get", function () {
      var instanceFirst;
      
      return testFirst.deployed().then(
          function(instance) {
              instanceFirst = instance;
              return instanceFirst.get.call();		// 调用实例的get方法获取值
          }).then(
              function(result) {
                  // assert.equal函数第一个参数为待判断值，第二个参数为预期值，第三个参数为不符合预期时的输出
                  assert.equal(result, 20, "first.get() not equal to 20");	
              })
  }); // end-of-it
}); // end-of-contract