npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@eth-optimism/sdk

v3.3.0

Published

[Optimism] Tools for working with Optimism

Downloads

110,773

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

optibotoptibotkelvinfichterkelvinfichter

Keywords

optimismethereumsdk

Readme

@eth-optimism/sdk

codecov

The @eth-optimism/sdk package provides a set of tools for interacting with Optimism.

Warning!!!

@eth-optimism/sdk has been superseded by op-viem. For most developers we suggest you migrate to viem which has native built in op-stack support built in. It also has additional benefits.

The OP Labs team has no plans to add new features @eth-optimism/sdk and it is in maintenance mode

If you are already using the sdk you are safe as it will continue to be maintained.

  • an intuitive API that learned from this package and is now revamped
  • great treeshaking with a 10x+ improvement to bundlesize
  • Better performance
  • Updated to use the latest op stack contracts. At times it will save you gas compared to using viem.

If viem does not have what you need please let us know by opening an issue in the viem repo or here. Letting us know helps us advocate to upstream more functionality to viem. Viem is missing the following functionality:

  • ERC20 support

If viem doesn't have what you need, the extensions for viem, op-viem extensions, likely have it too.

Installation

npm install @eth-optimism/sdk

Docs

You can find auto-generated API documentation over at sdk.optimism.io.

Contributing

Most of the core functionality is in the CrossChainMessenger file.

Using the SDK

CrossChainMessenger

The CrossChainMessenger class simplifies the process of moving assets and data between Ethereum and Optimism. You can use this class to, for example, initiate a withdrawal of ERC20 tokens from Optimism back to Ethereum, accurately track when the withdrawal is ready to be finalized on Ethereum, and execute the finalization transaction after the challenge period has elapsed. The CrossChainMessenger can handle deposits and withdrawals of ETH and any ERC20-compatible token. Detailed API descriptions can be found at sdk.optimism.io. The CrossChainMessenger automatically connects to all relevant contracts so complex configuration is not necessary.

L2Provider and related utilities

The Optimism SDK includes various utilities for handling Optimism's transaction fee model. For instance, estimateTotalGasCost will estimate the total cost (in wei) to send at transaction on Optimism including both the L2 execution cost and the L1 data cost. You can also use the asL2Provider function to wrap an ethers Provider object into an L2Provider which will have all of these helper functions attached.

Other utilities

The SDK contains other useful helper functions and constants. For a complete list, refer to the auto-generated SDK documentation