2020-05-31 16:38:41 +00:00
|
|
|
#![warn(
|
|
|
|
missing_debug_implementations,
|
|
|
|
missing_docs,
|
|
|
|
rust_2018_idioms,
|
|
|
|
unreachable_pub
|
|
|
|
)]
|
|
|
|
#![deny(intra_doc_link_resolution_failure)]
|
|
|
|
#![doc(test(
|
|
|
|
no_crate_inject,
|
|
|
|
attr(deny(warnings, rust_2018_idioms), allow(dead_code, unused_variables))
|
|
|
|
))]
|
|
|
|
#![cfg_attr(docsrs, feature(doc_cfg))]
|
|
|
|
|
|
|
|
//! # ethers-rs
|
2020-05-22 18:37:21 +00:00
|
|
|
//!
|
2020-05-31 16:38:41 +00:00
|
|
|
//! > ethers-rs is a port of [ethers-js](github.com/ethers-io/ethers.js) in Rust.
|
2020-05-24 15:55:46 +00:00
|
|
|
//!
|
|
|
|
//! # Quickstart
|
|
|
|
//!
|
2020-06-04 18:44:02 +00:00
|
|
|
//! A prelude is provided which imports all the important things for you. You can connect
|
|
|
|
//! to the chain by providing a URL to the Provider along with the provider type (Http/Websockets).
|
|
|
|
//!
|
|
|
|
//! ```no_run
|
|
|
|
//! use ethers::prelude::*;
|
|
|
|
//! let provider = Provider::<Http>::try_from("http://localhost:8545").unwrap();
|
|
|
|
//! ```
|
|
|
|
//!
|
|
|
|
//! All functions
|
|
|
|
//!
|
|
|
|
//!
|
2020-05-24 15:55:46 +00:00
|
|
|
//! ## Sending Ether
|
|
|
|
//!
|
|
|
|
//! ## Checking the state of the blockchain
|
|
|
|
//!
|
|
|
|
//! ## Deploying and interacting with a smart contract
|
|
|
|
//!
|
|
|
|
//! ## Watching on-chain events
|
|
|
|
//!
|
|
|
|
//! More examples can be found in the [`examples` directory of the
|
|
|
|
//! repositry](https://github.com/gakonst/ethers-rs)
|
2020-05-22 18:37:21 +00:00
|
|
|
|
2020-05-26 11:00:56 +00:00
|
|
|
#[cfg(feature = "contract")]
|
2020-05-31 16:38:41 +00:00
|
|
|
#[cfg_attr(docsrs, doc(cfg(feature = "contract")))]
|
|
|
|
/// TODO
|
2020-05-26 11:00:56 +00:00
|
|
|
pub mod contract {
|
|
|
|
pub use ethers_contract::*;
|
|
|
|
}
|
2020-05-24 16:43:47 +00:00
|
|
|
|
2020-05-26 11:00:56 +00:00
|
|
|
#[cfg(feature = "providers")]
|
2020-05-31 16:38:41 +00:00
|
|
|
#[cfg_attr(docsrs, doc(cfg(feature = "providers")))]
|
|
|
|
/// # Clients for interacting with Ethereum nodes
|
|
|
|
///
|
|
|
|
/// This crate provides asynchronous [Ethereum JSON-RPC](https://github.com/ethereum/wiki/wiki/JSON-RPC)
|
|
|
|
/// compliant clients. The client is network-specific in order to provide ENS support and EIP-155
|
|
|
|
/// replay protection. If you are testing and do not want to use EIP-155, you may use the `Any`
|
|
|
|
/// network type and override the provider's ENS address with the `ens` method.
|
|
|
|
///
|
|
|
|
/// ```rust
|
2020-06-02 21:16:08 +00:00
|
|
|
/// use ethers::providers::{Provider, Http};
|
2020-05-31 16:38:41 +00:00
|
|
|
/// use std::convert::TryFrom;
|
|
|
|
/// use tokio::runtime::Runtime;
|
|
|
|
///
|
2020-06-02 21:16:08 +00:00
|
|
|
/// let provider = Provider::<Http>::try_from(
|
|
|
|
/// "https://mainnet.infura.io/v3/c60b0bb42f8a4c6481ecd229eddaca27"
|
2020-05-31 16:38:41 +00:00
|
|
|
/// ).unwrap();
|
|
|
|
///
|
|
|
|
/// // Since this is an async function, we need to run it from an async runtime,
|
|
|
|
/// // such as `tokio`
|
|
|
|
/// let mut runtime = Runtime::new().expect("Failed to create Tokio runtime");
|
|
|
|
/// let block = runtime.block_on(provider.get_block(100u64)).unwrap();
|
|
|
|
/// println!("Got block: {}", serde_json::to_string(&block).unwrap());
|
|
|
|
/// ```
|
|
|
|
///
|
|
|
|
/// # Ethereum Name Service
|
|
|
|
///
|
|
|
|
/// The provider may also be used to resolve [Ethereum Name Service](https://ens.domains) (ENS) names
|
|
|
|
/// to addresses (and vice versa). The address of the deployed ENS contract per network is specified in
|
|
|
|
/// the `networks` module. If you want to use mainnet ENS, you should instantiate your provider as
|
|
|
|
/// follows:
|
|
|
|
///
|
|
|
|
/// ```rust
|
2020-06-02 21:16:08 +00:00
|
|
|
/// # use ethers::providers::{Provider, Http};
|
2020-05-31 16:38:41 +00:00
|
|
|
/// # use std::convert::TryFrom;
|
|
|
|
/// # use tokio::runtime::Runtime;
|
2020-06-02 21:16:08 +00:00
|
|
|
/// # let provider = Provider::<Http>::try_from(
|
|
|
|
/// # "https://mainnet.infura.io/v3/c60b0bb42f8a4c6481ecd229eddaca27"
|
2020-05-31 16:38:41 +00:00
|
|
|
/// # ).unwrap();
|
|
|
|
/// # let mut runtime = Runtime::new().expect("Failed to create Tokio runtime");
|
|
|
|
/// // Resolve ENS name to Address
|
|
|
|
/// let name = "vitalik.eth";
|
|
|
|
/// let address = runtime.block_on(provider.resolve_name(name)).unwrap();
|
|
|
|
/// let address = address.unwrap();
|
|
|
|
///
|
|
|
|
/// // Lookup ENS name given Address
|
|
|
|
/// let resolved_name = runtime.block_on(provider.lookup_address(address)).unwrap();
|
|
|
|
/// let resolved_name = resolved_name.unwrap();
|
|
|
|
/// assert_eq!(name, resolved_name);
|
|
|
|
/// ```
|
2020-05-26 11:00:56 +00:00
|
|
|
pub mod providers {
|
|
|
|
pub use ethers_providers::*;
|
|
|
|
}
|
2020-05-22 18:37:21 +00:00
|
|
|
|
2020-05-26 11:00:56 +00:00
|
|
|
#[cfg(feature = "signers")]
|
2020-05-31 16:38:41 +00:00
|
|
|
#[cfg_attr(docsrs, doc(cfg(feature = "signers")))]
|
|
|
|
/// # ethers-signers
|
|
|
|
///
|
|
|
|
/// Provides a unified interface for locally signing transactions and interacting
|
|
|
|
/// with the Ethereum JSON-RPC. You can implement the `Signer` trait to extend
|
|
|
|
/// functionality to other signers such as Hardware Security Modules, KMS etc.
|
|
|
|
///
|
|
|
|
/// ```ignore
|
|
|
|
/// # use anyhow::Result;
|
|
|
|
/// # use ethers::{providers::HttpProvider, signers::MainnetWallet, types::TransactionRequest};
|
|
|
|
/// # use std::convert::TryFrom;
|
|
|
|
/// # async fn main() -> Result<()> {
|
|
|
|
/// // connect to the network
|
|
|
|
/// let provider = HttpProvider::try_from("http://localhost:8545")?;
|
|
|
|
///
|
|
|
|
/// // instantiate the wallet and connect it to the provider to get a client
|
|
|
|
/// let client = "dcf2cbdd171a21c480aa7f53d77f31bb102282b3ff099c78e3118b37348c72f7"
|
|
|
|
/// .parse::<MainnetWallet>()?
|
|
|
|
/// .connect(&provider);
|
|
|
|
///
|
|
|
|
/// // create a transaction
|
|
|
|
/// let tx = TransactionRequest::new()
|
|
|
|
/// .to("vitalik.eth") // this will use ENS
|
|
|
|
/// .value(10000);
|
|
|
|
///
|
|
|
|
/// // send it! (this will resolve the ENS name to an address under the hood)
|
|
|
|
/// let hash = client.send_transaction(tx, None).await?;
|
|
|
|
///
|
|
|
|
/// // get the mined tx
|
|
|
|
/// let tx = client.get_transaction(hash).await?;
|
|
|
|
///
|
|
|
|
/// // get the receipt
|
|
|
|
/// let receipt = client.get_transaction_receipt(tx.hash).await?;
|
|
|
|
///
|
|
|
|
/// println!("{}", serde_json::to_string(&tx)?);
|
|
|
|
/// println!("{}", serde_json::to_string(&receipt)?);
|
|
|
|
///
|
|
|
|
/// # Ok(())
|
|
|
|
/// # }
|
2020-05-26 11:00:56 +00:00
|
|
|
pub mod signers {
|
|
|
|
pub use ethers_signers::*;
|
|
|
|
}
|
2020-05-23 00:01:20 +00:00
|
|
|
|
2020-05-31 16:01:34 +00:00
|
|
|
#[cfg(feature = "core")]
|
2020-05-31 16:38:41 +00:00
|
|
|
#[cfg_attr(docsrs, doc(cfg(feature = "core")))]
|
|
|
|
/// # Ethereum types, cryptography and utilities
|
|
|
|
///
|
|
|
|
/// This library provides type definitions for Ethereum's main datatypes along
|
|
|
|
/// with other utilities for interacting with the Ethereum ecosystem
|
|
|
|
///
|
|
|
|
/// ## Signing an ethereum-prefixed message
|
|
|
|
///
|
|
|
|
/// Signing in Ethereum is done by first prefixing the message with
|
|
|
|
/// `"\x19Ethereum Signed Message:\n" + message.length`, and then
|
|
|
|
/// signing the hash of the result.
|
|
|
|
///
|
|
|
|
/// ```rust
|
2020-05-31 18:46:49 +00:00
|
|
|
/// use ethers::core::types::{PrivateKey, Address};
|
2020-05-31 16:38:41 +00:00
|
|
|
///
|
|
|
|
/// let message = "Some data";
|
|
|
|
/// let key = PrivateKey::new(&mut rand::thread_rng());
|
2020-05-31 21:17:50 +00:00
|
|
|
/// let address = Address::from(&key);
|
2020-05-31 16:38:41 +00:00
|
|
|
///
|
|
|
|
/// // Sign the message
|
|
|
|
/// let signature = key.sign(message);
|
|
|
|
///
|
|
|
|
/// // Recover the signer from the message
|
|
|
|
/// let recovered = signature.recover(message).unwrap();
|
|
|
|
///
|
|
|
|
/// assert_eq!(recovered, address);
|
|
|
|
/// ```
|
|
|
|
///
|
|
|
|
/// ## Utilities
|
|
|
|
///
|
|
|
|
/// The crate provides utilities for launching local Ethereum testnets by using `ganache-cli`
|
|
|
|
/// via the `GanacheBuilder` struct. In addition, you're able to compile contracts on the
|
|
|
|
/// filesystem by providing a glob to their path, using the `Solc` struct.
|
|
|
|
///
|
|
|
|
/// # ABI Encoding and Decoding
|
|
|
|
///
|
|
|
|
/// This crate re-exports the [`ethabi`](http://docs.rs/ethabi) crate's functions
|
2020-06-04 18:44:02 +00:00
|
|
|
/// under the `abi` module, as well as the [`secp256k1`](secp256k1) and [`rand`](rand)
|
|
|
|
/// crates for convenience.
|
2020-05-31 16:01:34 +00:00
|
|
|
pub mod core {
|
|
|
|
pub use ethers_core::*;
|
2020-05-26 11:00:56 +00:00
|
|
|
}
|
2020-05-31 16:20:08 +00:00
|
|
|
|
|
|
|
// Re-export ethers_core::utils
|
|
|
|
#[cfg(feature = "core")]
|
|
|
|
pub use ethers_core::utils;
|
|
|
|
|
2020-05-31 16:38:41 +00:00
|
|
|
/// Easy import of frequently used type definitions and traits
|
2020-05-31 16:20:08 +00:00
|
|
|
pub mod prelude {
|
|
|
|
#[cfg(feature = "contract")]
|
|
|
|
pub use ethers_contract::*;
|
|
|
|
|
|
|
|
#[cfg(feature = "providers")]
|
|
|
|
pub use ethers_providers::*;
|
|
|
|
|
|
|
|
#[cfg(feature = "signers")]
|
|
|
|
pub use ethers_signers::*;
|
|
|
|
|
|
|
|
#[cfg(feature = "core")]
|
|
|
|
pub use ethers_core::types::*;
|
|
|
|
}
|