这里写自定义目录标题
使用Rust直接编译单个的Solidity合约
前言
我们知道,我们平常开发Solidity智能合约时一般使用Hardhat框架,但是如果你是一个Rustacean (这是由 "Rust" 和 "crustacean" -甲壳类动物 结合而来的俏皮称呼),也许你会使用Foundry框架进行开发。开发好了之后,我们要编写相关应用怎么办?通常的做法是将编译好的合约字节码和ABI复制到其它项目中去,然后使用各种框架来编写我们的Dapp。
但是这里有一个问题,如果合约只是简单的合约,或者是一个flatten之后的合约,如果有任何修改,你都必须在Hardhat或者Foundry中进行重新编译,然后重复复制到Dapp目录(偷懒的做法是使用一个sh 脚本自动去做这些事)。那么,作为一个Rustacean来讲,你肯定在想,能否在我的Dapp中使用Rust语言来直接编译这个合约呢?答案是肯定的。
这样做的目的是为我们节省不少工序,如果只是一个简单的没有外部依赖的合约,或者是一个Flatten后的合约,我们直接在Dapp目录进行开发和编译及使用其它库进行交互,不必重新建立hardhat或者foundry工程。
但是这是有前提的,我们直接使用Rust编译并不会自动查找它的外部依赖,因此这是我说的只能编译简单合约或者flatten合约的原因。
预备知识
Rust 语言本身无法编译Solidity或者Vyper智能合约,因此它还是得调用第三方编译工具进行。通常这个工具为solc。其原理就是Rust调用solc,再由solc来编译合约。
但是Rust调用solc这一步已经有第三方库抽象好了,我们不必手动去实现了。
在我们的示例中,我们使用 foundry-compilers
这个crate
来调用solc
进行编译,它其实是Foundry
内部工具的一部分。
准备工作
上面提到了,还是得第三方编译工具。因此我们得安装solc,具体方法为:
bash
brew install solc-select
solc-select install 0.8.24
solc-select use 0.8.24
示例
-
运行
cargo new sol_demo
来新建一个rust 工程 -
在项目根目录下建立
contracts
目录,这是hardhat框架常用的源文件目录。 -
在
contracts
目录下新建Counter.sol
,内容如下:solidity// SPDX-License-Identifier: MIT pragma solidity ^0.8.24; contract Counter { uint256 public number; function setNumber(uint256 newNumber) public { number = newNumber; } function increment() public { number++; } }
-
在
Cargo.toml
中添加如下依赖toml[dependencies] foundry-compilers = "0.11.0"
-
将
main.rs
替换为如下内容:rustuse foundry_compilers::{Project, ProjectPathsConfig}; use std::path::Path; use std::env; fn main() { // 这个环境变量会识别为运行cargo的项目根目录 let cargo_manifest_dir = env::var("CARGO_MANIFEST_DIR").unwrap(); // configure the project with all its paths, solc, cache etc. let project = Project::builder() .paths(ProjectPathsConfig::hardhat(Path::new(&cargo_manifest_dir)).unwrap()) .build(Default::default()) //Default::default()这里其实返回的是MultiCompilers,可以编译vyper和solidity .unwrap(); // 这里也可以使用compile()函数编译contracts目录下的所有文件,有外部依赖的得提前导入 let output = project.compile_file("contracts/Counter.sol").unwrap(); // 如果有任何错误,panic output.succeeded(); println!("Compilation succeeded."); // Tell Cargo that if a source file changes, to rerun this build script. // project.rerun_if_sources_changed(); }
-
打开终端,在项目根目录下运行
cargo run
,得到Compilation succeeded.
输出。 -
同时查看项目根目录,会发现多了
artifacts
和cache
目录,如下图所示:
真正使用时,你其实是另外起一个bin目录,在这里面做编译工作,而主main.rs
一般做交互工作。