1 个不稳定版本

0.1.0 2023年7月17日

#46#json-rpc-client

MIT 许可证

535KB
11K SLoC

web3

Ethereum JSON-RPC 多传输客户端。Web3.js 库的 Rust 实现。

Build Status Crates.io

文档: crates.io

状态

请注意,此包维护得很少,我正在寻找活跃的维护者(参见 #664)。如果您正在启动新项目,我建议选择 https://github.com/gakonst/ethers-rs

用法

首先,将以下内容添加到您的 Cargo.toml

[dependencies]
web3 = "0.18.0"

示例

#[tokio::main]
async fn main() -> web3::Result<()> {
    let transport = web3::transports::Http::new("https://127.0.0.1:8545")?;
    let web3 = web3::Web3::new(transport);

    println!("Calling accounts.");
    let mut accounts = web3.eth().accounts().await?;
    println!("Accounts: {:?}", accounts);
    accounts.push("00a329c0648769a73afac7f9381e08fb43dbea72".parse().unwrap());

    println!("Calling balance.");
    for account in accounts {
        let balance = web3.eth().balance(account, None).await?;
        println!("Balance of {:?}: {}", account, balance);
    }

    Ok(())
}

如果您想部署您编写的智能合约,可以这样做(确保您已安装了 Solidity 编译器)

solc-o build--bin--abi contracts/*.sol

Solidity 编译器正在生成智能合约的二进制和 ABI 代码,并将其输出到名为 contracts 的目录,并在名为 build 的目录中输出。

更多信息请参阅 示例文件夹

未来迁移

  • 移除 parking_lot(如果真的需要,则替换为异步感知锁)。
  • 考虑移除 Unpin 要求。(#361)
  • WebSockets:TLS 支持 (#360)
  • WebSockets:重新连接 & Pings
  • 考虑使用 tokio 替代 async-std 用于 ws.rs 传输(测试问题)。
  • 恢复 IPC 传输

通用

  • 更灵活的 API(接受 Into<X>
  • 合约调用(ABI 编码;debris/ethabi
  • 批量请求

传输

  • HTTP 传输
  • IPC 传输
  • WebSockets 传输

类型

  • 类型为 U256,H256,Address(H160)
  • 索引类型(数值,编码为十六进制)
  • 交易类型(来自 Parity 的 Transaction
  • 交易收据类型(来自 Parity 的 TransactionReceipt
  • 区块类型(来自Parity的RichBlock
  • 工作类型(来自Parity的Work
  • 同步类型(来自Parity的SyncStats

API

  • Eth: eth_*
  • Eth过滤器: eth_*
  • Eth pubsub: eth_*
  • net_*
  • web3_*
  • personal_*
  • traces_*

Parity特定API

  • Parity只读: parity_*

  • Parity账户: parity_*(部分实现)

  • Parity设置: parity_*

  • signer_*

  • 自有API(可扩展)

let web3 = Web3::new(transport);
web3.api::<CustomNamespace>().custom_method().wait().unwrap()

Windows上的安装

目前,Windows不支持IPC,该库默认启用。要编译,您需要禁用IPC功能

web3 = { version = "0.18.0", default-features = false, features = ["http"] }

避免OpenSSL依赖

在Linux上,native-tls使用OpenSSL实现。为了避免HTTPS的依赖,请使用相应的功能。

web3 = { version = "0.18.0", default-features = false, features = ["http-rustls-tls"] }

Cargo功能

该库支持以下功能

  • http - 启用HTTP传输(因为hyper,需要tokio运行时)。
  • 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-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 - 在以太坊中某些响应字段是强制性的,但在Celo和Fantom等与EVM兼容的链中不存在。此功能通过在这些字段上设置默认值来启用兼容性。

依赖关系

~5–21MB
~317K SLoC