Commit c0915588 authored by Georgios Konstantopoulos's avatar Georgios Konstantopoulos Committed by GitHub

chore: rename plugins to hardhat-ovm (#19)

parent 550a2f69
# @eth-optimism/plugins/hardhat/compiler # @eth-optimism/hardhat-ovm
A plugin that brings OVM compiler support to Hardhat projects. A plugin that brings OVM compiler support to Hardhat projects.
## Installation ## Installation
Installation is super simple.
First, grab the package.
Via `npm`:
```
npm install @eth-optimism/plugins
```
Via `yarn`:
``` ```
yarn add @eth-optimism/plugins yarn add --dev @eth-optimism/plugins
``` ```
Next, import the plugin inside your `hardhat.config.js`: Next, import the plugin inside your `hardhat.config.js`:
...@@ -24,7 +13,7 @@ Next, import the plugin inside your `hardhat.config.js`: ...@@ -24,7 +13,7 @@ Next, import the plugin inside your `hardhat.config.js`:
```js ```js
// hardhat.config.js // hardhat.config.js
require("@eth-optimism/plugins/hardhat/compiler") require("@eth-optimism/hardhat-ovm")
``` ```
Or if using TypeScript: Or if using TypeScript:
...@@ -32,7 +21,7 @@ Or if using TypeScript: ...@@ -32,7 +21,7 @@ Or if using TypeScript:
```ts ```ts
// hardhat.config.ts // hardhat.config.ts
import "@eth-optimism/plugins/hardhat/compiler" import "@eth-optimism/hardhat-ovm"
``` ```
## Configuration ## Configuration
...@@ -43,7 +32,7 @@ Configure this plugin by adding an `ovm` field to your Hardhat config: ...@@ -43,7 +32,7 @@ Configure this plugin by adding an `ovm` field to your Hardhat config:
```js ```js
// hardhat.config.js // hardhat.config.js
require("@eth-optimism/plugins/hardhat/compiler") require("@eth-optimism/hardhat-ovm")
module.exports = { module.exports = {
ovm: { ovm: {
...@@ -53,4 +42,4 @@ module.exports = { ...@@ -53,4 +42,4 @@ module.exports = {
``` ```
Has typings so it won't break your Hardhat config if you're using TypeScript. This package also has typings so it won't break your Hardhat config if you're using TypeScript.
{ {
"name": "@eth-optimism/plugins", "name": "@eth-optimism/hardhat-ovm",
"version": "1.0.0-alpha.2", "version": "0.0.1",
"main": "dist/index", "main": "dist/index",
"types": "dist/index", "types": "dist/index",
"files": [ "files": [
"hardhat/", "dist/index"
"*.d.ts",
"*.d.ts.map",
"*.js",
"*.js.map",
"LICENSE.txt",
"README.md"
], ],
"license": "MIT", "license": "MIT",
"scripts": { "scripts": {
"clean": "rimraf hardhat *.d.ts *.map *.js tsconfig.tsbuildinfo dist", "clean": "rimraf tsconfig.build.tsbuildinfo dist",
"build": "tsc -p tsconfig.build.json", "build": "tsc -p tsconfig.build.json",
"lint": "yarn run lint:fix && yarn run lint:check", "lint": "yarn run lint:fix && yarn run lint:check",
"lint:check": "tslint --format stylish --project .", "lint:check": "tslint --format stylish --project .",
......
...@@ -2,6 +2,7 @@ ...@@ -2,6 +2,7 @@
"extends": "../../tsconfig.build.json", "extends": "../../tsconfig.build.json",
"compilerOptions": { "compilerOptions": {
"rootDir": "./src",
"outDir": "./dist" "outDir": "./dist"
}, },
......
# @eth-optimism/plugins
## What is this?
A collection of useful JavaScript/TypeScript tooling plugins that you might need when building on top of Optimistic Ethereum!
## What kind of plugins are we talking about?
### Plugins for [`hardhat`](https://hardhat.org)
#### `@eth-optimism/plugins/hardhat/compiler`
Automatically compiles your Solidity contracts with the OVM compiler.
Defaults to Solidity version 0.7.6, but also has support for 0.5.16 and 0.6.12.
[Full README available here](./src/hardhat/compiler).
{
"extends": "../tsconfig.json",
"compilerOptions": {
"outDir": "../",
"rootDirs": ["."],
"composite": true
},
"include": [
"./**/*.ts"
],
"exclude": []
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment