docs: add deprecation notices

gakonst · Nov 7, 2023 · aae3c7a · aae3c7a
1 parent 4f7b354
commit aae3c7a
Show file tree

Hide file tree

Showing 10 changed files with 44 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -9,6 +9,13 @@
 [crates-badge]: https://img.shields.io/crates/v/ethers.svg
 [crates-url]: https://crates.io/crates/ethers
 
+> [!WARNING]
+> This library is in the process of being deprecated. Consider using instead:
+> - ~~`ethers::{abi, core, contract, types}`~~ -> [alloy-rs/core](https://github.com/alloy-rs/core)
+> - ~~`ethers::{middleware, providers, signers}`~~ -> [alloy-rs/alloy](https://github.com/alloy-rs/alloy)
+> - ~~`ethers::etherscan`~~ -> [foundry-rs/block-explorers](https://github.com/foundry-rs/block-explorers)
+> - ~~`ethers::solc`~~ -> [foundry-rs/compilers](https://github.com/foundry-rs/compilers)
+
 ## Quickstart
 
 Add this to your Cargo.toml:

diff --git a/ethers-addressbook/README.md b/ethers-addressbook/README.md
@@ -4,6 +4,10 @@ A collection of commonly used smart contract addresses.
 
 For more information, please refer to the [book](https://gakonst.com/ethers-rs).
 
+> **Warning**
+>
+> This crate is in the process of being deprecated. Please see the [repository README](https://github.com/gakonst/ethers-rs) for more information.
+
 ## Examples
 
 ```rust

diff --git a/ethers-contract/README.md b/ethers-contract/README.md
@@ -2,6 +2,10 @@
 
 Type-safe abstractions for interacting with Ethereum smart contracts.
 
+> **Warning**
+>
+> This crate is in the process of being deprecated. Please see the [repository README](https://github.com/gakonst/ethers-rs) for more information.
+
 Interacting with a smart contract requires broadcasting carefully crafted
 [transactions](ethers_core::types::TransactionRequest) where the `data` field
 contains the

diff --git a/ethers-core/README.md b/ethers-core/README.md
@@ -2,6 +2,10 @@
 
 Ethereum data types, cryptography and utilities.
 
+> **Warning**
+>
+> This crate is in the process of being deprecated. Please see the [repository README](https://github.com/gakonst/ethers-rs) for more information.
+
 It is recommended to use the `utils`, `types` and `abi` re-exports instead of
 the `core` module to simplify your imports.
 

diff --git a/ethers-etherscan/README.md b/ethers-etherscan/README.md
@@ -4,6 +4,10 @@ Bindings for the [etherscan.io web API](https://docs.etherscan.io).
 
 For more information, please refer to the [book](https://gakonst.com/ethers-rs).
 
+> **Warning**
+> 
+> This crate is deprecated in favor of [foundry-block-explorers](https://crates.io/foundry-block-explorers) ([github](https://github.com/foundry-rs/block-explorers)).
+
 ## Examples
 
 ```rust,no_run

diff --git a/ethers-middleware/README.md b/ethers-middleware/README.md
@@ -4,6 +4,10 @@ Your ethers application interacts with the blockchain through a [`Provider`](eth
 
 For more information, please refer to the [book](https://gakonst.com/ethers-rs).
 
+> **Warning**
+>
+> This crate is in the process of being deprecated. Please see the [repository README](https://github.com/gakonst/ethers-rs) for more information.
+
 ## Available Middleware
 
 -   [`Signer`](./signer/struct.SignerMiddleware.html): Signs transactions locally, with a private key or a hardware wallet.

diff --git a/ethers-providers/README.md b/ethers-providers/README.md
@@ -8,6 +8,10 @@ clients.
 
 For more information, please refer to the [book](https://gakonst.com/ethers-rs).
 
+> **Warning**
+>
+> This crate is in the process of being deprecated. Please see the [repository README](https://github.com/gakonst/ethers-rs) for more information.
+
 ## Websockets
 
 This crate supports for WebSockets via `tokio-tungstenite`.

diff --git a/ethers-signers/README.md b/ethers-signers/README.md
@@ -2,6 +2,10 @@
 
 A unified interface for locally signing Ethereum transactions.
 
+> **Warning**
+>
+> This crate is in the process of being deprecated. Please see the [repository README](https://github.com/gakonst/ethers-rs) for more information.
+
 You can implement the `Signer` trait to extend functionality to other signers
 such as Hardware Security Modules, KMS etc.
 

diff --git a/ethers-solc/README.md b/ethers-solc/README.md
@@ -2,6 +2,10 @@
 
 Utilities for working with native `solc` and compiling projects.
 
+> **Warning**
+> 
+> This crate is deprecated in favor of [foundry-compilers](https://crates.io/foundry-compilers) ([github](https://github.com/foundry-rs/compilers)).
+
 To also compile contracts during `cargo build` (so that ethers `abigen!` can pull in updated abi automatically) you can configure a `ethers_solc::Project` in your `build.rs` file
 
 First add `ethers-solc` to your cargo build-dependencies.

diff --git a/ethers/src/lib.rs b/ethers/src/lib.rs
@@ -1,6 +1,11 @@
 //! # ethers-rs
 //!
 //! A complete Ethereum and Celo Rust library.
+//! 
+//! <div class="warning">
+//! This crate is in the process of being deprecated. Please see the
+//! <a href="https://github.com/gakonst/ethers-rs">repository README</a> for more information.
+//! </div>
 //!
 //! ## Quickstart: `prelude`
 //!