以太坊智能合约开发第六篇:truffle开发框架

在前面几篇教程中,我们实现了一个简单的 Hello 合约,并通过 solc 编译器将合约代码编译后,部署在私有链Ganache上。本篇将介绍通过truffle框架来构建自动编译、部署合约代码。

truffle框架

Truffle是基于Solidity语言的一套开发框架,它简化了去中心化应用(Dapp)的构建和管理流程。本身是采用Javascript编写,支持智能合约的编译、部署和测试。 truffle开发框架提供了很多功能,简化了我们的开发、编译、部署与调试过程:

  • 内置了智能合约编译、链接、部署和二进制文件的管理
  • 方便快速开发的合约自动化测试
  • 方便扩展的、脚本化的部署与发布框架
  • 方便的网络管理功能。不论是公有网络还是私有网络
  • 基于ERC190标准,使用EthPM & NPM进行依赖包管理
  • 内置控制台功能。项目构建后,可以直接在命令行调用输出结果,方便了开发调试
  • 可配的构建流程,支持持续集成。
  • 支持外部脚本的执行

接下来,我们将通过truffle框架来构建 Hello 合约的编译、部署过程。

truffle安装

npm install -g truffle

安装好后,查看一下版本信息:

truffle version

本篇示例基于如下版本:

Truffle v4.0.1 (core: 4.0.1)
Solidity v0.4.18 (solc-js)

初始化项目

truffle提供了很多项目模板,可以快速搭建一个去中心化应用的代码骨架。我们使用 webpack 项目模板来构建 Hello 合约。在 smartcontract 目录下,执行如下命令:

truffle unbox webpack

初始化项目的时候,它会创建运行一个完整Dapp所需的文件和目录。我们将 strings.solHello.sol 两个合约文件移动到 contracts 目录下,并删除 contracts 目录下原有的 ConvertLib.solMetaCoin.sol 文件(Migrations.sol 合约用来管理应用合约的部署,因此请勿删除)。目录结构如下:

smartcontract
  ├── app
  ├── contracts
          ├── Hello.sol
          ├── Migrations.sol
          └── strings.sol
  ├── migrations
          ├── 1_initial_migration.js
          └── 2_deploy_contracts.js
  ├── node_modules
  ├── package.json
  ├── test
  ├── truffle.js
  └── webpack.config.js

修改部署脚本

目录migrations (迁移的意思) 非常重要。truffle使用该目录下的脚本来管理合约的部署。在前面几篇教程中,我们是通过自己编写编译部署脚本 deploy.js ,并在node控制台中运行来将 Hello 合约部署到区块链上的。有了truffle,以后再也不用这么做了。

第一个脚本 1_initial_migration.js 的作用是向区块链部署 Migrations 合约。 这个合约的作用是存储并跟踪已经部署的最新合约。每次运行脚本时,truffle就会向区块链查询获取已部署好的合约,然后部署新的合约。部署完成后,这个脚本会更新 Migrations 合约中的last_completed_migration 字段指向最新部署的合约。

我们可以简单地把 Migrations 合约当成是一个数据库表,字段last_completed_migration 总是保持最新状态。

我们来修改第二个脚本 2_deploy_contracts.js

//artifacts对象为truffle框架提供
//artifacts.require()方法与Node中的require()方法类似
//编译合约代码。自动调用solc编译器来编译合约代码并返回编译结果对象
var stringsContract = artifacts.require("./strings.sol");
var HelloContract = artifacts.require("./Hello.sol");

//部署器对象deployer为truffle框架提供
module.exports = function(deployer) {
  //部署string.sol合约
  deployer.deploy(stringsContract);
  //将已部署的strings合约类库连接到Hello合约
  deployer.link(stringsContract, HelloContract);
  //部署Hello.sol合约
  deployer.deploy(HelloContract);
};

代码不难,加上了注释很容易理解。

修改truffle配置

