-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update readme for better install steps
- Loading branch information
1 parent
3aab82a
commit 66ef793
Showing
3 changed files
with
26 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,39 @@ | ||
|
||
# optimism-openzeppelin-compat | ||
[![NPM Package](https://img.shields.io/npm/v/@thesatoshicompany/optimism-openzeppelin-compat/latest?label=%40thesatoshicompany%2Foptimism-openzeppelin-compat&logo=npm)](https://www.npmjs.com/package/@thesatoshicompany/optimism-openzeppelin-compat) | ||
|
||
This repo contains patches needed to use the OpenZeppelin contracts with Optimism L2. | ||
|
||
Example: When using Optimism ETH is not supported and instead WETH must be used. When using OpenZeppelin Address contract via ERC20, there are balance checks for ETH and thus the compilation fails due to an unsupported OPCODE. This patches these issues and allows for seamless development. | ||
> Example: When using Optimism ETH is not supported and instead WETH | ||
> must be used. When using OpenZeppelin Address contract via ERC20, | ||
> there are balance checks for ETH and thus the compilation fails due to | ||
> an unsupported OPCODE. This patches these issues and allows for | ||
> seamless development. | ||
## Installation | ||
|
||
Use the following command to use: | ||
Use the following command to install: | ||
|
||
``` | ||
npm i --save @thesatoshicompany/optimism-openzeppelin-compat | ||
``` | ||
|
||
Add the following to the package.json scripts section: | ||
|
||
``` | ||
"scripts": { | ||
+ "postinstall": "patch-package --patch-dir node_modules/@thesatoshicompany/optimism-openzeppelin-compat/patches" | ||
}, | ||
``` | ||
|
||
`Note: Post install script is needed because this package does not patch files on install automatically. It only provides the appropriate patches and the needed module to apply them.` | ||
|
||
`This was a design choice so full control is left to the consumer of the module for if and when they are applied.` | ||
|
||
## Supported OpenZeppelin Versions | ||
|
||
v3.4.1 | ||
|
||
## Have an additional patch which should be included? | ||
|
||
Provide a PR and a review will happen so that it can be included. |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters