Optimism Forking with Hardhat

.circleci/config.yml

@@ -42,6 +42,31 @@ jobs:
       - attach_workspace:
           at: .
       - run: npx hardhat compile --optimizer --fail-oversize
+  job-fork-tests-ovm:
+    working_directory: ~/repo
+    docker:
+      - image: synthetixio/docker-node:16.13-ubuntu
+        auth:
+          username: $DOCKERHUB_USERNAME
+          password: $DOCKERHUB_TOKEN
+    steps:
+      - checkout
+      - attach_workspace:
+          at: .
+      - run:
+          command: npm run fork:ovm
+          background: true
+      - cmd-wait-for-port:
+          port: 8545
+      - run:
+          name: Run integration tests on l2
+          command: |
+            NEW_CONTRACTS=$(node bin.js sips --layer=base --unreleased --with-sources)
+            if [ -z "$NEW_CONTRACTS" ]; then
+              npx hardhat test:integration:l2 --use-fork
+            else
+              npx hardhat test:integration:l2 --compile --deploy --use-sips --use-fork
+            fi;
   job-fork-tests:
     working_directory: ~/repo
     docker:
@@ -57,15 +82,15 @@ jobs:
           command: npm run fork:mainnet
           background: true
       - cmd-wait-for-port:
-          port: 8545
+          port: 9545
       - run:
           name: Run integration tests on l1
           command: |
             NEW_CONTRACTS=$(node bin.js sips --layer=base --unreleased --with-sources)
             if [ -z "$NEW_CONTRACTS" ]; then
-              npx hardhat test:integration:l1 --use-fork
+              npx hardhat test:integration:l1 --use-fork --provider-port 9545
             else
-              npx hardhat test:integration:l1 --compile --deploy --use-sips --use-fork
+              npx hardhat test:integration:l1 --compile --deploy --use-sips --use-fork --provider-port 9545
             fi;
   job-integration-tests:
     working_directory: ~/repo
@@ -406,6 +431,9 @@ workflows:
       - job-fork-tests:
           requires:
             - job-prepare
+      - job-fork-tests-ovm:
+          requires:
+            - job-prepare
       - job-simulate-release:
           requires:
             - job-prepare

.circleci/src/jobs/job-fork-tests-ovm.yml

@@ -0,0 +1,21 @@
+# Starts a fork of OVM, deploys the latest release, and runs L2 integration tests
+{{> job-header-node.yml}}
+steps:
+  - checkout
+  - attach_workspace:
+      at: .
+  - run:
+      command: npm run fork:ovm
+      background: true
+  - cmd-wait-for-port:
+      port: 8545
+  - run:
+      name: Run integration tests on l2
+      command: |
+        # Only compile and deploy when there are new contracts
+        NEW_CONTRACTS=$(node bin.js sips --layer=base --unreleased --with-sources)
+        if [ -z "$NEW_CONTRACTS" ]; then
+          npx hardhat test:integration:l2 --use-fork
+        else
+          npx hardhat test:integration:l2 --compile --deploy --use-sips --use-fork
+        fi;

.circleci/src/jobs/job-fork-tests.yml

@@ -8,14 +8,14 @@ steps:
       command: npm run fork:mainnet
       background: true
   - cmd-wait-for-port:
-      port: 8545
+      port: 9545
   - run:
       name: Run integration tests on l1
       command: |
         # Only compile and deploy when there are new contracts
         NEW_CONTRACTS=$(node bin.js sips --layer=base --unreleased --with-sources)
         if [ -z "$NEW_CONTRACTS" ]; then
-          npx hardhat test:integration:l1 --use-fork
+          npx hardhat test:integration:l1 --use-fork --provider-port 9545
         else
-          npx hardhat test:integration:l1 --compile --deploy --use-sips --use-fork
+          npx hardhat test:integration:l1 --compile --deploy --use-sips --use-fork --provider-port 9545
         fi;

.circleci/src/workflows/workflow-all.yml

