Skip to content
This repository has been archived by the owner on Oct 19, 2024. It is now read-only.

docs: add deprecation notices #2666

Merged
merged 1 commit into from
Nov 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 4 additions & 0 deletions ethers-addressbook/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions ethers-contract/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions ethers-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 4 additions & 0 deletions ethers-etherscan/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions ethers-middleware/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions ethers-providers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
4 changes: 4 additions & 0 deletions ethers-signers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 4 additions & 0 deletions ethers-solc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
5 changes: 5 additions & 0 deletions ethers/src/lib.rs
Original file line number Diff line number Diff line change
@@ -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.
//! See <a href="https://github.com/gakonst/ethers-rs/issues/2667">#2667</a> for more information.
//! </div>
//!
//! ## Quickstart: `prelude`
//!
Expand Down
Loading