Skip to content

Commit

Permalink
Merge pull request #115 from flashbots/v5-note
Browse files Browse the repository at this point in the history
Add ethers-v5 section README for users wishing to stay on older version
  • Loading branch information
epheph authored Feb 20, 2024
2 parents f1e6dbc + fa594c0 commit da8e652
Show file tree
Hide file tree
Showing 3 changed files with 116 additions and 837 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ One key feature this library provides is **payload signing**, a requirement to s

This library is not a fully functional ethers.js implementation, just a simple provider class, designed to interact with an existing [ethers.js v6 installation](https://github.com/ethers-io/ethers.js/).

# ethers v5 & v6

This version of `@flashbots/ethers-provider-bundle` (v1.x.x) is designed to work with [ethers v6](https://www.npmjs.com/package/ethers). If you want ethers-v5 compatibility, stick with the `v0.x.x` versions.

## Example

Install ethers.js and the Flashbots ethers bundle provider.
Expand Down
Loading

0 comments on commit da8e652

Please sign in to comment.