From 933f4228276581d4cc43551813bee16e5b3da29d Mon Sep 17 00:00:00 2001 From: Blessing Krofegha Date: Thu, 26 Sep 2024 12:20:52 +0100 Subject: [PATCH 1/6] Added notice page for deprecation and banner --- pages/builders/notices/_meta.json | 3 +- pages/builders/notices/sdk-deprecation.mdx | 66 ++++++++++++++++++++++ theme.config.tsx | 8 +++ 3 files changed, 76 insertions(+), 1 deletion(-) create mode 100644 pages/builders/notices/sdk-deprecation.mdx diff --git a/pages/builders/notices/_meta.json b/pages/builders/notices/_meta.json index 0b387da16..c52a90569 100644 --- a/pages/builders/notices/_meta.json +++ b/pages/builders/notices/_meta.json @@ -1,4 +1,5 @@ { "granite-changes": "Preparing for Granite Breaking Changes", - "fp-changes": "Preparing for Fault Proofs Breaking Changes" + "fp-changes": "Preparing for Fault Proofs Breaking Changes", + "sdk-deprecation": "Preparing for Optimism SDK deprecation" } diff --git a/pages/builders/notices/sdk-deprecation.mdx b/pages/builders/notices/sdk-deprecation.mdx new file mode 100644 index 000000000..ab5d7a689 --- /dev/null +++ b/pages/builders/notices/sdk-deprecation.mdx @@ -0,0 +1,66 @@ +--- +title: Deprecation of the Optimism SDK +description: This page outlines the details of the Optimism SDK deprecation and guides developers to migrate to using `viem/opstack` library. +--- + +## Preparing for Optimism SDK deprecation + +The Optimism SDK will officially be deprecated on **\[insert deprecation date]**. We are shifting to the `viem/opstack` library for a more modern, efficient, and flexible development experience. This change affects all tutorials and resources that previously relied on the Optimism SDK, and we have updated relevant documentation accordingly. + +### Breaking Changes to Expect + +The migration from the Optimism SDK to `viem`/`opstack` brings several breaking changes: + +* **Transaction estimation**: Methods for estimating gas fees will now leverage `viem` APIs. +* **Bridging**: All token bridging actions must be updated to use the `opstack` bridging methods. +* **Cross-chain communication**: `opstack` simplifies the cross-domain messaging functionality. +* **SDK method removal**: All deprecated SDK methods will be unavailable after \[insert deprecation date]. + +We strongly encourage developers and users to transition to `viem/opstack` before the deprecation date to avoid disruptions. + +### Updated Tutorials + +The following tutorials have been updated to use `viem/opstack` library: + +* [Estimating Transaction Costs on OP Mainnet](../tutorials/transaction-cost-estimation)\ + Estimation of transaction costs now uses the `viem` gas estimation utilities. + +* [Triggering OP Mainnet Transactions from Ethereum](../tutorials/trigger-op-transactions)\ + Learn how to trigger transactions using `viem` to interact with the OP Mainnet. + +* [Tracing Deposits and Withdrawals](../tutorials/tracing-deposits-withdrawals)\ + The tracing functionalities have been adapted to use `opstack` for efficient results. + +* [Viewing Deposits and Withdrawals by Address](../tutorials/view-deposits-withdrawals)\ + This tutorial outlines updated methods in `viem` for querying deposits and withdrawals by address. + +* [Bridging Your Standard ERC-20 Token Using the Standard Bridge](../tutorials/bridge-standard-erc20)\ + The standard bridge tutorial now uses `opstack` for token transfers between Ethereum and OP Mainnet. + +* [Bridging Your Custom ERC-20 Token Using the Standard Bridge](../tutorials/bridge-custom-erc20)\ + Custom ERC-20 tokens can now be bridged via `opstack`, making the process more streamlined. + +* [Bridging ERC-20 Tokens to OP Mainnet With the Optimism SDK](../tutorials/bridge-sdk-erc20)\ + **Deprecated** – please use [Bridging Your Custom ERC-20 Token Using the Standard Bridge](../tutorials/bridge-custom-erc20). + +* [Bridging ETH to OP Mainnet With the Optimism SDK](../tutorials/bridge-sdk-eth)\ + **Deprecated** – please use [Estimating Transaction Costs on OP Mainnet](../tutorials/transaction-cost-estimation). + +* [Communicating Between OP Mainnet and Ethereum in Solidity](../tutorials/cross-chain-solidity)\ + Cross-chain communication now leverages `opstack` for all messaging. + +### For App Developers + +If your application currently depends on the Optimism SDK, you will need to migrate to using the `viem/opstack` library. Our tutorials have been updated to reflect these changes, and it is critical to update your applications before the deprecation date to maintain compatibility. + +### For Chain Operators + +Chain operators utilizing the SDK for cross-chain operations, bridging, or other functions should switch to the `viem/opstack`. The `viem/opstack` library offer more efficient methods to handle these operations. + +### For Node Operators + +Node operators will need to ensure that any scripts or services relying on the Optimism SDK are updated to use `viem/opstack` library. These updates will help align with future improvements and scalability efforts across the OP Stack. + +*** + +For further assistance or questions about this migration, feel free to reach out via the [community forum](https://community.optimism.io/) or [join our developer Slack](#). diff --git a/theme.config.tsx b/theme.config.tsx index a4b8adcca..b720e1a0e 100644 --- a/theme.config.tsx +++ b/theme.config.tsx @@ -28,6 +28,14 @@ const config: DocsThemeConfig = { ), darkMode: true, + banner: { + key: 'viem/op-stack', + text: ( + + 🎉 We are deprecating the Optimism SDK and migrating all tutorials to use viem/op-stack. Read more → + + ) + }, search: { component: Search, }, From 138050284dcf0c56a8fc8bdf582b901b4bd387bd Mon Sep 17 00:00:00 2001 From: Blessing Krofegha Date: Thu, 26 Sep 2024 12:38:05 +0100 Subject: [PATCH 2/6] updated docs --- pages/builders/notices/sdk-deprecation.mdx | 52 ++++++++++++++++++---- words.txt | 1 + 2 files changed, 44 insertions(+), 9 deletions(-) diff --git a/pages/builders/notices/sdk-deprecation.mdx b/pages/builders/notices/sdk-deprecation.mdx index ab5d7a689..459addbbf 100644 --- a/pages/builders/notices/sdk-deprecation.mdx +++ b/pages/builders/notices/sdk-deprecation.mdx @@ -9,18 +9,18 @@ The Optimism SDK will officially be deprecated on **\[insert deprecation date]** ### Breaking Changes to Expect -The migration from the Optimism SDK to `viem`/`opstack` brings several breaking changes: +The migration from the Optimism SDK to `viem/opstack` library brings several breaking changes: * **Transaction estimation**: Methods for estimating gas fees will now leverage `viem` APIs. -* **Bridging**: All token bridging actions must be updated to use the `opstack` bridging methods. -* **Cross-chain communication**: `opstack` simplifies the cross-domain messaging functionality. +* **Bridging**: All token bridging actions must be updated to use the `viem/opstack` library bridging methods. +* **Cross-chain communication**: `viem/opstack` library simplifies the cross-domain messaging functionality. * **SDK method removal**: All deprecated SDK methods will be unavailable after \[insert deprecation date]. We strongly encourage developers and users to transition to `viem/opstack` before the deprecation date to avoid disruptions. ### Updated Tutorials -The following tutorials have been updated to use `viem/opstack` library: +We've updated our tutorials and documentation to use `viem/opstack` library. Below, you'll find links to the updated versions of popular tutorials: * [Estimating Transaction Costs on OP Mainnet](../tutorials/transaction-cost-estimation)\ Estimation of transaction costs now uses the `viem` gas estimation utilities. @@ -51,16 +51,50 @@ The following tutorials have been updated to use `viem/opstack` library: ### For App Developers -If your application currently depends on the Optimism SDK, you will need to migrate to using the `viem/opstack` library. Our tutorials have been updated to reflect these changes, and it is critical to update your applications before the deprecation date to maintain compatibility. +If your application currently depends on the Optimism SDK, you will need to migrate to using the `viem/opstack` library. +Our tutorials have been updated to reflect these changes, and it is critical to update your applications before the deprecation date to maintain compatibility. + +Here are some key points to consider: + +Install new dependencies: Replace the Optimism SDK with `viem/opstack` in your project. + +```bash + pnpm remove @eth-optimism/sdk + npm install viem +``` + +* Update imports: Replace Optimism SDK imports with `viem/opstack` imports. +* Migrate SDK methods: Refactor your code to use equivalent `viem/opstack` methods. Refer to the viem documentation and opstack documentation for guidance. +* Test thoroughly: After migration, extensively test your application to ensure all functionality works as expected. ### For Chain Operators -Chain operators utilizing the SDK for cross-chain operations, bridging, or other functions should switch to the `viem/opstack`. The `viem/opstack` library offer more efficient methods to handle these operations. +Chain operators utilizing the SDK for cross-chain operations, bridging, or other functions should switch to the `viem/opstack`. +The `viem/opstack` library offer more efficient methods to handle these operations. + +Chain operators should be aware of the following: + +* SDK removal: Remove any dependencies on the Optimism SDK in your infrastructure. +* Update tooling: Ensure all tools and scripts are updated to use `viem/opstack`. +* Monitor performance: After migration, closely monitor your chain's performance to ensure smooth operation. ### For Node Operators -Node operators will need to ensure that any scripts or services relying on the Optimism SDK are updated to use `viem/opstack` library. These updates will help align with future improvements and scalability efforts across the OP Stack. +Node operators will need to ensure that any scripts or services relying on the Optimism SDK are updated to use `viem/opstack` library. +These updates will help align with future improvements and scalability efforts across the OP Stack. + +Node operators should take the following steps: + +* Update node software: Ensure your node software is compatible with the latest `viem/opstack` libraries. +* Review configuration: Check and update any configuration files that may reference the Optimism SDK. +* Test thoroughly: Perform comprehensive testing in a staging environment before updating production nodes. + +### Need Help? -*** +For further assistance or questions about this migration, feel free to reach out via the -For further assistance or questions about this migration, feel free to reach out via the [community forum](https://community.optimism.io/) or [join our developer Slack](#). +* [Community forum](https://community.optimism.io/) or +* [Join our developer Slack](#). +* Join our [Discord](#) for community support +* Open an [issue on our GitHub repository](#) +* Check our [FAQ](#) for common questions and answers diff --git a/words.txt b/words.txt index 90467007b..3fde99f89 100644 --- a/words.txt +++ b/words.txt @@ -230,6 +230,7 @@ offchain Openfort oplabs opnode's +opstack Opti pausable pcscdpath From 59c12d856d198f83079846934271fa5fd9fb5710 Mon Sep 17 00:00:00 2001 From: krofax Date: Fri, 4 Oct 2024 16:31:47 +0100 Subject: [PATCH 3/6] updated content --- pages/builders/notices/sdk-deprecation.mdx | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/pages/builders/notices/sdk-deprecation.mdx b/pages/builders/notices/sdk-deprecation.mdx index 459addbbf..4d7f4e938 100644 --- a/pages/builders/notices/sdk-deprecation.mdx +++ b/pages/builders/notices/sdk-deprecation.mdx @@ -5,7 +5,7 @@ description: This page outlines the details of the Optimism SDK deprecation and ## Preparing for Optimism SDK deprecation -The Optimism SDK will officially be deprecated on **\[insert deprecation date]**. We are shifting to the `viem/opstack` library for a more modern, efficient, and flexible development experience. This change affects all tutorials and resources that previously relied on the Optimism SDK, and we have updated relevant documentation accordingly. +The Optimism SDK will officially be deprecated in Q1 2025. We are shifting to the `viem/opstack` library for a more modern, efficient, and flexible development experience. This change affects all tutorials and resources that previously relied on the Optimism SDK, and we have updated relevant documentation accordingly. ### Breaking Changes to Expect @@ -20,7 +20,9 @@ We strongly encourage developers and users to transition to `viem/opstack` befor ### Updated Tutorials -We've updated our tutorials and documentation to use `viem/opstack` library. Below, you'll find links to the updated versions of popular tutorials: +We are updated our tutorials and documentation to use `viem/opstack` library. + + {/* Below, you'll find links to the updated versions of popular tutorials: * [Estimating Transaction Costs on OP Mainnet](../tutorials/transaction-cost-estimation)\ Estimation of transaction costs now uses the `viem` gas estimation utilities. @@ -47,7 +49,7 @@ We've updated our tutorials and documentation to use `viem/opstack` library. Bel **Deprecated** – please use [Estimating Transaction Costs on OP Mainnet](../tutorials/transaction-cost-estimation). * [Communicating Between OP Mainnet and Ethereum in Solidity](../tutorials/cross-chain-solidity)\ - Cross-chain communication now leverages `opstack` for all messaging. + Cross-chain communication now leverages `opstack` for all messaging. */} ### For App Developers @@ -60,7 +62,7 @@ Install new dependencies: Replace the Optimism SDK with `viem/opstack` in your p ```bash pnpm remove @eth-optimism/sdk - npm install viem + pnpm add viem ``` * Update imports: Replace Optimism SDK imports with `viem/opstack` imports. @@ -91,10 +93,8 @@ Node operators should take the following steps: ### Need Help? -For further assistance or questions about this migration, feel free to reach out via the +For further assistance or questions about this migration, feel free to reach throught the following channels. -* [Community forum](https://community.optimism.io/) or -* [Join our developer Slack](#). -* Join our [Discord](#) for community support -* Open an [issue on our GitHub repository](#) -* Check our [FAQ](#) for common questions and answers +* Join our [community forum](https://community.optimism.io/) +* Join our [discord](https://discord.gg/optimism) for community support +* Open an [issue on our GitHub repository](https://github.com/ethereum-optimism/docs/issues) From f67bb4fe4c68da80d90d283bc19e1c7e83af5553 Mon Sep 17 00:00:00 2001 From: krofax Date: Fri, 4 Oct 2024 16:47:24 +0100 Subject: [PATCH 4/6] updated docs --- pages/builders/notices/sdk-deprecation.mdx | 44 +++++++++++----------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/pages/builders/notices/sdk-deprecation.mdx b/pages/builders/notices/sdk-deprecation.mdx index 4d7f4e938..db9ced19d 100644 --- a/pages/builders/notices/sdk-deprecation.mdx +++ b/pages/builders/notices/sdk-deprecation.mdx @@ -1,26 +1,26 @@ --- title: Deprecation of the Optimism SDK -description: This page outlines the details of the Optimism SDK deprecation and guides developers to migrate to using `viem/opstack` library. +description: This page outlines the details of the Optimism SDK deprecation and guides developers to migrate to using `viem` library. --- ## Preparing for Optimism SDK deprecation -The Optimism SDK will officially be deprecated in Q1 2025. We are shifting to the `viem/opstack` library for a more modern, efficient, and flexible development experience. This change affects all tutorials and resources that previously relied on the Optimism SDK, and we have updated relevant documentation accordingly. +The Optimism SDK will officially be deprecated in Q1 2025. The project is shifting to the `viem` library for a more modern, efficient, and flexible development experience. This change affects all tutorials and resources that previously relied on the Optimism SDK, and relevant documentation has been updated accordingly. ### Breaking Changes to Expect -The migration from the Optimism SDK to `viem/opstack` library brings several breaking changes: +The migration from the Optimism SDK to `viem` library brings several breaking changes: * **Transaction estimation**: Methods for estimating gas fees will now leverage `viem` APIs. -* **Bridging**: All token bridging actions must be updated to use the `viem/opstack` library bridging methods. -* **Cross-chain communication**: `viem/opstack` library simplifies the cross-domain messaging functionality. -* **SDK method removal**: All deprecated SDK methods will be unavailable after \[insert deprecation date]. +* **Bridging**: All token bridging actions must be updated to use the `viem` library bridging methods. +* **Cross-chain communication**: `viem` library simplifies the cross-domain messaging functionality. +* **SDK method removal**: All deprecated SDK methods will be unavailable after Q1 2025. -We strongly encourage developers and users to transition to `viem/opstack` before the deprecation date to avoid disruptions. +Developers and users are strongly encouraged to transition to `viem` before the deprecation date to avoid disruptions. ### Updated Tutorials -We are updated our tutorials and documentation to use `viem/opstack` library. +We are updating our tutorials to use the `viem` library. {/* Below, you'll find links to the updated versions of popular tutorials: @@ -53,48 +53,48 @@ We are updated our tutorials and documentation to use `viem/opstack` library. ### For App Developers -If your application currently depends on the Optimism SDK, you will need to migrate to using the `viem/opstack` library. -Our tutorials have been updated to reflect these changes, and it is critical to update your applications before the deprecation date to maintain compatibility. +If your application currently depends on the Optimism SDK, you will need to migrate to using the `viem` library. +The tutorials have been updated to reflect these changes, and it is critical to update your applications before the deprecation date to maintain compatibility. Here are some key points to consider: -Install new dependencies: Replace the Optimism SDK with `viem/opstack` in your project. +Install new dependencies: Replace the Optimism SDK with `viem` in your project. ```bash pnpm remove @eth-optimism/sdk pnpm add viem ``` -* Update imports: Replace Optimism SDK imports with `viem/opstack` imports. -* Migrate SDK methods: Refactor your code to use equivalent `viem/opstack` methods. Refer to the viem documentation and opstack documentation for guidance. +* Update imports: Replace Optimism SDK imports with `viem` imports. +* Migrate SDK methods: Refactor your code to use equivalent `viem` methods. Refer to the viem documentation and opstack documentation for guidance. * Test thoroughly: After migration, extensively test your application to ensure all functionality works as expected. ### For Chain Operators -Chain operators utilizing the SDK for cross-chain operations, bridging, or other functions should switch to the `viem/opstack`. -The `viem/opstack` library offer more efficient methods to handle these operations. +Chain operators utilizing the SDK for cross-chain operations, bridging, or other functions should switch to the `viem` library. +The `viem` library offers more efficient methods to handle these operations. Chain operators should be aware of the following: * SDK removal: Remove any dependencies on the Optimism SDK in your infrastructure. -* Update tooling: Ensure all tools and scripts are updated to use `viem/opstack`. +* Update tooling: Ensure all tools and scripts are updated to use `viem`. * Monitor performance: After migration, closely monitor your chain's performance to ensure smooth operation. ### For Node Operators -Node operators will need to ensure that any scripts or services relying on the Optimism SDK are updated to use `viem/opstack` library. +Node operators will need to ensure that any scripts or services relying on the Optimism SDK are updated to use `viem` library. These updates will help align with future improvements and scalability efforts across the OP Stack. Node operators should take the following steps: -* Update node software: Ensure your node software is compatible with the latest `viem/opstack` libraries. +* Update node software: Ensure your node software is compatible with the latest `viem` libraries. * Review configuration: Check and update any configuration files that may reference the Optimism SDK. * Test thoroughly: Perform comprehensive testing in a staging environment before updating production nodes. ### Need Help? -For further assistance or questions about this migration, feel free to reach throught the following channels. +For further assistance or questions about this migration, feel free to reach through the following channels: -* Join our [community forum](https://community.optimism.io/) -* Join our [discord](https://discord.gg/optimism) for community support -* Open an [issue on our GitHub repository](https://github.com/ethereum-optimism/docs/issues) +* Join our [community forum](https://community.optimism.io/) for discussions and support +* Connect with us on [Discord](https://discord.gg/optimism) for community support +* Open an [issue on our GitHub repository](https://github.com/ethereum-optimism/docs/issues) for documentation-related concerns From cdeb33271b77dc53de3304e6fcd27b7a95e97d18 Mon Sep 17 00:00:00 2001 From: krofax Date: Fri, 4 Oct 2024 16:48:31 +0100 Subject: [PATCH 5/6] Added a lang attribute --- pages/builders/notices/sdk-deprecation.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/pages/builders/notices/sdk-deprecation.mdx b/pages/builders/notices/sdk-deprecation.mdx index db9ced19d..7d8b9b8a2 100644 --- a/pages/builders/notices/sdk-deprecation.mdx +++ b/pages/builders/notices/sdk-deprecation.mdx @@ -1,5 +1,6 @@ --- title: Deprecation of the Optimism SDK +lang: en-US description: This page outlines the details of the Optimism SDK deprecation and guides developers to migrate to using `viem` library. --- From 924eceb0221c2c34a581f65e646520cf1bb73b18 Mon Sep 17 00:00:00 2001 From: krofax Date: Fri, 4 Oct 2024 17:58:03 +0100 Subject: [PATCH 6/6] Used sentence case for headers --- pages/builders/notices/sdk-deprecation.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/pages/builders/notices/sdk-deprecation.mdx b/pages/builders/notices/sdk-deprecation.mdx index 7d8b9b8a2..302f4afba 100644 --- a/pages/builders/notices/sdk-deprecation.mdx +++ b/pages/builders/notices/sdk-deprecation.mdx @@ -8,7 +8,7 @@ description: This page outlines the details of the Optimism SDK deprecation and The Optimism SDK will officially be deprecated in Q1 2025. The project is shifting to the `viem` library for a more modern, efficient, and flexible development experience. This change affects all tutorials and resources that previously relied on the Optimism SDK, and relevant documentation has been updated accordingly. -### Breaking Changes to Expect +### Breaking changes to expect The migration from the Optimism SDK to `viem` library brings several breaking changes: @@ -19,7 +19,7 @@ The migration from the Optimism SDK to `viem` library brings several breaking ch Developers and users are strongly encouraged to transition to `viem` before the deprecation date to avoid disruptions. -### Updated Tutorials +### Updated tutorials We are updating our tutorials to use the `viem` library. @@ -52,7 +52,7 @@ We are updating our tutorials to use the `viem` library. * [Communicating Between OP Mainnet and Ethereum in Solidity](../tutorials/cross-chain-solidity)\ Cross-chain communication now leverages `opstack` for all messaging. */} -### For App Developers +### For app developers If your application currently depends on the Optimism SDK, you will need to migrate to using the `viem` library. The tutorials have been updated to reflect these changes, and it is critical to update your applications before the deprecation date to maintain compatibility. @@ -70,7 +70,7 @@ Install new dependencies: Replace the Optimism SDK with `viem` in your project. * Migrate SDK methods: Refactor your code to use equivalent `viem` methods. Refer to the viem documentation and opstack documentation for guidance. * Test thoroughly: After migration, extensively test your application to ensure all functionality works as expected. -### For Chain Operators +### For chain operators Chain operators utilizing the SDK for cross-chain operations, bridging, or other functions should switch to the `viem` library. The `viem` library offers more efficient methods to handle these operations. @@ -81,7 +81,7 @@ Chain operators should be aware of the following: * Update tooling: Ensure all tools and scripts are updated to use `viem`. * Monitor performance: After migration, closely monitor your chain's performance to ensure smooth operation. -### For Node Operators +### For node operators Node operators will need to ensure that any scripts or services relying on the Optimism SDK are updated to use `viem` library. These updates will help align with future improvements and scalability efforts across the OP Stack.