@eth-optimism/sdk NPM | npm.io

3.3.0 • Published 30 days ago

Install

Weekly downloads

-

License

MIT

Repository

Last release

30 days ago

@eth-optimism/sdk

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

optimism ethereum sdk

@eth-optimism/contracts lodash merkletreejs rlp semver @eth-optimism/contracts-bedrock @eth-optimism/core-utils

@infinitebrahmanuniverse/nolb-_et @everything-registry/sub-chunk-299 dimaa-smart-order-router ens_bedrock_resolver test-dex-smart-order-router @derivation-tech/web3-core ccip-resolver @chainify/evm @dappworks/mimoswap-sdk @connext/smart-contracts @conduitxyz/sdk teleport-sdk conduit-sdk @nathan2024/up-smart-order-router @polysensus/chaintrap-arenastate @egiftcard/sdk @relicprotocol/client @metarollup/sdk @liquality/wallet-core @roninjin10/actor-tests @sequelfinance/toolbox-evm @hashflow/hashflow @hemilabs/smart-order-router @kayenorg/smart-order-router @keller_/smart-order-router @eth-optimism/contracts-governance @eth-optimism/actor-tests @eth-optimism/message-relayer @jalaswap/smart-order-router @hop-protocol/hop-node-core @hop-protocol/v2-sdk @uniswap/smart-order-router @xlayerswap/smart-order-router @yac-swap/wallet-core @yac-swap/evm @zalastax/nolb-_et @across-protocol/sdk-v2 @yaswap/wallet-core @yaswap/evm @atleta-chain/smart-order-router

0.0.0-develop-20240401230611

1 month ago

0.0.0-develop-20240401191608

1 month ago

0.0.0-develop-20240401175937

1 month ago

0.0.0-develop-20240401184411

1 month ago

0.0.0-develop-20240401161654

1 month ago

30 days ago

0.0.0-develop-20240401201601

1 month ago

0.0.0-develop-20240401211611

1 month ago

0.0.0-develop-20240401175653

1 month ago

0.0.0-develop-20240401193634

1 month ago

0.0.0-develop-20240401175154

1 month ago

0.0.0-develop-20240330200937

1 month ago

0.0.0-develop-20240330203913

1 month ago

0.0.0-develop-20240330201747

1 month ago

0.0.0-develop-20240329181214

1 month ago

0.0.0-develop-20240329164135

1 month ago

0.0.0-sdk-replay-20240330020121

1 month ago

0.0.0-develop-20240329164052

1 month ago

0.0.0-develop-20240328205242

1 month ago

0.0.0-develop-20240328211223

1 month ago

0.0.0-develop-20240328010630

1 month ago

0.0.0-develop-20240327170934

1 month ago

0.0.0-develop-20240327175239

1 month ago

0.0.0-develop-20240327164138

1 month ago

0.0.0-develop-20240327151219

1 month ago

0.0.0-develop-20240325182313

1 month ago

0.0.0-develop-20240325222725

1 month ago

0.0.0-develop-20240325220434

1 month ago

0.0.0-develop-20240325173921

1 month ago

0.0.0-develop-20240325175336

1 month ago

0.0.0-develop-20240326200558

1 month ago

0.0.0-develop-20240325234437

1 month ago

0.0.0-develop-20240325221328

1 month ago

0.0.0-develop-20240322215055

1 month ago

1 month ago

0.0.0-develop-20240321160336

1 month ago

0.0.0-develop-20240321153335

1 month ago

0.0.0-develop-20240321142358

1 month ago

0.0.0-develop-20240321123548

1 month ago

0.0.0-develop-20240319173743

1 month ago

0.0.0-develop-20240319174953

1 month ago

0.0.0-develop-20240319221854

1 month ago

0.0.0-develop-20240320182236

1 month ago

0.0.0-develop-20240320222252

1 month ago

0.0.0-develop-20240320211012

1 month ago

0.0.0-develop-20240320191348

1 month ago

0.0.0-develop-20240320114650

1 month ago

0.0.0-develop-20240320202027

1 month ago

0.0.0-develop-20240320210929

1 month ago

0.0.0-develop-20240319184244

1 month ago

0.0.0-develop-20240320000130

1 month ago

0.0.0-develop-20240320132857

1 month ago

2 months ago

0.0.0-develop-20240311173125

2 months ago

0.0.0-develop-20240311193603

2 months ago

0.0.0-develop-20240311171430

2 months ago

2 months ago

0.0.0-develop-20240227180624

2 months ago

0.0.0-develop-20240227175903

2 months ago

3 months ago

0.0.0-develop-20240207171627

3 months ago

0.0.0-develop-20240207160424

3 months ago

0.0.0-develop-20240207160553

3 months ago

0.0.0-develop-20240207165123

3 months ago

0.0.0-develop-20240207055222

3 months ago

0.0.0-develop-20240206182048

3 months ago

0.0.0-develop-20240206211856

3 months ago

0.0.0-develop-20240207032634

3 months ago

0.0.0-develop-20240206203731

3 months ago

0.0.0-develop-20240206215751

3 months ago

0.0.0-develop-20240207044051

3 months ago

0.0.0-develop-20240206162917

3 months ago

0.0.0-develop-20240207031907

3 months ago

0.0.0-develop-20240206175826

3 months ago

0.0.0-develop-20240206114009

3 months ago

0.0.0-develop-20240206115338

3 months ago

0.0.0-develop-20240206093029

3 months ago

0.0.0-develop-20240206023315

3 months ago

0.0.0-develop-20240205211408

3 months ago

0.0.0-develop-20240205205054

3 months ago

0.0.0-develop-20240206002212

3 months ago

0.0.0-develop-20240205234819

3 months ago

0.0.0-develop-20240206015300

3 months ago

0.0.0-develop-20240206041431

3 months ago

0.0.0-develop-20240205215135

3 months ago

0.0.0-develop-20240205214032

3 months ago

0.0.0-develop-20240205233912

3 months ago

0.0.0-develop-20240206043819

3 months ago

0.0.0-develop-20240205223052

3 months ago

0.0.0-develop-20240205212200

3 months ago

0.0.0-develop-20240205152632

3 months ago

0.0.0-develop-20240205151555

3 months ago

0.0.0-develop-20240205194422

3 months ago

0.0.0-develop-20240205181439

3 months ago

0.0.0-develop-20240205175006

3 months ago

0.0.0-develop-20240204232104

3 months ago

0.0.0-develop-20240204225925

3 months ago

0.0.0-develop-20240204214707

3 months ago

0.0.0-develop-20240204090247

3 months ago

0.0.0-develop-20240204013722

3 months ago

0.0.0-develop-20240205010441

3 months ago

0.0.0-develop-20240204224341

3 months ago

0.0.0-develop-20240205011944

3 months ago

0.0.0-develop-20240204070056

3 months ago

0.0.0-develop-20240204061529

3 months ago

0.0.0-develop-20240204162015

3 months ago

0.0.0-develop-20240204070137

3 months ago

0.0.0-develop-20240204233614

3 months ago

0.0.0-develop-20240202045932

3 months ago

0.0.0-develop-20240202134449

3 months ago

0.0.0-develop-20240202201400

3 months ago

0.0.0-develop-20240201235404

3 months ago

0.0.0-develop-20240202100929

3 months ago

0.0.0-generate-chains-20240202151645

3 months ago

0.0.0-develop-20240202050612

3 months ago

0.0.0-develop-20240201184039

3 months ago

0.0.0-develop-20240202043650

3 months ago

0.0.0-develop-20240202023245

3 months ago

0.0.0-develop-20240202005345

3 months ago

0.0.0-develop-20240201220646

3 months ago

0.0.0-develop-20240202012310

3 months ago

0.0.0-develop-20240201214636

3 months ago

0.0.0-develop-20240201223258

3 months ago

0.0.0-develop-20240202151744

3 months ago

0.0.0-develop-20240202170343

3 months ago

0.0.0-develop-20240201232532

3 months ago

0.0.0-develop-20240201234159

3 months ago

0.0.0-develop-20240201235804

3 months ago

0.0.0-develop-20240202043923

3 months ago

0.0.0-develop-20240202002253

3 months ago

0.0.0-develop-20240202180118

3 months ago

0.0.0-develop-20240201203935

3 months ago

0.0.0-develop-20240202034733

3 months ago

0.0.0-develop-20240202032311

3 months ago

4 months ago

0.0.0-develop-20240110014821

4 months ago

4 months ago

0.0.0-develop-20240104225319

4 months ago

0.0.0-develop-20240104233248

4 months ago

0.0.0-develop-20240104220606

4 months ago

0.0.0-develop-20240104231610

4 months ago

0.0.0-develop-20240104190714

4 months ago

0.0.0-develop-20230816150616

9 months ago

0.0.0-develop-20230918164008

8 months ago

0.0.0-develop-20230822020446

8 months ago

0.0.0-develop-20230919162050

8 months ago

0.0.0-develop-20230915070507

8 months ago

0.0.0-develop-20230816010544

