框架
框架可以用于简化Ethereum智能合约的开发。通过自己做所有的事情,你就能更好地理解每件事是如何组合在一起的,但这是一项非常繁琐、重复性的工作。下面列出的框架可以自动执行某些任务并使开发变得轻而易举。
Truffle
- Github链接:https://github.com/trufflesuite/truffle
- 网站链接:https://truffleframework.com
- 文档链接:https://truffleframework.com/docs
- Truffle Boxes链接:http://truffleframework.com/boxes/
- npm package repository链接:https://www.npmjs.com/package/truffle
安装truffle框架
truffle框架由几个NodeJS包组成。在安装truffle之前,我们需要安装最新的NodeJS和node包管理器(npm)。
安装NodeJS和npm的推荐方法是使用节点版本管理器NVM。一旦我们安装了nvm,它将为我们处理所有的依赖项和更新。我们将遵循在http://nvm.sh中的说明。
一旦nvm安装在您的操作系统上,安装node.js就很简单了。我们使用-lts
标志来告诉nvm,我们需要最新的NodeJS“长期支持(Long Term Support, lts)”版本
$ nvm install --lts
确认已安装node和npm:
$ node -v
v8.9.4
$ npm -v
5.6.0
创建一个DApp支持的包含Node.js版本的隐藏文件.nvmrc,因此开发人员只需在项目目录的根目录中运行nvm安装,它就会自动安装并切换到使用该版本。
$ node -v > .nvmrc
$ nvm install
看上去不错。现在安装truffle:
$ npm -g install truffle
+ truffle@4.0.6
installed 1 package in 37.508s
集成预构建的Truffle项目(Truffle Box)
如果我们想使用或创建一个基于预先构建的样板文件的DApp,那么在Truffle Boxes链接中我们可以选择一个现有的Truffle项目,然后运行以下程序来下载和提取:
$ truffle unbox <BOX_NAME>
创建一个truffle项目目录
对于使用truffle的每个项目,我们都创建一个项目目录并在该目录中初始化truffle。truffle将在我们的项目目录中创建必要的目录结构。通常,我们给项目目录一个描述项目的名称。对于本例,我们将使用truffle来从[simple_contract_example]部署水龙头合约,因此我们将命名项目文件夹Faucet。
$ mkdir Faucet
$ cd Faucet
Faucet $
一旦进入Faucet目录,我们初始化truffle:
Faucet $ truffle init
Truffle创建了一个目录结构和一些默认文件:
Faucet
├── contracts
│ └── Migrations.sol
├── migrations
│ └── 1_initial_migration.js
├── test
├── truffle-config.js
└── truffle.js
除了truffle本身,我们还将使用一些JavaScript (nodeJS)支持包。我们可以用npm安装这些。我们初始化npm目录结构并接受npm建议的默认值:
$ npm init
package name: (faucet)
version: (1.0.0)
description:
entry point: (truffle-config.js)
test command:
git repository:
keywords:
author:
license: (ISC)
About to write to Faucet/package.json:
{
"name": "faucet",
"version": "1.0.0",
"description": "",
"main": "truffle-config.js",
"directories": {
"test": "test"
},
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
Is this ok? (yes)
现在,我们可以安装与truffle一起使用的依赖项:
$ npm install dotenv truffle-wallet-provider ethereumjs-wallet
现在,在您的Faucet目录中,有一个包含数千个文件的node_modules目录。
在将DApp部署到云生产或持续集成环境之前,有必要指定“engines
”字段,以便使用正确的Node.js版本构建DApp及安装其相关的依赖项。
Package.json中“engines”字段配置参考链接:https://docs.npmjs.com/files/package.json#engines
配置truffle
Truffle创建一些空的配置文件,truffle.js和truffle-config.js。在Windows系统上truffle.js名称可能会引起冲突,当您尝试运行命令truffle时,Windows尝试运行truffle.js代替。为了避免这种情况,我们将删除truffle.js和使用truffle-config.js支持Windows用户,老实说,他们已经受够了。
$ rm truffle.js
现在我们编辑truffle-config.js,内容替换为:
truffle-config.js:truffle配置,让我们开始
module.exports = {
networks: {
localnode: { // Whatever network our local node connects to
network_id: "*", // Match any network id
host: "localhost",
port: 8545,
}
}
};
上面的配置是一个很好的起点。它设置一个默认的Ethereum网络(名为localnode),该网络假定您正在运行一个Ethereum客户机(如parity),要么作为一个完整的节点,要么作为一个轻量级客户机。此配置将指示truffle通过端口8545上的RPC与本地节点通信。Truffle将使用本地节点连接到的任何Ethereum网络,比如Ethereum主网络,或者像Ropsten这样的测试网络。本地节点也将提供钱包功能。
在接下来的小节中,我们将为truffle配置其他网络,例如ganache test-RPC区块链和托管网络提供商Infura。随着我们添加更多的网络,配置文件将变得更加复杂,但它也将为我们的测试和开发工作流提供更多的选项。
使用truffle部署合约
现在,我们有了一个用于我们的水龙头项目的基本工作目录,并配置了truffle和它的依赖项。合约进入我们项目的合约子目录。该目录已经包含了一个“helper”合约,Migrations.sol为我们管理合约升级。我们将检查Migrations.sol的使用在后面的部分。
让我们复制Faucet.sol合同(从[solid _faucet_example])到contract子目录,因此项目目录如下所示:
Faucet
├── contracts
│ ├── Faucet.sol
│ └── Migrations.sol
...
现在我们可以要求truffle为我们编译合同:
$ truffle compile
Compiling ./contracts/Faucet.sol...
Compiling ./contracts/Migrations.sol...
Writing artifacts to ./build/contracts
Truffle迁移——理解部署脚本
Truffle提供了一个名为migration的部署系统。如果您在其他框架中工作过,您可能会看到类似的东西:Ruby on Rails、Python Django和许多其他语言和框架都有migrate命令。
在所有这些框架中,迁移的目的是处理不同版本的软件之间的数据模式的变化。以太坊的迁移目的略有不同。因为以太坊合约是不可变的,并且成本高昂,因此truffle提供了一种迁移机制来跟踪哪些合约(以及哪些版本)已经被部署。在一个包含数十个合约和复杂依赖项的复杂项目中,您不希望必须花钱重新部署没有更改的合约。您也不希望手动跟踪已经部署了哪些合约版本。truffle迁移机制通过部署智能合约Migrations.sol完成了这一切,然后跟踪所有其他合约部署。
我们只有一个合同,Faucet.sol,至少可以说,迁移系统是过度的。不幸的是,我们不得不使用它。但是,通过学习如何在一个合约中使用它,我们可以开始为我们的开发工作流实践一些好习惯。随着事情变得越来越复杂,这种努力将会得到回报。
Truffle的migrations目录是找到迁移脚本的地方。现在,只有一个脚本1_initial_migration。它部署Migrations.sol合约本身:
include::code/Faucet/migrations/1_initial_migration.js
我们需要第二个迁移脚本,以部署Faucet.sol。我们叫它2_deploy_contracts.js。它非常简单,就像1_initial_migration.js,只有几个小的改变。事实上,您可以复制1_initial_migration.js的内容。用Faucet替换所有Migrations的实例:
include::code/Faucet/migrations/2_deploy_contracts.js
脚本初始化变量Faucet,标识Faucet.sol的Solidity源代码是定义Faucet的工件。然后,它调用部署函数来部署这个合约。
我们都准备好了。让我们使用truffle migrate来部署合约。我们必须使用——network参数来指定部署合约的网络。配置文件中只指定了一个网络,我们将其命名为localnode。确保您的本地Ethereum客户端正在运行,然后输入:
Faucet $ truffle migrate --network localnode
因为我们正在使用一个本地节点连接到Ethereum网络并管理我们的钱包,所以我们必须授权truffle创建的事务。我正在运行连接到Ropsten测试区块链的奇偶校验,因此在truffle迁移期间,我将在奇偶校验的web控制台看到一个弹出:
您将看到总共四笔交易。一个用于部署迁移,一个用于将部署计数器更新为1,一个用于部署Faucet,另一个用于将部署计数器更新为2。
truffle将显示迁移完成,显示每个交易并显示合同地址:
$ truffle migrate --network localnode
Using network 'localnode'.
Running migration: 1_initial_migration.js
Deploying Migrations...
... 0xfa090db179d023d2abae543b4a21a1479e70ca7d35a469a5d1a98bfc6bd80fe8
Migrations: 0x8861c27715550bed8362c0345add158489df6db0
Saving successful migration to network...
... 0x985c4a32716826ddbe4eae284104bef8bc69e959899f62246a1b27c9dfcd6c03
Saving artifacts...
Running migration: 2_deploy_contracts.js
Deploying Faucet...
... 0xecdbeef77f0558edc689440e34b7bba0a3ba7a45e4b680b071b47c30a930e9d6
Faucet: 0xd01cd8e7bd29e4bff8c1693f59eee46137a9f300
Saving successful migration to network...
... 0x11f376bd7307edddfd40dc4a14c3f7cb84b6c921ac2465602060b67d08f9fd8a
Saving artifacts...
使用truffle控制台
Truffle提供了一个JavaScript控制台,我们可以使用它与以太坊网络(通过本地节点)进行交互,与已部署的合同进行交互,并与钱包提供商进行交互。在我们当前的配置(localnode)中,节点和钱包提供程序是我们的本地奇偶校验客户端。
让我们启动松露控制台并尝试一些命令: