forge

名称

forge - 构建、测试、模糊、调试和部署 Solidity 合约。

简介

forge [options] command [args]
forge [options] --version
forge [options] --help

描述

该程序是一套用于构建、测试、模糊、调试和部署 Solidity 智能合约的工具。

命令

一般命令

forge help
    显示关于 Forge 的帮助信息。

forge completions
    为 Forge 生成 shell 的自动补全。

项目命令

forge init
    创建一个新的 Forge 项目。

forge clone
    将一个链上验证过的合约克隆为一个Forge项目。

forge install
    安装一个或多个依赖。

forge update
    更新一个或多个依赖。

forge remove
    移除一个或多个依赖。

forge config
    显示当前配置。

forge remappings
    获取这个项目的自动推断的重映射。

forge tree
    显示项目的树状可视化依赖关系图。

forge geiger     检测在 Foundry 项目及其依赖中使用的不安全作弊码。

构建命令

forge build
    构建项目的智能合约。

forge clean
    移除构建的 artifacts 和 cache 目录。

forge inspect
    获取关于智能合约的专门信息。

测试命令

forge test
    运行项目的测试。

forge snapshot
    创建每个测试的 Gas 使用快照。

forge coverage
    生成覆盖率报告

部署命令

forge create
    部署一个智能合约

forge verify-contract
    在 Etherscan 上验证智能合约。

forge verify-check
    在 Etherscan 上检查验证状态。

forge flatten
    将一个源文件及其所有的导入文件扁平化到一个文件中。

实用命令

forge debug
    将单个智能合约作为脚本进行调试。

forge bind
    为智能合约生成 Rust bindings。

forge cache
    管理 Foundry 缓存。

forge cache clean
    从 ~/.foundry 清除缓存数据。

forge cache ls
    从 ~/.foundry 显示缓存数据。

forge script
    以脚本形式运行智能合约,建立可在链上发送的交易。

forge upload-selectors
    将给定合约的 ABI 上传至 https://sig.eth.samczsun.com 函数选择器数据库。

forge doc
    为 Solidity 源文件生成文档。

选项

特别选项

-V
--version
    打印版本信息并退出。

普通选项

-h
--help
    打印帮助信息。

文件

~/.foundry/
    Foundry 的 "home" 目录的默认位置,它存储各种文件。

~/.foundry/bin/
    使用 foundryup 安装的二进制文件将位于这里。

~/.foundry/cache/
    Forge 的缓存目录,它在那里存储缓存的块数据和更多。

~/.foundry/foundry.toml
    全局 Foundry 配置.

~/.svm
    Forge 管理的 solc 二进制文件的位置。

例子

  1. 创建一个新的 Forge 项目:

    forge init hello_foundry
    
  2. 构建一个项目:

    forge build
    
  3. 运行一个项目的测试:

    forge test
    

BUGS

Issues 请看 https://github.com/foundry-rs/foundry/issues