部署脚本修改完后,我们还需要在配置文件中声明要连接的以太坊节点地址,这里使用Ganache的地址 http://localhost:7545

require('babel-register')
module.exports = {
  networks: {
    development: {
      host: 'localhost',
      port: 7545,
      network_id: '*'
    }
  }
}

注意 development 关键字。truffle支持将合约部署到多个区块链网络,例如开发网络、私有网络、测试网或公网。 在上面的配置中,我们只定义了一个用于开发的网络。

编译合约

smartcontract 目录下执行 truffle compile 命令,终端输出如下:

Compiling ./contracts/Hello.sol...
Compiling ./contracts/Migrations.sol...
Compiling ./contracts/strings.sol...
Writing artifacts to ./build/contracts

可以看到,contracts 目录下的三个合约文件都编译了,并且在当前目录下生成了 build/contracts 目录,同时也产生了三个文件:

smartcontract/build/contracts
    ├── Hello.json
    ├── Migrations.json
    └── strings.json

这三个都是 abi 文件(abi概念的解释,可以翻看以太坊智能合约开发第二篇:理解以太坊相关概念)。

部署合约

合约编译成功后,就可以部署了。在 smartcontract 目录下执行部署命令 truffle migrate ,可以看到终端上输出了部署日志:

关键信息可以标注出来。我们也可以在 Ganache 中的 LOGS 面板中查看 transaction id 和 合约地址:

合约调用

合约部署成功后,我们可以通过 truffle console 命令进入控制台。在控制台里调用刚才部署的合约:

$ truffle console
truffle(development)> Hello.deployed().then(function(contractInstance){contractInstance.say.call('Guys').then(function(result){console.log(result)})})
truffle(development)> Hello Guys

需要注意的是,truffle 的所有调用都会返回 promise (node语法),所以每个响应都被包裹在 then() 函数里。

至此,通过truffle框架进行合约的编译、部署与调用就介绍完了。和之前手动编写编译部署脚本,及调用脚本的方式相比,是不是更方便快捷?而且代码量还更少更精炼。 通过truffle框架,编译和部署都用一条命令即可搞定。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏容器云生态

当go get遇到墙时

作为一名从py转向go语言的新手,在使用第三方包的时候我们需要比较熟悉该包或者模块的构建与安装,好比在使用pip或者easy_install之类的工具安装模块时...

8579
来自专栏沈唁志

更换服务器遇到的破事

1934
来自专栏北京马哥教育

恢复错删的文件

起因:我写了个程序自动重命名下载的图片,改着改着,程序出了bug,把所有图片从图片文件夹 /media/disk/picure 都移动到了当前脚本的工作目录 ...

3377
来自专栏区块链大本营

【手把手】如何在10分钟内搭建一个以太坊私有链?

3733
来自专栏生信技能树

R包安装大全-番外篇一

SingleCellExperiment是单细胞转录组数据的基础包,大部分其它单细胞转录组数据处理的包都依赖于它,就跟芯片数据里面的ExpressionSet对...

4147
来自专栏闻道于事

Maven使用本地jar包(两种方式)

有些项目会用到一些Maven库上没有的jar包,这就需要我们自己引入了 这种情况有两种办法: 第一种方式,在pom文件中引用时使用本地路径: 首先把jar包放到...

3195
来自专栏汇智网教程

geth如何解锁账户?

3096
来自专栏子勰随笔

Eclipse使用中部分经验总结

1625
来自专栏编程

R基础入门(4)——安装图形化操作界面

既然是基础入门系列,让大家下手写代码或命令简直是不可容忍的,虽然等过了入门阶段你会义无反顾地抛弃图形界面。R的图形化操作界面有多个,既包含基本统计分析的功能,又...

35911
来自专栏Netkiller

高级运维工程师面试题(更新中)

高级运维工程师 服务器硬件 RAID 磁盘阵列 简述 RAID? RAID 0 5 6 10 50 都适用于那些场景? 数据库适用那种 RAID? RAID 1...

4904

扫码关注云+社区