@@ -31,6 +31,8 @@ jobs:
   # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   - job-fork-tests:
       {{> require-prepare.yml}}
+  - job-fork-tests-ovm:
+      {{> require-prepare.yml}}
 
   # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   # Simulate release on fork & test

hardhat.config.js

@@ -74,6 +74,12 @@ module.exports = {
 			url: process.env.OVM_PROVIDER_URL || 'https://kovan.optimism.io/',
 			chainId: 69,
 		},
+		local: {
+			url: process.env.PROVIDER_URL || 'http://localhost:8545/',
+		},
+		'local-ovm': {
+			url: process.env.OVM_PROVIDER_URL || 'http://localhost:9545/',
+		},
 	},
 	gasReporter: {
 		enabled: false,

hardhat/tasks/task-node.js

@@ -7,6 +7,7 @@ const { TASK_NODE_SERVER_READY } = require('hardhat/builtin-tasks/task-names');
 
 task('node', 'Run a node')
 	.addOptionalParam('targetNetwork', 'Target network to simulate, i.e. mainnet or local', 'local')
+	.addFlag('useOvm', 'Use OVM', false)
 	.setAction(async (taskArguments, hre, runSuper) => {
 		// Enable forking if necessary
 		if (taskArguments.fork) {
@@ -17,12 +18,18 @@ task('node', 'Run a node')
 			);
 		}
 		const network = taskArguments.targetNetwork;
+		const useOvm = taskArguments.useOvm;
 		if (network !== 'local') {
+			const networkHostReplace = (taskArguments.useOvm ? 'optimism-' : '') + network;
+
 			if (network === 'mainnet') {
-				taskArguments.fork = process.env.PROVIDER_URL_MAINNET;
+				taskArguments.fork = process.env.PROVIDER_URL_MAINNET.replace(
+					'network',
+					networkHostReplace
+				);
 			}
 			taskArguments.fork =
-				taskArguments.fork || process.env.PROVIDER_URL.replace('network', network);
+				taskArguments.fork || process.env.PROVIDER_URL.replace('network', networkHostReplace);
 
 			console.log(yellow(`Forking ${network}...`));
 		}
@@ -37,13 +44,20 @@ task('node', 'Run a node')
 			// Unlock any specified accounts, plus those
 			// known as protocol users of the target network.
 			const { getUsers } = wrap({ network, fs, path });
-			const accounts = getUsers({ network })
+			const accounts = getUsers({ network, useOvm })
 				.filter(account => account.name !== 'fee')
 				.filter(account => account.name !== 'zero')
 				.concat(knownAccounts[network] || []);
 			await Promise.all(
-				accounts.map(account => {
-					console.log(gray(`  > Unlocking ${account.name}: ${account.address}`));
+				accounts.map(async account => {
+					console.log(gray(`  > Unlocking & Funding ${account.name}: ${account.address}`));
+
+					// owner might not have eth when we impersonate them
+
+					await provider.request({
+						method: 'hardhat_setBalance',
+						params: [account.address, '0x10000000000000000000000'],
+					});
 
 					return provider.request({
 						method: 'hardhat_impersonateAccount',

hardhat/tasks/task-test-integration.js

@@ -81,6 +81,13 @@ task('test:integration:l2', 'run isolated layer 2 production tests')
 	.addFlag('debugOptimism', 'Debug Optimism activity')
 	.addFlag('compile', 'Compile an l2 instance before running the tests')
 	.addFlag('deploy', 'Deploy an l2 instance before running the tests')
+	.addFlag('useSips', 'Use sources from SIPs directly, instead of releases')
+	.addFlag('useFork', 'Run the tests against a fork of mainnet')
+	.addOptionalParam(
+		'providerPort',
+		'The target port for the running local chain to test on',
+		'8545'
+	)
 	.setAction(async (taskArguments, hre) => {
 		hre.config.paths.tests = './test/integration/l2/';
 		hre.config.debugOptimism = taskArguments.debugOptimism;
@@ -89,25 +96,47 @@ task('test:integration:l2', 'run isolated layer 2 production tests')
 
 		const providerUrl = (hre.config.providerUrl = 'http://localhost');
 		hre.config.providerPortL1 = '9545';
-		const providerPortL2 = (hre.config.providerPortL2 = '8545');
+		const providerPortL2 = (hre.config.providerPortL2 = taskArguments.providerPort);
 		const useOvm = true;
-		const buildPath = path.join(__dirname, '..', '..', `${BUILD_FOLDER}-ovm`);
+		const buildPath = path.join(__dirname, '..', '..', BUILD_FOLDER);
 
 		if (taskArguments.compile) {
 			await compileInstance({ useOvm, buildPath });
 		}
+		if (taskArguments.useFork) {
+			hre.config.fork = true;
+		}
 
 		if (taskArguments.deploy) {
-			const network = 'local';
-			await prepareDeploy({ network, synthsToAdd, useOvm });
-			await deployInstance({
-				addNewSynths: true,
-				buildPath,
-				network,
-				providerPort: providerPortL2,
-				providerUrl,
-				useOvm,
-			});
+			if (taskArguments.useFork) {
+				await prepareDeploy({
+					network: 'mainnet',
+					synthsToAdd,
+					useOvm,
+					useSips: taskArguments.useSips,
+				});
+				await deployInstance({
+					addNewSynths: true,
+					buildPath,
+					freshDeploy: false,
+					network: 'mainnet',
+					providerPort: providerPortL2,
+					providerUrl,
+					useFork: true,
+					useOvm,
+				});
+			} else {
+				const network = 'local';
+				await prepareDeploy({ network, synthsToAdd, useOvm, useReleases: false, useSips: false });
+				await deployInstance({
+					addNewSynths: true,
+					buildPath,
+					network,
+					providerPort: providerPortL2,
+					providerUrl,
+					useOvm,
+				});
+			}
 			hre.config.addedSynths = synthsToAdd;
 		}
 
@@ -127,27 +156,25 @@ task('test:integration:dual', 'run integrated layer 1 and layer 2 production tes
 		const providerUrl = (hre.config.providerUrl = 'http://localhost');
 		const providerPortL1 = (hre.config.providerPortL1 = '9545');
 		const providerPortL2 = (hre.config.providerPortL2 = '8545');
-		const buildPathEvm = path.join(__dirname, '..', '..', BUILD_FOLDER);
-		const buildPathOvm = path.join(__dirname, '..', '..', `${BUILD_FOLDER}-ovm`);
+		const buildPath = path.join(__dirname, '..', '..', BUILD_FOLDER);
 
 		if (taskArguments.compile) {
-			await compileInstance({ useOvm: false, buildPath: buildPathEvm });
-			await compileInstance({ useOvm: true, buildPath: buildPathOvm });
+			await compileInstance({ useOvm: false, buildPath: buildPath });
 		}
 
 		if (taskArguments.deploy) {
 			await deployInstance({
 				useOvm: false,
 				providerUrl,
 				providerPort: providerPortL1,
-				buildPath: buildPathEvm,
+				buildPath: buildPath,
 			});
 
 			await deployInstance({
 				useOvm: true,
 				providerUrl,
 				providerPort: providerPortL2,
-				buildPath: buildPathOvm,
+				buildPath: buildPath,
 			});
 		}
 

index.js

@@ -499,6 +499,7 @@ const getUsers = ({ network = 'mainnet', user, useOvm = false } = {}) => {
 		}),
 		'mainnet-ovm': Object.assign({}, base, {
 			owner: '0x6d4a64C57612841c2C6745dB2a4E4db34F002D20',
+			deployer: '0xDe910777C787903F78C89e7a0bf7F4C435cBB1Fe',
 		}),
 		rinkeby: Object.assign({}, base),
 		ropsten: Object.assign({}, base),