9 months ago

0.0.0-develop-20230822154524

8 months ago

0.0.0-develop-20230918224128

8 months ago

0.0.0-develop-20230918220320

8 months ago

0.0.0-develop-20230818154628

9 months ago

0.0.0-develop-20230822022055

8 months ago

0.0.0-develop-20230919155756

8 months ago

0.0.0-will-20230915154458

8 months ago

0.0.0-develop-20230720203027

10 months ago

0.0.0-develop-20230919225313

8 months ago

0.0.0-develop-20230921172205

7 months ago

0.0.0-develop-20230919163704

8 months ago

0.0.0-develop-20230821233051

8 months ago

0.0.0-20230711223728

10 months ago

0.0.0-develop-20230820045056

9 months ago

0.0.0-develop-20230821035847

8 months ago

0.0.0-develop-20230915184450

8 months ago

0.0.0-develop-20230822024701

8 months ago

0.0.0-develop-20230921134548

7 months ago

0.0.0-develop-20230921100523

7 months ago

0.0.0-develop-20230719153729

10 months ago

0.0.0-develop-20230816193533

9 months ago

0.0.0-develop-20230914222336

8 months ago

0.0.0-develop-20230919222511

8 months ago

7 months ago

0.0.0-develop-20230822003439

8 months ago

0.0.0-develop-20230921134439

7 months ago

8 months ago

9 months ago

0.0.0-develop-20230822023724

8 months ago

10 months ago

5 months ago

6 months ago

7 months ago

0.0.0-develop-20230720163548

10 months ago

0.0.0-develop-20230915164853

8 months ago

0.0.0-develop-20230818002338

9 months ago

0.0.0-develop-20230915120902

8 months ago

0.0.0-develop-20230919234604

8 months ago

0.0.0-develop-20230818151909

9 months ago

0.0.0-20230629165646

10 months ago

0.0.0-develop-20230719160135

10 months ago

0.0.0-develop-20230918191941

8 months ago

0.0.0-develop-20230821234812

8 months ago

0.0.0-develop-20230822011731

8 months ago

0.0.0-develop-20230821204047

8 months ago

0.0.0-develop-20230816021225

9 months ago

0.0.0-develop-20231122023438

5 months ago

0.0.0-develop-20230821200458

8 months ago

0.0.0-develop-20230719034914

10 months ago

0.0.0-20230630143718

10 months ago

0.0.0-develop-20230921053937

7 months ago

0.0.0-develop-20230719192358

10 months ago

0.0.0-develop-20230816012251

9 months ago

0.0.0-develop-20230822000428

8 months ago

0.0.0-develop-20231121220534

5 months ago

0.0.0-develop-20230821234550

8 months ago

0.0.0-develop-20230816143049

9 months ago

0.0.0-develop-20230921151157

7 months ago

0.0.0-20230711222223

10 months ago

0.0.0-will-20230915144606

8 months ago

0.0.0-develop-20230821231847

8 months ago

0.0.0-develop-20230928190155

7 months ago

0.0.0-develop-20230920230520

7 months ago

0.0.0-develop-20230915220457

8 months ago

0.0.0-develop-20230816223618

9 months ago

0.0.0-develop-20230821233012

8 months ago

0.0.0-develop-20230919214810

8 months ago

0.0.0-develop-20230822001723

8 months ago

0.0.0-develop-20230719005728

10 months ago

0.0.0-develop-20230822014916

8 months ago

0.0.0-develop-20230821213744

8 months ago

0.0.0-develop-20230820215736

9 months ago

0.0.0-develop-20230818211824

9 months ago

0.0.0-develop-20230919165552

8 months ago

0.0.0-develop-20230719045051

10 months ago

0.0.0-develop-20230921155055

7 months ago

0.0.0-develop-20230818161114

9 months ago

0.0.0-develop-20230719143038

10 months ago

0.0.0-develop-20231122023515

5 months ago

0.0.0-develop-20230822175727

8 months ago

0.0.0-develop-20230816202156

9 months ago

0.0.0-will-20230915152549

8 months ago

0.0.0-develop-20230816204334

9 months ago

0.0.0-develop-20230915210719

8 months ago

0.0.0-develop-20230822154128

8 months ago

0.0.0-develop-20230816164850

9 months ago

0.0.0-develop-20230918220719

8 months ago

0.0.0-develop-20230818195659

9 months ago

0.0.0-develop-20230921144045

7 months ago

0.0.0-develop-20230818193118

9 months ago

0.0.0-develop-20230821203120

8 months ago

0.0.0-develop-20230920183854

