Skip to content
This repository was archived by the owner on Mar 5, 2025. It is now read-only.

Commit 5b33133

Browse files
authored
Add 1.x deprecation notice (#6723)
* add Maintenance notes * add links
1 parent 0e8695b commit 5b33133

File tree

2 files changed

+33
-2
lines changed

2 files changed

+33
-2
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
## Maintenance Countdown:
2+
Commencing from January 1, 2024, a 90-day countdown has been initiated, signaling the transition of Web3.js version 1.x into an end-of-maintenance phase.
3+
4+
### Timeline of Changes:
5+
6+
- 90-Day Countdown (1/1/24 - 3/31/24):
7+
During this period, we strongly encourage users to plan accordingly and initiate the [upgrade to Web3.js version 4.x](https://docs.web3js.org/guides/web3_upgrade_guide/x/)
8+
9+
- No New Bug Fixes (4/1/24 onwards):
10+
Starting April 1, 2024, new bug fixes for Web3.js version 1.x will no longer be provided. To benefit from continued support and access to new features, we recommend [upgrading to Web3.js version 4.x](https://docs.web3js.org/guides/web3_upgrade_guide/x/)
11+
12+
- End of Security Fixes (7/1/24):
13+
Security fixes for Web3.js version 1.x will be discontinued from July 1, 2024. [Upgrading to Web3.js version 4.x](https://docs.web3js.org/guides/web3_upgrade_guide/x/) is crucial to ensure the security of your applications.
14+
15+
116
<p style="text-align: center;">
217
<img src="assets/logo/web3js.jpg" width="200" alt="web3.js">
318
</p>

docs/index.rst

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
=================================
2+
Maintenance Countdown:
3+
=================================
4+
5+
Commencing from January 1, 2024, a 90-day countdown has been initiated, signaling the transition of Web3.js version 1.x into an end-of-maintenance phase.
6+
7+
---------------------
8+
Timeline of Changes:
9+
---------------------
10+
11+
- 90-Day Countdown (1/1/24 - 3/31/24): During this period, we strongly encourage users to plan accordingly and initiate the `upgrade to Web3.js version 4.x <https://docs.web3js.org/guides/web3_upgrade_guide/x/>`_
12+
13+
- No New Bug Fixes (4/1/24 onwards): Starting April 1, 2024, new bug fixes for Web3.js version 1.x will no longer be provided. To benefit from continued support and access to new features, we recommend `upgrading to Web3.js version 4.x <https://docs.web3js.org/guides/web3_upgrade_guide/x/>`_
14+
15+
- End of Security Fixes (7/1/24): Security fixes for Web3.js version 1.x will be discontinued from July 1, 2024. `Upgrading to Web3.js version 4.x <https://docs.web3js.org/guides/web3_upgrade_guide/x/>`_ is crucial to ensure the security of your applications
16+
117

218
=================================
319
web3.js - Ethereum JavaScript API
@@ -7,7 +23,7 @@ web3.js is a collection of libraries that allow you to interact with a local or
723

824
The following documentation will guide you through :ref:`installing and running web3.js <adding-web3>` as well as providing an :ref:`API reference documentation <#id1>` with examples.
925

10-
.. note:: `Web3.js 4.x <https://www.npmjs.com/package/web3>`_ has been released. Checkout 4.x `API documentation and migration guide <https://docs.web3js.org/>`_ .
26+
.. note:: `Web3.js 4.x <https://www.npmjs.com/package/web3>`_ has been released. Checkout 4.x `API documentation and migration guide <https://docs.web3js.org/>`_ .
1127

1228
Contents:
1329

@@ -42,4 +58,4 @@ Contents:
4258
web3-admin
4359

4460

45-
Special thanks to `Netlify <https://www.netlify.com/>`_ for providing build and deploy services for our end-to-end integration tests.
61+
Special thanks to `Netlify <https://www.netlify.com/>`_ for providing build and deploy services for our end-to-end integration tests.

0 commit comments

Comments
 (0)