20 releases (13 breaking)

0.13.0 Jul 13, 2020
0.11.0 May 18, 2020
0.10.0 Jan 28, 2020
0.8.0 Jul 12, 2019
0.0.2 Dec 28, 2016

#2 in Cryptocurrencies

Download history 2640/week @ 2020-04-20 2408/week @ 2020-04-27 1226/week @ 2020-05-04 798/week @ 2020-05-11 1051/week @ 2020-05-18 921/week @ 2020-05-25 1039/week @ 2020-06-01 870/week @ 2020-06-08 1461/week @ 2020-06-15 2183/week @ 2020-06-22 2605/week @ 2020-06-29 2911/week @ 2020-07-06 2838/week @ 2020-07-13 3147/week @ 2020-07-20 3781/week @ 2020-07-27 3512/week @ 2020-08-03

7,099 downloads per month
Used in 18 crates (15 directly)

MIT license

350KB
8K SLoC

rust-web3

Ethereum JSON-RPC multi-transport client. Rust implementation of Web3.js library.

Build Status

Documentation

Usage

First, add this to your Cargo.toml:

[dependencies]
web3 = { git = "https://github.com/tomusdrw/rust-web3" }

Example

#[tokio::main]
async fn main() -> web3::Result<()> {
    let transport = web3::transports::Http::new("http://localhost: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(())
}

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.

Opt-out Features

  • http - Enables HTTP transport (requires tokio runtime, because of hyper).
  • http-tls - Enables TLS support for HTTP transport (implies http).
  • ws - Enables WS transport.
  • ws-tls - Enables TLS support for WS transport (implies ws).

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 of async-std for ws.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 complile, you need to disable the IPC feature:

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

Dependencies

~3.5–6.5MB
~131K SLoC