@eth-optimism/provider
TypeScript icon, indicating that this package has built-in type declarations

0.0.3 • Public • Published

Optimism Provider

Note: It is recommended to use a normal Web3 provider for now unless you need to access the additional properties that the Optimism Node attaches to RPC responses or the eth_sign based transaction signing. The full geth RPC is supported, and most users will not need these additional fields.

The OptimismProvider extends the ethers.js JsonRpcProvider and implements all of the same methods. It will sign transactions using eth_sign and submit transactions to the Optimism Sequencer through a new endpoint eth_sendRawEthSignTransaction. It needs a Web3Provider based provider to manage keys for any transaction signing.

Usage

import { OptimismProvider } from '@eth-optimism/provider'
import { Web3Provider } from '@ethersproject/providers'

// Uses a Web3Provider to manage keys, pass in `window.ethereum` or
// another key management backend.
const web3 = new Web3Provider()

// Accepts either a URL or a network name (main, kovan)
const provider = new OptimismProvider('http://localhost:8545', web3)

Goerli Testnet

To connect to the Goerli testnet:

const provider = new OptimismProvider('goerli')

Readme

Keywords

none

Package Sidebar

Install

npm i @eth-optimism/provider

Weekly Downloads

582

Version

0.0.3

License

MIT

Unpacked Size

31.4 kB

Total Files

15

Last publish

Collaborators

  • optibot
  • kelvinfichter