feat: OVM #491

gakonst · 2021-05-21T07:07:50Z

Summary

The OVM is a sandboxed environment for the EVM which allows execution of smart contract code on L2, with the ability to dispute it on L1 via a fraud proof. Solidity code can be compiled directly to OVM code instead of EVM code by using "optimistic solc", a fork of the well-known solc. The OVM bytecode is ~30% larger than EVM bytecode, which may result in the bytecode being larger than the 24kb size limit for smart contracts.

This PR refactors the codebase to allow it to fit in the 24kb limit, and does a minimal diff to the test suite so that tests can pass when ran against an instance of go-ethereum running the OVM. I suspect the test suite changes around waiting for txs to be confirmed would've been required anyway if we wanted to test against geth or any full node impl.

Explanation of code changes

Introduces a new CI job for the OVM unit tests
Modifies the hardhat config in the following ways:
- Overrides the default signer and contracts to always .wait(). This is because tests are run against go-ethereum which does not insta-mine, hence receipts are not immediately available in tests.
- Overrides the default waffle getWallets() method because it fails if the network name is not hardhat
- Makes Waffle fixtures a no-op. This is because go-ethereum does not support snapshots
- Makes the default ethers provider polling interval 100ms. This is because when blocks don't get instamined, Ethers by default waits 4s while polling
- Add a new network called optimism
- Increase the mocha timeout, given that there's no fixtures to speed tests up
- Decreases the optimizer runs to keep bytecode size low
- Adds a new plugin, hardhat-ovm which allows compiling to the OVM when the target network has the ovm: true flag set
Adds a scripts/run-optimism.sh script which will clone the Optimism monorepo, build it, and bring up the network
Replaces the minimal proxy which contains banned opcodes with a normal delegateproxy contract
Refactors libraries with internal functions to public, so that they get deployed as separate contracts and do not contribute to the bytecode of the "main" contract. Certain functions were also batched together to minimize the number of delegatecalls needed (e.g. updateBoth).

Status

All tests pass both in the EVM and in the OVM! Due to the lack of snapshots and running against a real node, tests take much longer, ~90mins.

The linter fails due to perms, but I formatted everything in the last commit.

h/t to @mds1 and @elenadimitrova for the help :)

This reverts commit 7a4e277. -> Temporary revert. TODO: Load wallets conditionally on `--network optimism`

… optimism

Waffle event emitter seems to be having problems with Optimism

…timated

…proxy bytecode

The try/catch pattern does not yield the revert msg when used with geth. We would need to use the `expect(tx).to.be.revertedWith` pattern

This reverts commit c6da41a.

This reverts commit 3d6eb05.

moodysalem

can we do something about the modifiers -> functions change?

.github/workflows/tests.yml

moodysalem · 2021-05-25T18:06:34Z

.github/workflows/tests.yml

+        run: yarn optimism-up
+
+      - name: Run unit tests
+        run: UPDATE_SNAPSHOT=1 yarn test:ovm


We'd need to generate 2 different snapshots since gas costs differ between EVM and OVM (due to including L1 data publishing costs). I don't think the snapshot plugin supports that right now. I changed this to test the snapshot for the EVM tests however, to ensure that the baseline performance is ~same as the one we have in main.

contracts/UniswapV3Pool.sol

NoahZinsmeister · 2021-06-07T19:16:20Z

did a first pass, nothing jumped out to me as a big problem, though i echo what moody already pointed out

This reverts commit 859f762.

This reverts commit b1b1ecd.

It'd be nice if Jest had a way to have 2 different types of snapshots, so that we could have snapshots for both EVM and OVM

moodysalem · 2021-06-09T16:35:45Z

test/shared/utilities.ts

@@ -256,3 +257,12 @@ export function createMultiPoolFunctions({
    swapForExact1Multi,
  }
 }
