From 8772ce76a9928bc311657e42f37d4209d6e52d12 Mon Sep 17 00:00:00 2001 From: DaniPopes <57450786+DaniPopes@users.noreply.github.com> Date: Tue, 7 Nov 2023 20:20:41 +0100 Subject: [PATCH] docs: add deprecation notices --- README.md | 4 ++++ ethers-addressbook/README.md | 4 ++++ ethers-contract/README.md | 4 ++++ ethers-core/README.md | 4 ++++ ethers-etherscan/README.md | 4 ++++ ethers-middleware/README.md | 4 ++++ ethers-providers/README.md | 4 ++++ ethers-signers/README.md | 4 ++++ ethers-solc/README.md | 4 ++++ ethers/src/lib.rs | 5 +++++ 10 files changed, 41 insertions(+) diff --git a/README.md b/README.md index 8ea9f36aa..e17491abd 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,10 @@ [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. See [#2667](https://github.com/gakonst/ethers-rs/issues/2667) for more information. + ## Quickstart Add this to your Cargo.toml: diff --git a/ethers-addressbook/README.md b/ethers-addressbook/README.md index 434ce7b54..17722ed16 100644 --- 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 library is in the process of being deprecated. See [#2667](https://github.com/gakonst/ethers-rs/issues/2667) for more information. + ## Examples ```rust diff --git a/ethers-contract/README.md b/ethers-contract/README.md index 61a8a2f23..1f108b3ce 100644 --- 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 library is in the process of being deprecated. See [#2667](https://github.com/gakonst/ethers-rs/issues/2667) 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 index d202258bd..0096d3464 100644 --- a/ethers-core/README.md +++ b/ethers-core/README.md @@ -2,6 +2,10 @@ Ethereum data types, cryptography and utilities. +> **Warning** +> +> This library is in the process of being deprecated. See [#2667](https://github.com/gakonst/ethers-rs/issues/2667) 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 index d9e3dce4e..3d9bf9d95 100644 --- 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) ([foundry-rs/block-explorers](https://github.com/foundry-rs/block-explorers)). See [#2667](https://github.com/gakonst/ethers-rs/issues/2667) for more information. + ## Examples ```rust,no_run diff --git a/ethers-middleware/README.md b/ethers-middleware/README.md index c66835e05..19c415d5f 100644 --- 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 library is in the process of being deprecated. See [#2667](https://github.com/gakonst/ethers-rs/issues/2667) 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 index 70e5697cc..ec25508b8 100644 --- 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 library is in the process of being deprecated. See [#2667](https://github.com/gakonst/ethers-rs/issues/2667) for more information. + ## Websockets This crate supports for WebSockets via `tokio-tungstenite`. diff --git a/ethers-signers/README.md b/ethers-signers/README.md index e4f908809..77899b25b 100644 --- a/ethers-signers/README.md +++ b/ethers-signers/README.md @@ -2,6 +2,10 @@ A unified interface for locally signing Ethereum transactions. +> **Warning** +> +> This library is in the process of being deprecated. See [#2667](https://github.com/gakonst/ethers-rs/issues/2667) 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 index 98eb5ecde..9b4dcd676 100644 --- 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) ([foundry-rs/compilers](https://github.com/foundry-rs/compilers)). See [#2667](https://github.com/gakonst/ethers-rs/issues/2667) for more information. + 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 index ed982c726..6cd73ae3f 100644 --- a/ethers/src/lib.rs +++ b/ethers/src/lib.rs @@ -1,6 +1,11 @@ //! # ethers-rs //! //! A complete Ethereum and Celo Rust library. +//! +//!
+//! This crate is in the process of being deprecated. +//! See #2667 for more information. +//!
//! //! ## Quickstart: `prelude` //!