truffle

:warning: Truffle Suite 正在逐步停止维护。有关持续支持、迁移选项和常见问题解答的信息，请访问 Consensys 博客。感谢多年来的支持。

<img src="https://yellow-cdn.veclightyear.com/ab5030c0/3905c765-185a-4b1c-aaba-05705fa6e97f.svg" width="200">

---

Truffle 是一个以太坊开发环境、测试框架和资产管道，旨在简化以太坊开发者的工作。使用 Truffle，您可以获得：

• 内置的智能合约编译、链接、部署和二进制管理。
• 使用 Mocha 和 Chai 进行自动化合约测试。
• 可配置的构建管道，支持自定义构建流程。
• 可编写脚本的部署和迁移框架。
• 网络管理，可部署到多个公共和私有网络。
• 用于直接合约通信的交互式控制台。
• 开发过程中资产的即时重建。
• 在 Truffle 环境中执行脚本的外部脚本运行器。

ℹ️ 贡献者：请查看本 README 的开发部分。

安装

$ npm install -g truffle

注意：为避免任何奇怪的权限错误，我们建议使用 nvm。

快速使用

对于默认的合约和测试集，在空项目目录中运行以下命令：

$ truffle init

之后，您可以运行 truffle compile、truffle migrate 和 truffle test 来编译合约、将合约部署到网络，并运行相关的单元测试。

Truffle 自带本地开发区块链服务器，在调用上述命令时会自动启动。如果您想配置更高级的开发环境，我们建议您通过在命令行运行 npm install -g ganache 单独安装区块链服务器。

• ganache：Truffle 区块链服务器的命令行版本。
• ganache-ui：服务器的图形用户界面，显示您的交易历史和链状态。

文档

请参阅官方 Truffle 文档获取指南、技巧和示例。

开发

我们欢迎拉取请求。要开始，只需 fork 此仓库，在本地克隆，然后运行：

# 安装
npm install -g yarn
yarn bootstrap

# 测试
yarn test

# 向包添加依赖
cd packages/<truffle-package>
yarn add <npm-package> [--dev] # 使用 yarn

如果您想在所有包中将依赖更新到相同版本，可能会发现这个工具很有用。

项目分支说明：

• master：稳定的发布版本 (v5)
• beta：发布的测试版本
• develop：针对稳定版本的开发工作 (v5)
• next：目前未使用

请针对 develop 分支提交拉取请求。

在 CONTRIBUTING.md 文件中有更多信息。

许可证

MIT