Skip to content
This repository has been archived by the owner on Apr 12, 2021. It is now read-only.

Latest commit

 

History

History
88 lines (67 loc) · 2.67 KB

README.md

File metadata and controls

88 lines (67 loc) · 2.67 KB
Raw

[DEPRECATED] This repository is now deprecated in favour of the new development monorepo.

Optimistic Ethereum Smart Contracts

@eth-optimism/contracts contains the various Solidity smart contracts used within the Optimistic Ethereum system. Some of these contracts are deployed on Ethereum ("Layer 1"), while others are meant to be deployed to Optimistic Ethereum ("Layer 2").

Within each contract file you'll find a comment that lists:

  1. The compiler with which a contract is intended to be compiled, solc or optimistic-solc.
  2. The network upon to which the contract will be deployed, OVM or EVM.

A more detailed overview of these contracts can be found on the community hub.

Usage (npm)

If your development stack is based on Node/npm:

npm install @eth-optimism/contracts

Within your contracts:

import { SomeContract } from "@eth-optimism/contracts/SomeContract.sol";

Guide for Developers

Setup

Install the following:

Clone the repo:

git clone https://github.com/ethereum-optimism/contracts.git
cd contracts

Install npm packages:

yarn install

Running Tests

Tests are executed via yarn:

yarn test

Run specific tests by giving a path to the file you want to run:

yarn test ./test/path/to/my/test.spec.ts

Measuring test coverage:

yarn test-coverage

The output is most easily viewable by opening the html file in your browser:

open ./coverage/index.html

Compiling and Building

Easiest way is to run the primary build script:

yarn build

Running the full build command will perform the following actions:

  1. build:contracts - Compile all Solidity contracts with both the EVM and OVM compilers.
  2. build:typescript - Builds the typescript files that are used to export utilities into js.
  3. build:copy - Copies various other files into the build folder.
  4. build:dump - Generates a genesis state from the contracts that L2 geth will use.
  5. build:typechain - Generates TypeChain artifacts.

You can also build specific components as follows:

yarn build:contracts

Security

Please refer to our Security Policy for information about how to disclose security issues with this code.