2 stable releases
1.1.0 | Oct 24, 2022 |
---|---|
1.0.0 | Sep 23, 2022 |
#43 in #json-rpc-client
520KB
11K
SLoC
web3 FE
Ethereum JSON-RPC multi-transport client. Rust implementation of Web3.js library. Fathom Edition.
Documentation: crates.io
Usage
First, add this to your Cargo.toml
:
[dependencies]
fathom_web3 = "1.0.0"
Example
#[tokio::main]
async fn main() -> fathom_web3::Result<()> {
let transport = fathom_web3::transports::Http::new("http://localhost:8545")?;
let web3 = fathom_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(())
}
If you want to deploy smart contracts you have written you can do something like this (make sure you have the solidity compiler installed):
solc -o build --bin --abi contracts/*.sol
The solidity compiler is generating the binary and abi code for the smart contracts in a directory called contracts and is being output to a directory called build.
For more see examples folder.
Futures migration
- Get rid of parking_lot (replace with async-aware locks if really needed).
- Consider getting rid of
Unpin
requirements. (#361) - WebSockets: TLS support (#360)
- WebSockets: Reconnecting & Pings
- Consider using
tokio
instead ofasync-std
forws.rs
transport (issue with test). - Restore IPC Transport
General
- More flexible API (accept
Into<X>
) - Contract calls (ABI encoding;
debris/ethabi
) - Batch Requests
Transports
- HTTP transport
- IPC transport
- WebSockets transport
Types
- Types for
U256,H256,Address(H160)
- Index type (numeric, encoded to hex)
- Transaction type (
Transaction
from Parity) - Transaction receipt type (
TransactionReceipt
from Parity) - Block type (
RichBlock
from Parity) - Work type (
Work
from Parity) - Syncing type (
SyncStats
from Parity)
APIs
- Eth:
eth_*
- Eth filters:
eth_*
- Eth pubsub:
eth_*
-
net_*
-
web3_*
-
personal_*
-
traces_*
Parity-specific APIs
-
Parity read-only:
parity_*
-
Parity accounts:
parity_*
(partially implemented) -
Parity set:
parity_*
-
signer_*
-
Own APIs (Extendable)
let web3 = Web3::new(transport);
web3.api::<CustomNamespace>().custom_method().wait().unwrap()
Installation on Windows
Currently, Windows does not support IPC, which is enabled in the library by default. To compile, you need to disable the IPC feature:
fathom_web3 = { version = "1.0.0", default-features = false, features = ["http"] }
Avoiding OpenSSL dependency
On Linux, native-tls
is implemented using OpenSSL. To avoid that dependency
for HTTPS use the corresponding feature.
fathom_web3 = { version = "1.0.0", default-features = false, features = ["http-rustls-tls"] }
Cargo Features
The library supports following features:
http
- Enables HTTP transport (requirestokio
runtime, because ofhyper
).http-tls
- Enables TLS support viareqwest/default-tls
for HTTP transport (implieshttp
; default).http-native-tls
- Enables TLS support viareqwest/native-tls
for HTTP transport (implieshttp
).http-rustls-tls
- Enables TLS support viareqwest/rustls-tls
for HTTP transport (implieshttp
).ws-tokio
- Enables WS transport usingtokio
runtime.ws-tls-tokio
- Enables TLS support for WS transport (impliesws-tokio
; default).ws-async-std
- Enables WS transport usingasync-std
runtime.ws-tls-async-std
- Enables TLS support for WS transport (impliesws-async-std
).ipc-tokio
- Enables IPC transport usingtokio
runtime (default).signing
- Enable account namespace and local-signing support (default).eip-1193
- Enable EIP-1193 support.wasm
- Compile for WASM (make sure to disable default features).arbitrary_precision
- Enablearbitrary_precision
inserde_json
.
Dependencies
~5–21MB
~316K SLoC