Rust分叉数据库管理库foundry-fork-db的使用指南

概述

foundry-fork-db 是一个用于以太坊开发的高效链上数据模拟与测试环境搭建的Rust库，它是Foundry工具链的一部分。该库允许开发者在本地创建分叉(fork)的以太坊环境，模拟主网或测试网状态，便于进行合约测试和开发。

主要特性

• 支持从任意以太坊网络(主网、测试网)创建分叉
• 提供内存数据库实现，快速模拟链上状态
• 支持自定义区块号和链ID
• 与Foundry工具链无缝集成
• 高性能的链上数据缓存机制

安装方法

在Cargo.toml中添加依赖：

[dependencies]
foundry-fork-db = "0.1.0"  # 请使用最新版本

基本使用方法

1. 创建分叉数据库

use foundry_fork_db::{
    fork_db::ForkDb,
    fork_factory::ForkFactory,
};

#[tokio::main]
async fn main() {
    // 从以太坊主网在区块号15000000创建分叉
    let fork_url = "https://mainnet.infura.io/v3/YOUR_INFURA_KEY";
    let fork_block_number = Some(15000000);
    
    let fork_factory = ForkFactory::new(fork_url);
    let fork_db = fork_factory.create_fork(fork_block_number).await.unwrap();
    
    println!("Fork created at block {}", fork_db.block_number());
}

2. 查询分叉状态

use ethers::types::Address;

// 继续上面的代码
let dai_address: Address = "0x6B175474E89094C44Da98b954EedeAC495271d0F".parse().unwrap();
let dai_balance = fork_db.get_balance(dai_address).await.unwrap();

println!("DAI合约在分叉区块的余额: {}", dai_balance);

3. 修改分叉状态

use ethers::types::{Address, U256};

let user_address: Address = "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B".parse().unwrap();

// 给用户地址充值100ETH
fork_db.set_balance(user_address, U256::from(100) * U256::exp10(18)).unwrap();

// 验证余额
let new_balance = fork_db.get_balance(user_address).await.unwrap();
println!("用户新余额: {} ETH", new_balance);

高级用法

1. 与测试框架集成

use foundry_fork_db::fork_factory::ForkFactory;
use foundry_evm::executor::Executor;

#[tokio::test]
async fn test_contract_on_fork() {
    let fork_factory = ForkFactory::new("https://mainnet.infura.io/v3/YOUR_KEY");
    let fork_db = fork_factory.create_fork(None).await.unwrap();
    
    let mut executor = Executor::new(fork_db);
    
    // 在这里部署和测试合约
    // ...
}

2. 多分叉管理

use foundry_fork_db::fork_factory::ForkFactory;

#[tokio::main]
async fn main() {
    let fork_factory = ForkFactory::new("https://mainnet.infura.io/v3/YOUR_KEY");
    
    // 创建两个不同区块高度的分叉
    let fork_db1 = fork_factory.create_fork(Some(15000000)).await.unwrap();
    let fork_db2 = fork_factory.create_fork(Some(16000000)).await.unwrap();
    
    // 比较两个分叉状态下某个合约的差异
    // ...
}

性能优化技巧

1. 使用本地缓存：配置分叉数据库使用本地缓存可以显著提高性能

   let fork_factory = ForkFactory::new("https://mainnet.infura.io/v3/YOUR_KEY")
       .with_cache_dir("/path/to/cache");
   

2. 限制获取的状态：只获取测试需要的状态数据

   let fork_db = fork_factory.create_fork_with_state(
       Some(15000000),
       vec![address1, address2]  // 只获取这些地址的状态
   ).await.unwrap();
   

3. 批量操作：使用批量查询和写入方法减少RPC调用

注意事项

1. 需要稳定的RPC节点连接，推荐使用Infura或Alchemy等服务
2. 分叉数据库会占用较多内存，特别是模拟大区块时
3. 测试完成后应清理缓存文件，特别是运行大量测试时

foundry-fork-db为以太坊智能合约开发提供了强大的测试环境模拟能力，可以显著提高开发效率和测试覆盖率。

完整示例demo

下面是一个完整的foundry-fork-db使用示例，展示了创建分叉、查询状态和修改状态的全流程：

use foundry_fork_db::{fork_db::ForkDb, fork_factory::ForkFactory};
use ethers::types::{Address, U256};
use std::str::FromStr;

#[tokio::main]
async fn main() {
    // 1. 创建分叉数据库
    let fork_url = "https://mainnet.infura.io/v3/YOUR_INFURA_KEY";
    let fork_block_number = Some(15000000);
    
    let fork_factory = ForkFactory::new(fork_url)
        .with_cache_dir("/tmp/fork_cache"); // 启用本地缓存
    
    println!("正在创建分叉...");
    let fork_db = fork_factory.create_fork(fork_block_number).await.unwrap();
    println!("成功创建分叉，区块高度: {}", fork_db.block_number());

    // 2. 查询状态
    let dai_address = Address::from_str("0x6B175474E89094C44Da98b954EedeAC495271d0F").unwrap();
    let dai_balance = fork_db.get_balance(dai_address).await.unwrap();
    println!("DAI合约余额: {}", dai_balance);

    // 3. 修改状态
    let user_address = Address::from_str("0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B").unwrap();
    let amount = U256::from(100) * U256::exp10(18); // 100 ETH
    
    println!("修改用户余额...");
    fork_db.set_balance(user_address, amount).unwrap();
    
    // 验证修改
    let new_balance = fork_db.get_balance(user_address).await.unwrap();
    println!("用户新余额: {} ETH", new_balance);
    
    // 4. 批量操作示例
    let addresses = vec![
        Address::from_str("0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045").unwrap(), // vitalik.eth
        Address::from_str("0x1db3439a222c519ab44bb1144fc28167b4fa6ee6").unwrap() // 随机地址
    ];
    
    println!("批量查询余额...");
    for addr in addresses {
        let balance = fork_db.get_balance(addr).await.unwrap();
        println!("地址 {} 的余额: {}", addr, balance);
    }
}

这个完整示例展示了：

1. 使用缓存目录创建分叉数据库
2. 查询特定合约的余额
3. 修改用户地址的余额
4. 批量查询多个地址的余额

要运行此示例，请确保：

1. 替换YOUR_INFURA_KEY为实际的Infura API密钥
2. 确保已安装tokio运行时
3. Cargo.toml中包含所有必要的依赖项