diff --git a/packages/provider/README.md b/packages/provider/README.md index 8c2f6cf7ae38..66524f61dff9 100644 --- a/packages/provider/README.md +++ b/packages/provider/README.md @@ -1,8 +1,15 @@ # 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 submit transactions -to the Optimism Sequencer and needs a `Web3Provider` based provider +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