7 months ago

0.0.0-develop-20230915114417

8 months ago

0.0.0-develop-20230920222027

7 months ago

0.0.0-develop-20231122024851

5 months ago

0.0.0-develop-20230819014829

9 months ago

0.0.0-develop-20230921093539

7 months ago

0.0.0-develop-20230818235808

9 months ago

0.0.0-develop-20230816181033

9 months ago

0.0.0-develop-20230818191523

9 months ago

0.0.0-develop-20230921090940

7 months ago

0.0.0-develop-20230919202751

8 months ago

0.0.0-develop-20231121230228

5 months ago

0.0.0-develop-20230921052819

7 months ago

0.0.0-develop-20230919152321

8 months ago

0.0.0-develop-20230719200105

10 months ago

0.0.0-develop-20230818000658

9 months ago

0.0.0-develop-20230822165239

8 months ago

0.0.0-develop-20230720200759

10 months ago

0.0.0-develop-20230821042650

8 months ago

0.0.0-develop-20230719171655

10 months ago

0.0.0-develop-20230719194152

10 months ago

0.0.0-develop-20230920072059

7 months ago

0.0.0-develop-20230919201530

8 months ago

0.0.0-develop-20230818151511

9 months ago

0.0.0-develop-20230818155557

9 months ago

0.0.0-develop-20230719050957

10 months ago

0.0.0-develop-20230921050632

7 months ago

0.0.0-develop-20230921165738

7 months ago

0.0.0-develop-20230819001732

9 months ago

0.0.0-develop-20230821215338

8 months ago

0.0.0-develop-20230821192417

8 months ago

0.0.0-develop-20230821153048

8 months ago

0.0.0-develop-20231121222858

5 months ago

0.0.0-develop-20230817234403

9 months ago

0.0.0-develop-20230822131747

8 months ago

0.0.0-develop-20230822152425

8 months ago

0.0.0-develop-20230815225108

9 months ago

0.0.0-develop-20230816165228

9 months ago

0.0.0-develop-20230920224357

7 months ago

0.0.0-develop-20230918210043

8 months ago

0.0.0-develop-20230919172452

8 months ago

0.0.0-develop-20230821154740

8 months ago

0.0.0-develop-20230928172636

7 months ago

0.0.0-develop-20230915230513

8 months ago

0.0.0-develop-20230921181749

7 months ago

0.0.0-develop-20230919154123

8 months ago

0.0.0-develop-20230816122653

9 months ago

0.0.0-develop-20230914220733

8 months ago

0.0.0-develop-20230816184239

9 months ago

0.0.0-develop-20230822144932

8 months ago

0.0.0-develop-20230914215145

8 months ago

0.0.0-develop-20230720192840

10 months ago

0.0.0-develop-20230918165822

8 months ago

0.0.0-will-20230915150338

8 months ago

0.0.0-develop-20230822013330

8 months ago

0.0.0-develop-20230821212044

8 months ago

0.0.0-develop-20230815234603

9 months ago

0.0.0-develop-20230719160303

10 months ago

0.0.0-develop-20230919052241

8 months ago

0.0.0-develop-20230822172830

8 months ago

0.0.0-develop-20230719211429

10 months ago

0.0.0-develop-20230816024639

9 months ago

0.0.0-develop-20230821234714

8 months ago

0.0.0-develop-20230719214615

10 months ago

0.0.0-develop-20230821212130

8 months ago

0.0.0-develop-20230914195115

8 months ago

0.0.0-develop-20230720202645

10 months ago

0.0.0-develop-20231114152327

6 months ago

0.0.0-develop-20230815232409

9 months ago

0.0.0-develop-20230822160144

8 months ago

0.0.0-develop-20230818173744

9 months ago

0.0.0-develop-20230918171503

8 months ago

0.0.0-develop-20230821234748

8 months ago

0.0.0-develop-20230818145830

9 months ago

0.0.0-develop-20230816221604

9 months ago

0.0.0-develop-20230816022904

9 months ago

0.0.0-develop-20230822133331

8 months ago

0.0.0-develop-20230818182209

9 months ago

0.0.0-develop-20230920005934

8 months ago

0.0.0-develop-20230720165249

10 months ago

0.0.0-develop-20230918222608

8 months ago

0.0.0-develop-20231122010500

5 months ago

0.0.0-develop-20230816200226

9 months ago

0.0.0-20230629183311

10 months ago

0.0.0-develop-20230821234619

8 months ago

0.0.0-develop-20230816194259

9 months ago

0.0.0-develop-20230921062130

7 months ago

