web3
以太坊JSON-RPC多传输客户端。 Web3.js库的Rust实现。
文档: crates.io
状态
请注意,这个包几乎不再维护,我正在寻找一位积极的维护者(参见 #664)。 如果你正在开始一个新项目,我建议选择 https://github.com/gakonst/ethers-rs 。
使用方法
首先,在你的 Cargo.toml
中添加以下内容:
[dependencies]
web3 = "0.19.0"
示例
#[tokio::main]
async fn main() -> web3::Result<()> {
let transport = web3::transports::Http::new("http://localhost:8545")?;
let web3 = web3::Web3::new(transport);
println!("调用账户。");
let mut accounts = web3.eth().accounts().await?;
println!("账户: {:?}", accounts);
accounts.push("00a329c0648769a73afac7f9381e08fb43dbea72".parse().unwrap());
println!("调用余额。");
for account in accounts {
let balance = web3.eth().balance(account, None).await?;
println!("{:?} 的余额: {}", account, balance);
}
Ok(())
}
如果你想部署你编写的智能合约,你可以这样做(确保你已安装 Solidity 编译器):
solc -o build --bin --abi contracts/*.sol
Solidity 编译器会为 contracts 目录中的智能合约生成二进制文件和 ABI 代码,并输出到名为 build 的目录中。
更多示例请查看 examples 文件夹。
Futures 迁移
- 移除 parking_lot(如果真的需要,替换为异步感知锁)。
- 考虑移除
Unpin
要求。(#361) - WebSockets: TLS 支持 (#360)
- WebSockets: 重新连接 & Pings
- 考虑在
ws.rs
传输中使用tokio
替代async-std
(测试问题)。 - 恢复 IPC 传输
通用
- 更灵活的 API(接受
Into<X>
) - 合约调用(ABI 编码;
debris/ethabi
) - 批量请求
传输
- HTTP 传输
- IPC 传输
- WebSockets 传输
类型
-
U256,H256,Address(H160)
类型 - 索引类型(数字,编码为十六进制)
- 交易类型(来自 Parity 的
Transaction
) - 交易收据类型(来自 Parity 的
TransactionReceipt
) - 区块类型(来自 Parity 的
RichBlock
) - 工作类型(来自 Parity 的
Work
) - 同步类型(来自 Parity 的
SyncStats
)
APIs
- Eth:
eth_*
- Eth 过滤器:
eth_*
- Eth pubsub:
eth_*
-
net_*
-
web3_*
-
personal_*
-
traces_*
Parity 特定 APIs
-
Parity 只读:
parity_*
-
Parity 账户:
parity_*
(部分实现) -
Parity 设置:
parity_*
-
signer_*
-
自定义 APIs(可扩展)
let web3 = Web3::new(transport);
web3.api::<CustomNamespace>().custom_method().wait().unwrap()
Windows 安装
目前,Windows 不支持 IPC,而该库默认启用 IPC。 要编译,你需要禁用 IPC 功能:
web3 = { version = "_", default-features = false, features = ["http"] }
避免 OpenSSL 依赖
在 Linux 上,native-tls
使用 OpenSSL 实现。要避免 HTTPS 或 WSS 的这种依赖,请使用相应的功能。
web3 = { version = "_", default-features = false, features = ["http-rustls-tls", "ws-rustls-tokio"] }
注意:要完全复制默认功能,还需添加 signing
和 ipc-tokio
功能。
Cargo 功能
该库支持以下功能:
http
- 启用 HTTP 传输(需要tokio
运行时,因为使用了hyper
)。http-tls
- 通过reqwest/default-tls
为 HTTP 传输启用 TLS 支持(包含http
;默认)。http-native-tls
- 通过reqwest/native-tls
为 HTTP 传输启用 TLS 支持(包含http
)。http-rustls-tls
- 通过reqwest/rustls-tls
为 HTTP 传输启用 TLS 支持(包含http
)。ws-tokio
- 使用tokio
运行时启用 WS 传输。ws-tls-tokio
- 为 WS 传输启用 TLS 支持(包含ws-tokio
;默认)。ws-rustls-tokio
- 为 WS 传输启用 rustls TLS 支持(包含ws-tokio
)。ws-async-std
- 使用async-std
运行时启用 WS 传输。ws-tls-async-std
- 为 WS 传输启用 TLS 支持(包含ws-async-std
)。ipc-tokio
- 使用tokio
运行时启用 IPC 传输(默认)。signing
- 启用账户命名空间和本地签名支持(默认)。eip-1193
- 启用 EIP-1193 支持。wasm
- 编译为 WASM(确保禁用默认功能)。arbitrary_precision
- 在serde_json
中启用arbitrary_precision
。allow-missing-fields
- 某些响应字段在以太坊中是必需的,但在兼容 EVM 的链(如 Celo 和 Fantom)中不存在。此功能通过为这些字段设置默认值来实现兼容性。