🎉 We are deprecating the Optimism SDK and migrating all tutorials to use viem/op-stack. Read more →
Builders
Notices (README)
Preparing for Optimism SDK deprecation

Preparing for Optimism SDK deprecation

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 (opens in a new tab) 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 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.

Developers and users are strongly encouraged to transition to viem before the deprecation date to avoid disruptions.

Updated tutorials

We are updating our tutorials to use the viem library.

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.

Here are some key points to consider:

Install new dependencies: Replace the Optimism SDK with viem in your project.

    pnpm remove @eth-optimism/sdk
    pnpm add viem
  • 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 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.
  • 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 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 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 through the following channels:

Preparing for Optimism SDK deprecationOverview