0.0.0-develop-20230822005133

8 months ago

0.0.0-develop-20230821230810

8 months ago

0.0.0-20230616235645

11 months ago

1 year ago

0.0.0-20230616235251

11 months ago

1 year ago

0.0.0-20230420003632

1 year ago

0.0.0-20230321224840

1 year ago

0.0.0-20230616230534

11 months ago

0.0.0-20230321191125

1 year ago

0.0.0-20230523161835

11 months ago

0.0.0-20230313235858

1 year ago

0.0.0-20230523155309

11 months ago

0.0.0-20230616234355

11 months ago

0.0.0-20230616231927

11 months ago

0.0.0-20230601165341

11 months ago

0.0.0-20230522161230

12 months ago

0.0.0-20230616232227

11 months ago

11 months ago

0.0.0-20230616220649

11 months ago

0.0.0-20230329025055

1 year ago

0.0.0-20230616221621

11 months ago

0.0.0-20230616214530

11 months ago

11 months ago

0.0.0-20230617014211

11 months ago

0.0.0-20230523183011

11 months ago

0.0.0-20230617021031

11 months ago

1 year ago

0.0.0-20230302033438

1 year ago

0.0.0-20230302025456

1 year ago

0.0.0-20230301065104

1 year ago

0.0.0-20230301212134

1 year ago

0.0.0-20230301063949

1 year ago

0.0.0-20230301062844

1 year ago

0.0.0-20230302031516

1 year ago

1 year ago

1 year ago

1 year ago

0.0.0-20230206220540

1 year ago

0.0.0-20230123181406

1 year ago

0.0.0-20230203233650

1 year ago

0.0.0-20230206212406

1 year ago

0.0.0-20230203220206

1 year ago

0.0.0-20230206212811

1 year ago

0.0.0-202211534330

1 year ago

1 year ago

0.0.0-20230206222627

1 year ago

0.0.0-20230206232610

1 year ago

0.0.0-20221115223117

1 year ago

0.0.0-20230206222914

1 year ago

1 year ago

1 year ago

0.0.0-202211521918

1 year ago

1 year ago

0.0.0-20221116233743

1 year ago

0.0.0-20230123175344

1 year ago

0.0.0-20230206230656

1 year ago

0.0.0-20230123181326

1 year ago

0.0.0-20230127153748

1 year ago

0.0.0-20230203201529

1 year ago

0.0.0-202211542835

1 year ago

0.0.0-20230203195642

1 year ago

0.0.0-20230206224602

1 year ago

0.0.0-20230203163959

1 year ago

0.0.0-20230203230908

1 year ago

0.0.0-20230203214025

1 year ago

0.0.0-20230123180301

1 year ago

0.0.0-202211517735

1 year ago

0.0.0-202211121340

1 year ago

0.0.0-2022927211939

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

0.0.0-2022814222656

2 years ago

0.0.0-2022921172216

2 years ago

0.0.0-20221015224241

1 year ago

0.0.0-20229519352

2 years ago

0.0.0-2022927151939

2 years ago

0.0.0-20228823182

2 years ago

0.0.0-2022814155956

2 years ago

1 year ago

0.0.0-2022927214235

2 years ago

1 year ago

0.0.0-2022921171514

2 years ago

0.0.0-2022815194840

2 years ago

1 year ago

0.0.0-2022829172921

2 years ago

0.0.0-2022819193354

2 years ago

0.0.0-202211220335

1 year ago

0.0.0-2022812163333

2 years ago

0.0.0-202286152821

2 years ago

0.0.0-2022813172428

2 years ago

0.0.0-202292720537

2 years ago

2 years ago

0.0.0-2022109231046

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

0.0.0-202292716831

2 years ago

2 years ago

0.0.0-202272320426

2 years ago

2 years ago

2 years ago

2 years ago

0.0.0-2022718152759

2 years ago

0.0.0-2022725173131

2 years ago

0.0.0-2022726221713

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

0.0.0-2022718175520

2 years ago

0.0.0-2022724212719

2 years ago

2 years ago

2 years ago

2 years ago

0.0.0-202242872411

2 years ago

0.0.0-202242865913

2 years ago

0.0.0-202251153718

2 years ago

0.0.0-20225116021

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

0.0.0-2022310341

2 years ago

2 years ago

2 years ago

2 years ago

0.0.0-20222319056

2 years ago

0.0.0-202212020516

2 years ago

0.0.0-202223213144

2 years ago

0.0.0-2022111165616

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

0.0.0-2021117221042

2 years ago

0.0.0-202111722448

2 years ago

2 years ago