+
+/**
+ * @notice The OVM emits an additional `Transfer` event due to its usage of WETH instead of native ETH. As a result,


is this transfer the payment of gas?

gakonst and others added 30 commits May 19, 2021 14:10

feat: add ovm compiler

ed9e906

tune down optimizer

4e32a0f

perf(swap-math): -1kb

863c52a

perf(tick-bitmap): -0.5kb

adf11b1

perf(position): -0.5kb

b816415

perf(tick): -0.5kb

3d6eb05

perf(tick-math): -0.8kb (core compiles now)

46bc354

perf(oracle): -1.88kb

4636a31

perf(factory): -3kb

ba6a069

perf(pool): combine requires -0.17kb

954eafd

test: link libraries before deploying contracts

814e68c

perf(mock-deployer): ovm-ify to be under 24kb

588b116

ci: add job for ovm unit tests

1352782

tests: lower hh polling interval

fbe0052

tests: use provider wallets instead of waffle signers

3362f29

Revert "tests: use provider wallets instead of waffle signers"

11ebe4f

This reverts commit 7a4e277. -> Temporary revert. TODO: Load wallets conditionally on `--network optimism`

Fix code style issues with Prettier

e4c9980

Add optimism folder to .gitignore

f62f752

Override waffle.provider.getWallets() when network is optimism

54a794d

Override waffle.createFixtureLoader() to return no-op when network is…

9963327

… optimism

Fix createFixtureLoader() override to use provided signers and provider

35420d1

fix: use correct receipt index when creating a pool

ba47519

fix factory tests

ac437a5

Waffle event emitter seems to be having problems with Optimism

fixtures: wait for tx to be mined + hardcode gas

3e36795

fix pool test to manually decode log

3a98ad0

fix: use correct receipt index based on network (again)

7f80919

Hardcode estimateGas response to avoid failures when gas cannot be es…

b5be03d

…timated

Fix NoDelegateCall OVM test to use Proxy contract instead of minimal …

7dca8e0

…proxy bytecode

Modify hardhat config so all transactions call .wait() automatically

7ff13bc

Bump mocha timeout to 60s to remove timeout test failures

d20e2b2

gakonst added 4 commits May 20, 2021 17:53

test: use Optimism 0.4.0

fa426cf

chore: do not snapshot error message

a30ce72

The try/catch pattern does not yield the revert msg when used with geth. We would need to use the `expect(tx).to.be.revertedWith` pattern

ci: update snapshots all the time so that tests pass

92e3298

chore: prettier

e5c8912

gakonst force-pushed the get-ovm-contracts-deployed branch from 9a9d213 to e5c8912 Compare May 21, 2021 07:30

gakonst added 8 commits May 25, 2021 20:58

Revert "refactor: move the state machine to a library function"

bc448c5

This reverts commit c6da41a.

Revert "perf(tick): -0.5kb"

a0ce7a3

This reverts commit 3d6eb05.

perf(oracle): make observeSingle public

570faf2

perf(pool): replace modifier with function

b1b1ecd

perf(pool): remove revert reasons

dcd1f6f

perf(pool): deduplicate require calls

011e06f

perf(pool): replace lock modifier with function

859f762

perf(pool): combine tick.update calls in 1

b42f49b

moodysalem changed the base branch from main to optimism May 25, 2021 18:03

moodysalem suggested changes Jun 2, 2021

View reviewed changes

gakonst added 7 commits June 9, 2021 15:21

Revert "perf(pool): replace lock modifier with function"

849856f

This reverts commit 859f762.

Revert "perf(pool): replace modifier with function"

84fd4df

This reverts commit b1b1ecd.

perf(pool): use functions to deduplicate requires inside modifiers

054ff4d

fix: update tests to not use revert messages

90d458c

chore: update snapshots

3ec0d63

ci: check snapshot on EVM tests instead of updating it

672a233

It'd be nice if Jest had a way to have 2 different types of snapshots, so that we could have snapshots for both EVM and OVM

chore: lint

95b598a

gakonst requested a review from moodysalem June 9, 2021 16:03

moodysalem reviewed Jun 9, 2021

View reviewed changes

moodysalem merged commit 6fab61b into Uniswap:optimism Jun 11, 2021

gakonst deleted the get-ovm-contracts-deployed branch June 12, 2021 08:39

mds1 restored the get-ovm-contracts-deployed branch June 15, 2021 12:05

mds1 mentioned this pull request Jun 16, 2021

feat: OVM Uniswap/v3-periphery#147

Merged

apbendi mentioned this pull request Jun 28, 2023

Foundation Mission Request: Governor v2 Contract ethereum-optimism/ecosystem-contributions#64

Closed

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: OVM #491

feat: OVM #491

gakonst commented May 21, 2021 •

edited by moodysalem

Loading

moodysalem left a comment

moodysalem May 25, 2021

gakonst Jun 9, 2021 •

edited

Loading

NoahZinsmeister commented Jun 7, 2021

moodysalem Jun 9, 2021

gakonst Jun 10, 2021

feat: OVM #491

feat: OVM #491

Conversation

gakonst commented May 21, 2021 • edited by moodysalem Loading

Summary

Explanation of code changes

Status

moodysalem left a comment

Choose a reason for hiding this comment

moodysalem May 25, 2021

Choose a reason for hiding this comment

gakonst Jun 9, 2021 • edited Loading

Choose a reason for hiding this comment

NoahZinsmeister commented Jun 7, 2021

moodysalem Jun 9, 2021

Choose a reason for hiding this comment

gakonst Jun 10, 2021

Choose a reason for hiding this comment

gakonst commented May 21, 2021 •

edited by moodysalem

Loading

gakonst Jun 9, 2021 •

edited

Loading