Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

provider: update readme #367

Merged
merged 2 commits into from
Dec 2, 2020
Merged

provider: update readme #367

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
97ce54c
provider: update readme
tynes Nov 21, 2020
7c875d7
provider: update readme
tynes Dec 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/provider/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# 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. 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 submit transactions
to the Optimism Sequencer and needs a `Web3Provider` based provider
Expand Down